WuKongIM Docs

Quick Start

Start a single-node cluster on Linux and verify the first two-way message.

Edit this pageReport a docs issue

This path is for first-time WuKongIM users. You will run a single-node cluster on one Linux server and use Manager and the Chat Demo to verify messaging.

Use it for learning and testing first

The current Linux repository is a Preview channel. This guide is for functional verification, not a complete production deployment.

Steps

  1. Check prerequisites: prepare a supported Linux server, sudo, curl, and SSH.
  2. Start a single-node cluster: install the package, initialize configuration, and start the systemd service.
  3. Send the first message: verify two-way messaging with two test UIDs.
  4. Understand the Chat Demo: learn where the demo ends and production integration begins.
  5. Choose the next step: continue to configuration, SDK, API, or operations documentation.

Completion criteria

  • http://127.0.0.1:5001/readyz succeeds.
  • Manager opens at http://127.0.0.1:5301.
  • The Chat Demo at http://127.0.0.1:5001/demo/ connects two test users.
  • The two users can send messages to each other.

The flow normally takes 5–10 minutes, excluding server and system download time.

Use Cases

Maps chat, notifications, customer service, and extended scenarios to WuKongIM.

Prerequisites

Lists Linux, sudo, SSH, port, and directory requirements.

On this page

StepsCompletion criteria