CN-JS-HuiBai/SingboxForPanel
0
0
Fork 0
Code Issues Pull Requests Actions 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 253976d6c0
commit e8c4c942c0
104 changed files with 2170 additions and 1767 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@@ -36,7 +36,7 @@ No authentication required if empty.
#### set_system_proxy
!!! error ""
!!! quote ""
Only supported on Linux, Android, Windows, and macOS.

2
docs/configuration/inbound/http.zh.md
View File

@@ -36,7 +36,7 @@ HTTP 用户
#### set_system_proxy
!!! error ""
!!! quote ""
仅支持 Linux、Android、Windows 和 macOS。

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/mixed.md
View File

@@ -33,7 +33,7 @@ No authentication required if empty.
#### set_system_proxy
!!! error ""
!!! quote ""
Only supported on Linux, Android, Windows, and macOS.

2
docs/configuration/inbound/mixed.zh.md
View File

@@ -33,7 +33,7 @@ SOCKS 和 HTTP 用户
#### set_system_proxy
!!! error ""
!!! quote ""
仅支持 Linux、Android、Windows 和 macOS。

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/redirect.md
View File

@@ -1,4 +1,4 @@
!!! error ""
!!! quote ""
Only supported on Linux and macOS.

2
docs/configuration/inbound/redirect.zh.md
View File

@@ -1,4 +1,4 @@
!!! error ""
!!! quote ""
仅支持 Linux 和 macOS。

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

@@ -1,4 +1,4 @@
!!! error ""
!!! quote ""
Only supported on Linux.

2
docs/configuration/inbound/tproxy.zh.md
View File

@@ -1,4 +1,4 @@
!!! error ""
!!! quote ""
仅支持 Linux。

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

@@ -47,7 +47,7 @@ TLS configuration, see [TLS](/configuration/shared/tls/#inbound).
#### fallback
!!! error ""
!!! quote ""
There is no evidence that GFW detects and blocks Trojan servers based on HTTP responses, and opening the standard http/s port on the server is a much bigger signature.

2
docs/configuration/inbound/trojan.zh.md
View File

@@ -49,7 +49,7 @@ TLS 配置, 参阅 [TLS](/zh/configuration/shared/tls/#inbound)。
#### fallback
!!! error ""
!!! quote ""
没有证据表明 GFW 基于 HTTP 响应检测并阻止 Trojan 服务器，并且在服务器上打开标准 http/s 端口是一个更大的特征。

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

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

@@ -1,4 +1,4 @@
!!! error ""
!!! quote ""
Only supported on Linux, Windows and macOS.
@@ -102,7 +102,7 @@ The maximum transmission unit.
Set the default route to the Tun.
!!! error ""
!!! quote ""
To avoid traffic loopback, set `route.auto_detect_interface` or `route.default_interface` or `outbound.bind_interface`
@@ -171,11 +171,11 @@ 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
!!! error ""
!!! quote ""
Interface rules are only supported on Linux and require auto_route.
@@ -191,7 +191,7 @@ Conflict with `include_interface`.
#### include_uid
!!! error ""
!!! quote ""
UID rules are only supported on Linux and require auto_route.
@@ -211,7 +211,7 @@ Exclude users in route, but in range.
#### include_android_user
!!! error ""
!!! quote ""
Android user and package rules are only supported on Android and require auto_route.

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

@@ -1,4 +1,4 @@
!!! error ""
!!! quote ""
仅支持 Linux、Windows 和 macOS。
@@ -102,7 +102,7 @@ tun 接口的 IPv6 前缀。
设置到 Tun 的默认路由。
!!! error ""
!!! quote ""
为避免流量环回，请设置 `route.auto_detect_interface` 或 `route.default_interface` 或 `outbound.bind_interface`。
@@ -171,7 +171,7 @@ TCP/IP 栈。
#### include_interface
!!! error ""
!!! quote ""
接口规则仅在 Linux 下被支持，并且需要 `auto_route`。
@@ -187,7 +187,7 @@ TCP/IP 栈。
#### include_uid
!!! error ""
!!! quote ""
UID 规则仅在 Linux 下被支持，并且需要 `auto_route`。
@@ -207,7 +207,7 @@ TCP/IP 栈。
#### include_android_user
!!! error ""
!!! quote ""
Android 用户和应用规则仅在 Android 下被支持，并且需要 `auto_route`。