diff --git a/docs/.vitepress/config.mts b/docs/.vitepress/config.mts index cb2aa5d3f..bcf3e7f8e 100644 --- a/docs/.vitepress/config.mts +++ b/docs/.vitepress/config.mts @@ -97,6 +97,7 @@ export default defineConfig({ { text:"钉钉",link:"/deploy/platforms/dingtalk.md"}, { text: "Discord", link: "/deploy/platforms/discord" }, { text: "Telegram", link: "/deploy/platforms/telegram" }, + { text:"Slack", link: "/deploy/platforms/slack"}, ], }, { text: "填写配置信息", link: "/deploy/quick-config/config" }, diff --git a/docs/assets/image/slack_01.jpg b/docs/assets/image/slack_01.jpg new file mode 100644 index 000000000..61b656a49 Binary files /dev/null and b/docs/assets/image/slack_01.jpg differ diff --git a/docs/assets/image/slack_02.jpg b/docs/assets/image/slack_02.jpg new file mode 100644 index 000000000..5f9919617 Binary files /dev/null and b/docs/assets/image/slack_02.jpg differ diff --git a/docs/assets/image/slack_03.jpg b/docs/assets/image/slack_03.jpg new file mode 100644 index 000000000..ffa32d1f3 Binary files /dev/null and b/docs/assets/image/slack_03.jpg differ diff --git a/docs/assets/image/slack_04.jpg b/docs/assets/image/slack_04.jpg new file mode 100644 index 000000000..4cdab3cef Binary files /dev/null and b/docs/assets/image/slack_04.jpg differ diff --git a/docs/assets/image/slack_05.jpg b/docs/assets/image/slack_05.jpg new file mode 100644 index 000000000..2afd3a645 Binary files /dev/null and b/docs/assets/image/slack_05.jpg differ diff --git a/docs/deploy/platforms/readme.md b/docs/deploy/platforms/readme.md index 0e1c96ffb..3a24c7c77 100644 --- a/docs/deploy/platforms/readme.md +++ b/docs/deploy/platforms/readme.md @@ -14,3 +14,4 @@ LangBot 需要连接消息平台 API 才能与用户交互,目前支持以下 | 钉钉 | ✅ | | [教程](/deploy/platforms/dingtalk) | | Discord | ✅ | | [教程](/deploy/platforms/discord) | | Telegram | ✅ | | [教程](/deploy/platforms/telegram) | +| Slack | ✅ | | [教程](/deploy/platforms/slack) | diff --git a/docs/deploy/platforms/slack.md b/docs/deploy/platforms/slack.md new file mode 100644 index 000000000..e513c7a03 --- /dev/null +++ b/docs/deploy/platforms/slack.md @@ -0,0 +1,55 @@ +# 接入 Slack 机器人 + +## 创建机器人 + +前往 [Slack的App平台](https://api.slack.com/apps)。 + +![Slack平台](/assets/image/slack_01.jpg) + +点击右上角的 `Create New App` ,选择从 `from a manifest` , 选择要部署机器人的工作区,选择下一步, +选择创建机器人。 + +进入左侧 `Basic Information` 选项,记录 `signing_secret`。 + +进入左侧 `OAuth & Permissions` ,往下拉到 `Scopes`,添加如下机器人权限: + +![机器人权限1](/assets/image/slack_02.jpg) + + +![机器人权限2](/assets/image/slack_03.jpg) + +添加上述权限之后,点击 `Install to your workspace`,记录下开头为 `xoxb-xxxxx`的token。
+ +**注:** +**若没有一次性添加成功权限,后续则需要重新安装App。**
+ +进入左侧 `App Home` 栏,滑到最下面有 `Message Tab`,打开并且勾选 +`Allow users to send Slash commands and messages from the messages tab`。 + +## 连接 LangBot + +进入左侧 `Event Subscriptions` ,打开开关,点击 `Subscribe to bot events`, +将如下权限添加进去: +![事件权限](/assets/image/slack_04.jpg) + +上述操作都完成之后,将 `signing_secret` 和 `bot token` 填写入[Slack适配器中](/deploy/quick-config/config.md#slack)。 + +## 启动机器人 + + Slack 配置项在填写完成后,**启动 LangBot**。 + 然后在刚才Event Subscriptions的 `Request URL`中,填写入你的 LangBot 的部署地址。 + +::: info +由于 Slack 官方要求使用 https,可以参考[QQ官方机器人部署流程中的Caddy配置部分](/deploy/platforms/qq/official_webhook.html#%E9%85%8D%E7%BD%AE%E5%9B%9E%E8%B0%83%E5%9C%B0%E5%9D%80),注意端口使用 Slack 适配器配置的端口。 + +::: + +上述配置项都填写完成后,点击保存链接,若标识为绿色的**Verified**,那么就说明部署成功。 +否则查看上述配置项是否填写正确。 + +## 效果图 + + + +![效果图](/assets/image/slack_05.jpg) + diff --git a/docs/deploy/quick-config/config.md b/docs/deploy/quick-config/config.md index 1914e0895..032b7416f 100644 --- a/docs/deploy/quick-config/config.md +++ b/docs/deploy/quick-config/config.md @@ -247,6 +247,20 @@ }, ``` +### Slack + +具体用法请查看[配置Slack](/deploy/platforms/slack.md)。 + +```json +{ + "adapter":"slack", + "enable":false, + "bot_token":"", + "signing_secret":"", + "port":2288 +} +``` + ## provider.json 修改此配置文件以设置所连接的 AI 提供商的相关信息。