42wim/matterircd

matterircd

https://img.shields.io/badge/IRC-matterircd-green.svg]([***]

镜像概述和主要用途

matterircd是一个最小化IRC服务器，可与Mattermost和Slack集成，允许用户通过IRC客户端连接并使用本地或远程的Mattermost/Slack服务。支持FreeBSD、Linux、Windows系统，实现IRC协议与Mattermost/Slack功能的无缝衔接。

兼容性

• 兼容Slack和Mattermost 5.x版本
• matterircd主分支始终适配最新稳定版Mattermost

核心功能和特性

• 支持私信、私有频道、消息编辑/删除/反应
• 自动加入/离开与Mattermost相同的频道
• 支持Mattermost重启后的退避重连机制
• 多用户支持
• 频道/私信消息回溯（断开连接期间的消息）
• 消息搜索（/msg mattermost search query）
• 滚动回溯支持（/msg mattermost scrollback #channel limit）
• 离开状态支持
• 可限制连接到指定Mattermost实例
• 支持设置默认团队/服务器
• 支持WHOIS、WHO、JOIN、LEAVE、NICK、LIST、ISON、PRIVMSG、MODE、TOPIC、LUSERS、AWAY、KICK、INVITE等IRC命令
• TLS（SSL）支持
• Unix套接字支持
• LDAP登录支持（Mattermost企业版）
• &users频道包含所有团队成员，便于消息发送
• 支持包含/排除特定频道显示
• 显示Mattermost角色（管理员显示@状态）
• GitLab认证支持（通过mmtoken cookie）
• Mattermost个人令牌支持
• 多行粘贴支持
• prefixcontext选项（支持线程和反应）

使用场景和适用范围

• 需要通过IRC客户端访问Mattermost/Slack的用户
• 希望在IRC环境中管理Mattermost/Slack消息和频道的团队
• 需要跨平台消息同步的企业或个人用户

详细使用方法和配置说明

二进制文件

可从https://github.com/42wim/matterircd/releases/latest%E8%8E%B7%E5%8F%96%E9%A2%84%E7%BC%96%E8%AF%91%E4%BA%8C%E8%BF%9B%E5%88%B6%E6%96%87%E4%BB%B6%E3%80%82

构建

需Go 1.14+环境：

bash
go get github.com/42wim/matterircd

构建后二进制文件位于~/go/bin/目录：

bash
$ ls ~/go/bin/
matterircd

配置文件

参考https://github.com/42wim/matterircd/blob/master/matterircd.toml.example%EF%BC%8C%E4%BD%BF%E7%94%A8%60matterircd --conf matterircd.toml`命令加载配置。

命令行参数

bash
Usage of ./matterircd:
      --bind string      绑定的接口:端口或Unix套接字路径（默认"127.0.0.1:6667"）
      --conf string      配置文件路径（默认"matterircd.toml"）
      --debug            启用调试日志
      --tlsbind string   TLS绑定的接口:端口（如127.0.0.1:6697）
      --tlsdir string    证书目录（包含key.pem和cert.pem，默认"."）
      --version          显示版本

默认监听localhost:6667，可使用任意IRC客户端连接。TLS支持需生成证书，可使用https://golang.org/src/***/tls/generate_cert.go%E7%94%9F%E6%88%90%60key.pem%60%E5%92%8C%60cert.pem%60%E3%80%82

Mattermost用户命令

登录

• 使用用户名/密码登录：

  /msg mattermost login <服务器> <团队> <用户名/邮箱> <密码>
  

• 使用个人令牌登录：

  /msg mattermost login <服务器> <团队> <用户名/邮箱> token=<个人令牌>
  

• 使用MFA令牌登录：

  /msg mattermost login <服务器> <团队> <用户名/邮箱> <密码> MFAToken=<MFA令牌>
  

搜索

/msg mattermost search query

滚动回溯

/msg mattermost scrollback <频道> <条数>
例如：/msg mattermost scrollback #bugs 100 显示#bugs频道最近100条消息

标记已读

（需设置DisableAutoView）

/msg mattermost updatelastviewed <频道>
/msg mattermost updatelastviewed <用户名>

Slack用户命令

获取令牌

从Slack Legacy Tokens获取令牌。

登录

• 使用令牌登录：

  /msg slack login <令牌>
  

• 使用团队/登录名/密码登录：

  /msg slack login <团队> <登录名> <密码>
  

登录后将显示可用于后续登录的令牌。

Docker部署

Docker镜像可从https://hub.docker.com/r/42wim/matterircd/%E8%8E%B7%E5%8F%96%E3%80%82

运行容器

默认监听容器内127.0.0.1:6667，需指定-bind 0.0.0.0:6667以对外暴露端口：

bash
docker run -p 6667:6667 docker.xuanyuan.run/42wim/matterircd:latest -bind 0.0.0.0:6667

使用IRC客户端连接Docker主机的6667端口即可。

常见问题（FAQ）

Mattermost SSO/GitLab登录

需从浏览器Cookie获取MMAUTHTOKEN：

1. 通过浏览器登录Mattermost
2. 打开开发者工具（F12）→ 应用 → 存储/Cookies → 选择Mattermost域名 → 获取MMAUTHTOKEN
3. 使用令牌登录：

   /msg mattermost login <用户名> MMAUTHTOKEN=<令牌>
   

   （若失败尝试：/msg mattermost login <用户名> token=<令牌>）

Slack SSO登录/xoxc令牌

1. 通过浏览器登录Slack团队
2. 打开开发者工具网络选项卡，查找XHR请求
3. 从请求数据中获取以xoxc-开头的令牌，从请求Cookie中获取d=XXXX;格式的auth cookie
4. 拼接令牌和Cookie（格式：xoxc-XXXX|d=XXXX;）
5. 使用拼接字符串登录：

   /msg slack login xoxc-XXXX|d=XXXX;
   

支持与问题

可加入IRC频道#matterircd（irc.freenode.net）获取支持。

相关项目

• https://github.com/hloeung/matterircd-complete - 增强irssi/Mattermost/matterircd集成