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

147 lines
2.6 KiB
Markdown
Raw Normal View History

2022-07-08 10:48:43 +00:00
`socks` outbound is a socks4/socks4a/socks5 client.
### Structure
```json
{
"outbounds": [
{
"type": "shadowsocks",
"tag": "ss-out",
"server": "127.0.0.1",
"server_port": 1080,
"method": "2022-blake3-aes-128-gcm",
"password": "8JCsPssfgS8tiRwiMlhARg==",
"network": "udp",
2022-08-11 02:36:28 +00:00
"udp_over_tcp": false,
"multiplex": {},
2022-07-08 10:48:43 +00:00
"detour": "upstream-out",
"bind_interface": "en0",
"routing_mark": 1234,
"reuse_addr": false,
"connect_timeout": "5s",
"tcp_fast_open": false,
"domain_strategy": "prefer_ipv6",
"fallback_delay": "300ms"
}
]
}
```
### Shadowsocks Fields
#### 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.
#### 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 structure](/configuration/shared/multiplex).
2022-07-08 10:48:43 +00:00
### Dial Fields
#### detour
The tag of the upstream outbound.
Other dial fields will be ignored when enabled.
#### bind_interface
The network interface to bind to.
#### routing_mark
2022-07-27 04:03:07 +00:00
!!! error ""
Linux only
2022-07-08 10:48:43 +00:00
2022-07-27 04:03:07 +00:00
The iptables routing mark.
2022-07-08 10:48:43 +00:00
#### reuse_addr
Reuse listener address.
#### connect_timeout
Connect timeout, in golang's Duration format.
A duration string is a possibly signed sequence of
decimal numbers, each with optional fraction and a unit suffix,
such as "300ms", "-1.5h" or "2h45m".
Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h".
#### domain_strategy
One of `prefer_ipv4` `prefer_ipv6` `ipv4_only` `ipv6_only`.
If set, the server domain name will be resolved to IP before connecting.
`dns.strategy` will be used if empty.
#### fallback_delay
The length of time to wait before spawning a RFC 6555 Fast Fallback connection.
That is, is the amount of time to wait for IPv6 to succeed before assuming
that IPv6 is misconfigured and falling back to IPv4 if `prefer_ipv4` is set.
If zero, a default delay of 300ms is used.
Only take effect when `domain_strategy` is `prefer_ipv4` or `prefer_ipv6`.