Install with DEB Package on Ubuntu, Debian

Learn how to install, upgrade, and uninstall Kafkorama Portal on Ubuntu/Debian using a DEB package.

Prerequisites

OpenJDK

As mentioned in the Requirements section, the Kafkorama Portal requires Java Runtime Environment (JRE) version 11 or later. For example, to install OpenJDK 11, run:

sudo apt-get install -y openjdk-11-jre-headless

Validate the installation:

java -version

You should see output similar to:

openjdk version "11.0.25" 2024-10-15 LTS

Kafkorama Portal

Install

Download the Kafkorama Portal as a DEB package and install it using the following command:

dpkg -i kafkorama-portal-<version>_<arch>.deb

Replace <version> and <arch> with the actual package version and architecture (e.g. 1.0.0_amd64.deb).

After installation, the following layout is created:

Location Description
/etc/kafkorama-portal/kafkorama-portal.conf Default configuration file
/etc/default/kafkorama-portal System environment variables
/var/log/kafkorama-portal/ Log directory
/usr/share/kafkorama-portal/kafkorama-portal.jar Executable JAR
/usr/share/kafkorama-portal/extensions/ Plugins directory
/usr/bin/kafkorama-portal Start script
/lib/systemd/system/kafkorama-portal.service Systemd service unit
/usr/share/doc/kafkorama-portal/ Documentation and license files

Refer to the Configuration Guide for instructions on customizing the default configuration and system config files.

Verify Installation

The service is started automatically after installation. You can manage it using:

systemctl start kafkorama-portal
systemctl stop kafkorama-portal
systemctl restart kafkorama-portal
systemctl status kafkorama-portal

Test Installation

To test the installation, open a browser on the host machine and navigate to:

http://localhost:8080

Develop Real-Time Applications

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.

Upgrade

To upgrade to a newer version, run:

dpkg -i kafkorama-portal-<newversion>_<arch>.deb
Your existing configuration will be preserved. If the new version contains updated defaults, they are saved as .dpkg-dist files.

Uninstall

To remove the Kafkorama Portal, run:

dpkg --purge kafkorama-portal
© 2025 MigratoryData. All rights reserved.