diff --git a/docs/.vitepress/config.mts b/docs/.vitepress/config.mts index f65b34602..332ba8632 100644 --- a/docs/.vitepress/config.mts +++ b/docs/.vitepress/config.mts @@ -80,6 +80,17 @@ export default defineConfig({ ], }, { text: "填写配置信息", link: "/deploy/quick-config/config" }, + { + text: "网络配置详解", + link: "/deploy/network-details", + // collapsed: true, + // items: [ + // { text: "LangBot和消息平台均Docker", link: "/deploy/network/langbot-platform-docker" }, + // { text: "仅LangBot Docker", link: "/deploy/network/langbot-docker" }, + // { text: "仅消息平台 Docker(不建议)", link: "/deploy/network/platform-docker" }, + // { text: "LangBot和消息平台均非Docker", link: "/deploy/network/langbot-platform-manual" }, + // ], + }, ], }, { @@ -136,7 +147,7 @@ export default defineConfig({ { text: "消息平台实体", link: "/plugin/dev/messages" }, { text: "API 参考", link: "/plugin/dev/api-ref" }, { text: "组件扩展", link: "/plugin/dev/extension" }, - ] + ], }, // { text: "技术信息", link: "/plugin/tech-info" }, ], @@ -147,7 +158,7 @@ export default defineConfig({ { text: "介绍 & 使用", link: "/webui/intro" }, { text: "系统操作", link: "/webui/system" }, { text: "设置项管理", link: "/webui/settings" }, - ] + ], }, // { // text: "规模化和商用", @@ -161,22 +172,29 @@ 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" }, - ] + text: "实践", + items: [ + { + text: "如何在 LangBot 上接入 Dify?", + link: "/workshop/dify-integration", + }, + { + text: "如何接入 OneAPI、LinkAI 等第三方 OpenAI 格式接口?", + link: "/workshop/one-api", + }, + ], }, ], // 编辑链接 editLink: { - pattern: "https://github.com/the-lazy-me/Langbot-Wiki/edit/main/docs/:path", + pattern: + "https://github.com/the-lazy-me/Langbot-Wiki/edit/main/docs/:path", }, // 本地搜索 search: { - provider: 'local' + provider: "local", }, // 导航栏的社交图标 diff --git a/docs/deploy/network-details.md b/docs/deploy/network-details.md new file mode 100644 index 000000000..f3efcb66f --- /dev/null +++ b/docs/deploy/network-details.md @@ -0,0 +1,60 @@ +# 网络配置详解 +:::tip + +LangBot和消息平台均可采用Docker部署, + +进而产生了四种不同的方式: + +[[toc]] + +本文旨在介绍这四种情况下的网络配置 +::: + +## LangBot和消息平台都采用Docker + +如果消息平台(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`)。 + +重启两个容器。 + + + +## 仅LangBot使用使用Docker + +当只有LangBot采用Docker部署时,默认情况就已经映射了2280到2290这些端口给消息平台(因为只支持消息平台作为客户端连接)使用 + +所以消息平台设置为ReverseWebSocket(反向ws),端口在2280到2290之间,连接本地127.0.0.1即可 + + +## LangBot和消息平台都不使用Docker部署 + +直接看文档配置消息平台和设置platforms即可,两者端口设置为统一的不被占用的即可,都连接本地127.0.0.1 + + +## 仅消息平台使用Docker(这个不建议) + +:::warning +这种情况不建议 +::: \ No newline at end of file diff --git a/docs/deploy/platforms/aiocqhttp/napcat.md b/docs/deploy/platforms/aiocqhttp/napcat.md index d31f1605a..ca41d2666 100644 --- a/docs/deploy/platforms/aiocqhttp/napcat.md +++ b/docs/deploy/platforms/aiocqhttp/napcat.md @@ -20,7 +20,7 @@ ::: info - 端口号取决于 `data/config/platform.json` 中 `aiocqhttp` 的 `port` 字段,默认是 2280,请查看[填写配置信息](/deploy/quick-config/config)继续配置。 - 必须使用 WebSocket Client(反向 WS) 连接 LangBot,注意根据实际情况修改 IP 地址和端口,后缀必须为`/ws`。 -- 如果 LangBot 和 NapCat 均运行在容器中,请参考[容器网络配置](/workshop/docker-network)。 +- 如果 LangBot 和 NapCat 均运行在容器中,请参考[容器网络配置](/deploy/network-details)。 ::: 接下来请阅读[填写配置信息](/deploy/quick-config/config)。 diff --git a/docs/deploy/quick-config/config.md b/docs/deploy/quick-config/config.md index d68ee1d0d..9d884d16f 100644 --- a/docs/deploy/quick-config/config.md +++ b/docs/deploy/quick-config/config.md @@ -1,6 +1,6 @@ # 填写配置信息 -修改以下配置文件即可启用 LangBot 的基本功能,当你阅读完此页面后,建议查看[配置详解](../../config/function/platform.md),以了解更多的配置项详解 +修改以下配置文件即可启用 LangBot 的基本功能,当你阅读完此页面后,建议查看[配置详解](/config/function/platform.md),以了解更多的配置项详解 - `data/config/platform.json` - `data/config/provider.json` @@ -13,7 +13,7 @@ 请根据你部署的消息平台的情况选择填写。 ::: info -如果消息平台和 LangBot 均运行在 Docker 中,请先配置下方适配器设置,具体网络配置可参考[Docker 网络配置详解](/workshop/docker-network) +如果消息平台和 LangBot 均运行在 Docker 中,请先配置下方适配器设置,具体网络配置可参考[Docker 网络配置详解](/deploy/network-details) ::: ### aiocqhttp 适配器 diff --git a/docs/workshop/docker-network.md b/docs/workshop/docker-network.md deleted file mode 100644 index e1e392baf..000000000 --- a/docs/workshop/docker-network.md +++ /dev/null @@ -1,28 +0,0 @@ -# 消息平台和 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`)。 - -重启两个容器。 \ No newline at end of file