Configuration

Once Fast2 is installed, several components can be easily configured to adapt the software as much as your constraints might require.

Among all these components, you can find :

Configure the broker

Depending on the amount of documents you are dealing with, you may want to control max memory usage allowed (Xmx) for broker.

The <FAST2_HOME>/config/env.properties file is configured by default to 1GB for this resource :

...
# Broker Maximum memory allowed (Xmx)
BROKER_MAX_MEMORY=1G

If the campaign are involving a couple of millions of documents, increasing this value to 8GB or 16GB will help increasing the performance rate of the migration.

Configure the worker(s)

Depending on the amount of documents and the number of tasks you are dealing with, you may want to control max memory usage allowed (Xmx) for worker.

The <FAST2_HOME>/config/env.properties file is configured by default to 1GB for this resource:

...
# Worker Maximum memory allowed (Xmx)
WORKER_MAX_MEMORY=1G

Keep in mind that this property is designed for workers started from the binary start-worker.sh|.bat. If you intend to target the embedded worker, go to <FAST2_HOME>/config/application.properties instead:

...
# Broker embedded worker max memory
broker.embeddedworker.max.memory=1G

For more information about the worker, head out to the dedicated section.

Configure the UI port

Fast2 application run on the 1789 port by default. To change this, add the parameters below if they are not already defined in the /config/application.properties file:

...
# Remote broker port to use by the worker
# broker.port=1789
server.port=1789

Put the same value for these two properties.

Configure the background database


💡 Note
Although Fast2 was first shipped with an embedded Elasticsearch database, the ETL has switched to OpenSearch as of its v2.5.0.
However the configuration of both these databases are quite similar. This is why we will refer to them as the “background database”.


The database communicates with the broker via the port 1790 (as illustrated in the architecture section).

For more details on this component such as configuration, refer to dedicated section.

Configure the dashboard add-on


💡 Note
Although Fast2 was first shipped with a Kibana add-on, the ETL has switched to OpenSearch dashboard as of its v2.5.0.
However the configuration of both these vizualisation tools are quite similar. This is why we will refer to them as the “dashboard”.


Fast2 does not embed any dashboard by default. However, you can get the add-on through the same portal you downloaded the Fast2 binaries. Unzip the package at the root of Fast2 installation folder.

This hierarchy will make Fast2 automatically start your dashboard.

You will still be able to disable dashboards by updating the config/application.properties file : 

broker.kibana.embedded.enabled=true

broker.dashboards.embedded.enabled=true

The dashboard only communicates with the database (as illustrated in the architecture section), and is accessible via the port 1791.


✅ Success
Not having integrated the dashboard component will not prevent you from starting Fast2 and running it properly.


The ports related to dashboard usage can be updated as well, based on the knowledge accessible here.

For basic understanding and usage of this component, refer to dedicated section.