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

101 lines
1.4 KiB
Markdown
Raw Permalink Normal View History

2022-07-08 10:48:43 +00:00
### Structure
```json
{
2022-08-31 05:21:29 +00:00
"type": "shadowsocks",
"tag": "ss-out",
"server": "127.0.0.1",
"server_port": 1080,
"method": "2022-blake3-aes-128-gcm",
"password": "8JCsPssfgS8tiRwiMlhARg==",
2022-09-13 03:24:33 +00:00
"plugin": "",
"plugin_opts": "",
2022-08-31 05:21:29 +00:00
"network": "udp",
"udp_over_tcp": false,
"multiplex": {},
... // 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.
#### method
==Required==
2022-07-08 10:48:43 +00:00
Encryption methods:
* `2022-blake3-aes-128-gcm`
* `2022-blake3-aes-256-gcm`
* `2022-blake3-chacha20-poly1305`
* `none`
* `aes-128-gcm`
* `aes-192-gcm`
* `aes-256-gcm`
* `chacha20-ietf-poly1305`
* `xchacha20-ietf-poly1305`
Legacy encryption methods:
* `aes-128-ctr`
* `aes-192-ctr`
* `aes-256-ctr`
* `aes-128-cfb`
* `aes-192-cfb`
* `aes-256-cfb`
* `rc4-md5`
* `chacha20-ietf`
* `xchacha20`
#### password
==Required==
2022-07-08 10:48:43 +00:00
The shadowsocks password.
2022-09-13 03:24:33 +00:00
#### plugin
Shadowsocks SIP003 plugin, implemented in internal.
Only `obfs-local` and `v2ray-plugin` are supported.
#### plugin_opts
Shadowsocks SIP003 plugin options.
2022-07-08 10:48:43 +00:00
#### network
Enabled network
One of `tcp` `udp`.
Both is enabled by default.
2022-08-11 02:36:28 +00:00
#### udp_over_tcp
2022-08-12 09:55:52 +00:00
Enable the UDP over TCP protocol.
2022-08-11 02:36:28 +00:00
Conflict with `multiplex`.
#### multiplex
Multiplex configuration, see [Multiplex](/configuration/shared/multiplex).
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.