Mattermost bot setup and OpenClaw config

Read when…
  • Setting up Mattermost
  • Debugging Mattermost routing

Mattermost (plugin)

状态:通过插件支持(bot token + WebSocket 事件)。支持频道、群组和个人消息。 Mattermost 是一个可自托管的团队消息平台;有关产品详细信息和下载,请访问 mattermost.com

需要插件

Mattermost 作为插件提供,并不包含在核心安装中。

通过 CLI 安装(npm 仓库):

openclaw plugins install @openclaw/mattermost

本地检出(从 git 仓库运行时):

openclaw plugins install ./extensions/mattermost

如果您在配置/入职过程中选择了 Mattermost 并检测到 git 检出, OpenClaw 将自动提供本地安装路径。

详情:Plugins

快速设置

  1. 安装 Mattermost 插件。
  2. 创建一个 Mattermost 机器人账户并复制 bot token
  3. 复制 Mattermost base URL(例如,https://chat.example.com)。
  4. 配置 OpenClaw 并启动网关。

最小配置:

{
  channels: {
    mattermost: {
      enabled: true,
      botToken: "mm-token",
      baseUrl: "https://chat.example.com",
      dmPolicy: "pairing",
    },
  },
}

环境变量(默认账户)

如果您更喜欢使用环境变量,请在网关主机上设置这些变量:

  • MATTERMOST_BOT_TOKEN=...
  • MATTERMOST_URL=https://chat.example.com

环境变量仅适用于 默认 账户 (default)。其他账户必须使用配置值。

聊天模式

Mattermost 会自动回复个人消息。频道行为由 chatmode 控制:

  • oncall(默认):仅在频道中被 @ 提及时回复。
  • onmessage:回复每个频道消息。
  • onchar:当消息以触发前缀开头时回复。

配置示例:

{
  channels: {
    mattermost: {
      chatmode: "onchar",
      oncharPrefixes: [">", "!"],
    },
  },
}

注意:

  • onchar 仍然会响应显式 @ 提及。
  • channels.mattermost.requireMention 在旧配置中被尊重,但推荐使用 chatmode

访问控制(个人消息)

  • 默认:channels.mattermost.dmPolicy = "pairing"(未知发送者会收到配对码)。
  • 通过以下方式批准:
    • openclaw pairing list mattermost
    • openclaw pairing approve mattermost <CODE>
  • 公共个人消息:channels.mattermost.dmPolicy="open" 加上 channels.mattermost.allowFrom=["*"]

频道(群组)

  • 默认:channels.mattermost.groupPolicy = "allowlist"(提及受控)。
  • 使用 channels.mattermost.groupAllowFrom 允许特定发送者(用户 ID 或 @username)。
  • 开放频道:channels.mattermost.groupPolicy="open"(提及受控)。

外发传递的目标

使用这些目标格式与 openclaw message send 或 cron/webhooks 一起:

  • channel:<id> 用于频道
  • user:<id> 用于个人消息
  • @username 用于个人消息(通过 Mattermost API 解析)

裸 ID 被视为频道。

多账户

Mattermost 支持在 channels.mattermost.accounts 下的多个账户:

{
  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" },
      },
    },
  },
}

故障排除

  • 频道中没有回复:确保机器人在频道中并且提及它(oncall),使用触发前缀(onchar),或设置 chatmode: "onmessage"
  • 认证错误:检查机器人令牌、基础 URL 以及账户是否已启用。
  • 多账户问题:环境变量仅适用于 default 账户。