Wednesday, April 5, 2017

Coveo setup for Sitecore 8


Today we discuss how setup coveo for Sitecore 8.

Step 1: Download Coveo for Sitecore, Coveo Enterprise Search and Coveo Search API

Note: Download coveo based on your sitecore version.
Step 2: Create an admin user for Coveo on your computer
  • Open Control Panel -> System and Security -> Administrative Tools
  • Open Computer Management
  • Go to Local users and groups -> Users
  • Right click -> New User
  • Name: Coveo
  • Full Name: Coveo Search
  • Password: search (use something more secure in a production environment)
  • Uncheck user much change password at next login & account disabled
  • Check user cannot change & password never expires
  • Make the user a member of Administrators and Users
Step 3: Install Coveo Enterprise Search
  • You cannot run the installer from a network drive
  • Let it install any necessary files
  • Agree to terms
  • Choose typical Installation
  • Configure Account for Access
    • Use the user account created in step 2
  • Do not change config for other options
    • Secure access not necessary for a local instance
    • Take note if you change the RabbitMQ username: password, you will need these during the Sitecore package install
  • Allow Firewall Access if prompted
1. It also asks for the install coveo diagnostic tool. Install that and open below URL:
Here 8081 is default port you also can change that.
2. Please also create a folder C:\CES7 , this is default folder you also can change that but keep in mind if you change here then you also select that folder in during Sitecore coveo package installation.
Step 4: Install Coveo Search API
Note: Select the check box “This installation is part of a Sitecore installation” and after click next select “Generate Random Token”
If you found any difficulties in above step then Please have a look on below URL:
Step 5: Make sure Coveo services are running
  • View Local Services by search “View Local Services”
  • Start all Coveo services
Step 6: Restart IIS
  • This may not be necessary. But it makes sure the localhost:8080 and localhost/AdminService are working correctly.
Step 7: Verify Admin Service

Step 8: Verify RabbitMQ
Step 9: Verify Coveo Search API
  • Go to http://localhost:8080
    • You should get a message the search page is not configured yet
Step 10: Verify Coveo Admin Tool
  • Go to http://localhost:8081
    • You should see the coveo admin tool
Step 11: Install Coveo for Sitecore (sitecore package)
  • Open Sitecore Desktop -> Developer Tools -> Installation Wizard
  • Upload Sitecore package and Install
  • Follow wizard prompts
    • Coveo is on the same server as the sitecore instance
    • Coveo Index Path: c:\CES7 (create this folder if it does not exist)
    • Search API Url: http://localhost:8080/
    • Application Secret: (the secret key created in step 4)
    • Configure RabbitMQ: (leave defaults or enter credentials used in step 3)
    • Admin Service URI: http://localhost/AdminService
    • Username and Password: (for the sitecore admin account)
    • Sitecore license: Copy and paste your license file contents
    • Rename Coveo files /websiteroot/Website/App_Config/Includes/
      • Coveo.SearchProvider.config.example to Coveo.SearchProvider.config.
      • Coveo.SearchProvider.Rest.config.example to Coveo.SearchProvider.Rest.config.
      • Coveo.UI.Controls.config.example to Coveo.UI.Controls.config
    • Restart Sitecore client and server.
    • I personally didn’t disable lucene config.
Step 12: Check Coveo Diagnostics
  • Open Sitecore Control Panel -> Coveo Diagnostic Page
  • All components should have a green light and message “up and running”
    • Coveo Search REST Endpoint can have a red X and an error and the site will still function correctly
Note: If Coveo Search Web Service is not running or give Failed to obtain resource located at 'http://sc8initial/coveo/rest?indexName=Coveo_web_index'. [BEGIN RESPONSE BODY]{"statusCode":408 error.
It means you don't have any serverCertificatePath or clientCertificatePath in your config.yml. Those settings are mandatory.

serverCertificatePath should be the path to the CES7 index's cert-ca.pem certificate file.

clientCertificatePath should be the path to the CES7 index's cert-iis.p12 certificate file.
serverCertificatePath: C:\CES7\Config\Certificates\cert-ca.pem (default)
clientCertificatePath: C:\CES7\Config\Certificates\cert-iis.p12 (default)

Or have a look same issue on below URL:

After giving the path go to “view local services” and restart the “Coveo search api”.
Now you can access :

After this when you open diagnose page you found that all services are up and running smooth.

Ex: http://{HostName}/sitecore%20modules/Web/Coveo/Admin/CoveoDiagnosticPage.aspx

Some Useful Coveo local system URL:
http://localhost:8081/Configuration/InitialSetup/InitialSetup.aspx  (Coveo Admin Tool): For index configuration handled by sitecore
http://localhost:8081 (Coveo Admin Tool): For index configuration handled by sitecore
http://localhost/adminservice  (Admin Service)
http://localhost:8080 (Coveo Search API)


I hope you enjoy this Sitecore blog. Stay tuned for more Sitecore related articles.

Till that happy Sitecoring :)

Please leave your comments or share this article if it’s useful for you.

No comments:

Post a Comment