tedomum/matrix-appservice-irc

Matrix-IRC桥接镜像概述

本镜像提供Matrix与IRC网络之间的桥接服务，通过Matrix应用服务（AS）API实现两者间的双向消息互通。它支持频道和私信的完整通信，可高度自定义配置，目前被matrix.org用于桥接Freenode、Moznet等主流IRC网络。

核心功能

1. 双向消息传递：IRC频道消息转发至Matrix房间，Matrix消息同步至IRC频道；
2. 多场景支持：覆盖公共频道互通、用户私信通信等场景；
3. 高度可配置：允许自定义IRC网络连接、频道别名模板、用户ID模板等参数；
4. homeserver集成：生成注册文件与Matrix homeserver对接，接收指定事件。

使用场景

• 团队/社区需要在Matrix和IRC网络间同步消息；
• 用户希望通过Matrix客户端访问IRC频道内容；
• 管理员需要桥接多个IRC网络到Matrix平台。

配置与运行说明

前提条件

• 控制一个Matrix homeserver（推荐Synapse v0.99.5.2及以上版本）；
• 获得目标IRC网络运营商的桥接许可（重要：违反IRC网络条款可能导致封禁）。

部署示例（Docker）

bash
# 假设本地配置目录为./matrix-irc-config，包含config.yaml和my_registration_file.yaml
docker run -d \
  --name matrix-appservice-irc \
  -p 9999:9999 \
  -v $(pwd)/matrix-irc-config:/app/config \
  tedomum/matrix-appservice-irc \
  node app.js -c /app/config/config.yaml -f /app/config/my_registration_file.yaml -p 9999

关键步骤说明

1. 配置文件准备：复制镜像内的config.sample.yaml为config.yaml，修改homeserver地址、IRC网络参数；
2. 生成注册文件：通过镜像命令生成注册文件，添加到homeserver配置的app_service_config_files字段；
3. 启动服务：使用上述Docker命令启动桥接服务，确保端口映射与配置一致。

注意事项

• 必须获得IRC网络运营商的桥接许可；
• 升级前请阅读镜像内的CHANGELOG，避免兼容性问题；
• 详细配置可参考镜像内的HOWTO.md和config.sample.yaml文件。