Browse Source

Add documentation for shadowsocks multiplexer

世界 3 years ago
parent
commit
5f1f55fbe7

+ 5 - 0
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

+ 38 - 0
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`.

+ 1 - 1
docs/configuration/shared/tls.md

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

+ 1 - 0
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