vora-ai 0.1.0

package/docs/zh-CN/channels/index.md

@@ -0,0 +1,53 @@
+---
+read_when:
+  - 你想为 Vora 选择一个聊天渠道
+  - 你需要快速了解支持的消息平台
+summary: Vora 可连接的消息平台
+title: 聊天渠道
+x-i18n:
+  generated_at: "2026-02-03T07:43:27Z"
+  model: claude-opus-4-5
+  provider: pi
+  source_hash: 2632863def6dee97e0fa8b931762f0969174fd4fb22303a00dcd46527fe4a141
+  source_path: channels/index.md
+  workflow: 15
+---
+
+# 聊天渠道
+
+Vora 可以在你已经使用的任何聊天应用上与你交流。每个渠道通过 Gateway 网关连接。
+所有渠道都支持文本；媒体和表情回应的支持因渠道而异。
+
+## 支持的渠道
+
+- [BlueBubbles](/channels/bluebubbles) — **推荐用于 iMessage**；使用 BlueBubbles macOS 服务器 REST API，功能完整（编辑、撤回、特效、回应、群组管理——编辑功能在 macOS 26 Tahoe 上目前不可用）。
+- [Discord](/channels/discord) — Discord Bot API + Gateway；支持服务器、频道和私信。
+- [飞书](/channels/feishu) — 飞书（Lark）机器人（插件，需单独安装）。
+- [Google Chat](/channels/googlechat) — 通过 HTTP webhook 的 Google Chat API 应用。
+- [iMessage（旧版）](/channels/imessage) — 通过 imsg CLI 的旧版 macOS 集成（已弃用，新设置请使用 BlueBubbles）。
+- [LINE](/channels/line) — LINE Messaging API 机器人（插件，需单独安装）。
+- [Matrix](/channels/matrix) — Matrix 协议（插件，需单独安装）。
+- [Mattermost](/channels/mattermost) — Bot API + WebSocket；频道、群组、私信（插件，需单独安装）。
+- [Microsoft Teams](/channels/msteams) — Bot Framework；企业支持（插件，需单独安装）。
+- [Nextcloud Talk](/channels/nextcloud-talk) — 通过 Nextcloud Talk 的自托管聊天（插件，需单独安装）。
+- [Nostr](/channels/nostr) — 通过 NIP-04 的去中心化私信（插件，需单独安装）。
+- [Signal](/channels/signal) — signal-cli；注重隐私。
+- [Slack](/channels/slack) — Bolt SDK；工作区应用。
+- [Telegram](/channels/telegram) — 通过 grammY 使用 Bot API；支持群组。
+- [Tlon](/channels/tlon) — 基于 Urbit 的消息应用（插件，需单独安装）。
+- [Twitch](/channels/twitch) — 通过 IRC 连接的 Twitch 聊天（插件，需单独安装）。
+- [WebChat](/web/webchat) — 基于 WebSocket 的 Gateway 网关 WebChat 界面。
+- [WhatsApp](/channels/whatsapp) — 最受欢迎；使用 Baileys，需要二维码配对。
+- [Zalo](/channels/zalo) — Zalo Bot API；越南流行的消息应用（插件，需单独安装）。
+- [Zalo Personal](/channels/zalouser) — 通过二维码登录的 Zalo 个人账号（插件，需单独安装）。
+
+## 注意事项
+
+- 渠道可以同时运行；配置多个渠道后，Vora 会按聊天进行路由。
+- 最快的设置方式通常是 **Telegram**（简单的机器人令牌）。WhatsApp 需要二维码配对，
+  并在磁盘上存储更多状态。
+- 群组行为因渠道而异；参见[群组](/channels/groups)。
+- 为安全起见，私信配对和允许列表会被强制执行；参见[安全](/gateway/security)。
+- Telegram 内部机制：[grammY 说明](/channels/grammy)。
+- 故障排除：[渠道故障排除](/channels/troubleshooting)。
+- 模型提供商单独记录；参见[模型提供商](/providers/models)。

package/docs/zh-CN/channels/line.md

@@ -0,0 +1,180 @@
+---
+read_when:
+  - 你想将 Vora 连接到 LINE
+  - 你需要配置 LINE webhook + 凭证
+  - 你想了解 LINE 特有的消息选项
+summary: LINE Messaging API 插件的配置、设置和使用方法
+title: LINE
+x-i18n:
+  generated_at: "2026-02-03T07:43:38Z"
+  model: claude-opus-4-5
+  provider: pi
+  source_hash: 8fbac126786f95b9454f3cc61906c2798393a8d7914e787d3755c020c7ab2da6
+  source_path: channels/line.md
+  workflow: 15
+---
+
+# LINE（插件）
+
+LINE 通过 LINE Messaging API 连接到 Vora。该插件作为 webhook 接收器在 Gateway 网关上运行，使用你的 channel access token + channel secret 进行身份验证。
+
+状态：通过插件支持。支持私信、群聊、媒体、位置、Flex 消息、模板消息和快捷回复。不支持表情回应和话题回复。
+
+## 需要安装插件
+
+安装 LINE 插件：
+
+```bash
+vora plugins install @vora/line
+```
+
+本地检出（从 git 仓库运行时）：
+
+```bash
+vora plugins install ./extensions/line
+```
+
+## 配置步骤
+
+1. 创建 LINE Developers 账户并打开控制台：
+   https://developers.line.biz/console/
+2. 创建（或选择）一个 Provider 并添加 **Messaging API** 渠道。
+3. 从渠道设置中复制 **Channel access token** 和 **Channel secret**。
+4. 在 Messaging API 设置中启用 **Use webhook**。
+5. 将 webhook URL 设置为你的 Gateway 网关端点（必须使用 HTTPS）：
+
+```
+https://gateway-host/line/webhook
+```
+
+Gateway 网关会响应 LINE 的 webhook 验证（GET）和入站事件（POST）。如果你需要自定义路径，请设置 `channels.line.webhookPath` 或 `channels.line.accounts.<id>.webhookPath` 并相应更新 URL。
+
+## 配置
+
+最小配置：
+
+```json5
+{
+  channels: {
+    line: {
+      enabled: true,
+      channelAccessToken: "LINE_CHANNEL_ACCESS_TOKEN",
+      channelSecret: "LINE_CHANNEL_SECRET",
+      dmPolicy: "pairing",
+    },
+  },
+}
+```
+
+环境变量（仅限默认账户）：
+
+- `LINE_CHANNEL_ACCESS_TOKEN`
+- `LINE_CHANNEL_SECRET`
+
+Token/secret 文件：
+
+```json5
+{
+  channels: {
+    line: {
+      tokenFile: "/path/to/line-token.txt",
+      secretFile: "/path/to/line-secret.txt",
+    },
+  },
+}
+```
+
+多账户配置：
+
+```json5
+{
+  channels: {
+    line: {
+      accounts: {
+        marketing: {
+          channelAccessToken: "...",
+          channelSecret: "...",
+          webhookPath: "/line/marketing",
+        },
+      },
+    },
+  },
+}
+```
+
+## 访问控制
+
+私信默认使用配对模式。未知发送者会收到配对码，其消息在获得批准前会被忽略。
+
+```bash
+vora pairing list line
+vora pairing approve line <CODE>
+```
+
+允许列表和策略：
+
+- `channels.line.dmPolicy`：`pairing | allowlist | open | disabled`
+- `channels.line.allowFrom`：私信的允许列表 LINE 用户 ID
+- `channels.line.groupPolicy`：`allowlist | open | disabled`
+- `channels.line.groupAllowFrom`：群组的允许列表 LINE 用户 ID
+- 单群组覆盖：`channels.line.groups.<groupId>.allowFrom`
+
+LINE ID 区分大小写。有效 ID 格式如下：
+
+- 用户：`U` + 32 位十六进制字符
+- 群组：`C` + 32 位十六进制字符
+- 房间：`R` + 32 位十六进制字符
+
+## 消息行为
+
+- 文本按 5000 字符分块。
+- Markdown 格式会被移除；代码块和表格会尽可能转换为 Flex 卡片。
+- 流式响应会被缓冲；智能体处理时，LINE 会收到完整分块并显示加载动画。
+- 媒体下载受 `channels.line.mediaMaxMb` 限制（默认 10）。
+
+## 渠道数据（富消息）
+
+使用 `channelData.line` 发送快捷回复、位置、Flex 卡片或模板消息。
+
+```json5
+{
+  text: "Here you go",
+  channelData: {
+    line: {
+      quickReplies: ["Status", "Help"],
+      location: {
+        title: "Office",
+        address: "123 Main St",
+        latitude: 35.681236,
+        longitude: 139.767125,
+      },
+      flexMessage: {
+        altText: "Status card",
+        contents: {
+          /* Flex payload */
+        },
+      },
+      templateMessage: {
+        type: "confirm",
+        text: "Proceed?",
+        confirmLabel: "Yes",
+        confirmData: "yes",
+        cancelLabel: "No",
+        cancelData: "no",
+      },
+    },
+  },
+}
+```
+
+LINE 插件还提供 `/card` 命令用于 Flex 消息预设：
+
+```
+/card info "Welcome" "Thanks for joining!"
+```
+
+## 故障排除
+
+- **Webhook 验证失败：** 确保 webhook URL 使用 HTTPS 且 `channelSecret` 与 LINE 控制台中的一致。
+- **没有入站事件：** 确认 webhook 路径与 `channels.line.webhookPath` 匹配，且 Gateway 网关可从 LINE 访问。
+- **媒体下载错误：** 如果媒体超过默认限制，请提高 `channels.line.mediaMaxMb`。

package/docs/zh-CN/channels/location.md

@@ -0,0 +1,63 @@
+---
+read_when:
+  - 添加或修改渠道位置解析
+  - 在智能体提示或工具中使用位置上下文字段
+summary: 入站渠道位置解析（Telegram + WhatsApp）及上下文字段
+title: 渠道位置解析
+x-i18n:
+  generated_at: "2026-02-01T19:21:46Z"
+  model: claude-opus-4-5
+  provider: pi
+  source_hash: 5602ef105c3da7e47497bfed8fc343dd8d7f3c019ff7e423a08b25092c5a1837
+  source_path: channels/location.md
+  workflow: 14
+---
+
+# 渠道位置解析
+
+Vora 将聊天渠道中分享的位置标准化为：
+
+- 附加到入站消息体的可读文本，以及
+- 自动回复上下文负载中的结构化字段。
+
+目前支持：
+
+- **Telegram**（位置图钉 + 地点 + 实时位置）
+- **WhatsApp**（locationMessage + liveLocationMessage）
+- **Matrix**（`m.location` 配合 `geo_uri`）
+
+## 文本格式
+
+位置以友好的行格式呈现，不带括号：
+
+- 图钉：
+  - `📍 48.858844, 2.294351 ±12m`
+- 命名地点：
+  - `📍 Eiffel Tower — Champ de Mars, Paris (48.858844, 2.294351 ±12m)`
+- 实时分享：
+  - `🛰 Live location: 48.858844, 2.294351 ±12m`
+
+如果渠道包含标题/评论，会附加在下一行：
+
+```
+📍 48.858844, 2.294351 ±12m
+Meet here
+```
+
+## 上下文字段
+
+当存在位置信息时，以下字段会被添加到 `ctx` 中：
+
+- `LocationLat`（数字）
+- `LocationLon`（数字）
+- `LocationAccuracy`（数字，米；可选）
+- `LocationName`（字符串；可选）
+- `LocationAddress`（字符串；可选）
+- `LocationSource`（`pin | place | live`）
+- `LocationIsLive`（布尔值）
+
+## 渠道说明
+
+- **Telegram**：地点映射到 `LocationName/LocationAddress`；实时位置使用 `live_period`。
+- **WhatsApp**：`locationMessage.comment` 和 `liveLocationMessage.caption` 作为标题行附加。
+- **Matrix**：`geo_uri` 解析为图钉位置；忽略海拔高度，`LocationIsLive` 始终为 false。

package/docs/zh-CN/channels/matrix.md

@@ -0,0 +1,221 @@
+---
+read_when:
+  - 开发 Matrix 渠道功能
+summary: Matrix 支持状态、功能和配置
+title: Matrix
+x-i18n:
+  generated_at: "2026-02-03T07:44:02Z"
+  model: claude-opus-4-5
+  provider: pi
+  source_hash: b276b5263593c766e7be6549abbb27927177e7b51cfd297b4825965372513ee4
+  source_path: channels/matrix.md
+  workflow: 15
+---
+
+# Matrix（插件）
+
+Matrix 是一个开放的去中心化消息协议。Vora 以 Matrix **用户**身份连接到任意主服务器，因此你需要为机器人创建一个 Matrix 账户。登录后，你可以直接私信机器人或邀请它加入房间（Matrix"群组"）。Beeper 也是一个有效的客户端选项，但它需要启用 E2EE。
+
+状态：通过插件（@vector-im/matrix-bot-sdk）支持。支持私信、房间、话题、媒体、表情回应、投票（发送 + poll-start 作为文本）、位置和 E2EE（需要加密支持）。
+
+## 需要插件
+
+Matrix 作为插件提供，不包含在核心安装中。
+
+通过 CLI 安装（npm 仓库）：
+
+```bash
+vora plugins install @vora/matrix
+```
+
+本地检出（从 git 仓库运行时）：
+
+```bash
+vora plugins install ./extensions/matrix
+```
+
+如果你在配置/新手引导期间选择 Matrix 并检测到 git 检出，Vora 将自动提供本地安装路径。
+
+详情：[插件](/tools/plugin)
+
+## 设置
+
+1. 安装 Matrix 插件：
+   - 从 npm：`vora plugins install @vora/matrix`
+   - 从本地检出：`vora plugins install ./extensions/matrix`
+2. 在主服务器上创建 Matrix 账户：
+   - 在 [https://matrix.org/ecosystem/hosting/](https://matrix.org/ecosystem/hosting/) 浏览托管选项
+   - 或自行托管。
+3. 获取机器人账户的访问令牌：
+   - 在你的主服务器上使用 `curl` 调用 Matrix 登录 API：
+
+   ```bash
+   curl --request POST \
+     --url https://matrix.example.org/_matrix/client/v3/login \
+     --header 'Content-Type: application/json' \
+     --data '{
+     "type": "m.login.password",
+     "identifier": {
+       "type": "m.id.user",
+       "user": "your-user-name"
+     },
+     "password": "your-password"
+   }'
+   ```
+
+   - 将 `matrix.example.org` 替换为你的主服务器 URL。
+   - 或设置 `channels.matrix.userId` + `channels.matrix.password`：Vora 会调用相同的登录端点，将访问令牌存储在 `~/.vora/credentials/matrix/credentials.json`，并在下次启动时重用。
+
+4. 配置凭证：
+   - 环境变量：`MATRIX_HOMESERVER`、`MATRIX_ACCESS_TOKEN`（或 `MATRIX_USER_ID` + `MATRIX_PASSWORD`）
+   - 或配置：`channels.matrix.*`
+   - 如果两者都设置，配置优先。
+   - 使用访问令牌时：用户 ID 通过 `/whoami` 自动获取。
+   - 设置时，`channels.matrix.userId` 应为完整的 Matrix ID（示例：`@bot:example.org`）。
+5. 重启 Gateway 网关（或完成新手引导）。
+6. 从任何 Matrix 客户端（Element、Beeper 等；参见 https://matrix.org/ecosystem/clients/）与机器人开始私信或邀请它加入房间。Beeper 需要 E2EE，因此请设置 `channels.matrix.encryption: true` 并验证设备。
+
+最小配置（访问令牌，用户 ID 自动获取）：
+
+```json5
+{
+  channels: {
+    matrix: {
+      enabled: true,
+      homeserver: "https://matrix.example.org",
+      accessToken: "syt_***",
+      dm: { policy: "pairing" },
+    },
+  },
+}
+```
+
+E2EE 配置（启用端到端加密）：
+
+```json5
+{
+  channels: {
+    matrix: {
+      enabled: true,
+      homeserver: "https://matrix.example.org",
+      accessToken: "syt_***",
+      encryption: true,
+      dm: { policy: "pairing" },
+    },
+  },
+}
+```
+
+## 加密（E2EE）
+
+通过 Rust 加密 SDK **支持**端到端加密。
+
+使用 `channels.matrix.encryption: true` 启用：
+
+- 如果加密模块加载成功，加密房间会自动解密。
+- 发送到加密房间时，出站媒体会被加密。
+- 首次连接时，Vora 会向你的其他会话请求设备验证。
+- 在另一个 Matrix 客户端（Element 等）中验证设备以启用密钥共享。
+- 如果无法加载加密模块，E2EE 将被禁用，加密房间将无法解密；Vora 会记录警告。
+- 如果你看到缺少加密模块的错误（例如 `@matrix-org/matrix-sdk-crypto-nodejs-*`），请允许 `@matrix-org/matrix-sdk-crypto-nodejs` 的构建脚本并运行 `pnpm rebuild @matrix-org/matrix-sdk-crypto-nodejs`，或使用 `node node_modules/@matrix-org/matrix-sdk-crypto-nodejs/download-lib.js` 获取二进制文件。
+
+加密状态按账户 + 访问令牌存储在 `~/.vora/matrix/accounts/<account>/<homeserver>__<user>/<token-hash>/crypto/`（SQLite 数据库）。同步状态存储在同目录的 `bot-storage.json` 中。如果访问令牌（设备）更改，将创建新的存储，机器人必须重新验证才能访问加密房间。
+
+**设备验证：**
+启用 E2EE 时，机器人将在启动时向你的其他会话请求验证。打开 Element（或其他客户端）并批准验证请求以建立信任。验证后，机器人可以解密加密房间中的消息。
+
+## 路由模型
+
+- 回复始终返回到 Matrix。
+- 私信共享智能体的主会话；房间映射到群组会话。
+
+## 访问控制（私信）
+
+- 默认：`channels.matrix.dm.policy = "pairing"`。未知发送者会收到配对码。
+- 通过以下方式批准：
+  - `vora pairing list matrix`
+  - `vora pairing approve matrix <CODE>`
+- 公开私信：`channels.matrix.dm.policy="open"` 加上 `channels.matrix.dm.allowFrom=["*"]`。
+- `channels.matrix.dm.allowFrom` 仅接受完整 Matrix 用户 ID（例如 `@user:server`）。向导仅在目录搜索得到唯一精确匹配时将显示名称解析为用户 ID。
+
+## 房间（群组）
+
+- 默认：`channels.matrix.groupPolicy = "allowlist"`（提及门控）。使用 `channels.defaults.groupPolicy` 在未设置时覆盖默认值。
+- 使用 `channels.matrix.groups` 配置房间允许列表（房间 ID 或别名；名称仅在目录搜索得到唯一精确匹配时解析为 ID）：
+
+```json5
+{
+  channels: {
+    matrix: {
+      groupPolicy: "allowlist",
+      groups: {
+        "!roomId:example.org": { allow: true },
+        "#alias:example.org": { allow: true },
+      },
+      groupAllowFrom: ["@owner:example.org"],
+    },
+  },
+}
+```
+
+- `requireMention: false` 启用该房间的自动回复。
+- `groups."*"` 可以设置跨房间的提及门控默认值。
+- `groupAllowFrom` 限制哪些发送者可以在房间中触发机器人（需完整 Matrix 用户 ID）。
+- 每个房间的 `users` 允许列表可以进一步限制特定房间内的发送者（需完整 Matrix 用户 ID）。
+- 配置向导会提示输入房间允许列表（房间 ID、别名或名称），仅在精确且唯一匹配时解析名称。
+- 启动时，Vora 将允许列表中的房间/用户名称解析为 ID 并记录映射；未解析的条目不会参与允许列表匹配。
+- 默认自动加入邀请；使用 `channels.matrix.autoJoin` 和 `channels.matrix.autoJoinAllowlist` 控制。
+- 要**禁止所有房间**，设置 `channels.matrix.groupPolicy: "disabled"`（或保持空的允许列表）。
+- 旧版键名：`channels.matrix.rooms`（与 `groups` 相同的结构）。
+
+## 话题
+
+- 支持回复话题。
+- `channels.matrix.threadReplies` 控制回复是否保持在话题中：
+  - `off`、`inbound`（默认）、`always`
+- `channels.matrix.replyToMode` 控制不在话题中回复时的 reply-to 元数据：
+  - `off`（默认）、`first`、`all`
+
+## 功能
+
+| 功能     | 状态                                                   |
+| -------- | ------------------------------------------------------ |
+| 私信     | ✅ 支持                                                |
+| 房间     | ✅ 支持                                                |
+| 话题     | ✅ 支持                                                |
+| 媒体     | ✅ 支持                                                |
+| E2EE     | ✅ 支持（需要加密模块）                                |
+| 表情回应 | ✅ 支持（通过工具发送/读取）                           |
+| 投票     | ✅ 支持发送；入站投票开始转换为文本（响应/结束被忽略） |
+| 位置     | ✅ 支持（geo URI；忽略海拔）                           |
+| 原生命令 | ✅ 支持                                                |
+
+## 配置参考（Matrix）
+
+完整配置：[配置](/gateway/configuration)
+
+提供商选项：
+
+- `channels.matrix.enabled`：启用/禁用渠道启动。
+- `channels.matrix.homeserver`：主服务器 URL。
+- `channels.matrix.userId`：Matrix 用户 ID（使用访问令牌时可选）。
+- `channels.matrix.accessToken`：访问令牌。
+- `channels.matrix.password`：登录密码（令牌会被存储）。
+- `channels.matrix.deviceName`：设备显示名称。
+- `channels.matrix.encryption`：启用 E2EE（默认：false）。
+- `channels.matrix.initialSyncLimit`：初始同步限制。
+- `channels.matrix.threadReplies`：`off | inbound | always`（默认：inbound）。
+- `channels.matrix.textChunkLimit`：出站文本分块大小（字符）。
+- `channels.matrix.chunkMode`：`length`（默认）或 `newline` 在长度分块前按空行（段落边界）分割。
+- `channels.matrix.dm.policy`：`pairing | allowlist | open | disabled`（默认：pairing）。
+- `channels.matrix.dm.allowFrom`：私信允许列表（需完整 Matrix 用户 ID）。`open` 需要 `"*"`。向导在可能时将名称解析为 ID。
+- `channels.matrix.groupPolicy`：`allowlist | open | disabled`（默认：allowlist）。
+- `channels.matrix.groupAllowFrom`：群组消息的允许发送者列表（需完整 Matrix 用户 ID）。
+- `channels.matrix.allowlistOnly`：强制私信 + 房间使用允许列表规则。
+- `channels.matrix.groups`：群组允许列表 + 每个房间的设置映射。
+- `channels.matrix.rooms`：旧版群组允许列表/配置。
+- `channels.matrix.replyToMode`：话题/标签的 reply-to 模式。
+- `channels.matrix.mediaMaxMb`：入站/出站媒体上限（MB）。
+- `channels.matrix.autoJoin`：邀请处理（`always | allowlist | off`，默认：always）。
+- `channels.matrix.autoJoinAllowlist`：自动加入的允许房间 ID/别名。
+- `channels.matrix.actions`：每个操作的工具限制（reactions/messages/pins/memberInfo/channelInfo）。

package/docs/zh-CN/channels/mattermost.md

@@ -0,0 +1,144 @@
+---
+read_when:
+  - 设置 Mattermost
+  - 调试 Mattermost 路由
+summary: Mattermost 机器人设置和 Vora 配置
+title: Mattermost
+x-i18n:
+  generated_at: "2026-02-03T07:43:43Z"
+  model: claude-opus-4-5
+  provider: pi
+  source_hash: 57fabe5eb0efbcb885f4178b317b2fa99a41daf609e3a471de2b44db9def4ad7
+  source_path: channels/mattermost.md
+  workflow: 15
+---
+
+# Mattermost（插件）
+
+状态：通过插件支持（bot token + WebSocket 事件）。支持频道、群组和私信。
+Mattermost 是一个可自托管的团队消息平台；有关产品详情和下载，请访问官方网站
+[mattermost.com](https://mattermost.com)。
+
+## 需要插件
+
+Mattermost 以插件形式提供，不包含在核心安装中。
+
+通过 CLI 安装（npm 注册表）：
+
+```bash
+vora plugins install @vora/mattermost
+```
+
+本地检出（从 git 仓库运行时）：
+
+```bash
+vora plugins install ./extensions/mattermost
+```
+
+如果你在配置/新手引导期间选择 Mattermost 并检测到 git 检出，Vora 会自动提供本地安装路径。
+
+详情：[插件](/tools/plugin)
+
+## 快速设置
+
+1. 安装 Mattermost 插件。
+2. 创建 Mattermost bot 账户并复制 **bot token**。
+3. 复制 Mattermost **基础 URL**（例如 `https://chat.example.com`）。
+4. 配置 Vora 并启动 Gateway 网关。
+
+最小配置：
+
+```json5
+{
+  channels: {
+    mattermost: {
+      enabled: true,
+      botToken: "mm-token",
+      baseUrl: "https://chat.example.com",
+      dmPolicy: "pairing",
+    },
+  },
+}
+```
+
+## 环境变量（默认账户）
+
+如果你偏好使用环境变量，请在 Gateway 网关主机上设置：
+
+- `MATTERMOST_BOT_TOKEN=...`
+- `MATTERMOST_URL=https://chat.example.com`
+
+环境变量仅适用于**默认**账户（`default`）。其他账户必须使用配置值。
+
+## 聊天模式
+
+Mattermost 自动响应私信。频道行为由 `chatmode` 控制：
+
+- `oncall`（默认）：仅在频道中被 @提及时响应。
+- `onmessage`：响应每条频道消息。
+- `onchar`：当消息以触发前缀开头时响应。
+
+配置示例：
+
+```json5
+{
+  channels: {
+    mattermost: {
+      chatmode: "onchar",
+      oncharPrefixes: [">", "!"],
+    },
+  },
+}
+```
+
+注意事项：
+
+- `onchar` 仍会响应显式 @提及。
+- `channels.mattermost.requireMention` 对旧配置仍然有效，但推荐使用 `chatmode`。
+
+## 访问控制（私信）
+
+- 默认：`channels.mattermost.dmPolicy = "pairing"`（未知发送者会收到配对码）。
+- 通过以下方式批准：
+  - `vora pairing list mattermost`
+  - `vora pairing approve mattermost <CODE>`
+- 公开私信：`channels.mattermost.dmPolicy="open"` 加上 `channels.mattermost.allowFrom=["*"]`。
+
+## 频道（群组）
+
+- 默认：`channels.mattermost.groupPolicy = "allowlist"`（提及限制）。
+- 使用 `channels.mattermost.groupAllowFrom` 将发送者加入允许列表（用户 ID 或 `@username`）。
+- 开放频道：`channels.mattermost.groupPolicy="open"`（提及限制）。
+
+## 出站投递目标
+
+在 `vora message send` 或 cron/webhooks 中使用这些目标格式：
+
+- `channel:<id>` 用于频道
+- `user:<id>` 用于私信
+- `@username` 用于私信（通过 Mattermost API 解析）
+
+裸 ID 被视为频道。
+
+## 多账户
+
+Mattermost 支持在 `channels.mattermost.accounts` 下配置多个账户：
+
+```json5
+{
+  channels: {
+    mattermost: {
+      accounts: {
+        default: { name: "Primary", botToken: "mm-token", baseUrl: "https://chat.example.com" },
+        alerts: { name: "Alerts", botToken: "mm-token-2", baseUrl: "https://alerts.example.com" },
+      },
+    },
+  },
+}
+```
+
+## 故障排除
+
+- 频道中无回复：确保 bot 在频道中并提及它（oncall），使用触发前缀（onchar），或设置 `chatmode: "onmessage"`。
+- 认证错误：检查 bot token、基础 URL 以及账户是否已启用。
+- 多账户问题：环境变量仅适用于 `default` 账户。