Editing the Maestro Settings File

This article applies to the new Crawling Module, which works without Docker. If you still use the Crawling Module with Docker, see Coveo On-Premises Crawling Module (Docker Version) instead. You might also want to read about the advantages of the new Crawling Module.

To identify the Crawling Module you’re currently using, on the Crawling Modules page of the Coveo Administration Console, look at the Maestro reported version:

  • Versions > 1: new Crawling Module

  • Versions < 1: Crawling Module with Docker

As you install Maestro, you’re prompted to set several parameters, i.e., the ports to use, whether the Coveo organization you link to the Crawling Module instance is a HIPAA organization, your proxy information, etc. Should you need to change these parameters, you must edit the maestro_settings.ini file located under C:\Program Files\Coveo\Maestro (or the alternative location you chose while deploying Maestro).

To edit the Maestro settings file:

  1. In the Windows Start menu, type notepad.

  2. Right-click the Notepad application that appears, and then click Run as administrator.

  3. In the Notepad window that opens, click File > Open, and then navigate to C:\Program Files\Coveo\Maestro.

  4. In the Maestro folder, double-click the maestro_settings file.

  5. Make your changes, and then save the file.

  6. Restart Maestro to apply your changes.

WorkerService

The WorkerService, also known as the Node Agent, launches the Crawling Module workers.

WorkerService Port

The local port that Maestro uses to send content update jobs to the Crawling Module workers.

Default value is 52816.

WorkerSyncRate

The rate at which the Coveo Platform pings the WorkerService to check whether it’s up and running. Typically, you shouldn’t need to change this value.

Expected format is days.hours:minutes:seconds.

Default value is 0.00:00:15.

Workers

A list of your workers, along with their type and state, appears on the Crawling Module component dashboard.

MinimumPort

The lowest port number that can be used by a newly created Crawling Module worker to communicate with Coveo Cloud. If this port is already in use or can’t be used, the worker tries to use the next one (i.e. 23001 when the specified value is 23000) until it finds an available port.

Default value is 23000.

MaximumPort

The highest port number that can be used by the Crawling Module workers to communicate with Coveo Cloud.

Default value is 24999.

Maestro

AutoUpdateFrequency

The frequency at which the Crawling Module retries installing an automatic update it previously failed to install.

Expected format is days.hours:minutes:seconds.

Default value is 1.00:00:00.

MaximumDumpFolderSizeInGB

The maximum allowed size for the Dumps folder. Once the folder reaches this size, its oldest dumps are deleted to free up disk space.

Default value is 10.0 GB.

MaximumLogFolderSizeInGB

The maximum allowed size for the Logs folder, excluding the Dumps folder. Once the folder reaches this size, its oldest logs are deleted to free up disk space.

Default value is 10.0 GB.

CoveoEnvironment

Whether the Coveo organization linked to your Crawling Module instance is a regular organization or a HIPAA organization.

Expected values are Production and Hipaa.

Maestro Port

The port from which you can access the Crawling Module component dashboard.

Default value is 5000 or the port number you entered when installing Maestro.

DataDirectoryLocation

The location of your Maestro data folder. If you want to change this location, see Moving the “Maestro” Data Folder.

Region

The deployment region of the organization linked to the Crawling Module instance.

If you want to change this location, you must uninstall and reinstall the Crawling Module.

Database

ConnectionString

The connection string allowing your Database source to connect to the database storing the source state information.

Since the connection string syntax differs from one database type to another, you might want to see The Connection Strings Reference for details.

Default value is Server=localhost;Port=3306;Database=crawlers;.

  • Source state information is used to enable less demanding operations (i.e., source rescans and refreshes) after a source initial build.

  • A database is installed alongside Maestro. If you switch to a custom (MySQL-compatible) solution, ensure that you have the resources to monitor and manage it. When the database is down, crawling operations don’t proceed.

ConnectionString Username

The username of an account that has access to the database storing the source state information.

Default value is root.

Password

The password of the database account specified above.

Proxy

Due to your network configuration, you may want the Crawling Module to communicate with Coveo Cloud through a proxy.

Typically, you provide proxy settings when installing Maestro. However, if you have not done so or if you want to change these settings, you can enter your new proxy information in the Maestro settings.

Proxy settings are used only for communication with the Coveo Platform. Crawlers and security workers running on your server don’t use the proxy settings when crawling content through an HTTP connection. This means that your server must be able to access your content without going through the proxy.

If you want to crawl content through an external connection, you rather need either a cloud source or a Crawling Module deployment in a different location.

When you change the proxy settings, your workers will automatically stop and restart.

To stop using a proxy and return to a direct connection, leave each parameter empty.

Url

The proxy URL. This address must start with http.

Proxy Username

The username of the proxy account.

Leave this parameter empty if your proxy doesn’t require credentials.

Proxy Password

The password corresponding to the proxy account specified above.

Leave this parameter empty if your proxy doesn’t require credentials.

Recommended Articles