Install Coveo for Sitecore With Sitecore in Docker

Coveo has forked the Sitecore/docker-images repository. In the Coveo fork, changes were made to allow Sitecore Docker users to build Coveo for Sitecore and Coveo for Sitecore SXA Docker images along with the Sitecore images.

Once all images are built with the Coveo fork, you can launch Sitecore Docker instances with Coveo for Sitecore pre-installed.

This article provides the recommended procedure to install, activate, configure, and scale Coveo for Sitecore in a Sitecore Docker environment.

Supported Coveo for Sitecore Versions

Coveo for Sitecore and Coveo for Sitecore SXA Docker modules can be generated since version 5.0.1039.1. These modules are compatible with Sitecore 10.0.0 and above.

Coveo recommends you use the latest Coveo for Sitecore release. Consult the Coveo for Sitecore Releases and Downloads page to retrieve the latest release build number, as you will need it in the installation instructions section.

To ensure Coveo for Sitecore supports your Sitecore version, see Supported Sitecore Versions and Dependencies.

Installation Instructions

Step 1: Build Coveo for Sitecore Images

Coveo doesn’t add any images directly in the Coveo docker-images repository. Instead, Coveo for Sitecore images are built when calling the repository Build.ps1 script locally with Coveo-specific parameters. The repository instructions explain how these parameters are used.

EXAMPLE

After running Build.ps1 with both the Coveo for Sitecore and Coveo for Sitecore SXA related tags, you will see changes such as the following in your local branch.

Changes to the repository contents after running build.ps1 command

Step 2: Launch Sitecore Docker Instances With Coveo for Sitecore Pre-Installed

Update your container development Docker files to bundle Coveo with Sitecore in your preferred Sitecore topology instances. See the Sitecore/docker-examples repository documentation for guidance.

Coveo doesn’t offer support for issues with the installation of Coveo for Sitecore in Docker. Once Coveo for Sitecore is installed correctly, Coveo can fix client issues as it does in non-Docker setups.

Step 3: Configure and Activate Coveo for Sitecore

Configure and activate Coveo for Sitecore to link your Sitecore CM instance in Docker to a Coveo Platform organization. In this step, you also configure indexing settings.

Step 4: Scale Coveo for Sitecore

Configuring and activating Coveo for Sitecore on the CM instance in step 3 populated settings in Coveo configuration files. To scale Coveo for Sitecore, you need to copy these configurations over to your CD instance.

Docker provides a command line utility for this purpose.

What's Next for Me?