HCL Commerce Version 9.1.7.0 or later

Starting the Must-Gather Docker container by retrieving parameters from container environment variables

Learn about how to start the Must-Gather server Docker container by specifying CONFIGURE_MODE=EnvVariables.

Mandatory parameters

Parameter name Value
LOG_ELASTICSEARCH_HOST The Elasticsearch service host name for the logging system.
LOG_ELASTICSEARCH_PORT The Elasticsearch service port number for the logging system.
ELASTICSEARCH_HOST The Elasticsearch service host name.
NIFI_HOST The NiFi service host name.
REGISTRY_HOST The Registry service host name.
DATA_QUERY_HOST The Data Query service host name.
AUTH_QUERY_HOST The authoring search Query service host name.
LIVE_QUERY_HOST The live search Query service host name.
INGEST_HOST The search Ingest service host name.
SPIUSER_NAME The 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.

ADMIN_SPIUSER_PWD The same value as SPIUSER_PWD but kept as plain text.

Optional parameters

Parameter name Value
ELASTICSEARCH_PORT The Elasticsearch service port number.

The default value is 9200.

NIFI_PORT The NiFi service port number.

The default value is 30600.

REGISTRY_PORT The Registry service port number.

The default value is 30400.

DATA_QUERY_PORT The Data Query port number.

The default value is 30900.

AUTH_QUERY_PORT The authoring search Query port number.

The default value is 30900.

LIVE_QUERY_PORT The live search Query port number.

The default value is 30900.

INGEST_PORT The search Ingest service port number.

The default value is 30800.

MAX_DOCS_PER_SERVICE The maximum number of documents to be retrieved.

The default value is 10000.

Code example

docker run -it -e LICENSE=accept  \ 
    -e CONFIGURE_MODE=EnvVariables 
    -e LOG_ELASTICSEARCH_HOST=<elasticsearch host name for logging> \ 
    -e LOG_ELASTICSEARCH_PORT=<elasticsearch port number for logging> \ 
-e NIFI_HOST=<nifi host name> \ 
-e REGISTRY_HOST=<registry host name> \ 
-e DATA_QUERY_HOST=<data query host name> \ 
-e AUTH_QUERY_HOST=<auth query host name> \ 
-e LIVE_QUERY_HOST=<live query host name> \ 
-e INGEST_HOST=<ingest host name> \ 
    <mustgather Docker image>