Home
Installing
Learn how to install the product.
Install and deploy HCL Compass
Find information about installing and deploying HCL Compass client and server software
Getting started with Docker
Learn how to install, configure, and launch the HCL Compass Docker Containers with RESTful APIs and HCL Compass search.
Mounting HCL Compass Windows package in a HCL Compass REST API server Docker container
You can mount the Windows package into a REST API server Docker container

Installing
Learn how to install the product.
- Install and deploy HCL Compass
  Find information about installing and deploying HCL Compass client and server software
  - Planning the deployment and installation
    Before installing HCL Compass, complete planning tasks to determine what Compass components to install, review system requirements, and complete required and optional configuration tasks to prepare your environment for the Compass installation process.
  - Prerequisites and changes for using HCL Compass
    Starting with HCL Compass there are prerequisites and changes to the supported platforms.
  - Prerequisite planning for installing HCL Compass
    Information about installing HCL Compass.
  - User privilege requirements for installing the product
    You must have a user ID that meets the following requirements before you can install the product.
  - Installation Manager tasks
    Information about installing, starting, and uninstalling Installation Manager
  - Installing silently
    Use IBM Installation Manager to run a silent install of an HCL product. When you run a silent install, the Installation Manager interface is not available. Installation Manager uses a response file that contains commands required to install the product package.
  - Installing the product package using the Installation Manager GUI
    The following steps describe how to install the product package by using the Installation Manager graphical user interface (GUI). You can optionally install product updates at the same time that the base product package is installed; skip the update steps in this topic if they do not apply to your installation.
  - Prepare the WebSphere® Application Server environment
    Before you install HCL VersionVaultHCL Compass web features, install a supported version of IBM® WebSphere Application Server, IBM HTTP Server, and Web Plug-ins for IBM WebSphere.
  - Disable Terminal Services before installing, upgrading, or modifying HCL Compass
    On Windows™ systems, disable Terminal Services before update, roll back, modify, or uninstall operations.
  - Installing HCL Compass Web server
    Use IBM Rational® Installation Manager to install the HCL Compass Web server.
  - Getting started with Docker
    Learn how to install, configure, and launch the HCL Compass Docker Containers with RESTful APIs and HCL Compass search.
    - Install and deploy Opensearch, Opensearch Dashboards and Logstash to support HCL Compass dashboards for business analytics
      Business analytics and dashboard support is offered as part of a technical preview. Support will be provided on a best effort basis.
    - Install and deploy HCL Compass container with Single Sign On feature using Keycloak
      Keycloak provides open source identity and access management and can be integrated with HCL Compass to support Single Sign On (SSO) in HCL Compass.
    - Installing HCL Compass by using the keycloak.json file
      Keycloak provides open source identity and access management and can be integrated with HCL Compass to support Single Sign On (SSO) in HCL Compass.
    - Installing HCL Compass with SCM Integration Enablement
      HCL Compass Software Configuration Management (SCM) integration supports changes in the software for HCL VersionVault Express, GitLab, and GitHub.
    - Mounting HCL Compass Windows package in a HCL Compass REST API server Docker container
      You can mount the Windows package into a REST API server Docker container
    - Creating new database connections and updating database connections on a running container
      The cqreg add_dbset command runs via Docker run command by passing the database parameters as environment variables.
    - Creating and attaching a volume to the hcl-compass Docker container
      This quick start guide shows you how to create and attach a volume to the hcl-compass Docker container.
    - Upgrading the HCL Compass Docker image and container
      The best way to update an existing container with the newest image is to download the latest image and launch a new container with the same configuration. This quick start guide will help you update your container with the newest HCL Compass Docker image.
    - Upgrading HCL Compass RESTful server API instance in the HCL Compass Docker container
      To update the HCL Compass RESTful server APIs with the latest version, you must have the HCL Compass RESTful server APIs zip file. This quick start guide shows you how to update or patch the HCL Compass RESTful server APIs in the HCL Compass Docker container.
  - Getting started with Docker Compose
    Docker Compose is a tool that is used for running dockerized applications in a development environment.
  - Getting started with HCL Compass Helm Chart
    Learn how to install, configure, and launch the HCL Compass Helm chart in your own Kubernetes environment.
  - Configuring your environment after installing
    After installing HCL Compass, there are series of tasks to perform to verify that the installation has completed successfully and to configure the installation for your site.
- Using HCL installation and packaging utilities

Mounting HCL Compass Windows package in a HCL Compass REST API server Docker container

You can mount the Windows package into a REST API server Docker container

Before you begin

Note: Using HCL Compass on Docker and Docker Compose is not supported when deployed in a production environment. To use HCL Compass in a container in a production environment, deploy HCL Compass to a Kubernetes environment.

For more information, see Deploying HCL Compass on SoFy Sandbox.

Procedure

Deploy hcl-compass-win-install container to create persistence volume for the HCL Compass windows product package.

```bash
docker run --rm -d --name hcl-compass-win-install \
 -v hcl-compass-win-install:/ccm/win-install \
 hclcr.io/compass/hcl-compass-win-install:2.2.0

To see and check the hcl-compass-win-install persistence volume, run the docker inspect volume command to find the Mountpoint location.
```
docker inspect volume hcl-compass-win-install
```

Add the following setting to the Docker hcl-compass run command in Getting started with Docker.

--mount source=hcl-compass-win-install,destination=/opt/hcl/compass/compass-rest-server-distribution/win-install  \