Upgrade Sitecore with Coveo for Sitecore

This is for:

Developer System Administrator

To benefit from the latest features, enhancements, and bug fixes of Sitecore, you may want to upgrade your instance. This page describes the procedure to follow to upgrade your Sitecore instance with Coveo for Sitecore installed on it.

Best practices

Here are some best practices to follow to avoid common issues when upgrading Sitecore with Coveo for Sitecore installed.

  • Verify that Coveo for Sitecore supports the Sitecore version you’re upgrading to (see Supported Sitecore versions and dependencies).

  • Back up your Sitecore instance with Coveo for Sitecore before upgrading Sitecore. This includes backing up your files, licenses, encryption keys, and databases.

  • Disable your Coveo for Sitecore .config files. They can be found in the <SITECORE_INSTANCE_ROOT>\App_Config\Include\Coveo and <SITECORE_INSTANCE_ROOT>\App_Config\Modules\Coveo folders. This way, you can avoid any potential conflict with other Sitecore .config files.

  • Upgrade Sitecore first and, if applicable, Coveo for Sitecore after.

  • Upgrade from one update of Sitecore to the one strictly consecutive to the one you have installed. For example, if you want to update from Sitecore update 1 to update 3, it’s a good practice to update from update 1 to 2, and then from update 2 to 3.

  • Follow the leading practices when upgrading Coveo for Sitecore.

  • After having finished upgrading Sitecore and Coveo for Sitecore, rebuild your indexes (see Coveo for Sitecore indexing guide).

Upgrade to a new Sitecore update revision

You may want to upgrade your Sitecore version to a new update revision, for example from Sitecore version 10.0 update 1 to 10.0 update 3. In this case, you would need to follow these steps.

With the same release of Coveo for Sitecore

You need to follow the Sitecore upgrade steps found on the Sitecore Developer Portal.

Coveo for Sitecore releases one version per minor Sitecore version per release (see Releases and downloads). Coveo for Sitecore will therefore already be configured for your revision of Sitecore.

With a new Coveo for Sitecore version

If you want to upgrade your Sitecore instance to a new update revision while also upgrading your Coveo for Sitecore version, you need to follow these steps:

  1. In your <SITECORE_INSTANCE_ROOT>\App_Config\Include\Coveo and <SITECORE_INSTANCE_ROOT>\App_Config\Modules\Coveo folders, disable all Coveo .config files. A common practice is to add .disabled at the end of their file name.

  2. Upgrade your Sitecore instance. Follow the upgrade steps found on the Sitecore Developer Portal.

  3. Once your Sitecore instance is upgraded, follow the required upgrade steps for your version.

Upgrade to a new major or minor version of Sitecore

You may want to upgrade your Sitecore version to a new major or minor version, for example from Sitecore version 9.3 to 10.0, or from 10.0 to 10.1 In this case, you need to follow these steps:

  1. In your <SITECORE_INSTANCE_ROOT>\App_Config\Include\Coveo and <SITECORE_INSTANCE_ROOT>\App_Config\Modules\Coveo folders, disable all Coveo .config files. A common practice is to add .disabled at the end of their file name.

  2. Update your Sitecore instance. Follow the steps found on the Sitecore Developer Portal.

  3. Once your Sitecore instance is upgraded, download and install the new Coveo for Sitecore package corresponding to your new Sitecore instance. Follow the steps in the Install article.

    Important

    Make sure that you upgrade to the same Coveo for Sitecore version that you had on your previous Sitecore instance.

    For example, if you had the March 18, 2022 release of Coveo for Sitecore (5.0.1110.1) for Sitecore 10.0 on your Sitecore 10.0 instance, and have now upgraded to Sitecore 10.1, make sure that you install the March 18, 2022 release of Coveo for Sitecore (5.0.1110.1) for Sitecore 10.1.

  4. Using a merge tool such as WinMerge, manually merge your customization from your disabled files into your new .config files.

  5. If you also wanted to upgrade your Coveo for Sitecore version, follow the required upgrade steps for your version.

  6. Rebuild your indexes (see Coveo for Sitecore indexing guide).