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 |
<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: |
|
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.
|
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 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 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.
|
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. Provide Twilio account credentials such as SID, Auth Token, sender phone number. All fields are mandatory, for correct configuration all fields should be filled.
|
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 LICENSE 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.
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