Product DocsMenu

Configuring the Search Web Service for a Mirror

CES 7.0.6547+ (March 2014)

Coveo Enterprise Search comes with a Search Web Service (see About the Coveo Search Web Service). The Search Web Service needs to be enabled and configured only when a custom search application uses it to perform search operations.

The Search Web Service is enabled by default on a Coveo Master server and disabled by default on Mirror servers. You can enable/disable and configure the Search Web Service independently for each server. The Search Web Service is secured using certificates.

To configure the Search Web Service for a Coveo Mirror Server

  1. On the Coveo server, access the Administration Tool (see Opening the Administration Tool).

  2. In the Administration Tool, select Index > Mirrors.

  3. In the Mirrors page, click the name of the mirror for which you want to configure the Search Web Service.

    Note: The index of the Coveo Master server is represented here as a mirror typically named Default.

  4. In the page for the selected mirror:

    1. In the navigation panel on the left, select Search Web Service.

    2. Select/clear the Enabled check box to enable/disable the Search Web Service for the selected mirror.

      Tip: When no custom application uses the API, it is a good practice to disable the API, particularly when the Use SSL Connection option is cleared, to prevent anonymous Search Web Service accesses.

      Note: The Search Web Service is enabled by default on a Coveo Master server and disabled by default on Mirror servers.

    3. Select the Keep Alive check box to use a single TCP connection to send and receive multiple HTTP requests/responses, as opposed to opening a new connection for every single request/response pair.

      Selecting this option can improve performances, more notably when Use SSL Connection is selected by preventing repeating the SSL handshake for each request/response pair.

    4. In the Port box, you can change the port number used to access the Search Web Service on this mirror. The default is 52810.

      You must change the port when the default port is used by another application and may need to change it for example to respect your IT standards. When you have more than one mirror, each mirror may use the same or different ports.

    5. In the Number of Threads box, you can change the minimum number or threads that are allocated to concurrently serve requests to the Search Web Service. The default is 10.

    6. In the Error Log box, enter the path and file name in which Search Web Service logs will be written. No logs are saved when the box is empty.

    7. Select the Use SSL Connection check box to only accept Secure Sockets Layer (SSL) connections to the Search Web Service. Clear to use non-secured connection (HTTP).

    8. When the Use SSL Connection option is selected, leave the Certificate, Certificate Private Key, and Trusted CAs boxes empty to use the default CES certificate files. Otherwise, enter the paths and file names where your own appropriate certificate files are on the Coveo server.

    9. Click Apply Changes.

      Note: When you change the configuration for a Mirror server, the changes are effective within about a minute when the next transaction is committed.

  5. When you enable/disable Search Web Service on a remote mirror, your need to restart the CES service on the mirror server for the modifications to be effective.

People who viewed this topic also viewed