WuKongIM/WuKongIMDocs
1
0
Fork 0
mirror of https://github.com/WuKongIM/WuKongIMDocs synced 2025-05-31 05:24:10 +00:00
Code Issues Packages Projects Releases Wiki Activity

fix: 修复文档里无效的链接

Browse Source
This commit is contained in:
tangtaoit 2024-07-22 16:20:04 +08:00
parent eb5a8f9cd4
commit af89a3b562
18 changed files with 1477 additions and 1099 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
. dockerignore Normal file
View File

@ -0,0 +1 @@
node_modules/

2
.vitepress/config.ts
View File

@ -74,5 +74,5 @@ export default defineConfig({
}, },
plugins: [UnoCSS()], plugins: [UnoCSS()],
}, },
ignoreDeadLinks: true ignoreDeadLinks: false
}); });

63
src/guide/deploy-binary.md
View File

@ -1,63 +0,0 @@
# 执行文件部署（推荐）
## 1. 下载二进制包
下载对应您系统的二进制包 [release](https://github.com/WuKongIM/WuKongIM/releases/latest)
(国内可以通过gitee下载 https://gitee.com/WuKongDev/WuKongIM/releases/latest)
`
amd架构的系统比较多，所以不清楚下载那个的话 先下载amd后缀的包试试,Windows系统的包仅测试使用，不建议在生产环境使用
`
## 2. 执行
将下载的文件重命名为 wukongim
设置可执行权限
```shell
chmod +x wukongim
```
启动wukongim
```shell
./wukongim
```
或者指定配置
```shell
./wukongim --config configs/config.yaml
```
后台启动
```shell
./wukongim -d
```
停止服务
```shell
./wukongim stop
```
## 3. 配置
[部署配置](/guide/deploy-config)

36
src/guide/deploy-config.md
View File

@ -1,36 +0,0 @@
# 部署配置
`配置修改需要重启服务，重启服务方式查看对应的部署方式的章节`
## 1. 配置IP地址
配置文件如果没指定，默认在 `~/wukongim/wk.yaml` （如果没有就新建）
需要修改配置文件中的 `external.ip` 为服务器外网 IP（如果本地电脑部署没有外网IP，可填写本机局域网IP）。如下
```yaml
external:
ip: 'xxx.xxx.xxx.xxx'
```
[完整配置说明](/guide/fullconfig)
## 2. 开放端口
5001: http api 端口
5100: app 长连接的 tcp 端口
5172: demo端口，用于测试
5200: websocket 端口，web 或 pc 长连接使用的
5300: 监控端口，可以查看服务的运行状态（待完善）
查看服务器信息： http://127.0.0.1:5001/varz
查看监控系统： http://127.0.0.1:5300/web
chat demo： http://127.0.0.1:5172/chatdemo

52
src/guide/deploy-default.md
View File

@ -1,52 +0,0 @@
# 一键部署（推荐）
## 部署
安装部署脚本
```shell
curl -sSL https://gitee.com/WuKongDev/WuKongIMCli/raw/main/install.sh | sudo bash
```
开始服务
```shell
wk start
```
重启服务
```shell
wk stop
```
```shell
wk start
```
`wk stop如果有报错可以忽略`
## 配置
[部署配置](/guide/deploy-config)
## 验证
```shell
wk doctor
```
```shell
[✓] Http Service is running in 5001
[✓] TCP Service is running in 5100
[✓] Monitor Service is running in 5300
• No issues found!
```

40
src/guide/deploy-docker.md
View File

@ -1,40 +0,0 @@
# Docker 部署
## 部署
启动服务
```shell
docker run -d -p 5001:5001 -p 5100:5100 -p 5172:5172 -p 5200:5200 -p 5210:5210 -p 5300:5300 --name wukongim -v ～/wukongim:/root/wukongim registry.cn-shanghai.aliyuncs.com/wukongim/wukongim:v1.2
```
新建配置文件
```shell
vi ~/wukongim/wk.yaml
```
参考： [部署配置](/guide/deploy-config)
重启服务
```shell
docker stop wukongim
```
```shell
docker start wukongim
```
## 配置
[部署配置](/guide/deploy-config)

35
src/guide/deploy-dockercompose.md
View File

@ -1,35 +0,0 @@
# Docker Compose 部署
## 部署
克隆项目
```shell
git clone https://github.com/WuKongIM/WuKongIM.git
```
进入到项目内
```shell
cd WuKongIM
```
启动服务
```shell
docker-compose up -d
```
重启服务
```shell
docker-compose restart
```
## 配置
[部署配置](/guide/deploy-config)

2
src/guide/guide.md
View File

@ -13,7 +13,7 @@ title: 介绍
## 部署服务端 ## 部署服务端
服务端部署：[文档](/install) 服务端部署：[文档](/install/)

94
src/guide/quickstart.md
View File

@ -1,94 +0,0 @@
# 部署
## 第一种：一键部署（推荐）
```shell
curl -sSL https://gitee.com/WuKongDev/WuKongIMCli/raw/main/install.sh | sudo bash
```
```shell
# 前台运行
wk run
# 后台启动
# wk start
# 停止
# wk stop
# 升级WuKongIM
# wk upgrade
```
配置文件在 `~/wukongim/wk.yaml` .
默认是局域网地址，如果需要外网访问，需要修改配置文件中的 `external.ip` 为服务器外网 IP。如下
```yaml
external:
ip: 'xxx.xxx.xxxx.xxx'
```
## 第二种：Docker 部署
```shell
docker run -d -p 5001:5001 -p 5100:5100 -p 5172:5172 -p 5210:5210 -p 5200:5200 -p 5300:5300 -e WK_EXTERNAL_IP=xxx.xxx.xxx.xx --name wukongim -v ~/wukongim:/root/wukongim wukongim/wukongim:latest
```
（如果慢镜像可以替换为国内的： registry.cn-shanghai.aliyuncs.com/wukongim/wukongim:latest）
`WK_EXTERNAL_IP：为服务器外网IP，用于客户端连接，如果仅测试，客户端和服务器都在一个局域网内，这里可以填部署服务器的局域网IP`
## 第三种： Docker Compose 部署
```shell
git clone https://github.com/WuKongIM/WuKongIM.git
cd WuKongIM
docker-compose up -d
```
`WK_EXTERNAL_IP：为服务器外网IP，用于客户端连接，如果仅测试，客户端和服务器都在一个局域网内，这里可以填部署服务器的局域网IP`
## 配置
配置文件为当前目录下的 wk.yaml（默认为~/wukongim/wk.yaml）文件，如果没有此文件，则使用系统的默认最优配置。
完整配置请查看[完整配置](/guide/fullconfig)
## 端口说明
5001: http api 端口
5100: app 长连接的 tcp 端口
5172: demo端口，用于测试
5200: websocket 端口，web 或 pc 长连接使用的
5300: 监控端口，可以查看服务的运行状态（待完善）
查看服务器信息： http://127.0.0.1:5001/varz
查看监控系统： http://127.0.0.1:5300/web
chat demo： http://127.0.0.1:5172/chatdemo
## 验证部署
```shell
wk doctor
```
```shell
[✓] Http Service is running in 5001
[✓] TCP Service is running in 5100
[✓] Monitor Service is running in 5300
• No issues found!
```

2
src/install/docker-compose/multinode-scale.md
View File

@ -43,7 +43,7 @@ services:
- "WK_EXTERNAL_WSADDR=ws://119.45.229.172:15200" # web端访问的ws长连接地址 - "WK_EXTERNAL_WSADDR=ws://119.45.229.172:15200" # web端访问的ws长连接地址
- "WK_EXTERNAL_TCPADDR=119.45.229.172:15100" # app端访问的tcp长连接地址 - "WK_EXTERNAL_TCPADDR=119.45.229.172:15100" # app端访问的tcp长连接地址
- "WK_TRACE_PROMETHEUSAPIURL=http://10.206.0.13:9090" # 监控地址 - "WK_TRACE_PROMETHEUSAPIURL=http://10.206.0.13:9090" # 监控地址
- "WK_CLUSTER_SEED=1001@10.206.0.13:11110" # 种子节点， 原集群里容易节点都可以做为种子节点，这里将node1节点作为种子节点 - "WK_CLUSTER_SEED=1001@10.206.0.13:11110" # 种子节点， 原集群里任意节点都可以做为种子节点，这里将node1节点作为种子节点
healthcheck: healthcheck:
test: "wget -q -Y off -O /dev/null http://localhost:5001/health > /dev/null 2>&1" test: "wget -q -Y off -O /dev/null http://localhost:5001/health > /dev/null 2>&1"
interval: 10s interval: 10s

21
src/install/docker-compose/multinode.md
View File

@ -20,11 +20,11 @@ WuKongIM集群符合 `2n+1` 原则，n表示宕机数量，比如允许1台机
假设三台服务器，信息如下 假设三台服务器，信息如下
| 名称 | 内网IP | 外网IP | 角色 | | 名称 | 内网IP | 外网IP |
| --- | --- | --- | --- | | --- | --- | --- |
| node1(1001) | 10.206.0.13 | 119.45.229.172 | 核心节点 | | node1(1001) | 10.206.0.13 | 119.45.229.172 |
| node2(1002) | 10.206.0.14 | 129.211.213.76 | 常规 | | node2(1002) | 10.206.0.14 | 129.211.213.76 |
| node3(1003) | 10.206.0.8 | 1.13.191.138 | 常规 | | node3(1003) | 10.206.0.8 | 1.13.191.138 |
## 安装 ## 安装
@ -56,10 +56,10 @@ services:
- "WK_EXTERNAL_IP=119.45.229.172" # 当前节点外网ip - "WK_EXTERNAL_IP=119.45.229.172" # 当前节点外网ip
- "WK_CLUSTER_APIURL=http://10.206.0.13:5001" # 节点内部通信api url地址，这里ip换成自己节点实际node2的内网ip - "WK_CLUSTER_APIURL=http://10.206.0.13:5001" # 节点内部通信api url地址，这里ip换成自己节点实际node2的内网ip
- "WK_CLUSTER_SERVERADDR=10.206.0.13:11110" # 节点内部通信请求地址 - "WK_CLUSTER_SERVERADDR=10.206.0.13:11110" # 节点内部通信请求地址
- "WK_EXTERNAL_WSADDR=ws://119.45.229.172:15200" # web端访问的ws长连接地址 - "WK_EXTERNAL_WSADDR=ws://119.45.229.172:15200" # web端访问的ws长连接地址，这里设置负载均衡的地址即可，这样让负载均衡来分配WuKongIM
- "WK_EXTERNAL_TCPADDR=119.45.229.172:15100" # app端访问的tcp长连接地址 - "WK_EXTERNAL_TCPADDR=119.45.229.172:15100" # app端访问的tcp长连接地址，这里设置负载均衡的地址即可，这样让负载均衡来分配WuKongIM
- "WK_TRACE_PROMETHEUSAPIURL=http://10.206.0.13:9090" # 监控地址 - "WK_TRACE_PROMETHEUSAPIURL=http://10.206.0.13:9090" # 监控地址
- "WK_CLUSTER_NODES=1001@10.206.0.13 1002@10.206.0.14 1003@10.206.0.8" # 集群节点列表 - "WK_CLUSTER_INITNODES=1001@10.206.0.13 1002@10.206.0.14 1003@10.206.0.8" # 集群节点列表
healthcheck: healthcheck:
test: "wget -q -Y off -O /dev/null http://localhost:5001/health > /dev/null 2>&1" test: "wget -q -Y off -O /dev/null http://localhost:5001/health > /dev/null 2>&1"
interval: 10s interval: 10s
@ -112,7 +112,7 @@ services:
- "WK_EXTERNAL_WSADDR=ws://129.211.213.76:15200" # web端访问的ws长连接地址 - "WK_EXTERNAL_WSADDR=ws://129.211.213.76:15200" # web端访问的ws长连接地址
- "WK_EXTERNAL_TCPADDR=129.211.213.76:15100" # app端访问的tcp长连接地址 - "WK_EXTERNAL_TCPADDR=129.211.213.76:15100" # app端访问的tcp长连接地址
- "WK_TRACE_PROMETHEUSAPIURL=http://10.206.0.13:9090" # 监控地址 - "WK_TRACE_PROMETHEUSAPIURL=http://10.206.0.13:9090" # 监控地址
- "WK_CLUSTER_NODES=1001@10.206.0.13 1002@10.206.0.14 1003@10.206.0.8" # 集群节点列表 - "WK_CLUSTER_INITNODES=1001@10.206.0.13 1002@10.206.0.14 1003@10.206.0.8" # 集群节点列表
healthcheck: healthcheck:
test: "wget -q -Y off -O /dev/null http://localhost:5001/health > /dev/null 2>&1" test: "wget -q -Y off -O /dev/null http://localhost:5001/health > /dev/null 2>&1"
interval: 10s interval: 10s
@ -150,7 +150,7 @@ services:
- "WK_EXTERNAL_WSADDR=ws://119.45.229.172:15200" # web端访问的ws长连接地址 - "WK_EXTERNAL_WSADDR=ws://119.45.229.172:15200" # web端访问的ws长连接地址
- "WK_EXTERNAL_TCPADDR=119.45.229.172:15100" # app端访问的tcp长连接地址 - "WK_EXTERNAL_TCPADDR=119.45.229.172:15100" # app端访问的tcp长连接地址
- "WK_TRACE_PROMETHEUSAPIURL=http://10.206.0.13:9090" # 监控地址 - "WK_TRACE_PROMETHEUSAPIURL=http://10.206.0.13:9090" # 监控地址
- "WK_CLUSTER_NODES=1001@10.206.0.13 1002@10.206.0.14 1003@10.206.0.8" # 集群节点列表 - "WK_CLUSTER_INITNODES=1001@10.206.0.13 1002@10.206.0.14 1003@10.206.0.8" # 集群节点列表
healthcheck: healthcheck:
test: "wget -q -Y off -O /dev/null http://localhost:5001/health > /dev/null 2>&1" test: "wget -q -Y off -O /dev/null http://localhost:5001/health > /dev/null 2>&1"
interval: 10s interval: 10s
@ -202,6 +202,7 @@ scrape_configs:
在node1节点上的安装目录（`~/wukongim`）里创建`nginx.conf`文件，内容如下： 在node1节点上的安装目录（`~/wukongim`）里创建`nginx.conf`文件，内容如下：
```nginx ```nginx
user nginx; user nginx;
worker_processes auto; worker_processes auto;

4
src/install/docker-compose/singlenode-scale.md
View File

@ -7,7 +7,7 @@
假设有两台服务器，信息如下 假设有两台服务器，信息如下
| 名称 | 内网IP | 外网IP | 角色 | | 名称 | 内网IP | 外网IP | 描述 |
| --- | --- | --- | --- | | --- | --- | --- | --- |
| node1(1001) | 192.168.1.10 | 221.123.68.10 | 主节点（原部署好的单机节点） | | node1(1001) | 192.168.1.10 | 221.123.68.10 | 主节点（原部署好的单机节点） |
| node2(1002) | 192.168.1.20 | 221.123.68.20 | 即将加入的新节点 | | node2(1002) | 192.168.1.20 | 221.123.68.20 | 即将加入的新节点 |
@ -55,7 +55,7 @@ services:
- "WK_EXTERNAL_TCPADDR=221.123.68.10:15100" # app端访问的tcp长连接地址,注意这里是 node1的外网ip - "WK_EXTERNAL_TCPADDR=221.123.68.10:15100" # app端访问的tcp长连接地址,注意这里是 node1的外网ip
- "WK_CLUSTER_APIURL=http://192.168.1.20:5001" # 节点内部通信api url地址，这里ip换成自己节点实际node2的内网ip - "WK_CLUSTER_APIURL=http://192.168.1.20:5001" # 节点内部通信api url地址，这里ip换成自己节点实际node2的内网ip
- "WK_CLUSTER_SERVERADDR=192.168.1.20:11110" # 节点内部通信请求地址 - "WK_CLUSTER_SERVERADDR=192.168.1.20:11110" # 节点内部通信请求地址
- "WK_CLUSTER_SEED=1001@192.168.1.10:11110" # 种子节点， 原node1节点的内网通讯地址 - "WK_CLUSTER_SEED=1001@192.168.1.10:11110" # 种子节点， 原集群里任意节点都可以做为种子节点，这里将node1节点作为种子节点
- "WK_TRACE_PROMETHEUSAPIURL=http://192.168.1.10:9090" # prometheus监控地址， node1的内网地址 - "WK_TRACE_PROMETHEUSAPIURL=http://192.168.1.10:9090" # prometheus监控地址， node1的内网地址
healthcheck: healthcheck:
test: "wget -q -Y off -O /dev/null http://localhost:5001/health > /dev/null 2>&1" test: "wget -q -Y off -O /dev/null http://localhost:5001/health > /dev/null 2>&1"

2
src/install/linux/multinode-scale.md
View File

@ -57,7 +57,7 @@ cluster:
nodeId: 1004 # 节点id nodeId: 1004 # 节点id
apiUrl: "http://192.168.12.4:5001" # 当前节点内网的api地址 apiUrl: "http://192.168.12.4:5001" # 当前节点内网的api地址
serverAddr: "192.168.12.4:11110" # 当前节点内网的分布式通讯地址 serverAddr: "192.168.12.4:11110" # 当前节点内网的分布式通讯地址
seed: "1001@192.168.12.1:11100" # 种子节点 seed: "1001@192.168.12.1:11100" # 种子节点，原集群里任意节点都可以做为种子节点，这里将node1节点作为种子节点
``` ```

10
src/install/linux/multinode.md
View File

@ -20,11 +20,11 @@ WuKongIM集群符合 `2n+1` 原则，n表示宕机数量，比如允许1台机
假设三台服务器，信息如下 假设三台服务器，信息如下
| 名称 | 内网IP | 外网IP | 角色 | | 名称 | 内网IP | 外网IP |
| --- | --- | --- | --- | | --- | --- | --- |
| node1(1001) | 10.206.0.13 | 119.45.229.172 | 核心节点 | | node1(1001) | 10.206.0.13 | 119.45.229.172 |
| node2(1002) | 10.206.0.14 | 129.211.213.76 | 常规 | | node2(1002) | 10.206.0.14 | 129.211.213.76 |
| node3(1003) | 10.206.0.8 | 1.13.191.138 | 常规 | | node3(1003) | 10.206.0.8 | 1.13.191.138 |
## 准备工作 ## 准备工作

2
src/install/linux/singlenode-scale.md
View File

@ -7,7 +7,7 @@
假设有两台服务器，信息如下 假设有两台服务器，信息如下
| 名称 | 内网IP | 外网IP | 角色 | | 名称 | 内网IP | 外网IP | 描述 |
| --- | --- | --- | --- | | --- | --- | --- | --- |
| node1(1001) | 192.168.1.10 | 221.123.68.10 | 主节点（原部署好的单机节点） | | node1(1001) | 192.168.1.10 | 221.123.68.10 | 主节点（原部署好的单机节点） |
| node2(1002) | 192.168.1.20 | 221.123.68.20 | 即将加入的新节点 | | node2(1002) | 192.168.1.20 | 221.123.68.20 | 即将加入的新节点 |

4
src/server/advance/integration.md
View File

@ -7,13 +7,13 @@
![集成用户流程](./integration.png) ![集成用户流程](./integration.png)
1. 您的应用调用自己的登录或注册的业务接口。 1. 您的应用调用自己的登录或注册的业务接口。
2. 您的登录或注册的业务接口处理完自己的业务逻辑后将生成的用户 ID（uid）和 token，调用WuKongIM 的[登录或注册用户](/api/user#注册用户)接口更新到WuKongIM 2. 您的登录或注册的业务接口处理完自己的业务逻辑后将生成的用户 ID（uid）和 token，调用WuKongIM 的[登录或注册用户](/server/api/user#注册用户)接口更新到WuKongIM
3. 将 uid 和 token 返回给您自己的应用端。 3. 将 uid 和 token 返回给您自己的应用端。
4. 应用端调用WuKongIM 的 SDK 的 connect 方法，将 uid 和 token 传入，WuKongIM 的 SDK 会将 uid 和 token 传给WuKongIM 的服务端进行校验，如果客户端传的跟服务端传的一致将校验通过，校验通过后将保持长连接 4. 应用端调用WuKongIM 的 SDK 的 connect 方法，将 uid 和 token 传入，WuKongIM 的 SDK 会将 uid 和 token 传给WuKongIM 的服务端进行校验，如果客户端传的跟服务端传的一致将校验通过，校验通过后将保持长连接
## 第二步：提供 Webhook 接口 ## 第二步：提供 Webhook 接口
第三方服务提供一个 http api 接口，WuKongIM 将按照 Webhook[(详见文档)](/api/webhook)的约定将对应的数据按照事件的机制传递给此接口。 第三方服务提供一个 http api 接口，WuKongIM 将按照 Webhook[(详见文档)](/server/api/webhook)的约定将对应的数据按照事件的机制传递给此接口。
## 第三步：配置 Webhook 接口到WuKongIM ## 第三步：配置 Webhook 接口到WuKongIM

2
src/server/api/message.md
View File

@ -30,7 +30,7 @@ order: 200
} }
``` ```
[payload 内容参考](/guide/proto#普通消息) [payload 内容参考](/server/advance/proto.html#普通消息)
成功响应 成功响应

2204
yarn.lock
View File

File diff suppressed because it is too large Load Diff