2023-08-01 06:20:13 +00:00
|
|
|
### Structure
|
|
|
|
|
|
|
|
|
|
```json
|
|
|
|
|
{
|
|
|
|
|
"type": "tuic",
|
|
|
|
|
"tag": "tuic-out",
|
|
|
|
|
|
|
|
|
|
"server": "127.0.0.1",
|
|
|
|
|
"server_port": 1080,
|
|
|
|
|
"uuid": "2DD61D93-75D8-4DA4-AC0E-6AECE7EAC365",
|
|
|
|
|
"password": "hello",
|
|
|
|
|
"congestion_control": "cubic",
|
|
|
|
|
"udp_relay_mode": "native",
|
2023-08-20 03:28:30 +00:00
|
|
|
"udp_over_stream": false,
|
2023-08-01 06:20:13 +00:00
|
|
|
"zero_rtt_handshake": false,
|
|
|
|
|
"heartbeat": "10s",
|
|
|
|
|
"network": "tcp",
|
|
|
|
|
"tls": {},
|
|
|
|
|
|
|
|
|
|
... // Dial Fields
|
|
|
|
|
}
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
!!! warning ""
|
|
|
|
|
|
2023-11-09 09:04:08 +00:00
|
|
|
QUIC, which is required by TUIC is not included by default, see [Installation](./#installation).
|
2023-08-01 06:20:13 +00:00
|
|
|
|
|
|
|
|
### Fields
|
|
|
|
|
|
|
|
|
|
#### server
|
|
|
|
|
|
|
|
|
|
==Required==
|
|
|
|
|
|
|
|
|
|
The server address.
|
|
|
|
|
|
|
|
|
|
#### server_port
|
|
|
|
|
|
|
|
|
|
==Required==
|
|
|
|
|
|
|
|
|
|
The server port.
|
|
|
|
|
|
|
|
|
|
#### uuid
|
|
|
|
|
|
|
|
|
|
==Required==
|
|
|
|
|
|
|
|
|
|
TUIC user uuid
|
|
|
|
|
|
|
|
|
|
#### password
|
|
|
|
|
|
|
|
|
|
TUIC user password
|
|
|
|
|
|
|
|
|
|
#### congestion_control
|
|
|
|
|
|
|
|
|
|
QUIC congestion control algorithm
|
|
|
|
|
|
|
|
|
|
One of: `cubic`, `new_reno`, `bbr`
|
|
|
|
|
|
|
|
|
|
`cubic` is used by default.
|
|
|
|
|
|
|
|
|
|
#### udp_relay_mode
|
|
|
|
|
|
|
|
|
|
UDP packet relay mode
|
|
|
|
|
|
|
|
|
|
| Mode | Description |
|
|
|
|
|
|:-------|:-------------------------------------------------------------------------|
|
|
|
|
|
| native | native UDP characteristics |
|
|
|
|
|
| quic | lossless UDP relay using QUIC streams, additional overhead is introduced |
|
|
|
|
|
|
|
|
|
|
`native` is used by default.
|
|
|
|
|
|
2023-08-20 03:28:30 +00:00
|
|
|
Conflict with `udp_over_stream`.
|
|
|
|
|
|
|
|
|
|
#### udp_over_stream
|
|
|
|
|
|
2023-12-14 14:23:52 +00:00
|
|
|
This is the TUIC port of the [UDP over TCP protocol](/configuration/shared/udp-over-tcp/), designed to provide a QUIC
|
2023-08-20 03:28:30 +00:00
|
|
|
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
|
|
|
|
|
another program compatible with the protocol as a server.
|
|
|
|
|
|
|
|
|
|
This mode has no positive effect in a proper UDP proxy scenario and should only be applied to relay streaming UDP
|
|
|
|
|
traffic (basically QUIC streams).
|
|
|
|
|
|
|
|
|
|
Conflict with `udp_relay_mode`.
|
|
|
|
|
|
2023-08-01 06:20:13 +00:00
|
|
|
#### network
|
|
|
|
|
|
|
|
|
|
Enabled network
|
|
|
|
|
|
|
|
|
|
One of `tcp` `udp`.
|
|
|
|
|
|
|
|
|
|
Both is enabled by default.
|
|
|
|
|
|
|
|
|
|
#### tls
|
|
|
|
|
|
|
|
|
|
==Required==
|
|
|
|
|
|
|
|
|
|
TLS configuration, see [TLS](/configuration/shared/tls/#outbound).
|
|
|
|
|
|
|
|
|
|
### Dial Fields
|
|
|
|
|
|
2023-12-14 14:23:52 +00:00
|
|
|
See [Dial Fields](/configuration/shared/dial/) for details.
|
