diff --git a/docs/.vitepress/config.mts b/docs/.vitepress/config.mts index 56cb0cfea..a84b38937 100644 --- a/docs/.vitepress/config.mts +++ b/docs/.vitepress/config.mts @@ -150,6 +150,7 @@ export default defineConfig({ { text: "Telegram", link: "/zh/deploy/platforms/telegram" }, { text: "Slack", link: "/zh/deploy/platforms/slack" }, { text: "LINE", link: "/zh/deploy/platforms/line" }, + { text: "KOOK", link: "/zh/deploy/platforms/kook" }, ], }, { @@ -380,6 +381,7 @@ export default defineConfig({ { text: "Telegram", link: "/en/deploy/platforms/telegram" }, { text: "Slack", link: "/en/deploy/platforms/slack" }, { text: "LINE", link: "/en/deploy/platforms/line" }, + { text: "KOOK", link: "/en/deploy/platforms/kook" }, { text: "Lark", link: "/en/deploy/platforms/lark" }, { text: "DingTalk", link: "/en/deploy/platforms/dingtalk" }, { diff --git a/docs/assets/image/zh/deploy/bots/kook/01-dashboard.png b/docs/assets/image/zh/deploy/bots/kook/01-dashboard.png new file mode 100644 index 000000000..4de3f73f2 Binary files /dev/null and b/docs/assets/image/zh/deploy/bots/kook/01-dashboard.png differ diff --git a/docs/assets/image/zh/deploy/bots/kook/02-create-app.png b/docs/assets/image/zh/deploy/bots/kook/02-create-app.png new file mode 100644 index 000000000..42da78ed3 Binary files /dev/null and b/docs/assets/image/zh/deploy/bots/kook/02-create-app.png differ diff --git a/docs/assets/image/zh/deploy/bots/kook/03-app-created.png b/docs/assets/image/zh/deploy/bots/kook/03-app-created.png new file mode 100644 index 000000000..f6f7a316a Binary files /dev/null and b/docs/assets/image/zh/deploy/bots/kook/03-app-created.png differ diff --git a/docs/assets/image/zh/deploy/bots/kook/04-app-overview.png b/docs/assets/image/zh/deploy/bots/kook/04-app-overview.png new file mode 100644 index 000000000..49e205ecd Binary files /dev/null and b/docs/assets/image/zh/deploy/bots/kook/04-app-overview.png differ diff --git a/docs/assets/image/zh/deploy/bots/kook/05-bot-token.png b/docs/assets/image/zh/deploy/bots/kook/05-bot-token.png new file mode 100644 index 000000000..de4cc124c Binary files /dev/null and b/docs/assets/image/zh/deploy/bots/kook/05-bot-token.png differ diff --git a/docs/assets/image/zh/deploy/bots/kook/06-invite-link.png b/docs/assets/image/zh/deploy/bots/kook/06-invite-link.png new file mode 100644 index 000000000..dd85a364e Binary files /dev/null and b/docs/assets/image/zh/deploy/bots/kook/06-invite-link.png differ diff --git a/docs/assets/image/zh/deploy/bots/kook/07-message-filters.png b/docs/assets/image/zh/deploy/bots/kook/07-message-filters.png new file mode 100644 index 000000000..db25aadae Binary files /dev/null and b/docs/assets/image/zh/deploy/bots/kook/07-message-filters.png differ diff --git a/docs/assets/image/zh/deploy/bots/kook/08-permissions-enabled.png b/docs/assets/image/zh/deploy/bots/kook/08-permissions-enabled.png new file mode 100644 index 000000000..eb1691b80 Binary files /dev/null and b/docs/assets/image/zh/deploy/bots/kook/08-permissions-enabled.png differ diff --git a/docs/assets/image/zh/deploy/bots/kook/09-langbot-bots.png b/docs/assets/image/zh/deploy/bots/kook/09-langbot-bots.png new file mode 100644 index 000000000..c6d033acb Binary files /dev/null and b/docs/assets/image/zh/deploy/bots/kook/09-langbot-bots.png differ diff --git a/docs/assets/image/zh/deploy/bots/kook/10-bot-config.png b/docs/assets/image/zh/deploy/bots/kook/10-bot-config.png new file mode 100644 index 000000000..324d7711a Binary files /dev/null and b/docs/assets/image/zh/deploy/bots/kook/10-bot-config.png differ diff --git a/docs/assets/image/zh/deploy/bots/kook/11-bot-created.png b/docs/assets/image/zh/deploy/bots/kook/11-bot-created.png new file mode 100644 index 000000000..ce826cdd9 Binary files /dev/null and b/docs/assets/image/zh/deploy/bots/kook/11-bot-created.png differ diff --git a/docs/assets/image/zh/deploy/bots/kook/12-bot-enabled.png b/docs/assets/image/zh/deploy/bots/kook/12-bot-enabled.png new file mode 100644 index 000000000..084e8a968 Binary files /dev/null and b/docs/assets/image/zh/deploy/bots/kook/12-bot-enabled.png differ diff --git a/docs/en/deploy/platforms/kook.md b/docs/en/deploy/platforms/kook.md new file mode 100644 index 000000000..ef82ffe69 --- /dev/null +++ b/docs/en/deploy/platforms/kook.md @@ -0,0 +1,63 @@ +# Integrating KOOK Bot + +## Create a Bot + +Visit the [KOOK Developer Center](https://developer.kookapp.cn/), log in and access the console. + +![KOOK Developer Console](/assets/image/zh/deploy/bots/kook/01-dashboard.png) + +Click "Create Application" and fill in the application information. + +![Create Application](/assets/image/zh/deploy/bots/kook/02-create-app.png) + +After the application is created, enter the application details page. + +![Application Created](/assets/image/zh/deploy/bots/kook/03-app-created.png) + +You can view the basic information of the application on the application overview page. + +![Application Overview](/assets/image/zh/deploy/bots/kook/04-app-overview.png) + +## Get Bot Token + +In the application page, click the "Bot" tab, copy the Bot Token and save it securely. You will need it later. + +![Get Bot Token](/assets/image/zh/deploy/bots/kook/05-bot-token.png) + +## Configure Bot Permissions + +**Important:** In the "Bot" settings, find the "Message Filtering" option and click to configure. + +![Message Filter Settings](/assets/image/zh/deploy/bots/kook/07-message-filters.png) + +Enable all message-related event permissions, including channel messages and private message events. Otherwise, the bot will not be able to receive messages. + +![Enable Permissions](/assets/image/zh/deploy/bots/kook/08-permissions-enabled.png) + +## Invite the Bot + +In the bot settings page, you can generate an invitation link to invite the bot to your server. + +![Generate Invitation Link](/assets/image/zh/deploy/bots/kook/06-invite-link.png) + +## Connect to LangBot + +Open the LangBot Webui page, and click to create a new bot on the "Bots" page. + +![LangBot Bot Management](/assets/image/zh/deploy/bots/kook/09-langbot-bots.png) + +Select the KOOK platform, fill in the bot name and Bot Token. + +![Configure KOOK Bot](/assets/image/zh/deploy/bots/kook/10-bot-config.png) + +After saving, the bot will appear in the list. + +![Bot Created](/assets/image/zh/deploy/bots/kook/11-bot-created.png) + +Click the enable button to start the bot. If successfully configured, the bot status will show as running. + +![Bot Enabled](/assets/image/zh/deploy/bots/kook/12-bot-enabled.png) + +## Using the Bot + +Now in the KOOK server, the bot can receive and reply to messages normally. The bot supports both channel messages and private messages. diff --git a/docs/en/deploy/platforms/readme.md b/docs/en/deploy/platforms/readme.md index 5ec3be14d..5f9e4b072 100644 --- a/docs/en/deploy/platforms/readme.md +++ b/docs/en/deploy/platforms/readme.md @@ -11,6 +11,7 @@ Bots are used to receive message events from messaging platforms and call pipeli | Telegram | ✅ | | [Tutorial](/en/deploy/platforms/telegram) | | Slack | ✅ | | [Tutorial](/en/deploy/platforms/slack) | | LINE | ✅ | | [Tutorial](/en/deploy/platforms/line) | +| KOOK | ✅ | | [Tutorial](/en/deploy/platforms/kook) | | Lark | ✅ | | [Tutorial](/en/deploy/platforms/lark) | | DingTalk | ✅ | | [Tutorial](/en/deploy/platforms/dingtalk) | | WeCom (Enterprise WeChat) | ✅ | Enterprise internal bot | [Tutorial](/en/deploy/platforms/wecom/wecom) | diff --git a/docs/en/insight/features.md b/docs/en/insight/features.md index 8b6c641c3..0181b92ed 100644 --- a/docs/en/insight/features.md +++ b/docs/en/insight/features.md @@ -17,6 +17,7 @@ LangBot is an open-source LLM native instant messaging robot development platfor | Telegram | ✅ | Support streaming output | | Slack | ✅ | | | LINE | ✅ | | +| KOOK | ✅ | | | WhatsApp | 🚧 | | 🚧: In development diff --git a/docs/zh/deploy/platforms/kook.md b/docs/zh/deploy/platforms/kook.md new file mode 100644 index 000000000..cdc319052 --- /dev/null +++ b/docs/zh/deploy/platforms/kook.md @@ -0,0 +1,63 @@ +# 接入 KOOK 机器人 + +## 创建机器人 + +前往 [KOOK 开发者中心](https://developer.kookapp.cn/),登录后进入控制台。 + +![KOOK 开发者控制台](/assets/image/zh/deploy/bots/kook/01-dashboard.png) + +点击「新建应用」,填写应用信息。 + +![创建应用](/assets/image/zh/deploy/bots/kook/02-create-app.png) + +应用创建完成后,进入应用详情页。 + +![应用已创建](/assets/image/zh/deploy/bots/kook/03-app-created.png) + +在应用概览页面可以查看应用的基本信息。 + +![应用概览](/assets/image/zh/deploy/bots/kook/04-app-overview.png) + +## 获取 Bot Token + +在应用页面中,点击「机器人」标签,复制 Bot Token 并妥善保存,后续需要使用。 + +![获取 Bot Token](/assets/image/zh/deploy/bots/kook/05-bot-token.png) + +## 配置机器人权限 + +**重要:** 在「机器人」设置中,找到「消息过滤」选项,点击配置。 + +![消息过滤设置](/assets/image/zh/deploy/bots/kook/07-message-filters.png) + +开启所有消息相关事件权限,包括频道消息和私聊消息事件,否则机器人将无法接收消息。 + +![启用权限](/assets/image/zh/deploy/bots/kook/08-permissions-enabled.png) + +## 邀请机器人 + +在机器人设置页面,可以生成邀请链接,将机器人邀请到你的服务器。 + +![生成邀请链接](/assets/image/zh/deploy/bots/kook/06-invite-link.png) + +## 对接 LangBot + +打开 LangBot Webui 页面,在「机器人」页面点击创建新机器人。 + +![LangBot 机器人管理](/assets/image/zh/deploy/bots/kook/09-langbot-bots.png) + +选择 KOOK 平台,填写机器人名称和 Bot Token。 + +![配置 KOOK 机器人](/assets/image/zh/deploy/bots/kook/10-bot-config.png) + +保存后,机器人将出现在列表中。 + +![机器人已创建](/assets/image/zh/deploy/bots/kook/11-bot-created.png) + +点击启用按钮,启动机器人。若成功配置,机器人状态将显示为运行中。 + +![机器人已启用](/assets/image/zh/deploy/bots/kook/12-bot-enabled.png) + +## 使用机器人 + +现在在 KOOK 服务器中,机器人就可以正常接收和回复消息了。机器人支持频道消息和私聊消息。 diff --git a/docs/zh/deploy/platforms/readme.md b/docs/zh/deploy/platforms/readme.md index 8e876024b..e1c96a3fb 100644 --- a/docs/zh/deploy/platforms/readme.md +++ b/docs/zh/deploy/platforms/readme.md @@ -19,3 +19,4 @@ | Telegram | ✅ | | [教程](/zh/deploy/platforms/telegram) | | Slack | ✅ | | [教程](/zh/deploy/platforms/slack) | | LINE | ✅ | | [教程](/zh/deploy/platforms/line) | +| KOOK | ✅ | | [教程](/zh/deploy/platforms/kook) | diff --git a/docs/zh/insight/features.md b/docs/zh/insight/features.md index 79267b8a8..134e1bdbe 100644 --- a/docs/zh/insight/features.md +++ b/docs/zh/insight/features.md @@ -18,6 +18,7 @@ LangBot 是一个开源的大语言模型原生即时通信机器人开发平台 | Telegram | ✅ | 支持流式输出 | | Slack | ✅ | | | LINE | ✅ | | +| KOOK | ✅ | | | WhatsApp | 🚧 | | 🚧: 正在开发中