Prerequisites
Prepare the tools, ports, and local directory required to run WuKongIM from source.
The quick start runs from source because that path only needs Git and Go and directly uses the repository's tested single-node cluster example configuration.
Required tools
| Tool | Requirement | Purpose |
|---|---|---|
| Git | Able to reach GitHub | Fetch the source |
| Go | 1.25.11 | Build and run WuKongIM |
| curl | Supports --fail | Verify readiness |
| Browser | Supports modern WebSocket | Use Manager and the Chat Demo |
Check the local environment:
git --version
go version
curl --versiongo version should report go1.25.11. Other versions may build, but they are outside the verified toolchain for this quick start.
Local ports
The default example requires these ports to be free:
| Port | Purpose |
|---|---|
5001 | HTTP API, readiness, metrics, and embedded Chat Demo |
5100 | WKProto TCP |
5200 | WebSocket multiplexer |
5301 | Manager |
7001 | Node transport |
If a port conflicts, stop the conflicting program or change the corresponding listener in your copied wukongim.toml. Do not edit wukongim.toml.example directly.
Disk and network
- The current directory must allow creation of
./data/wukongim-single-node-data. - The first run needs network access to download Go modules.
- Test users only need local browser access; no public domain is required.
When ready, start the single-node cluster.