Configuring Timeline Using Environment File

The Timeline settings may be configured after the installation.

At the system hosting Timeline, 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 timeline, timeline-log and timeline-000 databases.
Format
  • timeline and timeline-log database URLs have the following format:
    postgres://<username>:<password>@<IP address or 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 or postgres hostname>:<Port>/<Database name prefix: timeline->

<IP address or postgres hostname> should 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 being used by any other application and is open on the firewall. If using the default PostgreSQL port, it can be done by:
firewall-cmd --add-service=postgresql
and
firewall-cmd --runtime-to-permanent

Example

ADMIN_DATABASE_URL=postgres://trx:x@172.18.0.1:5432/timeline

LOG_DATABASE_URL=postgres://trx:x@172.18.0.1:5432/timeline-log

USER_DATABASE_URL_PREFIX=postgres://trx:x@172.18.0.1:5432/timeline-

Web server configuration

PROXY_PORT

PROXY_SSL_PORT

Description

Specifies the ports 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 section 'HTTPS configuration'.

Important.

  • 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, it is strongly recommended to use HTTPS and highly discouraged HTTP.
Format

PROXY_PORT=<HTTP port>

PROXY_SSL_PORT=<HTTPS port>

0 (zero) means the port is disabled.

Example

PROXY_PORT=0

PROXY_SSL_PORT=443

BASE_URL Description

Specifies the Base URL that hosts Timeline. 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 Timeline.

Format BASE_URL={protocol}://hostname[:port]
Example

BASE_URL=http://10.15.61.165
(if use HTTP)

BASE_URL=https://mytimeline.com
(if use 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

MAIL_SERVER_CUSTOM_CONFIG_FILE

Description

Specifies SMTP server access to allow Timeline to send out emails in several features such as Alerting, User invitation, etc.

Provide SMTP mail server access credentials such as host, port, username, password, e-mail sender address, and mail server security options.

  • MAIL_SERVER_USERNAME
    MAIL_SERVER_PASSWORD
    Keep these fields empty if the mail server requires no authentication.
  • MAIL_SERVER_TLS_CONNECTION
    MAIL_SERVER_TLS_CONNECTION=true
    Makes the app connect to the mail server using TLS right from the start. This is the most secure option. Unfortunately, not all mail servers support this. E.g., Exchange requires unencrypted connection, and then use 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 true/false.
  • MAIL_SERVER_REJECT_UNAUTHORIZED
    Set MAIL_SERVER_REJECT_UNAUTHORIZED to false if your mail server uses a self-signed certificate. Default value is true.
  • EMAIL_SENDER
    EMAIL_SENDER is used to fill the 'From' header field of e-mails.
  • MAIL_SERVER_CUSTOM_CONFIG_FILE
    Appears only if you chose to use a custom NodeMailer configuration. This parameter's value will be the JSON file, whose path you provided during the installation.
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>

MAIL_SERVER_CUSTOM_CONFIG_FILE=<config_file_name.json>

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_SENDER=timeline-support@example.com

MAIL_SERVER_CUSTOM_CONFIG_FILE=mailServerConfig.json

SMS service (Twilio account)

TWILIO_ACCOUNT_SID

TWILIO_AUTH_TOKEN

TWILIO_PHONE_NUMBER

Description

These properties appear if Twilio service is enabled upon installation.
Specifies Twilio account access to allow Timeline to send SMS notifications containing verification codes, alert notifications, and error messages.

Provide Twilio account credentials such as SID, Auth Token, sender phone number. All fields are mandatory, for correct configuration all fields should be filled.

  • TWILIO_ACCOUNT_SID
    Is used to identify your Twilio account and serves as its username.
  • TWILIO_AUTH_TOKEN
    Is an access token that Timeline needs to connect to your Twilio account.
  • TWILIO_PHONE_NUMBER
    Valid phone number from which SMS notifications are sent.
Format

TWILIO_ACCOUNT_SID=<your Twilio account SID>

TWILIO_AUTH_TOKEN=<Authorization token belonging to your Twilio account>

TWILIO_PHONE_NUMBER=<PHONE_NUMBER>

Example

TWILIO_ACCOUNT_SID=AC3f84d59206412725a03114dfb5163e33

TWILIO_AUTH_TOKEN=ae356b78c7ch1293h123n2afe6a9

TWILIO_PHONE_NUMBER=+121313141516

Timeline folders

LOGS

NGINX_CONF

DB_SSL

STORAGE

LICENSE

PG_SSL_ROOT_CERT_ADMIN

PG_SSL_ROOT_CERT_LOG

PG_SSL_ROOT_CERT_USER

CUSTOM_CONF

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 refer to the installation directory.

  • LOGS
    All Timeline 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 section '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 presented, the certificate file must be copied to the host machine into this directory.
    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
  • PG_SSL_ROOT_CERT_ADMIN
    PG_SSL_ROOT_CERT_LOG
    PG_SSL_ROOT_CERT_USER
    These are the names of the database CA Root certificate files located in the DB_SSL folder. The file names are hashed to avoid name collision.
    If your remote databases are configured with SSL support and a CA Root certificate files are used, these root certificate files must be specified in these keys.
  • CUSTOM_CONF
    A variable that points to /opt/timeline/config - the intended directory for the custom-configuration files. Do not change this value!

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

PG_SSL_ROOT_CERT_ADMIN=bd469b5612d1807776be854922291ffd.pem

PG_SSL_ROOT_CERT_LOG=bd469b5612d1807776be854922291ffd.pem

PG_SSL_ROOT_CERT_USER=bd469b5612d1807776be854922291ffd.pem

CUSTOM_CONF=opt/timeline/config

9/5/2024 4:23:54 PM

Usage of Cookies. In order to optimize the website functionality and improve your online experience ABBYY uses cookies. You agree to the usage of cookies when you continue using this site. Further details can be found in our Privacy Notice.