Configure Process Intelligence using the environment file
Process Intelligence settings can be configured after the installation by updating the environment file.
In the system hosting Process Intelligence, open the opt/timeline/.env file in any editor and set the following environment variables:
Parameters |
Information |
|
---|---|---|
Database connection settings ADMIN_DATABASE_URL LOG_DATABASE_URL USER_DATABASE_URL_PREFIX |
Description |
Configures access to the timeline, timeline-log and timeline-000 databases. |
Format |
IP address or postgres hostname must be the machine's IP or public name so it can be accessed from Docker containers. By default, PostgreSQL uses port 5432. Make sure that the configured port is not used by any other application and is open on the firewall. If using the default PostgreSQL port, it can be done by using:
|
|
Example |
ADMIN_DATABASE_URL=postgres://trx:[email protected]:5432/timeline LOG_DATABASE_URL=postgres://trx:[email protected]:5432/timeline-log USER_DATABASE_URL_PREFIX=postgres://trx:[email protected]:5432/timeline- |
|
Web server configuration PROXY_PORT PROXY_SSL_PORT |
Description |
Specifies the port configuration available for the application on the host machine. By default, the application listens on port 80 for HTTP and port 443 for HTTPS. If both ports are defined, HTTP requests will be redirected to HTTPS. For details on SSL configuration, see HTTPS configuration. Make sure that the configured ports are open on the firewall and not being used by any other application. If you install the application in a production environment, you are strongly recommended to use HTTPS and not HTTP. |
Format |
PROXY_PORT=<HTTP port> PROXY_SSL_PORT=<HTTPS port> 0 (zero) means that the port is disabled. |
|
Example |
PROXY_PORT=0 PROXY_SSL_PORT=443 |
|
BASE_URL |
Description |
Specifies the base URL that hosts the Process Intelligence website. The hostname should include the port number if it is not the default, and the protocol (http/https) of the server where the application is going to run. The BASE_URL variable is used for links inside email messages sent by Process Intelligence. |
Format |
BASE_URL={protocol}://hostname[:port] |
|
Example |
BASE_URL=http://10.15.61.165
BASE_URL=https://mytimeline.com
|
|
Mail server configuration MAIL_SERVER_HOST MAIL_SERVER_PORT MAIL_SERVER_USERNAME MAIL_SERVER_PASSWORD MAIL_SERVER_TLS_CONNECTION MAIL_SERVER_REQUIRE_TLS MAIL_SERVER_REJECT_UNAUTHORIZED EMAIL_SENDER |
Description |
Specifies SMTP server access to allow Process Intelligence to send out emails such as alert and user invitations. Provide SMTP mail server access credentials such as host, port, username, password, email sender address, and mail server security options.
|
Format |
MAIL_SERVER_HOST=<mail server IP address or hostname> MAIL_SERVER_PORT=<mail server port> MAIL_SERVER_USERNAME=<mail server username> MAIL_SERVER_PASSWORD=<mail server password> MAIL_SERVER_TLS_CONNECTION=<true/false> MAIL_SERVER_REQUIRE_TLS=<true/false> MAIL_SERVER_REJECT_UNAUTHORIZED=<true/false> EMAIL_SENDER=<mail sender e-mail> |
|
Example |
MAIL_SERVER_HOST=example.smtp.server.com MAIL_SERVER_PORT=465 MAIL_SERVER_USERNAME=mail_user MAIL_SERVER_PASSWORD=mail_password MAIL_SERVER_TLS_CONNECTION=false MAIL_SERVER_REQUIRE_TLS=true MAIL_SERVER_REJECT_UNAUTHORIZED=false |
|
Process Intelligence folders LOGS NGINX_CONF DB_SSL STORAGE LICENSE PG_SSL_ROOT_CERT |
Description |
Specifies the locations of directories the app saves data to. Each of these should be directories on the host machine. If you specify relative paths, they will be relative to the installation directory.
By default, all directories are under the installation directory. |
Example |
LOGS=/opt/timeline/logs NGINX_CONF=/opt/timeline/nginx STORAGE_DIR=/opt/timeline/storage LICENSE=/opt/timeline/license |