From f03769fc8a510b4583a6ec3c440bf415056cc1a0 Mon Sep 17 00:00:00 2001 From: loyalsoldier <10487845+Loyalsoldier@users.noreply.github.com> Date: Tue, 4 Aug 2020 15:40:11 +0800 Subject: [PATCH] Add README --- README.md | 152 +++++++++++++++++++++++++++++++++++++++++++++++++++++- 1 file changed, 151 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 4b55937..9d73574 100644 --- a/README.md +++ b/README.md @@ -1 +1,151 @@ -# clash-rules \ No newline at end of file +# 简介 + +本项目生成适用于 [**Clash Premium**](https://github.com/Dreamacro/clash/releases/tag/premium) 的规则集（RULE-SET）。使用 GitHub Actions 北京时间每天早上 6:30 自动构建，保证规则最新。 + +## 说明 + +本项目的规则集（RULE-SET）主要来源于项目 [@Loyalsoldier/v2ray-rules-dat](https://github.com/Loyalsoldier/v2ray-rules-dat)；[`Apple`](https://github.com/Loyalsoldier/clash-rules/blob/release/apple.txt) 和 [`Google`](https://github.com/Loyalsoldier/clash-rules/blob/release/google.txt) 列表里的部分域名来源于项目 [@felixonmars/dnsmasq-china-list](https://github.com/felixonmars/dnsmasq-china-list)；中国大陆 IPv4 地址数据使用 [@17mon/china_ip_list](https://github.com/17mon/china_ip_list)。 + +本项目的规则集（RULE-SET）只适用于 Clash **Premium** 版本。Clash Premium 相对于普通版，增加了 **TUN 增强模式**，能接管设备所有 TCP 和 UDP 流量，类似 [Surge for Mac](https://nssurge.com) 的增强模式。更多高级特性请看[官方 wiki](https://github.com/Dreamacro/clash/wiki/premium-core-features)。 + +### Clash 各版本下载地址 + +- Clash Premium **命令行**版（兼容 Windows、macOS、Linux、OpenWRT 等多种平台）：[https://github.com/Dreamacro/clash/releases/tag/premium](https://github.com/Dreamacro/clash/releases/tag/premium) +- Clash Premium **图形用户界面**版（ClashX Pro，兼容 macOS）：[https://install.appcenter.ms/users/clashx/apps/clashx-pro/distribution_groups/public](https://install.appcenter.ms/users/clashx/apps/clashx-pro/distribution_groups/public) +- Clash Premium **图形用户界面**版（Clash for Windows，兼容 Windows、macOS）：[https://github.com/Fndroid/clash_for_windows_pkg/releases](https://github.com/Fndroid/clash_for_windows_pkg/releases) + +## 规则文件地址及使用方式 + +### 在线地址（URL） + +> 如果无法访问域名 `raw.githubusercontent.com`，可以使用第二个地址（`cdn.jsdelivr.net`），但是内容更新会有 12 小时的延迟。以下地址填写在 Clash 配置文件里的 `rule-providers` 里的 `url` 配置项中。 + +- **直连域名列表 direct.txt**： + - [https://raw.githubusercontent.com/Loyalsoldier/clash-rules/release/direct.txt](https://raw.githubusercontent.com/Loyalsoldier/clash-rules/release/direct.txt) + - [https://cdn.jsdelivr.net/gh/Loyalsoldier/clash-rules@release/direct.txt](https://cdn.jsdelivr.net/gh/Loyalsoldier/clash-rules@release/direct.txt) +- **代理域名列表 proxy.txt**： + - [https://raw.githubusercontent.com/Loyalsoldier/clash-rules/release/proxy.txt](https://raw.githubusercontent.com/Loyalsoldier/clash-rules/release/proxy.txt) + - [https://cdn.jsdelivr.net/gh/Loyalsoldier/clash-rules@release/proxy.txt](https://cdn.jsdelivr.net/gh/Loyalsoldier/clash-rules@release/proxy.txt) +- **广告域名列表 reject.txt**： + - [https://raw.githubusercontent.com/Loyalsoldier/clash-rules/release/reject.txt](https://raw.githubusercontent.com/Loyalsoldier/clash-rules/release/reject.txt) + - [https://cdn.jsdelivr.net/gh/Loyalsoldier/clash-rules@release/reject.txt](https://cdn.jsdelivr.net/gh/Loyalsoldier/clash-rules@release/reject.txt) +- **Apple 域名列表 apple.txt**： + - [https://raw.githubusercontent.com/Loyalsoldier/clash-rules/release/apple.txt](https://raw.githubusercontent.com/Loyalsoldier/clash-rules/release/apple.txt) + - [https://cdn.jsdelivr.net/gh/Loyalsoldier/clash-rules@release/apple.txt](https://cdn.jsdelivr.net/gh/Loyalsoldier/clash-rules@release/apple.txt) +- **iCloud 域名列表 icloud.txt**： + - [https://raw.githubusercontent.com/Loyalsoldier/clash-rules/release/icloud.txt](https://raw.githubusercontent.com/Loyalsoldier/clash-rules/release/icloud.txt) + - [https://cdn.jsdelivr.net/gh/Loyalsoldier/clash-rules@release/icloud.txt](https://cdn.jsdelivr.net/gh/Loyalsoldier/clash-rules@release/icloud.txt) +- **Google 域名列表 google.txt**： + - [https://raw.githubusercontent.com/Loyalsoldier/clash-rules/release/google.txt](https://raw.githubusercontent.com/Loyalsoldier/clash-rules/release/google.txt) + - [https://cdn.jsdelivr.net/gh/Loyalsoldier/clash-rules@release/google.txt](https://cdn.jsdelivr.net/gh/Loyalsoldier/clash-rules@release/google.txt) +- **局域网 IP 及保留 IP 地址列表 lancidr.txt**： + - [https://raw.githubusercontent.com/Loyalsoldier/clash-rules/release/lancidr.txt](https://raw.githubusercontent.com/Loyalsoldier/clash-rules/release/lancidr.txt) + - [https://cdn.jsdelivr.net/gh/Loyalsoldier/clash-rules@release/lancidr.txt](https://cdn.jsdelivr.net/gh/Loyalsoldier/clash-rules@release/lancidr.txt) +- **中国大陆 IPv4 地址列表 cncidr.txt**： + - [https://raw.githubusercontent.com/Loyalsoldier/clash-rules/release/cncidr.txt](https://raw.githubusercontent.com/Loyalsoldier/clash-rules/release/cncidr.txt) + - [https://cdn.jsdelivr.net/gh/Loyalsoldier/clash-rules@release/cncidr.txt](https://cdn.jsdelivr.net/gh/Loyalsoldier/clash-rules@release/cncidr.txt) + +### 使用方式 + +关于 Clash Premium 使用方式，请查看[官方文档](https://github.com/Dreamacro/clash/wiki/premium-core-features) 或 [Lancellc's GitBook](https://lancellc.gitbook.io/clash/)。 + +要想使用本项目的规则集，只需要在 Clash 配置文件中添加如下 `rule-providers` 和 `rules`。 + +#### Rule Providers 配置方式 + +```yaml +rule-providers: + reject: + type: http + behavior: domain + url: "https://raw.githubusercontent.com/Loyalsoldier/clash-rules/release/reject.txt" + path: ./ruleset/reject.yaml + interval: 86400 + + icloud: + type: http + behavior: domain + url: "https://raw.githubusercontent.com/Loyalsoldier/clash-rules/release/icloud.txt" + path: ./ruleset/icloud.yaml + interval: 86400 + + apple: + type: http + behavior: domain + url: "https://raw.githubusercontent.com/Loyalsoldier/clash-rules/release/apple.txt" + path: ./ruleset/apple.yaml + interval: 86400 + + google: + type: http + behavior: domain + url: "https://raw.githubusercontent.com/Loyalsoldier/clash-rules/release/google.txt" + path: ./ruleset/google.yaml + interval: 86400 + + proxy: + type: http + behavior: domain + url: "https://raw.githubusercontent.com/Loyalsoldier/clash-rules/release/proxy.txt" + path: ./ruleset/proxy.yaml + interval: 86400 + + direct: + type: http + behavior: domain + url: "https://raw.githubusercontent.com/Loyalsoldier/clash-rules/release/direct.txt" + path: ./ruleset/direct.yaml + interval: 86400 + + cncidr: + type: http + behavior: ipcidr + url: "https://raw.githubusercontent.com/Loyalsoldier/clash-rules/release/cncidr.txt" + path: ./ruleset/cncidr.yaml + interval: 86400 + + lancidr: + type: http + behavior: ipcidr + url: "https://raw.githubusercontent.com/Loyalsoldier/clash-rules/release/lancidr.txt" + path: ./ruleset/lancidr.yaml + interval: 86400 +``` + +#### Rules 配置方式 + +- 以下配置中的 `PROCESS-NAME` 规则类型**只能**在 **ClashX Pro** 中使用，其余版本均不能使用，需要手动删除。 +- 如果希望使用 DNS 来解析未命中 RULE-SET 中域名类型规则的域名，而不是直接走代理，请删除 `cncidr` 行尾的 `,no-resolve`。 +- 以下配置中，除了 `DIRECT` 和 `REJECT` 是默认存在于 Clash 中的 policy（路由策略/流量处理策略），其余均为自定义 policy，对应配置文件中 `proxies` 或 `proxy-groups` 中的 `name`。如你直接使用下面的 `rules` 规则，则需要在 `proxies` 或 `proxy-groups` 中手动配置一个 `name` 为 `PROXY` 的 policy。 +- 如你希望 Apple、iCloud 和 Google 列表中的域名使用代理，则把 policy 由 `DIRECT` 改为 `PROXY`，以此类推，举一反三。 + +```yaml +rules: + - PROCESS-NAME,v2ray,DIRECT + - PROCESS-NAME,ss-local,DIRECT + - PROCESS-NAME,privoxy,DIRECT + - PROCESS-NAME,trojan,DIRECT + - PROCESS-NAME,trojan-go,DIRECT + - PROCESS-NAME,naive,DIRECT + - PROCESS-NAME,Thunder,DIRECT + - PROCESS-NAME,DownloadService,DIRECT + - PROCESS-NAME,qbittorrent,DIRECT + - PROCESS-NAME,Transmission,DIRECT + - RULE-SET,reject,REJECT + - RULE-SET,icloud,DIRECT + - RULE-SET,apple,DIRECT + - RULE-SET,google,DIRECT + - RULE-SET,proxy,PROXY + - RULE-SET,direct,DIRECT + - RULE-SET,lancidr,DIRECT,no-resolve + - RULE-SET,cncidr,DIRECT,no-resolve + - GEOIP,CN,DIRECT + - MATCH,PROXY +``` + +## 致谢 + +- [@Loyalsoldier/v2ray-rules-dat](https://github.com/Loyalsoldier/v2ray-rules-dat) +- [@v2fly/domain-list-community](https://github.com/v2fly/domain-list-community) +- [@felixonmars/dnsmasq-china-list](https://github.com/felixonmars/dnsmasq-china-list) +- [@17mon/china_ip_list](https://github.com/17mon/china_ip_list)