diff --git a/docs/.vitepress/config.mts b/docs/.vitepress/config.mts index ab1cef194..c75738719 100644 --- a/docs/.vitepress/config.mts +++ b/docs/.vitepress/config.mts @@ -75,7 +75,16 @@ export default defineConfig({ text: "QQ 官方机器人", link: "/deploy/platforms/qq/official", }, - { text: "企业微信", link: "/deploy/platforms/wechat/wecom" }, + { text: "企业微信", link: "/deploy/platforms/wecom/wecom" }, + { text: "个人微信", + collapsed: true, + items: [ + { + text: "Gewechat", + link: "/deploy/platforms/wechat/gewechat", + }, + ], + }, { text: "飞书", link: "/deploy/platforms/lark" }, { text: "Discord", link: "/deploy/platforms/discord" }, ], diff --git a/docs/assets/image/gewechat_01.png b/docs/assets/image/gewechat_01.png new file mode 100644 index 000000000..7e42d5f22 Binary files /dev/null and b/docs/assets/image/gewechat_01.png differ diff --git a/docs/assets/image/gewechat_02.png b/docs/assets/image/gewechat_02.png new file mode 100644 index 000000000..6b8b9ca74 Binary files /dev/null and b/docs/assets/image/gewechat_02.png differ diff --git a/docs/config/function/platform.md b/docs/config/function/platform.md index 736d4c921..9bc001c3a 100644 --- a/docs/config/function/platform.md +++ b/docs/config/function/platform.md @@ -50,7 +50,7 @@ ``` 目前支持 `go-cqhttp`、`aiocqhttp`、`qq-botpy`、`wecom` 四种消息平台适配器,也可以同时启用多个同种类或不同种类的平台适配器。 -各个消息平台的配置方式请查看部署文档。 +各个消息平台的配置方式请查看[部署文档](/deploy/quick-config/config.html#platform-json)。 ### 多开示例 diff --git a/docs/deploy/langbot/docker.md b/docs/deploy/langbot/docker.md index 5a2f5765f..21e1aa4a5 100644 --- a/docs/deploy/langbot/docker.md +++ b/docs/deploy/langbot/docker.md @@ -9,13 +9,8 @@ ::: :::info -请先确保 Git、 Docker 和 Docker Compose 已安装 -::: - - - -:::info -使用[阿里云,服务器价格低至 38 元一年,更可以享受8折优惠](https://www.aliyun.com/minisite/goods?userCode=ys4ad8gs) +- 请先确保 Git、 Docker 和 Docker Compose 已安装 +- 推荐使用[阿里云,服务器价格低至 38 元一年,更可以享受8折优惠](https://www.aliyun.com/minisite/goods?userCode=ys4ad8gs) ::: Git 克隆本项目: diff --git a/docs/deploy/platforms/readme.md b/docs/deploy/platforms/readme.md index eb1333385..12e973b6a 100644 --- a/docs/deploy/platforms/readme.md +++ b/docs/deploy/platforms/readme.md @@ -7,6 +7,7 @@ LangBot 需要连接消息平台 API 才能与用户交互,目前支持以下 | ------ | ---- | ---- | ---- | | QQ 个人号 | ✅ | 使用普通的 QQ 号作为机器人,需要使用独立的协议端,支持 OneBot v11 和 go-cqhttp 协议 | [NapCat](/deploy/platforms/qq/aiocqhttp/napcat)
[Lagrange](/deploy/platforms/qq/aiocqhttp/lagrange)
[LiteLoaderQQNT](/deploy/platforms/qq/aiocqhttp/llonebot)
[Shamrock(不推荐)](/deploy/platforms/qq/aiocqhttp/shamrock)
[go-cqhttp(不推荐)](/deploy/platforms/qq/gocq) | | QQ 官方机器人 | ✅ | 接入 QQ 开放平台的机器人 API | [教程](/deploy/platforms/qq/official) | -| 企业微信 | ✅ | 企业内部机器人 | [教程](/deploy/platforms/wechat/wecom) | +| 企业微信 | ✅ | 企业内部机器人 | [教程](/deploy/platforms/wecom/wecom) | +| 个人微信 | ✅ | 个人微信机器人 | [Gewechat](/deploy/platforms/wechat/gewechat) | | 飞书 | ✅ | | [教程](/deploy/platforms/lark) | | Discord | ✅ | | [教程](/deploy/platforms/discord) | \ No newline at end of file diff --git a/docs/deploy/platforms/wechat/gewechat.md b/docs/deploy/platforms/wechat/gewechat.md new file mode 100644 index 000000000..306a2e628 --- /dev/null +++ b/docs/deploy/platforms/wechat/gewechat.md @@ -0,0 +1,93 @@ +# 通过 Gewechat 接入个人微信 + +**本教程要求 LangBot 以 Docker 容器部署**,请根据 LangBot 部署文档将 LangBot 部署到 Docker 中。 + +:::info +- 推荐使用 Ubuntu Linux 系统部署。 +- 推荐使用[阿里云,服务器价格低至 38 元一年,更可以享受8折优惠](https://www.aliyun.com/minisite/goods?userCode=ys4ad8gs),系统选择 Ubuntu 22.04 或 24.04。 +::: + +## 创建 Docker 网络 + +我们需要将 Gewechat 和 LangBot 部署到同一个 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: + external: true +``` + +在下一步部署 Gewechat 时,请在启动命令(docker run 命令)中的`-itd`后添加额外的网络配置`--network langbot-network`。 + +```bash +# 例如原命令为 +docker run -itd -v /root/temp:/root/temp -p 2531:2531 -p 2532:2532 --privileged=true --name=gewe gewe /usr/sbin/init + +# 添加网络配置后,命令变为 +docker run -itd --network langbot-network -v /root/temp:/root/temp -p 2531:2531 -p 2532:2532 --privileged=true --name=gewe gewe /usr/sbin/init +``` + +## 部署 Gewechat + +请查看 [Gewechat 文档](https://github.com/Devo919/Gewechat) 执行到 `启动服务` 步骤。 + +## 在 LangBot 中填写信息并启动 + +根据[填写配置信息](/deploy/quick-config/config)中的个人微信适配器配置,填写 LangBot 相关配置信息。 + +```json + { + "adapter": "gewechat", + "enable": true, + "gewechat_url": "http://gewe:2531", + "port": 2286, + "callback_url": "http://langbot:2286/gewechat/callback", + "app_id": "", + "token": "" + } +``` + +- `enable` 是否启用个人微信适配器,请修改为 `true` +- `gewechat_url` 上一步部署的 Gewechat 容器地址,端口默认为 2531,不需要填写路径 +- `port` LangBot 监听 Gewechat 消息的端口,默认 2286,非必要勿修改 +- `callback_url` 回调地址,是 Gewechat 容器推送消息给 LangBot 容器的地址,需要填写完整路径,例如 `http://langbot:2286/gewechat/callback`,端口与 `port` 一致,路径必须为 `/gewechat/callback` +- `app_id` 和 `token` **请勿填写**,这是用于存储登录信息的,在首次启动扫码登录后会自动保存 + +:::info +在这里我们将`gewechat_url`的主机名设置为`gewe`,即为上一步部署的 Gewechat 容器名称。 +将`callback_url`的主机名设置为`langbot`,即为上一步部署的 LangBot 容器名称。 + +- 如果你按照本教程要求部署,使用上述默认的即可。 +- 如果你使用了其他的容器名称,或者其他情况,请自行更改。 +::: + +## 启动 LangBot + +按照部署 LangBot 文档中的启动命令启动 LangBot。 + +LangBot 启动后,会显示一个二维码,请使用个人微信扫描该二维码进行登录。 + +![alt text](/assets/image/gewechat_01.png) + +成功登录后,会显示登录信息,并开始监听个人微信消息。 + +![alt text](/assets/image/gewechat_02.png) + +:::info +登录后会将`app_id`和`token`保存到配置文件中,下次启动时不需要再次扫码登录。 +::: + +现在即可私聊或在群聊中与 LangBot 对话。 \ No newline at end of file diff --git a/docs/deploy/platforms/wechat/wecom.md b/docs/deploy/platforms/wecom/wecom.md similarity index 100% rename from docs/deploy/platforms/wechat/wecom.md rename to docs/deploy/platforms/wecom/wecom.md diff --git a/docs/deploy/quick-config/config.md b/docs/deploy/quick-config/config.md index cf94424da..9a5e1ea31 100644 --- a/docs/deploy/quick-config/config.md +++ b/docs/deploy/quick-config/config.md @@ -101,7 +101,7 @@ ### 企业微信适配器 -用于接入企业微信机器人,如果不清楚这些内容应该填写什么,请查看[配置企业微信](/deploy/platforms/wechat/wecom.md)。 +用于接入企业微信机器人,如果不清楚这些内容应该填写什么,请查看[配置企业微信](/deploy/platforms/wecom/wecom.md)。 ```json { @@ -126,6 +126,49 @@ `corpid`,`secret`,`token`,`EncodingAESKey`,`contacts_secret`都在企业微信配置项页中获取。 +## 个人微信 + +具体用法请查看[配置个人微信](/deploy/platforms/wechat/gewechat.md)。 + +```json +{ + "adapter": "gewechat", + "enable": true, + "gewechat_url": "http://gewe:2531", + "port": 2286, + "callback_url": "http://langbot:2286/gewechat/callback", + "app_id": "", + "token": "" +} +``` + +## 飞书 + +具体用法请查看[配置飞书](/deploy/platforms/lark.md)。 + +```json +{ + "adapter": "lark", + "enable": false, + "app_id": "cli_abcdefgh", + "app_secret": "XXXXXXXXXX", + "bot_name": "LangBot" +}, +``` + +## Discord + +具体用法请查看[配置 Discord](/deploy/platforms/discord.md)。 + +```json +{ + "adapter": "discord", + "enable": false, + "client_id": "1234567890", + "token": "XXXXXXXXXX" +}, +``` + ## provider.json 修改此配置文件以设置所连接的 AI 提供商的相关信息。