WuKongIM /WuKongIM

More than just IM 不只是即时通讯(IM)

★ 5,001⑂ 716👁 33⑃ 488● 632▤ 66
GoApache-2.0Created 2023-05-09docs.githubim.com
下载:v2.2.5-20260422v2.2.5-20260422 ↓202604222026-04-22
+0
日增长
5,001
stars
716
forks
33
watchers
488
prs
632
issues
66
releases

README

WuKongIM


  让消息实时流动,让产品掌握在你手中。
  自托管的开源即时通信,连接聊天、通知与 AI 对话。
  内置存储与集群能力,通信核心无需外部数据库、缓存或消息队列。



  快速开始 ·
  Demo 首页 ·
  应用案例 ·
  文档 ·
  English



  
  
  



  


WuKongIM 负责连接、消息存储、同步、在线状态与在线投递。你可以在此基础上构建单聊群聊、在线客服、应用通知或 AI 流式回复;产品界面、账号体系和业务规则由你的应用掌握。

 为什么选择 WuKongIM?

| 能力 | 带来的价值 |
| --- | --- |
| 自带存储的通信核心 | 消息、元数据和复制日志存储内置,减少部署与运维所需的外部服务。 |
| 统一的集群模型 | 从单节点集群起步,多节点部署沿用相同的消息模型,默认采用 256 个 Hash Slot。 |
| 完整的消息基础能力 | 频道内有序消息、离线同步、多设备会话,以及个人、群组和自定义频道。 |
| 开箱可用的工具 | 六个可运行的 Demo,以及内嵌 Manager、指标、诊断和备份工具。 |

 [!NOTE]
 v3 目前处于 beta 阶段。 API、配置和持久化格式仍可能变化。更换版本前请阅读升级指南,安装软件包后使用 wukongim version 确认版本。

 应用案例

 唐僧叨叨 · TangSengDaoDao

基于 WuKongIM 构建、支持私有化部署的开源即时通讯产品。 唐僧叨叨提供 iOS、Android、Web、Windows、macOS 和 Ubuntu Linux 客户端,帮助企业拥有自己的即时通讯服务。

WuKongIM 为其提供长连接维护、消息投递与消息存储能力;唐僧叨叨在此基础上实现聊天界面、好友关系、群组等产品功能,展示了如何以 WuKongIM 为通信核心构建完整的即时通讯应用。

产品官网 · 开源代码与架构说明

 快速开始

打开 Demo 首页,即可在浏览器中体验全部六个 Demo:即时聊天、流式回复、在线客服、Agent 任务助手、MQTT 智能门店与直播弹幕。希望在自己的电脑上运行时,按下方步骤启动。

 1. 在自己的电脑上启动 Demo

需要 Go 1.26+、Node.js 22.12+ 或 20.19+ 和 npm。首次使用:

bash
git clone https://github.com/WuKongIM/WuKongIM.git
cd WuKongIM
node demo/start.mjs


已经克隆仓库?直接在仓库根目录执行 node demo/start.mjs。

启动器会构建服务端、准备 Demo 后端,并在就绪后自动打开 Demo 首页。它启动一个采用 256 个 Hash Slot 的单节点集群,所有服务只监听回环地址。默认使用模拟模型,无需模型 API Key;首次运行会下载 Go 与 npm 依赖。

| Demo | 可以体验 | 源码与指南 |
| --- | --- | --- |
| 即时聊天 | 单聊、群聊、消息编辑与历史恢复 | 聊天 Demo |
| 流式回复 | 逐段回复、模型接入、取消与失败处理 | 流式 Demo |
| 在线客服 | AI 接待、人工接管与多访客会话 | 客服 Demo |
| Agent | 工具调用、任务确认、暂停与取消 | Agent Demo |
| MQTT 智能门店 | 冷柜告警、远程制冷、设备回执、离线告警与 IM 协作 | MQTT Demo |
| 直播新品发布会 | 实时弹幕、点赞、置顶公告、房间禁言与重连恢复 | 直播 Demo |


预览当前 Demo 界面:流式回复、在线客服、Agent 与手机聊天

以下截图于 2026 年 10 月 2 日从实际运行的仓库 Demo 截取。点击图片可查看原图。

流式回复:模拟模型的完整回复,通过真实消息服务逐段送达。

  


在线客服:访客转人工,客服从工作台接入并回复。

  


Agent:资料检索已完成,创建测试待办前等待确认。

  


手机聊天:同一会话在手机尺寸的界面中同步恢复历史消息。

  




体验时保持启动器运行,按 Ctrl+C 关闭本次启动的进程。每次运行的配置、日志、数据与 run.json 保存在 demo/.runs/,下次启动会创建新的运行目录。只输出地址、不打开浏览器时,使用 node demo/start.mjs --no-open。更多选项见启动器指南。

 2. 完成第一次双向收发

从 Demo 首页打开即时聊天,使用两个独立的浏览器会话,例如普通窗口与无痕窗口。保留页面提供的 API 地址,填写以下测试凭据:

| 会话 | 账号(UID) | Token |
| --- | --- | --- |
| Alice | quickstart-alice | alice-local-token |
| Bob | quickstart-bob | bob-local-token |

1. 在两个页面均勾选创建或更新演示凭据(仅测试账号),点击登录,等待双方均显示已连接。
2. 在 Alice 页面打开右上角 ⋯ 演示工具 → 开始聊天 → 单聊,填写 quickstart-bob 并确认。在 Bob 页面以相同方式选择 quickstart-alice。
3. 发送 hello from alice,确认消息出现在 Bob 页面;再回复 hello from bob,确认 Alice 收到。

至此,你已验证连接、发送与在线投递的双向链路。演示凭据直接通过 /user/token 注册;正式接入时,身份验证与 Token 签发必须由可信业务后端负责。


  


 希望直接部署到服务器?

| 部署方式 | 从这里开始 |
| --- | --- |
| Linux 软件包 | APT / RPM 安装:systemd 服务、配置初始化与就绪检查 |
| Docker | Docker 部署:在容器中运行单节点集群 |
| 多节点集群 | 多节点部署:集群配置与网络接入 |


Linux 软件包快速开始:安装、初始化并打开聊天 Demo

Preview 软件源支持 amd64/x86_64:Ubuntu 24.04、Debian 13、Rocky Linux 9、AlmaLinux 9 和 RHEL 9。需要 systemd、sudo 和 curl,无需安装 Go。

在 Linux 服务器上,选择自己的包管理器安装:

bash
 Ubuntu / Debian
curl -fsSL https://packages.githubim.com/repo | sudo sh
sudo apt update
sudo apt install -y wukongim


bash
 Rocky Linux / AlmaLinux / RHEL 9
curl -fsSL https://packages.githubi

Top issues

Latest release

v2.2.5-20260422 v2.2.5-20260422 2026-04-22

Snapshot: 2026-11-16T09:23:14Z · Data license Apache-2.0 · JSON