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 or later is required for the Kafkorama Gateway. To install the JRE version 8 or later of OpenJDK, follow the instructions specific for your operating system.
Download the Kafkorama Gateway as a tarball package and extract it to any folder. You will have the following layout in your installation folder:
| Location | Description |
|---|---|
kafkorama-gateway.conf |
Default config file |
integrations |
Folder with config files of the add-ons |
logs |
Folder where the logs will reside |
kafkorama-gateway.jar |
Object code of the Kafkorama Gateway |
extensions |
Folder where plugins reside |
start-kafkorama-gateway.sh |
Start script for Linux/MacOS |
start-kafkorama-gateway.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 Kafkorama Integrations section.
To start the Kafkorama Gateway, open a console/terminal, change to the directory where the Kafkorama package has been extracted, and run one of the following commands:
For Windows:
start-kafkorama-gateway.bat
For Linux or MacOS:
./start-kafkorama-gateway.sh
To test the installation, start a web browser on the machine where the Kafkorama Gateway has been installed and open the following URL:
http://localhost:8800
This will open the home page of the Kafkorama Gateway which contains docs and demos.
push.example.com 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: http://push.example.com:8800
The next step is to build realtime apps using your preferred programming languages to communicate with your Kafkorama server. Please refer to the Kafkorama Client APIs section.