Installing Maestro

Maestro is the Coveo software that allows communication between the On-Premises Crawling Module and the Coveo Cloud platform, as well as worker management. The workers then send your content updates to the index, so that the latest versions are available through your Coveo-powered search page.

The Crawling Module can retrieve content from several on-premises sources (see Supported Content). Therefore, only one Crawling Module per Coveo Cloud organization is supported, as you do not need more. You must however ensure that you have enough workers to crawl your content optimally (see Number of Workers).

  1. Ensure that your environment meets the requirements (see Requirements).
  2. Download the latest version of Maestro on your server. As stated under Requirements, this server must have access to the content you want to crawl, and the disk on which you install Maestro must have enough free space for Crawling Module database storage (see Host Server and Disk Space Requirements).

  3. HIPAA If you use the Coveo HIPAA-compliant environment, you must specify it in your system environment variables (see About the Coveo Cloud V2 HIPAA Platform). If your organization is in the regular Coveo Cloud environment, skip this step.
    1. In the Windows Start menu, search for Edit the system environment variables.
    2. In the System Properties window that appears, in the Advanced tab, click Environment Variables.
    3. In the Environment Variables window that appears, under System variables, click New.
    4. In the New System Variable window that appears, fill the boxes as follows, and then click OK.

      • Variable name: ASPNETCORE_ENVIRONMENT
      • Variable value: Hipaa
    5. Back in the Environment Variables window, click OK.
    6. Back in the System Properties window, click OK.
  4. Open a Windows Explorer window and navigate to the CrawlingModules folder you downloaded.
  5. Right-click the CrawlingModules folder, and then click Extract Files. Extract the files on the desired disk (see Disk Space Requirements).

    Avoid saving your extracted files in your user folder or one of its child folders, as this may cause access permission issues. You should generally save the files under C:, but also avoid saving to C:\ProgramData\Coveo, since this could hinder the Crawling Module update process in the future.

    However, no matter where you choose to save the Coveo On-Premises Crawling Module, its logs are always saved to C:\ProgramData\Coveo\Data (%PROGRAMDATA%) by default. You can change this location after completing the installation (see Moving the Data Directory).

  6. In the unzipped CrawlingModules folder, open the scripts folder.
  7. Click the File tab, and then, in the menu, click Open Windows PowerShell as an administrator.
  8. In the Administrator: Windows PowerShell window, type .\registerCrawlingModulesService.bat, and then press Enter. This registers Maestro as a Windows service, thus ensuring that if your machine reboots, the Crawling Module restarts as well.

What’s Next?

Configure the Coveo On-Premises Crawling Module workers (see Managing the On-Premises Crawling Module Using the REST API).