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

     1  ### Structure
     2  
     3  ```json
     4  {
     5    "type": "tuic",
     6    "tag": "tuic-out",
     7    
     8    "server": "127.0.0.1",
     9    "server_port": 1080,
    10    "uuid": "2DD61D93-75D8-4DA4-AC0E-6AECE7EAC365",
    11    "password": "hello",
    12    "congestion_control": "cubic",
    13    "udp_relay_mode": "native",
    14    "udp_over_stream": false,
    15    "zero_rtt_handshake": false,
    16    "heartbeat": "10s",
    17    "network": "tcp",
    18    "tls": {},
    19    
    20    ... // Dial Fields
    21  }
    22  ```
    23  
    24  !!! warning ""
    25  
    26      QUIC, which is required by TUIC is not included by default, see [Installation](/#installation).
    27  
    28  ### Fields
    29  
    30  #### server
    31  
    32  ==Required==
    33  
    34  The server address.
    35  
    36  #### server_port
    37  
    38  ==Required==
    39  
    40  The server port.
    41  
    42  #### uuid
    43  
    44  ==Required==
    45  
    46  TUIC user uuid
    47  
    48  #### password
    49  
    50  TUIC user password
    51  
    52  #### congestion_control
    53  
    54  QUIC congestion control algorithm
    55  
    56  One of: `cubic`, `new_reno`, `bbr`
    57  
    58  `cubic` is used by default.
    59  
    60  #### udp_relay_mode
    61  
    62  UDP packet relay mode
    63  
    64  | Mode   | Description                                                              |
    65  |:-------|:-------------------------------------------------------------------------|
    66  | native | native UDP characteristics                                               |
    67  | quic   | lossless UDP relay using QUIC streams, additional overhead is introduced |
    68  
    69  `native` is used by default.
    70  
    71  Conflict with `udp_over_stream`.
    72  
    73  #### udp_over_stream
    74  
    75  This is the TUIC port of the [UDP over TCP protocol](/configuration/shared/udp-over-tcp), designed to provide a QUIC
    76  stream based UDP relay mode that TUIC does not provide. Since it is an add-on protocol, you will need to use sing-box or
    77  another program compatible with the protocol as a server.
    78  
    79  This mode has no positive effect in a proper UDP proxy scenario and should only be applied to relay streaming UDP
    80  traffic (basically QUIC streams).
    81  
    82  Conflict with `udp_relay_mode`.
    83  
    84  #### network
    85  
    86  Enabled network
    87  
    88  One of `tcp` `udp`.
    89  
    90  Both is enabled by default.
    91  
    92  #### tls
    93  
    94  ==Required==
    95  
    96  TLS configuration, see [TLS](/configuration/shared/tls/#outbound).
    97  
    98  ### Dial Fields
    99  
   100  See [Dial Fields](/configuration/shared/dial) for details.