KafkIO is a desktop application that you install like any other: download it from the download page, or install it with Scoop (Windows) or Homebrew (macOS). This page covers what to download, how to install it on each platform, how to keep it up to date and how to remove it again.
System requirements
- Windows: 64-bit (x64).
- macOS: a Mac with Apple Silicon (M-series) or an Intel processor. Each has its own build.
- Linux: 64-bit (x86-64), with a graphical desktop. The packages rely on the usual desktop libraries (GTK 3 and friends), which any desktop distribution already has.
You don't need Java: every download includes the runtime KafkIO needs, and doesn't use or change a Java you may already have. Downloads are between about 145 and 205 MB. Apart from that, KafkIO needs network access to your Kafka brokers (and Schema Registry, Kafka Connect or ksqlDB, if you use them), and internet access only to check for updates.
Which file to download
The download page highlights the files for the system you're browsing from. Each platform offers an installer and a portable version that you just extract and run:
| Platform | File (version 2.1.17, for example) | What it is |
|---|---|---|
| Windows | KafkIO-win-2.1.17-x64.msi |
MSI installer: Start menu entry, optional desktop shortcut, uninstall from Windows settings. |
KafkIO-win-2.1.17-x64.zip |
Portable: extract anywhere and run KafkIO.exe. No installation or admin rights. |
|
| macOS | KafkIO-macos-2.1.17-arm64.dmgKafkIO-macos-2.1.17-x64.dmg |
Disk image: drag KafkIO to your Applications folder. arm64 is Apple Silicon,
x64 is Intel. |
KafkIO-macos-2.1.17-arm64.pkgKafkIO-macos-2.1.17-x64.pkg |
Installer package: installs KafkIO into Applications for you (asks for an administrator password). | |
KafkIO-macos-2.1.17-arm64.zipKafkIO-macos-2.1.17-x64.zip |
Portable: the KafkIO.app bundle plus run.sh scripts. |
|
| Linux | KafkIO-linux-2.1.17-x64.deb |
Package for Debian, Ubuntu, Linux Mint and other Debian-based distributions. |
KafkIO-linux-2.1.17-x64.rpm |
Package for Fedora, Red Hat Enterprise Linux and other RPM-based distributions. | |
KafkIO-linux-2.1.17-x64.tar.gz |
Portable archive for any distribution: extract and run. |
The portable versions are handy where you can't install software, or to carry KafkIO on a USB stick; with Memory Stick Mode its configuration travels with it too. Older releases are listed further down the download page, each with its release notes.
Installing
Installer (.msi)
-
Download the MSI
Get
KafkIO-win-…-x64.msifrom the download page. -
Run it
Double-click the file and follow the wizard. You can change the installation folder (by default
C:\Program Files\KafkIO) and choose whether to add a desktop shortcut. KafkIO is installed for all users of the PC, so Windows asks for administrator permission. -
Start KafkIO
Open it from the Start menu (KafkIO) or the desktop shortcut.
Installing with Scoop
If you use the Scoop package manager, KafkIO
is in its extras bucket. No administrator rights are needed:
scoop bucket add extras
scoop install kafkioPortable ZIP
Extract KafkIO-win-…-x64.zip wherever you like and double-click KafkIO.exe in the
extracted folder. The folder is self-contained: you can move or copy it, and delete it to remove KafkIO.
It also contains run.bat, which starts KafkIO with its output in a console window (useful
when something goes wrong, and for the command-line options),
and run_debug.bat, which does the same with verbose logging and can save it to a file
in Documents\KafkIO_Logs.
Microsoft Defender SmartScreen warning
KafkIO's installer and executable are code-signed. Even so, Windows may show "Windows protected your PC" when you run them, or your browser may flag the download: SmartScreen builds trust in a signing certificate gradually, as more people run software signed with it. If that happens, any of these works:
- In the SmartScreen dialog, click More info, then Run anyway (your organisation's policy may hide this option).
- Right-click the downloaded file, choose Properties, tick Unblock at the bottom of the General tab, click OK and run it again.
- Use the portable ZIP instead.
To be sure the file is the one we published, check its SHA256 first.
Intel or Apple Silicon?
Pick the build for your Mac's processor: choose Apple menu ▸ About This Mac. If it lists a Chip such as "Apple M2", download the Apple Silicon (arm64) files; if it lists an Intel Processor, download Intel (x64). The Apple Silicon build runs natively on those Macs.
Disk image (.dmg) or installer package (.pkg)
-
Open the download
Double-click
KafkIO-macos-…dmg, then drag KafkIO onto the Applications folder in the window that opens. Or double-clickKafkIO-macos-…pkgand follow the installer, which puts KafkIO in Applications for you and asks for an administrator password. -
Start KafkIO
Open it from Applications, Launchpad or Spotlight. The downloads are signed and notarised by Apple, so macOS normally opens KafkIO without security warnings; if it doesn't, see macOS says it can't verify KafkIO. You can eject the disk image afterwards.
Installing with Homebrew
With Homebrew, install KafkIO from its own tap. Homebrew picks the right build for your Mac and installs it in Applications, without a password:
brew tap certak-com/kafkio
brew install kafkioPortable ZIP
Extract KafkIO-macos-…zip (Finder does this when you double-click it). The folder contains the
KafkIO.app bundle, which you can run from where it is or move anywhere, plus two scripts for
the Terminal: run.sh starts KafkIO in the background, and run_debug.sh starts it
with verbose logging, shown in the Terminal and saved to KafkIO_debug.log. Run them from
inside the extracted folder (./run.sh).
macOS says it can't verify KafkIO
macOS may refuse to open KafkIO the first time, with "Apple could not verify 'KafkIO' is free of malware that may harm your Mac or compromise your privacy", even though it's signed and notarised. It's more likely on a company-managed Mac, where security settings are often stricter. Any of these lets it open:
- Click Done on the warning, then open System Settings ▸ Privacy & Security and scroll down to Security. Next to "KafkIO" was blocked to protect your Mac, click Open Anyway and enter your password, then open KafkIO again and click Open Anyway in the dialog that follows. The button only appears for about an hour after the blocked attempt.
- On macOS 14 and earlier you can also Control-click KafkIO in Applications, choose Open, then click Open in the dialog.
- In the Terminal, remove the download's quarantine flag, then open KafkIO as usual:
xattr -dr com.apple.quarantine /Applications/KafkIO.app
If there's no Open Anyway button, or the command isn't allowed, your organisation's device policy is blocking KafkIO: ask your IT team to allow it. To be sure the file is the one we published, check its SHA256.
Debian and Ubuntu (.deb)
Install the package with apt, which also pulls in any desktop libraries it needs:
sudo apt install ./KafkIO-linux-2.1.17-x64.deb(The ./ matters: it tells apt to use the file rather than look for a package
online. Use the name of the file you downloaded.)
Fedora, RHEL and other RPM-based distributions (.rpm)
sudo dnf install ./KafkIO-linux-2.1.17-x64.rpmBoth packages are called kafkio, install KafkIO in /opt/kafkio and add it to your
desktop's application menu (under Development). Start it from there, or run
/opt/kafkio/bin/KafkIO.
Other distributions and the portable archive
On any other distribution, or to run KafkIO without installing it, use the portable archive:
tar -xzf KafkIO-linux-2.1.17-x64.tar.gz
cd KafkIO-linux-2.1.17-x64
./run.shrun.sh starts KafkIO in the background; ./bin/KafkIO starts it with its output in
the terminal. run_debug.sh adds verbose logging, shown in the terminal and saved to
KafkIO_debug.log. The folder is self-contained, so you can put it anywhere (for example under
~/apps) and delete it to remove KafkIO.
Once KafkIO is running, the Quick Start takes you from adding your first cluster to finding a message.
Verifying downloads (SHA256)
The download page shows a SHA256 checksum under every file. To check that your download is complete and unaltered, calculate the file's checksum and compare it with the one on the page:
| System | Command |
|---|---|
| Windows (PowerShell) | Get-FileHash .\KafkIO-win-2.1.17-x64.msi |
| macOS | shasum -a 256 KafkIO-macos-2.1.17-arm64.dmg |
| Linux | sha256sum KafkIO-linux-2.1.17-x64.deb |
The two values must match exactly. PowerShell prints the checksum in capitals and the download page in lower case; that difference doesn't matter. If they don't match, delete the file and download it again.
Updating KafkIO
Installing a new version keeps your cluster configurations, preferences and message templates: they're stored outside the program folder (see what's left behind), so you can update at any time. You can see which version you have in Help ▸ About KafkIO.
The automatic check and the "New version available" dialog
While it runs, KafkIO checks for a newer release about 30 seconds after it starts and then every 24 hours. When it finds one, it tells you:
- What's new? opens the new version's release notes in your browser.
- Download update opens the download page in your browser. KafkIO doesn't download or install anything itself: install the new version as you did the first one (an installer replaces the old version in place).
- Remind me later (or closing the dialog) does nothing for now; you're asked again at the next check, so within a day or the next time you start KafkIO.
- Ignore this update stops the automatic check from mentioning this version again. You're told about the next release as usual, and Check for Updates still reports the ignored version.
If the check can't reach the update server (no internet, or a proxy in the way), nothing is shown. The automatic check can also announce a release a little later than it appears on the download page; checking manually always finds the latest one.
Checking manually
To check now, choose Help ▸ Check for Updates 1.
- Check for Updates asks the update server straight away.
If there's a newer version you get the dialog above, even for a version you chose to ignore. If you're up to date, a notification says so ("KafkIO 2.1.17 is already up-to-date"). If the server can't be reached you get an error suggesting you check your network or proxy settings: KafkIO uses the proxy configured in Network, Proxy & Trust.
Turning off update notifications
The automatic check is controlled by File ▸ Preferences ▸ Network ▸ Check for latest version online 1, which is on by default. Untick it and click Save if you'd rather update in your own time, for example when your organisation manages software versions.
- Check for latest version online: whether KafkIO tells you about new versions on its own.
Help ▸ Check for Updates keeps working whatever this setting is.
Updating with a package manager or the portable versions
- Scoop:
scoop update kafkio - Homebrew:
brew update, thenbrew upgrade kafkio - Linux packages: install the new
.debor.rpmthe same way as the first one; it replaces the installed version. - Portable versions: quit KafkIO, extract the new version, and delete the old folder. Your settings aren't in that folder (unless you use Memory Stick Mode, in which case copy them across first).
A new release can reach Scoop and Homebrew a little after it appears on the download page.
Uninstalling
- Windows (MSI): Settings ▸ Apps ▸ Installed apps, then Uninstall from KafkIO's … menu (or Programs and Features in the Control Panel).
- Scoop:
scoop uninstall kafkio - macOS: quit KafkIO and move it from Applications to the Bin. With Homebrew:
brew uninstall kafkio. - Linux:
sudo apt remove kafkio, orsudo dnf remove kafkio. - Portable versions: delete the folder.
What's left behind
Uninstalling removes the program only. Your cluster configurations (with their saved credentials), message templates, imported certificates and logs stay in KafkIO's data folder, so a later reinstall picks up where you left off:
| System | Data folder |
|---|---|
| Windows | %LOCALAPPDATA%\com.certak\kafkio (for example
C:\Users\you\AppData\Local\com.certak\kafkio) |
| macOS | ~/Library/Application Support/kafkio |
| Linux | ~/.local/share/kafkio (or $XDG_DATA_HOME/kafkio) |
Preferences are kept separately, in the operating system's store for Java preferences: on Windows the registry key
HKEY_CURRENT_USER\Software\JavaSoft\Prefs\com\certak\kafkio, on Linux
~/.java/.userPrefs/com/certak/kafkio, and on macOS a file under ~/Library/Preferences.
To remove everything, delete the data folder too, and, if you like, the preferences (Removing everything). The quickest way to find the folder is to open it from KafkIO before you uninstall: Tools ▸ Show Config In ▸ File Browser (see Config & Log Files), then go up one level. If you used Memory Stick Mode, the configuration is next to the program instead, and goes when you delete it.