The installation procedure described in this section has been tested on Red Had Enterprise Linux (RHEL) and CentOS 64-bit distributions
As mentioned in the Requirements section, the Java Runtime Environment (JRE) version 8 or later is required for Kafkorama. Fore example, to install the JRE version 8 of OpenJDK, run as root:
yum install java-1.8.0-openjdk-headless
Validate your installation with the following command:
java -version
The output should be something like:
openjdk version "1.8.0_212"
OpenJDK Runtime Environment (build 1.8.0_212-b04)
OpenJDK 64-Bit Server VM (build 25.212-b04, mixed mode)
Download the Kafkorama Gateway as an RPM package and run as root the following command to install it:
rpm -vi kafkorama-gateway-Version-Architecture.rpm
This will deploy the Kafkorama Gateway as follows:
| Location | Description |
|---|---|
/etc/kafkorama-gateway/kafkorama-gateway.conf |
Default config file |
/etc/sysconfig/kafkorama-gateway |
Default system config file |
/etc/kafkorama-gateway/integrations/ |
Folder with config files of the add-ons |
/var/log/kafkorama-gateway/ |
Folder where the logs will reside |
/usr/share/kafkorama-gateway/kafkorama-gateway.jar |
Object code of Kafkorama |
/usr/share/kafkorama-gateway/extensions |
Folder where plugins reside |
/usr/bin/kafkorama-gateway |
Start script |
/lib/systemd/system/kafkorama-gateway.service |
Systemd unit file |
/usr/share/doc/kafkorama-gateway |
Folder where docs & license reside |
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.
The service will start automatically after the installation. To manually start, stop, restart, or get the
status of the Kafkorama service, run as root one of the following commands:
systemctl start kafkorama-gateway
systemctl stop kafkorama-gateway
systemctl restart kafkorama-gateway
systemctl status kafkorama-gateway
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.
To upgrade Kafkorama to a newer version, run as root the following command:
rmp -vU kafkorama-gateway-NewVersion-Architecture.rpm
.rpmnew if it
differs from the default configuration of the installed version.
To remove the Kafkorama Gateway from your system, run as root the following command:
rpm -ve kafkorama-gateway