matrixdotorg/matrix-appservice-irc

Matrix IRC Bridge

镜像概述和主要用途

Matrix IRC Bridge 是一个用于 https://matrix.org 网络的 IRC 桥接器。若从旧版本升级，请务必阅读 CHANGELOG，因为不同版本间可能存在破坏性变更。

该桥接器可将所有 IRC 消息转发至 Matrix，同时将所有 Matrix 消息转发至 IRC。它具有高度可配置性，目前已在 matrix.org homeserver 上使用，用于桥接多个流行 IRC 网络，包括 Freenode 和 OFTC。

核心功能和特性

主要功能

• 启动时，桥接器会将 Matrix 客户端加入配置文件中指定的 IRC 频道
• 监听传入的 IRC 消息并将其转发至 Matrix 房间
• 每个真实 Matrix 用户由一个 IRC 客户端表示，每个真实 IRC 客户端由一个 Matrix 用户表示
• 支持频道和私信中的全双向通信
• 提供大量自定义选项

使用场景和适用范围

该桥接器适用于需要在 Matrix 和 IRC 网络之间建立双向通信的个人或组织。目前已在 matrix.org homeserver 上大规模使用，成功桥接多个流行 IRC 网络（如 Freenode 和 OFTC）。任何需要将 IRC 社区与 Matrix 生态系统连接的场景均可使用此桥接器。

使用方法和配置说明

环境要求

• 运行中的 Matrix homeserver（支持应用服务 API 的任何 homeserver 均可）

桥接器部署

基本步骤

请参考 https://matrix-org.github.io/matrix-appservice-irc/latest/bridge_setup 了解桥接器部署的详细步骤。

配置说明

配置选项的详细说明请参见 示例配置文件。配置文件支持自定义 IRC 网络连接、频道映射、用户映射、消息转发规则等核心功能。

使用指南

要了解如何使用桥接器，请参阅 https://matrix-org.github.io/matrix-appservice-irc/latest/usage.html。

文档

在线文档

完整文档可在 https://matrix-org.github.io/matrix-appservice-irc 上查看。

本地构建文档

如需本地构建文档：

bash
# 确保系统已安装 Rust
# cargo install mdbook
mdbook build
sensible-browser book/index.html

贡献

有关贡献指南，请参见 CONTRIBUTING 文件。