# Docs

- API 与协议
  - [API 与协议](/zh/api): 查阅 Product HTTP、运维 HTTP、Webhook、WKProto 与内部接口边界。
  - [认证与安全](/zh/api/authentication): 理解浏览器、业务后端、Product HTTP 与 Gateway 的信任边界。
  - [API 版本与兼容性](/zh/api/compatibility): 区分完整源码合同、窄 Profile 与端到端验证范围。
  - [通用约定](/zh/api/conventions): Product HTTP 的地址、JSON、标识、游标和重试规则。
  - [接口清单与信任边界](/zh/api/interface-inventory): Manager、Node transport、MCP、Cloud View、插件、Webhook 和 Agent 私有合同。
  - 客户端协议
    - [客户端协议](/zh/api/client-protocols): 查阅当前 Gateway 连接生命周期与 WKProto 数据包边界。
    - [连接生命周期](/zh/api/client-protocols/connection-lifecycle): 按当前 Gateway 实现处理 CONNECT、CONNACK、心跳、关闭和恢复。
    - [加密与安全](/zh/api/client-protocols/encryption): WKProto 兼容会话密钥、Payload 与 msg_key 算法及安全边界。
    - [WebSocket JSON-RPC](/zh/api/client-protocols/json-rpc): 说明 Product Gateway 对固定 EasySDK 核心在线路径的 JSON-RPC 支持矩阵与限制。
    - [数据包类型](/zh/api/client-protocols/packet-types): 查阅 WKProto FrameType 值、方向、核心字段和当前发布范围。
    - [TCP 二进制协议](/zh/api/client-protocols/tcp-binary): WKProto 固定头、长度编码、版本条件与逐包 Wire 字段顺序。
  - 公共数据字典
    - [公共数据字典](/zh/api/dictionaries): 查阅与当前源码校准的 Channel Type、Device Flag、Message Flags 和 Reason Code。
    - [Channel Type](/zh/api/dictionaries/channel-types): 查阅当前 1–12 Channel Type 值，并区分基础、专用和兼容类型。
    - [Device Flag](/zh/api/dictionaries/device-flags): 查阅 APP、WEB、PC、SYSTEM 和 Device Level 的当前值与连接冲突边界。
    - [Message Flags](/zh/api/dictionaries/message-flags): 查阅 WKProto 固定 Header 与 Setting 位，并理解持久化、红点、命令、回执、加密和流边界。
    - [Reason Code](/zh/api/dictionaries/reason-codes): 完整查阅当前 0–29 协议原因码的名称、阶段、重试建议和可达性。
  - 运维 HTTP
    - [运维 HTTP](/zh/api/operations-http): API 监听器上的健康、就绪、指标和只读快照入口。
    - [健康与就绪](/zh/api/operations-http/health-and-readiness): 正确使用 /healthz 和 /readyz。
    - [Prometheus 指标](/zh/api/operations-http/metrics): /metrics 的注册条件、格式和安全边界。
    - [只读快照与受限入口](/zh/api/operations-http/read-only): Top、Debug 和 Bench 的精确路由、开关与认证边界。
    - [稳定性与私有边界](/zh/api/operations-http/stability): 运维、Debug、Bench 与 Manager 的发布范围。
  - Product HTTP API
    - [Product HTTP API](/zh/api/product-http): 查阅当前源码注册的全部 41 条业务 HTTP 操作。
    - [错误响应](/zh/api/product-http/errors): 按 HTTP 状态和协议层正确处理失败。
    - Channel
      - [Channel](/zh/api/product-http/channels): Channel 元数据、订阅者与名单管理。
      - [添加 Channel 允许列表成员](/zh/api/product-http/channels/addChannelAllowlistMembers)
      - [添加 Channel 拒绝列表成员](/zh/api/product-http/channels/addChannelDenylistMembers)
      - [添加或替换持久订阅者](/zh/api/product-http/channels/addChannelSubscribers)
      - [终态解散 Channel](/zh/api/product-http/channels/disbandChannel)
      - [列出全部 Channel 允许列表成员](/zh/api/product-http/channels/listChannelAllowlistMembers)
      - [移除全部 Channel 允许列表成员](/zh/api/product-http/channels/removeAllChannelAllowlistMembers)
      - [移除全部 Channel 拒绝列表成员](/zh/api/product-http/channels/removeAllChannelDenylistMembers)
      - [移除全部持久订阅者](/zh/api/product-http/channels/removeAllChannelSubscribers)
      - [移除 Channel 允许列表成员](/zh/api/product-http/channels/removeChannelAllowlistMembers)
      - [移除 Channel 拒绝列表成员](/zh/api/product-http/channels/removeChannelDenylistMembers)
      - [移除持久订阅者](/zh/api/product-http/channels/removeChannelSubscribers)
      - [替换 Channel 允许列表](/zh/api/product-http/channels/setChannelAllowlistMembers)
      - [替换 Channel 拒绝列表](/zh/api/product-http/channels/setChannelDenylistMembers)
      - [替换临时 Channel 订阅者](/zh/api/product-http/channels/setTemporaryChannelSubscribers)
      - [替换 Channel 元数据](/zh/api/product-http/channels/updateChannelInfo)
      - [创建或更新 Channel 元数据](/zh/api/product-http/channels/upsertChannel)
    - 会话
      - [会话](/zh/api/product-http/conversations): 会话同步、未读、隐藏与激活状态。
      - [激活会话](/zh/api/product-http/conversations/activateConversation)
      - [清除会话未读](/zh/api/product-http/conversations/clearConversationUnread)
      - [把会话隐藏到当前 head](/zh/api/product-http/conversations/hideConversation)
      - [同步一页会话](/zh/api/product-http/conversations/listConversations)
      - [重试未解析会话](/zh/api/product-http/conversations/retryConversations)
      - [设置会话最大未读数](/zh/api/product-http/conversations/setConversationUnread)
      - [同步旧式会话](/zh/api/product-http/conversations/syncConversationsLegacy)
    - 消息发送
      - [消息发送](/zh/api/product-http/message-send): 由受信后端提交消息。
      - [提交消息](/zh/api/product-http/message-send/sendChannelMessage)
    - 消息
      - [消息](/zh/api/product-http/messages): 消息恢复、事件与命令消息兼容接口。
      - [确认最新命令消息同步](/zh/api/product-http/messages/ackCommandMessages)
      - [追加消息事件](/zh/api/product-http/messages/appendMessageEvent)
      - [绑定命令 Channel 发现](/zh/api/product-http/messages/bindCommandChannel)
      - [同步最多 200 个 Channel](/zh/api/product-http/messages/syncChannelMessagesBatch)
      - [同步命令消息](/zh/api/product-http/messages/syncCommandMessages)
      - [同步一个 Channel 的已提交消息](/zh/api/product-http/messages/syncQuickstartChannelMessages)
      - [解绑命令 Channel 发现](/zh/api/product-http/messages/unbindCommandChannel)
    - 路由发现
      - [路由发现](/zh/api/product-http/routing): 客户端 Gateway 公网或内网地址。
      - [批量解析 UID 地址组](/zh/api/product-http/routing/getGatewayRoutesBatch)
      - [解析 Gateway 地址](/zh/api/product-http/routing/getQuickstartGatewayRoute)
    - 用户
      - [用户](/zh/api/product-http/users): 设备 Token、在线状态与系统身份。
      - [添加系统 UID](/zh/api/product-http/users/addSystemUIDs)
      - [添加节点本地系统 UID 缓存](/zh/api/product-http/users/addSystemUIDsToLocalCache)
      - [列出全部系统 UID](/zh/api/product-http/users/listSystemUIDs)
      - [查询用户在线路由](/zh/api/product-http/users/listUserOnlineStatus)
      - [退出用户设备](/zh/api/product-http/users/quitUserDevice)
      - [移除系统 UID](/zh/api/product-http/users/removeSystemUIDs)
      - [移除节点本地系统 UID 缓存](/zh/api/product-http/users/removeSystemUIDsFromLocalCache)
      - [创建或更新设备 Token](/zh/api/product-http/users/setQuickstartUserToken)
  - 规格与下载
    - [规格与下载](/zh/api/specifications): 下载当前源码快照对应的 OpenAPI、JSON Schema，并查看协议变更规则。
    - [JSON-RPC 实验 Schema](/zh/api/specifications/json-rpc-schema): 下载 JSON-RPC 数据形状，并理解 EasySDK 核心路径与其余实验边界。
    - [OpenAPI 合同](/zh/api/specifications/openapi): 下载完整 HTTP 合同或一个边界更窄的接入 Profile。
    - [协议变更记录](/zh/api/specifications/protocol-changelog): 当前合同快照、WKProto v5→v6 变化和破坏性变更规则。
  - Webhook
    - [Webhook](/zh/api/webhooks): 配置同步发送前回调与三个异步通知事件。
    - [Webhook 事件类型](/zh/api/webhooks/events): 同步发送前回调与异步通知的触发条件、批次及用途。
    - [Webhook 请求结构](/zh/api/webhooks/payloads): 消息字段、离线 UID 两种表示与在线状态字符串格式。
    - [Webhook 可靠性与安全](/zh/api/webhooks/reliability-and-security): 投递成功、有限重试、丢失与重复边界以及生产网络防护。
- 指南
  - [指南](/zh/guide): 判断 WuKongIM 是否适合你的产品，并完成第一次运行与集成。
  - 核心概念
    - [核心概念](/zh/guide/core-concepts): 用消息、频道、用户、设备和会话五个概念，理解 WuKongIM 如何组织一次即时通信。
    - [频道](/zh/guide/core-concepts/channels): 理解频道如何表示消息目标，以及单聊、群聊、成员关系和消息历史如何围绕频道组织。
    - [会话](/zh/guide/core-concepts/conversations): 理解会话为什么是用户自己的聊天列表视图，以及它与频道、未读和删除的关系。
    - [设备](/zh/guide/core-concepts/devices): 区分设备与连接，理解多端在线、跨设备共享状态和设备本地状态。
    - [消息](/zh/guide/core-concepts/messages): 理解消息是什么、如何找到接收范围，以及发送成功、送达和已读为什么不是一回事。
    - [用户](/zh/guide/core-concepts/users): 理解用户如何用稳定 UID 接入，以及 WuKongIM 与业务账号系统各自负责什么。
  - 集成指南
    - [集成指南](/zh/guide/integration): 从业务系统视角完成 WuKongIM 接入。
    - [上线检查](/zh/guide/integration/acceptance): 在发布前检查身份、连接、消息、离线恢复、安全、容量和回滚。
    - [集成架构](/zh/guide/integration/architecture): 划分业务服务、WuKongIM 集群和客户端 SDK 的职责与数据流。
    - [身份认证](/zh/guide/integration/authentication): 设计 UID、Token、设备标识、连接鉴权和撤销策略。
    - [消息收发](/zh/guide/integration/messaging): 串联连接、发送、接收、确认、重连和离线恢复。
    - [插件扩展](/zh/guide/integration/plugins): 理解 v3 Beta 节点内插件的适用范围、生命周期、Hook、绑定与安全边界。
    - [Webhook](/zh/guide/integration/webhooks): 安全、幂等地消费消息和在线状态事件。
  - 产品概览
    - [产品概览](/zh/guide/product-overview): 快速判断 WuKongIM 是什么、适合哪些产品，以及业务系统仍需负责什么。
    - [核心能力](/zh/guide/product-overview/capabilities): 从产品结果理解 WuKongIM 的实时接入、可靠消息、多设备同步、集群和运维能力。
    - [适用场景](/zh/guide/product-overview/use-cases): 判断聊天、通知、客服及扩展场景是否适合使用 WuKongIM。
  - 快速开始
    - [快速开始](/zh/guide/quick-start): 在 Linux 上启动单节点集群，并完成第一次双向消息验证。
    - [运行聊天演示](/zh/guide/quick-start/chat-demo): 理解内嵌 Chat Demo 的入口、工作方式和生产安全边界。
    - [发送第一条消息](/zh/guide/quick-start/first-message): 使用内嵌 Chat Demo 创建两个测试身份并验证双向消息收发。
    - [下一步](/zh/guide/quick-start/next-steps): 根据接入、配置、部署和运维目标选择后续阅读路径。
    - [环境准备](/zh/guide/quick-start/prerequisites): 准备运行 WuKongIM 所需的 Linux 服务器、工具和端口。
    - [启动单节点集群](/zh/guide/quick-start/single-node-cluster): 在 Linux 上安装 WuKongIM，并通过 systemd 启动单节点集群。
  - 场景教程
    - [场景教程](/zh/guide/tutorials): 把身份、Channel、消息、会话与规模约束组合成可落地的业务流程。
    - [AI 与 IoT 通信](/zh/guide/tutorials/ai-and-iot): 组合 AI 流式投影、设备遥测、持久命令同步和业务执行回执。
    - [单聊](/zh/guide/tutorials/direct-chat): 实现两个用户之间的持久消息、在线投递、离线同步、未读状态与多设备恢复。
    - [群聊与超大群](/zh/guide/tutorials/large-groups): 实现群 Channel、成员协调、群消息、成员变更，以及十万成员负载边界。
    - [消息推送](/zh/guide/tutorials/push): 用离线 Webhook、业务 Outbox 和推送厂商完成可恢复的移动通知流程。
- 选择 SDK
  - [选择 SDK](/zh/sdk): 在完整版 WuKongIMSDK 与轻量 WuKongEasySDK 之间快速做出选择。
  - Android
    - [Android](/zh/sdk/android): 用 Java 接入 WuKongIMAndroidSDK，管理连接、消息、会话和频道资料。
    - [Android API 参考](/zh/sdk/android/api-reference): 按管理器快速查找 WuKongIMAndroidSDK 常用入口、监听器、模型和状态。
    - [Android 频道管理](/zh/sdk/android/channels): 为单聊和群聊加载名称、头像、设置与群成员。
    - [Android 连接管理](/zh/sdk/android/connection): 初始化身份、提供网关地址、监听状态，并正确处理断开和退出。
    - [Android 会话管理](/zh/sdk/android/conversations): 读取聊天列表、监听变化，并管理每个聊天的未读数。
    - [Android 消息管理](/zh/sdk/android/messages): 发送、接收、重发和查询消息，并理解本地插入与服务器结果。
    - [Android 快速开始](/zh/sdk/android/quickstart): 安装 WuKongIMAndroidSDK 1.5.5，连接用户并完成第一条在线文本消息。
    - Android 高级功能
      - [Android 高级功能](/zh/sdk/android/advanced): 在基础收发完成后接入自定义正文、媒体上传和远端历史消息。
      - [Android 自定义消息](/zh/sdk/android/advanced/custom-messages): 定义、注册并发送业务自己的消息正文。
      - [Android 媒体与历史消息](/zh/sdk/android/advanced/media-and-history): 接入附件上传，并在本地数据不足时从业务服务端补齐消息。
  - WuKongEasySDK
    - [WuKongEasySDK](/zh/sdk/easy): 选择 iOS、Android、Flutter、Web、C#、C++ 或 Rust 快速接入，使用固定版本或源码完成 Alice 与 Bob 的在线双向消息闭环。
    - [运行官方示例](/zh/sdk/easy/examples): 用固定 WuKongIM revision 跑通 Web、Android、iOS 与 Flutter 的源码 example 和正式发布包。
    - Android
      - [Android 快速接入](/zh/sdk/easy/android/getting-started): 精确安装 WuKongEasySDK Android 1.0.5，用可连续复制的 Kotlin 代码完成连接、在线收发与生命周期清理。
    - Cpp
      - [C++ 快速接入](/zh/sdk/easy/cpp/getting-started): 通过 vcpkg 自动安装 WuKongEasySDK-CPP 及依赖，使用 CMake 接入 C++17 在线消息、重连和线程生命周期管理。
    - Csharp
      - [C# 快速接入](/zh/sdk/easy/csharp/getting-started): 使用 WuKongEasySDK-CSharp NuGet 正式包接入 .NET 8，完成认证、在线消息、自动重连和异步释放。
    - Flutter
      - [Flutter 快速接入](/zh/sdk/easy/flutter/getting-started): 精确安装 WuKongEasySDK Flutter 1.1.0，用可连续复制的 Dart 代码完成连接、在线收发与 Widget 清理。
    - Ios
      - [iOS 快速接入](/zh/sdk/easy/ios/getting-started): 精确安装 WuKongEasySDK iOS 1.1.1，用可连续复制的 Swift 代码完成连接、在线收发与生命周期清理。
    - Javascript
      - [Web 快速接入](/zh/sdk/easy/javascript/getting-started): 精确安装 easyjssdk 2.0.4，通过业务 BFF 和可连续复制的 TypeScript 代码完成浏览器在线消息闭环。
    - Rust
      - [Rust 快速接入](/zh/sdk/easy/rust/getting-started): 通过 WuKongEasySDK-Rust 和 Tokio 连接用户，完成在线收发、有限重连和连接清理。
  - Flutter
    - [Flutter](/zh/sdk/flutter): 用 Dart 接入 wukongimfluttersdk，管理连接、消息、会话和频道资料。
    - [Flutter API 参考](/zh/sdk/flutter/api-reference): 按管理器快速查找 wukongimfluttersdk 常用入口、监听器、模型和状态。
    - [Flutter 频道管理](/zh/sdk/flutter/channels): 为单聊和群聊加载名称、头像、设置与群成员。
    - [Flutter 连接管理](/zh/sdk/flutter/connection): 初始化身份和地址，理解会话同步状态，并正确处理断开与退出。
    - [Flutter 会话管理](/zh/sdk/flutter/conversations): 读取聊天列表、监听变化，并管理每个聊天的未读数。
    - [Flutter 消息管理](/zh/sdk/flutter/messages): 发送、接收、重试和查询本地消息，并理解发送状态。
    - [Flutter 快速开始](/zh/sdk/flutter/quickstart): 安装 wukongimfluttersdk 1.7.9，连接用户并完成第一条在线文本消息。
    - Flutter 高级功能
      - [Flutter 高级功能](/zh/sdk/flutter/advanced): 在基础收发完成后接入自定义正文、媒体上传和远端历史消息。
      - [Flutter 自定义消息](/zh/sdk/flutter/advanced/custom-messages): 定义业务消息正文、分配类型编号，并在读取消息前完成注册。
      - [Flutter 媒体与历史消息](/zh/sdk/flutter/advanced/media-and-history): 接入媒体上传，并在本地消息不足时从业务服务补齐历史消息。
  - HarmonyOS SDK
    - [HarmonyOS SDK](/zh/sdk/harmonyos): 使用 @wukong/wkim 1.1.7 在 HarmonyOS NEXT 应用中接入完整 WuKongIMSDK。
    - [HarmonyOS API 参考](/zh/sdk/harmonyos/api-reference): 按管理器快速查找 @wukong/wkim 常用入口、Provider、监听器、模型和状态。
    - [HarmonyOS 频道与资料](/zh/sdk/harmonyos/channels): 理解频道标识，并接入用户、群组和群成员资料。
    - [HarmonyOS 连接管理](/zh/sdk/harmonyos/connection): 初始化身份和地址，理解同步完成状态，并正确处理断开和退出。
    - [HarmonyOS 会话管理](/zh/sdk/harmonyos/conversations): 同步并读取聊天列表，监听变化，处理未读数和删除。
    - [HarmonyOS 消息管理](/zh/sdk/harmonyos/messages): 发送、接收和读取消息，并正确显示本地插入与服务端发送结果。
    - [HarmonyOS 快速开始](/zh/sdk/harmonyos/quickstart): 安装 @wukong/wkim 1.1.7，连接用户并完成第一条在线文本消息。
    - HarmonyOS 高级功能
      - [HarmonyOS 高级功能](/zh/sdk/harmonyos/advanced): 在基础收发完成后接入自定义正文、媒体上传和远端历史消息。
      - [HarmonyOS 自定义消息](/zh/sdk/harmonyos/advanced/custom-messages): 定义业务消息正文、分配类型编号，并在读取消息前完成注册。
      - [HarmonyOS 媒体与历史消息](/zh/sdk/harmonyos/advanced/media-and-history): 接入媒体上传，并在本地消息不足时从业务服务补齐历史消息。
  - iOS
    - [iOS](/zh/sdk/ios): 用 Objective-C 接入 WuKongIMSDK，管理连接、消息、会话和频道资料。
    - [iOS API 参考](/zh/sdk/ios/api-reference): 按管理器快速查找 WuKongIMSDK 常用入口、回调、模型和状态。
    - [iOS 频道管理](/zh/sdk/ios/channels): 为单聊和群聊加载名称、头像、设置与成员资料。
    - [iOS 连接管理](/zh/sdk/ios/connection): 配置用户身份和连接地址，监听状态，并正确处理断开与退出。
    - [iOS 会话管理](/zh/sdk/ios/conversations): 读取聊天列表、监听会话变化，并维护未读数。
    - [iOS 消息管理](/zh/sdk/ios/messages): 发送、接收、重发和读取本地消息，并理解消息状态。
    - [iOS 快速开始](/zh/sdk/ios/quickstart): 安装 WuKongIMSDK 1.1.1，连接用户并完成第一条在线文本消息。
    - iOS 高级功能
      - [iOS 高级功能](/zh/sdk/ios/advanced): 在基础收发完成后接入自定义正文、媒体文件和远端历史消息。
      - [iOS 自定义消息](/zh/sdk/ios/advanced/custom-messages): 定义、注册并发送业务自己的消息正文。
      - [iOS 媒体与历史消息](/zh/sdk/ios/advanced/media-and-history): 接入媒体上传、下载，并在本地数据不足时从业务服务端补齐消息。
  - JavaScript / Web
    - [JavaScript / Web](/zh/sdk/javascript): 用 TypeScript 接入 wukongimjssdk，管理 WebSocket、消息、会话和频道资料。
    - [JavaScript / Web API 参考](/zh/sdk/javascript/api-reference): 按管理器快速查找 wukongimjssdk 常用配置、监听器、Provider 和模型。
    - [JavaScript / Web 频道管理](/zh/sdk/javascript/channels): 为单聊和群聊加载名称、头像、设置与订阅者资料。
    - [JavaScript / Web 连接管理](/zh/sdk/javascript/connection): 配置身份与 WebSocket 地址，监听状态，并处理重连和页面清理。
    - [JavaScript / Web 会话管理](/zh/sdk/javascript/conversations): 同步并维护内存中的聊天列表、最后消息和未读数。
    - [JavaScript / Web 消息管理](/zh/sdk/javascript/messages): 发送、接收和同步消息，并区分本地消息、服务器结果与在线投递。
    - [JavaScript / Web 快速开始](/zh/sdk/javascript/quickstart): 安装 wukongimjssdk 1.3.5，连接用户并完成第一条在线文本消息。
    - JavaScript / Web 高级功能
      - [JavaScript / Web 高级功能](/zh/sdk/javascript/advanced): 在基础收发完成后接入自定义正文、离线恢复，并迁移旧 UniApp SDK。
      - [JavaScript / Web 自定义消息](/zh/sdk/javascript/advanced/custom-messages): 定义、注册并发送业务自己的消息正文。
      - [JavaScript 离线恢复与 UniApp 迁移](/zh/sdk/javascript/advanced/offline-and-uniapp): 接入离线消息同步，并从已停止维护的 wukongimuniappsdk 迁移到 wukongimjssdk。
  - WuKongIMSDK
    - [WuKongIMSDK](/zh/sdk/wukongim): 选择客户端平台，并按清晰的任务顺序接入完整版 WuKongIMSDK。
    - [核心概念](/zh/sdk/wukongim/concepts): 用简单语言理解完整版客户端 SDK 中最常见的六个概念。
    - [升级 SDK](/zh/sdk/wukongim/upgrade): 用一套简洁流程安全升级任意平台的 WuKongIMSDK。
- 服务端
  - [服务端](/zh/server): 部署、配置、运维和理解 WuKongIM 集群。
  - 架构
    - [架构](/zh/server/architecture): 从 Controller、Slot、Channel、Transport 和在线路由理解 WuKongIM 的集群边界。
    - [Channel 消息层](/zh/server/architecture/channels): 理解频道元数据、Leader、ISR、消息日志、提交高水位和故障 fence。
    - [Controller 控制层](/zh/server/architecture/controller): 理解 Controller Raft、集群状态物化、节点角色、任务和控制意图。
    - [消息发送链路](/zh/server/architecture/message-flow): 跟踪持久化消息从 Gateway 进入、权限检查、权威追加、quorum commit 到在线投递。
    - [Slot 元数据层](/zh/server/architecture/slots): 理解物理哈希槽、逻辑 Slot Raft Group、元数据路由和权威读写。
    - [Transport 网络层](/zh/server/architecture/transport): 区分客户端 Gateway 与节点间 Transport，并理解 RPC、优先级、队列和背压。
    - [用户连接路由](/zh/server/architecture/user-routing): 理解节点本地 Session、UID Presence Authority、租约、设备冲突和跨节点投递。
  - 配置
    - [配置](/zh/server/configuration): 理解 WuKongIM 的 TOML 配置、查找顺序、环境变量覆盖和本地基础设置。
    - [节点与集群](/zh/server/configuration/cluster): 配置节点身份、静态或种子加入、Slot、副本和安全的集群变更边界。
    - [常用配置](/zh/server/configuration/common-configurations): WuKongIM 高频配置项及其作用、默认行为和关键限制。
    - [网络与客户端接入](/zh/server/configuration/networking): 区分节点 Transport、HTTP、Gateway、Manager 和对客户端发布的地址。
    - [日志与可观测性](/zh/server/configuration/observability): 配置日志、指标、Prometheus、Top、诊断与 Debug 的边界和成本。
    - [配置参考](/zh/server/configuration/reference): 可搜索的 WuKongIM 配置手册，逐项说明全部公开 TOML 字段、环境变量、关键默认值与约束。
    - [安全与权限](/zh/server/configuration/security): 保护客户端 CONNECT、集群加入、Manager、产品 API、Benchmark、诊断和配置秘密。
    - [消息与存储](/zh/server/configuration/storage): 规划节点数据目录、消息保留、队列、批处理、并发和容量证据。
  - 部署
    - [部署](/zh/server/deployment): 选择最短的 WuKongIM 部署路径，并在上线前完成必要验证。
    - [Docker 部署](/zh/server/deployment/docker): 使用配置文件和数据卷，通过 docker run 或 Docker Compose 启动 WuKongIM 单节点集群。
    - [Linux 部署](/zh/server/deployment/linux): 使用 APT 或 DNF 安装 WuKongIM，并通过 systemd 启动。
    - [多节点集群](/zh/server/deployment/multi-node): 用三步搭建 WuKongIM 多节点集群，并检查每个节点是否可用。
  - 运维
    - [运维](/zh/server/operations): 从日常检查开始，安全地监控、备份、扩缩容和升级 WuKongIM。
    - [备份与恢复](/zh/server/operations/backup-and-restore): 跟着示例在 Manager 中完成一次备份和恢复。
    - [健康检查与监控](/zh/server/operations/health-and-monitoring): 用三个地址判断进程是否存活、节点能否接流量，以及问题发生在哪里。
    - [Manager 管理后台](/zh/server/operations/manager): 登录 Manager、看懂主要页面，并安全执行管理操作。
    - [扩容与缩容](/zh/server/operations/scaling): 跟着示例在 Manager 中增加或移除一个节点。
    - [故障排查](/zh/server/operations/troubleshooting): 从故障现象开始，用低风险检查逐步找到问题范围。
    - [升级与迁移](/zh/server/operations/upgrade-and-migration): 根据发布说明选择滚动升级或停机升级，并保留安全回退点。
  - 工具
    - [工具](/zh/server/tools): 为观察、离线存储检查、负载验证和有界诊断选择正确的仓库工具。
    - [诊断能力](/zh/server/tools/diagnostics): 在日志、指标、Top、Manager、保留诊断、pprof 和 Operations MCP 之间选择有界证据。
    - [wkbench](/zh/server/tools/wkbench): 在受控集群上执行黑盒验证、真实负载、容量搜索和回归门槛。
    - [wkcli](/zh/server/tools/wkcli): 使用命名上下文、Top、受控节点操作和轻量流量工具观察在线集群。
    - [wkdb](/zh/server/tools/wkdb): 离线查询、导出、导入和比较单个节点的本地 WKDB 数据。

# Docs

- API & Protocols
  - [API & Protocols](/en/api): Reference Product HTTP, operations HTTP, webhooks, WKProto, and internal-interface boundaries.
  - [Authentication & Security](/en/api/authentication): Understand trust boundaries among browsers, product backends, Product HTTP, and Gateway.
  - [API Versions & Compatibility](/en/api/compatibility): Separate complete source contracts, narrow profiles, and end-to-end verification scope.
  - [Conventions](/en/api/conventions): Addressing, JSON, identifiers, cursors, and retry rules for Product HTTP.
  - [Interface Inventory & Trust Boundaries](/en/api/interface-inventory): Private Manager, node transport, MCP, Cloud View, plugin, webhook, and agent contracts.
  - Client Protocols
    - [Client Protocols](/en/api/client-protocols): Reference the current Gateway lifecycle and WKProto packet boundary.
    - [Connection Lifecycle](/en/api/client-protocols/connection-lifecycle): Handle CONNECT, CONNACK, heartbeat, close, and recovery against the current Gateway implementation.
    - [Encryption & Security](/en/api/client-protocols/encryption): WKProto compatibility session keys, Payload and msg_key algorithms, and their security boundary.
    - [WebSocket JSON-RPC](/en/api/client-protocols/json-rpc): Product Gateway's JSON-RPC support matrix and limits for the pinned EasySDK core online path.
    - [Packet Types](/en/api/client-protocols/packet-types): Reference WKProto FrameType values, directions, core fields, and current publication scope.
    - [TCP Binary Protocol](/en/api/client-protocols/tcp-binary): Exact WKProto fixed header, length encoding, version conditions, and packet wire order.
  - Shared Dictionaries
    - [Shared Dictionaries](/en/api/dictionaries): Reference Channel Types, Device Flags, Message Flags, and Reason Codes aligned with current source.
    - [Channel Type](/en/api/dictionaries/channel-types): Reference current Channel Type values 1–12 and separate baseline, specialized, and compatibility types.
    - [Device Flag](/en/api/dictionaries/device-flags): Reference current APP, WEB, PC, SYSTEM, and Device Level values plus connection-conflict boundaries.
    - [Message Flags](/en/api/dictionaries/message-flags): Reference WKProto fixed-header and Setting bits and understand persistence, red-dot, command, receipt, encryption, and stream boundaries.
    - [Reason Code](/en/api/dictionaries/reason-codes): Reference every current protocol reason value 0–29 with name, phase, retry guidance, and reachability.
  - Operations HTTP
    - [Operations HTTP](/en/api/operations-http): Health, readiness, metrics, and read-only snapshots on the API listener.
    - [Health & Readiness](/en/api/operations-http/health-and-readiness): Use /healthz and /readyz correctly.
    - [Prometheus Metrics](/en/api/operations-http/metrics): Registration, format, and security boundaries for /metrics.
    - [Snapshots & Gated Routes](/en/api/operations-http/read-only): Exact Top, Debug, and Bench routes, switches, and authentication boundaries.
    - [Stability & Private Boundaries](/en/api/operations-http/stability): Publication scope for Operations, Debug, Bench, and Manager surfaces.
  - Product HTTP API
    - [Product HTTP API](/en/api/product-http): Reference all 41 business HTTP operations registered by the current source.
    - [Error Responses](/en/api/product-http/errors): Handle failures by HTTP status and protocol layer.
    - Channels
      - [Channels](/en/api/product-http/channels): Channel metadata, subscribers, and list administration.
      - [Add Channel allowlist members](/en/api/product-http/channels/addChannelAllowlistMembers)
      - [Add Channel denylist members](/en/api/product-http/channels/addChannelDenylistMembers)
      - [Add or replace durable subscribers](/en/api/product-http/channels/addChannelSubscribers)
      - [Terminally disband a Channel](/en/api/product-http/channels/disbandChannel)
      - [List all Channel allowlist members](/en/api/product-http/channels/listChannelAllowlistMembers)
      - [Remove all Channel allowlist members](/en/api/product-http/channels/removeAllChannelAllowlistMembers)
      - [Remove all Channel denylist members](/en/api/product-http/channels/removeAllChannelDenylistMembers)
      - [Remove all durable subscribers](/en/api/product-http/channels/removeAllChannelSubscribers)
      - [Remove Channel allowlist members](/en/api/product-http/channels/removeChannelAllowlistMembers)
      - [Remove Channel denylist members](/en/api/product-http/channels/removeChannelDenylistMembers)
      - [Remove durable subscribers](/en/api/product-http/channels/removeChannelSubscribers)
      - [Replace Channel allowlist members](/en/api/product-http/channels/setChannelAllowlistMembers)
      - [Replace Channel denylist members](/en/api/product-http/channels/setChannelDenylistMembers)
      - [Replace temporary Channel subscribers](/en/api/product-http/channels/setTemporaryChannelSubscribers)
      - [Replace Channel metadata](/en/api/product-http/channels/updateChannelInfo)
      - [Create or update Channel metadata](/en/api/product-http/channels/upsertChannel)
    - Conversations
      - [Conversations](/en/api/product-http/conversations): Conversation sync, unread, hide, and activation state.
      - [Activate a Conversation](/en/api/product-http/conversations/activateConversation)
      - [Clear Conversation unread](/en/api/product-http/conversations/clearConversationUnread)
      - [Hide Conversation through the current head](/en/api/product-http/conversations/hideConversation)
      - [Synchronize a Conversation page](/en/api/product-http/conversations/listConversations)
      - [Retry unresolved Conversations](/en/api/product-http/conversations/retryConversations)
      - [Set maximum Conversation unread](/en/api/product-http/conversations/setConversationUnread)
      - [Synchronize legacy Conversations](/en/api/product-http/conversations/syncConversationsLegacy)
    - Message Sending
      - [Message Sending](/en/api/product-http/message-send): Submit messages from a trusted backend.
      - [Submit a message](/en/api/product-http/message-send/sendChannelMessage)
    - Messages
      - [Messages](/en/api/product-http/messages): Message recovery, events, and command-message compatibility.
      - [Acknowledge the latest command sync](/en/api/product-http/messages/ackCommandMessages)
      - [Append a message event](/en/api/product-http/messages/appendMessageEvent)
      - [Bind command-channel discovery](/en/api/product-http/messages/bindCommandChannel)
      - [Synchronize up to 200 Channels](/en/api/product-http/messages/syncChannelMessagesBatch)
      - [Synchronize command messages](/en/api/product-http/messages/syncCommandMessages)
      - [Synchronize one Channel's committed messages](/en/api/product-http/messages/syncQuickstartChannelMessages)
      - [Unbind command-channel discovery](/en/api/product-http/messages/unbindCommandChannel)
    - Route Discovery
      - [Route Discovery](/en/api/product-http/routing): Public or intranet client Gateway addresses.
      - [Resolve one address group for UIDs](/en/api/product-http/routing/getGatewayRoutesBatch)
      - [Resolve Gateway addresses](/en/api/product-http/routing/getQuickstartGatewayRoute)
    - Users
      - [Users](/en/api/product-http/users): Device tokens, presence, and system identities.
      - [Add system UIDs](/en/api/product-http/users/addSystemUIDs)
      - [Add node-local system UID cache entries](/en/api/product-http/users/addSystemUIDsToLocalCache)
      - [List all system UIDs](/en/api/product-http/users/listSystemUIDs)
      - [List active user routes](/en/api/product-http/users/listUserOnlineStatus)
      - [Clear a user device token](/en/api/product-http/users/quitUserDevice)
      - [Remove system UIDs](/en/api/product-http/users/removeSystemUIDs)
      - [Remove node-local system UID cache entries](/en/api/product-http/users/removeSystemUIDsFromLocalCache)
      - [Create or update a device token](/en/api/product-http/users/setQuickstartUserToken)
  - Specifications & Downloads
    - [Specifications & Downloads](/en/api/specifications): Download current-snapshot OpenAPI and JSON Schema artifacts and read protocol change rules.
    - [Experimental JSON-RPC Schema](/en/api/specifications/json-rpc-schema): Download JSON-RPC shapes and understand the supported EasySDK core plus the remaining experimental boundary.
    - [OpenAPI Contracts](/en/api/specifications/openapi): Download the complete HTTP contracts or a narrower adoption profile.
    - [Protocol Changelog](/en/api/specifications/protocol-changelog): Current contract snapshot, the WKProto v5→v6 change, and breaking-change rules.
  - Webhooks
    - [Webhooks](/en/api/webhooks): Configure synchronous before-send admission and three asynchronous notifications.
    - [Webhook Event Types](/en/api/webhooks/events): Synchronous before-send admission and asynchronous notification triggers.
    - [Webhook Payloads](/en/api/webhooks/payloads): Message fields, the two offline UID representations, and the presence-string format.
    - [Webhook Reliability & Security](/en/api/webhooks/reliability-and-security): Delivery success, bounded retry, loss and duplication boundaries, and production network controls.
- Guides
  - [Guides](/en/guide): Decide whether WuKongIM fits your product, then run and integrate it.
  - Core Concepts
    - [Core Concepts](/en/guide/core-concepts): Use five concepts—message, channel, user, device, and conversation—to understand how WuKongIM organizes communication.
    - [Channel](/en/guide/core-concepts/channels): Understand how a Channel represents a message target and organizes direct chat, group chat, membership, and history.
    - [Conversation](/en/guide/core-concepts/conversations): Understand why a Conversation is one user's chat-list view and how it relates to Channels, unread state, and hiding.
    - [Device](/en/guide/core-concepts/devices): Separate a Device from a connection and understand multi-endpoint presence, shared state, and device-local state.
    - [Message](/en/guide/core-concepts/messages): Understand what a message is, how it finds its recipients, and why sent, delivered, and read are different outcomes.
    - [User](/en/guide/core-concepts/users): Understand how a stable UID enters WuKongIM and what remains the responsibility of your account system.
  - Integration
    - [Integration](/en/guide/integration): Integrate WuKongIM from the perspective of an existing product system.
    - [Release checks](/en/guide/integration/acceptance): Check identity, connection, messaging, offline recovery, security, capacity, and rollback before release.
    - [Integration Architecture](/en/guide/integration/architecture): Divide responsibilities and data flow across the product service, WuKongIM cluster, and client SDK.
    - [Authentication](/en/guide/integration/authentication): Design UID, token, device identity, connection authentication, and revocation.
    - [Messaging](/en/guide/integration/messaging): Connect sending, receiving, acknowledgements, reconnects, and offline recovery.
    - [Plugin Extensions](/en/guide/integration/plugins): Understand the scope, lifecycle, hooks, bindings, and safety boundaries of v3 Beta node-local plugins.
    - [Webhooks](/en/guide/integration/webhooks): Consume message and online-status events securely and idempotently.
  - Product Overview
    - [Product Overview](/en/guide/product-overview): Quickly decide what WuKongIM is, which products it fits, and what your application still owns.
    - [Core Capabilities](/en/guide/product-overview/capabilities): Understand WuKongIM's real-time access, reliable messaging, multi-device synchronization, clustering, and operations.
    - [Use Cases](/en/guide/product-overview/use-cases): Decide whether WuKongIM fits chat, notifications, customer service, and extended messaging scenarios.
  - Quick Start
    - [Quick Start](/en/guide/quick-start): Start a single-node cluster on Linux and verify the first two-way message.
    - [Run the Chat Demo](/en/guide/quick-start/chat-demo): Understand the embedded Chat Demo entry points, behavior, and production safety boundary.
    - [Send the First Message](/en/guide/quick-start/first-message): Use the embedded Chat Demo to create two test identities and verify two-way messaging.
    - [Next Steps](/en/guide/quick-start/next-steps): Choose the next reading path for integration, configuration, deployment, or operations.
    - [Prerequisites](/en/guide/quick-start/prerequisites): Prepare the Linux server, tools, and ports required by WuKongIM.
    - [Start a Single-node Cluster](/en/guide/quick-start/single-node-cluster): Install WuKongIM on Linux and start a single-node cluster with systemd.
  - Tutorials
    - [Tutorials](/en/guide/tutorials): Combine identity, Channels, messages, conversations, and scale boundaries into deployable product flows.
    - [AI & IoT Communication](/en/guide/tutorials/ai-and-iot): Combine AI stream projections, device telemetry, durable command sync, and business execution receipts.
    - [Direct Chat](/en/guide/tutorials/direct-chat): Implement durable messages, online delivery, offline sync, unread state, and multi-device recovery between two users.
    - [Groups & Large Groups](/en/guide/tutorials/large-groups): Implement a group Channel, membership reconciliation, group messages, churn, and 100,000-member workload boundaries.
    - [Message Push](/en/guide/tutorials/push): Build recoverable mobile notifications with offline webhooks, a product outbox, and push providers.
- Choose an SDK
  - [Choose an SDK](/en/sdk): Quickly choose between the full WuKongIMSDK and the lightweight WuKongEasySDK.
  - Android
    - [Android](/en/sdk/android): Use Java to connect WuKongIMAndroidSDK and manage connections, messages, conversations, and channel profiles.
    - [Android API Reference](/en/sdk/android/api-reference): Find common WuKongIMAndroidSDK entry points, listeners, models, and states by manager.
    - [Android Channels](/en/sdk/android/channels): Load names, avatars, settings, and members for direct and group chats.
    - [Android Connection](/en/sdk/android/connection): Initialize identity, supply a gateway endpoint, observe states, and disconnect or log out correctly.
    - [Android Conversations](/en/sdk/android/conversations): Read the chat list, observe changes, and manage unread counts for each chat.
    - [Android Messages](/en/sdk/android/messages): Send, receive, retry, and query messages while separating local insertion from the server result.
    - [Android Quickstart](/en/sdk/android/quickstart): Install WuKongIMAndroidSDK 1.5.5, connect a user, and exchange the first online text message.
    - Android Advanced
      - [Android Advanced](/en/sdk/android/advanced): Add custom content, media upload, and remote history after basic messaging works.
      - [Android Custom Messages](/en/sdk/android/advanced/custom-messages): Define, register, and send product-specific message content.
      - [Android Media & History](/en/sdk/android/advanced/media-and-history): Connect attachment upload and fill messages from your application server when local data is incomplete.
  - WuKongEasySDK
    - [WuKongEasySDK](/en/sdk/easy): Choose an iOS, Android, Flutter, Web, C#, C++, or Rust quickstart with pinned versions or source for Alice/Bob online messaging.
    - [Run the Official Examples](/en/sdk/easy/examples): Use one pinned WuKongIM revision to run the Web, Android, iOS, and Flutter source examples and released packages.
    - Android
      - [Android quickstart](/en/sdk/easy/android/getting-started): Install exactly WuKongEasySDK Android 1.0.5 and use contiguous Kotlin code for connection, online messaging, and lifecycle cleanup.
    - Cpp
      - [C++ quickstart](/en/sdk/easy/cpp/getting-started): Install WuKongEasySDK-CPP and its dependencies with vcpkg, then use CMake for C++17 messaging, reconnect, and thread ownership.
    - Csharp
      - [C# quickstart](/en/sdk/easy/csharp/getting-started): Integrate the WuKongEasySDK-CSharp NuGet release with .NET 8 for authentication, online messaging, automatic reconnect, and async cleanup.
    - Flutter
      - [Flutter quickstart](/en/sdk/easy/flutter/getting-started): Install exactly WuKongEasySDK Flutter 1.1.0 and use contiguous Dart code for connection, online messaging, and Widget cleanup.
    - Ios
      - [iOS quickstart](/en/sdk/easy/ios/getting-started): Install exactly WuKongEasySDK iOS 1.1.1 and use contiguous Swift code for connection, online messaging, and lifecycle cleanup.
    - Javascript
      - [Web quickstart](/en/sdk/easy/javascript/getting-started): Install exactly easyjssdk 2.0.4 and use a product BFF plus contiguous TypeScript code for an online browser messaging loop.
    - Rust
      - [Rust quickstart](/en/sdk/easy/rust/getting-started): Connect users with WuKongEasySDK-Rust and Tokio, exchange online messages, and manage bounded reconnect and cleanup.
  - Flutter
    - [Flutter](/en/sdk/flutter): Use Dart to connect wukongimfluttersdk and manage connections, messages, conversations, and channel profiles.
    - [Flutter API reference](/en/sdk/flutter/api-reference): Find common wukongimfluttersdk entry points, listeners, models, and states by manager.
    - [Flutter Channels](/en/sdk/flutter/channels): Load names, avatars, settings, and members for direct and group chats.
    - [Flutter Connection](/en/sdk/flutter/connection): Initialize identity and endpoint, understand conversation-sync states, and disconnect or log out correctly.
    - [Flutter Conversations](/en/sdk/flutter/conversations): Read the chat list, observe changes, and manage unread counts for each chat.
    - [Flutter Messages](/en/sdk/flutter/messages): Send, receive, retry, and query local messages while understanding send states.
    - [Flutter Quickstart](/en/sdk/flutter/quickstart): Install wukongimfluttersdk 1.7.9, connect a user, and exchange the first online text message.
    - Flutter Advanced
      - [Flutter Advanced](/en/sdk/flutter/advanced): Add custom content, media upload, and remote history after basic messaging works.
      - [Flutter custom messages](/en/sdk/flutter/advanced/custom-messages): Define an application message payload, assign its type, and register it before reading messages.
      - [Flutter media and history](/en/sdk/flutter/advanced/media-and-history): Connect media uploads and fetch remote history when the local message database is not enough.
  - HarmonyOS SDK
    - [HarmonyOS SDK](/en/sdk/harmonyos): Integrate the full @wukong/wkim 1.1.7 SDK into a HarmonyOS NEXT application.
    - [HarmonyOS API reference](/en/sdk/harmonyos/api-reference): Find common @wukong/wkim entry points, providers, listeners, models, and states by manager.
    - [HarmonyOS channels and metadata](/en/sdk/harmonyos/channels): Understand channel identity and connect user, group, and group-member metadata.
    - [HarmonyOS connection](/en/sdk/harmonyos/connection): Initialize identity and routing, understand the ready state, and disconnect or log out correctly.
    - [HarmonyOS conversations](/en/sdk/harmonyos/conversations): Synchronize and read the chat list, observe changes, and manage unread counts and deletion.
    - [HarmonyOS messages](/en/sdk/harmonyos/messages): Send, receive, and read messages while displaying local insertion and server send results correctly.
    - [HarmonyOS quickstart](/en/sdk/harmonyos/quickstart): Install @wukong/wkim 1.1.7, connect a user, and exchange the first online text message.
    - HarmonyOS advanced features
      - [HarmonyOS advanced features](/en/sdk/harmonyos/advanced): Add custom payloads, media upload, and remote history after basic messaging works.
      - [HarmonyOS custom messages](/en/sdk/harmonyos/advanced/custom-messages): Define an application message payload, assign its type, and register it before reading messages.
      - [HarmonyOS media and history](/en/sdk/harmonyos/advanced/media-and-history): Connect media upload and fetch remote history when the local message database is not enough.
  - iOS
    - [iOS](/en/sdk/ios): Use Objective-C to connect WuKongIMSDK and manage connections, messages, conversations, and channel profiles.
    - [iOS API Reference](/en/sdk/ios/api-reference): Find common WuKongIMSDK entry points, callbacks, models, and states by manager.
    - [iOS Channels](/en/sdk/ios/channels): Load names, avatars, settings, and members for direct and group chats.
    - [iOS Connection](/en/sdk/ios/connection): Configure identity and endpoints, observe connection state, and disconnect or log out correctly.
    - [iOS Conversations](/en/sdk/ios/conversations): Read the chat list, observe changes, and maintain unread counts.
    - [iOS Messages](/en/sdk/ios/messages): Send, receive, retry, and read local messages while understanding message states.
    - [iOS Quickstart](/en/sdk/ios/quickstart): Install WuKongIMSDK 1.1.1, connect a user, and exchange the first online text message.
    - iOS Advanced
      - [iOS Advanced](/en/sdk/ios/advanced): Add custom content, media files, and remote history after basic messaging works.
      - [iOS Custom Messages](/en/sdk/ios/advanced/custom-messages): Define, register, and send product-specific message content.
      - [iOS Media & History](/en/sdk/ios/advanced/media-and-history): Connect media upload and download, then fill messages from your application server when local data is incomplete.
  - JavaScript / Web
    - [JavaScript / Web](/en/sdk/javascript): Use TypeScript to connect wukongimjssdk and manage WebSocket, messages, conversations, and channel profiles.
    - [JavaScript / Web API Reference](/en/sdk/javascript/api-reference): Find common wukongimjssdk configuration, listeners, providers, and models by manager.
    - [JavaScript / Web Channels](/en/sdk/javascript/channels): Load names, avatars, settings, and subscriber profiles for direct and group chats.
    - [JavaScript / Web Connection](/en/sdk/javascript/connection): Configure identity and a WebSocket endpoint, observe states, and handle reconnection and page cleanup.
    - [JavaScript / Web Conversations](/en/sdk/javascript/conversations): Synchronize and maintain the in-memory chat list, last messages, and unread counts.
    - [JavaScript / Web Messages](/en/sdk/javascript/messages): Send, receive, and synchronize messages while separating local messages, server results, and live delivery.
    - [JavaScript / Web Quickstart](/en/sdk/javascript/quickstart): Install wukongimjssdk 1.3.5, connect a user, and exchange the first online text message.
    - JavaScript / Web Advanced
      - [JavaScript / Web Advanced](/en/sdk/javascript/advanced): Add custom content and offline recovery, and migrate from the old UniApp SDK after basic messaging works.
      - [JavaScript / Web Custom Messages](/en/sdk/javascript/advanced/custom-messages): Define, register, and send product-specific message content.
      - [JavaScript Offline Recovery & UniApp Migration](/en/sdk/javascript/advanced/offline-and-uniapp): Connect offline message synchronization and migrate from unmaintained wukongimuniappsdk to wukongimjssdk.
  - WuKongIMSDK
    - [WuKongIMSDK](/en/sdk/wukongim): Choose a client platform and integrate the full WuKongIMSDK through a clear task-based path.
    - [Core Concepts](/en/sdk/wukongim/concepts): Understand the six terms used most often by the full client SDKs.
    - [Upgrade SDKs](/en/sdk/wukongim/upgrade): Safely upgrade any WuKongIMSDK platform with one concise workflow.
- Server
  - [Server](/en/server): Deploy, configure, operate, and understand a WuKongIM cluster.
  - Architecture
    - [Architecture](/en/server/architecture): Understand WuKongIM cluster boundaries through Controller, Slot, Channel, Transport, and online routing.
    - [Channel Messaging Layer](/en/server/architecture/channels): Understand channel metadata, Leader, ISR, message logs, committed high watermark, and failure fences.
    - [Controller Layer](/en/server/architecture/controller): Understand Controller Raft, materialized cluster state, node roles, tasks, and control intent.
    - [Message Send Flow](/en/server/architecture/message-flow): Trace durable SEND through Gateway, permission checks, authority append, quorum commit, and online delivery.
    - [Slot Metadata Layer](/en/server/architecture/slots): Understand physical hash slots, logical Slot Raft Groups, metadata routing, and authoritative reads and writes.
    - [Transport Layer](/en/server/architecture/transport): Separate client Gateway traffic from node Transport and understand RPC, priority, queues, and backpressure.
    - [User Connection Routing](/en/server/architecture/user-routing): Understand node-local Sessions, UID Presence Authority, leases, device conflicts, and cross-node delivery.
  - Configuration
    - [Configuration](/en/server/configuration): Understand WuKongIM TOML configuration, lookup order, environment overrides, and basic local settings.
    - [Nodes & Cluster](/en/server/configuration/cluster): Configure node identity, static or seed joining, slots, replicas, and safe cluster change boundaries.
    - [Common Configurations](/en/server/configuration/common-configurations): Frequently used WuKongIM settings, with their purpose, default behavior, and key constraints.
    - [Networking & Client Access](/en/server/configuration/networking): Separate node Transport, HTTP, Gateway, Manager, and client-advertised addresses.
    - [Logs & Observability](/en/server/configuration/observability): Configure the boundaries and costs of logs, metrics, Prometheus, Top, diagnostics, and Debug.
    - [Configuration Reference](/en/server/configuration/reference): Searchable WuKongIM configuration handbook explaining every public TOML field, environment override, key default, and constraint.
    - [Security & Access](/en/server/configuration/security): Protect client CONNECT, cluster joining, Manager, product APIs, benchmark, diagnostics, and configuration secrets.
    - [Messages & Storage](/en/server/configuration/storage): Plan node data directories, message retention, queues, batching, concurrency, and capacity evidence.
  - Deployment
    - [Deployment](/en/server/deployment): Choose the shortest WuKongIM deployment path and complete the required checks before traffic cutover.
    - [Docker](/en/server/deployment/docker): Start a WuKongIM single-node cluster with docker run or Docker Compose, a configuration file, and persistent storage.
    - [Linux](/en/server/deployment/linux): Install WuKongIM with APT or DNF and start it with systemd.
    - [Multi-node Cluster](/en/server/deployment/multi-node): Set up a WuKongIM multi-node cluster in three steps and check that every node is ready.
  - Operations
    - [Operations](/en/server/operations): Start with daily checks, then monitor, back up, scale, and upgrade WuKongIM safely.
    - [Backup & Restore](/en/server/operations/backup-and-restore): Follow one example to back up and restore data in Manager.
    - [Health & Monitoring](/en/server/operations/health-and-monitoring): Use three endpoints to tell whether the process is alive, the node can accept traffic, and where a problem may be.
    - [Manager](/en/server/operations/manager): Sign in to Manager, understand its main pages, and perform administrative actions safely.
    - [Scaling](/en/server/operations/scaling): Follow one example to add or remove a node in Manager.
    - [Troubleshooting](/en/server/operations/troubleshooting): Start from the symptom and narrow the problem with low-risk checks.
    - [Upgrade & Migration](/en/server/operations/upgrade-and-migration): Use release notes to choose a rolling or stopped upgrade and preserve a safe rollback point.
  - Tools
    - [Tools](/en/server/tools): Choose the correct repository tool for observation, offline storage inspection, workload validation, and bounded diagnostics.
    - [Diagnostics](/en/server/tools/diagnostics): Choose bounded evidence among logs, metrics, Top, Manager, retained diagnostics, pprof, and Operations MCP.
    - [wkbench](/en/server/tools/wkbench): Run black-box validation, real workloads, capacity searches, and regression gates against a controlled cluster.
    - [wkcli](/en/server/tools/wkcli): Use named contexts, Top, controlled node operations, and lightweight traffic tools against a live cluster.
    - [wkdb](/en/server/tools/wkdb): Query, export, import, and compare one node's local WKDB data while offline.