Learn how to install Kafkorama Gateway from a ZIP or tarball package across major platforms like macOS, Windows, and Linux.
As mentioned in the Requirements section, the Kafkorama Gateway requires Java Runtime Environment (JRE) version 8 or later. Please follow the installation instructions appropriate for your operating system to install OpenJDK 8 or newer.
Download the Kafkorama Gateway as a ZIP or tarball archive and extract it to any folder. The extracted directory will include the following structure:
| Location | Description |
|---|---|
kafkorama-gateway.conf |
Default config file |
integrations |
Folder with config files of the add-ons |
logs |
Folder where the logs are stored |
kafkorama-gateway.jar |
Object code of the Kafkorama Gateway |
extensions |
Folder for plugins |
start-kafkorama-gateway.sh |
Start script for Linux/macOS |
start-kafkorama-gateway.bat |
Start script for Windows |
html |
Welcome and demo pages |
README.txt |
Introduction to the product |
LICENSE.txt |
License |
NOTICE.txt |
Notices for third-party libraries |
THIRD-PARTY-LICENSES |
Folder with third-party license details |
Refer to the Configuration Guide for instructions on customizing the default configuration.
To launch the Kafkorama Gateway, 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-kafkorama-gateway.sh
On Windows:
start-kafkorama-gateway.bat
Once the Kafkorama Gateway is running, open a web browser on the same machine and visit the following address to verify the installation:
http://127.0.0.1:8800
This will display the welcome page of Kafkorama Gateway.
127.0.0.1 with the remote machine's IP address or hostname.
Once your Kafkorama Gateway is running, and your streaming APIs are set up in Kafkorama Portal, the next step is to build real-time apps using your preferred programming language. Explore the available Kafkorama SDKs to get started on your programming language of choice.