Repository navigation
User Guide.zh CN
打开 /auth,提供具有 gist 权限的 GitHub Token。默认仅在当前会话保存。
仅在可信设备主动选择持久保存;同源 JavaScript 可读取持久 Token,发生 XSS 时也不例外。
SubMan 查找描述为 SubMan-Data、包含权威文档 subman.json 的私有 Gist。
存在多个候选时,输入原 Gist ID。只有未发现候选时,初始化才可创建空的私有引导 Gist。
设备绑定后,重新连接或更换 Token 都会返回原 Gist。加载最新云端数据后才能编辑。
识别到 V1 数据时先显示迁移预览,并要求确认。迁移保留原 Gist、字节一致的 V1 备份、 输出内容、文件名、元数据和订阅链接。数据缺失或文档被拒绝时,参阅迁移指南。
| 页面 | 用途 |
|---|---|
/auth |
连接、Token、发送状态、云端重载、迁移和诊断 |
/nodes |
节点与订阅、标签、搜索、过滤、批量导入 |
/aggregate |
规则编辑、预览排序、发布目标与发布 |
/exports |
sing-box 配置预览、复制、下载和发布 |
/gists |
输出文件、原始链接和清理 |
每行粘贴一个 URI,也可导入 base64 订阅内容;预览并处理重复项后再添加。 聚合规则可选择节点和订阅、排除标签、过滤协议、正则重命名、添加地区旗帜, 并按名称、协议、地区、优先关键词或手动拖拽排序。
订阅地址需要允许浏览器访问。请求超时为 15 秒,响应上限为 4 MiB;网络/CORS、HTTP、 大小、编码和空内容分别提示错误。导出指南说明支持的协议、 警告和 sing-box 1.14 兼容范围。
选择聚合规则,预览输出并配置发布目标。输出写入绑定的工作区 Gist,继承它在 GitHub 上的实际可见性。 同一 Gist 和文件名可保持原始订阅 URL 稳定;重命名会产生新 URL,删除旧文件前先查看清理结果。 修改节点后不会自动重新发布现有聚合或 sing-box 文件。
配置与输出由协调器一并提交。subman.json、subman.v1.backup.json 和
subman.bootstrap.json 为保留文件,不可用作输出,也不能通过文件管理器删除。
云端 subman.json 是业务数据来源。每个有效编辑先事务性记录到浏览器发送日志,再立即发送,
只有云端确认后才报告保存成功。缓存和排队请求是技术发送状态;待发送或阻塞的变更会暂停后续编辑。
- **网络失败或其他页面正在发送:**保留原 mutation,恢复连接后重试;排队和重试状态不代表保存成功。
- **并发修改:**查看冲突;若决定放弃待处理工作,确认丢弃完整队列并重载最新云端文档,再重新应用编辑。
- **存储修复:**保留浏览器数据并查看安全诊断,不要单独删除队列条目,也不要用诊断文件替换 Gist。
- **旧规则缺失:**输出文件无法重建聚合规则或发布记录,应按迁移指南检查原 Gist 历史。
诊断只导出计数、安全元数据、哈希和重试分类,不包含业务数据或凭据。 浏览器不提供业务 JSON 备份/恢复、本地覆盖/合并、手动推送或工作区切换。 操作人员的修复步骤见运维与恢复。
公共 API 支持健康检查和节点 CRUD/按外部键更新。参阅 Server API 和 sing-box-vps 集成。 后端 Bearer 与浏览器 GitHub Token 分开。订阅、聚合、发布和导出 REST 接口仍为提案; 第三方脚本不可直接 PATCH Gist 或使用内部浏览器 mutation 路由。
SubMan Wiki
| English | 简体中文 |
|---|---|
| User guide | 使用指南 |
| Development | 开发指南 |
| Server API | 接口文档 |
| Operations | 运维与恢复 |
| Migration | 旧版迁移 |
| sing-box export | sing-box 导出 |
| CI/CD | CI/CD |
| Roadmap | 路线图 |
| Changelog | 变更记录 |