adapter selfurl requirements, fix #138

koishijs · Dec 13, 2023 · 423b8e4 · 423b8e4
1 parent b28749e
commit 423b8e4
Show file tree

Hide file tree

Showing 12 changed files with 57 additions and 2 deletions.
diff --git a/zh-CN/plugins/adapter/dingtalk.md b/zh-CN/plugins/adapter/dingtalk.md
@@ -1,9 +1,13 @@
 # @koishijs/plugin-adapter-dingtalk
 
+::: tip
+如果选择通信方式为 `http`，那么你需要准备一个带有 SSL 证书的公网域名，并将 Koishi [部署到公网](../../manual/recipe/server.md)。
+:::
+
 ## 接入方式
 
 1. 前往 [开放平台 > 应用开发 > 钉钉应用](https://open-dev.dingtalk.com/fe/app#/corp/app) 并点击「创建应用」，输入相关信息确定创建
-2. 在跳转至的页面，选择添加「机器人」；勾选「机器人配置」，输入相关信息；消息接收模式选择 `Stream 模式` 时，插件的 protocol 填写 ws，选择 `HTTP 模式` 时，将机器人的 `selfUrl` 值后连接 `/dingtalk` (如 `https://example.com/dingtalk`) 填入钉钉平台的消息接收地址，插件的 protocol 填写 http；最后点击发布按钮
+2. 在跳转至的页面，选择添加「机器人」；勾选「机器人配置」，输入相关信息；消息接收模式选择 `Stream 模式` 时，插件的 `protocol` 选择 `ws`，选择 `HTTP 模式` 时，将机器人的 `selfUrl` 值后连接 `/dingtalk` (如 `https://example.com/dingtalk`) 填入钉钉平台的消息接收地址，插件的 `protocol` 选择 `http`；最后点击发布按钮
 3. 在左侧打开「凭证与基础信息」页面，将 `Client ID` 填入插件的 `appkey` 字段，将 `Client Secret` 填入插件的 `secret` 字段。
 4. (可选) 为了在控制台中显示应用名称与头像，请参照 [添加接口调用权限](https://open.dingtalk.com/document/orgapp/add-api-permission) 操作，申请 `qyapi_get_microapp_list` 权限；在左侧打开「添加应用能力」，选择添加「网页应用」。将「企业内部应用 AgentId」填入插件的 `agentId` 字段
 

diff --git a/zh-CN/plugins/adapter/kook.md b/zh-CN/plugins/adapter/kook.md
@@ -1,5 +1,9 @@
 # @koishijs/plugin-adapter-kook
 
+::: tip
+如果选择通信方式为 `http`，那么你需要准备一个带有 SSL 证书的公网域名，并将 Koishi [部署到公网](../../manual/recipe/server.md)。
+:::
+
 ## 接入方法
 
 1. 前往 [开发者平台](https://developer.kookapp.cn/)，选择「机器人」并点击「新建」

diff --git a/zh-CN/plugins/adapter/lark.md b/zh-CN/plugins/adapter/lark.md
@@ -1,5 +1,9 @@
 # @koishijs/plugin-adapter-lark
 
+::: warning
+在接入之前，你需要准备一个带有 SSL 证书的公网域名，并将 Koishi [部署到公网](../../manual/recipe/server.md)。
+:::
+
 ## 接入方法
 
 1. 在开发者后台 ([Lark](https://open.larksuite.com/app/) / [飞书](https://open.feishu.cn/app/)) 新建**企业自建应用**，点击应用名称进入应用详情页。

diff --git a/zh-CN/plugins/adapter/line.md b/zh-CN/plugins/adapter/line.md
@@ -1,5 +1,9 @@
 # @koishijs/plugin-adapter-line
 
+::: warning
+在接入之前，你需要准备一个带有 SSL 证书的公网域名，并将 Koishi [部署到公网](../../manual/recipe/server.md)。
+:::
+
 ## 接入方法
 
 1. 在 [LINE 开发者控制台](https://developers.line.biz/console/) 注册账号，创建一个新的 Provider，在 Provider 中创建一个 Channel，类型选择 Messaging API，输入相关信息

diff --git a/zh-CN/plugins/adapter/matrix.md b/zh-CN/plugins/adapter/matrix.md
@@ -1,5 +1,9 @@
 # @koishijs/plugin-adapter-matrix
 
+::: warning
+在接入之前，你需要准备一个带有 SSL 证书的公网域名，并将 Koishi [部署到公网](../../manual/recipe/server.md)。
+:::
+
 ## 接入方式
 
 1. 参考 [此链接](https://spec.matrix.org/unstable/application-service-api/#registration) 编写 `registry.yaml` 文件：

diff --git a/zh-CN/plugins/adapter/qq.md b/zh-CN/plugins/adapter/qq.md
@@ -1,6 +1,10 @@
 # @koishijs/plugin-adapter-qq
 
-QQ (官方机器人) 适配器。
+::: tip
+目前 QQ 群官方 API 尚未支持发送本地图片，但 Koishi 对此类需求做了处理。建议同时安装 [@koishijs/plugin-server-temp](../develop/server-temp.md) 插件，并将 Koishi [部署到公网](../../manual/recipe/server.md)。
+:::
+
+QQ 和 QQ 频道官方机器人适配器。
 
 ## 接入方法
 

diff --git a/zh-CN/plugins/adapter/slack.md b/zh-CN/plugins/adapter/slack.md
@@ -1,5 +1,9 @@
 # @koishijs/plugin-adapter-slack
 
+::: tip
+如果选择通信方式为 `http`，那么你需要准备一个带有 SSL 证书的公网域名，并将 Koishi [部署到公网](../../manual/recipe/server.md)。
+:::
+
 ## 接入方式
 
 Slack 适配器提供了两种接入方式：`http` 和 `ws` (推荐)。其中，`http` 连接方式需要一个公网可访问的地址。在接入之前，请根据使用需求填写插件的 [`protocol`](#config-protocol) 字段。

diff --git a/zh-CN/plugins/adapter/telegram.md b/zh-CN/plugins/adapter/telegram.md
@@ -1,5 +1,9 @@
 # @koishijs/plugin-adapter-telegram
 
+::: tip
+如果选择通信方式为 `http`，那么你需要准备一个带有 SSL 证书的公网域名，并将 Koishi [部署到公网](../../manual/recipe/server.md)。
+:::
+
 ## 接入方法
 
 1. 搜索 @botfather（有个官方认证的符号）并进入聊天界面

diff --git a/zh-CN/plugins/adapter/wechat-official.md b/zh-CN/plugins/adapter/wechat-official.md
@@ -1,5 +1,9 @@
 # @koishijs/plugin-adapter-wechat-official
 
+::: warning
+在接入之前，你需要准备一个带有 SSL 证书的公网域名，并将 Koishi [部署到公网](../../manual/recipe/server.md)。
+:::
+
 ## 接入方法
 
 1. 根据 [注册流程指引](https://kf.qq.com/product/weixinmp.html#hid=87) 注册公众平台。

diff --git a/zh-CN/plugins/adapter/wecom.md b/zh-CN/plugins/adapter/wecom.md
@@ -1,5 +1,9 @@
 # @koishijs/plugin-adapter-wecom
 
+::: warning
+在接入之前，你需要准备一个带有 SSL 证书的公网域名，并将 Koishi [部署到公网](../../manual/recipe/server.md)。
+:::
+
 ## 接入方法
 
 1. 前往 [我的企业](https://work.weixin.qq.com/wework_admin/frame#profile)，复制页面下方企业 ID，填入插件的 corpId。

diff --git a/zh-CN/plugins/adapter/whatsapp.md b/zh-CN/plugins/adapter/whatsapp.md
@@ -1,5 +1,9 @@
 # @koishijs/plugin-adapter-whatsapp
 
+::: warning
+在接入之前，你需要准备一个带有 SSL 证书的公网域名，并将 Koishi [部署到公网](../../manual/recipe/server.md)。
+:::
+
 ## 接入方式
 
 1. 前往 [商务平台](https://business.facebook.com/) 创建业务账户，并在 [业务设置](https://business.facebook.com/settings/security) 完成组织验证

diff --git a/zh-CN/plugins/develop/server-temp.md b/zh-CN/plugins/develop/server-temp.md
@@ -1,5 +1,9 @@
 # @koishijs/plugin-server-temp
 
+::: warning
+使用此插件需要你将 Koishi [部署到公网](../../manual/recipe/server.md) (通常你还需要准备一个公网域名)。
+:::
+
 @koishijs/plugin-server-temp 实现了一个临时文件服务。
 
 ## 配置项
@@ -11,6 +15,13 @@
 
 服务器监听的路径。
 
+### config.selfUrl
+
+- 类型: `string`
+- 默认值: [`ctx.server.config.selfUrl`](./server.md#config-selfurl)
+
+服务暴露在公网的地址。
+
 ### config.maxAge
 
 - 类型: `number`