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.
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.
HCL Commerce production environment overview
HCL Commerce is separated into different applications that run within Docker containers. HCL provides the following Docker images that you can deploy to run your HCL Commerce application.
Accessing Docker image Help
You can access HCL Commerce Docker image Help documents directly on your environment. Use the Help documents to learn about the parameters that you need to specify to deploy a container.

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.
        HCL Commerce production environment overview
        HCL Commerce is separated into different applications that run within Docker containers. HCL provides the following Docker images that you can deploy to run your HCL Commerce application.
        Accessing Docker image Help
        You can access HCL Commerce Docker image Help documents directly on your environment. Use the Help documents to learn about the parameters that you need to specify to deploy a container.
        Environment data in Vault
        Vault is supported for storing sensitive key-value pairs for Docker configuration. If you want to use this method of environment configuration, set CONFIGURE_MODE to Vault. With this setting, startup scripts fetch environment-related data from Vault when you start a Docker container.
        Managing certificates manually
        If your internal or third party certificates are not stored in a remote configuration management center such as Vault, you can also define the certificates locally in a JSON file.
        Managing certificates with Vault
        By default, the HCL Commerce Docker containers support the use of Vault as the certificate management system.
        Planning your production environment infrastructure
        The production environment is the live environment that is open for business and accessible to shoppers. Before you open your site to serve live traffic, ensure that you have a robust system that is configured to optimize and maintain the containers that are running your HCL Commerce application.
        HCL Commerce deployment checklist
        The HCL Commerce deployment checklist is based on lessons learned from internal groups, external customers and business partners deploying HCL Commerce-based solutions. This checklist is intended to provoke discussion; it is not a detailed set of instructions.
        How to increase your success with HCL Commerce deployment
        Use these tips and best practices to help you successfully deploy HCL Commerce.
      - 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.
      - 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.

Accessing Docker image Help

You can access HCL Commerce Docker image Help documents directly on your environment. Use the Help documents to learn about the parameters that you need to specify to deploy a container.

Before you begin

Ensure that you loaded the Docker images on your host machine.

Procedure

Find the Docker image for which you need help.
```
docker images
```
Run the following command to view the Help document for a specific Docker image.
```
docker run -it -e LICENSE=accept <IMAGE_ID> help
```
Use the REPOSITORY:TAG or the IMAGE ID.