Starting Store server Docker container by retrieving parameters from container environment variables

Learn about how to start Store server Docker container by specifying CONFIGURE_MODE=EnvVariables.

Mandatory parameters

Parameter name Value
SPIUSER_NAME Your SPIUSER name. The default value is spiuser.
Note: From version 9.1.7.0 onward, the SPIUSER_NAME parameter is optional. If it is not specified, then the default value is assumed.
SPIUSER_PWD The encrypted password for the spiuser. For more information, see Setting the spiuser password in your Docker images.
TX_HOST The Transaction server hostname.
SEARCH_HOST The Search server hostname.
ELASTICSEARCH_ENABLED Specify if the environment is using the Elasticsearch-based or Solr-based search solution. Accepted values are true for Elasticsearch-based search, and false for Solr-based search.

Optional parameters

Parameter name Value
TX_PORT The Transaction server port. The default value is 5443.
SEARCH_PORT The Search server port. The default value is 3738 for Solr-based search or 30901 for Elasticsearch-based search.
SEARCH_SCHEME The Search scheme. The default value is https.
SSLPort The remote store page redirect secure port.
NONSSLPort The remote store page redirect non-secure port.
TRACE_SPEC Sets trace specifications. For more information about trace, see Trace components.
KAFKA_SERVERS The Kafka server. Works with ZOOKEEPER_SERVERS if you want to configure the container to catch validation.
Note: The KAFKA_SERVERS, ZOOKEEPER_SERVERS, and KAFKA_TOPIC_PREFIX parameters must be provided together.
ZOOKEEPER_SERVERS Works with KAFKA_SERVERS, if you want to configure the container to catch validation.
KAFKA_TOPIC_PREFIX This parameter is used to compose the queue name for the cache invalidation.
HEALTH_CENTER_ENABLED Specify whether Health Center is enabled. Accepted values are true and false.

The default value is false.

EXPOSE_METRICS Specify if you want to enable metrics for the commerce environment.
ADMIN_SPIUSER_PWD The same value as SPIUSER_PWD but keep as plain text.

Code example

docker run -it -e LICENSE=accept  \
    -e CONFIGURE_MODE=EnvVariables
    -e SPIUSER_NAME=<your spiuser-name> \
    -e SPIUSER_PWD=<your spiuser password that you encrypted with wcs_encrypt.sh> \
    -e TX_HOST=<Transaction server hostname, default port is 5443> \
    -e SEARCH_HOST=<specify search service hostname, default port is 3738> \
    -e ELASTICSEARCH_ENABLED =< Specify if the environment should use elasticsearch-based search or solr-based search >
    <Store Docker image>