相关资料
有疑问也可联系我哦，不过在这之前请确认你已经阅读了以下资料。
配置教程
草履虫也能学会的 Clash 配置：UI界面一键配置精确分流、链式代理
在线版本
开源许可
SubBoost 公开源码以 GNU Affero General Public License v3.0 only 授权。
常用接口
以下为SubBoost公开接口。
管理员与登录
| 方法 | 路径 | 作用 |
|---|---|---|
POST | /api/setup/admin | 初始化本地管理员。 |
POST | /api/auth/login | 登录管理员账号。 |
POST | /api/auth/logout | 退出登录。 |
GET | /api/auth/me | 查看初始化状态、登录状态和当前账号信息。 |
订阅
| 方法 | 路径 | 作用 |
|---|---|---|
POST | /api/source-import | 从订阅 URL 导入源内容并返回解析结果。 |
GET | /api/subscriptions | 读取订阅列表。 |
POST | /api/subscriptions | 创建订阅。 |
GET | /api/subscriptions/:id | 读取一个订阅。 |
PUT | /api/subscriptions/:id | 更新一个订阅。 |
DELETE | /api/subscriptions/:id | 删除一个订阅。 |
POST | /api/subscriptions/:id/refresh | 手动刷新订阅。 |
GET | /api/subscriptions/:token/config.yaml | 读取生成的订阅配置。 |
模板与规则
| 方法 | 路径 | 作用 |
|---|---|---|
GET | /api/templates | 读取内置模板、规则目录模板或我的模板列表。 |
POST | /api/templates | 创建私有模板。 |
DELETE | /api/templates?id=:id | 删除私有模板。 |
GET | /api/templates/:id | 读取模板详情。 |
GET | /api/rules/search | 搜索规则。 |
GET | /api/rules/cn-candidates | 查找中国规则候选。 |
定时任务
这些接口由 Docker Compose 的 cron 侧车调用，需要 Authorization: Bearer <CRON_SECRET>。
| 方法 | 路径 | 作用 |
|---|---|---|
POST | /api/cron/update-rule-index | 刷新规则目录缓存。 |
POST | /api/cron/update-subscriptions | 刷新到期订阅。 |
健康检查
| 方法 | 路径 | 作用 |
|---|---|---|
GET | /api/health/live | 应用进程是否存活。 |
GET | /api/health/ready | 数据库等依赖是否就绪。 |