ontrif/slacker

Slacker Docker镜像文档

概述

Slacker是一个简单的email-to-slack网关，支持通过基本规则将邮件从不同发送源路由到Slack的不同频道。其主要用途是将仅支持邮件通知的旧系统（如cron和monit）的消息重定向到Slack，解决传统系统消息通知方式单一的问题。

核心功能

• 内置SMTP服务器，接收邮件并转发至Slack
• 支持基于邮件发送者（from）、接收者（to）和主题（subject）的规则路由
• 提供默认配置，可通过规则覆盖默认参数
• 支持自定义Slack机器人名称、头像和目标频道

使用场景

适用于需要将邮件通知转换为Slack消息的场景，特别是：

• cron任务的执行结果通知
• monit监控系统的告警通知
• 其他仅支持邮件输出的老旧系统或工具

使用方法

拉取镜像

bash
docker pull ontrif/slacker

运行容器

使用自定义配置文件启动Slacker容器：

bash
docker run \
    -d --restart=always \
    --name=slacker \
    -v /path/to/config.yml:/etc/slacker/config.yml \
    -p localhost:8025:8025 \
    ontrif/slacker

上述命令将在localhost:8025启动SMTP服务器，容器会自动重启。

参数说明：

• -v /path/to/config.yml:/etc/slacker/config.yml：挂载本地配置文件到容器内
• -p localhost:8025:8025：映射SMTP服务端口
• --restart=always：设置容器自动重启

配置说明

Slacker通过config.yml文件进行配置，包含两个主要部分：default（默认配置）和rules（规则列表）。

配置结构

default 部分

默认配置，所有未匹配规则的邮件将使用这些参数：

• channel：默认Slack频道（如#general）
• username：默认机器人名称
• icon_url：默认机器人头像URL（留空使用Slack默认头像）
• slack_token：Slack API令牌（格式：xoxb-...）
• debug：是否开启调试模式（布尔值，true/false）

rules 部分

规则列表，按顺序匹配邮件，第一个匹配的规则将覆盖默认配置。每个规则包含：

• name：规则名称（仅用于标识）
• from：匹配邮件发送者的正则表达式（如monit@.*）
• to：匹配邮件接收者的正则表达式（可选）
• subject：匹配邮件主题的正则表达式（可选）
• options：规则匹配时应用的参数（同default部分的参数，用于覆盖默认值）

配置示例

以下示例配置将邮件分别路由到#monit和#cron频道：

yaml
# 默认配置：频道、机器人名称、头像URL、Slack令牌和调试模式
default:
    channel: '#general'
    username: slacker
    icon_url: ''
    slack_token: xoxb-00000000000-aaaaaaaaaaaaaaaaaaaaaaaa
    debug: false


# 规则列表
rules:
    - name: Monit规则
      from: monit@.*     # 匹配所有来自monit@开头的邮件
      options:
          username: monit
          channel: '#monit'
          icon_url: 'https://bitbucket.org/tildeslash/monit/avatar/128'
          debug: false


    - name: Cron规则
      from: root@localhost  # 匹配来自root@localhost的邮件
      subject: Cron.*       # 匹配主题以"Cron..."开头的邮件
      options:
          username: cron
          channel: '#cron'
          icon_url: ''
          debug: true       # 开启调试模式，输出完整邮件内容及所有X-headers

规则匹配逻辑

1. 邮件到达后，按规则列表顺序依次检查
2. 当邮件的from、to、subject（若规则中定义）均匹配正则表达式时，应用该规则
3. 规则中的options参数将覆盖default中的对应参数
4. 若未匹配任何规则，使用default配置发送到Slack