sing-box/docs/configuration/shared/dial.md

97 lines
2.5 KiB
Markdown
Raw Normal View History

2022-08-31 04:50:26 +00:00
### Structure
```json
{
"detour": "upstream-out",
"bind_interface": "en0",
2022-11-03 04:07:16 +00:00
"inet4_bind_address": "0.0.0.0",
"inet6_bind_address": "::",
2022-08-31 04:50:26 +00:00
"routing_mark": 1234,
"reuse_addr": false,
"connect_timeout": "5s",
"tcp_fast_open": false,
2023-08-08 08:14:03 +00:00
"tcp_multi_path": false,
2022-09-09 07:40:35 +00:00
"udp_fragment": false,
2022-08-31 04:50:26 +00:00
"domain_strategy": "prefer_ipv6",
"fallback_delay": "300ms"
}
```
### Fields
2023-08-08 08:14:03 +00:00
| Field | Available Context |
|------------------------------------------------------------------------------------------------------------------------------------------|-------------------|
| `bind_interface` /`*bind_address` /`routing_mark` /`reuse_addr` / `tcp_fast_open` / `tcp_multi_path` / `udp_fragment` /`connect_timeout` | `detour` not set |
2022-09-03 05:02:41 +00:00
2022-08-31 04:50:26 +00:00
#### detour
The tag of the upstream outbound.
#### bind_interface
The network interface to bind to.
2022-11-03 04:07:16 +00:00
#### inet4_bind_address
2022-08-31 04:50:26 +00:00
2022-11-03 04:07:16 +00:00
The IPv4 address to bind to.
#### inet6_bind_address
The IPv6 address to bind to.
2022-08-31 04:50:26 +00:00
#### routing_mark
!!! quote ""
2022-08-31 04:50:26 +00:00
Only supported on Linux.
Set netfilter routing mark.
#### reuse_addr
Reuse listener address.
2022-09-09 07:40:35 +00:00
#### tcp_fast_open
Enable TCP Fast Open.
2023-08-08 08:14:03 +00:00
#### tcp_multi_path
!!! warning ""
Go 1.21 required.
Enable TCP Multi Path.
2022-09-09 07:40:35 +00:00
#### udp_fragment
Enable UDP fragmentation.
2022-08-31 04:50:26 +00:00
#### connect_timeout
Connect timeout, in golang's Duration format.
A duration string is a possibly signed sequence of
decimal numbers, each with optional fraction and a unit suffix,
such as "300ms", "-1.5h" or "2h45m".
Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h".
#### domain_strategy
One of `prefer_ipv4` `prefer_ipv6` `ipv4_only` `ipv6_only`.
If set, the requested domain name will be resolved to IP before connect.
2022-09-03 05:02:41 +00:00
| Outbound | Effected domains | Fallback Value |
|----------|--------------------------|-------------------------------------------|
| `direct` | Domain in request | Take `inbound.domain_strategy` if not set |
| others | Domain in server address | / |
2022-08-31 04:50:26 +00:00
#### fallback_delay
The length of time to wait before spawning a RFC 6555 Fast Fallback connection.
2022-09-03 05:02:41 +00:00
That is, is the amount of time to wait for connection to succeed before assuming
that IPv4/IPv6 is misconfigured and falling back to other type of addresses.
2022-08-31 04:50:26 +00:00
If zero, a default delay of 300ms is used.
2022-09-03 05:02:41 +00:00
Only take effect when `domain_strategy` is set.