sing-box/docs/configuration/inbound/direct.md

87 lines
1.5 KiB
Markdown
Raw Normal View History

2022-07-08 18:10:39 +08:00
`direct` inbound is a tunnel server.
### Structure
```json
{
"inbounds": [
{
"type": "direct",
"tag": "direct-in",
"listen": "::",
"listen_port": 5353,
"tcp_fast_open": false,
"sniff": false,
"sniff_override_destination": false,
"domain_strategy": "prefer_ipv6",
"udp_timeout": 300,
"network": "udp",
2022-08-23 23:15:56 +08:00
"proxy_protocol": false,
2022-07-08 18:10:39 +08:00
"override_address": "1.0.0.1",
"override_port": 53
}
]
}
```
2022-08-23 23:15:56 +08:00
### Direct Fields
#### network
Listen network, one of `tcp` `udp`.
Both if empty.
#### override_address
Override the connection destination address.
#### override_port
Override the connection destination port.
2022-07-08 18:10:39 +08:00
### Listen Fields
#### listen
==Required==
2022-07-08 18:10:39 +08:00
Listen address.
#### listen_port
==Required==
2022-07-08 18:10:39 +08:00
Listen port.
#### tcp_fast_open
Enable tcp fast open for listener.
#### sniff
Enable sniffing.
2022-07-17 15:11:26 +08:00
See [Sniff](/configuration/route/sniff/) for details.
2022-07-08 18:10:39 +08:00
#### sniff_override_destination
Override the connection destination address with the sniffed domain.
If the domain name is invalid (like tor), this will not work.
#### domain_strategy
One of `prefer_ipv4` `prefer_ipv6` `ipv4_only` `ipv6_only`.
If set, the requested domain name will be resolved to IP before routing.
If `sniff_override_destination` is in effect, its value will be taken as a fallback.
#### udp_timeout
UDP NAT expiration time in seconds, default is 300 (5 minutes).
2022-08-23 23:15:56 +08:00
#### proxy_protocol
2022-07-08 18:10:39 +08:00
2022-08-23 23:15:56 +08:00
Parse [Proxy Protocol](https://www.haproxy.org/download/1.8/doc/proxy-protocol.txt) in the connection header.