github.com/sagernet/sing-box@v1.9.0-rc.20/docs/configuration/outbound/hysteria2.md (about)

     1  ### Structure
     2  
     3  ```json
     4  {
     5    "type": "hysteria2",
     6    "tag": "hy2-out",
     7    
     8    "server": "127.0.0.1",
     9    "server_port": 1080,
    10    "up_mbps": 100,
    11    "down_mbps": 100,
    12    "obfs": {
    13      "type": "salamander",
    14      "password": "cry_me_a_r1ver"
    15    },
    16    "password": "goofy_ahh_password",
    17    "network": "tcp",
    18    "tls": {},
    19    "brutal_debug": false,
    20    
    21    ... // Dial Fields
    22  }
    23  ```
    24  
    25  !!! warning "Difference from official Hysteria2"
    26  
    27      The official Hysteria2 supports an authentication method called **userpass**,
    28      which essentially uses a combination of `<username>:<password>` as the actual password,
    29      while sing-box does not provide this alias.
    30      If you are planning to use sing-box with the official program,
    31      please note that you will need to fill the combination as the password.
    32  
    33  ### Fields
    34  
    35  #### server
    36  
    37  ==Required==
    38  
    39  The server address.
    40  
    41  #### server_port
    42  
    43  ==Required==
    44  
    45  The server port.
    46  
    47  #### up_mbps, down_mbps
    48  
    49  Max bandwidth, in Mbps.
    50  
    51  If empty, the BBR congestion control algorithm will be used instead of Hysteria CC.
    52  
    53  #### obfs.type
    54  
    55  QUIC traffic obfuscator type, only available with `salamander`.
    56  
    57  Disabled if empty.
    58  
    59  #### obfs.password
    60  
    61  QUIC traffic obfuscator password.
    62  
    63  #### password
    64  
    65  Authentication password.
    66  
    67  #### network
    68  
    69  Enabled network
    70  
    71  One of `tcp` `udp`.
    72  
    73  Both is enabled by default.
    74  
    75  #### tls
    76  
    77  ==Required==
    78  
    79  TLS configuration, see [TLS](/configuration/shared/tls/#outbound).
    80  
    81  #### brutal_debug
    82  
    83  Enable debug information logging for Hysteria Brutal CC.
    84  
    85  ### Dial Fields
    86  
    87  See [Dial Fields](/configuration/shared/dial/) for details.