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

91 lines
1.6 KiB
Markdown
Raw Normal View History

2022-07-08 10:10:39 +00:00
### Structure
```json
{
"inbounds": [
{
"type": "http",
"tag": "http-in",
"listen": "::",
"listen_port": 2080,
"tcp_fast_open": false,
"sniff": false,
"sniff_override_destination": false,
"domain_strategy": "prefer_ipv6",
2022-08-23 15:15:56 +00:00
"proxy_protocol": false,
2022-07-08 10:10:39 +00:00
"users": [
{
"username": "admin",
"password": "admin"
}
2022-07-14 06:29:28 +00:00
],
2022-08-10 13:17:02 +00:00
"tls": {},
2022-07-14 06:29:28 +00:00
"set_system_proxy": false
2022-07-08 10:10:39 +00:00
}
]
}
```
2022-08-23 15:15:56 +00:00
### HTTP Fields
#### tls
TLS configuration, see [TLS](/configuration/shared/tls/#inbound).
2022-08-23 15:15:56 +00:00
#### users
HTTP users.
No authentication required if empty.
#### set_system_proxy
!!! error ""
Only supported on Linux, Android, Windows, and macOS.
Automatically set system proxy configuration when start and clean up when stop.
2022-07-08 10:10:39 +00:00
### Listen Fields
#### listen
==Required==
2022-07-08 10:10:39 +00:00
Listen address.
#### listen_port
==Required==
2022-07-08 10:10:39 +00:00
Listen port.
#### tcp_fast_open
Enable tcp fast open for listener.
#### sniff
Enable sniffing.
See [Protocol Sniff](/configuration/route/sniff/) for details.
2022-07-08 10:10:39 +00: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.
2022-08-23 15:15:56 +00:00
#### proxy_protocol
2022-07-08 10:10:39 +00:00
2022-08-23 15:15:56 +00:00
Parse [Proxy Protocol](https://www.haproxy.org/download/1.8/doc/proxy-protocol.txt) in the connection header.