doc: 优化部署教程

This commit is contained in:
Junyan Qin
2024-11-18 23:44:42 +08:00
parent 7d010c4689
commit cd260f390d
8 changed files with 58 additions and 36 deletions
+2 -1
View File
@@ -32,8 +32,8 @@ export default defineConfig({
text: "部署 LangBot",
collapsed: true,
items: [
{ text: "手动部署", link: "/deploy/langbot/manual" },
{ text: "Docker部署", link: "/deploy/langbot/docker" },
{ text: "手动部署", link: "/deploy/langbot/manual" },
],
},
{
@@ -163,6 +163,7 @@ export default defineConfig({
text: "实践", items: [
{ text: "如何在 LangBot 上接入 Dify?", link: "/workshop/dify-integration" },
{ text: "如何接入 OneAPI、LinkAI 等第三方 OpenAI 格式接口?", link: "/workshop/one-api" },
{ text: "消息平台和 LangBot 均使用 Docker 时,如何配置网络连接?", link: "/workshop/docker-network" },
]
},
],
+11 -21
View File
@@ -1,44 +1,34 @@
# Docker部署(仅推荐在Linux上使用)
:::warning
要使用 Docker 部署,请**确保**您具有以下能力:
请**确保**您具有以下能力:
- 了解 `Docker` 和 `Docker Compose` 的使用
- 了解容器间网络通信配置方式
- 了解容器文件挂载机制
- 动手能力强、资料查找能力强
**不建议**您在除 Linux 之外的系统上使用 Docker 进行部署。
:::
:::info
请先确保 Docker 和 Docker Compose 已安装
请先确保 Git、 Docker 和 Docker Compose 已安装
:::
以下是推荐的`docker-compose.yaml`模板,您可以根据自己的需求进行修改。
Git 克隆本项目:
```yaml
version: "3"
services:
langbot:
image: rockchin/langbot:latest
volumes:
- ./data:/app/data
- ./plugins:/app/plugins
restart: on-failure
ports:
- 5300:5300 # 供 WebUI 使用
- 2280-2290:2280-2290 # 供消息平台适配器方向连接
# 根据具体环境配置网络
```bash
git clone https://github.com/RockChinQ/LangBot
cd LangBot
```
保存到一个目录的`docker-compose.yaml`,运行命令:
启动容器:
```bash
docker compose up
```
无报错即为启动成功,请查看`部署消息平台`部分以配置消息平台框架。
首次启动会输出创建配置文件的提示,请继续按照文件配置。
容器会映射`5300`端口供 WebUI 使用,您可以访问`http://127.0.0.1:5300`查看 WebUI。
还会映射`2280-2290`端口供使用 OneBot 协议的消息平台适配器反向连接,请继续阅读[消息平台接入文档](/deploy/platforms/aiocqhttp/napcat)。
## 注意
+3 -1
View File
@@ -51,4 +51,6 @@ Lagrange 是一个 QQNT 协议逆向工程框架,轻便且相对稳定。通
其中 Type 必须为 `ReverseWebSocket`;
Host 为 LangBot 运行的主机 IP,若在同一主机上,可以写 `127.0.0.1`;
Suffix 必须为 `/ws`;
Port 必须与 LangBot 消息平台配置中的 aiocqhttp 适配器监听的端口相同。
Port 必须与 LangBot 消息平台配置中的 aiocqhttp 适配器监听的端口相同。
接下来请阅读[填写配置信息](/deploy/quick-config/config)。
+3 -1
View File
@@ -8,4 +8,6 @@
![image-20240515185909108](/assets/image/llob_cfg.png)
确保地址中 IP地址 是 LangBot 运行的主机的地址(若在同一网络内运行则为 127.0.0.1),端口必须与 LangBot 消息平台配置中的 aiocqhttp 适配器监听的端口相同,后缀必须为`/ws`:
确保地址中 IP地址 是 LangBot 运行的主机的地址(若在同一网络内运行则为 127.0.0.1),端口必须与 LangBot 消息平台配置中的 aiocqhttp 适配器监听的端口相同,后缀必须为`/ws`:
接下来请阅读[填写配置信息](/deploy/quick-config/config)。
+3 -11
View File
@@ -1,15 +1,5 @@
# 部署消息平台 NapCat
## NapCat介绍
NapCat 是一个 QQNT 协议逆向工程框架。
可选平台:
- Windows
- Linux Docker
- Linux 非 Docker
## NapCat安装教程
按照 [NapCat 官方文档安装](https://napneko.com/guide/start-install)
@@ -32,4 +22,6 @@ NapCat 是一个 QQNT 协议逆向工程框架。
然后重新运行登录即可,看到提示:
![image-20240514232647329](/assets/image/napcat_cfg_3.png)
![image-20240514232647329](/assets/image/napcat_cfg_3.png)
接下来请阅读[填写配置信息](/deploy/quick-config/config)。
+4 -1
View File
@@ -71,4 +71,7 @@ go-cqhttp 之类的是模拟 QQ 的协议进行通信,而 Shamrock 使用的
查看填写配置信息页,通过 aiocqhttp 适配器接入。
![img](https://cos.thelazy.cn/pictures/202405292250017.jpeg)
![img](https://cos.thelazy.cn/pictures/202405292250017.jpeg)
接下来请阅读[填写配置信息](/deploy/quick-config/config)。
+4
View File
@@ -12,6 +12,10 @@
目前支持 `go-cqhttp`、`aiocqhttp`、`qq-botpy` 消息平台适配器,也可以同时启用多个同种类或不同种类的平台适配器。
请根据你部署的消息平台的情况选择填写。
::: info
如果消息平台和 LangBot 均运行在 Docker 中,请先配置下方适配器设置,具体网络配置可参考[Docker 网络配置详解](/workshop/docker-network)
:::
### aiocqhttp 适配器
用于接入 NapCat/Lagrange/LLOneBot 等兼容 OneBot 协议的机器人端(仅支持反向ws)。
+28
View File
@@ -0,0 +1,28 @@
# 消息平台和 LangBot 连接
如果消息平台(NapCat/Lagrange)和 LangBot 均使用 Docker 启动,那么你需要配置 Docker 的网络连接。
新建一个网络:
```bash
docker network create langbot-network
```
在 LangBot 目录的 `docker-compose.yaml` 文件中添加网络配置(添加到 `services.langbot` 字段下,并在 `networks` 字段下添加 `langbot-network` 网络配置):
```yaml
services:
langbot:
...
networks:
- langbot-network
...
networks:
langbot-network:
driver: bridge
```
然后在消息平台的 `docker-compose.yaml` 文件中添加同样的网络配置(如果是直接 docker run 命令启动的,请在启动命令中添加 `--network langbot-network`)。接着在消息平台配置文件中,把 WS 反向连接地址中的 IP 地址修改为 `langbot`(例如:`ws://langbot:2280/ws`)。
重启两个容器。