Installing the Coveo Search API

The Coveo Search API implements a REST search endpoint that can be used by other Coveo products to communicate with your on-premises Coveo Enterprise Search (CES) index (see Coveo REST Search API 8.0). You can install the Coveo Search API on a server of your choice such as on the Coveo Master server (where Coveo Enterprise Search is installed), on a front-end server (where the Coveo JavaScript Search is installed), or any other server. Once installed, the Coveo Search API runs as a Windows service.

When your deployment includes one or more Coveo JavaScript Search interfaces, you must install and configure a Coveo Search API.

Notes:

Coveo for Sitecore uses both the JavaScript Search and the Coveo Search API, but both are deployed by the Coveo for Sitecore installer (see Installing Coveo for Sitecore).
You can also embed the Coveo Search API in ASP.NET or Java applications (see Installation Options).
You can also install the Coveo Search API silently (see Silent install).

To install the Coveo Search API

Using an administrator account, connect to the server on which you decided to install the Coveo Search API.
Download the latest version of the Coveo Search API installer.
Run the Coveo Search API installer (Coveo Search API 8.0.nnn.exe).
When a previous version of the Search API was deployed with the ZIP file distribution and set as a Windows service, you will see the following message. You need to stop and uninstall the old service (Coveo REST Search API) before you can continue this installation.
1. Click OK, and in the Installation Cannot Proceed screen, click Finish.
2. Open the Windows Services management console, and locate the CoveoSearchAPI service.
3. In the folder where you extracted the ZIP file, run the Uninstall.bat batch file.
4. Restart the Coveo Search API installer.
In the Installation Folder screen:
1. When the default installation folder is not appropriate C:\Program Files\Coveo Search API 8\), select the desired folder.
2. When you are installing the Coveo Search API in the context of a Coveo for Sitecore deployment, select the This installation is part of a Sitecore installation check box.
3. Click Next.
If you selected the This installation is part of a Sitecore installation check box, in the Application Secret Token screen, click Generate Random Token to create an application secret token to be used by Coveo for Sitecore, and then click Next.
In the Ready to Install screen, click Install.
In the Installation Successful screen:
1. When you are deploying a new install of the Coveo Search API and did not select the This installation is part of a Sitecore installation check box, the installer cannot start the Coveo Search API service.
  
  You must first edit the default configuration file to specify the Coveo server hosting the index (if not the localhost) and most probably to secure the access to the REST API.
  
  Click Open config.yml to edit the configuration file (by default C:\Program Files\Coveo Search API 8\config.yml) with a text editor of your choice (see Customizing and Starting the Coveo Search API).
  
  Note: You may need to set which application on your computer opens YAML files (.yml extension) by default. Choose a text editor such as Notepad.
2. Click Finish.

When you select the This installation is part of a Sitecore installation check box, the installer automatically configures and starts the Coveo Search API service.

To silently install Coveo Search API

(For advanced users only) The Coveo Search API installer can be launched in command line simply by calling the executable. Since the installer is made using Windows installer, msiexec options are supported, including /qn for a silent install (see Msiexec (command-line options)).

Using an administrator account, connect to the server on which you decided to install the Coveo Search API.
Download the latest version of the Coveo Search API installer.
Open Command Prompt as an administrator.
In Command Prompt:
1. Using the cd command reach the Coveo Search API 8.0.nnn.exe file directory (see Chdir (cd)).
2. Depending on the product for which you install the Search API:
- (For a Coveo product other than Coveo for Sitecore) Enter and execute the following command line where you replace nnn by the version number:
  
  "Coveo Search API 8.0.nnn.exe" /qn
  
  Example: C:\Downloads\"Coveo Search API 8.0.802.exe" /qn
- (For Coveo for Sitecore)
  1. Generate a random string that will be used as the application secret.
  2. Enter and execute the following command line in which you replace nnn by the version number and [value] by the application secret:
    
    "Coveo Search API 8.0.nnn.exe" /qn APPLICATION_SECRET=[value]
    
    Example: "Coveo Search API 8.0.802.exe" /qn APPLICATION_SECRET=123456789
    
    Note: You also need to provide the application secret when installing the Coveo for Sitecore integration (see Installing Coveo for Sitecore).

Ask your questions on connect.coveo.com.

People who viewed this topic also viewed

Community

Product DocsMenu

Installing the Coveo Search API