WuKongIM Docs

Start a Single-node Cluster

Install WuKongIM on Linux and start a single-node cluster with systemd.

Run all commands below on the Linux server.

1. Install WuKongIM

On Ubuntu or Debian:

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

On Rocky, AlmaLinux, or RHEL 9:

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

2. Initialize configuration

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

Save the Manager administrator password printed by the first command. It is shown only once.

3. Start and check the cluster

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

A successful /readyz means that the single-node cluster can accept traffic. If it fails, inspect the logs:

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

4. Open the pages from your computer

For a remote Linux server, keep this SSH forwarding command running on your computer:

ssh -L 5001:127.0.0.1:5001 -L 5200:127.0.0.1:5200 -L 5301:127.0.0.1:5301 <user>@<server-ip>

Then open these addresses in your computer's browser:

PageAddress
Chat Demohttp://127.0.0.1:5001/demo/
Managerhttp://127.0.0.1:5301

The Manager username is admin; use the password saved during initialization.

To stop or start the service again:

sudo systemctl stop wukongim
sudo systemctl start wukongim

Data is stored in /var/lib/wukongim. Next: send the first message.

On this page