Learn how to install Kafkorama Portal from a ZIP or tarball package across major platforms like macOS, Windows, and Linux.
As mentioned in the Requirements section, the Kafkorama Portal requires Java Runtime Environment (JRE) version 11 or later. Please follow the installation instructions appropriate for your operating system to install OpenJDK 11 or newer.
Download the Kafkorama Portal as a ZIP or tarball archive and extract it to any folder. The extracted directory will include the following structure:
| File / Folder | Description |
|---|---|
kafkorama-portal.conf |
Default configuration file |
logs |
Directory for log files |
kafkorama-portal.jar |
Executable JAR of the Kafkorama Portal |
start-kafkorama-portal.sh |
Startup script for Linux/macOS |
start-kafkorama-portal.bat |
Startup script for Windows |
data |
Folder containing the 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 |
Refer to the Configuration Guide for instructions on customizing the default configuration.
To launch the Kafkorama 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-kafkorama-portal.sh
On Windows:
start-kafkorama-portal.bat
Once the Kafkorama Portal is running, open a web browser on the same machine and visit:
http://127.0.0.1:8080
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.