Quick Start
Run a single-node cluster from source, check readiness, and verify the first two-way message.
This path is for developers using WuKongIM for the first time. When finished, you will have a local single-node cluster, working Manager and Chat Demo pages, and two test users that can exchange messages.
Local verification only
The example configuration contains fixed development credentials and binds several administrative and diagnostic surfaces locally. It is suitable for learning and functional verification, not as a production deployment template.
Shortest path
- Check prerequisites: prepare Git, Go 1.25.11, a terminal, and free ports.
- Start a single-node cluster: copy the example configuration and run the server.
- Send the first message: verify two-way messaging with two test UIDs.
- Understand the Chat Demo: learn where the demo ends and production integration begins.
- Choose the next step: continue to configuration, SDK, API, or operations documentation.
Completion criteria
At the end of the quick start, verify that:
http://127.0.0.1:5001/readyzsucceeds.- Manager opens at
http://127.0.0.1:5301. - The Chat Demo at
http://127.0.0.1:5001/demo/connects two unique UIDs. - A message sent by either test user reaches the other user.
The hands-on flow normally takes about 5–10 minutes, excluding the first Go dependency download.