The installation procedure described in this section has been tested on Windows, Linux, and Mac OS.



As mentioned in the Requirements section, the Java Runtime Environment (JRE) version 8 is required for the MigratoryData server. To install the JRE version 8 of OpenJDK, follow the instructions specific for your operating system.



Download the MigratoryData server as a tarball package and extract it to any folder. You will have the following layout in your installation folder:

Location Description
migratorydata.conf Default config file
integrations Folder with config files of the add-ons
logs Folder where the logs will reside
migratorydata.jar Object code of the MigratoryData server
extensions Folder where plugins reside Start script for Linux/MacOS
start-migratorydata.bat Start script for Windows
html Folder where the welcome and demo pages reside
README.txt Introduction to the product
LICENSE.txt License
NOTICE.txt Notices for third-party libraries
THIRD-PARTY-LICENSES Folder with third-party licenses

Please refer to Configuration Guide to learn how to customize the default config file and the default system config file. To customize the add-on configs, check the documentation of the add-on in the MigratoryData Integrations section.

Verify Installation

To start the MigratoryData server, open a console/terminal, change to the directory where the MigratoryData package has been extracted, and run one of the following commands:

For Windows:


For Linux or MacOS:


Test Installation

To test the installation, start a web browser on the machine where the MigratoryData server has been installed and open the following URL:


This will open the home page of the MigratoryData server which contains docs and demos.

If a browser is not available on the machine on which the MigratoryData server has been installed, then, supposing the address of the machine is and the port 8800 is not blocked by the firewall, you can remotely test the installation by opening the following URL from a remote machine:

Build Realtime Apps

The next step is to build realtime apps using your preferred programming languages to communicate with your MigratoryData server. Please refer to the MigratoryData Client APIs section.