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

67 lines
846 B
Markdown
Raw Normal View History

2022-07-08 10:48:43 +00:00
`socks` outbound is a socks4/socks4a/socks5 client.
### Structure
```json
{
2022-08-31 05:21:29 +00:00
"type": "socks",
"tag": "socks-out",
"server": "127.0.0.1",
"server_port": 1080,
"version": "5",
"username": "sekai",
"password": "admin",
"network": "udp",
2023-03-17 04:24:29 +00:00
"udp_over_tcp": false | {},
2022-08-31 05:21:29 +00:00
... // Dial Fields
2022-07-08 10:48:43 +00:00
}
```
2022-08-31 05:21:29 +00:00
### Fields
2022-07-08 10:48:43 +00:00
#### server
==Required==
2022-07-08 10:48:43 +00:00
The server address.
#### server_port
==Required==
2022-07-08 10:48:43 +00:00
The server port.
#### version
The SOCKS version, one of `4` `4a` `5`.
2022-07-08 10:48:43 +00:00
SOCKS5 used by default.
2022-07-08 10:48:43 +00:00
#### username
SOCKS username.
2022-07-08 10:48:43 +00:00
#### password
SOCKS5 password.
2022-07-08 10:48:43 +00:00
#### network
Enabled network
One of `tcp` `udp`.
Both is enabled by default.
2022-08-12 09:55:52 +00:00
#### udp_over_tcp
2023-03-17 04:24:29 +00:00
UDP over TCP protocol settings.
See [UDP Over TCP](/configuration/shared/udp-over-tcp) for details.
2022-08-12 09:55:52 +00:00
2022-07-08 10:48:43 +00:00
### Dial Fields
2022-08-31 05:21:29 +00:00
See [Dial Fields](/configuration/shared/dial) for details.