Skip to main content
Version: Early Access

Docker environment variables

This topic explains the environment variables that can be configured to customize a Docker image for various scenarios.

PLUGIN_SOURCE​
  • File-based installation of custom plugins.
  • possible values: "filesystem"
  • default value: If this value is not passed, the plugins will be loaded from the Database.
  • example: "filesystem"
ADMIN_PASSWORD​
  • Admin user password used in our products.
  • possible values: "password-value"
  • default value: If this value is not passed, a random 8-character password will be generated.
  • example: "adm_P@ssw0rd_01"
REPOSITORY_KEYSTORE_PASSPHRASE​

  • Repository keystore passphrase used in our products.

  • possible values: "passphrase-string-value"

  • default value: If this value is not passed, a random 16-character password will be generated.

  • example: "XL_P@ssphr@se_01"

    note
    • Keystore password must be at least 6 characters.
REPOSITORY_KEYSTORE​

  • Repository keystore used in our products.

  • possible values: "keystore-string-value"

  • default value: content of ${APP_HOME}/conf/repository-keystore.jceks which is generated from keytool -genseckey -alias deployit-password-key -keyalg aes -keysize 128 -keypass "deployit" -keystore ${APP_HOME}/conf/repository-keystore.jceks -storetype jceks -storepass ${REPOSITORY_KEYSTORE_PASSPHRASE}

  • example: "b3J0IHBvbGljeTogMSBtb250aCBvZiB0ZWNobmljYWwgc3VwcG9ydApFZGl0aW9uOiBUcmlhbAotLS0gU2lnbmF0dXJlIChTSEExd2l0aERTQSkgLS0tCjMwMmMwM"

    note
    • This value is set as a string which will be converted to a base64 value and added to the keystore file like below: echo "${REPOSITORY_KEYSTORE}" | base64 -d > ${APP_HOME}/conf/repository-keystore.jceks
XL_LICENSE​
  • Sets your XL License by passing a base64 string license, which will then be added to the license file. For more information on other options to pass the license as a volume, see Volumes.
  • possible values: "license-base64-value"
  • default value: unregistered license valid for 7 days but you must use ACCEPT_EULA.
  • example: "LS0tIExpY2Vuc2UgLS0tCkxpY2Vuc2UgdmVyc2lvbjogMwpQcm9kdWN0OiOiBUcmlhbAotLS0gU2lnbmF0dXJlIChTSEExd2l0aERTQSkgLS0tCjMwMmMwMjE0MTY5YjUyNGFkYWYwYWRhYmNlZDcyMGM0YmZkMGmVhNTZhNGFiMzk4YTgzNGUyZjJiOWQ1CjI2MzNhHVyZSAtLS0K%"
ACCEPT_EULA​
  • "You must accept the End User License Agreement" if you are unable to provide your own license before the container can start.
  • possible values: "y" or "Y"
  • default value: none
FORCE_UPGRADE​
  • Force upgrade setting. It can be used to perform an upgrade in non-interactive mode by passing the flag -force-upgrades while starting a service.
  • possible values: "true", "false"
  • default value: "false"
XL_CLUSTER_MODE​
  • This is to specify if HA setup is needed and specify modes of setup.
  • possible values: "default", "hot-standby", "full"
  • default value: "default"
XL_DB_URL​
  • This is to set a DB URL that will be used for the repository.
  • possible values: "url-string-value"
  • default value: for XLD "jdbc:h2:file:${APP_HOME}/repository/xl-deploy" for XLR jdbc:h2:file:${APP_HOME}/repository/xl-release
  • example: jdbc:postgresql://postgresql:5432/XLDATABASENAME
XL_DB_USERNAME​
  • Username used to connect to the database configured with our products.
  • possible values: "user-string-value"
  • default value: "sa"
  • example: "xl_user"
XL_DB_PASSWORD​
  • Password used to connect to the database configured with our products.
  • possible values: "password-value"
  • default value: "123"
  • example: "xl_P@ssw0rd01"
XL_METRICS_ENABLED​
  • Flag to expose internal and system metrics over Java Management Extensions (JMX). This is to enable the use of monitoring systems that can read JMX data, with our products.
  • possible values: "true", "false"
  • default value: "false"
GENERATE_XL_CONFIG​
  • Used to generate configuration from environment parameters passed, and volumes mounted with custom changes. If set to false, a default config will be used and all environment variables and volumes added will be ignored.
  • possible values: "true", "false"
  • default value: "true"
USE_IP_AS_HOSTNAME​
  • Used to set the IP address of the container as the hostname for the instance. If set to true, then IP will be used instead of the container ID. This is useful when deploying Deploy as an active-active cluster using docker compose as pekko cannot resolve aliases within the docker network.
  • possible values: "true", "false"
  • default value: "false"
SERVER_URL​
  • This is used for setting a custom server URL instead of a hostname where our products are installed. This can be useful in email notifications where you need users to connect directly to URLs such as a reverse proxy.
  • possible values: "url-string-value"
  • default value: http://localhost:5516/
  • example: http://xl-release.company.com
XL_REPORT_DB_URL​
  • Sets the value for the URL used to connect to the reporting database.
  • possible values: "url-string-value"
  • default value: jdbc:h2:file:${APP_HOME}/repository/xl-release-report
  • example: jdbc:postgresql://postgresql:5432/xl-release-report
XL_REPORT_DB_USERNAME​
  • Sets the value for the username used to connect to the reporting database.
  • possible values: "user-string-value"
  • default value: none
  • example: "xlr_user"
XL_REPORT_DB_PASSWORD​
  • Sets the value for the password used to connect to the reporting database.
  • possible values: "password-value"
  • default value: none
  • example: "rep_P@ssw0rd01"