Installing the Sidecar

Sidecars are installed locally on the machines running MassTransit 5 and later. This document assumes that both MySQL and MassTransit are already installed.

  1. Install J2SE(TM) Runtime Environment 7 or 8. Use the Typical installation.
  2. Put the Sidecar folder anywhere on your machine. For example, C:\Program Files (x86)\Acronis\Sidecar.
  3. Navigate to C:\Program Files (x86)\Acronis\Sidecar\App and edit the Sidecar configuration files.

    Note: The steps below provide basic setup instructions for .cfg files. You can find additional information in the respective .cfg files.

  4. Open the sidecar.cfg file and configure the following properties:

    mt_database_username =

    mt_database_password =

    Enter the username and the password with which you wish to connect to the MassTransit database. This user must have permissions to read from it.

    sidecar_hostname =

    Enter the host name or IP address of the Sidecar.

    hub_hostname =

    Enter the host name or IP address of the Hub.

    Note: Every time you change this configuration file, you must restart the Sidecar, in order for the changes to take effect.

  5. [Optional] Configure standard.cfg.
  6. [Optional] Configure log4j.cfg.
  7. Install the Sidecar by double-clicking the installsidecar.bat file located in your Sidecar folder. For example, C:\Program Files (x86)\Acronis\Sidecar.
  8. Go to the Windows Services and start the Sidecar service, DBSidecar.
  9. To make the Sidecar service start up automatically, right click DBSidecar in the Windows Services and select Properties. Under the General tab, select Automatic as Startup type. Then click Apply and OK.
  10. To verify that the Sidecar is running, open the log file DBSidecar.output, located in your Sidecar\App folder. For example, C:\Program Files (x86)\Acronis\Sidecar\App. This file is created when the Sidecar is launched for the first time, and it is overwritten on every subsequent launch.