diff --git a/docs/configuration/outbound/shadowsocks.md b/docs/configuration/outbound/shadowsocks.md index da42da06..fdc8ee12 100644 --- a/docs/configuration/outbound/shadowsocks.md +++ b/docs/configuration/outbound/shadowsocks.md @@ -14,6 +14,7 @@ "method": "2022-blake3-aes-128-gcm", "password": "8JCsPssfgS8tiRwiMlhARg==", "network": "udp", + "multiplex": {}, "detour": "upstream-out", "bind_interface": "en0", @@ -84,6 +85,10 @@ One of `tcp` `udp`. Both is enabled by default. +#### multiplex + +Multiplex configuration, see [Multiplex structure](/configuration/shared/multiplex). + ### Dial Fields #### detour diff --git a/docs/configuration/shared/multiplex.md b/docs/configuration/shared/multiplex.md new file mode 100644 index 00000000..534827b0 --- /dev/null +++ b/docs/configuration/shared/multiplex.md @@ -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`. diff --git a/docs/configuration/shared/tls.md b/docs/configuration/shared/tls.md index 85763385..e0072e0a 100644 --- a/docs/configuration/shared/tls.md +++ b/docs/configuration/shared/tls.md @@ -63,7 +63,7 @@ Cipher suite values: #### enabled -Enabled TLS. +Enable TLS. #### server_name diff --git a/mkdocs.yml b/mkdocs.yml index 7d0f1b67..9e370451 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -66,6 +66,7 @@ nav: - Experimental: configuration/experimental.md - Shared: - TLS: configuration/shared/tls.md + - Multiplex: configuration/shared/multiplex.md - Examples: - examples/index.md - Shadowsocks Server: examples/ss-server.md