HCL Commerce Version 9.1.13.0 or later

Starting the Nextjs (Ruby) store Docker container with default configurations

Learn how to start the Nextjs (Ruby) store Docker container.

To start the container with default configurations to view files inside the container, use:
docker run -it -e LICENSE=accept nextjs-store-app
When you start by using the default configurations, the Nextjs (Ruby) store Docker container Docker image name is nextjs-store-app.

Default host name

When you start by using the default configurations, the Nextjs (Ruby) store Docker container  host name is nextjs-store.

Mandatory parameters

Parameter name Value
MAP_API_KEY The Google Maps API key that is used by the React store.
Note: A placeholder value can be used to enable you to start the container. For example, google-api-key.

Optional parameters

Parameter name Description
TX_HOST The Transaction server host name. The default value is app.
TX_PORT The Transaction server port number.

The default value is 5443.

SEARCH_HOST The Search server hostname, which is referring to the Query service for the Elasticsearch-based search solution.

The default value is search.

SEARCH_PORT The auth or live Query server port.

The default value is 30901.

SEARCH_SCHEME The auth or live Query server scheme.

The default value is https.

LOG_LEVEL The log level used for troubleshooting purposes.
Available log levels are:
  • trace
  • debug
  • info
  • warn
  • error
  • fatal
Note:
  • When configured as trace, all messages are displayed.
  • When configured as debug, all messages are displayed except those tagged as trace.
  • When configured as info, all messages at levels info through fatal are displayed.
By default, server-side API client log messages are displayed at level:
  • HCL Commerce Version 9.1.14.0info
  • HCL Commerce Version 9.1.13.0trace
.
TRACE_DETAIL Defines which API methods are logged.
Functions can be filtered using a comma-separated list.
TRACE_DETAILS=findProducts,getV2CategoryResources
This specification will display the log messages from the findProducts and the getV2CategoryResources functions only.
By default, this value is left empty. This implies that all functions are logged.
TRACE_DETAILS= 
LOG_SENSOR_STRING Defines the masking string that is used in logs to mask sensitive information, for example, messages with GDPR-related content. The set of values to mask are identified by their keys in the logging/core/redactionKeys.ts configuration file. For more information, see https://getpino.io/#/docs/redaction.

The default value given in the template is **GDPR COMPLIANT**. If the value is empty, or not set, then the censor string that is used is ****.

HCL Commerce Version 9.1.14.0 or laterNODE_INSTANCE_NUMBER Defines the maximum number of concurrent Node processes that can be run by the Node.js cluster API.
Note: The value that is specified in Vault takes precedence over other configuration methods.

Code example

For example, to start with mandatory parameters, run the following command.
docker run -it -e LICENSE=accept  \  
    -e MAP_API_KEY=Api-key \ 
Nextjs-Store-Docker-image