docs: update

This commit is contained in:
tangtaoit 2023-09-20 15:37:43 +08:00
parent fd6d5e3c97
commit a0126e65ce
10 changed files with 55 additions and 10 deletions

View File

@ -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" },

View File

@ -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)

View File

@ -4,7 +4,7 @@
## 1. 配置IP地址
配置文件在 `~/wukongim/wk.yaml` (如果没有就新建)
配置文件如果没指定,默认`~/wukongim/wk.yaml` (如果没有就新建)
需要修改配置文件中的 `external.ip` 为服务器外网 IP如果本地电脑部署没有外网IP可填写本机局域网IP。如下

View File

@ -13,7 +13,7 @@ title: 介绍
## 部署服务端
服务端部署:[一分钟部署](/guide/quickstart)
服务端部署:[一分钟部署](/guide/deploy-binary)
部署后打开 http://127.0.0.1:5172/chatdemo 即可体验

View File

@ -349,6 +349,11 @@ CONNACK 报文由服务端所发送,作为对来自客户端的 CONNECT 报文
<td>Channel Type</td>
<td>int8</td>
<td>频道类型1.个人 2.群组)</td>
</tr>
<tr>
<td>Expire</td>
<td>uint32</td>
<td>消息过期时间(单位秒) version>=3 </td>
</tr>
<tr>
<td>Msg Key</td>
@ -566,6 +571,11 @@ CONNACK 报文由服务端所发送,作为对来自客户端的 CONNECT 报文
<td>Channel Type</td>
<td>int8</td>
<td>频道类型</td>
</tr>
<tr>
<td>Expire</td>
<td>uint32</td>
<td>消息过期时间(单位秒) version>=3 </td>
</tr>
<tr>
<td>Client Msg No</td>

View File

@ -1340,7 +1340,7 @@ public class WKReply {
### 消息回应(点赞)
如果你不理解消息回应请查看[什么是消息回应](/unifying.html#什么是消息回应)
<!-- 如果你不理解消息回应请查看[什么是消息回应](/unifying.html#什么是消息回应) -->
当自己或者别人对消息回应(点赞)时,都会触发 cmd(命令)消息`syncMessageReaction`。app 需监听同步消息回应事件

View File

@ -1114,7 +1114,7 @@ WKMessage *messageEditAfter = [[WKSDK shared].chatManager editMessage:(WKMessage
### 消息回应(点赞)
如果你不理解消息回应请查看[什么是消息回应](/guide/unifying.html#什么是消息回应)
<!-- 如果你不理解消息回应请查看[什么是消息回应](/guide/unifying.html#什么是消息回应) -->
#### 操作数据

View File

@ -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}```

View File

@ -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)

View File

@ -34,7 +34,7 @@ const WKSDK = require("wukongimjssdk").default
``` js [浏览器]
<script src="https://cdn.jsdelivr.net/npm/wukongimjssdk@1.1.3/lib/wukongimjssdk.umd.js"></script>
<script src="https://cdn.jsdelivr.net/npm/wukongimjssdk@1.1.7/lib/wukongimjssdk.umd.js"></script>
```