The installation procedure described in this section has been tested on Debian and Ubuntu 64-bit distributions.


Kafka (Optional)

As mentioned in the Requirements section, you need a running Kafka cluster 0.11 or later.

If you don’t have already a deployment of Apache Kafka cluster, you can deploy Kafka as follows. Get the tarball binary package of Kafka from the Kafka downloads page, unzip the tarball to any folder, change to that folder, and run the following commands:

bin/ config/
bin/ config/

This will deploy a cluster of one instance of Apache Kafka which will listen for client connections on localhost, port 9092.

For production deployments, please refer to the Apache Kafka documentation to learn how to deploy a Kafka cluster, or use a software-as-a-service platform such as Confluent which provides production-ready Kafka clusters.


As mentioned in the Requirements section, the Java Runtime Environment (JRE) version 8 is required for MigratoryData KE. To install the JRE version 8 of OpenJDK, run as root:

apt-get install openjdk-8-jre-headless

Validate your installation with the following command:

java -version

The output should be something like:

openjdk version "1.8.0_212"
OpenJDK Runtime Environment (build 1.8.0_212-b04)
OpenJDK 64-Bit Server VM (build 25.212-b04, mixed mode)

OpenSSL (optional)

As mentioned in the Requirements section, the OpenSSL and APR libraries are required to enable the native TLS/SSL communication. To install these libraries, run as root:

apt-get install libapr1 openssl

MigratoryData KE


Download the DEB package of MigratoryData KE and run as root the following to install it:

dpkg -i migratorydata-ke-Version-Architecture.deb

This will deploy MigratoryData KE as follows:

Location Description
/etc/migratorydata-ke/migratorydata-ke.conf Default config file
/etc/default/migratorydata-ke Default system config file
/etc/migratorydata-ke/kafka/ Default config for Kafka consumers
/etc/migratorydata-ke/kafka/ Default config for Kafka producers
/var/log/migratorydata-ke/ Folder where the logs will reside
/usr/share/migratorydata-ke/migratorydata-ke.jar Object code of MigratoryData KE
/usr/share/migratorydata-ke/extensions Folder where plugins reside
/usr/bin/migratorydata-ke Start script
/lib/systemd/system/migratorydata-ke.service Systemd unit file
/usr/share/doc/migratorydata-ke Folder where docs & license reside

Please refer to Configuration Guide to learn how to customize the default configuration file, the default system configuration file, as well as the default configuration files for Kafka consumers and producers.

Verify Installation

The service will start automatically after the installation. To manually start, stop, restart, or get the status of the MigratoryData KE service, run as root one of the following commands:

systemctl start migratorydata-ke
systemctl stop migratorydata-ke
systemctl restart migratorydata-ke
systemctl status migratorydata-ke

Test Installation

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


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

If a browser is not available on the machine where MigratoryData KE 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 with your preferred programming languages to communicate with your MigratoryData KE installation. Please refer to the documentation of the client SDKs provided by MigratoryData for your preferred programming languages.


To upgrade MigratoryData KE to a newer version, run as root the following command:

dpkg -i migratorydata-ke-NewVersion-Architecture.deb
The upgrade process will preserve your customized configuration files to ensure the continuity of your service. However, a copy of the default configuration of the new version is provided with the extension .dpkg-dist if it differs from the default configuration of the installed version.


To remove MigratoryData KE from your system, run as root the following command:

dpkg --purge migratorydata-ke