Add documentation for shadowsocks multiplexer

This commit is contained in:
世界 2022-07-30 18:12:24 +08:00
parent 2d3d46eb34
commit 5f1f55fbe7
No known key found for this signature in database
GPG key ID: CD109927C34A63C4
4 changed files with 45 additions and 1 deletions

View file

@ -14,6 +14,7 @@
"method": "2022-blake3-aes-128-gcm", "method": "2022-blake3-aes-128-gcm",
"password": "8JCsPssfgS8tiRwiMlhARg==", "password": "8JCsPssfgS8tiRwiMlhARg==",
"network": "udp", "network": "udp",
"multiplex": {},
"detour": "upstream-out", "detour": "upstream-out",
"bind_interface": "en0", "bind_interface": "en0",
@ -84,6 +85,10 @@ One of `tcp` `udp`.
Both is enabled by default. Both is enabled by default.
#### multiplex
Multiplex configuration, see [Multiplex structure](/configuration/shared/multiplex).
### Dial Fields ### Dial Fields
#### detour #### detour

View file

@ -0,0 +1,38 @@
### Server Requirements
`sing-box` :)
### Structure
```json
{
"enabled": true,
"max_connections": 4,
"min_streams": 4,
"max_streams": 0
}
```
### Fields
#### enabled
Enable multiplex.
#### max_connections
Maximum connections.
Conflict with `max_streams`.
#### min_streams
Minimum multiplexed streams in a connection before opening a new connection.
Conflict with `min_streams`.
#### max_streams
Maximum multiplexed streams in a connection before opening a new connection.
Conflict with `max_connections` and `min_streams`.

View file

@ -63,7 +63,7 @@ Cipher suite values:
#### enabled #### enabled
Enabled TLS. Enable TLS.
#### server_name #### server_name

View file

@ -66,6 +66,7 @@ nav:
- Experimental: configuration/experimental.md - Experimental: configuration/experimental.md
- Shared: - Shared:
- TLS: configuration/shared/tls.md - TLS: configuration/shared/tls.md
- Multiplex: configuration/shared/multiplex.md
- Examples: - Examples:
- examples/index.md - examples/index.md
- Shadowsocks Server: examples/ss-server.md - Shadowsocks Server: examples/ss-server.md