The installation procedure described in this section has been tested on Windows, Linux, and Mac OS.
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 on Linux or MacOS:
bin/zookeeper-server-start.sh config/zookeeper.properties bin/kafka-server-start.sh config/server.properties
This will deploy a cluster of one instance of Apache Kafka which will listen for client connections on
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, follow the instructions specific for your operating system.
To install the JRE version 8 of OpenJDK, follow the specific instructions for your operating system.
Download the tarball package of MigratoryData KE and extract it to any folder. You will have the following layout in your installation folder:
||Default config file|
||Default config file for Kafka consumers|
||Default config file for Kafka producers|
||Folder where the logs will reside|
||Object code of MigratoryData KE|
||Folder where plugins reside|
||Start script for Linux/MacOS|
||Start script for Windows|
||Folder where the welcome and demo pages reside|
||Introduction to the product|
||Notices for third-party libraries|
||Folder with third-party licenses|
Please refer to Configuration Guide to learn how to customize the default configuration file, as well as the default configuration files for Kafka consumers and producers.
To start MigratoryData KE, open a console/terminal, change to the directory where MigratoryData KE package has been extracted, and run one of the following commands:
For Linux or MacOS:
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.
push.example.comand the port
8800is 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.