chunyu/sing-box
1
0
Fork 0
mirror of https://github.com/SagerNet/sing-box.git synced 2025-06-13 21:54:13 +08:00
Code Issues Packages Projects Releases Wiki Activity

Update documentation

Browse Source
This commit is contained in:
H1JK 2023-01-28 10:31:03 +08:00
parent 29259c63ee
commit 34d7ba04c7
4 changed files with 26 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
docs/configuration/inbound/mtproto.md
View File

@ -7,7 +7,12 @@
... // Listen Fields ... // Listen Fields
"secret": "" "users": [
{
"name": "sekai",
"secret": "ee134132e79f44020784bddce2e734b5e2676f6f676c652e636f6d"
}
]
} }
``` ```
@ -21,8 +26,12 @@ See [Listen Fields](/configuration/shared/listen) for details.
### Fields ### Fields
#### secret #### users
==Required== ==Required==
MTProto V3 secret. MTProto users, where secret is a MTProto V3 secret.
!!! note ""
MTProto multi-user inbound might be poor on performance limited to its authentication algorithm.

15
docs/configuration/inbound/mtproto.zh.md
View File

@ -7,7 +7,12 @@
... // 监听字段 ... // 监听字段
"secret": "" "users": [
{
"name": "sekai",
"secret": "ee134132e79f44020784bddce2e734b5e2676f6f676c652e636f6d"
}
]
} }
``` ```
@ -21,8 +26,12 @@
### 字段 ### 字段
#### secret #### users
==必填== ==必填==
MTProto V3 密钥。 MTProto 用户，其中 secret 是 MTProto V3 密钥。
!!! note ""
受限于其身份认证算法，MTProto 多用户入站可能性能不佳。

1
docs/index.md
View File

@ -30,7 +30,6 @@ go install -v -tags with_clash_api github.com/sagernet/sing-box/cmd/sing-box@lat
| `with_shadowsocksr` | Build with ShadowsocksR support, see [ShadowsocksR outbound](./configuration/outbound/shadowsocksr). | | `with_shadowsocksr` | Build with ShadowsocksR support, see [ShadowsocksR outbound](./configuration/outbound/shadowsocksr). |
| `with_ech` | Build with TLS ECH extension support for TLS outbound, see [TLS](./configuration/shared/tls#ech). | | `with_ech` | Build with TLS ECH extension support for TLS outbound, see [TLS](./configuration/shared/tls#ech). |
| `with_utls` | Build with [uTLS](https://github.com/refraction-networking/utls) support for TLS outbound, see [TLS](./configuration/shared/tls#utls). | | `with_utls` | Build with [uTLS](https://github.com/refraction-networking/utls) support for TLS outbound, see [TLS](./configuration/shared/tls#utls). |
| `with_mtproto` | Build with MTProto inbound support, see [TLS](./configuration/inbound/mtproto). |
| `with_acme` | Build with ACME TLS certificate issuer support, see [TLS](./configuration/shared/tls). | | `with_acme` | Build with ACME TLS certificate issuer support, see [TLS](./configuration/shared/tls). |
| `with_clash_api` | Build with Clash API support, see [Experimental](./configuration/experimental#clash-api-fields). | | `with_clash_api` | Build with Clash API support, see [Experimental](./configuration/experimental#clash-api-fields). |
| `with_v2ray_api` | Build with V2Ray API support, see [Experimental](./configuration/experimental#v2ray-api-fields). | | `with_v2ray_api` | Build with V2Ray API support, see [Experimental](./configuration/experimental#v2ray-api-fields). |

1
docs/index.zh.md
View File

@ -30,7 +30,6 @@ go install -v -tags with_clash_api github.com/sagernet/sing-box/cmd/sing-box@lat
| `with_shadowsocksr` | 启用 ShadowsocksR 支持，参阅 [ShadowsocksR 出站](./configuration/outbound/shadowsocksr)。 | | `with_shadowsocksr` | 启用 ShadowsocksR 支持，参阅 [ShadowsocksR 出站](./configuration/outbound/shadowsocksr)。 |
| `with_ech` | 启用 TLS ECH 扩展支持，参阅 [TLS](./configuration/shared/tls#ech)。 | | `with_ech` | 启用 TLS ECH 扩展支持，参阅 [TLS](./configuration/shared/tls#ech)。 |
| `with_utls` | 启用 uTLS 支持，参阅 [实验性](./configuration/experimental#clash-api-fields)。 | | `with_utls` | 启用 uTLS 支持，参阅 [实验性](./configuration/experimental#clash-api-fields)。 |
| `with_mtproto` | 启用 MTProto 支持，参阅 [实验性](./configuration/inbound/mtproto)。 |
| `with_acme` | 启用 ACME TLS 证书签发支持，参阅 [TLS](./configuration/shared/tls)。 | | `with_acme` | 启用 ACME TLS 证书签发支持，参阅 [TLS](./configuration/shared/tls)。 |
| `with_clash_api` | 启用 Clash API 支持，参阅 [实验性](./configuration/experimental#clash-api-fields)。 | | `with_clash_api` | 启用 Clash API 支持，参阅 [实验性](./configuration/experimental#clash-api-fields)。 |
| `with_v2ray_api` | 启用 V2Rat API 支持，参阅 [实验性](./configuration/experimental#v2ray-api-fields)。 | | `with_v2ray_api` | 启用 V2Rat API 支持，参阅 [实验性](./configuration/experimental#v2ray-api-fields)。 |