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

  • timeline and timeline-log database URLs has one of the following formats:
    postgres://<username>:<password><IP address or postgres hostname>:<Port>/<Database name: timeline or timeline-log>
    • postgres://<username>:<password><IP address
    • postgres hostname>:<Port>/<Database name: timeline or timeline-log>
  • timeline-000 database has a similar format with the difference that the last part defining the database should not contain the number '000':
    • postgres://<username>:<password><IP address
    • postgres hostname>:<Port>/<Database name: timeline->

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:
firewall-cmd --add-service=postgresql
and
firewall-cmd --runtime-to-permanent

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
(if using HTTP)

BASE_URL=https://mytimeline.com
(if using HTTPS)

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.

  • MAIL_SERVER_TLS_CONNECTION
    MAIL_SERVER_TLS_CONNECTION=true makes the app connect to the mail server using TLS from the start. This is the most secure option. However, not all mail servers support this. For example, Exchange requires unencrypted connection, and then uses the STARTTLS command to upgrade. In this case, use: MAIL_SERVER_TLS_CONNECTION=false and MAIL_SERVER_REQUIRE_TLS=true.
  • MAIL_SERVER_REQUIRE_TLS
    To enable/disable TLS, set MAIL_SERVER_REQUIRE_TLS to trueorfalse.
  • MAIL_SERVER_REJECT_UNAUTHORIZED

    Set MAIL_SERVER_REJECT_UNAUTHORIZED to false if your mail server uses a self-signed certificate. The default value is true.

  • EMAIL_SENDER

    EMAIL_SENDER is used to fill the 'From' header field of e-mails.

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

[email protected]

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.

  • LOGS
    All Process Intelligence logs will be placed here.
    Default value: /opt/timeline/logs
  • NGINX_CONF
    This is a directory for SSL configuration and certificates.
    Default value: /opt/timeline/nginx
    For details on SSL configuration, see HTTPS configuration.
  • DB_SSL

    This is a directory for a database certificate file.

    If your remote PostgreSQL is configured with SSL support and a CA Root certificate file is not present, the certificate file must be copied  into this directory on the host machine.

    Default value: /opt/timeline/db-ssl

  • STORAGE
    This directory is used by different parts of the application to permanently or temporarily store data. Make sure that the directories are not world readable and that they are backed up regularly.
    Default value: /opt/timeline/storage
  • LICENSE
    The path to the directory where the license file is located relative to the installation directory.
    Default value: /opt/timeline/license
  • This is the path for a database CA Root certificate file.

    If your remote PostgreSQL is configured with SSL support and a CA Root certificate file used, a path to the root certificate file must be specified in this key.

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