This guide describes how to install MigratoryData Portal from a ZIP or tarball archive on macOS, Windows, or Linux.

Prerequisites

OpenJDK

As mentioned in the Requirements section, MigratoryData Portal requires Java Runtime Environment (JRE) version 17 or later. Please follow the installation instructions appropriate for your operating system to install OpenJDK 17 or newer.

MigratoryData Portal

Install

Download the MigratoryData Portal as a ZIP or tarball archive and extract it to any folder. The extracted directory will include the following structure:

File / Folder Description
migratorydata-portal.conf Default configuration file
logs/ Directory for log files
migratorydata-portal.jar Executable JAR
start-migratorydata-portal.sh Startup script for Linux/macOS
start-migratorydata-portal.bat Startup script for Windows
data/ Folder containing the embedded database
README.txt Product introduction
LICENSE.txt Software license
NOTICE.txt Notices for third-party software
THIRD-PARTY-LICENSES/ Directory of third-party license files

Verify Installation

To launch MigratoryData Portal, open a terminal (Linux/macOS) or command prompt (Windows), navigate to the extracted directory, and run the appropriate startup script:

On Linux or macOS:

./start-migratorydata-portal.sh

On Windows:

start-migratorydata-portal.bat

Test Installation

Once MigratoryData Portal is running, open a web browser and visit:

http://127.0.0.1:8080
If MigratoryData Portal is running on a remote machine, replace 127.0.0.1 with the remote machine's IP address or hostname.

Build Realtime Apps

Once your MigratoryData Gateway is running, and your streaming APIs are set up in MigratoryData Portal, the next step is to build real-time apps using your preferred programming language. Explore the available Client APIs to get started on your programming language of choice.