Installing CES on the Master Server

The Coveo Enterprise Search (CES) installer allows you to deploy all Back-End components. You must install CES on the Master server first. In the case of a one server installation, this is the only Back-End installation that is required. In a multiple Back-End server topology, you must run the CES installer on each Back-End Server (see Coveo Platform Deployment Overview).

To install CES on the Master server

1. Before you start the installation, ensure to perform the following preparation steps: 

   1. Install the hardware for a server that fulfills the Coveo system requirements. In particular, ensure to install the recommended dedicated disk(s) for the index (see Coveo Platform Hardware and Software Requirements).

   2. Decide which existing or new Windows account to use as the CES service logon account (see About the CES Service Logon Account).

   3. Decide which CES service port (default 52800) to use (see About the CES Service Port).

   4. Ensure to open the ports used by the Coveo Platform (see Ports Used By the Coveo Platform).

   5. Determine if you want to convert an existing CES 6 index configuration or create a new index.

   6. Locate the email message received from Coveo that contains your Coveo license that you will need to provide during the installation.

      Note: You do not receive your license key by email if you are installing CES as a part of the Coveo for Sitecore 4 setup. The license is configured subsequently by the Coveo for Sitecore 4 installation wizard itself (see Installing Coveo for Sitecore).

   Important: For an installation on Windows Server 2008 where the User Account Control (UAC) is activated, ensure to keep a backup copy of the CES installer. While the UAC is activated, uninstalling CES only works using the original installer executable.

2. When not already done, download the latest CES version (x64) from the Coveo website.

   Notes:

   • Contact Coveo Support when you need the 32-bit version.

   • The CES installer creates a website in IIS for the Administration Tool.

   • The CES installer enables ASP.NET pages on the IIS Web server.

   • The Coveo installers require the .NET Framework 2 that is usually available on Windows Server OS.

3. Using a local administrator account, connect to the server on which you want to install CES.

4. Locate and run the CES installer that you downloaded.

   Example: When the installer is in your Downloads folder, run: C:\Users\Username\Downloads\Coveo Enterprise Search 7.0 x64 (nnnn).exe

5. CES 7.0.6547+ (March 2014) When Microsoft .NET Framework 4.5 SP1 is not available on your server, a Coveo Enterprise Search 7 Setup dialog box appears. Click Install to download and install the missing Microsoft .NET Framework component.

   Important: The Microsoft .NET Framework installer will require that you restart the server following this installation when no prior Microsoft .NET Framework 4.5 version was installed on your server.

   

   Note: The Microsoft components are installed through the Internet. When the installer does not have access to the Internet, prerequisite installations will fail. You must then install the components manually and restart the CES installer.

6. When a Coveo Enterprise Search 7 Setup dialog box as shown below appears, click Install to install the other components that CES also needs.

   

7. Wait for the component installation to complete.

8. In the Coveo Enterprise Search 7. 0 Installation Welcome screen, click Next.

9. In the License Agreement screen, read the license terms, select I accept the terms in the license agreement, and then click Next.

10. In the Select Setup Type screen:

    

    • Click Typical to install CES in the default installation folder (C:\Program Files\Coveo Enterprise Search 7\).

    OR

    1. Click Custom when,

       • You want to specify a CES installation folder other than the default.

         Example: Your IT rules may specify that on servers, only the operating system can be installed on the C: hard disk drive and all other software must be installed on the D: hard disk drive.

       • You must install the Admin Service, such as when you install CES on a Sitecore 7 server to be used with Coveo for Sitecore (see About the Coveo Admin Service).

    2. In the Installing Folders screen:

       

       1. For a Coveo Master server, ensure to select to install the following components and their child components:

          • Coveo Enterprise Search Server

          • Console

       2. Select to install Admin Service only when you need this service such as when you install CES for Coveo for Sitecore (see Coveo for Sitecore).

          Notes:

          • CES 7.0.6339+ (January 2014) The Admin Service option to install the Admin Service is available and not selected by default.

            CES 7.0.6225– (December 2013) The Admin Service is always installed.

          • Once installed, the Coveo Admin Service is available as a Windows service.

       3. CES 7.0.8388+ (June 2016) (For Coveo for Sitecore only) Select to install a standalone version of RabbitMQ.

          Note: The RabbitMQ option is not selected by default.

       4. Select Coveo Enterprise Search Server, and then under Location, click Change.

       5. In the Modify Current Destination Folder screen, select the desired installation folder for CES, and then click OK.

          Example: D:\Program Files\Coveo Enterprise Search 7\

       6. Click Next.

          Note: Because the Coveo Enterprise Search installation folder may be different from one implementation to another, it is referred to as the [CES_Path] variable in the documentation.

    Note: The Advanced option is used when you want to create Coveo Mirror or Remote Converter servers (see Installing CES Mirror Components and Installing CES Remote Converter Components).

11. In the Configuration screen, click Configure next to Account used to access the files to index.

    

12. In the Service Logon Account screen, select the account that CES uses to run its service (see About the CES Service Logon Account):

    

    1. In the Username, Password, and Domain boxes, enter the credentials of the account that you want to use for the CES service.

       Note: It is recommended to create and use a Windows administrator account dedicated to CES with a strong password that never changes (see About the CES Service Logon Account).

    2. Click OK.

    Note: CES 7.0.6424+ (February 2014) The Use local system account in order to only index local files option no longer exists because selecting this option can lead to various authentication issues.

13. Back in the Configuration screen, when you need to change the default port used by the CES service (52800), click Configure next to CES service port (see About the CES Service Port).

    Example: You need to change the port when you install CES 7 on the same server as your CES 6 instance. Two CES instances can reside on the same server but they must use different CES service ports.

    In the CES Service Configuration screen:

    1. In the Port box, type the desired port number (ex.: 52801).

    2. Click OK.

14. Back in the Configuration screen, click Configure next to Web site hosting the Administration Tool.

15. CES 7.0.8388+ (June 2016) Back in the Configuration screen, when you need to change the default Web site name and port (Coveo Enterprise 7 Admin, port 8081), click Configure next to Website hosting the Administration Tool.

    Note: CES 7.0.8225– (March 2016) You need to validate the default Web site name and port.

16. In the Web Interface Configuration screen, configure the website that hosts the Administration Tool (see CES Administration Tool):

    

    1. In the Web site name box, enter a name that you want to see in IIS for the website. The default is Coveo Enterprise Search 7 Admin.

    2. In the Web site port box, when the default port value (8081) is in conflict with another process on the server, enter the port that you want to use.

    3. Click OK.

17. CES 7.0.6547+ (March 2014) Back in the Configuration screen, when you chose to install the Admin Service, the Admin service security option appears. It is then recommended to click Configure next to Admin service security to secure the Admin Service and prevent anonymous usage of the service.

    Notes:

    • CES 7.0.6424– (February 2014) The Admin Service was only accessible anonymously.
      

    • When you use the Admin service security to be used with Coveo for Sitecore, you need to perform additional configuration (see Configuring a Secured Admin Service).

18. In the Coveo Enterprise Search Admin Service Security Options screen:

    

    1. Select the Enable Coveo Enterprise Search Admin service security check box.

       Important: When the Admin Service is installed, it is highly recommended to activate the security to restrict access users or processes that can authenticate with the credentials that you provide below. Otherwise, anyone can use the service to perform administrative tasks on your CES instance.

       When secured, the service is available through HTTPS, by default on port 443. A certificate must be bound to the port to allow the connection (see Securing the Admin Service - Troubleshooting).

    2. CES 7.0.8388+ (June 2016) When the default Admin Service port number (443) is used by another service or application, modify the port number.

    3. CES 7.0.7814+ (August 2015) Next to Configure credentials for the Admin Service, click Configure.

       

    4. In the Username, Password and Confirm Password boxes, enter credentials that you create and take good note of them.

       The specified username/password do not need to be that of an Active Directory or Sitecore user. They are encrypted and stored only on the Coveo server. These credentials will be used by application (such as the Coveo for Sitecore Search Provider) that need to authenticate to the Admin Service.

    5. Click OK.

    6. CES 7.0.7814+ (August 2015) Next to Configure a certificate for the Admin Service, click Configure.

       Important: The certificate validity period depends on your CES version:

       • CES 7.0.8147– (December 2015) The certificate is valid for two years (see Extending CES Admin Service Certificate Validity Period).

       • CES 7.0.8225+ (March 2016) The certificate is valid for 50 years.

       

    7. In the Create a certificate to secure the Admin Service screen, configure the certificate settings:

       1. In the CES Server name box, enter the fully qualified domain name (FQDN) of the CES server or an alias for future reference using your hosts file.

          Note: The default value is the computer name.

       2. In the Certificate private key password and Confirm Password boxes, enter the password to protect the certificate private key.

       3. CES 7.0.8225 (March 2016) When the default Admin Service port number (443) is used by another service or application, modify the port number.

       4. Optionally click Browse to modify the default Certificate export path, which is the Coveo Enterprise Search 7 folder, and then click OK.

       5. Click OK.

19. CES 7.0.7256+ (December 2014) Back in the Configuration screen, click Configure next to RabbitMQ username and password.

20. In the RabbitMQ Security Options screen, create RabbitMQ administrator credentials:

    

    1. Select the Set RabbitMQ administrator credentials and overwrite default values check box.

       Important: The default user id/password is guest/guest. For evident security reasons, create new RabbitMQ default administrator credentials.

    2. In the Username and Password boxes, enter credentials that you create and take good note of them.

       Notes:

       • You will need these credentials when installing Coveo for Sitecore and/or when accessing RabbitMQ management.

       • You can also change the password once RabbitMQ is installed (see Changing the RabbitMQ Administrator Password) .

    3. Click OK.

21. Back in the Configuration screen, click Next.

22. In the Installing the program screen, click Install.

23. Wait for the installation to complete while a screen shows the installation progress bar.

24. In the installer Installation Successful screen, click Finish.

    CES 7.0.8850+ (March 2017) The Coveo Diagnostic Tool Setup Wizard is automatically launched after a Coveo Enterprise Search installation or update (see Installing the Coveo Diagnostic Tool).