black-internet-days-ahead/sing-box
1
0
Fork 0
mirror of https://github.com/SagerNet/sing-box.git synced 2024-11-21 16:11:32 +00:00
Code Issues Packages Projects Releases Wiki Activity

documentation: Add override destination to route options

Browse source
This commit is contained in:
世界 2024-11-15 13:33:35 +08:00
parent ac847e1f63
commit 479a57a81a
No known key found for this signature in database
GPG key ID: CD109927C34A63C4
10 changed files with 194 additions and 72 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

9
docs/configuration/dns/index.md
View file

@ -1,16 +1,11 @@
--- ---
icon: material/new icon: material/new-box
--- ---
!!! quote "Changes in sing-box 1.11.0" !!! quote "Changes in sing-box 1.11.0"
:material-plus: [cache_capacity](#cache_capacity) :material-plus: [cache_capacity](#cache_capacity)
!!! quote "Changes in sing-box 1.9.0"
:material-plus: [client_subnet](#client_subnet)
# DNS # DNS
### Structure ### Structure
@ -70,7 +65,7 @@ Make each DNS server's cache independent for special purposes. If enabled, will
#### cache_capacity #### cache_capacity
!!! quote "Since sing-box 1.11.0" !!! question "Since sing-box 1.11.0"
LRU cache capacity. LRU cache capacity.

10
docs/configuration/dns/index.zh.md
View file

@ -1,15 +1,11 @@
--- ---
icon: material/new icon: material/new-box
--- ---
!!! quote "自 sing-box 1.11.0 起" !!! quote "sing-box 1.11.0 中的更改"
:material-plus: [cache_capacity](#cache_capacity) :material-plus: [cache_capacity](#cache_capacity)
!!! quote "自 sing-box 1.9.0 起"
:material-plus: [client_subnet](#client_subnet)
# DNS # DNS
### 结构 ### 结构
@ -68,7 +64,7 @@ icon: material/new
#### cache_capacity #### cache_capacity
!!! quote "自 sing-box 1.11.0 起" !!! question "自 sing-box 1.11.0 起"
LRU 缓存容量。 LRU 缓存容量。

22
docs/configuration/outbound/direct.md
View file

@ -1,3 +1,12 @@
---
icon: material/alert-decagram
---
!!! quote "Changes in sing-box 1.11.0"
:material-alert-decagram: [override_address](#override_address)
:material-alert-decagram: [override_port](#override_port)
`direct` outbound send requests directly. `direct` outbound send requests directly.
### Structure ### Structure
@ -9,7 +18,6 @@
"override_address": "1.0.0.1", "override_address": "1.0.0.1",
"override_port": 53, "override_port": 53,
"proxy_protocol": 0,
... // Dial Fields ... // Dial Fields
} }
@ -19,16 +27,20 @@
#### override_address #### override_address
!!! failure "Deprecated in sing-box 1.11.0"
Destination override fields are deprecated in sing-box 1.11.0 and will be removed in sing-box 1.13.0, see [Migration](/migration/#migrate-destination-override-fields-to-route-options).
Override the connection destination address. Override the connection destination address.
#### override_port #### override_port
!!! failure "Deprecated in sing-box 1.11.0"
Destination override fields are deprecated in sing-box 1.11.0 and will be removed in sing-box 1.13.0, see [Migration](/migration/#migrate-destination-override-fields-to-route-options).
Override the connection destination port. Override the connection destination port.
#### proxy_protocol
Write [Proxy Protocol](https://www.haproxy.org/download/1.8/doc/proxy-protocol.txt) in the connection header.
Protocol value can be `1` or `2`. Protocol value can be `1` or `2`.
### Dial Fields ### Dial Fields

24
docs/configuration/outbound/direct.zh.md
View file

@ -1,3 +1,12 @@
---
icon: material/alert-decagram
---
!!! quote "sing-box 1.11.0 中的更改"
:material-alert-decagram: [override_address](#override_address)
:material-alert-decagram: [override_port](#override_port)
`direct` 出站直接发送请求。 `direct` 出站直接发送请求。
### 结构 ### 结构
@ -9,7 +18,6 @@
"override_address": "1.0.0.1", "override_address": "1.0.0.1",
"override_port": 53, "override_port": 53,
"proxy_protocol": 0,
... // 拨号字段 ... // 拨号字段
} }
@ -19,18 +27,20 @@
#### override_address #### override_address
!!! failure "已在 sing-box 1.11.0 废弃"
目标覆盖字段在 sing-box 1.11.0 中已废弃，并将在 sing-box 1.13.0 中被移除，参阅 [迁移指南](/migration/#migrate-destination-override-fields-to-route-options)。
覆盖连接目标地址。 覆盖连接目标地址。
#### override_port #### override_port
!!! failure "已在 sing-box 1.11.0 废弃"
目标覆盖字段在 sing-box 1.11.0 中已废弃，并将在 sing-box 1.13.0 中被移除，参阅 [迁移指南](/migration/#migrate-destination-override-fields-to-route-options)。
覆盖连接目标端口。 覆盖连接目标端口。
#### proxy_protocol
写出 [代理协议](https://www.haproxy.org/download/1.8/doc/proxy-protocol.txt) 到连接头。
可用协议版本值：`1` 或 `2`。
### 拨号字段 ### 拨号字段
参阅 [拨号字段](/zh/configuration/shared/dial/)。 参阅 [拨号字段](/zh/configuration/shared/dial/)。

50
docs/configuration/route/rule_action.md
View file

@ -10,12 +10,8 @@ icon: material/new-box
{ {
"action": "route", // default "action": "route", // default
"outbound": "", "outbound": "",
"network_strategy": "",
"network_type": [], ... // route-options Fields
"fallback_network_type": [],
"fallback_delay": "",
"udp_disable_domain_unmapping": false,
"udp_connect": false
} }
``` ```
@ -31,6 +27,34 @@ icon: material/new-box
Tag of target outbound. Tag of target outbound.
#### route-options Fields
See `route-options` fields below.
### route-options
```json
{
"action": "route-options",
"override_address": "",
"override_port": 0,
"network_strategy": "",
"fallback_delay": "",
"udp_disable_domain_unmapping": false,
"udp_connect": false
}
```
`route-options` set options for routing.
#### override_address
Override the connection destination address.
#### override_port
Override the connection destination port.
#### network_strategy #### network_strategy
See [Dial Fields](/configuration/shared/dial/#network_strategy) for details. See [Dial Fields](/configuration/shared/dial/#network_strategy) for details.
@ -62,20 +86,6 @@ do not support receiving UDP packets with domain addresses, such as Surge.
If enabled, attempts to connect UDP connection to the destination instead of listen. If enabled, attempts to connect UDP connection to the destination instead of listen.
### route-options
```json
{
"action": "route-options",
"network_strategy": "",
"fallback_delay": "",
"udp_disable_domain_unmapping": false,
"udp_connect": false
}
```
`route-options` set options for routing.
### reject ### reject
```json ```json

58
docs/configuration/route/rule_action.zh.md
View file

@ -10,12 +10,8 @@ icon: material/new-box
{ {
"action": "route", // 默认 "action": "route", // 默认
"outbound": "", "outbound": "",
"network_strategy": "",
"fallback_delay": "", ... // route-options 字段
"network_type": [],
"fallback_network_type": [],
"udp_disable_domain_unmapping": false,
"udp_connect": false
} }
``` ```
@ -27,6 +23,38 @@ icon: material/new-box
目标出站的标签。 目标出站的标签。
#### route-options 字段
参阅下方的 `route-options` 字段。
### route-options
```json
{
"action": "route-options",
"override_address": "",
"override_port": 0,
"network_strategy": "",
"fallback_delay": "",
"udp_disable_domain_unmapping": false,
"udp_connect": false
}
```
!!! note ""
当内容只有一项时，可以忽略 JSON 数组 [] 标签
`route-options` 为路由设置选项。
#### override_address
覆盖目标地址。
#### override_port
覆盖目标端口。
#### network_strategy #### network_strategy
详情参阅 [拨号字段](/configuration/shared/dial/#network_strategy)。 详情参阅 [拨号字段](/configuration/shared/dial/#network_strategy)。
@ -56,24 +84,6 @@ icon: material/new-box
如果启用，将尝试将 UDP 连接 connect 到目标而不是 listen。 如果启用，将尝试将 UDP 连接 connect 到目标而不是 listen。
### route-options
```json
{
"action": "route-options",
"network_strategy": "",
"fallback_delay": "",
"udp_disable_domain_unmapping": false,
"udp_connect": false
}
```
!!! note ""
当内容只有一项时，可以忽略 JSON 数组 [] 标签
`route-options` 为路由设置选项。
### reject ### reject
```json ```json

6
docs/deprecated.md
View file

@ -22,6 +22,12 @@ check [Migration](../migration/#migrate-legacy-inbound-fields-to-rule-actions).
Old fields will be removed in sing-box 1.13.0. Old fields will be removed in sing-box 1.13.0.
#### Destination override fields in direct outbound
Destination override fields (`override_address` / `override_port`) in direct outbound are deprecated
and can be replaced by rule actions,
check [Migration](../migration/#migrate-destination-override-fields-to-route-options).
## 1.10.0 ## 1.10.0
#### TUN address fields are merged #### TUN address fields are merged

7
docs/deprecated.zh.md
View file

@ -20,6 +20,13 @@ icon: material/delete-alert
旧字段将在 sing-box 1.13.0 中被移除。 旧字段将在 sing-box 1.13.0 中被移除。
#### direct 出站中的目标地址覆盖字段
direct 出站中的目标地址覆盖字段（`override_address` / `override_port`）已废弃且可以通过规则动作替代，
参阅 [迁移指南](/migration/#migrate-destination-override-fields-to-route-options)。
旧字段将在 sing-box 1.13.0 中被移除。
## 1.10.0 ## 1.10.0
#### Match source 规则项已重命名 #### Match source 规则项已重命名

38
docs/migration.md
View file

@ -156,6 +156,44 @@ Inbound fields are deprecated and can be replaced by rule actions.
} }
``` ```
### Migrate destination override fields to route options
Destination override fields in direct outbound are deprecated and can be replaced by route options.
!!! info "References"
[Rule Action](/configuration/route/rule_action/) /
[Direct](/configuration/outbound/direct/)
=== ":material-card-remove: Deprecated"
```json
{
"outbounds": [
{
"type": "direct",
"override_address": "1.1.1.1",
"override_port": 443
}
]
}
```
=== ":material-card-multiple: New"
```json
{
"route": {
"rules": [
{
"action": "route-options", // or route
"override_address": "1.1.1.1",
"override_port": 443
}
]
}
```
## 1.10.0 ## 1.10.0
### TUN address fields are merged ### TUN address fields are merged

42
docs/migration.zh.md
View file

@ -104,6 +104,7 @@ icon: material/arrange-bring-forward
### 迁移旧的入站字段到规则动作 ### 迁移旧的入站字段到规则动作
入站选项已被弃用，且可以被规则动作替代。 入站选项已被弃用，且可以被规则动作替代。
!!! info "参考" !!! info "参考"
@ -156,6 +157,45 @@ icon: material/arrange-bring-forward
} }
``` ```
### 迁移 direct 出站中的目标地址覆盖字段到路由字段
direct 出站中的目标地址覆盖字段已废弃，且可以被路由字段替代。
!!! info "参考"
[Rule Action](/zh/configuration/route/rule_action/) /
[Direct](/zh/configuration/outbound/direct/)
=== ":material-card-remove: 弃用的"
```json
{
"outbounds": [
{
"type": "direct",
"override_address": "1.1.1.1",
"override_port": 443
}
]
}
```
=== ":material-card-multiple: 新的"
```json
{
"route": {
"rules": [
{
"action": "route-options", // 或 route
"override_address": "1.1.1.1",
"override_port": 443
}
]
}
}
```
## 1.10.0 ## 1.10.0
### TUN 地址字段已合并 ### TUN 地址字段已合并
@ -164,8 +204,6 @@ icon: material/arrange-bring-forward
`inet4_route_address` 和 `inet6_route_address` 已合并为 `route_address`， `inet4_route_address` 和 `inet6_route_address` 已合并为 `route_address`，
`inet4_route_exclude_address` 和 `inet6_route_exclude_address` 已合并为 `route_exclude_address`。 `inet4_route_exclude_address` 和 `inet6_route_exclude_address` 已合并为 `route_exclude_address`。
旧字段已废弃，且将在 sing-box 1.11.0 中移除。
!!! info "参考" !!! info "参考"
[TUN](/zh/configuration/inbound/tun/) [TUN](/zh/configuration/inbound/tun/)