Configuration

You can configure xltrail via the config file: /etc/xltrail/xltrail.conf. If the file doesn't exist, create it by running xltrail config.

NOTE:
  • After changing the config file, you need to run xltrail restart to apply the changes.
  • The config file requires no spaces around the = sign.
  • Comments can be added by starting the line with #.

Auth Provider (optional)

If you want to use LDAP to authenticate users, set this to ldap and follow the detailed instructions here.

AUTH_PROVIDER=ldap

Default: app

CA_CERTIFICATES (optional)

Add a directory with CA certificates. This may be required if e.g. you use LDAP with a self-signed certificate.

CA_CERTIFICATES=/path/to/dir

Data Directory (optional)

All data is stored in this directory on your server.

DATA_DIR=/path/to/dir

Default: /var/lib/xltrail

Docker Registry Password

Required when installing xltrail in online mode via xltrail install. Will be provided to you by email.

DOCKER_REGISTRY_PASSWORD=my_password

Git integration: Do not verify SSL certificates (optional)

This is only relevant if you use the Git integration. If your Git repos sync correctly when disabled (0), disable it for increased security, otherwise leave it at 1. Sometimes 1 is required, e.g. if you’re using a self-signed certificate to serve Git repositories over HTTPS. Must also be 1 when used with gitlab.com.

GIT_SSL_NO_VERIFY=1

Default: GIT_SSL_NO_VERIFY=1

Hostname

Required. Your hostname or IP address.

HOSTNAME=xltrail.mycompany.com

License Key

Required. Will be provided to you by email.

LICENSE_KEY=my_license_key

Minio Secret Key

This will automatically be set to a random value when you run xltrail config for the first time.

MINIO_SECRET_KEY=...

Offline (optional)

If you are on a server without internet access, set this flag to stop the CLI from checking for updates.

OFFLINE=1

Default: OFFLINE=0

Ports (optional)

You can change the ports on which you want xltrail's integrated web server (nginx) to listen:

HTTP_PORT=80
HTTPS_PORT=443

Defaults: HTTP_PORT=80 and HTTPS_PORT=443

Postgres

By default, xltrail uses an internal Postgres database and will automatically create a random POSTGRES_PASSWORD when you run xltrail config for the first time.

POSTGRES_PASSWORD=...

If, however, you want to use an external Postgres server (>= v10.0), you must create a database called xltrail and provide the additional settings below. Make sure that the user has owner rights so it can run database migrations. A full config for an external database looks as follows (note that the port has to be mentioned explicitly under POSTGRES_HOST):

POSTGRES_HOST="mypostgres.com:5432"
POSTGRES_DB="xltrail"
POSTGRES_USER="xltrail_owner"
POSTGRES_PASSWORD="password"

Proxy Address (optional)

If you are behind a proxy server, this is required for online installation and to reach external Git servers. Note that you need to prepare the Docker installation to run correctly behind a proxy, see here. As alternative, you could also use the offline installation.

PROXY_ADDRESS=http://username:password@host:port

SSL Configuration (optional)

If you want to connect to xltrail via https, you need to set the following 3 settings. The example shows a typical setup when using letsencrypt.

HTTPS_ENABLED=1
SSL_CERTIFICATE_KEY=/etc/letsencrypt/live/xltrail.mycompany.com/privkey.pem
SSL_CERTIFICATE=/etc/letsencrypt/live/xltrail.mycompany.com/fullchain.pem

Default: HTTPS_ENABLED=0

STARTUP_TIMEOUT (in seconds, optional)

When running xltrail start or xltrail restart, xltrail exits with exit code 1 if the application isn't up and running after STARTUP_TIMEOUT seconds. By default that is 30 seconds but on some systems you may have to set this to a higher number of seconds, like e.g. 120.

results matching ""

    No results matching ""