Common Environment Variables
The Commerce applications are configured using container environment variables. Some environment variables must be set and some are optional. The environment variables are read and consumed by the container entrypoint scripts.
important
The entrypoint scripts are and will remain the source of truth on the required environment variables. Review the container entrypoint scripts in your selected release to validate the required variables.
Common to All Commerce Containers
The following table lists the environment variables that are supported by all Commerce containers.
| Variable Name | Description | Required |
|---|---|---|
EP_COMMERCE_ENVNAME | Tells the application which fileset to use when loading configuration from the filesystem at start-up time. The options are defined in the Commerce application code, and correspond to folders in the ep-commerce project under extensions/database/ext-data/src/main/resources/environments. Your Commerce development team can confirm which value to use. | Yes |
EP_DB_USER | Used to set the Java property epdb.username, which is used when connecting to the Commerce database. | Yes |
EP_DB_PASS | Used to set the Java property epdb.password, which is used when connecting to the Commerce database. | Yes |
EP_DB_JDBC_DRIVER_CLASS | Used to set the Java property epdb.jdbc.driver, which is used when connecting to the Commerce database. | Yes |
EP_DB_URL | Used to set the Java property epdb.url, which is used when connecting to the Commerce database. | Yes |
epDbConnectionProperties | Used to set the Java property epdb.jdbc.properties, which is used when connecting to the Commerce database. | Yes |
EP_DB_FACTORY | Used to set the Java property epdb.data.source.factory, which is used when connecting to the Commerce database. | Yes |
EP_DB_TYPE | Used to set the Java property epdb.data.source.type, which is used when connecting to the Commerce database. | Yes |
EP_DB_VALIDATION_INTERVAL | Used to set the Java property epdb.validation.interval, which is used when connecting to the Commerce database. | Yes |
EP_DB_VALIDATION_QUERY | Used to set the Java property epdb.validation.query, which is used when connecting to the Commerce database. | Yes |
EP_JMS_TYPE | Used to set the Java property ep.jms.type, which is used when connecting to the Java messaging service. | Yes |
EP_JMS_FACTORY | Used to set the Java property ep.jms.factory, which is used when connecting to the Java messaging service. | Yes |
EP_JMS_URL | Used to set the Java property ep.jms.url, which is used when connecting to the Java messaging service. | Yes |
EP_SMTP_HOST | Used to set the Java property ep.smtp.host, which is used when optionally integrating with an SMTP email service. | No |
EP_SMTP_PORT | Used to set the Java property ep.smtp.port, which is used when optionally integrating with an SMTP email service. | No |
EP_SMTP_SCHEME | Used to set the Java property ep.smtp.scheme, which is used when optionally integrating with an SMTP email service. | No |
EP_SMTP_USER | Used to set the Java property ep.smtp.username, which is used when optionally integrating with an SMTP email service. | No |
EP_SMTP_PASS | Used to set the Java property ep.smtp.password, which is used when optionally integrating with an SMTP email service. | No |
EP_CORS_ALLOWED_ORIGINS | Used to configure the CorsFilter in the web.xml file, used in the Cortex application. | No |
EP_CORS_ALLOWED_METHODS | Used to configure the CorsFilter in the web.xml file, used in the Cortex application. | No |
EP_CORS_ALLOWED_HEADERS | Used to configure the CorsFilter in the web.xml file, used in the Cortex application. | No |
EP_CORS_EXPOSED_HEADERS | Used to configure the CorsFilter in the web.xml file, used in the Cortex application. | No |
ENABLE_JMX | Set this to true to enable JMX authentication. | No |
JMX_AUTH | Set this to true to enable JMX authentication. Ignored if ENABLE_JMX is not set to true. | No |
ENABLE_DEBUG | Set this to true to enable Java debug. | No |
EP_X_JVM_ARGS | Can be used to set additional custom Java arguments across all Commerce applications. | No |
EP_COMMERCE_CONFIG_REPO | Required when using a secure configuration Git repository, as described in Managing Secrets. | No |
EP_COMMERCE_CONFIG_GPG_KEY | Required when using a secure configuration Git repository, as described in Managing Secrets. | No |
EP_COMMERCE_CONFIG_SSH_KEY | Required when using a secure configuration Git repository, as described in Managing Secrets. | No |
EP_COMMERCE_CONFIG_HOST_KEY | Required when using a secure configuration Git repository, as described in Managing Secrets. | No |
Application-Specific Environment Variables
The applications have a small number of application-specific environment variables. For more information, see the application-specific pages in this section.