For platform installation, follow the six steps below in order;
Terminal Environment
You must have the Console or Terminal application installed on your computer so that you can perform the following installation steps. The Terminal environment is always built-in on Linux, Mac OS and Windows WSL2 (Windows Subsystem for Linux) operating systems. Switch or run into the command line by running the Terminal application.
Docker version control
Run the following command to check whether the Docker environment is successfully installed and it is up and running on your computer. If you get a version and a build number you are good to go. If the command is not found try to install Docker again.
docker -v
# Docker version 23.0.5, build bc4487a
Platform Script
Open a Console or Terminal session and run the command below to get the official platform script from GitHub.
Platform script is in progress.
It will be provided here soon.
Setting the Environment Variables
The environment parameters required for the system to be operational are in the ".env" file in the folder named "technoplatz" which was created automatically in the previous step. Edit the ".env" file and assign the required values to the parameters. The ".env" file contains many parameters. Update only the lines specified in the user parameters section. If you do not have advanced system knowledge we recommend that you do not change the previously assigned values under the system parameters section.
### USER PARAMETERS
TZ=Europe/Berlin
DOMAIN=localhost
ADMIN_EMAIL=you@company.com
ADMIN_NAME=John Doe
COMPANY_NAME=Company GmbH
DEPARTMENT_NAME=Finance
COUNTRY_CODE=DE
STATE_NAME=NRW
CITY_NAME=Dusseldorf
SMTP_PORT=465
SMTP_SERVER=smtp.sendgrid.net
SMTP_USERID=apikey
SMTP_PASSWORD=SG.****.****
FROM_EMAIL=notification@yourcompany.com
### SYSTEM PARAMETERS
...
Notes with the environment variables;
- TZ is the Timezone of your country. It must be provided in an official format.
- DOMAIN should be leaved as "localhost".
- ADMIN_EMAIL and ADMIN_NAME are set as the user ID and full name of the first user who will also have administrative rights.
- COMPANY_NAME, DEPARTMENT NAME, COUNTRY_CODE, STATE NAME and CITY_NAME are used by the system itself to generate SSL certificates for clusters' internal communication.
- SMTP_PORT, SMTP_SERVER, SMTP_USERID and SMTP_PASSWORD are required to enable internal messaging and data announcements via email.
- FROM_EMAIL is used for the sender address of all email communication.
Starting Containers
Enter the following command to get the containers up and running. Technoplatz BI starts automatically each time the platform is rebooted.
Signing In
Go to the following URL in your browser to get signed in.
- Click the "Sign in" button,
- Click the "Set Password" button,
- Enter the ADMIN_EMAIL address you specified in the ".env" file and click the "Continue" button,
- Set a password and enter the one-time password that will be sent by the system,
- Click the sign in button and enter your credentials,
- Enter the new one time password sent by the system.
