Editing the Maestro settings file
Editing the Maestro settings file
As you install Maestro, you’re prompted to set several parameters, that is, 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:
-
In the Windows Start menu, type
notepad. -
Right-click the Notepad application that appears, and then click Run as administrator.
-
In the Notepad window that opens, click File > Open, and then navigate to
C:\Program Files\Coveo\Maestro. -
In the
Maestrofolder, double-click themaestro_settingsfile. -
Make your changes, and then save the file.
-
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 Coveo 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.
If this port is already in use or can’t be used, the worker tries to use the next one (that is,
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.
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.
EnableLogRequests
This opt-in parameter allows downloading the logs of your Crawling Module instance through the Activity Browser (platform-ca | platform-eu | platform-au) page of the Coveo Administration Console.
This feature is expected to be used mostly by Coveo support agents, although Administration Console users with the required privileges could also use it. Allowing log download in advance speeds up the issue resolution process when you request Coveo’s assistance, as Coveo’s personnel can immediately start investigating your issue.
If you don’t allow log download, only users with access to the Crawling Module host server can access the logs. Your Coveo support agent will therefore ask you to provide a log archive.
Either way, your support agent uploads the logs to Coveo’s secure cloud platform, which only authorized personnel can access. Logs are deleted after 30 days. They contain no sensitive information such as passwords and no indexed content, but they still show the hostname of the Crawling Module host server, the accessed URLs, etc.
Default value is false.
true allows log download.
Database
ConnectionString
The connection string to use 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;.
|
Notes
|
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 through a proxy. Perhaps you also want your content and security workers to access your content through this 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.
|
|
Note
By default, the following proxy settings are used for communication with Coveo only. Your content and security workers won’t use this proxy. If you want your workers to use the these proxy settings too, access your source’s JSON configuration to switch the |
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 all parameters 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.
Very useful
Not really
Very useful
Not really