Skip to content

Commit

Permalink
Update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
nekohasekai committed Oct 6, 2022
1 parent b0ad9bb commit 39c1416
Show file tree
Hide file tree
Showing 7 changed files with 79 additions and 10 deletions.
2 changes: 1 addition & 1 deletion constant/version.go
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
package constant

var Version = "1.1-beta8"
var Version = "1.1-beta9"
13 changes: 8 additions & 5 deletions docs/changelog.md
Original file line number Diff line number Diff line change
@@ -1,17 +1,20 @@
#### 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**:

* Fix DNS leak caused by
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
Expand Down
21 changes: 18 additions & 3 deletions docs/configuration/inbound/shadowtls.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,8 @@

... // Listen Fields

"version": 2,
"password": "fuck me till the daylight",
"handshake": {
"server": "google.com",
"server_port": 443,
Expand All @@ -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 changes: 17 additions & 0 deletions docs/configuration/inbound/shadowtls.zh.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,8 @@

... // 监听字段

"version": 2,
"password": "fuck me till the daylight",
"handshake": {
"server": "google.com",
"server_port": 443,
Expand All @@ -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

==必填==
Expand Down
17 changes: 17 additions & 0 deletions docs/configuration/outbound/shadowtls.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,8 @@

"server": "127.0.0.1",
"server_port": 1080,
"version": 2,
"password": "fuck me till the daylight",
"tls": {},

... // Dial Fields
Expand All @@ -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==
Expand Down
17 changes: 17 additions & 0 deletions docs/configuration/outbound/shadowtls.zh.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,8 @@

"server": "127.0.0.1",
"server_port": 1080,
"version": 2,
"password": "fuck me till the daylight",
"tls": {},

... // 拨号字段
Expand All @@ -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

==必填==
Expand Down
2 changes: 1 addition & 1 deletion release/local/install_go.sh
Original file line number Diff line number Diff line change
@@ -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

0 comments on commit 39c1416

Please sign in to comment.