Home

📚 Rule-Bot 用户文档

从公共实例、自托管部署和关联项目中找到正确入口。

🤖 公共实例 · 🚀 部署指南 · ⚙️ 配置说明 · 🔌 Client 接入

---

Rule-Bot 是一个自托管的 Telegram 机器人，用于查询域名、判断是否适合直连，并按私聊确认或受信任自动入口的策略维护 GitHub 规则。本 Wiki 面向实际使用者和部署者；项目概览与快速开始见 README。

Tip

只想为 Custom_OpenClash_Rules 查询或添加补充直连域名？ 查看公共实例，直接打开 Telegram 机器人，无需自行部署 Rule-Bot。规则文件、CDN 和 OpenClash 使用方法由 Custom_OpenClash_Rules 文档维护。

🧭 选择你的阅读路径

目标	推荐入口	读完可以做什么
🤖 直接使用公共实例	公共实例	查询或添加域名，并找到目标规则项目的使用说明
🐳 部署自己的实例	部署与故障排查	准备凭据、启动容器并验证 Telegram
⚙️ 调整功能	配置说明	配置群聊、管理员、播报、数据源和资源参数
🔌 接入流量采集端	Rule-Bot Client 接入	安全启用私用或社区入口
🔐 了解数据边界	隐私说明	了解 Token、网络元数据、数据保留和用户控制

🗺️ 文档地图

🤖 公共实例

介绍公共 Telegram 机器人、固定维护目标、处理结果、Client 接入和问题分流。

➡️ 打开公共实例说明

🛠️ 部署与故障排查

适合第一次自托管、更新 Docker 镜像或处理启动问题。包含准备工作、安装步骤、成功标志、备份要求和常见问题。

➡️ 打开部署与故障排查

⚙️ 配置说明

集中说明必需环境变量和可选能力，包括 Telegram 群聊、群成员验证、管理员、播报、数据源、缓存和日志。

➡️ 打开配置说明

🔌 Rule-Bot Client 接入

面向需要接入实际流量域名的部署者，说明私用入口、社区入口、HTTPS、鉴权、持久化与恢复边界。

➡️ 打开 Rule-Bot Client 接入

⚠️ 使用前须知

Important

Rule-Bot 不是网页应用。维护其他规则仓库或需要独立服务时，可以通过 @BotFather 创建 Telegram Bot 并自行部署。

• 当前只管理直连规则。代理规则添加和规则删除尚未开放。
• Telegram 私聊添加需要用户确认；群聊和 Rule-Bot Client 使用各自的自动处理策略。
• 成功添加的域名会写入目标 GitHub 仓库及其提交历史；目标仓库公开时，这些内容也会公开。

🐳 镜像渠道

默认 Compose 使用 aethersailor/rule-bot:latest。latest 是随 master 更新的滚动标签，可能领先最新正式 Release；X.Y.Z 标签对应 vX.Y.Z Release。需要审计、复现或回滚时，应记录镜像 digest 和 OCI revision。完整说明见部署与故障排查，稳定版本记录见 GitHub Releases。

🔗 四个项目如何配合

项目	主要职责	是否为 Rule-Bot 必需组件
Custom_OpenClash_Rules	提供 OpenClash / Mihomo 配置、规则及使用文档	仅项目公共实例固定写入该项目；自建实例可维护其他仓库
SubConverter-Extended	按需转换订阅和生成客户端配置	否，是可选的配置转换工具
Rule-Bot	检查域名并维护目标 GitHub 规则文件	当前项目
Rule-Bot Client	本地收集 Mihomo MATCH 域名，并可选发送给 Rule-Bot	否，本地收集可以独立使用

常见流程是：Mihomo 产生最终命中 MATCH 的连接，Rule-Bot Client 在本地收集域名；用户主动启用发送后，Rule-Bot 检查并维护目标规则仓库。SubConverter-Extended 只在需要转换订阅或生成配置时参与。

🧭 问题应当提交到哪里

问题或需求	正确入口
查询或添加少量公共直连域名	@asailor_rulebot
Rule-Bot 部署、Telegram 流程或 Client API 缺陷	Rule-Bot Bug 表单
本地收集、Mihomo 连接或客户端投递问题	Rule-Bot Client Issues
规则内容、派生文件、CDN 或 OpenClash 使用问题	Custom_OpenClash_Rules Issues
订阅转换或生成配置问题	SubConverter-Extended Issues
安全漏洞或隐私边界问题	私密漏洞报告

🔗 项目入口

资源	链接
🤖 公共实例	使用说明 · @asailor_rulebot
🧑‍💻 GitHub 仓库	Aethersailor/Rule-Bot
🐳 Docker 镜像	aethersailor/rule-bot
📦 正式版本	GitHub Releases
🔌 Rule-Bot Client	Aethersailor/Rule-Bot-Client
💬 交流群	Custom OpenClash Rules 交流群

📄 开源许可

本 Wiki 内容与 Rule-Bot 项目均采用 GNU Affero General Public License v3.0。