Prerequisites
Prepare Docker, a browser, and local ports for your first message exchange.
Try it on your computer
- Install and start Docker; Docker Desktop is an option for macOS and Windows.
- Use a browser that can open two independent sessions.
- Keep local ports
5001,5100,5200, and5301available.
docker versionThe output should include both Client and Server. Next: start a single-node cluster with Docker.
Ports
| Port | Purpose |
|---|---|
5001 | HTTP API, readiness, and Chat Demo |
5100 | Client TCP |
5200 | Client WebSocket |
5301 | Manager |
7001 | Node transport; no host port mapping needed |
The example API and Manager ports bind only to your computer. Keep management ports off the public internet; use the Docker guide's SSH tunnel for a remote server.
Without Docker: prepare a Linux host
Linux packages support amd64 / x86_64 on Ubuntu 24.04, Debian 13, Rocky Linux 9, AlmaLinux 9, or RHEL 9. You need sudo, curl, and access to packages.githubim.com; remote hosts also need SSH.
uname -m
. /etc/os-release && echo "$PRETTY_NAME"
curl --version
sudo -vThe package creates /etc/wukongim, /var/lib/wukongim, and /var/log/wukongim. Continue with the Linux installation path.