Matrix（插件）

Matrix 是一个开放的去中心化消息协议。OpenClaw 作为 Matrix 用户连接到任何主服务器，因此您需要为机器人创建一个 Matrix 账户。登录后，您可以直接向机器人发送私信或邀请它加入房间（Matrix "群组"）。Beeper 也是一个有效的客户端选项，但它需要启用 E2EE。

状态：通过插件支持（@vector-im/matrix-bot-sdk）。支持私信、房间、主题串、媒体、表情回应、投票（发送 + poll-start 作为文本）、位置和 E2EE（具有加密支持）。

需要插件

Matrix 作为插件提供，不包含在核心安装中。

通过 CLI 安装（npm 注册表）：

openclaw plugins install @openclaw/matrix

本地检出（从 git 仓库运行时）：

openclaw plugins install ./extensions/matrix

如果您在配置/初始化期间选择 Matrix 并检测到 git 检出，OpenClaw 将自动提供本地安装路径。

详情：插件

设置

1. 安装 Matrix 插件：

   • 从 npm：openclaw plugins install @openclaw/matrix
   • 从本地检出：openclaw plugins install ./extensions/matrix

2. 在主服务器上创建 Matrix 账户：

   • 在 https://matrix.org/ecosystem/hosting/ 浏览托管选项
   • 或自行托管。

3. 获取机器人账户的访问令牌：

   • 在您的主服务器上使用 curl 调用 Matrix 登录 API：

   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：OpenClaw 调用相同的登录端点，将访问令牌存储在 ~/.openclaw/credentials/matrix/credentials.json 中，并在下次启动时重用。

4. 配置凭证：

   • 环境变量：MATRIX_HOMESERVER、MATRIX_ACCESS_TOKEN（或 MATRIX_USER_ID + MATRIX_PASSWORD）
   • 或配置：channels.matrix.*
   • 如果两者都设置，配置优先。
   • 使用访问令牌时：通过 /whoami 自动获取用户 ID。
   • 设置时，channels.matrix.userId 应为完整的 Matrix ID（例如：@bot:example.org）。

5. 重启网关（或完成初始化）。

6. 从任何 Matrix 客户端（Element、Beeper 等；参见 https://matrix.org/ecosystem/clients/）与机器人开始私信或邀请它加入房间。Beeper 需要 E2EE，因此请设置 channels.matrix.encryption: true 并验证设备。

最小配置（访问令牌，自动获取用户 ID）：

{
  channels: {
    matrix: {
      enabled: true,
      homeserver: "https://matrix.example.org",
      accessToken: "syt_***",
      dm: { policy: "pairing" },
    },
  },
}

E2EE 配置（启用端到端加密）：

{
  channels: {
    matrix: {
      enabled: true,
      homeserver: "https://matrix.example.org",
      accessToken: "syt_***",
      encryption: true,
      dm: { policy: "pairing" },
    },
  },
}

加密（E2EE）

通过 Rust 加密 SDK 支持端到端加密。

使用 channels.matrix.encryption: true 启用：

• 如果加密模块加载成功，加密房间会自动解密。
• 发送到加密房间时，出站媒体会被加密。
• 首次连接时，OpenClaw 会从您的其他会话请求设备验证。
• 在另一个 Matrix 客户端（Element 等）中验证设备以启用密钥共享。
• 如果无法加载加密模块，E2EE 将被禁用，加密房间无法解密；OpenClaw 会记录警告。
• 如果您看到缺少加密模块的错误（例如 @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 获取二进制文件。

加密状态按账户 + 访问令牌存储在 ~/.openclaw/matrix/accounts/<account>/<homeserver>__<user>/<token-hash>/crypto/（SQLite 数据库）中。同步状态存储在其旁边的 bot-storage.json 中。如果访问令牌（设备）更改，会创建新的存储，机器人必须为加密房间重新验证。

设备验证： 启用 E2EE 时，机器人会在启动时从您的其他会话请求验证。打开 Element（或其他客户端）并批准验证请求以建立信任。验证后，机器人可以解密加密房间中的消息。

路由模型

• 回复始终返回到 Matrix。
• 私信共享代理的主会话；房间映射到群组会话。

访问控制（私信）

• 默认：channels.matrix.dm.policy = "pairing"。未知发送者会获得配对码。
• 通过以下方式批准：
  • openclaw pairing list matrix
  • openclaw 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）：

{
  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、别名或名称），仅在精确唯一匹配时解析名称。
• 启动时，OpenClaw 将白名单中的房间/用户名称解析为 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	✅ 支持（需要加密模块）
表情回应	✅ 支持（通过工具发送/读取）
投票	✅ 支持发送；入站 poll starts 转换为文本（忽略响应/结束）
位置	✅ 支持（geo URI；忽略海拔）
原生命令	✅ 支持

配置参考（Matrix）

完整配置：配置

提供商选项：

• 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）。