black-internet-days-ahead/sing-box
1
0
Fork 0
mirror of https://github.com/SagerNet/sing-box.git synced 2024-11-22 00:21:30 +00:00
Code Issues Packages Projects Releases Wiki Activity

Fix documentation

Browse source
This commit is contained in:
世界 2023-02-18 19:27:22 +08:00
parent 67814faf92
commit 123c383eae
No known key found for this signature in database
GPG key ID: CD109927C34A63C4
4 changed files with 12 additions and 8 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

6
.github/workflows/mkdocs.yml vendored
View file

@ -14,5 +14,7 @@ jobs:
- uses: actions/setup-python@v4
with:
python-version: 3.x
- run: pip install mkdocs-material mkdocs-static-i18n
- run: mkdocs gh-deploy -m "{sha}" --force --ignore-version --no-history
- run: |
pip install mkdocs-material=="9.*" mkdocs-static-i18n=="0.53"
- run: |
mkdocs gh-deploy -m "{sha}" --force --ignore-version --no-history

5
docs/configuration/inbound/shadowtls.md
View file

@ -7,7 +7,7 @@
... // Listen Fields
"version": 2,
"version": 3,
"password": "fuck me till the daylight",
"handshake": {
"server": "google.com",
@ -32,12 +32,13 @@ ShadowTLS 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) |
| `3` | [ShadowTLS v3](https://github.com/ihciah/shadow-tls/blob/master/docs/protocol-v3-en.md) |
#### password
Set password.
Only available in the ShadowTLS v2 protocol.
Only available in the ShadowTLS v2/v3 protocol.
#### handshake

5
docs/configuration/inbound/shadowtls.zh.md
View file

@ -7,7 +7,7 @@
... // 监听字段
"version": 2,
"version": 3,
"password": "fuck me till the daylight",
"handshake": {
"server": "google.com",
@ -32,12 +32,13 @@ 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) |
| `3` | [ShadowTLS v3](https://github.com/ihciah/shadow-tls/blob/master/docs/protocol-v3-en.md) |
#### password
设置密码。
仅在 ShadowTLS v2 协议中可用。
仅在 ShadowTLS v2/v3 协议中可用。
#### handshake

4
docs/examples/shadowtls.md
View file

@ -7,7 +7,7 @@
"type": "shadowtls",
"listen": "::",
"listen_port": 4443,
"version": 2,
"version": 3,
"password": "fuck me till the daylight",
"handshake": {
"server": "google.com",
@ -47,7 +47,7 @@
"tag": "shadowtls-out",
"server": "127.0.0.1",
"server_port": 4443,
"version": 2,
"version": 3,
"password": "fuck me till the daylight",
"tls": {
"enabled": true,