Skip to content

yaml

Directory actions

More options

Directory actions

More options

Latest commit

 

History

History

yaml

README.md

🌐 远程 YAML 覆写模块

填写模块变量，自动下载对应 YAML、写入订阅并切换配置

模块列表 · 如何选择 · 使用方法 · 参数说明 · 订阅链接

Important

使用本目录模块前，先按照项目 Wiki 的 OpenClash 设置方案 完成 LuCI 设置。模块负责调用远程 YAML 和写入订阅地址，不负责配置 DNS、IPv6、TUN、嗅探及其他插件运行参数。

如需了解被调用 YAML 的策略组、规则和版本区别，请先阅读 ../../cfg/yaml/。

🧭 远程 YAML 覆写模块的定位

本项目建议先配置 LuCI，再从以下三种路径中三选一：

  1. 订阅转换与 .ini 模板；
  2. 本目录的远程 YAML 覆写模块；
  3. 下载 YAML，手动修改后导入。

覆写模块适合不使用订阅转换后端、又不想手动维护 YAML 的用户。与手动导入相比，它的操作更简单，但仍需理解模块地址、EN_KEY 变量和 OpenClash 覆写执行结果。

Note

模块最终调用的仍是本项目 YAML，因此同样基于维护者推定的典型使用场景。需要完全个性化时，请手动修改或自行编写 YAML。

📦 模块列表

功能 模块文件 调用目标 模块变量
标准版 Custom_Clash.conf Custom_Clash.yaml EN_KEY1：节点订阅链接
标准故障转移版 Custom_Clash_Fallback.conf Custom_Clash_Fallback.yaml EN_KEY1：节点订阅链接
轻量版 Custom_Clash_Lite.conf Custom_Clash_Lite.yaml EN_KEY1：节点订阅链接
轻量故障转移版 Custom_Clash_Lite_Fallback.conf Custom_Clash_Lite_Fallback.yaml EN_KEY1：节点订阅链接
极简 GFW 版 Custom_Clash_GFW.conf Custom_Clash_GFW.yaml EN_KEY1：节点订阅链接
极简 GFW 故障转移版 Custom_Clash_GFW_Fallback.conf Custom_Clash_GFW_Fallback.yaml EN_KEY1：节点订阅链接
重度分流版 Custom_Clash_Full.conf Custom_Clash_Full.yaml EN_KEY1：节点订阅链接
重度分流故障转移版 Custom_Clash_Full_Fallback.conf Custom_Clash_Full_Fallback.yaml EN_KEY1：节点订阅链接
8 合 1 Custom_Clash_8in1.conf 8 个常规 YAML 中任选其一 EN_KEY1：节点订阅；EN_KEY2：配置名称
自建节点 Provider 优先版 Custom_Clash_Selfhosted_Provider_Fallback.conf Custom_Clash_Selfhosted_Provider_Fallback.yaml EN_KEY1：节点订阅；EN_KEY2：自建节点订阅

模块实际执行的操作

启用后，模块会：

  1. 从 cdn.jsdelivr.net 下载对应的远程 YAML 到 /etc/openclash/config/；
  2. 将该 YAML 设为模块处理的配置文件；
  3. 使用 ruby_map_edit 把 EN_KEY 写入相应 proxy-providers.*.url；
  4. 设置订阅信息 URL；
  5. 应用配置并触发 OpenClash 重启。

模块不会修改仓库中的远程 YAML，也不会将订阅地址上传回本项目。

🎯 如何选择

单独模块

文件名与 YAML 一一对应，只需填写 EN_KEY1。配置固定且参数最少，可降低选错版本的风险。

建议： 已经确定长期使用某个版本时选择。

选择 8 合 1 模块

Custom_Clash_8in1.conf 可以调用 8 个常规 YAML。通过 EN_KEY2 选择版本，留空时默认使用 Custom_Clash。

该模块使用 ${EN_KEY2:-Custom_Clash}，需要 OpenClash 包含 2026 年 10 月 12 日的变量默认值解析修复。正式版 v0.48.002 不支持这一语法，会原样保留表达式，无法按预期生成下载地址和配置路径；填写 EN_KEY2 也不能解决该版本的解析差异。使用 v0.48.002 时请选择对应的单独模块。

建议： 经常在标准、Lite、GFW、Full 及其故障转移版之间切换时选择。

自建节点 Provider 版

Custom_Clash_Selfhosted_Provider_Fallback.conf 同时写入节点订阅和自建节点订阅，并调用 Custom_Clash_Selfhosted_Provider_Fallback.yaml。

建议： 自建节点作为优先出口、订阅节点作为后备，且自建节点已经整理为 HTTP Provider 或订阅 URL 时选择。

Caution

手动维护的自建节点版 Custom_Clash_Selfhosted_Manual_Fallback.yaml 没有对应通用模块。其协议字段和凭据需要自行编辑，详见 ../../cfg/yaml/。

⚙️ 使用方法

不同 OpenClash 版本的菜单名称可能略有差异，基本流程如下：

  1. 先按 Wiki 完成 OpenClash LuCI 设置并备份当前可用配置。
  2. 在 OpenClash 运行状态页点击「覆写模块」，打开覆写编辑器。
  3. 点击模块卡片栏中的「+」，选择通过订阅链接添加。
  4. 从全部模块订阅链接一节复制模块地址，进入模块信息填写步骤。中国大陆网络通常优先使用 jsDelivr 加速链接，GitHub Raw 链接可作备用。
  5. 确认名称、描述和匹配配置，并在模块变量或参数栏填写对应的订阅地址。
  6. 启用模块，保存并应用配置。
  7. 等待模块下载 YAML、写入 Provider 地址并触发 OpenClash 重启。
  8. 检查配置文件、Provider、策略组和日志，完成最终验收。

支持元信息的 OpenClash 版本会根据模块头部的 #!NAME、#!DESC、#!CONFIG、#!CRON 和 #!ENV 自动回填新增表单；旧版本按页面提供的字段手动填写。默认匹配配置为 all，模块订阅定时更新为 off，环境变量会预填参数名。八个单独模块声明 EN_KEY1；8 合 1 声明 EN_KEY1 和默认值为 Custom_Clash 的 EN_KEY2；自建节点 Provider 模块声明 EN_KEY1 和 EN_KEY2，两项订阅地址均需填写。

元信息只在新增模块时回填，刷新已有模块订阅不会自动修改已保存的参数。#!ENV 中的默认值用于填写表单，8 合 1 运行时仍通过 ${EN_KEY2:-Custom_Clash} 处理未设置或为空的 EN_KEY2。#!CRON = off 只关闭模块订阅的定时更新，模块执行时仍按 DOWNLOAD_FILE 获取 YAML。

Warning

模块启用后会下载并覆盖 /etc/openclash/config/ 下的同名 YAML。不要直接在该同名文件中长期保存手动修改，否则下一次执行模块时可能被覆盖。

🔑 参数说明

8 个单独模块

只需填写：

EN_KEY1=https://example.com/subscription

EN_KEY1 会写入 proxy-providers.provider1.url。

8 合 1 模块参数

EN_KEY1=https://example.com/subscription;EN_KEY2=Custom_Clash_Lite_Fallback

EN_KEY2 只允许以下值：

Custom_Clash
Custom_Clash_Fallback
Custom_Clash_Lite
Custom_Clash_Lite_Fallback
Custom_Clash_GFW
Custom_Clash_GFW_Fallback
Custom_Clash_Full
Custom_Clash_Full_Fallback

EN_KEY2 留空时默认调用 Custom_Clash.yaml。

自建节点 Provider 模块

EN_KEY1=https://example.com/airport-subscription;EN_KEY2=https://example.com/selfhost-provider
  • EN_KEY1 写入节点订阅的 provider1.url；
  • EN_KEY2 写入自建节点 selfhost.url。

EN_KEY2 必须是 Mihomo 可识别且可通过 HTTP 获取的节点订阅或 Provider 文件，不能直接填写单条节点 URI。

🔐 隐私与更新行为

  • 订阅地址通常包含访问凭据，截图、导出配置和分享日志前应脱敏。
  • 模块变量保存在本地 OpenClash 环境中；远程模块文件本身不包含订阅地址。
  • 模块每次执行都会获取仓库中的当前 YAML，远程更新可能在下次应用或重启时生效。
  • 需要固定版本时，应自行托管模块和 YAML，或改用手动下载导入。
  • 同时启用多个会切换 CONFIG_FILE 的模块可能相互覆盖，不建议并行启用多个本目录模块。

🔗 全部模块订阅链接

标准版

  • GitHub Raw 链接：

    https://raw.githubusercontent.com/Aethersailor/Custom_OpenClash_Rules/refs/heads/main/overwrite/yaml/Custom_Clash.conf

  • jsDelivr 加速链接：

    https://cdn.jsdelivr.net/gh/Aethersailor/Custom_OpenClash_Rules@main/overwrite/yaml/Custom_Clash.conf

标准故障转移版

  • GitHub Raw 链接：

    https://raw.githubusercontent.com/Aethersailor/Custom_OpenClash_Rules/refs/heads/main/overwrite/yaml/Custom_Clash_Fallback.conf

  • jsDelivr 加速链接：

    https://cdn.jsdelivr.net/gh/Aethersailor/Custom_OpenClash_Rules@main/overwrite/yaml/Custom_Clash_Fallback.conf

轻量版

  • GitHub Raw 链接：

    https://raw.githubusercontent.com/Aethersailor/Custom_OpenClash_Rules/refs/heads/main/overwrite/yaml/Custom_Clash_Lite.conf

  • jsDelivr 加速链接：

    https://cdn.jsdelivr.net/gh/Aethersailor/Custom_OpenClash_Rules@main/overwrite/yaml/Custom_Clash_Lite.conf

轻量故障转移版

  • GitHub Raw 链接：

    https://raw.githubusercontent.com/Aethersailor/Custom_OpenClash_Rules/refs/heads/main/overwrite/yaml/Custom_Clash_Lite_Fallback.conf

  • jsDelivr 加速链接：

    https://cdn.jsdelivr.net/gh/Aethersailor/Custom_OpenClash_Rules@main/overwrite/yaml/Custom_Clash_Lite_Fallback.conf

极简 GFW 版

  • GitHub Raw 链接：

    https://raw.githubusercontent.com/Aethersailor/Custom_OpenClash_Rules/refs/heads/main/overwrite/yaml/Custom_Clash_GFW.conf

  • jsDelivr 加速链接：

    https://cdn.jsdelivr.net/gh/Aethersailor/Custom_OpenClash_Rules@main/overwrite/yaml/Custom_Clash_GFW.conf

极简 GFW 故障转移版

  • GitHub Raw 链接：

    https://raw.githubusercontent.com/Aethersailor/Custom_OpenClash_Rules/refs/heads/main/overwrite/yaml/Custom_Clash_GFW_Fallback.conf

  • jsDelivr 加速链接：

    https://cdn.jsdelivr.net/gh/Aethersailor/Custom_OpenClash_Rules@main/overwrite/yaml/Custom_Clash_GFW_Fallback.conf

重度分流版

  • GitHub Raw 链接：

    https://raw.githubusercontent.com/Aethersailor/Custom_OpenClash_Rules/refs/heads/main/overwrite/yaml/Custom_Clash_Full.conf

  • jsDelivr 加速链接：

    https://cdn.jsdelivr.net/gh/Aethersailor/Custom_OpenClash_Rules@main/overwrite/yaml/Custom_Clash_Full.conf

重度分流故障转移版

  • GitHub Raw 链接：

    https://raw.githubusercontent.com/Aethersailor/Custom_OpenClash_Rules/refs/heads/main/overwrite/yaml/Custom_Clash_Full_Fallback.conf

  • jsDelivr 加速链接：

    https://cdn.jsdelivr.net/gh/Aethersailor/Custom_OpenClash_Rules@main/overwrite/yaml/Custom_Clash_Full_Fallback.conf

8 合 1

  • GitHub Raw 链接：

    https://raw.githubusercontent.com/Aethersailor/Custom_OpenClash_Rules/refs/heads/main/overwrite/yaml/Custom_Clash_8in1.conf

  • jsDelivr 加速链接：

    https://cdn.jsdelivr.net/gh/Aethersailor/Custom_OpenClash_Rules@main/overwrite/yaml/Custom_Clash_8in1.conf

自建节点 Provider 优先版

  • GitHub Raw 链接：

    https://raw.githubusercontent.com/Aethersailor/Custom_OpenClash_Rules/refs/heads/main/overwrite/yaml/Custom_Clash_Selfhosted_Provider_Fallback.conf

  • jsDelivr 加速链接：

    https://cdn.jsdelivr.net/gh/Aethersailor/Custom_OpenClash_Rules@main/overwrite/yaml/Custom_Clash_Selfhosted_Provider_Fallback.conf

✅ 最终验收

应用模块后确认：

  • 模块下载和 Ruby 覆写过程未报告错误；
  • /etc/openclash/config/ 中生成了预期 YAML；
  • Provider URL 已正确写入且更新成功；
  • 策略组、地区分组和规则集正常加载；
  • OpenClash 内核重启成功，DNS、IPv6 和流量接管符合 LuCI 设置；
  • 直连、代理及故障转移行为符合预期；
  • 保留一份已验证配置和模块参数用于回退。

📚 相关文档

建议一次只启用一个本目录模块，并在每次切换后重新验收。