yanistyle/sing-box-extended
1
0
Fork 0
mirror of https://github.com/shtorm-7/sing-box-extended.git synced 2026-06-08 12:14:54 +03:00
Code Issues Packages Projects Releases Wiki Activity

documentation: Bump version & Refactor docs

Browse Source
This commit is contained in:
世界
2023-11-09 17:04:08 +08:00
parent 8060b30e56
commit e48e5a309f
83 changed files with 1600 additions and 1716 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
docs/configuration/dns/server.md
View File

@@ -49,7 +49,7 @@ The address of the dns server.
!!! warning ""
QUIC and HTTP3 transport is not included by default, see [Installation](/#installation).
QUIC and HTTP3 transport is not included by default, see [Installation](./#installation).
!!! info ""
@@ -57,7 +57,7 @@ The address of the dns server.
!!! warning ""
DHCP transport is not included by default, see [Installation](/#installation).
DHCP transport is not included by default, see [Installation](./#installation).
| RCode | Description |
|-------------------|-----------------------|

4
docs/configuration/experimental/index.md
View File

@@ -46,7 +46,7 @@
!!! error ""
Clash API is not included by default, see [Installation](/#installation).
Clash API is not included by default, see [Installation](./#installation).
#### external_controller
@@ -112,7 +112,7 @@ If not empty, `store_selected` will use a separate store keyed by it.
!!! error ""
V2Ray API is not included by default, see [Installation](/#installation).
V2Ray API is not included by default, see [Installation](./#installation).
#### listen

2
docs/configuration/inbound/hysteria.md
View File

@@ -31,7 +31,7 @@
!!! warning ""
QUIC, which is required by hysteria is not included by default, see [Installation](/#installation).
QUIC, which is required by hysteria is not included by default, see [Installation](./#installation).
### Listen Fields

13
docs/configuration/inbound/hysteria2.md
View File

@@ -4,8 +4,8 @@
{
"type": "hysteria2",
"tag": "hy2-in",
... // Listen Fields
...
// Listen Fields
"up_mbps": 100,
"down_mbps": 100,
@@ -28,7 +28,14 @@
!!! warning ""
QUIC, which is required by Hysteria2 is not included by default, see [Installation](/#installation).
QUIC, which is required by Hysteria2 is not included by default, see [Installation](./#installation).
!!! warning "Difference from official Hysteria2"
The official program supports an authentication method called **userpass**,
which essentially uses a combination of `<username>:<password>` as the actual password,
while sing-box does not provide this alias.
To use sing-box with the official program, you need to fill in that combination as the actual password.
### Listen Fields

10
docs/configuration/inbound/hysteria2.zh.md
View File

@@ -4,8 +4,8 @@
{
"type": "hysteria2",
"tag": "hy2-in",
... // 监听字段
...
// 监听字段
"up_mbps": 100,
"down_mbps": 100,
@@ -30,6 +30,12 @@
默认安装不包含被 Hysteria2 依赖的 QUIC，参阅 [安装](/zh/#_2)。
!!! warning "与官方 Hysteria2 的区别"
官方程序支持一种名为 **userpass** 的验证方式，
本质上上是将用户名与密码的组合 `<username>:<password>` 作为实际上的密码，而 sing-box 不提供此别名。
要将 sing-box 与官方程序一起使用， 您需要填写该组合作为实际密码。
### 监听字段
参阅 [监听字段](/zh/configuration/shared/listen/)。

2
docs/configuration/inbound/naive.md
View File

@@ -20,7 +20,7 @@
!!! warning ""
HTTP3 transport is not included by default, see [Installation](/#installation).
HTTP3 transport is not included by default, see [Installation](./#installation).
### Listen Fields

2
docs/configuration/inbound/tuic.md
View File

@@ -24,7 +24,7 @@
!!! warning ""
QUIC, which is required by TUIC is not included by default, see [Installation](/#installation).
QUIC, which is required by TUIC is not included by default, see [Installation](./#installation).
### Listen Fields

2
docs/configuration/inbound/tun.md
View File

@@ -171,7 +171,7 @@ TCP/IP stack.
!!! warning ""
gVisor and LWIP stacks is not included by default, see [Installation](/#installation).
gVisor and LWIP stacks is not included by default, see [Installation](./#installation).
#### include_interface

2
docs/configuration/outbound/hysteria.md
View File

@@ -26,7 +26,7 @@
!!! warning ""
QUIC, which is required by hysteria is not included by default, see [Installation](/#installation).
QUIC, which is required by hysteria is not included by default, see [Installation](./#installation).
### Fields

10
docs/configuration/outbound/hysteria2.md
View File

@@ -24,7 +24,15 @@
!!! warning ""
QUIC, which is required by Hysteria2 is not included by default, see [Installation](/#installation).
QUIC, which is required by Hysteria2 is not included by default, see [Installation](./#installation).
!!! warning "Difference from official Hysteria2"
The official Hysteria2 supports an authentication method called **userpass**,
which essentially uses a combination of `<username>:<password>` as the actual password,
while sing-box does not provide this alias.
If you are planning to use sing-box with the official program,
please note that you will need to fill the combination as the password.
### Fields

6
docs/configuration/outbound/hysteria2.zh.md
View File

@@ -26,6 +26,12 @@
默认安装不包含被 Hysteria2 依赖的 QUIC，参阅 [安装](/zh/#_2)。
!!! warning "与官方 Hysteria2 的区别"
官方程序支持一种名为 **userpass** 的验证方式，
本质上上是将用户名与密码的组合 `<username>:<password>` 作为实际上的密码，而 sing-box 不提供此别名。
要将 sing-box 与官方程序一起使用， 您需要填写该组合作为实际密码。
### 字段
#### server

2
docs/configuration/outbound/shadowsocksr.md
View File

@@ -25,7 +25,7 @@
!!! warning ""
ShadowsocksR is not included by default, see [Installation](/#installation).
ShadowsocksR is not included by default, see [Installation](./#installation).
### Fields

2
docs/configuration/outbound/tor.md
View File

@@ -18,7 +18,7 @@
!!! info ""
Embedded tor is not included by default, see [Installation](/#installation).
Embedded tor is not included by default, see [Installation](./#installation).
### Fields

2
docs/configuration/outbound/tuic.md
View File

@@ -23,7 +23,7 @@
!!! warning ""
QUIC, which is required by TUIC is not included by default, see [Installation](/#installation).
QUIC, which is required by TUIC is not included by default, see [Installation](./#installation).
### Fields

4
docs/configuration/outbound/wireguard.md
View File

@@ -38,11 +38,11 @@
!!! warning ""
WireGuard is not included by default, see [Installation](/#installation).
WireGuard is not included by default, see [Installation](./#installation).
!!! warning ""
gVisor, which is required by the unprivileged WireGuard is not included by default, see [Installation](/#installation).
gVisor, which is required by the unprivileged WireGuard is not included by default, see [Installation](./#installation).
### Fields

10
docs/configuration/shared/tls.md
View File

@@ -201,7 +201,7 @@ The path to the server private key, in PEM format.
!!! warning ""
uTLS is not included by default, see [Installation](/#installation).
uTLS is not included by default, see [Installation](./#installation).
!!! note ""
@@ -228,7 +228,7 @@ Chrome fingerprint will be used if empty.
!!! warning ""
ECH is not included by default, see [Installation](/#installation).
ECH is not included by default, see [Installation](./#installation).
ECH (Encrypted Client Hello) is a TLS extension that allows a client to encrypt the first part of its ClientHello
message.
@@ -280,7 +280,7 @@ If empty, load from DNS will be attempted.
!!! warning ""
ACME is not included by default, see [Installation](/#installation).
ACME is not included by default, see [Installation](./#installation).
#### domain
@@ -359,11 +359,11 @@ See [DNS01 Challenge Fields](/configuration/shared/dns01_challenge) for details.
!!! warning ""
reality server is not included by default, see [Installation](/#installation).
reality server is not included by default, see [Installation](./#installation).
!!! warning ""
uTLS, which is required by reality client is not included by default, see [Installation](/#installation).
uTLS, which is required by reality client is not included by default, see [Installation](./#installation).
#### handshake

4
docs/configuration/shared/v2ray-transport.md
View File

@@ -131,7 +131,7 @@ It needs to be consistent with the server.
!!! warning ""
QUIC is not included by default, see [Installation](/#installation).
QUIC is not included by default, see [Installation](./#installation).
!!! warning "Difference from v2ray-core"
@@ -142,7 +142,7 @@ It needs to be consistent with the server.
!!! note ""
standard gRPC has good compatibility but poor performance and is not included by default, see [Installation](/#installation).
standard gRPC has good compatibility but poor performance and is not included by default, see [Installation](./#installation).
```json
{