documentation: Bump version & Refactor docs

2023-11-09 17:04:08 +08:00
parent 253976d6c0
commit e8c4c942c0
104 changed files with 2170 additions and 1767 deletions
--- a/docs/configuration/dns/rule.md
+++ b/docs/configuration/dns/rule.md
@@ -79,6 +79,12 @@
          1000
        ],
        "clash_mode": "direct",
+        "wifi_ssid": [
+          "My WIFI"
+        ],
+        "wifi_bssid": [
+          "00:00:00:00:00:00"
+        ],
        "invert": false,
        "outbound": [
          "direct"
@@ -188,7 +194,7 @@ Match port range.

 #### process_name

-!!! error ""
+!!! quote ""

    Only supported on Linux, Windows, and macOS.

@@ -196,7 +202,7 @@ Match process name.

 #### process_path

-!!! error ""
+!!! quote ""

    Only supported on Linux, Windows, and macOS.

@@ -208,7 +214,7 @@ Match android package name.

 #### user

-!!! error ""
+!!! quote ""

    Only supported on Linux.

@@ -216,7 +222,7 @@ Match user name.

 #### user_id

-!!! error ""
+!!! quote ""

    Only supported on Linux.

@@ -226,6 +232,24 @@ Match user id.

 Match Clash mode.

+#### wifi_ssid
+
+<!-- md:version 1.7.0-beta.4 -->
+
+!!! quote ""
+
+    Only supported in graphical clients on Android and iOS.
+
+Match WiFi SSID.
+
+#### wifi_bssid
+
+!!! quote ""
+
+    Only supported in graphical clients on Android and iOS.
+
+Match WiFi BSSID.
+
 #### invert

 Invert match result.
--- a/docs/configuration/dns/rule.zh.md
+++ b/docs/configuration/dns/rule.zh.md
@@ -78,6 +78,12 @@
          1000
        ],
        "clash_mode": "direct",
+        "wifi_ssid": [
+          "My WIFI"
+        ],
+        "wifi_bssid": [
+          "00:00:00:00:00:00"
+        ],
        "invert": false,
        "outbound": [
          "direct"
@@ -185,7 +191,7 @@ DNS 查询类型。值可以为整数或者类型名称字符串。

 #### process_name

-!!! error ""
+!!! quote ""

    仅支持 Linux、Windows 和 macOS.

@@ -193,7 +199,7 @@ DNS 查询类型。值可以为整数或者类型名称字符串。

 #### process_path

-!!! error ""
+!!! quote ""

    仅支持 Linux、Windows 和 macOS.

@@ -205,7 +211,7 @@ DNS 查询类型。值可以为整数或者类型名称字符串。

 #### user

-!!! error ""
+!!! quote ""

    仅支持 Linux。

@@ -213,7 +219,7 @@ DNS 查询类型。值可以为整数或者类型名称字符串。

 #### user_id

-!!! error ""
+!!! quote ""

    仅支持 Linux。

@@ -223,6 +229,22 @@ DNS 查询类型。值可以为整数或者类型名称字符串。

 匹配 Clash 模式。

+#### wifi_ssid
+
+!!! quote ""
+
+    仅在 Android 与 iOS 的图形客户端中支持。
+
+匹配 WiFi SSID。
+
+#### wifi_bssid
+
+!!! quote ""
+
+    仅在 Android 与 iOS 的图形客户端中支持。
+
+匹配 WiFi BSSID。
+
 #### invert

 反选匹配结果。
--- a/docs/configuration/dns/server.md
+++ b/docs/configuration/dns/server.md
@@ -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           | 
 |-------------------|-----------------------|
--- a/docs/configuration/experimental/index.md
+++ b/docs/configuration/experimental/index.md
@@ -44,9 +44,9 @@

 ### Clash API Fields

-!!! error ""
+!!! quote ""

-    Clash API is not included by default, see [Installation](/#installation).
+    Clash API is not included by default, see [Installation](./#installation).

 #### external_controller

@@ -110,9 +110,9 @@ If not empty, `store_selected` will use a separate store keyed by it.

 ### V2Ray API Fields

-!!! error ""
+!!! quote ""

-    V2Ray API is not included by default, see [Installation](/#installation).
+    V2Ray API is not included by default, see [Installation](./#installation).

 #### listen

--- a/docs/configuration/experimental/index.zh.md
+++ b/docs/configuration/experimental/index.zh.md
@@ -44,7 +44,7 @@

 ### Clash API 字段

-!!! error ""
+!!! quote ""

    默认安装不包含 Clash API，参阅 [安装](/zh/#_2)。

@@ -108,7 +108,7 @@ Clash 中的默认模式，默认使用 `Rule`。

 ### V2Ray API 字段

-!!! error ""
+!!! quote ""

    默认安装不包含 V2Ray API，参阅 [安装](/zh/#_2)。

--- a/docs/configuration/inbound/http.md
+++ b/docs/configuration/inbound/http.md
@@ -36,7 +36,7 @@ No authentication required if empty.

 #### set_system_proxy

-!!! error ""
+!!! quote ""

    Only supported on Linux, Android, Windows, and macOS.

--- a/docs/configuration/inbound/http.zh.md
+++ b/docs/configuration/inbound/http.zh.md
@@ -36,7 +36,7 @@ HTTP 用户

 #### set_system_proxy

-!!! error ""
+!!! quote ""

    仅支持 Linux、Android、Windows 和 macOS。

--- a/docs/configuration/inbound/hysteria.md
+++ b/docs/configuration/inbound/hysteria.md
@@ -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

--- a/docs/configuration/inbound/hysteria2.md
+++ b/docs/configuration/inbound/hysteria2.md
@@ -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

--- a/docs/configuration/inbound/hysteria2.zh.md
+++ b/docs/configuration/inbound/hysteria2.zh.md
@@ -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/)。
--- a/docs/configuration/inbound/mixed.md
+++ b/docs/configuration/inbound/mixed.md
@@ -33,7 +33,7 @@ No authentication required if empty.

 #### set_system_proxy

-!!! error ""
+!!! quote ""

    Only supported on Linux, Android, Windows, and macOS.

--- a/docs/configuration/inbound/mixed.zh.md
+++ b/docs/configuration/inbound/mixed.zh.md
@@ -33,7 +33,7 @@ SOCKS 和 HTTP 用户

 #### set_system_proxy

-!!! error ""
+!!! quote ""

    仅支持 Linux、Android、Windows 和 macOS。

--- a/docs/configuration/inbound/naive.md
+++ b/docs/configuration/inbound/naive.md
@@ -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

--- a/docs/configuration/inbound/redirect.md
+++ b/docs/configuration/inbound/redirect.md
@@ -1,4 +1,4 @@
-!!! error ""
+!!! quote ""

    Only supported on Linux and macOS.

--- a/docs/configuration/inbound/redirect.zh.md
+++ b/docs/configuration/inbound/redirect.zh.md
@@ -1,4 +1,4 @@
-!!! error ""
+!!! quote ""

    仅支持 Linux 和 macOS。

--- a/docs/configuration/inbound/tproxy.md
+++ b/docs/configuration/inbound/tproxy.md
@@ -1,4 +1,4 @@
-!!! error ""
+!!! quote ""

    Only supported on Linux.

--- a/docs/configuration/inbound/tproxy.zh.md
+++ b/docs/configuration/inbound/tproxy.zh.md
@@ -1,4 +1,4 @@
-!!! error ""
+!!! quote ""

    仅支持 Linux。

--- a/docs/configuration/inbound/trojan.md
+++ b/docs/configuration/inbound/trojan.md
@@ -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.

--- a/docs/configuration/inbound/trojan.zh.md
+++ b/docs/configuration/inbound/trojan.zh.md
@@ -49,7 +49,7 @@ TLS 配置, 参阅 [TLS](/zh/configuration/shared/tls/#inbound)。

 #### fallback

-!!! error ""
+!!! quote ""

    没有证据表明 GFW 基于 HTTP 响应检测并阻止 Trojan 服务器，并且在服务器上打开标准 http/s 端口是一个更大的特征。

--- a/docs/configuration/inbound/tuic.md
+++ b/docs/configuration/inbound/tuic.md
@@ -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

--- a/docs/configuration/inbound/tun.md
+++ b/docs/configuration/inbound/tun.md
@@ -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.

--- a/docs/configuration/inbound/tun.zh.md
+++ b/docs/configuration/inbound/tun.zh.md
@@ -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`。

--- a/docs/configuration/outbound/hysteria.md
+++ b/docs/configuration/outbound/hysteria.md
@@ -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

--- a/docs/configuration/outbound/hysteria2.md
+++ b/docs/configuration/outbound/hysteria2.md
@@ -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

--- a/docs/configuration/outbound/hysteria2.zh.md
+++ b/docs/configuration/outbound/hysteria2.zh.md
@@ -26,6 +26,12 @@

    默认安装不包含被 Hysteria2 依赖的 QUIC，参阅 [安装](/zh/#_2)。

+!!! warning "与官方 Hysteria2 的区别"
+
+    官方程序支持一种名为 **userpass** 的验证方式，
+    本质上上是将用户名与密码的组合 `<username>:<password>` 作为实际上的密码，而 sing-box 不提供此别名。
+    要将 sing-box 与官方程序一起使用， 您需要填写该组合作为实际密码。
+
 ### 字段

 #### server
--- a/docs/configuration/outbound/selector.md
+++ b/docs/configuration/outbound/selector.md
@@ -15,7 +15,7 @@
 }
 ```

-!!! error ""
+!!! quote ""

    The selector can only be controlled through the [Clash API](/configuration/experimental#clash-api-fields) currently.

--- a/docs/configuration/outbound/selector.zh.md
+++ b/docs/configuration/outbound/selector.zh.md
@@ -15,7 +15,7 @@
 }
 ```

-!!! error ""
+!!! quote ""

    选择器目前只能通过 [Clash API](/zh/configuration/experimental#clash-api) 来控制。

--- a/docs/configuration/outbound/shadowsocksr.md
+++ b/docs/configuration/outbound/shadowsocksr.md
@@ -25,7 +25,7 @@

 !!! warning ""

-    ShadowsocksR is not included by default, see [Installation](/#installation).
+    ShadowsocksR is not included by default, see [Installation](./#installation).

 ### Fields

--- a/docs/configuration/outbound/tor.md
+++ b/docs/configuration/outbound/tor.md
@@ -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

--- a/docs/configuration/outbound/tuic.md
+++ b/docs/configuration/outbound/tuic.md
@@ -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

--- a/docs/configuration/outbound/wireguard.md
+++ b/docs/configuration/outbound/wireguard.md
@@ -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

--- a/docs/configuration/route/index.md
+++ b/docs/configuration/route/index.md
@@ -31,7 +31,7 @@ Default outbound tag. the first outbound will be used if empty.

 #### auto_detect_interface

-!!! error ""
+!!! quote ""

    Only supported on Linux, Windows and macOS.

@@ -41,7 +41,7 @@ Takes no effect if `outbound.bind_interface` is set.

 #### override_android_vpn

-!!! error ""
+!!! quote ""

    Only supported on Android.

@@ -49,7 +49,7 @@ Accept Android VPN as upstream NIC when `auto_detect_interface` enabled.

 #### default_interface

-!!! error ""
+!!! quote ""

    Only supported on Linux, Windows and macOS.

@@ -59,7 +59,7 @@ Takes no effect if `auto_detect_interface` is set.

 #### default_mark

-!!! error ""
+!!! quote ""

    Only supported on Linux.

--- a/docs/configuration/route/index.zh.md
+++ b/docs/configuration/route/index.zh.md
@@ -32,7 +32,7 @@

 #### auto_detect_interface

-!!! error ""
+!!! quote ""

    仅支持 Linux、Windows 和 macOS。

@@ -42,7 +42,7 @@

 #### override_android_vpn

-!!! error ""
+!!! quote ""

    仅支持 Android。

@@ -50,7 +50,7 @@

 #### default_interface

-!!! error ""
+!!! quote ""

    仅支持 Linux、Windows 和 macOS。

@@ -60,7 +60,7 @@

 #### default_mark

-!!! error ""
+!!! quote ""

    仅支持 Linux。

--- a/docs/configuration/route/rule.md
+++ b/docs/configuration/route/rule.md
@@ -83,6 +83,12 @@
          1000
        ],
        "clash_mode": "direct",
+        "wifi_ssid": [
+          "My WIFI"
+        ],
+        "wifi_bssid": [
+          "00:00:00:00:00:00"
+        ],
        "invert": false,
        "outbound": "direct"
      },
@@ -190,7 +196,7 @@ Match port range.

 #### process_name

-!!! error ""
+!!! quote ""

    Only supported on Linux, Windows, and macOS.

@@ -198,7 +204,7 @@ Match process name.

 #### process_path

-!!! error ""
+!!! quote ""

    Only supported on Linux, Windows, and macOS.

@@ -210,7 +216,7 @@ Match android package name.

 #### user

-!!! error ""
+!!! quote ""

    Only supported on Linux.

@@ -218,7 +224,7 @@ Match user name.

 #### user_id

-!!! error ""
+!!! quote ""

    Only supported on Linux.

@@ -228,6 +234,22 @@ Match user id.

 Match Clash mode.

+#### wifi_ssid
+
+!!! quote ""
+
+    Only supported in graphical clients on Android and iOS.
+
+Match WiFi SSID.
+
+#### wifi_bssid
+
+!!! quote ""
+
+    Only supported in graphical clients on Android and iOS.
+
+Match WiFi BSSID.
+
 #### invert

 Invert match result.
--- a/docs/configuration/route/rule.zh.md
+++ b/docs/configuration/route/rule.zh.md
@@ -81,6 +81,12 @@
          1000
        ],
        "clash_mode": "direct",
+        "wifi_ssid": [
+          "My WIFI"
+        ],
+        "wifi_bssid": [
+          "00:00:00:00:00:00"
+        ],
        "invert": false,
        "outbound": "direct"
      },
@@ -188,7 +194,7 @@

 #### process_name

-!!! error ""
+!!! quote ""

    仅支持 Linux、Windows 和 macOS。

@@ -196,7 +202,7 @@

 #### process_path

-!!! error ""
+!!! quote ""

    仅支持 Linux、Windows 和 macOS.

@@ -208,7 +214,7 @@

 #### user

-!!! error ""
+!!! quote ""

    仅支持 Linux.

@@ -216,7 +222,7 @@

 #### user_id

-!!! error ""
+!!! quote ""

    仅支持 Linux.

@@ -226,6 +232,22 @@

 匹配 Clash 模式。

+#### wifi_ssid
+
+!!! quote ""
+
+    仅在 Android 与 iOS 的图形客户端中支持。
+
+匹配 WiFi SSID。
+
+#### wifi_bssid
+
+!!! quote ""
+
+    仅在 Android 与 iOS 的图形客户端中支持。
+
+匹配 WiFi BSSID。
+
 #### invert

 反选匹配结果。
--- a/docs/configuration/shared/dial.md
+++ b/docs/configuration/shared/dial.md
@@ -41,7 +41,7 @@ The IPv6 address to bind to.

 #### routing_mark

-!!! error ""
+!!! quote ""

    Only supported on Linux.

--- a/docs/configuration/shared/dial.zh.md
+++ b/docs/configuration/shared/dial.zh.md
@@ -44,7 +44,7 @@

 #### routing_mark

-!!! error ""
+!!! quote ""

    仅支持 Linux。

--- a/docs/configuration/shared/tls.md
+++ b/docs/configuration/shared/tls.md
@@ -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

--- a/docs/configuration/shared/v2ray-transport.md
+++ b/docs/configuration/shared/v2ray-transport.md
@@ -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
 {