XuqmGroup 57f8b36fab docs(deploy): 移除 Jenkins 配置和 Android Demo 计划文档

- 删除 jenkins-setup.md 完整的 Jenkins 服务配置指南
- 更新 README.md 部署文档标题为公有化部署文档
- 添加私有化部署说明章节和相关设计文档链接
- 从 REST API 设计文档中移除 demo-service 相关描述
- 更新推送架构图中业务服务端描述为客户端服务器
- 删除 android-demo-plan.md Android Demo 开发计划文档
- 删除 multi-platform-im-roadmap.md 多平台 IM 路线图文档
- 删除 java-im-server-sdk-plan.md Java IM 服务端 SDK 计划文档

2026-05-18 17:57:05 +08:00

2.5 KiB

原始文件 Blame 文件历史

快速开始

5 分钟接入 XuqmGroup IM，实现消息收发。

1. 选择部署形态

形态	适用场景	SDK
公有化	使用 XuqmGroup 公有云控制台	当前公有化 SDK
私有化	使用客户独立部署环境	独立私有化 SDK

公有化控制台地址：https://dev.xuqinmin.com

私有化环境由部署仓库生成控制台地址、文档站地址和 xuqm-private-sdk.json，接入时以客户环境输出为准。

2. 创建或获取应用

公有化：

登录公有化控制台。
注册开发者账号。
创建应用并记录 appKey。

私有化：

使用部署时内置的主租户登录客户控制台。
使用初始化默认应用，或在控制台创建新应用。
下载或读取 xuqm-private-sdk.json。

3. 选择平台

客户端 SDK

平台	接入文档
Android	Android SDK
iOS	iOS SDK
React Native	RN SDK
Vue3 / Web	Vue3 SDK
HarmonyOS	HarmonyOS SDK
Flutter	Flutter SDK
微信小程序	小程序 SDK
H5 / 纯 JS	H5 SDK

服务端 SDK

语言	接入文档
Go	Go Server SDK
Java	Java Server SDK
Python	Python Server SDK

4. 公有化初始化

XuqmSDK.initialize(
    context = this,
    appKey = "ak_your_app_key"
)

5. 私有化初始化

私有化 SDK 使用部署仓库生成的本地 JSON 初始化：

XuqmPrivateSDK.initialize(
    context = this,
    configAsset = "xuqm-private-sdk.json"
)

JSON 内容由私有化部署仓库生成，示例：

{
  "schemaVersion": 1,
  "deployment": "PRIVATE",
  "appKey": "ak_private_default",
  "controlBaseUrl": "https://tenant.customer.com",
  "imApiBaseUrl": "https://im.customer.com",
  "imWsUrl": "wss://im.customer.com/ws/im",
  "pushBaseUrl": "https://push.customer.com",
  "updateBaseUrl": "https://update.customer.com",
  "fileBaseUrl": "https://file.customer.com",
  "licenseBaseUrl": "https://license.customer.com"
}

6. 登录与收发消息

业务客户端
  -> 调用业务登录
  -> 业务服务端签发 UserSig
  -> 客户端调用 SDK login
  -> IM 连接建立
  -> 收发消息、推送、更新、License 能力按模块启用

安全要求：appSecret 只能保存在业务服务端，不允许下发到客户端。

2.5 KiB 原始文件 Blame 文件历史