Maestro Silent Install

This is for:

Developer System Administrator

A silent install of Maestro isn’t interactive and must have parameters preset through the command line. Only perform a silent install of Maestro when you’re faced with scenarios where an interactive install isn’t an option, such as when building virtual machine images.

Tip

We recommend opting for the regular, interactive installation process whenever you can. A regular install of Maestro will involve an installation wizard that guides you through the installation process.

Before you proceed:

Base Command

The following command installs the Crawling Module in the US East region with default ports for Maestro and its workers:

Maestro-setup.exe /VERYSILENT /SUPPRESSMSGBOXES /NORESTART /LOG=log.txt

The /VERYSILENT, /SUPPRESSMSGBOXES, and /NORESTART Inno Setup flags are mandatory.

/LOG=log.txt creates a log file with details pertaining to the process, which could be relevant for troubleshooting.

Optionally, add the following flags to customize the Maestro settings. The settings can also be modified after the installation.

Maestro Port

Use flag /CMaestro:Port=<PORT_NUMBER> to specify the port from which you should access the Crawling Module component dashboard.

Default value is 5000.

Example

/CMaestro:Port=3354

Worker Service Port

Use flag /CWorkerService:Port=<PORT_NUMBER> to specify the local port that Maestro should use to send content update jobs to the Crawling Module workers.

Default value is 52816.

Database Port

Use flag /CDatabase:DbPort=<PORT_NUMBER> to specify the port that the database installed alongside Maestro should use.

Default value is 3306.

Name

Use flag /CMaestro:Name=<NAME> to specify a name for your Crawling Module deployment.

If the name contains whitespace characters, enclose the flag value in quotation marks.

Example

/CMaestro:Name="My Crawling Module"

Environment

Use flag /CMaestro:CoveoEnvironment=<ENVIRONMENT> to specify whether the Coveo organization that you will link to your Crawling Module instance is a regular organization or a HIPAA organization.

Allowed values are Production and Hipaa.

Region

Use flag /CMaestro:Region=<REGION> to specify the deployment region of the organization that you will link to your Crawling Module instance.

Allowed values are US_EAST_1 (Eastern United States), EU_WEST_1 (Ireland), and AP_SOUTHEAST_2 (Australia). Default is US_EAST_1.

Organizations in the HIPAA environment must be deployed in region US_EAST_1.

Data Directory Location

Use flag /CMaestro:DataDirectoryLocation=<LOCATION> to specify the desired location of your Maestro data folder.

If the path contains whitespace characters, enclose the flag value in quotation marks.

Default value is C:\ProgramData\Coveo\Maestro.

Example

/CMaestro:DataDirectoryLocation="C:\ProgramData\My Favorite Apps\Coveo\Maestro"

Proxy URL

Use flag /CProxy:Url=<PROXY_URL> to specify your proxy URL. This URL must start with http.

Proxy Username and Password

Use flags /CProxy:Username=<PROXY_USERNAME> and /CProxy:Password=<PROXY_PASSWORD> to specify your proxy username and password. The flags must be specified together; a username or password alone will be ignored.

Your password will be stored in Windows Credentials.

API Key

If you are reinstalling the Crawling Module from a previous install, use flag /CMaestro:Apikey=<API_KEY> to enter your API key. This key should be saved in the Windows Credential Manager.

Other

You can add custom settings to the Maestro settings file with the following pattern: /C<SECTION>:<KEY>=<VALUE>.

Example

You provide a database connection string with the following flag:

/CDatabase:ConnectionString="Server=localhost;Port=3306;Database=crawlers;"