Debian Systems Installation

Install Relational Migrator

1. Download the latest .deb binary from the release page.

2. Update the system package manager repositories:

   sudo apt update

3. (For headless Linux distributions) Create the required directories:

   sudo mkdir /usr/share/desktop-directories/

4. Install Relational Migrator.

   sudo apt install ./mongodb-relational-migrator_<version_number>-1_amd64.deb

5. (Optional) To connect to Oracle or MySQL drivers, download and place the drivers into your Relational Migrator directory.

   1. To download and install MySQL or Oracle drivers, see the following:

      • MySQL: latest 8.3.x version, Platform Independent Version

      • Oracle: 21.6.0.0 of ojdbc11.jar from the Oracle 21c

   2. Copy the driver files to /opt/mongodb-relational-migrator/lib/app/lib.

      To copy the driver, use the following example:

      curl https://download.oracle.com/otn-pub/otn_software/jdbc/216/ojdbc11.jar -O -L -b -o

   For more information, see Install on a Local Machine.

6. Change the directory to the Relational Migrator /bin location and start the application.

   cd /opt/mongodb-relational-migrator/bin
   ./mongodb-relational-migrator

7. Enable Relational Migrator to run as an unattended standalone server.

   In your user.properties file, uncomment spring.profiles.active: unattended.

8. (Optional) Update TLS/SSL configuration properties.

   In your user.properties file, uncomment and update TLS/SSL configuration properties.

   It is recommended that you configure TLS/SSL for Relational Migrator on your unattended server. You can bind Relational Migrator to any IP and port on the server. For additional information, see TLS/SSL Configuration Properties.

9. (Optional) Update the port that Relational Migrator runs on.

   By default, Relational Migrator is configured to run on port 8278. To change the port Relational Migrator runs on, update the server.port line in your user.properties file to specify your preferred port. For example, you may wish to use port 80 for HTTP or port 443 for HTTPS.

10. Run Relational Migrator using the binary.

    The bin directory path is /opt/mongodb-relational-migrator/bin. To run Relational Migrator using the binary, run the following:

    cd /opt/mongodb-relational-migrator/bin
    ./mongodb-relational-migrator

11. (Optional) Check logs for errors or other information.

    • The logs are located in ~/Migrator/Logs/migrator.log.

    • When running Relational Migrator as a system service, the path is under the service user’s home directory.

Run as a System Service

When you install Relational Migrator on a Debian server, you can also set up Relational Migrator to run as a system service. When running Relational Migrator as a system service, Relational Migrator automatically starts when the server starts.

1. Create a /etc/systemd/system/migrator.service file.

   Copy the text below into the /etc/systemd/system/migrator.service file. Replace the binary path as needed.

   [Unit]
   Description=MongoDB Relational Migrator
   [Service]
   ExecStart="/opt/mongodb-relational-migrator/bin/MongoDB Relational Migrator"
   [Install]
   WantedBy=multi-user.target

2. Reload systemd to read the newly-created service.

   systemctl daemon-reload

3. Enable the Relational Migrator service to automatically start when the server starts.

   You can manage the service with the following systemctl commands:

   systemctl enable migrator.service
   systemctl start migrator.service