github.com/inazumav/sing-box@v0.0.0-20230926072359-ab51429a14f1/docs/configuration/inbound/hysteria2.md (about)

     1  ### Structure
     2  
     3  ```json
     4  {
     5    "type": "hysteria2",
     6    "tag": "hy2-in",
     7    
     8    ... // Listen Fields
     9  
    10    "up_mbps": 100,
    11    "down_mbps": 100,
    12    "obfs": {
    13      "type": "salamander",
    14      "password": "cry_me_a_r1ver"
    15    },
    16    "users": [
    17      {
    18        "name": "tobyxdd",
    19        "password": "goofy_ahh_password"
    20      }
    21    ],
    22    "ignore_client_bandwidth": false,
    23    "masquerade": "",
    24    "tls": {}
    25  }
    26  ```
    27  
    28  !!! warning "Compatibility issues with the official client"
    29  
    30      The use case of `fastOpen=false` or UDP MTU >= 1200 is not supported when using the official client.
    31  
    32  !!! warning ""
    33  
    34      QUIC, which is required by Hysteria2 is not included by default, see [Installation](/#installation).
    35  
    36  ### Listen Fields
    37  
    38  See [Listen Fields](/configuration/shared/listen) for details.
    39  
    40  ### Fields
    41  
    42  #### up_mbps, down_mbps
    43  
    44  Max bandwidth, in Mbps.
    45  
    46  Not limited if empty.
    47  
    48  Conflict with `ignore_client_bandwidth`.
    49  
    50  #### obfs.type
    51  
    52  QUIC traffic obfuscator type, only available with `salamander`.
    53  
    54  Disabled if empty.
    55  
    56  #### obfs.password
    57  
    58  QUIC traffic obfuscator password.
    59  
    60  #### users
    61  
    62  Hysteria2 users
    63  
    64  #### users.password
    65  
    66  Authentication password
    67  
    68  #### ignore_client_bandwidth
    69  
    70  Commands the client to use the BBR flow control algorithm instead of Hysteria CC.
    71  
    72  Conflict with `up_mbps` and `down_mbps`.
    73  
    74  #### masquerade
    75  
    76  HTTP3 server behavior when authentication fails.
    77  
    78  | Scheme       | Example                 | Description        |
    79  |--------------|-------------------------|--------------------|
    80  | `file`       | `file:///var/www`       | As a file server   |
    81  | `http/https` | `http://127.0.0.1:8080` | As a reverse proxy |
    82  
    83  A 404 page will be returned if empty.
    84  
    85  #### tls
    86  
    87  ==Required==
    88  
    89  TLS configuration, see [TLS](/configuration/shared/tls/#inbound).