Browse Source

Update documentation

世界 3 years ago
parent
commit
39c141651a

+ 1 - 1
constant/version.go

@@ -1,3 +1,3 @@
 package constant
 
-var Version = "1.1-beta8"
+var Version = "1.1-beta9"

+ 8 - 5
docs/changelog.md

@@ -1,10 +1,9 @@
 #### 1.1-beta9
 
-* Fix windows route **1**:
-* Add direct io option for clash api
-* Add v2ray statistics api
-* Improve TLS writer
-* Other fixes
+* Fix windows route **1**
+* Add [v2ray statistics api](/configuration/experimental#v2ray-api-fields)
+* Add ShadowTLS v2 support **2**
+* Fixes and improvements
 
 **1**:
 
@@ -12,6 +11,10 @@
   Windows' [ordinary multihomed DNS resolution behavior](https://learn.microsoft.com/en-us/previous-versions/windows/it-pro/windows-server-2008-R2-and-2008/dd197552%28v%3Dws.10%29)
 * Flush Windows DNS cache when start/close
 
+**2**:
+
+See [ShadowTLS inbound](/configuration/inbound/shadowtls#version) and [ShadowTLS outbound](/configuration/outbound/shadowtls#version)
+
 #### 1.1-beta8
 
 * Fix leaks on close

+ 18 - 3
docs/configuration/inbound/shadowtls.md

@@ -7,6 +7,8 @@
 
   ... // Listen Fields
 
+  "version": 2,
+  "password": "fuck me till the daylight",
   "handshake": {
     "server": "google.com",
     "server_port": 443,
@@ -20,12 +22,25 @@
 
 See [Listen Fields](/configuration/shared/listen) for details.
 
-
 ### Fields
 
+#### version
+
+ShadowTLS protocol version.
+
+| Value         | Protocol Version                                                                        |
+|---------------|-----------------------------------------------------------------------------------------|
+| `1` (default) | [ShadowTLS v1](https://github.com/ihciah/shadow-tls/blob/master/docs/protocol-en.md#v1) |
+| `2`           | [ShadowTLS v2](https://github.com/ihciah/shadow-tls/blob/master/docs/protocol-en.md#v2) |
+
+#### password
+
+Set password.
+
+Only available in the ShadowTLS v2 protocol.
+
 #### handshake
 
 ==Required==
 
-Handshake server address and [dial options](/configuration/shared/dial).
-
+Handshake server address and [Dial options](/configuration/shared/dial).

+ 17 - 0
docs/configuration/inbound/shadowtls.zh.md

@@ -7,6 +7,8 @@
 
   ... // 监听字段
 
+  "version": 2,
+  "password": "fuck me till the daylight",
   "handshake": {
     "server": "google.com",
     "server_port": 443,
@@ -22,6 +24,21 @@
 
 ### 字段
 
+#### version
+
+ShadowTLS 协议版本。
+
+| 值             | 协议版本                                                                                    |
+|---------------|-----------------------------------------------------------------------------------------|
+| `1` (default) | [ShadowTLS v1](https://github.com/ihciah/shadow-tls/blob/master/docs/protocol-en.md#v1) |
+| `2`           | [ShadowTLS v2](https://github.com/ihciah/shadow-tls/blob/master/docs/protocol-en.md#v2) |
+
+#### password
+
+设置密码。
+
+仅在 ShadowTLS v2 协议中可用。
+
 #### handshake
 
 ==必填==

+ 17 - 0
docs/configuration/outbound/shadowtls.md

@@ -7,6 +7,8 @@
   
   "server": "127.0.0.1",
   "server_port": 1080,
+  "version": 2,
+  "password": "fuck me till the daylight",
   "tls": {},
 
   ... // Dial Fields
@@ -27,6 +29,21 @@ The server address.
 
 The server port.
 
+#### version
+
+ShadowTLS protocol version.
+
+| Value         | Protocol Version                                                                        |
+|---------------|-----------------------------------------------------------------------------------------|
+| `1` (default) | [ShadowTLS v1](https://github.com/ihciah/shadow-tls/blob/master/docs/protocol-en.md#v1) |
+| `2`           | [ShadowTLS v2](https://github.com/ihciah/shadow-tls/blob/master/docs/protocol-en.md#v2) |
+
+#### password
+
+Set password.
+
+Only available in the ShadowTLS v2 protocol.
+
 #### tls
 
 ==Required==

+ 17 - 0
docs/configuration/outbound/shadowtls.zh.md

@@ -7,6 +7,8 @@
   
   "server": "127.0.0.1",
   "server_port": 1080,
+  "version": 2,
+  "password": "fuck me till the daylight",
   "tls": {},
 
   ... // 拨号字段
@@ -27,6 +29,21 @@
 
 服务器端口。
 
+#### version
+
+ShadowTLS 协议版本。
+
+| 值             | 协议版本                                                                                    |
+|---------------|-----------------------------------------------------------------------------------------|
+| `1` (default) | [ShadowTLS v1](https://github.com/ihciah/shadow-tls/blob/master/docs/protocol-en.md#v1) |
+| `2`           | [ShadowTLS v2](https://github.com/ihciah/shadow-tls/blob/master/docs/protocol-en.md#v2) |
+
+#### password
+
+设置密码。
+
+仅在 ShadowTLS v2 协议中可用。
+
 #### tls
 
 ==必填==

+ 1 - 1
release/local/install_go.sh

@@ -1,7 +1,7 @@
 #!/usr/bin/env bash
 
 set -e -o pipefail
-curl -Lo go.tar.gz https://go.dev/dl/go1.19.1.linux-amd64.tar.gz
+curl -Lo go.tar.gz https://go.dev/dl/go1.19.2.linux-amd64.tar.gz
 sudo rm -rf /usr/local/go
 sudo tar -C /usr/local -xzf go.tar.gz
 rm go.tar.gz