Installing Coveo for Sitecore

This page covers the installation of Coveo for Sitecore into your Sitecore instance.

Prerequisites

Installation Procedure

Throughout the installation of Coveo for Sitecore, whenever you are prompted to overwrite files or items, proceed to do so. Some dialogs display Apply to all buttons that allow you to overwrite several files or items at a time.

  1. Download the Coveo for Sitecore official package matching your Sitecore instance version (see Releases and Downloads).

  2. Launch the Sitecore Installation Wizard (Sitecore Desktop > Start Menu > Development Tools > Installation Wizard).

  3. In the Install a Package dialog, click Upload package.

  4. In the Upload Files dialog, click Choose File.

  5. Select the Coveo for Sitecore package downloaded earlier.

  6. Back in the Upload Files dialog, click Next.

  7. In the Upload Files dialog, accept file overwriting and click Upload and then click Close. The selected Coveo for Sitecore package appears in the Install a Package dialog.

  8. In the Install a Package dialog, click Next.

  9. Review and accept the terms of the license agreement and click Next. The Install a Package dialog now displays a list of documentation pages you should review before going any further­.

  10. When you are ready, click Next and then Install.

    This operation can take several minutes to complete.

  11. Once the package is installed, the Coveo for Sitecore Configuration screen will appear.

    alternate text

  12. Click Activate Coveo for Sitecore Package.

    The Coveo for Sitecore Activation page appears in a new browser tab.

  13. If you have installed Coveo for Sitecore on a Sitecore 7.2 instance, perform the activation prerequisites that apply to that version of Sitecore only (see Prerequisites For Sitecore 7.2 Instances Only).

    If you have accidentally closed the browser tab in which the Coveo for Sitecore Configuration page was opened in step 12 of the installation procedure, you can reach the Coveo for Sitecore Configuration page at http://[INSTANCE_NAME]/coveo/command-center/index.html, where [INSTANCE_NAME] is replaced by your Sitecore instance name­.

Activating Coveo for Sitecore

After installing Coveo for Sitecore, it must be configured and activated. The following steps allow you to link your Sitecore instance to a Coveo Cloud organization and to perform indexing configurations.

In some circumstances, for instance in multiple server setups, you may prefer activating Coveo for Sitecore programmatically using a REST API (see Silently Activating Coveo for Sitecore).

To configure and activate Sitecore using the Command Center

  1. If you have just installed Coveo for Sitecore, you should currently see the Coveo for Sitecore Activation page. If you have installed the Coveo for Sitecore package but have not yet activated Coveo for Sitecore, you can access the Coveo for Sitecore Activation page through the following URL: http://[INSTANCE_NAME]/coveo/command-center/index.html, where [INSTANCE_NAME] is replaced by your Sitecore instance name­.

    Command Center Activation

  2. Click Log In.
  3. Follow the instructions shown on screen to log into the Coveo Cloud platform using your preferred identity provider.

    • If you already have access to one or several Coveo Cloud organizations, a screen with the Select your organization section similar to the following will appear:

      Activating Existing Organization

    • If you do not have access to a Coveo Cloud organization, a screen with the Select your organization section similar to the following will appear:

      Activating New Organization

  4. Select or create your Coveo Cloud organization.
    • If you already have access to one or several Coveo Cloud organizations, you may either want to select an existing organization or create a new one.
      1. To select an existing organization, in the Select your organization section, under the Existing tab, select the appropriate organization name from the drop-down menu.
      2. To create a new organization, click the Create New tab and proceed as indicated in step b) below.
    • If you do not already have access to a Coveo Cloud organization, you must now create one.
      1. In the Select your organization section, in the Create New tab, type the name you want for your Coveo Cloud organization name.

        While you can always change your organization display name later in the Coveo Cloud Administration Console under Settings > Organization > Profile, be aware that the original name value you specify when creating an organization will forever be part of the unique and permanent ID of that organization.

      2. Select the Trial type that matches your needs (see Pro and Enterprise Edition Features).

  5. In the Configure options section, specify your configuration options.

    Further details for each option are provided below.

    • Security: Allows to select whether to index Sitecore permissions on the documents. When permissions are not indexed, all indexed documents are available to anonymous users. If your site contains secure content, it is recommended to index the permissions.
    • Body indexing: Allows to select whether the rendered HTML should be indexed.
    • Farm configuration: Allows to specify a farm name in order to refer to resources such as sources and security providers with coherent names.
    • Sitecore credentials: Allows to specify the Sitecore account (domain\username) responsible for crawling the items and expanding permissions (see Sitecore Credential Usage in Coveo for Sitecore.

      Coveo for Sitecore 5 - April 2019 If you do not specify a domain in the User name field, Coveo for Sitecore assumes the user is a member of the sitecore domain.

      The password entered on this screen is encrypted and saved in the Coveo.SearchProvider.Custom.config.example file.

      An encryption key is automatically created in the core database of your Sitecore instance.

  6. Click Activate.

    Allow 15 to 30 minutes for your Coveo Cloud organization to be provisioned.

    At activation, the .config.example files below are renamed.

    • Coveo.CloudPlatformClient.Custom.config.example to Coveo.CloudPlatformClient.Custom.config
    • Coveo.SearchProvider.config.example to Coveo.SearchProvider.config
    • Coveo.SearchProvider.Custom.config.example to Coveo.SearchProvider.Custom.config
    • Coveo.SearchProvider.Rest.config.example to Coveo.SearchProvider.Rest.config
    • Coveo.SearchProvider.Rest.Custom.config.example to Coveo.SearchProvider.Rest.Custom.config
    • Coveo.UI.Controls.config.example to Coveo.UI.Controls.config
    • Coveo.UI.Components.ExperienceEditor.config.example to Coveo.UI.Components.ExperienceEditor.config

    For Sitecore 7 and 8 versions, these configuration files are located under [Your Sitecore Instance]\Website\App_Config\Include\Coveo.

    For Sitecore 9 versions, these configuration files are located under [Your Sitecore Instance]\App_Config\Modules\Coveo, except the Coveo.SearchProvider.Custom.config.example file which is located under [Your Sitecore Instance]\App_Config\Include\Coveo.

    When a Coveo Cloud trial organization has been idle for some time, it is paused automatically. If you have selected an existing organization that has been idle for a while, the following dialog box will be displayed:

    You can click the Reactivate button in the dialog box to resume using your organization.

    You can also reactivate your organization through the Coveo Cloud Administration Console, in the left panel, in the Status section.

Final Steps

  1. Depending on your Sitecore revision, there may be some lines that you want to uncomment in the Coveo.SearchProvider.Custom.config file. Scan the file for any relevant section. For example, you may want to uncomment the <field fieldName="culture"> element.

    It is important that you only modify the .Custom.config files. Modifying the .config files may lead to unexpected bugs during updates.

  2. Restart both the Sitecore client and server.

  3. If you are using the web database, publish the master database, as items created by Coveo for Sitecore need to be replicated to the web database as well.

What’s Next?

When installing Coveo for Sitecore in a Sitecore configuration with several Content Management ( CM) and/or Content Delivery (CD) hosts, see the Coveo for Sitecore Scaling Guide.

Otherwise you can return to the Coveo for Sitecore Deployment Guide.

People also viewed