WuKongIM Docs

Quick Start

Start a single-node cluster with Docker, exchange messages in the Chat Demo, then choose an SDK for your app.

Edit this pageReport a docs issue

Exchange messages between Alice and Bob on your computer. You need Docker and a browser; allow 5–10 minutes, excluding downloads.

1. Start the cluster

Create the configuration, run Docker, and check /readyz.

2. Send the first message

Follow the screenshots to connect two test users and exchange messages.

3. Integrate your app

Choose an SDK for your needs, then open the platform tutorial.

To try the latest streaming, customer support, and Agent scenarios, launch all four Demos from source.

Success checklist

  • /readyz returns {"ready":true}.
  • Both Alice and Bob show a successful connection.
  • Each receives the other user's hello from alice or hello from bob.

For learning and development only

These examples use test credentials. Before production, replace credentials and configure TLS, application authentication, backups, and recovery. See Security & Access.

Need to prepare Docker? See Prerequisites. Prefer installing directly on a Linux host? Follow the Linux installation path.

Use Cases

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

Prerequisites

Prepare Docker, a browser, and local ports, with Linux installation as an alternative.

On this page

Success checklist