Installation Procedure
2.
Upload and install the last Coveo for Sitecore official package
corresponding to your Sitecore version from Downloads using the Sitecore Installation Wizard
( Sitecore Desktop > Start Menu > Development
Tools > Installation Wizard).
This operation can take several minutes to
complete. If you are asked whether to overwrite files or items during the
installation, click Yes to all.
3.
Once the package is installed, the Coveo for Sitecore
Configuration Wizard will appear.
4.
From the Welcome screen, you can access useful
documentation about the installation process. When you are ready to proceed,
click Next.
5.
In the Connect to Coveo Cloud screen:
a.
Click Sign-Up or Log Into Coveo Cloud.
b.
In the Log into Coveo Cloud page, choose your
authentication provider and enter your credentials.
c.
In the Grant Privileges page, click Authorize.
6.
In the Coveo Cloud Organization screen:
a.
If you do not have access to a Coveo organization, you will be
given the opportunity to create one.
If you have bought a Coveo for Sitecore Pro or
Enterprise edition subscription, you should already have access to an
organization with those rights, and should follow step 6.b instead.
i.
In New organization name, enter the name of your new
organization.
ii.
In Select your license plan, select On-Premises
Free Edition.
iii.
Click Next.
b.
If you already have access to a Coveo Cloud organization, you
should be able to select an existing organization:
i.
Select your organization.
ii.
Click Next.
c.
If you already have access to a Coveo organization, but would
like to create a new organization:
i.
In the drop-down, select Create new organization.
ii.
In New organization name, enter the name of your new
organization.
iii.
In Select your license plan, select On-Premises
Free Edition.
iv.
Click Next.
7.
In the Configure where the Coveo index is located screen:
a.
Choose either one of these options:
i.
If you will be running CES and Sitecore locally, on the same
server, choose On the same server as this Sitecore instance.
ii.
If you will be running CES remotely, on a separate server,
choose On a remote server.
b.
In Coveo Index Path, enter the path of the index
folder on the CES server (typically C:\CES7).
·
If you have not already performed the First-Time Setup in CES,
specify a path of your choice (e.g. D:\CES7). The required index folder will be
created where you specified on the CES server, and the Coveo.SearchProvider.config.example file will be updated to reflect this
location. If you have already performed the First-Time Setup, specify the path
of the index folder created by CES (the default location is C:\CES7).
·
Make sure that you enter a path with a valid format. You should
not use a network or DFS path.
8.
In the Configure the REST endpoint screen:
In Search API URI, enter:
a.
For a local setup: http://localhost:8080/
b.
For a remote setup: http://{CES server's FQDN or alias}:8080/
9.
In Application Secret, enter the application secret
of the Coveo Search API (located in the applications/secret node of the config.yml file).
The Application Secret is not
the same thing as the Secret Token created during CES setup.
Entering an incorrect application secret will result in a 403 - Permission Denied error.
10.
Click Next.
11.
In the Configure the RabbitMQ indexing queue connection screen:
a.
In URI, enter:
.
For a local setup: amqp://localhost:5682/
i.
For a remote setup: amqp://{CES server's FQDN or alias}:5682/
b.
In Username, enter the username of a RabbitMQ
administrator account (the default value is guest).
c.
In Password, enter the password of the account (the
default value is guest).
An encryption key is automatically
created in the core database of your Sitecore instance.
12.
Click Next.
13.
In the Configure the Coveo Admin Service screen:
In Admin Service URI, enter:
·
For a local setup: http://localhost/AdminService, OR
·
For a remote setup (unsecured): http://{CES server's FQDN or
alias}/AdminService, OR
·
For a remote setup (secured): https://{CES server's FQDN or
alias}/AdminService
14.
In case you want to secure the Admin Service:
.
Select Use a secure Admin Service.
a.
In Admin Service Username, enter the username
that you configured in CES to secure the Admin Service.
b.
In Admin Service Password, enter the password that
you configured in CES to secure the Admin Service.
An encryption key is
automatically created in the core database of your Sitecore instance.
c.
In Certificate File, choose the certificate file
( .pfx) that was previously generated and exported
by the CES installation wizard.
d.
In Private Key Password, enter the certificate’s
private key password that you configured previously in the CES installation
wizard.
e.
In Administrator Username, enter the username of an
account that is a member of the Local Administrators group on the Sitecore
server.
f.
In Administrator Password, enter the password of the
account.
15.
Click Next.
16.
In the Configure the Sitecore credentials used to
retrieve security permissions screen:
.
In Username, enter the username of the Sitecore
account to use to retrieve security permissions of indexed items.
a.
In Password, enter the password of the Sitecore
account to use to retrieve security permissions of indexed items.
An encryption key is
automatically created in the core database of your Sitecore instance.
17.
Click Next.
18.
In the Configure Body indexing options screen,
s elect the type of body indexing that you prefer for your Sitecore items.
.
To index only Sitecore item data, select Only index
Sitecore item data.
a.
To index the full HTML rendering of the published Sitecore
items, choose Index rendered HTML.
b.
In the Configure Body indexing options screen:
c.
If you do not need to index permissions, select Disable
Security Permissions on Documents, and click Next .
19.
To activate Coveo for Sitecore, in the Activate Coveo
for Sitecore screen:
.
Check Automatically rename the files.
a.
Click Next.
b.
Click Close, and after a few moments you should see
the the last screen of the Configuration Wizard. This screen contains links to
useful documentation to finalize your Coveo for Sitecore installation.
20.
Depending on your Sitecore revision, there may be some lines
that you want to uncomment in the Coveo.SearchProvider.config file. Scan the file for any relevant section. For example,
you may want to uncomment the fields/field[@fieldName="culture"] node if you are using a Sitecore
revision later than 150400.
21.
Click Close in the Configuration Wizard.
22.
Once the Configuration Wizard is closed, make sure that you
restart both the Sitecore client and server.
When the Search API is installed on a
different machine from CES, you should configure the Search API service
manually (for the available options, see Windows Service Configuration File).
23.
On the server where the Search API service is running, open
the config.yml file (typically located under C:\Program Files\Coveo Search API 8).
When editing the config.yml file,
make sure that you indent settings using spaces only. Tabs are considered
invalid and will therefore prevent the configuration from loading properly.
After having saved
your config.yml file, you must restart your Coveo Search
API service for your modifications to take effect.
.
Ensure that the serverCertificatePath setting points to a valid certificate path. The path should
be <CES
index path>\Config\Certificates\cert-ca.pem.
a.
Ensure that the clientCertificatePath setting points to a valid certificate path. The
path should be <CES
index path\Config\Certificates\cert-iis.p12.
24.
Start the Coveo Search API service.
You can access the services list from Control
Panel > System and Security > Administrative
Tools > Services.
If you are using the web database,
publish the master database, as items created by Coveo for
Sitecore will need to be replicated to this database as well.
