Home
Documentation
HCL Commerce is a high-availability, highly scalable and customizable e-commerce platform. Able to support hundreds of thousands of transactions per day, HCL Commerce allows you to do business with consumers (B2C) or directly with businesses (B2B). HCL Commerce uses cloud friendly technology to make deployment and operation both easy and efficient. It provides easy-to-use tools for business users to centrally manage a cross-channel strategy. Business users can create and manage precision marketing campaigns, promotions, catalog, and merchandising across all sales channels. Business users can also use AI enabled content management capabilities.
Installing and deploying
Learn how to install and deploy HCL Commerce development environments and HCL Commerce production environments.
Setting up HCL Commerce environments
Learn how to set up development, testing, and production environments, and how to update the production environment through deploying custom changes and applying maintenance.
Setting up an HCL Commerce production environment
You can set up your production environment however you like by using the provided Docker images for your HCL Commerce servers.
Prerequisites for your production environment
Before you set up the HCL Commerce production environment, perform these steps to ensure that your environment satisfies the prerequisite software.
HCL Commerce container users and privileges
In earlier releases of HCL Commerce, Docker images were run with root privileges by default. Beginning with HCL Commerce 9.1.14.0, provided HCL Commerce application images are supplied with a non-root user and user group. This user is intended to be used to run the containers and their applications within your deployment, more strictly limiting access to host container resources.
Running Docker images as the root user
In previous versions of HCL Commerce, Docker images were run with root privileges by default. This default setting changed in HCL Commerce 9.1.14.0 to ensure that full access is denied to the image and its contents. This change improves overall deployment security, but has major implications to existing deployments.

Documentation
HCL Commerce is a high-availability, highly scalable and customizable e-commerce platform. Able to support hundreds of thousands of transactions per day, HCL Commerce allows you to do business with consumers (B2C) or directly with businesses (B2B). HCL Commerce uses cloud friendly technology to make deployment and operation both easy and efficient. It provides easy-to-use tools for business users to centrally manage a cross-channel strategy. Business users can create and manage precision marketing campaigns, promotions, catalog, and merchandising across all sales channels. Business users can also use AI enabled content management capabilities.
- Getting started
  HCL Commerce has different advantages for business users, administrators and developers. HCL Commerce targets each of these roles with a tailored set of offerings so that each of your users can get maximum benefit.
- Installing and deploying
  Learn how to install and deploy HCL Commerce development environments and HCL Commerce production environments.
  - HCL Commerce assemblies
    HCL Commerce consists of HCL Commerce Enterprise, and HCL Commerce Developer, a separate offering that is used by developers of the platform. Each offering is logically divided into subpackages called electronic assemblies, or eAssemblies. An eAssembly is a group of software that is devoted to a particular platform or environment. Each eAssembly contains the individual product images for that environment, called parts. Which parts you need depends on your usage and configuration choices.
  - Downloading software
    To set up an HCL Commerce production, development, or test environment, you require the associated product software images.
  - Supported software levels, fixes, and settings
    The following table provides a list of generally available (GA) software levels, fixes, and settings for the latest HCL Commerce Version 9.1 release.
  - Hardware requirements
    The following reference provides a general guideline for the hardware capacity that is required for the HCL Commerce Version 9.1 release. This includes both full development and production environments for sites that are based on different sets of HCL Commerce solutions.
  - Setting up HCL Commerce environments
    Learn how to set up development, testing, and production environments, and how to update the production environment through deploying custom changes and applying maintenance.
    - Setting up an HCL Commerce development environment
      This section describes how to set up an HCL Commerce development environment. The HCL Commerce development environment is a flexible collection of software, collectively known as HCL Commerce Developer, for developers or system administrators to develop and test stores and HCL Commerce application code.
    - Setting up an HCL Commerce production environment
      You can set up your production environment however you like by using the provided Docker images for your HCL Commerce servers.
      - Planning your production environment
        Before you set up your production environment, ensure that you understand the HCL Commerce application structure and that you are familiar with basic steps for setting up the environment.
      - Prerequisites for your production environment
        Before you set up the HCL Commerce production environment, perform these steps to ensure that your environment satisfies the prerequisite software.
        Globalization
        Before you install HCL Commerce, ensure that the system meets all globalization prerequisites for your operating system.
        Preparing a Docker host server to launch Utility server Docker container
        The Utility server Docker container contains a tool that you can use to set up the HCL Commerce database schema and initialize the database. It is recommended that you prepare a dedicated server where you can run the Utility server Docker container and initialize all new databases.
        HCL Commerce container users and privileges
        In earlier releases of HCL Commerce, Docker images were run with root privileges by default. Beginning with HCL Commerce 9.1.14.0, provided HCL Commerce application images are supplied with a non-root user and user group. This user is intended to be used to run the containers and their applications within your deployment, more strictly limiting access to host container resources.
        Updating PVC file permissions
        To upgrade your Kubernetes deployment from using the root user to using the non-root user, you must update your Persistent Volume Container (PVC) to account for the different file permissions. This permission update is only necessary if you use the Assets Tool and have an existing readWriteMany PVC.
        Running Docker images as the root user
        In previous versions of HCL Commerce, Docker images were run with root privileges by default. This default setting changed in HCL Commerce 9.1.14.0 to ensure that full access is denied to the image and its contents. This change improves overall deployment security, but has major implications to existing deployments.
        Running Docker images as a non-root user (prior to 9.1.14.0)
        Prior to HCL Commerce 9.1.14.0, Docker images ran with root privileges by default. You can change this default setting to ensure that full access is denied to the image and its contents.
        Setting the spiuser password in your Docker images
        An administrator needs to choose a password for a default SPI user that is named spiuser, and then set the spiuser password in the HCL Commerce Docker containers.
        Configuring a database
        Prepare an IBM Db2 or Oracle database to use as the HCL Commerce database.
      - Deploying HCL Commerce to production environments
        HCL Commerce provides all applications in Docker images for deployment in a configuration of your choice. Also included are Kubernetes Helm Charts and Docker Compose sample files. Kubernetes is the intended deployment method for a live production site, however a production environment for testing, debugging or developing purposes can be deployed using the more simple Docker Compose method.
    - Default port numbers
      Review this information for the default port numbers that are used by HCL Commerce services or the component products.
  - Deploying custom changes
    With HCL Commerce Version 9.1, you can customize HCL Commerce Docker image with the source code, configurations, and the Docker container start-up logic. Learn how to build Docker images with your customized code and deploy the images (and other changes) to your Docker containers.
  - Updating HCL Commerce overview
    Learn about HCL Commerce release types, and learn how to update your custom HCL Commerce site deployments.
- Migrating
  Before you migrate to HCL Commerce Version 9.1, review this information to help plan and execute your migration.
- Operating
  Topics in the Operating category highlight tasks that are typically performed by business users, customer support representatives, to complete their day-to-day tasks in the operation of the HCL Commerce site.
- Integrating
  Topics in the Integrating category highlight the tasks that are commonly performed for using HCL Commerce in combination with other products.
- Administering
  Topics in the Administering category highlight tasks that are typically performed by the Site Administrator, to support daily operations of the HCL Commerce site.
- Customizing
  The topics in the Customizing section describe tasks performed by an application developer to customize HCL Commerce.
- Tutorials
  HCL Commerce provides many tutorials to help you customize and understand your HCL Commerce instance and stores.
- Samples
  Topics in the Samples category highlight the various samples that are provided with HCL Commerce.
- Compliance
  The following section describes how you can leverage HCL Commerce features and functionality to help your site be compliant with different privacy and security standards.
- Securing
  These topics describe the security features of HCL Commerce and how to configure these features.
- Performance
  Topics in the Performance section describe the means by which to plan, implement, test, and re-visit the optimization of HCL Commerce site performance.
- Troubleshooting
  Topics in the Troubleshooting section highlight common issues that are encountered with HCL Commerce, and how they can be addressed or mitigated.
- Reference
  Topics in the Reference section contain all of the HCL Commerce reference documentation.

HCL Commerce Version 9.1.14.0 or later

Running Docker images as the root user

In previous versions of HCL Commerce, Docker images were run with root privileges by default. This default setting changed in HCL Commerce 9.1.14.0 to ensure that full access is denied to the image and its contents. This change improves overall deployment security, but has major implications to existing deployments.

Before you begin

Learn about the benefits, limitations, and requirements for running your Docker images as a non-root user before upgrading to HCL Commerce 9.1.14.0 or greater. For more information, see HCL Commerce container users and privileges.

About this task

While it is recommended to run HCL Commerce containers as a non-root user, existing limitations can prevent existing deployments from fully functioning with this change.

Docker-based deployments as root are no longer supported with HCL Commerce 9.1.14.0 or greater.
For Kubernetes deployments, you can configure your HCL Commerce Helm Chart to deploy HCL Commerce containers as the root user. It is recommended to only do so temporarily, while taking the time to address any incompatibilities as soon as possible for future deployments.

Procedure

Deploy your HCL Commerce Helm Chart with the runAsNonRoot.enabled parameter set to false in your values.yaml configuration file.

For more information on the HCL Commerce Kubernetes deployment and the HCL Commerce Helm Chart, see Deploying HCL Commerce Version 9.1 on Kubernetes.

Results

HCL Commerce Docker images are now run with root privileges. It is highly recommended to modify your deployment to conform with the inclusion of the non-root user, to increase your deployment security, and to conform with future HCL Commerce updates.