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

     1  ### Structure
     2  
     3  ```json
     4  {
     5    "type": "hysteria",
     6    "tag": "hysteria-in",
     7    
     8    ... // Listen Fields
     9  
    10    "up": "100 Mbps",
    11    "up_mbps": 100,
    12    "down": "100 Mbps",
    13    "down_mbps": 100,
    14    "obfs": "fuck me till the daylight",
    15  
    16    "users": [
    17      {
    18        "name": "sekai",
    19        "auth": "",
    20        "auth_str": "password"
    21      }
    22    ],
    23    
    24    "recv_window_conn": 0,
    25    "recv_window_client": 0,
    26    "max_conn_client": 0,
    27    "disable_mtu_discovery": false,
    28    "tls": {}
    29  }
    30  ```
    31  
    32  !!! warning ""
    33  
    34      QUIC, which is required by hysteria 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, down
    43  
    44  ==Required==
    45  
    46  Format: `[Integer] [Unit]` e.g. `100 Mbps, 640 KBps, 2 Gbps`
    47  
    48  Supported units (case sensitive, b = bits, B = bytes, 8b=1B):
    49  
    50      bps (bits per second)
    51      Bps (bytes per second)
    52      Kbps (kilobits per second)
    53      KBps (kilobytes per second)
    54      Mbps (megabits per second)
    55      MBps (megabytes per second)
    56      Gbps (gigabits per second)
    57      GBps (gigabytes per second)
    58      Tbps (terabits per second)
    59      TBps (terabytes per second)
    60  
    61  #### up_mbps, down_mbps
    62  
    63  ==Required==
    64  
    65  `up, down` in Mbps.
    66  
    67  #### obfs
    68  
    69  Obfuscated password.
    70  
    71  #### users
    72  
    73  Hysteria users
    74  
    75  #### users.auth
    76  
    77  Authentication password, in base64.
    78  
    79  #### users.auth_str
    80  
    81  Authentication password.
    82  
    83  #### recv_window_conn
    84  
    85  The QUIC stream-level flow control window for receiving data.
    86  
    87  `15728640 (15 MB/s)` will be used if empty.
    88  
    89  #### recv_window_client
    90  
    91  The QUIC connection-level flow control window for receiving data.
    92  
    93  `67108864 (64 MB/s)` will be used if empty.
    94  
    95  #### max_conn_client
    96  
    97  The maximum number of QUIC concurrent bidirectional streams that a peer is allowed to open.
    98  
    99  `1024` will be used if empty.
   100  
   101  #### disable_mtu_discovery
   102  
   103  Disables Path MTU Discovery (RFC 8899). Packets will then be at most 1252 (IPv4) / 1232 (IPv6) bytes in size.
   104  
   105  Force enabled on for systems other than Linux and Windows (according to upstream).
   106  
   107  #### tls
   108  
   109  ==Required==
   110  
   111  TLS configuration, see [TLS](/configuration/shared/tls/#inbound).