chore: update docs

This commit is contained in:
engigu
2026-03-31 15:36:15 +08:00
parent 4ca87111c8
commit 8879e7002f
13 changed files with 276 additions and 33 deletions
+25
View File
@@ -0,0 +1,25 @@
# 仓库同步 (Repo)
仓库同步允许白虎面板直接以 Git 仓库的形式管理和更新脚本库,极大地方便了脚本的大规模分发与自动化部署。
## 同步源管理
- **青龙 (QL) 指令解析**:如果您曾经是青龙面板的用户,您可以直接粘贴类似的 `ql repo <url> <whitelist> <blacklist> <dependence> <branch>` 指令,系统将自动提取各项参数。
> [!IMPORTANT]
> **依赖管理说明**:由于该面板采用基于 Mise 的多版本语言管理系统,与青龙的全局环境不同,系统 **无法通过 `dependence` 字段自动安装依赖**。用户需要手动前往「语言依赖」页面,或者在终端中自己执行依赖,在对应的运行中安装脚本所需的依赖包。
- **Git 源管理**:支持从 **GitHub**, **GitLab**, **Gitee** 等主流代码托管平台同步脚本。
- **SSH/Token 访问**:支持私有仓库的访问,可以在环境变量中配置对应的 Git 鉴权秘钥。
## 扫描与注册规则
- **自动解析配置**:在同步代码至本地物理磁盘后,面板将深度扫描每个 `.js``.py` 文件。
- **配置探测**
- `new Env('任务名称')`:解析 JavaScript 脚本定义的展示名。
- `cron "0 0 * * *"`:自动提取文件头部的 Cron 注释规则。
- **白名单/黑名单**:通过正则表达式(Regex)过滤哪些子目录或特定命名的文件需要被注册为定时任务。
## 增量同步
- **Git 离线拉取**:支持增量更新,仅下载变更部分,降低带宽压力。
- **分支切换**:支持指定任意分支进行同步,方便用户在生产与测试环境间切换脚本源。
- **稀疏检出 (Sparse Checkout)**:如果仓库过于庞大,您可以配置仅同步特定的子文件夹以节省存储空间。