From a0126e65cef28e5bb553d7189281fe6b8914cc4a Mon Sep 17 00:00:00 2001 From: tangtaoit Date: Wed, 20 Sep 2023 15:37:43 +0800 Subject: [PATCH] docs: update --- .vitepress/sidebar.ts | 2 +- src/guide/deploy-binary.md | 35 +++++++++++++++++++++++++++++++++++ src/guide/deploy-config.md | 2 +- src/guide/guide.md | 2 +- src/guide/proto.md | 10 ++++++++++ src/sdk/android.md | 2 +- src/sdk/ios.md | 2 +- src/sdk/javascript.md | 4 ++-- src/sdk/jssdk/channel.md | 4 ++-- src/sdk/jssdk/integration.md | 2 +- 10 files changed, 55 insertions(+), 10 deletions(-) create mode 100644 src/guide/deploy-binary.md diff --git a/.vitepress/sidebar.ts b/.vitepress/sidebar.ts index 5baf5d1..019568c 100644 --- a/.vitepress/sidebar.ts +++ b/.vitepress/sidebar.ts @@ -17,7 +17,7 @@ export const sidebar: DefaultTheme.Sidebar = { text: "快速开始", collapsed: false, items: [ - { text: "一键部署（推荐）", link: "/guide/deploy-default" }, + { text: "执行文件部署（推荐）", link: "/guide/deploy-binary" }, { text: "Docker方式部署", link: "/guide/deploy-docker" }, { text: "Docker Compose方式部署", link: "/guide/deploy-dockercompose" }, { text: "部署配置", link: "/guide/deploy-config" }, diff --git a/src/guide/deploy-binary.md b/src/guide/deploy-binary.md new file mode 100644 index 0000000..2542aa5 --- /dev/null +++ b/src/guide/deploy-binary.md @@ -0,0 +1,35 @@ + +# 执行文件部署（推荐） + +## 1. 下载二进制包 + +下载对应您系统的二进制包 [release](https://github.com/WuKongIM/WuKongIM/releases/latest) + +(国内可以通过gitee下载 https://gitee.com/WuKongDev/WuKongIM/releases/latest) + +## 2. 执行 + +将下载的文件重命名为 wukongim + +设置可执行权限 + +```shell + +chmod +x wukongim + +``` + +启动wukongim + +```shell + +wukongim --config configs/config.yaml + + +``` + + + +## 3. 配置 + +[部署配置](/guide/deploy-config) \ No newline at end of file diff --git a/src/guide/deploy-config.md b/src/guide/deploy-config.md index 8933930..4d2ce7b 100644 --- a/src/guide/deploy-config.md +++ b/src/guide/deploy-config.md @@ -4,7 +4,7 @@ ## 1. 配置IP地址 -配置文件在 `~/wukongim/wk.yaml` （如果没有就新建） +配置文件如果没指定，默认在 `~/wukongim/wk.yaml` （如果没有就新建） 需要修改配置文件中的 `external.ip` 为服务器外网 IP（如果本地电脑部署没有外网IP，可填写本机局域网IP）。如下 diff --git a/src/guide/guide.md b/src/guide/guide.md index 47624e5..de2eb47 100644 --- a/src/guide/guide.md +++ b/src/guide/guide.md @@ -13,7 +13,7 @@ title: 介绍 ## 部署服务端 -服务端部署：[一分钟部署](/guide/quickstart) +服务端部署：[一分钟部署](/guide/deploy-binary) 部署后打开 http://127.0.0.1:5172/chatdemo 即可体验 diff --git a/src/guide/proto.md b/src/guide/proto.md index a23eeff..1299993 100644 --- a/src/guide/proto.md +++ b/src/guide/proto.md @@ -349,6 +349,11 @@ CONNACK 报文由服务端所发送，作为对来自客户端的 CONNECT 报文 Channel Type int8 频道类型（1.个人 2.群组） + + + Expire + uint32 + 消息过期时间（单位秒） version>=3 Msg Key @@ -566,6 +571,11 @@ CONNACK 报文由服务端所发送，作为对来自客户端的 CONNECT 报文 Channel Type int8 频道类型 + + + Expire + uint32 + 消息过期时间（单位秒） version>=3 Client Msg No diff --git a/src/sdk/android.md b/src/sdk/android.md index 4d4c49f..ef61558 100644 --- a/src/sdk/android.md +++ b/src/sdk/android.md @@ -1340,7 +1340,7 @@ public class WKReply { ### 消息回应(点赞) -如果你不理解消息回应请查看[什么是消息回应](/unifying.html#什么是消息回应) + 当自己或者别人对消息回应(点赞)时，都会触发 cmd(命令)消息`syncMessageReaction`。app 需监听同步消息回应事件 diff --git a/src/sdk/ios.md b/src/sdk/ios.md index 1d3dece..7b0e8d8 100644 --- a/src/sdk/ios.md +++ b/src/sdk/ios.md @@ -1114,7 +1114,7 @@ WKMessage *messageEditAfter = [[WKSDK shared].chatManager editMessage:(WKMessage ### 消息回应(点赞) -如果你不理解消息回应请查看[什么是消息回应](/guide/unifying.html#什么是消息回应) + #### 操作数据 diff --git a/src/sdk/javascript.md b/src/sdk/javascript.md index 2271896..533d7fa 100644 --- a/src/sdk/javascript.md +++ b/src/sdk/javascript.md @@ -5,7 +5,7 @@ ## 结构说明 -![sdk结构图](./wkjssdk.png) +![sdk结构图](./jssdk/wkjssdk.png) ``` js // 聊天管理者 @@ -486,7 +486,7 @@ WKSDK.shared().register(MessageContentTypeConst.gif, () => new GifContent()); // #### 第一步继承 MediaMessageContent -注意这里是继承 MediaMessageContent 不是 MessageContent，当发送附件消息的时候，sdk 会调用[上传任务](/web/onlysdk.html#消息附件上传设置),将本地的文件上传到服务器，然后再进行消息的编码和发送 +注意这里是继承 MediaMessageContent 不是 MessageContent，当发送附件消息的时候，sdk 会调用上传任务,将本地的文件上传到服务器，然后再进行消息的编码和发送 最终传递的消息内容为 ```{"type":4,"url":"xxxx","width":xxx,"height":xxx}``` diff --git a/src/sdk/jssdk/channel.md b/src/sdk/jssdk/channel.md index d793e3c..e52bf95 100644 --- a/src/sdk/jssdk/channel.md +++ b/src/sdk/jssdk/channel.md @@ -44,7 +44,7 @@ class Subscriber { ### 请求频道资料 -`需要实现获取频道资料的数据源` [获取频道资料数据源](sdk/jssdk/datasource.html#获取频道资料数据源) +`需要实现获取频道资料的数据源` [获取频道资料数据源](/sdk/jssdk/datasource.html#获取频道资料数据源) ```js // 强制从服务器获取频道资料并放入缓存 @@ -92,7 +92,7 @@ WKSDK.shared().channelManager.removeListener(listen) ### 同步频道的订阅者列表 -`需要实现同步频道订阅者数据源` [同步频道订阅者数据源](sdk/jssdk/datasource.html#同步频道订阅者数据源) +`需要实现同步频道订阅者数据源` [同步频道订阅者数据源](/sdk/jssdk/datasource.html#同步频道订阅者数据源) ```js WKSDK.shared().channelManager.syncSubscribes(channel) diff --git a/src/sdk/jssdk/integration.md b/src/sdk/jssdk/integration.md index bf46e04..773d537 100644 --- a/src/sdk/jssdk/integration.md +++ b/src/sdk/jssdk/integration.md @@ -34,7 +34,7 @@ const WKSDK = require("wukongimjssdk").default ``` js [浏览器] - + ```