From bacaa9926fe6153872356e549692f24a9cf04901 Mon Sep 17 00:00:00 2001 From: dnomd343 Date: Sun, 28 Aug 2022 01:19:29 +0800 Subject: [PATCH] docs: add describe of asset options --- README.md | 29 +++++++++++++++++------------ docs/example_2.md | 13 +++++++------ 2 files changed, 24 insertions(+), 18 deletions(-) diff --git a/README.md b/README.md index 872104f..eb077b3 100644 --- a/README.md +++ b/README.md @@ -43,7 +43,7 @@ proxy: network: ··· 网络选项 ··· -update: +asset: ··· 路由资源 ··· custom: @@ -153,14 +153,18 @@ network: ```yaml # 以下配置仅为示范 -update: - cron: "0 0 4 * * *" # 每天凌晨4点更新 - proxy: "socks5://192.168.2.4:1080" # 通过 socks5 代理更新资源 - url: - geoip.dat: "https://github.com/Loyalsoldier/v2ray-rules-dat/releases/latest/download/geoip.dat" - geosite.dat: "https://github.com/Loyalsoldier/v2ray-rules-dat/releases/latest/download/geosite.dat" +asset: + disable: false + update: + cron: "0 0 4 * * *" # 每天凌晨4点更新 + proxy: "socks5://192.168.2.4:1080" # 通过 socks5 代理更新资源 + url: + geoip.dat: "https://github.com/Loyalsoldier/v2ray-rules-dat/releases/latest/download/geoip.dat" + geosite.dat: "https://github.com/Loyalsoldier/v2ray-rules-dat/releases/latest/download/geosite.dat" ``` ++ `disable` :是否关闭路由资源文件载入,默认为 `false` + + `cron` :触发更新的 Cron 表达式,留空时关闭自动升级,默认为空 + `proxy` :通过指定的代理服务更新资源文件,留空时直连更新,默认为空 @@ -380,11 +384,12 @@ network: - fe80::/10 - ff00::/8 -update: - cron: "0 0 4 * * *" - url: - geoip.dat: "https://github.com/Loyalsoldier/v2ray-rules-dat/releases/latest/download/geoip.dat" - geosite.dat: "https://github.com/Loyalsoldier/v2ray-rules-dat/releases/latest/download/geosite.dat" +asset: + update: + cron: "0 0 4 * * *" + url: + geoip.dat: "https://github.com/Loyalsoldier/v2ray-rules-dat/releases/latest/download/geoip.dat" + geosite.dat: "https://github.com/Loyalsoldier/v2ray-rules-dat/releases/latest/download/geosite.dat" ``` 用户需要根据实际需求更改配置文件,保存以后重启容器即可生效: diff --git a/docs/example_2.md b/docs/example_2.md index ebf5f66..c002f68 100644 --- a/docs/example_2.md +++ b/docs/example_2.md @@ -105,12 +105,13 @@ radvd: prefix: cidr: 2409:8a55:e2a7:3a0::/64 -update: - cron: "0 5 6 * * *" - proxy: "socks5://192.168.2.2:1094" # 通过代理下载 Github 文件 - url: - geoip.dat: "https://github.com/Loyalsoldier/v2ray-rules-dat/releases/latest/download/geoip.dat" - geosite.dat: "https://github.com/Loyalsoldier/v2ray-rules-dat/releases/latest/download/geosite.dat" +asset: + update: + cron: "0 5 6 * * *" + proxy: "socks5://192.168.2.2:1094" # 通过代理下载 Github 文件 + url: + geoip.dat: "https://github.com/Loyalsoldier/v2ray-rules-dat/releases/latest/download/geoip.dat" + geosite.dat: "https://github.com/Loyalsoldier/v2ray-rules-dat/releases/latest/download/geosite.dat" ``` ### 代理配置