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

1.6 KiB

Structure

{
  "inbounds": [
    {
      "type": "http",
      "tag": "http-in",
      
      "listen": "::",
      "listen_port": 2080,
      "tcp_fast_open": false,
      "sniff": false,
      "sniff_override_destination": false,
      "domain_strategy": "prefer_ipv6",
      "proxy_protocol": false,
      
      "users": [
        {
          "username": "admin",
          "password": "admin"
        }
      ],
      "tls": {},
      "set_system_proxy": false
    }
  ]
}

HTTP Fields

tls

TLS configuration, see TLS inbound structure.

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.

Listen Fields

listen

==Required==

Listen address.

listen_port

==Required==

Listen port.

tcp_fast_open

Enable tcp fast open for listener.

sniff

Enable sniffing.

See Sniff for details.

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.

proxy_protocol

Parse Proxy Protocol in the connection header.