HCL Commerce Version 9.1.12.0 or later

Starting the Tooling Web Docker container by retrieving parameters from container environment variables

Learn about how to start the Tooling Web Docker container by specifying CONFIGURE_MODE=EnvVariables.

Mandatory parameters

Parameter name Value
ALLOW_TELEMETRY Specifies whether Google Analytics is enabled or not.

The default value is yes.

Accepted values are:
  • yes to enable Google Analytics.
  • no to disable Google Analytics.
Important: When starting the Tooling Web Docker container in versions 9.1.12.0 through 9.1.14.0, you must set the container deployment type. Failure to do so will prevent the container from starting. Ensure that you set the deployment type via the DEPLOYMENT_TYPE container environment variable, or in Vault at the following path ${VAULT_URL}/${TENANT}/${ENVIRONMENT}/deploymentType. Accepted values are development, staging, or production.

Optional parameters

Parameter name Value
DEPLOYMENT_TYPE The deployment type.

This value is required when allowTelemetry value is yes.

Accepted values are:
  • development,
  • staging,
  • production.
Important: When starting the Tooling Web Docker container in versions 9.1.12.0 through 9.1.14.0, you must set the container deployment type. Failure to do so will prevent the container from starting. Ensure that you set the deployment type via the DEPLOYMENT_TYPE container environment variable, or in Vault at the following path ${VAULT_URL}/${TENANT}/${ENVIRONMENT}/deploymentType. Accepted values are development, staging, or production.
HCL Commerce Version 9.1.14.0 or laterEXTERNAL_DOMAIN_NAME The external domain name for the Web server Docker container (ts-web). For example, mycompany.com.
HCL Commerce Version 9.1.14.0 or laterEXTRA_CSP_SOURCE Specify additional host names for the Content Security Policy (CSP) for the Web server Docker container (ts-web). The format of this value must conform to the content security policy source list standard.

Failure to specify CSP correctly will trigger Cross Site Scripting (XSS) protection in browsers. Third-party analytics, images, style sheets, or other scripts that are hosted on a secondary domain or third-party domain will fail to load in the browser, resulting in features of your site failing otherwise gracefully.

The default values supplied by HCL Commerce include your domain (EXTERNAL_DOMAIN_NAME), as well as analytics and file hosting from Google. Additional hostnames supplied via this variable include frame-ancestors, frame-src, default-src, child-src, script-src, connect-src, style-src, font-src and img-src definitions.

For example:
*.seconddomain.com
or
*.seconddomain.com *.thirdpartydomain.com

Code example

docker run -it -e LICENSE=accept  \
    -e ALLOW_TELEMETRY=<default value is yes>
	-e DEPLOYMENT_TYPE=<required when ALLOW_TELEMETRY is yes> \
    <Tooling web Docker image>