Home

🧭 Rule-Bot Client 用户文档

Rule-Bot Client 读取 Mihomo 的连接信息，找出没有命中前面规则、最终由兜底规则处理的域名，并保存为本地清单。需要时，还可以把域名发送给 Rule-Bot 做进一步检查。

本 Wiki 面向安装和使用 Rule-Bot Client 的用户。文中的安装示例已按当前正式版本 v0.3.3 核对；开始安装前，仍应查看最新正式版本。

🧩 先了解几个关键概念

名称	含义
🧠 Mihomo	实际处理代理连接和规则匹配的内核；OpenClash、Nikki 等工具可以管理 Mihomo
🎯 MATCH	Mihomo 规则列表末尾的兜底规则；连接没有命中前面的规则时，才会由它处理
🔗 Mihomo 控制接口	Mihomo 自带的 HTTP 管理接口，配置项通常叫 external-controller；Rule-Bot Client 通过它读取日志和当前连接，不需要再安装其他程序。英文资料和部分界面也称它为 Controller
🤖 Rule-Bot	可选的配套服务，用来检查域名是否需要补充规则；本地收集不依赖它

🔗 项目关系

Rule-Bot Client 可以独立完成本地收集。只有需要对应能力时，才使用其他项目：

项目	在流程中的作用
Rule-Bot	可选服务端；检查候选域名并写入目标 GitHub 规则仓库
Custom_OpenClash_Rules	项目公共 Rule-Bot 的公开目标规则仓库
SubConverter-Extended	可选订阅转换后端；与本地收集和发送没有直接依赖

公共服务中的数据流为：Mihomo 的 MATCH 连接 → 本地收集 → 用户主动启用发送 → Rule-Bot → Custom_OpenClash_Rules。

🎯 先选择一个部署位置

同一套网络通常只需部署一个 Rule-Bot Client。只要部署位置能够访问各个 Mihomo 控制接口，一个客户端就能同时采集多个正在运行的 Mihomo 内核；不需要在 OpenWrt 和 Linux 上各安装一份。

有常驻 Linux、NAS、Windows 或其他能够运行 Docker 的设备时，优先部署在那里。只有 OpenWrt 是唯一合适的常驻设备时，才建议使用 OpenWrt 软件包。仅当网络相互隔离，没有任何一个部署位置能够访问全部控制接口时，才需要多个客户端。

🚀 从这里开始

需要做什么	文档
🐧 在 Debian、Ubuntu、NAS 或 Docker 上部署	Linux 部署方式
🪟 在 Windows 上直接解压运行	Windows 便携版
📡 只有 OpenWrt 设备，需要使用 Web 界面	OpenWrt 使用指南
⚙️ 查找控制接口地址，或了解配置文件中的字段	配置说明
🔗 申请 Token，并接入项目配套的公共 Rule-Bot	接入公共 Rule-Bot
🩺 排查无法启动、无法连接或没有结果	故障排查
🔐 了解本地保存、发送到外部的数据和用户控制	客户端隐私说明 · Rule-Bot 隐私说明

✅ 第一次使用的推荐顺序

1. 安装客户端，只选择一种部署方式。
2. 连接 Mihomo 控制接口。OpenWrt 可以自动发现本机的 OpenClash 或 Nikki；其他方式需要填写控制接口地址和密钥。
3. 先使用「仅本地收集」。访问一个此前未收集、最终由 MATCH 处理的域名，然后确认本地域名清单出现结果。
4. 只有需要自动补充直连规则时，才按照公共 Rule-Bot 接入流程申请 Token，并填写完整提交地址和访问令牌。

Rule-Bot 默认关闭。Rule-Bot 收到域名后仍会检查已有规则、GeoSite 域名库和服务端策略，因此不是每个域名都会写入 GitHub。

Caution

隐私提醒： Rule-Bot Client 可能观察设备或整个网络访问的域名。OpenWrt 软件包安装后会启用后台服务，并可能通过 OpenClash 立即开始本地收集。安装前必须确认有权收集这些数据。

📄 开源许可

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

---

⬇️ 下载最新版本 · 📘 项目 README · 💬 问题反馈