The universal proxy platform.
https://community.sagernet.org/c/sing-box/
Copyright (C) 2022 by nekohasekai <contact-sagernet@sekai.icu>
This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program. If not, see <http://www.gnu.org/licenses/>.
In addition, no derivative work may use the name or imply association
with this application without prior consent.
- 编译时需要使用
with_proxyprovidertag
{
"proxyproviders": [
{
"tag": "proxy-provider-x", // 标签，必填，用于区别不同的 proxy-provider，不可重复，设置后outbounds会暴露一个同名的selector出站
"url": "", // 订阅链接，必填，支持Clash订阅链接，支持普通分享链接，支持Sing-box订阅链接
"cache_file": "/tmp/proxy-provider-x.cache", // 缓存文件，选填，强烈建议填写，可以加快启动速度
"update_interval": "4h", // 更新间隔，选填，仅填写 cache_file 有效，若当前缓存文件已经超过该时间，将会进行后台自动更新
"request_timeout": "10s", // 请求超时时间
"use_h3": false, // 使用 HTTP/3 请求订阅
"dns": "tls://223.5.5.5", // 使用自定义 DNS 请求订阅域名
"tag_format": "proxy-provider - %s", // 如果有多个订阅并且订阅间存在重名节点，可以尝试使用，其中 %s 为占位符，会被替换为原节点名。比如：原节点名："HongKong 01"，tag_format设置为 "PP - %s"，替换后新节点名会更变为 "PP - HongKong 01"，以解决节点名冲突的问题
"global_filter": {
"white_mode": true, // 白名单模式，匹配的节点会被保留，不匹配的节点会被删除
"rules": [], // 规则，详情见下文
},
// 规则
// 1. Golang 正则表达式 (example: Node) ==> 匹配 Tag (匹配 Node)
// 2. tag:Golang 正则表达式 (example: tag:Node) ==> 匹配 Tag (匹配 Node)
// 3. type:Golang 正则表达式 (example: type:vmess) ==> 匹配 Type (节点类型) (匹配 vmess)
// 4. server:Golang 正则表达式 (example: server:1.1.1.1) ==> 匹配 Server (节点服务器地址，不含端口) (匹配 1.1.1.1)
// 5. 若设置 tag_format 则匹配的是替换前的节点名
//
"lookup_ip": false, // 是否查询 IP 地址，覆盖节点地址，需要设置 dns 字段
"download_ua": "clash.meta", // 更新订阅时使用的 User-Agent
"dialer": {}, // 附加在节点 outbound 配置的 Dial 字段
"request_dialer": {}, // 请求时使用的 Dial 字段配置，detour 字段无效
"running_detour": "", // 运行时后台自动更新所使用的 outbound
"groups": [ // 自定义分组
{
"tag": "", // outbound tag，必填
"type": "selector", // outbound 类型，必填，仅支持selector, urltest
"filter": {}, // 节点过滤规则，选填，详见上global_filter字段
... Selector 或 URLTest 其他字段配置
}
]
}
]
}tcp://1.1.1.1
tcp://1.1.1.1:53
tcp://[2606:4700:4700::1111]
tcp://[2606:4700:4700::1111]:53
udp://1.1.1.1
udp://1.1.1.1:53
udp://[2606:4700:4700::1111]
udp://[2606:4700:4700::1111]:53
tls://1.1.1.1
tls://1.1.1.1:853
tls://[2606:4700:4700::1111]
tls://[2606:4700:4700::1111]:853
tls://1.1.1.1/?sni=cloudflare-dns.com
tls://1.1.1.1:853/?sni=cloudflare-dns.com
tls://[2606:4700:4700::1111]/?sni=cloudflare-dns.com
tls://[2606:4700:4700::1111]:853/?sni=cloudflare-dns.com
https://1.1.1.1
https://1.1.1.1:443/dns-query
https://[2606:4700:4700::1111]
https://[2606:4700:4700::1111]:443
https://1.1.1.1/dns-query?sni=cloudflare-dns.com
https://1.1.1.1:443/dns-query?sni=cloudflare-dns.com
https://[2606:4700:4700::1111]/dns-query?sni=cloudflare-dns.com
https://[2606:4700:4700::1111]:443/dns-query?sni=cloudflare-dns.com
1.1.1.1 => udp://1.1.1.1:53
1.1.1.1:53 => udp://1.1.1.1:53
[2606:4700:4700::1111] => udp://[2606:4700:4700::1111]:53
[2606:4700:4700::1111]:53 => udp://[2606:4700:4700::1111]:53
{
"proxyproviders": [
{
"tag": "proxy-provider",
"url": "你的订阅链接",
"cache_file": "缓存文件路径",
"dns": "tcp://223.5.5.5",
"update_interval": "4h", // 自动更新缓存
"request_timeout": "10s" // 请求超时时间
}
]
}- 编译时需要使用
with_ruleprovidertag
{
"ruleproviders": [
{
"tag": "rule-provider-x", // 标签，必填，用于区别不同的 rule-provider，不可重复
"url": "", // 规则订阅链接，必填，仅支持Clash订阅规则
"behavior": "", // 规则类型，必填，可选 domain / ipcidr / classical
"format": "", // 规则格式，选填，可选 yaml / text，默认 yaml
"use_h3": false, // 使用 HTTP/3 请求规则订阅
"cache_file": "/tmp/rule-provider-x.cache", // 缓存文件，选填，强烈建议填写，可以加快启动速度
"update_interval": "4h", // 更新间隔，选填，仅填写 cache_file 有效，若当前缓存文件已经超过该时间，将会进行后台自动更新
"request_timeout": "10s", // 请求超时时间
"dns": "tls://223.5.5.5", // 使用自定义 DNS 请求订阅域名，格式与 proxyprovider 相同
"request_dialer": {}, // 请求时使用的 Dial 字段配置，detour 字段无效
"running_detour": "" // 运行时后台自动更新所使用的 outbound
}
]
}用于 Route Rule 或者 DNS Rule
假设规则有以下内容：
payload:
- '+.google.com'
- '+.github.com'{
"dns": {
"rules": [
{
"@rule_provider": "rule-provider-x",
"server": "proxy-dns"
}
]
},
"route": {
"rules": [
{
"@rule_provider": "rule-provider-x",
"outbound": "proxy-out"
}
]
}
}等效于
{
"dns": {
"rules": [
{
"domain_suffix": [
".google.com",
".github.com"
],
"server": "proxy-dns"
}
]
},
"route": {
"rules": [
{
"domain_suffix": [
".google.com",
".github.com"
],
"outbound": "proxy-out"
}
]
}
}- 由于 sing-box 规则支持与 Clash 可能不同，某些无法在 sing-box 上使用的规则会被自动忽略，请注意
- 不支持 logical 规则，由于规则数目可能非常庞大，设置多个 @rule_provider 靶点可能会导致内存飙升和性能问题（笛卡儿积）
- DNS Rule 不支持某些类型，如：GeoIP IP-CIDR IP-CIDR6，这是因为 sing-box 程序逻辑所决定的
- 目前支持的 Clash 规则类型：
Clash 类型 ==> 对于的 sing-box 配置
DOMAIN ==> domain
DOMAIN-SUFFIX ==> domain_suffix
DOMAIN-KEYWORD ==> domain_keyword
GEOSITE ==> geosite
GEOIP ==> geoip
IP-CIDR ==> ip_cidr
IP-CIDR6 ==> ip_cidr
SRC-IP-CIDR ==> source_ip_cidr
SRC-PORT ==> source_port
DST-PORT ==> port
PROCESS-NAME ==> process_name
PROCESS-PATH ==> process_path
NETWORK ==> network
{
"outbounds": [
{
"tag": "tor-out",
"type": "tor",
"no_fatal": true // 启动时将 tor outbound 启动置于后台，加快启动速度，但启动失败会导致无法使用
}
]
}- 编译时需要使用
with_clash_dashboardtag - 编译前需要先初始化 web 文件
使用 yacd 作为 Clash Dashboard：make init_yacd
使用 metacubexd 作为 Clash Dashboard：make init_metacubexd
清除 web 文件：make clean_clash_dashboard
{
"experimental": {
"clash_api": {
"external_controller": "0.0.0.0:9090",
//"external_ui": "" // 无需填写
"external_ui_buildin": true // 启用内置 Clash Dashboard
}
}
}{
"route": {
"geosite": {
"path": "/temp/geosite.db",
"auto_update_interval": "12h" // 更新间隔，在程序运行时会间隔时间自动更新
},
"geoip": {
"path": "/temp/geoip.db",
"auto_update_interval": "12h"
}
}
}- 支持在 Clash API 中调用 API 更新 Geo Resource
JSTest 出站允许用户根据 JS 脚本代码选择出站，依附 JS 脚本，用户可以自定义强大的出站选择逻辑，比如：送中节点规避，流媒体节点选择，等等。
你可以在 jstest/javascript/ 目录下找到一些示例脚本。
-
编译时需要使用
with_jstesttag -
JS 脚本请自行测试，慎而又慎，不要随意使用不明脚本，可能会导致安全问题或预期外的问题
-
JS 脚本运行需要依赖 JS 虚拟机，内存占用可能会比较大（10-20M 左右，视脚本而定），建议使用时注意内存占用情况
-
专门告知使用送中节点的脚本的用户：请确保 Google 定位已经正常关闭，否则运行该脚本可能会导致上游节点全部送中，
尤其是机场用户，运行所造成的一切后果概不负责
{
"outbounds": [
{
"tag": "google-cn-auto-switch",
"type": "jstest",
"js_path": "/etc/sing-box/google_cn.js", // JS 脚本路径
"js_base64": "", // JS 脚本 Base64 编码，若遇到某些存储脚本文件困难的情况，如：使用了移动客户端，可以使用该字段
"interval": "60s", // 脚本执行间隔
"interrupt_exist_connections": false // 切换时是否中断已有连接
}
]
}Script 脚本允许用户在程序运行时执行脚本，可以用于自定义一些功能。
- 编译时需要使用
with_scripttag
{
"scripts": [
{
"tag": "script-x", // 标签，必填，用于区别不同的 script，不可重复
"command": "/path/to/script", // 脚本命令，必填，绝对路径
"args": [], // 脚本参数，选填
"directory": "/path/to/directory", // 脚本工作目录，选填，绝对路径
"mode": "pre-start", // 运行模式，必填，可选列表如下
"no_fatal": false, // 忽略脚本是否运行失败，若是运行在整个程序生命周期的脚本，则会在启动失败时退出，会在运行异常退出时程序不强制退出
"env": { // 环境变量，选填
"foo": "bar"
},
"log": {
"enabled": false, // 是否启用日志，选填，默认 false
"stdout_log_level": "info", // stdout 日志等级，选填，可选：trace，debug，info，warn，error，fatal，panic，默认 info
"stderr_log_level": "error", // stderr 日志等级，选填，可选：trace，debug，info，warn，error，fatal，panic，默认 error
}
}
]
}1. pre-start // 在启动其他服务前运行脚本
2. pre-start-service-pre-close // 运行的脚本会持续整个程序的生命周期，在启动其他服务前运行，且在关闭其他服务前停止
3. pre-start-service-post-close // 运行的脚本会持续整个程序的生命周期，在启动其他服务前运行，且在关闭其他服务后停止
4. post-start // 在启动其他服务后运行脚本
5. post-start-service-pre-close // 运行的脚本会持续整个程序的生命周期，在启动其他服务后运行，且在关闭其他服务前停止
6. post-start-service-post-close // 运行的脚本会持续整个程序的生命周期，在启动其他服务后运行，且在关闭其他服务后停止
7. pre-close // 在关闭其他服务前运行脚本
8. post-close // 在关闭其他服务后运行脚本