31
README.md
31
README.md
@@ -76,8 +76,6 @@ cp .env.example .env
|
||||
- `APP_DATA_DIR` 建议指向仓库外目录,例如 `../sub-provider-data`
|
||||
- `PUBLIC_PATH` 改成足够长的随机字符串
|
||||
- `PUBLIC_BASE_URL` 建议填写你反代后的最终访问地址,例如 `https://sub.example.com`
|
||||
- `ADMIN_TOKEN` 可选;配置后管理面板会启用登录鉴权,不配置则不校验登录
|
||||
- `ADMIN_SESSION_SECRET` 用于签发管理面板 session,部署时应改成随机长字符串
|
||||
- `AIRPORT_A_URL` / `AIRPORT_B_URL` / `AIRPORT_C_URL` 都可以直接填订阅地址,项目会自动判断是 YAML 还是 URI 订阅
|
||||
- 也可以直接填本地文件路径,例如 `/app/data/sources/airport-b.txt` 或 `file:///app/data/sources/airport-b.txt`
|
||||
- 允许把其中一个留空;留空时这个机场会自动跳过
|
||||
@@ -114,7 +112,6 @@ docker compose up -d --build
|
||||
6. 访问检查:
|
||||
|
||||
- 健康检查:`http://YOUR_HOST:18080/healthz`
|
||||
- 管理面板:`http://YOUR_HOST:18080/admin`
|
||||
- 单 provider:
|
||||
`https://YOUR_DOMAIN/<PUBLIC_PATH>/providers/airport-a.yaml`
|
||||
- merged provider:
|
||||
@@ -128,34 +125,6 @@ docker compose up -d --build
|
||||
- Stash bundle:
|
||||
`https://YOUR_DOMAIN/<PUBLIC_PATH>/bundle/stash.yaml?sources=airport-a,airport-b,airport-c`
|
||||
|
||||
### 管理面板(最小版本)
|
||||
|
||||
当前已提供一版服务端渲染的最小管理面板:
|
||||
|
||||
- `/admin/sources`
|
||||
- `/admin/profiles`
|
||||
- `/admin/profiles/{profile_key}/sources`
|
||||
- `/admin/profiles/{profile_key}/groups`
|
||||
- `/admin/profiles/{profile_key}/rules`
|
||||
- `/admin/profiles/{profile_key}/preview`
|
||||
|
||||
当前能力范围:
|
||||
|
||||
- Source 增删改
|
||||
- Profile 基础字段编辑
|
||||
- Profile 默认 source 绑定与顺序编辑
|
||||
- Profile group 新增、删除、基础字段编辑
|
||||
- Profile 规则启停、顺序、目标策略组编辑
|
||||
- 预览最终 bundle YAML
|
||||
|
||||
鉴权方式:
|
||||
|
||||
- 在 `.env` 中设置 `ADMIN_TOKEN`
|
||||
- `docker compose` 会自动把 `.env` 注入容器
|
||||
- 访问 `/admin` 时先进入登录页,提交 token 后写入 session cookie
|
||||
- session 使用 `ADMIN_SESSION_SECRET` 签名,默认有效期由 `ADMIN_SESSION_MAX_AGE` 控制
|
||||
- 如果 `ADMIN_TOKEN` 留空,管理面板默认不启用登录拦截
|
||||
|
||||
---
|
||||
|
||||
## 接口说明
|
||||
|
||||
Reference in New Issue
Block a user