benramsey/slack-irc

benramsey/slack-irc Docker镜像

镜像概述

本镜像为Martin Ek的https://github.com/ekmartin/slack-irc%E7%9A%84%E5%AE%B9%E5%99%A8%E5%8C%96%E5%AE%9E%E7%8E%B0%EF%BC%8C%E7%94%A8%E4%BA%8E%E5%9C%A8Slack%E4%B8%8EIRC%E9%A2%91%E9%81%93%E4%B9%8B%E9%97%B4%E5%8F%8C%E5%90%91%E8%BD%AC%E5%8F%91%E6%B6%88%E6%81%AF%EF%BC%8C%E6%94%AF%E6%8C%81%E5%8D%95/%E5%A4%9A%E5%9B%A2%E9%98%9F%E9%85%8D%E7%BD%AE%EF%BC%8C%E5%8F%AF%E9%80%82%E9%85%8D%E4%B8%8D%E5%90%8CIRC%E7%BD%91%E7%BB%9C%E5%9C%BA%E6%99%AF%E3%80%82

核心功能

• 双向消息转发：在Slack与IRC频道间同步文本消息
• 多实例支持：通过数组配置文件运行多个IRC机器人，适配多团队/多IRC网络
• 自动命令执行：连接IRC时自动发送身份验证、模式设置等命令
• 自定义配置：支持Slack用户名格式、头像显示、频道映射及密钥配置
• 日志与过滤：可开启调试日志，屏蔽特定用户或Slackbot消息
• 邀请制支持：自动加入已授权的IRC邀请制频道

使用场景

• 团队同时使用Slack和IRC沟通，需统一消息流的协作场景
• 跨平台项目需要在Slack与IRC间同步信息的场景
• 需要自动化管理IRC频道（如自动身份验证）的运维场景

配置说明

准备配置文件

创建JSON格式的配置文件（默认名为config.json，可自定义），支持单机器人（对象）或多机器人（数组）配置。配置需包含Slack机器人令牌、IRC服务器地址、频道映射等关键信息。

部署示例

1. 使用默认配置文件

将包含config.json的本地目录挂载到容器/config目录：

bash
docker run -it -v /本地配置目录路径:/config benramsey/slack-irc

2. 使用自定义配置文件名

若配置文件名为my-config.json：

bash
docker run -it -v /本地配置目录路径:/config benramsey/slack-irc my-config.json

3. 开启调试日志

设置环境变量NODE_ENV=development启用调试模式：

bash
docker run -it -v /本地配置目录路径:/config -e NODE_ENV=development benramsey/slack-irc

配置文件示例

（注意：JSON不允许注释，请移除注释后使用）

json
[
  // 最小配置示例
  {
    "nickname": "test2",
    "server": "irc.testbot.org",
    "token": "slacktoken2",
    "channelMapping": {
      "#other-slack": "#new-irc-channel"
    }
  },
  // 高级配置示例
  {
    "nickname": "test",
    "server": "irc.bottest.org",
    "token": "slacktoken", // Slack机器人令牌
    "avatarUrl": "https://robohash.org/$username.png?size=48x48", // 禁用头像设为false
    "slackUsernameFormat": "<$username>", // 自定义Slack用户名格式
    "autoSendCommands": [ // 连接时自动发送的IRC命令
      ["PRIVMSG", "NickServ", "IDENTIFY password"],
      ["MODE", "test", "+x"]
    ],
    "channelMapping": { // Slack与IRC频道映射（支持密钥）
      "#slack": "#irc channel-password",
      "privategroup": "#other-channel"
    },
    "ircOptions": { // node-irc可选配置（参考node-irc文档）
      "floodProtection": false,
      "floodProtectionDelay": 1000
    },
    "commandCharacters": ["!", "."], // 隐藏用户名前缀的命令字符
    "muteSlackbot": true, // 屏蔽Slackbot消息
    "ircStatusNotices": { // IRC状态通知开关
      "join": false,
      "leave": true
    },
    "muteUsers": { // 屏蔽特定用户消息
      "irc": ["irc-user"],
      "slack": ["slack-user"]
    }
  }
]

注意事项

• Slack机器人需加入目标Slack频道（通过/invite <botname>命令）
• ircOptions参数直接传递给node-irc，详细选项可参考node-irc文档
• 配置文件需确保JSON格式合法，无语法错误