Starting the Search server Docker container with default configurations

Learn how to start Search server Docker container without specifying the CONFIGURE_MODE parameter.

To start the container with default configurations to view files inside the container, use:
docker run -it -e LICENSE=accept search-app
When you start the Search server Docker container using the default configurations, the Search server Docker container  image name is  search-app.

Types of search server configurations

Search server Docker container uses Docker environment variables to identify the type of server (Master/Repeater/Subordinate):
  • To deploy a Search server as the Search Master, specify -e SOLR_MASTER=true -e SOLR_SLAVE=false
  • To deploy a Search server as a Search repeater, specify -e SOLR_MASTER=true -e SOLR_SLAVE=true
  • To deploy a Search server as a Search subordinate, specify -e SOLR_MASTER=false -e SOLR_SLAVE=true

Default host name

When you start the Search server Docker container using the default configurations, the Search server Docker container host name is search.

Mandatory parameters

Parameter name Description Configuration
SPIUSER_NAME Your SPIUSER name. The default value is spiuser.
HCL Commerce Version 9.1.7.0 or laterNote: This value is optional as of HCL Commerce 9.1.7.0.
Container environment variable/Vault
SPIUSER_PWD The encrypted password for the spiuser. For more information, see Setting the spiuser password in your Docker images. Container environment variable/Vault
ADMIN_SPIUSER_PWD The ADMIN_SPIUSER_PWD must be the same value as SPIUSER_PWD but kept as plain text. Container environment variable/Vault
DBHOST The database hostname. Container environment variable/Vault
DBNAME The name of the database. Container environment variable/Vault
DBUSER The database user name. Container environment variable/Vault
DBPASS The database user password. Container environment variable/Vault
DBPORT The database port. Container environment variable/Vault
DBAUSER The database administrator. Container environment variable/Vault
DBAPASSENCRYPT The database administrator password that is encrypted with the wcs_encrypt.sh utility. Container environment variable/Vault
DBPASSENCRYPT The database user password that is encrypted with the wcs_encrypt.sh utility. Container environment variable/Vault
HCL Commerce Version 9.1.12.0 or laterSESSION_KEY_ENCRYPT The encrypted session key.
Note: This parameter was optional in all releases prior to HCL Commerce 9.1.12.0.
Container environment variable/Vault

Optional parameters

Parameter name Description
DB_SSLENABLE Determines whether to enable SSL protocol for connections to the database. Valid values are true or false. The default value is false.
DB_XA Specify if the XA function has been enabled for database. The default value is false.
SOLR_MASTER

SOLR_SLAVE

SOLR_MASTER and SOLR_SLAVE work together to determine the search node type. To configure the Search server container as:
  • Search-master node:
    SOLR_MASTER=true
    SOLR_SLAVE=false
  • Search-repeater node:
    SOLR_MASTER=true
    SOLR_SLAVE=true
  • Search-subordinate node:
    SOLR_MASTER=false
    SOLR_SLAVE=true
SOLR_MASTER_SERVER_URL The IP and port of the search node to poll from. Mandatory for the search-repeater/subordinate on the live environment SOLR_SLAVE=true.
  • For the search-repeater node, specify the
    search-master-ip:3737
  • For the search-subordinate node, specify the
    search-repeater-ip:3737
SOLR_REPLICATION_POLLINTERVAL The replication poll interval.
WORKAREA The search index path in the Search server Docker container. For example,
/search
EXPOSE_METRICS Specify if you want to enable metrics for the HCL Commerce environment.
SESSION_KEY_ENCRYPT The encrypted session key.
Note: This parameter is mandatory in all releases HCL Commerce 9.1.12.0 and greater.

Code example

docker run -it -e LICENSE=accept  \
    -e SPIUSER_NAME=<your spiuser-name> \
    -e SPIUSER_PWD=<your spiuser password that you encrypted with wcs-encrypt.sh>
    -e DBHOST=<db hostname> \
    -e DBNAME=<db instance name> \
    -e DBPASS=<db user password> \
    -e DBPORT=<db port> \
    -e DBUSER=<db user> \
    -e SOLR_MASTER=true \
    <Search Docker image>