sing-box/docs/configuration/outbound/hysteria2.md

92 lines
1.6 KiB
Markdown
Raw Normal View History

2023-09-09 05:42:38 +00:00
### Structure
```json
{
"type": "hysteria2",
"tag": "hy2-out",
"server": "127.0.0.1",
"server_port": 1080,
"up_mbps": 100,
"down_mbps": 100,
"obfs": {
"type": "salamander",
"password": "cry_me_a_r1ver"
},
"password": "goofy_ahh_password",
"network": "tcp",
"tls": {},
2023-10-21 04:00:00 +00:00
"brutal_debug": false,
2023-09-09 05:42:38 +00:00
... // Dial Fields
}
```
!!! warning ""
QUIC, which is required by Hysteria2 is not included by default, see [Installation](./#installation).
!!! warning "Difference from official Hysteria2"
The official Hysteria2 supports an authentication method called **userpass**,
which essentially uses a combination of `<username>:<password>` as the actual password,
while sing-box does not provide this alias.
If you are planning to use sing-box with the official program,
please note that you will need to fill the combination as the password.
2023-09-09 05:42:38 +00:00
### Fields
#### server
==Required==
The server address.
#### server_port
==Required==
The server port.
#### up_mbps, down_mbps
Max bandwidth, in Mbps.
If empty, the BBR congestion control algorithm will be used instead of Hysteria CC.
#### obfs.type
QUIC traffic obfuscator type, only available with `salamander`.
Disabled if empty.
#### obfs.password
QUIC traffic obfuscator password.
#### password
Authentication password.
#### network
Enabled network
One of `tcp` `udp`.
Both is enabled by default.
#### tls
==Required==
TLS configuration, see [TLS](/configuration/shared/tls/#outbound).
2023-10-21 04:00:00 +00:00
#### brutal_debug
Enable debug information logging for Hysteria Brutal CC.
2023-09-09 05:42:38 +00:00
### Dial Fields
2023-12-14 14:23:52 +00:00
See [Dial Fields](/configuration/shared/dial/) for details.