github.com/inazumav/sing-box@v0.0.0-20230926072359-ab51429a14f1/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    
    20    ... // Dial Fields
    21  }
    22  ```
    23  
    24  !!! warning "Compatibility issues with the official server"
    25  
    26      The use case of UDP MTU >= 1200 is not supported when using the official server.
    27  
    28  !!! warning ""
    29  
    30      QUIC, which is required by Hysteria2 is not included by default, see [Installation](/#installation).
    31  
    32  ### Fields
    33  
    34  #### server
    35  
    36  ==Required==
    37  
    38  The server address.
    39  
    40  #### server_port
    41  
    42  ==Required==
    43  
    44  The server port.
    45  
    46  #### up_mbps, down_mbps
    47  
    48  Max bandwidth, in Mbps.
    49  
    50  If empty, the BBR congestion control algorithm will be used instead of Hysteria CC.
    51  
    52  #### obfs.type
    53  
    54  QUIC traffic obfuscator type, only available with `salamander`.
    55  
    56  Disabled if empty.
    57  
    58  #### obfs.password
    59  
    60  QUIC traffic obfuscator password.
    61  
    62  #### password
    63  
    64  Authentication password.
    65  
    66  #### network
    67  
    68  Enabled network
    69  
    70  One of `tcp` `udp`.
    71  
    72  Both is enabled by default.
    73  
    74  #### tls
    75  
    76  ==Required==
    77  
    78  TLS configuration, see [TLS](/configuration/shared/tls/#outbound).
    79  
    80  ### Dial Fields
    81  
    82  See [Dial Fields](/configuration/shared/dial) for details.