WuKongIM Docs

Prerequisites

Prepare the Linux server, tools, and ports required by WuKongIM.

Linux server

  • CPU architecture: amd64 / x86_64.
  • OS: Ubuntu 24.04, Debian 13, Rocky Linux 9, AlmaLinux 9, or RHEL 9.
  • The server can use sudo and reach packages.githubim.com.
  • Your computer can sign in to the server over SSH.

Check the server:

uname -m
. /etc/os-release && echo "$PRETTY_NAME"
curl --version
sudo -v

Required ports

PortPurpose
5001HTTP API, readiness, and Chat Demo
5100Client TCP
5200Client WebSocket
5301Manager
7001Node transport

The quick start accesses these ports only through the server itself, so you do not need to expose them to the internet. A remote browser uses SSH forwarding; only SSH must be reachable.

The package creates /etc/wukongim, /var/lib/wukongim, and /var/log/wukongim. When ready, start the single-node cluster.

On this page