diff --git a/docs/.vitepress/config.mts b/docs/.vitepress/config.mts index bf56480db..1efa4f8e9 100644 --- a/docs/.vitepress/config.mts +++ b/docs/.vitepress/config.mts @@ -87,6 +87,7 @@ export default defineConfig({ ], }, { text: "企业微信", link: "/deploy/platforms/wecom/wecom" }, + { text:"微信公众号",link:"/deploy/platforms/wxoa.md"}, { text: "个人微信", collapsed: true, items: [ diff --git a/docs/assets/image/oa1.png b/docs/assets/image/oa1.png new file mode 100644 index 000000000..a9a8240bd Binary files /dev/null and b/docs/assets/image/oa1.png differ diff --git a/docs/assets/image/oa2.png b/docs/assets/image/oa2.png new file mode 100644 index 000000000..309869a9e Binary files /dev/null and b/docs/assets/image/oa2.png differ diff --git a/docs/config/function/platform.md b/docs/config/function/platform.md index 8269f974b..0bf058a42 100644 --- a/docs/config/function/platform.md +++ b/docs/config/function/platform.md @@ -8,6 +8,7 @@ ## 消息平台适配器 platform-adapters +以下只列举部分适配器配置。 ```json "platform-adapters": [ { @@ -53,11 +54,11 @@ "token": "", "EncodingAESKey": "", "contacts_secret": "" - } + }, ], ``` -目前支持 `go-cqhttp`、`aiocqhttp`、`qq-botpy`、`qqofficial`、 `wecom` 等八种消息平台适配器,也可以同时启用多个同种类或不同种类的平台适配器。 +目前支持 `go-cqhttp`、`aiocqhttp`、`qq-botpy`、`qqofficial`、 `wecom` 等多种消息平台适配器,也可以同时启用多个同种类或不同种类的平台适配器。 各个消息平台的配置方式请查看[部署文档](/deploy/quick-config/config.html#platform-json)。 ### 多开示例 diff --git a/docs/deploy/platforms/qq/official_webhook.md b/docs/deploy/platforms/qq/official_webhook.md index a01c29555..788d18e84 100644 --- a/docs/deploy/platforms/qq/official_webhook.md +++ b/docs/deploy/platforms/qq/official_webhook.md @@ -1,7 +1,6 @@ # 使用 QQ 官方机器人 API(使用webhook方式) -本文章只提供测试版机器人的发布,适用于 **手动部署** 的 LangBot 。
-具体机器人上线请按照 [发布流程](https://q.qq.com/qqbot/#/home) 进行部署。 +本文章只提供测试版机器人的发布,具体机器人上线请按照 [发布流程](https://q.qq.com/qqbot/#/home) 进行部署。 ## 注册 QQ 机器人(测试机器人) diff --git a/docs/deploy/platforms/readme.md b/docs/deploy/platforms/readme.md index cdd0b8471..6a6db54c0 100644 --- a/docs/deploy/platforms/readme.md +++ b/docs/deploy/platforms/readme.md @@ -8,6 +8,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_webhook) | | 企业微信 | ✅ | 企业内部机器人 | [教程](/deploy/platforms/wecom/wecom) | +| 微信公众号 | ✅ | 微信公众平台机器人 | [教程](/deploy/platforms/wxoa.md) | | 个人微信 | ✅ | 个人微信机器人 | [Gewechat](/deploy/platforms/wechat/gewechat) | | 飞书 | ✅ | | [教程](/deploy/platforms/lark) | | Discord | ✅ | | [教程](/deploy/platforms/discord) | \ No newline at end of file diff --git a/docs/deploy/platforms/wecom/wecom.md b/docs/deploy/platforms/wecom/wecom.md index b96fc73bb..1a90d8df6 100644 --- a/docs/deploy/platforms/wecom/wecom.md +++ b/docs/deploy/platforms/wecom/wecom.md @@ -36,6 +36,8 @@ 进入机器人页面。 +点击最下方的`企业可信IP`,将部署 LangBot 的服务器添加进去。 + 点击` 接收消息 `,` 设置API接收 `,开始填写接收服务器消息配置。 URL填写为` http://your_ip_address:2290/callback/command `,你的IP地址就是部署LangBot的服务器的地址。 diff --git a/docs/deploy/platforms/wxoa.md b/docs/deploy/platforms/wxoa.md new file mode 100644 index 000000000..bbe175641 --- /dev/null +++ b/docs/deploy/platforms/wxoa.md @@ -0,0 +1,32 @@ +# 部署微信公众号机器人 + +部署微信公众号机器人接入 LangBot 。 + +## 创建机器人 + +进入[微信公众平台](https://mp.weixin.qq.com/),如果已经有公众号账号,那么直接扫码登录,进入控制台。 +如果之前没有注册过公众号,那么点击立即注册,选择 `公众号`,依次填写信息,进入控制台。控制台是这样的: +![控制台页面](/assets/image/oa1.png) + + +## 设置回调地址 + +### 获取配置项 + +点击`设置与开发`,`开发接口管理`,出现这样的页面: +![设置开发项](/assets/image/oa2.png) + +记录下来`开发者ID(AppID)`,`开发者密码(AppSecret)`,并将部署 LangBot 的服务器添加入`IP白名单`。 + +### 设置反向代理 + +由于微信公众号的只支持http(80端口),https(443端口),所以本文假设80端口已被占用,使用443端口反向代理至 LangBot 。
+具体的反向代理配置教程与[QQ官方机器人反向代理配置](/deploy/platforms/qq/official_webhook.md#操作caddy流程)相同,只是将`reverse_proxy 127.0.0.1:2284`改为`reverse_proxy 127.0.0.1:2287`。 + +### 保存回调地址 + +点击设置服务器配置,输入`Token`,`EncodingAESKey`,并将消息加解密方式改为`安全模式`。
+至此,将获取到的四个配置项( AppID , AppSecret , token , EncodingAESKey )填入[微信公众号配置项](/deploy/quick-config/config.md#微信公众号适配器)。填写成功后,**启动 LangBot 。**
+ +将 URL 填写为`https://your_domain_name/callback/command`,其中的 `your_domain_name` 就是 Caddy 中填写的域名。点击保存。如果可以保存成功,那么意味着部署成功。如果出现**系统发生错误,请稍后重试**,那么请重新检查以上配置内容是否填写正确。 + diff --git a/docs/deploy/quick-config/config.md b/docs/deploy/quick-config/config.md index b24d72fc7..34ff2cb78 100644 --- a/docs/deploy/quick-config/config.md +++ b/docs/deploy/quick-config/config.md @@ -132,15 +132,15 @@ ```json { - "adapter": "wecom", - "enable": false, - "host": "0.0.0.0", - "port": 2290, - "corpid": "", - "secret": "", - "token": "", - "EncodingAESKey": "", - "contacts_secret": "" + "adapter": "wecom", + "enable": false, + "host": "0.0.0.0", + "port": 2290, + "corpid": "", + "secret": "", + "token": "", + "EncodingAESKey": "", + "contacts_secret": "" }, ``` `"adapter": "wecom"`,无需改动。 @@ -153,6 +153,33 @@ `corpid`,`secret`,`token`,`EncodingAESKey`,`contacts_secret`都在企业微信配置项页中获取。 +### 微信公众号适配器 + +用于接入微信公众号机器人。 + +```json +{ + "adapter":"officialaccount", + "enable": true, + "token": "", + "EncodingAESKey":"", + "AppSecret":"", + "AppID":"", + "host": "0.0.0.0", + "port": 2287 +} +``` + +`"adapter": "officialaccount"`,无需改动。 + +`enable`:是否启用,配置完成后请将其设为`true` + +`host`:运行 微信公众号回调地址 的主机地址,一般不改动 + +`port`:运行 微信公众号回调地址 的监听端口,一般不改动 + +`AppSecret`,`token`,`EncodingAESKey`,`AppID`都在微信公众号配置项页中获取。 + ## 个人微信 具体用法请查看[配置个人微信](/deploy/platforms/wechat/gewechat.md)。