mirror of
https://github.com/SagerNet/sing-box.git
synced 2024-11-24 17:41:29 +00:00
496 lines
11 KiB
Markdown
496 lines
11 KiB
Markdown
---
|
|
icon: material/arrange-bring-forward
|
|
---
|
|
|
|
## 1.11.0
|
|
|
|
### Migrate legacy special outbounds to rule actions
|
|
|
|
Legacy special outbounds are deprecated and can be replaced by rule actions.
|
|
|
|
!!! info "References"
|
|
|
|
[Rule Action](/configuration/route/rule_action/) /
|
|
[Block](/configuration/outbound/block/) /
|
|
[DNS](/configuration/outbound/dns)
|
|
|
|
=== "Block"
|
|
|
|
=== ":material-card-remove: Deprecated"
|
|
|
|
```json
|
|
{
|
|
"outbounds": [
|
|
{
|
|
"type": "block",
|
|
"tag": "block"
|
|
}
|
|
],
|
|
"route": {
|
|
"rules": [
|
|
{
|
|
...,
|
|
|
|
"outbound": "block"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
```
|
|
|
|
=== ":material-card-multiple: New"
|
|
|
|
```json
|
|
{
|
|
"route": {
|
|
"rules": [
|
|
{
|
|
...,
|
|
|
|
"action": "reject"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
```
|
|
|
|
=== "DNS"
|
|
|
|
=== ":material-card-remove: Deprecated"
|
|
|
|
```json
|
|
{
|
|
"inbound": [
|
|
{
|
|
...,
|
|
|
|
"sniff": true
|
|
}
|
|
],
|
|
"outbounds": [
|
|
{
|
|
"tag": "dns",
|
|
"type": "dns"
|
|
}
|
|
],
|
|
"route": {
|
|
"rules": [
|
|
{
|
|
"protocol": "dns",
|
|
"outbound": "dns"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
```
|
|
|
|
=== ":material-card-multiple: New"
|
|
|
|
```json
|
|
{
|
|
"route": {
|
|
"rules": [
|
|
{
|
|
"action": "sniff"
|
|
},
|
|
{
|
|
"protocol": "dns",
|
|
"action": "hijack-dns"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
```
|
|
|
|
### Migrate legacy inbound fields to rule actions
|
|
|
|
Inbound fields are deprecated and can be replaced by rule actions.
|
|
|
|
!!! info "References"
|
|
|
|
[Listen Fields](/configuration/inbound/listen/) /
|
|
[Rule](/configuration/route/rule/) /
|
|
[Rule Action](/configuration/route/rule_action/) /
|
|
[DNS Rule](/configuration/dns/rule/) /
|
|
[DNS Rule Action](/configuration/dns/rule_action/)
|
|
|
|
=== ":material-card-remove: Deprecated"
|
|
|
|
```json
|
|
{
|
|
"inbounds": [
|
|
{
|
|
"type": "mixed",
|
|
"sniff": true,
|
|
"sniff_timeout": "1s",
|
|
"domain_strategy": "prefer_ipv4"
|
|
}
|
|
]
|
|
}
|
|
```
|
|
|
|
=== ":material-card-multiple: New"
|
|
|
|
```json
|
|
{
|
|
"inbounds": [
|
|
{
|
|
"type": "mixed",
|
|
"tag": "in"
|
|
}
|
|
],
|
|
"route": {
|
|
"rules": [
|
|
{
|
|
"inbound": "in",
|
|
"action": "resolve",
|
|
"strategy": "prefer_ipv4"
|
|
},
|
|
{
|
|
"inbound": "in",
|
|
"action": "sniff",
|
|
"timeout": "1s"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
```
|
|
|
|
### Migrate legacy DNS route options to rule actions
|
|
|
|
Legacy DNS route options are deprecated and can be replaced by rule actions.
|
|
|
|
!!! info "References"
|
|
|
|
[DNS Rule](/configuration/dns/rule/) /
|
|
[DNS Rule Action](/configuration/dns/rule_action/)
|
|
|
|
=== ":material-card-remove: Deprecated"
|
|
|
|
```json
|
|
{
|
|
"dns": {
|
|
"rules": [
|
|
{
|
|
...,
|
|
|
|
"server": "local",
|
|
"disable_cache": true,
|
|
"rewrite_ttl": 600,
|
|
"client_subnet": "1.1.1.1/24"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
```
|
|
|
|
=== ":material-card-multiple: New"
|
|
|
|
```json
|
|
{
|
|
"dns": {
|
|
"rules": [
|
|
{
|
|
...,
|
|
|
|
"action": "route-options",
|
|
"disable_cache": true,
|
|
"rewrite_ttl": 600,
|
|
"client_subnet": "1.1.1.1/24"
|
|
},
|
|
{
|
|
...,
|
|
|
|
"server": "local"
|
|
}
|
|
]
|
|
}
|
|
}
|
|
```
|
|
|
|
## 1.10.0
|
|
|
|
### TUN address fields are merged
|
|
|
|
`inet4_address` and `inet6_address` are merged into `address`,
|
|
`inet4_route_address` and `inet6_route_address` are merged into `route_address`,
|
|
`inet4_route_exclude_address` and `inet6_route_exclude_address` are merged into `route_exclude_address`.
|
|
|
|
!!! info "References"
|
|
|
|
[TUN](/configuration/inbound/tun/)
|
|
|
|
=== ":material-card-remove: Deprecated"
|
|
|
|
```json
|
|
{
|
|
"inbounds": [
|
|
{
|
|
"type": "tun",
|
|
"inet4_address": "172.19.0.1/30",
|
|
"inet6_address": "fdfe:dcba:9876::1/126",
|
|
"inet4_route_address": [
|
|
"0.0.0.0/1",
|
|
"128.0.0.0/1"
|
|
],
|
|
"inet6_route_address": [
|
|
"::/1",
|
|
"8000::/1"
|
|
],
|
|
"inet4_route_exclude_address": [
|
|
"192.168.0.0/16"
|
|
],
|
|
"inet6_route_exclude_address": [
|
|
"fc00::/7"
|
|
]
|
|
}
|
|
]
|
|
}
|
|
```
|
|
|
|
=== ":material-card-multiple: New"
|
|
|
|
```json
|
|
{
|
|
"inbounds": [
|
|
{
|
|
"type": "tun",
|
|
"address": [
|
|
"172.19.0.1/30",
|
|
"fdfe:dcba:9876::1/126"
|
|
],
|
|
"route_address": [
|
|
"0.0.0.0/1",
|
|
"128.0.0.0/1",
|
|
"::/1",
|
|
"8000::/1"
|
|
],
|
|
"route_exclude_address": [
|
|
"192.168.0.0/16",
|
|
"fc00::/7"
|
|
]
|
|
}
|
|
]
|
|
}
|
|
```
|
|
|
|
## 1.9.5
|
|
|
|
### Bundle Identifier updates in Apple platform clients
|
|
|
|
Due to problems with our old Apple developer account,
|
|
we can only change Bundle Identifiers to re-list sing-box apps,
|
|
which means the data will not be automatically inherited.
|
|
|
|
For iOS, you need to back up your old data yourself (if you still have access to it);
|
|
for tvOS, you need to re-import profiles from your iPhone or iPad or create it manually;
|
|
for macOS, you can migrate the data folder using the following command:
|
|
|
|
```bash
|
|
cd ~/Library/Group\ Containers && \
|
|
mv group.io.nekohasekai.sfa group.io.nekohasekai.sfavt
|
|
```
|
|
|
|
## 1.9.0
|
|
|
|
### `domain_suffix` behavior update
|
|
|
|
For historical reasons, sing-box's `domain_suffix` rule matches literal prefixes instead of the same as other projects.
|
|
|
|
sing-box 1.9.0 modifies the behavior of `domain_suffix`: If the rule value is prefixed with `.`,
|
|
the behavior is unchanged, otherwise it matches `(domain|.+\.domain)` instead.
|
|
|
|
### `process_path` format update on Windows
|
|
|
|
The `process_path` rule of sing-box is inherited from Clash,
|
|
the original code uses the local system's path format (e.g. `\Device\HarddiskVolume1\folder\program.exe`),
|
|
but when the device has multiple disks, the HarddiskVolume serial number is not stable.
|
|
|
|
sing-box 1.9.0 make QueryFullProcessImageNameW output a Win32 path (such as `C:\folder\program.exe`),
|
|
which will disrupt the existing `process_path` use cases in Windows.
|
|
|
|
## 1.8.0
|
|
|
|
### :material-close-box: Migrate cache file from Clash API to independent options
|
|
|
|
!!! info "References"
|
|
|
|
[Clash API](/configuration/experimental/clash-api/) /
|
|
[Cache File](/configuration/experimental/cache-file/)
|
|
|
|
=== ":material-card-remove: Deprecated"
|
|
|
|
```json
|
|
{
|
|
"experimental": {
|
|
"clash_api": {
|
|
"cache_file": "cache.db", // default value
|
|
"cahce_id": "my_profile2",
|
|
"store_mode": true,
|
|
"store_selected": true,
|
|
"store_fakeip": true
|
|
}
|
|
}
|
|
}
|
|
```
|
|
|
|
=== ":material-card-multiple: New"
|
|
|
|
```json
|
|
{
|
|
"experimental" : {
|
|
"cache_file": {
|
|
"enabled": true,
|
|
"path": "cache.db", // default value
|
|
"cache_id": "my_profile2",
|
|
"store_fakeip": true
|
|
}
|
|
}
|
|
}
|
|
```
|
|
|
|
### :material-checkbox-intermediate: Migrate GeoIP to rule-sets
|
|
|
|
!!! info "References"
|
|
|
|
[GeoIP](/configuration/route/geoip/) /
|
|
[Route](/configuration/route/) /
|
|
[Route Rule](/configuration/route/rule/) /
|
|
[DNS Rule](/configuration/dns/rule/) /
|
|
[rule-set](/configuration/rule-set/)
|
|
|
|
!!! tip
|
|
|
|
`sing-box geoip` commands can help you convert custom GeoIP into rule-sets.
|
|
|
|
=== ":material-card-remove: Deprecated"
|
|
|
|
```json
|
|
{
|
|
"route": {
|
|
"rules": [
|
|
{
|
|
"geoip": "private",
|
|
"outbound": "direct"
|
|
},
|
|
{
|
|
"geoip": "cn",
|
|
"outbound": "direct"
|
|
},
|
|
{
|
|
"source_geoip": "cn",
|
|
"outbound": "block"
|
|
}
|
|
],
|
|
"geoip": {
|
|
"download_detour": "proxy"
|
|
}
|
|
}
|
|
}
|
|
```
|
|
|
|
=== ":material-card-multiple: New"
|
|
|
|
```json
|
|
{
|
|
"route": {
|
|
"rules": [
|
|
{
|
|
"ip_is_private": true,
|
|
"outbound": "direct"
|
|
},
|
|
{
|
|
"rule_set": "geoip-cn",
|
|
"outbound": "direct"
|
|
},
|
|
{
|
|
"rule_set": "geoip-us",
|
|
"rule_set_ipcidr_match_source": true,
|
|
"outbound": "block"
|
|
}
|
|
],
|
|
"rule_set": [
|
|
{
|
|
"tag": "geoip-cn",
|
|
"type": "remote",
|
|
"format": "binary",
|
|
"url": "https://raw.githubusercontent.com/SagerNet/sing-geoip/rule-set/geoip-cn.srs",
|
|
"download_detour": "proxy"
|
|
},
|
|
{
|
|
"tag": "geoip-us",
|
|
"type": "remote",
|
|
"format": "binary",
|
|
"url": "https://raw.githubusercontent.com/SagerNet/sing-geoip/rule-set/geoip-us.srs",
|
|
"download_detour": "proxy"
|
|
}
|
|
]
|
|
},
|
|
"experimental": {
|
|
"cache_file": {
|
|
"enabled": true // required to save rule-set cache
|
|
}
|
|
}
|
|
}
|
|
```
|
|
|
|
### :material-checkbox-intermediate: Migrate Geosite to rule-sets
|
|
|
|
!!! info "References"
|
|
|
|
[Geosite](/configuration/route/geosite/) /
|
|
[Route](/configuration/route/) /
|
|
[Route Rule](/configuration/route/rule/) /
|
|
[DNS Rule](/configuration/dns/rule/) /
|
|
[rule-set](/configuration/rule-set/)
|
|
|
|
!!! tip
|
|
|
|
`sing-box geosite` commands can help you convert custom Geosite into rule-sets.
|
|
|
|
=== ":material-card-remove: Deprecated"
|
|
|
|
```json
|
|
{
|
|
"route": {
|
|
"rules": [
|
|
{
|
|
"geosite": "cn",
|
|
"outbound": "direct"
|
|
}
|
|
],
|
|
"geosite": {
|
|
"download_detour": "proxy"
|
|
}
|
|
}
|
|
}
|
|
```
|
|
|
|
=== ":material-card-multiple: New"
|
|
|
|
```json
|
|
{
|
|
"route": {
|
|
"rules": [
|
|
{
|
|
"rule_set": "geosite-cn",
|
|
"outbound": "direct"
|
|
}
|
|
],
|
|
"rule_set": [
|
|
{
|
|
"tag": "geosite-cn",
|
|
"type": "remote",
|
|
"format": "binary",
|
|
"url": "https://raw.githubusercontent.com/SagerNet/sing-geosite/rule-set/geosite-cn.srs",
|
|
"download_detour": "proxy"
|
|
}
|
|
]
|
|
},
|
|
"experimental": {
|
|
"cache_file": {
|
|
"enabled": true // required to save rule-set cache
|
|
}
|
|
}
|
|
}
|
|
``` |