Home

📚 Rule-Bot 用户文档

从直接使用到自托管部署，一站找到所需说明。

🤖 打开配套机器人 · 🚀 部署指南 · ⚙️ 配置说明 · 🔌 Client 接入

---

Rule-Bot 是一个自托管的 Telegram 机器人，用于查询域名、判断是否适合直连，并把确认后的规则写入 GitHub。本 Wiki 面向实际使用者和部署者；项目概览与快速开始见 README。

Tip

只想为 Custom_OpenClash_Rules 添加规则？ 直接打开配套机器人 @asailor_rulebot，无需自行部署 Rule-Bot。

🧭 选择你的阅读路径

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

🗺️ 文档地图

🛠️ 部署与故障排查

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

➡️ 打开部署与故障排查

⚙️ 配置说明

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

➡️ 打开配置说明

🔌 Rule-Bot Client 接入

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

➡️ 打开 Rule-Bot Client 接入

⚠️ 使用前须知

Important

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

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

🔗 项目入口

资源	链接
🤖 配套机器人	@asailor_rulebot
🧑‍💻 GitHub 仓库	Aethersailor/Rule-Bot
🐳 Docker 镜像	aethersailor/rule-bot
🔌 Rule-Bot Client	Aethersailor/Rule-Bot-Client
💬 交流群	Custom OpenClash Rules 交流群