HTTP

Structure

{
  "type": "http",
  "tag": "http-in",

  ... // Listen Fields

  "version": [],
  "users": [
    {
      "username": "admin",
      "password": "admin"
    }
  ],
  "tls": {},
  "set_system_proxy": false,

  ... // HTTP2 Fields / QUIC Fields
}

Listen Fields

See Listen Fields for details.

Fields

version

Since sing-box 1.15.0

List of HTTP versions to serve.

Available values: 1, 2, 3.

1 and 2 are used by default.

TLS is required for 3.

tls

TLS configuration, see TLS.

users

HTTP users.

No authentication required if empty.

set_system_proxy

Only supported on Linux, Android, Windows, and macOS.

To work on Android and Apple platforms without privileges, use tun.platform.http_proxy instead.

Automatically set system proxy configuration when start and clean up when stop.

HTTP2 Fields

Since sing-box 1.15.0

When version contains 2.

See HTTP2 Fields for details.

QUIC Fields

Since sing-box 1.15.0

When version contains 3, HTTP2 Fields are replaced by QUIC Fields.

See QUIC Fields for details.