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

     1  ### Structure
     2  
     3  ```json
     4  {
     5    "type": "hysteria",
     6    "tag": "hysteria-out",
     7    
     8    "server": "127.0.0.1",
     9    "server_port": 1080,
    10    "up": "100 Mbps",
    11    "up_mbps": 100,
    12    "down": "100 Mbps",
    13    "down_mbps": 100,
    14    "obfs": "fuck me till the daylight",
    15    "auth": "",
    16    "auth_str": "password",
    17    "recv_window_conn": 0,
    18    "recv_window": 0,
    19    "disable_mtu_discovery": false,
    20    "network": "tcp",
    21    "tls": {},
    22    
    23    ... // Dial Fields
    24  }
    25  ```
    26  
    27  !!! warning ""
    28  
    29      QUIC, which is required by hysteria is not included by default, see [Installation](/#installation).
    30  
    31  ### Fields
    32  
    33  #### server
    34  
    35  ==Required==
    36  
    37  The server address.
    38  
    39  #### server_port
    40  
    41  ==Required==
    42  
    43  The server port.
    44  
    45  #### up, down
    46  
    47  ==Required==
    48  
    49  Format: `[Integer] [Unit]` e.g. `100 Mbps, 640 KBps, 2 Gbps`
    50  
    51  Supported units (case sensitive, b = bits, B = bytes, 8b=1B):
    52  
    53      bps (bits per second)
    54      Bps (bytes per second)
    55      Kbps (kilobits per second)
    56      KBps (kilobytes per second)
    57      Mbps (megabits per second)
    58      MBps (megabytes per second)
    59      Gbps (gigabits per second)
    60      GBps (gigabytes per second)
    61      Tbps (terabits per second)
    62      TBps (terabytes per second)
    63  
    64  #### up_mbps, down_mbps
    65  
    66  ==Required==
    67  
    68  `up, down` in Mbps.
    69  
    70  #### obfs
    71  
    72  Obfuscated password.
    73  
    74  #### auth
    75  
    76  Authentication password, in base64.
    77  
    78  #### auth_str
    79  
    80  Authentication password.
    81  
    82  #### recv_window_conn
    83  
    84  The QUIC stream-level flow control window for receiving data.
    85  
    86  `15728640 (15 MB/s)` will be used if empty.
    87  
    88  #### recv_window
    89  
    90  The QUIC connection-level flow control window for receiving data.
    91  
    92  `67108864 (64 MB/s)` will be used if empty.
    93  
    94  #### disable_mtu_discovery
    95  
    96  Disables Path MTU Discovery (RFC 8899). Packets will then be at most 1252 (IPv4) / 1232 (IPv6) bytes in size.
    97  
    98  Force enabled on for systems other than Linux and Windows (according to upstream).
    99  
   100  #### network
   101  
   102  Enabled network
   103  
   104  One of `tcp` `udp`.
   105  
   106  Both is enabled by default.
   107  
   108  #### tls
   109  
   110  ==Required==
   111  
   112  TLS configuration, see [TLS](/configuration/shared/tls/#outbound).
   113  
   114  ### Dial Fields
   115  
   116  See [Dial Fields](/configuration/shared/dial) for details.