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

Structure

{
  "type": "hysteria2",
  "tag": "hy2-in",
  ...
  // Listen Fields

  "up_mbps": 100,
  "down_mbps": 100,
  "obfs": {
    "type": "salamander",
    "password": "cry_me_a_r1ver"
  },
  "users": [
    {
      "name": "tobyxdd",
      "password": "goofy_ahh_password"
    }
  ],
  "ignore_client_bandwidth": false,
  "tls": {},
  "masquerade": "",
  "brutal_debug": false
}

!!! warning ""

QUIC, which is required by Hysteria2 is not included by default, see [Installation](./#installation).

!!! warning "Difference from official Hysteria2"

The official program supports an authentication method called **userpass**,
which essentially uses a combination of `<username>:<password>` as the actual password,
while sing-box does not provide this alias.
To use sing-box with the official program, you need to fill in that combination as the actual password.

Listen Fields

See Listen Fields for details.

Fields

up_mbps, down_mbps

Max bandwidth, in Mbps.

Not limited if empty.

Conflict with ignore_client_bandwidth.

obfs.type

QUIC traffic obfuscator type, only available with salamander.

Disabled if empty.

obfs.password

QUIC traffic obfuscator password.

users

Hysteria2 users

users.password

Authentication password

ignore_client_bandwidth

Commands the client to use the BBR flow control algorithm instead of Hysteria CC.

Conflict with up_mbps and down_mbps.

tls

==Required==

TLS configuration, see TLS.

masquerade

HTTP3 server behavior when authentication fails.

Scheme	Example	Description
file	file:///var/www	As a file server
http/https	http://127.0.0.1:8080	As a reverse proxy

A 404 page will be returned if empty.

brutal_debug

Enable debug information logging for Hysteria Brutal CC.