WuKongIM Docs

Linux

Install WuKongIM with APT or DNF and start it with systemd.

The preview repository currently publishes v3.0.0-beta.8 for amd64/x86_64. It is verified on Ubuntu 24.04, Debian 13, Rocky Linux 9, and AlmaLinux 9; RHEL 9 can use the same EL9 repository.

Preview is a prerelease channel

Validate it outside production before serving production traffic.

1. Install

Debian / Ubuntu

curl -fsSL https://packages.githubim.com/repo | sudo sh
sudo apt update
sudo apt install -y wukongim

RHEL / Rocky / AlmaLinux 9

curl -fsSL https://packages.githubim.com/repo | sudo sh
sudo dnf -y --disablerepo='*' --enablerepo=wukongim-preview makecache --refresh
sudo dnf install -y wukongim

Check the installed version:

wukongim version

The package creates the service account, systemd service, /etc/wukongim, /var/lib/wukongim, and /var/log/wukongim. It does not create a configuration or start the service.

2. Initialize the configuration

sudo wukongim init
# For automation:
sudo wukongim init \
  --admin-password-stdin < /secure/path/manager-password

Save the administrator password, which is shown only once. Existing automation may keep using wukongim config init --config /etc/wukongim/wukongim.toml. Then validate the configuration:

sudo wukongim config validate --config /etc/wukongim/wukongim.toml

Services bind to loopback by default. Configure the firewall, TLS, and ingress policy before exposing them.

3. Start and verify

sudo systemctl enable --now wukongim
curl --fail http://127.0.0.1:5001/readyz

Add the node to traffic only after /readyz succeeds. If startup fails, inspect the logs:

The default Manager address is http://127.0.0.1:5301. Sign in as admin with the password saved during initialization. For public access, set listen_addr = "0.0.0.0:5301" under [manager], confirm auth_on = true, restart the service, allow TCP port 5301 through the firewall, and open http://<server-public-ip>:5301. See Manager for details.

sudo journalctl -u wukongim -n 100 --no-pager

For multiple nodes, continue to Multi-node Cluster. Before upgrading, read Upgrade & Migration.

On this page