Mattermost (plugin)

适用范围

在以下情况使用此页面：

• 设置 Mattermost
• 调试 Mattermost 路由

状态：通过插件支持（机器人令牌 + WebSocket 事件）。支持通道、群组和 DM。Mattermost 是一个可自托管的团队消息传递平台；请参阅 mattermost.com 上的官方网站了解产品详细信息和下载。

需要插件

Mattermost 作为插件提供，不与核心安装捆绑。

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

moltbot plugins install @moltbot/mattermost

本地结帐（从 git 存储库运行时）：

moltbot plugins install ./extensions/mattermost

如果您在配置/入门期间选择 Mattermost 并且检测到 git 结帐，Moltbot 将自动提供本地安装路径。

详细信息：插件

快速设置

1. 安装 Mattermost 插件。
2. 创建 Mattermost 机器人帐户并复制机器人令牌。
3. 复制 Mattermost 基本 URL（例如，https://chat.example.com）。
4. 配置 Moltbot 并启动网关。

最小配置：

{
  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 自动响应 DM。通道行为由 chatmode 控制：

• oncall（默认）：仅在通道中 @提及时响应。
• onmessage：响应每条通道消息。
• onchar：当消息以触发前缀开始时响应。

配置示例：

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

注意：

• onchar 仍然响应显式 @提及。
• 对于传统配置，channels.mattermost.requireMention 受到尊重，但更喜欢 chatmode。

访问控制（DM）

• 默认：channels.mattermost.dmPolicy = "pairing"（未知发送者获得配对代码）。
• 通过以下方式批准：
  • moltbot pairing list mattermost
  • moltbot pairing approve mattermost <CODE>
• 公共 DM：channels.mattermost.dmPolicy="open" 加上 channels.mattermost.allowFrom=["*"]。

通道（群组）

• 默认：channels.mattermost.groupPolicy = "allowlist"（提及门控）。
• 使用 channels.mattermost.groupAllowFrom 允许列表发送者（用户 ID 或 @username）。
• 开放通道：channels.mattermost.groupPolicy="open"（提及门控）。

出站传递的目标

将这些目标格式与 moltbot message send 或 cron/webhooks 一起使用：

• channel:<id> 用于通道
• user:<id> 用于 DM
• @username 用于 DM（通过 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 帐户。