修改readme
This commit is contained in:
15
README.md
15
README.md
@@ -2,12 +2,13 @@
|
|||||||
|
|
||||||
## 功能
|
## 功能
|
||||||
|
|
||||||
每天从 `指定的网址` 拉取 `whitelist.md`:
|
每天从 `WHITELIST_REPO_URL` 指定的仓库拉取 `whitelist.md`,解析其中的仓库列表进行备份:
|
||||||
|
|
||||||
- 拉取不到时,自动使用前一天保存的白名单缓存作为兜底。
|
- 拉取不到时,自动使用前一天保存的白名单缓存作为兜底。
|
||||||
- 超过 **1/3** 的仓库拉取/更新失败时,通过 **server酱3** 推送告警通知。
|
- 超过 **1/3** 的仓库拉取/更新失败时,通过 **server酱3** 推送告警通知。
|
||||||
- 白名单第一次拉取失败且无前一天缓存时,同样推送告警。
|
- 白名单第一次拉取失败且无前一天缓存时,同样推送告警。
|
||||||
- 对白名单中的仓库执行 `git pull --ff-only`(已有)或 `git clone --depth 1`(新仓库),失败后自动重试一次重新克隆。
|
- 对白名单中的仓库执行 `git pull --ff-only`(已有)或 `git clone --depth 1`(新仓库),pull 失败后自动回退为重新克隆。
|
||||||
|
- 通过 Git Access Token(Bearer 认证)访问仓库,不填 Token 则使用默认凭证。
|
||||||
- 将所有仓库打包为 `ociflab-backup-YYYYMMDD.zip`,保留最近 **7 天**,过期自动清理。
|
- 将所有仓库打包为 `ociflab-backup-YYYYMMDD.zip`,保留最近 **7 天**,过期自动清理。
|
||||||
|
|
||||||
## 依赖
|
## 依赖
|
||||||
@@ -24,13 +25,16 @@
|
|||||||
编辑脚本顶部的配置变量:
|
编辑脚本顶部的配置变量:
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
|
# Git Access Token(用于认证,不填则不使用)
|
||||||
|
GIT_ACCESS_TOKEN=""
|
||||||
|
|
||||||
|
# 白名单仓库地址(clone 后读取其中的 whitelist.md)
|
||||||
|
WHITELIST_REPO_URL=""
|
||||||
|
|
||||||
# server酱3 配置(不填则跳过推送)
|
# server酱3 配置(不填则跳过推送)
|
||||||
SERVERCHAN_UID="" # 填写你的 UID
|
SERVERCHAN_UID="" # 填写你的 UID
|
||||||
SERVERCHAN_SENDKEY="" # 填写你的 SendKey
|
SERVERCHAN_SENDKEY="" # 填写你的 SendKey
|
||||||
|
|
||||||
# 白名单地址
|
|
||||||
WHITELIST_URL=""
|
|
||||||
|
|
||||||
# 保留天数(默认 7 天)
|
# 保留天数(默认 7 天)
|
||||||
RETENTION_DAYS=7
|
RETENTION_DAYS=7
|
||||||
```
|
```
|
||||||
@@ -72,6 +76,7 @@ crontab -e
|
|||||||
```
|
```
|
||||||
ociflab-backup/
|
ociflab-backup/
|
||||||
├── ociflab-backup.sh # 主脚本
|
├── ociflab-backup.sh # 主脚本
|
||||||
|
├── whitelist_repo/ # 白名单仓库 clone 位置
|
||||||
├── whitelist_cache.md # 当天拉取的白名单缓存
|
├── whitelist_cache.md # 当天拉取的白名单缓存
|
||||||
├── whitelist_cache.md.yesterday # 前一天缓存(兜底)
|
├── whitelist_cache.md.yesterday # 前一天缓存(兜底)
|
||||||
├── work/ # 仓库克隆工作目录
|
├── work/ # 仓库克隆工作目录
|
||||||
|
|||||||
Reference in New Issue
Block a user