Configure and activate Coveo for Sitecore using the user interface
Configure and activate Coveo for Sitecore using the user interface
After installing Coveo for Sitecore, it must be configured and activated. The following steps let you link your Sitecore instance to a Coveo organization and to perform indexing configurations.
|
Note
In some circumstances, for example in multi-server setups, you may prefer activating Coveo for Sitecore using PowerShell. |
To configure and activate Coveo for Sitecore using the Command Center
-
In the Coveo for Sitecore Configuration dialog, click Activate Coveo for Sitecore Package.
You can also reach the Coveo for Sitecore Activation page at
https://<INSTANCE_HOSTNAME>/coveo/command-center/index.html
, where<INSTANCE_HOSTNAME>
is replaced with your Sitecore instance name. -
Click Log In.
-
Follow the instructions shown on screen to log in to Coveo using your preferred identity provider.
-
If you already have access to one or several Coveo organizations, a screen with the Select your organization section similar to the following will appear:
-
If you don’t have access to a Coveo organization, a screen with the Select your organization section similar to the following will appear:
-
-
Select or create your Coveo organization.
-
To select an existing organization
-
In the Select your organization section, select the Existing tab.
-
Select the desired organization from the drop-down.
NoteYou can only link to an organization in which you’re a member of the Administrators group.
The flag next to the organization name indicates the region the organization data is hosted in. The flag tooltip provides further details on the organization data residency location.
-
-
To create a new organization
-
In the Select your organization section, select the Create New tab.
-
In the Organization Name field, type the name you want for your Coveo organization.
Notes-
While you can always change your organization display name later in the Coveo Administration Console (platform-ca | platform-eu | platform-au) 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.
-
Organizations created through Coveo for Sitecore are hosted in the
us-east-1
region.
-
-
Select the Organization Type that matches your needs (see Entitlement comparison (Coveo for Sitecore)).
Leading practiceFor a local development environment, select the Test organization organization type.
-
In the Organization Region drop-down, select the data residency region that best suits your needs.
-
-
-
In the Index Sitecore Content section, use the Index Sitecore content check box to specify whether you want to index your Sitecore instance content.
The Index Sitecore content option is associated with the
disableSourceCreation
element in theCoveo.SearchProvider.Custom.config
file. If you unselect Index Sitecore content now and later decide to index Sitecore content, you will need to do the following in theCoveo.SearchProvider.Custom.config
file:-
Set the value of the
disableSourceCreation
element tofalse
. -
Set the Sitecore credential
sitecoreUsername
(i.e., domain\username), andsitecorePassword
element values.
-
-
If you selected Index Sitecore content, in the Configure options section, specify your Sitecore instance indexing-related configurations.
Further details for each option are provided below:
-
Index permissions: Lets you select whether to index Sitecore permissions on the documents. When permissions aren’t indexed, all indexed documents are available to anonymous users. When permissions are indexed, a security provider is created in Coveo to ensure user access to documents follows Sitecore permissions. If your site contains secure content, we recommend that you index the permissions.
-
Body indexing: Lets you select whether the rendered HTML should be indexed.
-
Farm configuration: Lets you specify a Farm name to set coherent names for your resources (i.e., sources and security identity providers).
By default, Coveo for Sitecore sources are named
Coveo_master_index - <FARM_NAME>
andCoveo_web_index - <FARM_NAME>
in your Coveo organization. As a result, if multiple Sitecore instances use the same farm name and are linked to the same Coveo organization, their items are indexed in the same sources.This is rarely useful in a development scenario, but a leading practice in a scaled production environment.
Multiple developers shouldn’t link their instances to the same Coveo organization and use the same farm name. With this setup, a rebuild in one Sitecore instance deletes all items in your Coveo for Sitecore sources that come from the other linked Sitecore instances. Instead, each developer should use their own trial or test Coveo organization.
In a scaled production environment, where multiple Content Management (CM) servers share the same databases, using the same farm name across all CMs and CDs is ideal. This ensures all CMs and CDs pull results from the same public website-related Coveo source (e.g., a
Coveo_pub_index - <FARM_NAME>
source). -
Sitecore credentials: Lets you specify the Sitecore account (domain\username) responsible for crawling the items and expanding permissions (see Sitecore credential usage in Coveo for Sitecore).
Leading practiceCreate a dedicated Sitecore admin user for Coveo and use it in the activation steps. Assigning a dedicated user to Coveo for Sitecore will prevent lock-down issues.
Notes-
If you don’t 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.An encryption key is automatically created in the
core
database (for Sitecore versions up to 9.0 inclusively) or theweb
database (for Sitecore versions 9.1 onwards) of your Sitecore instance.
-
-
-
Click Activate.
Allow 15 to 30 minutes for your Coveo organization to be provisioned.
NoteAt activation, the
.config.example
files below are renamed.-
Coveo.CloudPlatformClient.Custom.config.example
toCoveo.CloudPlatformClient.Custom.config
-
Coveo.SearchProvider.config.example
toCoveo.SearchProvider.config
-
Coveo.SearchProvider.Custom.config.example
toCoveo.SearchProvider.Custom.config
-
Coveo.SearchProvider.Rest.config.example
toCoveo.SearchProvider.Rest.config
-
Coveo.SearchProvider.Rest.Custom.config.example
toCoveo.SearchProvider.Rest.Custom.config
-
Coveo.UI.Controls.config.example
toCoveo.UI.Controls.config
-
Coveo.UI.Components.ExperienceEditor.config.example
toCoveo.UI.Components.ExperienceEditor.config
These configuration files are located under
<SITECORE_INSTANCE_ROOT>\App_Config\Modules\Coveo
, except the*.Custom.config
files which are located under<SITECORE_INSTANCE_ROOT>\App_Config\Include\Coveo
.NoteWhen a Coveo trial organization has been idle for some time, it’s 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 Resume in the dialog box to resume using your organization.
You can also reactivate your organization through the Coveo Administration Console (platform-ca | platform-eu | platform-au), in the notification center.
-
-
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’s important that you only modify the
.Custom.config
files. Modifying the.config
files may lead to unexpected bugs during updates. -
Changes to your
Web.config
file are required to ensure that requests targeting the REST endpoint can handle special characters. -
Restart the Sitecore client.
-
If you’re using the
web
database, publish themaster
database, as items created by Coveo for Sitecore need to be replicated to theweb
database as well.
|
Sitecore on Azure Azure’s Web Application Firewall (WAF) may block Coveo query network calls that trigger OWASP rules. You might need to disable or customize Azure WAF rules to allow Coveo for Sitecore network calls (see Azure Web Application Firewall triggered rules block Coveo for Sitecore’s communication on Content Delivery servers). |
What’s next?
When installing Coveo for Sitecore in a Sitecore configuration with several content management (CM) and content delivery (CD) hosts, see the Coveo for Sitecore scaling guide.
Otherwise you can return to the Coveo for Sitecore deployment guide.