From 080bdf4561286a21b56f206ad6e7c72cd671282d Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E4=B8=96=E7=95=8C?= Date: Thu, 14 Dec 2023 22:23:52 +0800 Subject: [PATCH] documentation: Fix link format --- docs/changelog.md | 140 +++++++++--------- docs/clients/index.md | 4 +- docs/clients/index.zh.md | 4 +- docs/configuration/dns/index.md | 8 +- docs/configuration/dns/index.zh.md | 6 +- docs/configuration/dns/rule.md | 2 +- docs/configuration/dns/rule.zh.md | 2 +- docs/configuration/dns/server.md | 2 +- docs/configuration/dns/server.zh.md | 2 +- docs/configuration/experimental/index.md | 6 +- docs/configuration/experimental/index.zh.md | 6 +- docs/configuration/inbound/direct.md | 2 +- docs/configuration/inbound/http.md | 2 +- docs/configuration/inbound/hysteria.md | 2 +- docs/configuration/inbound/hysteria2.md | 2 +- docs/configuration/inbound/index.md | 32 ++-- docs/configuration/inbound/index.zh.md | 32 ++-- docs/configuration/inbound/mixed.md | 2 +- docs/configuration/inbound/naive.md | 2 +- docs/configuration/inbound/redirect.md | 2 +- docs/configuration/inbound/shadowsocks.md | 2 +- docs/configuration/inbound/shadowsocks.zh.md | 2 +- docs/configuration/inbound/shadowtls.md | 6 +- docs/configuration/inbound/socks.md | 2 +- docs/configuration/inbound/tproxy.md | 2 +- docs/configuration/inbound/trojan.md | 4 +- docs/configuration/inbound/trojan.zh.md | 2 +- docs/configuration/inbound/tuic.md | 2 +- docs/configuration/inbound/tun.md | 2 +- docs/configuration/inbound/vless.md | 4 +- docs/configuration/inbound/vless.zh.md | 2 +- docs/configuration/inbound/vmess.md | 4 +- docs/configuration/inbound/vmess.zh.md | 2 +- docs/configuration/index.md | 14 +- docs/configuration/index.zh.md | 12 +- docs/configuration/ntp/index.md | 2 +- docs/configuration/outbound/direct.md | 2 +- docs/configuration/outbound/http.md | 2 +- docs/configuration/outbound/hysteria.md | 2 +- docs/configuration/outbound/hysteria2.md | 2 +- docs/configuration/outbound/index.md | 36 ++--- docs/configuration/outbound/index.zh.md | 36 ++--- docs/configuration/outbound/shadowsocks.md | 4 +- docs/configuration/outbound/shadowsocks.zh.md | 2 +- docs/configuration/outbound/shadowtls.md | 2 +- docs/configuration/outbound/socks.md | 4 +- docs/configuration/outbound/socks.zh.md | 2 +- docs/configuration/outbound/ssh.md | 2 +- docs/configuration/outbound/tor.md | 2 +- docs/configuration/outbound/trojan.md | 4 +- docs/configuration/outbound/trojan.zh.md | 2 +- docs/configuration/outbound/tuic.md | 4 +- docs/configuration/outbound/tuic.zh.md | 2 +- docs/configuration/outbound/vless.md | 4 +- docs/configuration/outbound/vless.zh.md | 2 +- docs/configuration/outbound/vmess.md | 4 +- docs/configuration/outbound/vmess.zh.md | 2 +- docs/configuration/outbound/wireguard.md | 2 +- docs/configuration/route/index.md | 8 +- docs/configuration/route/index.zh.md | 8 +- docs/configuration/route/rule.md | 2 +- docs/configuration/route/rule.zh.md | 2 +- docs/configuration/rule-set/source-format.md | 2 +- docs/configuration/shared/multiplex.md | 4 +- docs/configuration/shared/multiplex.zh.md | 4 +- docs/configuration/shared/tls.md | 4 +- docs/configuration/shared/tls.zh.md | 2 +- docs/deprecated.md | 4 +- docs/deprecated.zh.md | 4 +- docs/installation/build-from-source.md | 12 +- docs/installation/build-from-source.zh.md | 12 +- docs/migration.md | 24 +-- docs/migration.zh.md | 24 +-- 73 files changed, 282 insertions(+), 282 deletions(-) diff --git a/docs/changelog.md b/docs/changelog.md index 5c76fa026c..0173ff142a 100644 --- a/docs/changelog.md +++ b/docs/changelog.md @@ -28,8 +28,8 @@ by the Apple App Store, so updates to Apple Platforms will be delayed._ Important changes since 1.6: -* Add [exclude route support](/configuration/inbound/tun) for TUN inbound -* Add `udp_disable_domain_unmapping` [inbound listen option](/configuration/shared/listen) **1** +* Add [exclude route support](/configuration/inbound/tun/) for TUN inbound +* Add `udp_disable_domain_unmapping` [inbound listen option](/configuration/shared/listen/) **1** * Add [HTTPUpgrade V2Ray transport](/configuration/shared/v2ray-transport#HTTPUpgrade) support **2** * Migrate multiplex and UoT server to inbound **3** * Add TCP Brutal support for multiplex **4** @@ -59,7 +59,7 @@ and needs to be turned on explicitly in inbound options. **4** Hysteria Brutal Congestion Control Algorithm in TCP. A kernel module needs to be installed on the Linux server, -see [TCP Brutal](/configuration/shared/tcp-brutal) for details. +see [TCP Brutal](/configuration/shared/tcp-brutal/) for details. **5**: @@ -148,7 +148,7 @@ Only supported in graphical clients on Android and iOS. #### 1.6.1 -* Our [Android client](/installation/clients/sfa) is now available in the Google Play Store ▶️ +* Our [Android client](/installation/clients/sfa/) is now available in the Google Play Store ▶️ * Fixes and improvements #### 1.7.0-alpha.6 @@ -168,7 +168,7 @@ options. **2** Hysteria Brutal Congestion Control Algorithm in TCP. A kernel module needs to be installed on the Linux server, -see [TCP Brutal](/configuration/shared/tcp-brutal) for details. +see [TCP Brutal](/configuration/shared/tcp-brutal/) for details. #### 1.7.0-alpha.3 @@ -187,13 +187,13 @@ The new HTTPUpgrade transport has better performance than WebSocket and is bette Important changes since 1.5: -* Our [Apple tvOS client](/installation/clients/sft) is now available in the App Store 🍎 +* Our [Apple tvOS client](/installation/clients/sft/) is now available in the App Store 🍎 * Update BBR congestion control for TUIC and Hysteria2 **1** * Update brutal congestion control for Hysteria2 * Add `brutal_debug` option for Hysteria2 * Update legacy Hysteria protocol **2** * Add TLS self sign key pair generate command -* Remove [Deprecated Features](/deprecated) by agreement +* Remove [Deprecated Features](/deprecated/) by agreement **1**: @@ -211,8 +211,8 @@ the old protocol (Hysteria 1) have been updated to be consistent with Hysteria 2 #### 1.7.0-alpha.1 -* Add [exclude route support](/configuration/inbound/tun) for TUN inbound -* Add `udp_disable_domain_unmapping` [inbound listen option](/configuration/shared/listen) **1** +* Add [exclude route support](/configuration/inbound/tun/) for TUN inbound +* Add `udp_disable_domain_unmapping` [inbound listen option](/configuration/shared/listen/) **1** * Fixes and improvements **1**: @@ -330,7 +330,7 @@ introduce new issues. #### 1.5.2 -* Our [Apple tvOS client](/installation/clients/sft) is now available in the App Store 🍎 +* Our [Apple tvOS client](/installation/clients/sft/) is now available in the App Store 🍎 * Fixes and improvements #### 1.6.0-alpha.3 @@ -350,7 +350,7 @@ introduce new issues. * Update BBR congestion control for TUIC and Hysteria2 **1** * Update quic-go to v0.39.0 * Update gVisor to 20230814.0 -* Remove [Deprecated Features](/deprecated) by agreement +* Remove [Deprecated Features](/deprecated/) by agreement * Fixes and improvements **1**: @@ -364,7 +364,7 @@ This update is intended to address the multi-send defects of the old implementat Important changes since 1.4: -* Add TLS [ECH server](/configuration/shared/tls) support +* Add TLS [ECH server](/configuration/shared/tls/) support * Improve TLS TCH client configuration * Add TLS ECH key pair generator **1** * Add TLS ECH support for QUIC based protocols **2** @@ -373,7 +373,7 @@ Important changes since 1.4: * Add `interrupt_exist_connections` option for `Selector` and `URLTest` outbounds **4** * Add DNS01 challenge support for ACME TLS certificate issuer **5** * Add `merge` command **6** -* Mark [Deprecated Features](/deprecated) +* Mark [Deprecated Features](/deprecated/) **1**: @@ -385,7 +385,7 @@ All inbounds and outbounds are supported, including `Naiveproxy`, `Hysteria[/2]` **3**: -See [Hysteria2 inbound](/configuration/inbound/hysteria2) and [Hysteria2 outbound](/configuration/outbound/hysteria2) +See [Hysteria2 inbound](/configuration/inbound/hysteria2/) and [Hysteria2 outbound](/configuration/outbound/hysteria2/) For protocol description, please refer to [https://v2.hysteria.network](https://v2.hysteria.network) @@ -398,7 +398,7 @@ Only inbound connections are affected by this setting, internal connections will **5**: Only `Alibaba Cloud DNS` and `Cloudflare` are supported, see [ACME Fields](/configuration/shared/tls#acme-fields) -and [DNS01 Challenge Fields](/configuration/shared/dns01_challenge). +and [DNS01 Challenge Fields](/configuration/shared/dns01_challenge/). **6**: @@ -480,7 +480,7 @@ Global Flags: Only `Alibaba Cloud DNS` and `Cloudflare` are supported, see [ACME Fields](/configuration/shared/tls#acme-fields) -and [DNS01 Challenge Fields](/configuration/shared/dns01_challenge). +and [DNS01 Challenge Fields](/configuration/shared/dns01_challenge/). #### 1.5.0-beta.10 @@ -509,7 +509,7 @@ Only inbound connections are affected by this setting, internal connections will * Fix compatibility issues with official Hysteria2 server and client * Fixes and improvements -* Mark [deprecated features](/deprecated) +* Mark [deprecated features](/deprecated/) #### 1.5.0-beta.3 @@ -528,13 +528,13 @@ Hysteria2 server and client when using `fastOpen=false` or UDP MTU >= 1200. **1**: -See [Hysteria2 inbound](/configuration/inbound/hysteria2) and [Hysteria2 outbound](/configuration/outbound/hysteria2) +See [Hysteria2 inbound](/configuration/inbound/hysteria2/) and [Hysteria2 outbound](/configuration/outbound/hysteria2/) For protocol description, please refer to [https://v2.hysteria.network](https://v2.hysteria.network) #### 1.5.0-beta.1 -* Add TLS [ECH server](/configuration/shared/tls) support +* Add TLS [ECH server](/configuration/shared/tls/) support * Improve TLS TCH client configuration * Add TLS ECH key pair generator **1** * Add TLS ECH support for QUIC based protocols **2** @@ -567,12 +567,12 @@ Important changes since 1.3: *1*: -See [TUIC inbound](/configuration/inbound/tuic) -and [TUIC outbound](/configuration/outbound/tuic) +See [TUIC inbound](/configuration/inbound/tuic/) +and [TUIC outbound](/configuration/outbound/tuic/) **2**: -This is the TUIC port of the [UDP over TCP protocol](/configuration/shared/udp-over-tcp), designed to provide a QUIC +This is the TUIC port of the [UDP over TCP protocol](/configuration/shared/udp-over-tcp/), designed to provide a QUIC stream based UDP relay mode that TUIC does not provide. Since it is an add-on protocol, you will need to use sing-box or another program compatible with the protocol as a server. @@ -603,7 +603,7 @@ Requires sing-box to be compiled with Go 1.21. **1**: -This is the TUIC port of the [UDP over TCP protocol](/configuration/shared/udp-over-tcp), designed to provide a QUIC +This is the TUIC port of the [UDP over TCP protocol](/configuration/shared/udp-over-tcp/), designed to provide a QUIC stream based UDP relay mode that TUIC does not provide. Since it is an add-on protocol, you will need to use sing-box or another program compatible with the protocol as a server. @@ -641,8 +641,8 @@ Requires sing-box to be compiled with Go 1.21. *1*: -See [TUIC inbound](/configuration/inbound/tuic) -and [TUIC outbound](/configuration/outbound/tuic) +See [TUIC inbound](/configuration/inbound/tuic/) +and [TUIC outbound](/configuration/outbound/tuic/) #### 1.3.6 @@ -651,7 +651,7 @@ and [TUIC outbound](/configuration/outbound/tuic) #### 1.3.5 * Fixes and improvements -* Introducing our [Apple tvOS](/installation/clients/sft) client applications **1** +* Introducing our [Apple tvOS](/installation/clients/sft/) client applications **1** * Add per app proxy and app installed/updated trigger support for Android client * Add profile sharing support for Android/iOS/macOS clients @@ -678,7 +678,7 @@ downloaded through TestFlight. #### 1.3.1-beta.3 -* Introducing our [new iOS](/installation/clients/sfi) and [macOS](/installation/clients/sfm) client applications **1** +* Introducing our [new iOS](/installation/clients/sfi/) and [macOS](/installation/clients/sfm/) client applications **1** * Fixes and improvements **1**: @@ -699,7 +699,7 @@ The old testflight link and app are no longer valid. Important changes since 1.2: -* Add [FakeIP](/configuration/dns/fakeip) support **1** +* Add [FakeIP](/configuration/dns/fakeip/) support **1** * Improve multiplex **2** * Add [DNS reverse mapping](/configuration/dns#reverse_mapping) support * Add `rewrite_ttl` DNS rule action @@ -726,11 +726,11 @@ Important changes since 1.2: *1*: -See [FAQ](/faq/fakeip) for more information. +See [FAQ](/faq/fakeip/) for more information. *2*: -Added new `h2mux` multiplex protocol and `padding` multiplex option, see [Multiplex](/configuration/shared/multiplex). +Added new `h2mux` multiplex protocol and `padding` multiplex option, see [Multiplex](/configuration/shared/multiplex/). #### 1.3-rc2 @@ -792,7 +792,7 @@ Improved performance and reduced memory usage. *1*: -Added new `h2mux` multiplex protocol and `padding` multiplex option, see [Multiplex](/configuration/shared/multiplex). +Added new `h2mux` multiplex protocol and `padding` multiplex option, see [Multiplex](/configuration/shared/multiplex/). #### 1.2.6 @@ -844,25 +844,25 @@ This is an incompatible update for XUDP in VLESS if vision flow is enabled. #### 1.3-beta1 * Add [DNS reverse mapping](/configuration/dns#reverse_mapping) support -* Add [L3 routing](/configuration/route/ip-rule) support **1** +* Add [L3 routing](/configuration/route/ip-rule/) support **1** * Add `rewrite_ttl` DNS rule action -* Add [FakeIP](/configuration/dns/fakeip) support **2** +* Add [FakeIP](/configuration/dns/fakeip/) support **2** * Add `store_fakeip` Clash API option * Add multi-peer support for [WireGuard](/configuration/outbound/wireguard#peers) outbound * Add loopback detect *1*: -It can currently be used to [route connections directly to WireGuard](/examples/wireguard-direct) or block connections +It can currently be used to [route connections directly to WireGuard](/examples/wireguard-direct/) or block connections at the IP layer. *2*: -See [FAQ](/faq/fakeip) for more information. +See [FAQ](/faq/fakeip/) for more information. #### 1.2.3 -* Introducing our [new Android client application](/installation/clients/sfa) +* Introducing our [new Android client application](/installation/clients/sfa/) * Improve UDP domain destination NAT * Update reality protocol * Fix TTL calculation for DNS response @@ -891,16 +891,16 @@ to `domain` rule. Important changes since 1.1: -* Introducing our [new iOS client application](/installation/clients/sfi) -* Introducing [UDP over TCP protocol version 2](/configuration/shared/udp-over-tcp) +* Introducing our [new iOS client application](/installation/clients/sfi/) +* Introducing [UDP over TCP protocol version 2](/configuration/shared/udp-over-tcp/) * Add [platform options](/configuration/inbound/tun#platform) for tun inbound * Add [ShadowTLS protocol v3](https://github.com/ihciah/shadow-tls/blob/master/docs/protocol-v3-en.md) -* Add [VLESS server](/configuration/inbound/vless) and [vision](/configuration/outbound/vless#flow) support -* Add [reality TLS](/configuration/shared/tls) support -* Add [NTP service](/configuration/ntp) -* Add [DHCP DNS server](/configuration/dns/server) support -* Add SSH [host key validation](/configuration/outbound/ssh) support -* Add [query_type](/configuration/dns/rule) DNS rule item +* Add [VLESS server](/configuration/inbound/vless/) and [vision](/configuration/outbound/vless#flow) support +* Add [reality TLS](/configuration/shared/tls/) support +* Add [NTP service](/configuration/ntp/) +* Add [DHCP DNS server](/configuration/dns/server/) support +* Add SSH [host key validation](/configuration/outbound/ssh/) support +* Add [query_type](/configuration/dns/rule/) DNS rule item * Add fallback support for v2ray transport * Add custom TLS server support for http based v2ray transports * Add health check support for http-based v2ray transports @@ -931,7 +931,7 @@ name. #### 1.2-beta9 -* Introducing the [UDP over TCP protocol version 2](/configuration/shared/udp-over-tcp) +* Introducing the [UDP over TCP protocol version 2](/configuration/shared/udp-over-tcp/) * Add health check support for http-based v2ray transports * Remove length limit on short_id for reality TLS config * Fix bugs and update dependencies @@ -948,7 +948,7 @@ name. #### 1.2-beta6 -* Introducing our [new iOS client application](/installation/clients/sfi) +* Introducing our [new iOS client application](/installation/clients/sfi/) * Add [platform options](/configuration/inbound/tun#platform) for tun inbound * Add custom TLS server support for http based v2ray transports * Add generate commands @@ -961,8 +961,8 @@ name. #### 1.2-beta5 -* Add [VLESS server](/configuration/inbound/vless) and [vision](/configuration/outbound/vless#flow) support -* Add [reality TLS](/configuration/shared/tls) support +* Add [VLESS server](/configuration/inbound/vless/) and [vision](/configuration/outbound/vless#flow) support +* Add [reality TLS](/configuration/shared/tls/) support * Fix match private address #### 1.1.6 @@ -977,7 +977,7 @@ name. #### 1.2-beta4 -* Add [NTP service](/configuration/ntp) +* Add [NTP service](/configuration/ntp/) * Add Add multiple server names and multi-user support for shadowtls * Add strict mode support for shadowtls v3 * Add uTLS support for shadowtls v3 @@ -997,9 +997,9 @@ name. #### 1.2-beta1 -* Add [DHCP DNS server](/configuration/dns/server) support -* Add SSH [host key validation](/configuration/outbound/ssh) support -* Add [query_type](/configuration/dns/rule) DNS rule item +* Add [DHCP DNS server](/configuration/dns/server/) support +* Add SSH [host key validation](/configuration/outbound/ssh/) support +* Add [query_type](/configuration/dns/rule/) DNS rule item * Add v2ray [user stats](/configuration/experimental#statsusers) api * Add new clash DNS query api * Improve vmess request @@ -1228,7 +1228,7 @@ and [ShadowTLS outbound](/configuration/outbound/shadowtls#version) #### 1.1-beta6 -* Add [URLTest outbound](/configuration/outbound/urltest) +* Add [URLTest outbound](/configuration/outbound/urltest/) * Fix bugs in 1.1-beta5 #### 1.1-beta5 @@ -1260,8 +1260,8 @@ The default tun stack is changed to system. #### 1.1-beta4 * Add internal simple-obfs and v2ray-plugin [Shadowsocks plugins](/configuration/outbound/shadowsocks#plugin) -* Add [ShadowsocksR outbound](/configuration/outbound/shadowsocksr) -* Add [VLESS outbound and XUDP](/configuration/outbound/vless) +* Add [ShadowsocksR outbound](/configuration/outbound/shadowsocksr/) +* Add [VLESS outbound and XUDP](/configuration/outbound/vless/) * Skip wait for hysteria tcp handshake response * Fix socks4 client * Fix hysteria inbound @@ -1288,7 +1288,7 @@ The default tun stack is changed to system. *1*: Switching modes using the Clash API, and `store-selected` are now supported, -see [Experimental](/configuration/experimental). +see [Experimental](/configuration/experimental/). *2*: @@ -1369,15 +1369,15 @@ and [Listen Fields](/configuration/shared/listen#udp_fragment). * Fix write trojan udp * Fix DNS routing * Add attribute support for geosite -* Update documentation for [Dial Fields](/configuration/shared/dial) +* Update documentation for [Dial Fields](/configuration/shared/dial/) #### 1.0-beta3 * Add [chained inbound](/configuration/shared/listen#detour) support * Add process_path rule item * Add macOS redirect support -* Add ShadowTLS [Inbound](/configuration/inbound/shadowtls), [Outbound](/configuration/outbound/shadowtls) - and [Examples](/examples/shadowtls) +* Add ShadowTLS [Inbound](/configuration/inbound/shadowtls/), [Outbound](/configuration/outbound/shadowtls/) + and [Examples](/examples/shadowtls/) * Fix search android package in non-owner users * Fix socksaddr type condition * Fix smux session status @@ -1421,7 +1421,7 @@ and [Listen Fields](/configuration/shared/listen#udp_fragment). ##### 2022/08/23 -* Add [V2Ray Transport](/configuration/shared/v2ray-transport) support for VMess and Trojan +* Add [V2Ray Transport](/configuration/shared/v2ray-transport/) support for VMess and Trojan * Allow plain http request in Naive inbound (It can now be used with nginx) * Add proxy protocol support * Free memory after start @@ -1430,13 +1430,13 @@ and [Listen Fields](/configuration/shared/listen#udp_fragment). ##### 2022/08/22 -* Add strategy setting for each [DNS server](/configuration/dns/server) +* Add strategy setting for each [DNS server](/configuration/dns/server/) * Add bind address to outbound options ##### 2022/08/21 -* Add [Tor outbound](/configuration/outbound/tor) -* Add [SSH outbound](/configuration/outbound/ssh) +* Add [Tor outbound](/configuration/outbound/tor/) +* Add [SSH outbound](/configuration/outbound/ssh/) ##### 2022/08/20 @@ -1450,8 +1450,8 @@ and [Listen Fields](/configuration/shared/listen#udp_fragment). ##### 2022/08/19 -* Add Hysteria [Inbound](/configuration/inbound/hysteria) and [Outbund](/configuration/outbound/hysteria) -* Add [ACME TLS certificate issuer](/configuration/shared/tls) +* Add Hysteria [Inbound](/configuration/inbound/hysteria/) and [Outbund](/configuration/outbound/hysteria/) +* Add [ACME TLS certificate issuer](/configuration/shared/tls/) * Allow read config from stdin (-c stdin) * Update gVisor to 20220815.0 @@ -1469,11 +1469,11 @@ and [Listen Fields](/configuration/shared/listen#udp_fragment). ##### 2022/08/16 * Add ip_version (route/dns) rule item -* Add [WireGuard](/configuration/outbound/wireguard) outbound +* Add [WireGuard](/configuration/outbound/wireguard/) outbound ##### 2022/08/15 -* Add uid, android user and package rules support in [Tun](/configuration/inbound/tun) routing. +* Add uid, android user and package rules support in [Tun](/configuration/inbound/tun/) routing. ##### 2022/08/13 @@ -1482,15 +1482,15 @@ and [Listen Fields](/configuration/shared/listen#udp_fragment). ##### 2022/08/12 * Performance improvements -* Add UoT option for [SOCKS](/configuration/outbound/socks) outbound +* Add UoT option for [SOCKS](/configuration/outbound/socks/) outbound ##### 2022/08/11 -* Add UoT option for [Shadowsocks](/configuration/outbound/shadowsocks) outbound, UoT support for all inbounds +* Add UoT option for [Shadowsocks](/configuration/outbound/shadowsocks/) outbound, UoT support for all inbounds ##### 2022/08/10 -* Add full-featured [Naive](/configuration/inbound/naive) inbound +* Add full-featured [Naive](/configuration/inbound/naive/) inbound * Fix default dns server option [#9] by iKirby ##### 2022/08/09 diff --git a/docs/clients/index.md b/docs/clients/index.md index b80c161867..9c6f00e44c 100644 --- a/docs/clients/index.md +++ b/docs/clients/index.md @@ -4,8 +4,8 @@ Maintained by Project S to provide a unified experience and platform-specific fu | Platform | Client | |---------------------------------------|-----------------------------------------| -| :material-android: Android | [sing-box for Android](./android) | -| :material-apple: iOS/macOS/Apple tvOS | [sing-box for Apple platforms](./apple) | +| :material-android: Android | [sing-box for Android](./android/) | +| :material-apple: iOS/macOS/Apple tvOS | [sing-box for Apple platforms](./apple/) | | :material-laptop: Desktop | Working in progress | Some third-party projects that claim to use sing-box or use sing-box as a selling point are not listed here. The core diff --git a/docs/clients/index.zh.md b/docs/clients/index.zh.md index ef643086ac..81e4129183 100644 --- a/docs/clients/index.zh.md +++ b/docs/clients/index.zh.md @@ -4,8 +4,8 @@ | 平台 | 客户端 | |---------------------------------------|-----------------------------------------| -| :material-android: Android | [sing-box for Android](./android) | -| :material-apple: iOS/macOS/Apple tvOS | [sing-box for Apple platforms](./apple) | +| :material-android: Android | [sing-box for Android](./android/) | +| :material-apple: iOS/macOS/Apple tvOS | [sing-box for Apple platforms](./apple/) | | :material-laptop: Desktop | 施工中 | 此处没有列出一些声称使用或以 sing-box 为卖点的第三方项目。此类项目维护者的动机是获得更多用户，即使它们提供友好的商业 diff --git a/docs/configuration/dns/index.md b/docs/configuration/dns/index.md index 5f8b254733..e2832c4275 100644 --- a/docs/configuration/dns/index.md +++ b/docs/configuration/dns/index.md @@ -23,9 +23,9 @@ | Key | Format | |----------|--------------------------------| -| `server` | List of [DNS Server](./server) | -| `rules` | List of [DNS Rule](./rule) | -| `fakeip` | [FakeIP](./fakeip) | +| `server` | List of [DNS Server](./server/) | +| `rules` | List of [DNS Rule](./rule/) | +| `fakeip` | [FakeIP](./fakeip/) | #### final @@ -62,4 +62,4 @@ problematic in environments such as macOS, where DNS is proxied and cached by th #### fakeip -[FakeIP](./fakeip) settings. +[FakeIP](./fakeip/) settings. diff --git a/docs/configuration/dns/index.zh.md b/docs/configuration/dns/index.zh.md index b84f95282b..9c61107ceb 100644 --- a/docs/configuration/dns/index.zh.md +++ b/docs/configuration/dns/index.zh.md @@ -23,8 +23,8 @@ | 键 | 格式 | |----------|------------------------| -| `server` | 一组 [DNS 服务器](./server) | -| `rules` | 一组 [DNS 规则](./rule) | +| `server` | 一组 [DNS 服务器](./server/) | +| `rules` | 一组 [DNS 规则](./rule/) | #### final @@ -60,4 +60,4 @@ #### fakeip -[FakeIP](./fakeip) 设置。 +[FakeIP](./fakeip/) 设置。 diff --git a/docs/configuration/dns/rule.md b/docs/configuration/dns/rule.md index c393a919ff..68cc32cfae 100644 --- a/docs/configuration/dns/rule.md +++ b/docs/configuration/dns/rule.md @@ -142,7 +142,7 @@ icon: material/alert-decagram #### inbound -Tags of [Inbound](/configuration/inbound). +Tags of [Inbound](/configuration/inbound/). #### ip_version diff --git a/docs/configuration/dns/rule.zh.md b/docs/configuration/dns/rule.zh.md index 41e90281f0..5b1d75019a 100644 --- a/docs/configuration/dns/rule.zh.md +++ b/docs/configuration/dns/rule.zh.md @@ -139,7 +139,7 @@ icon: material/alert-decagram #### inbound -[入站](/zh/configuration/inbound) 标签. +[入站](/zh/configuration/inbound/) 标签. #### ip_version diff --git a/docs/configuration/dns/server.md b/docs/configuration/dns/server.md index 8123f4d1c2..62fcb5df9f 100644 --- a/docs/configuration/dns/server.md +++ b/docs/configuration/dns/server.md @@ -41,7 +41,7 @@ The address of the dns server. | `HTTP3` | `h3://8.8.8.8/dns-query` | | `RCode` | `rcode://refused` | | `DHCP` | `dhcp://auto` or `dhcp://en0` | -| [FakeIP](/configuration/dns/fakeip) | `fakeip` | +| [FakeIP](/configuration/dns/fakeip/) | `fakeip` | !!! warning "" diff --git a/docs/configuration/dns/server.zh.md b/docs/configuration/dns/server.zh.md index 728590de80..3f4e0d32b7 100644 --- a/docs/configuration/dns/server.zh.md +++ b/docs/configuration/dns/server.zh.md @@ -41,7 +41,7 @@ DNS 服务器的地址。 | `HTTP3` | `h3://8.8.8.8/dns-query` | | `RCode` | `rcode://refused` | | `DHCP` | `dhcp://auto` 或 `dhcp://en0` | -| [FakeIP](/configuration/dns/fakeip) | `fakeip` | +| [FakeIP](/configuration/dns/fakeip/) | `fakeip` | !!! warning "" diff --git a/docs/configuration/experimental/index.md b/docs/configuration/experimental/index.md index 1057e59b36..4ddcc41af7 100644 --- a/docs/configuration/experimental/index.md +++ b/docs/configuration/experimental/index.md @@ -25,6 +25,6 @@ icon: material/alert-decagram | Key | Format | |--------------|----------------------------| -| `cache_file` | [Cache File](./cache-file) | -| `clash_api` | [Clash API](./clash-api) | -| `v2ray_api` | [V2Ray API](./v2ray-api) | \ No newline at end of file +| `cache_file` | [Cache File](./cache-file/) | +| `clash_api` | [Clash API](./clash-api/) | +| `v2ray_api` | [V2Ray API](./v2ray-api/) | \ No newline at end of file diff --git a/docs/configuration/experimental/index.zh.md b/docs/configuration/experimental/index.zh.md index 36fce5f6f4..4be70aa7d4 100644 --- a/docs/configuration/experimental/index.zh.md +++ b/docs/configuration/experimental/index.zh.md @@ -25,6 +25,6 @@ icon: material/alert-decagram | 键 | 格式 | |--------------|--------------------------| -| `cache_file` | [缓存文件](./cache-file) | -| `clash_api` | [Clash API](./clash-api) | -| `v2ray_api` | [V2Ray API](./v2ray-api) | \ No newline at end of file +| `cache_file` | [缓存文件](./cache-file/) | +| `clash_api` | [Clash API](./clash-api/) | +| `v2ray_api` | [V2Ray API](./v2ray-api/) | \ No newline at end of file diff --git a/docs/configuration/inbound/direct.md b/docs/configuration/inbound/direct.md index 706c677525..6dc93578a7 100644 --- a/docs/configuration/inbound/direct.md +++ b/docs/configuration/inbound/direct.md @@ -17,7 +17,7 @@ ### Listen Fields -See [Listen Fields](/configuration/shared/listen) for details. +See [Listen Fields](/configuration/shared/listen/) for details. ### Fields diff --git a/docs/configuration/inbound/http.md b/docs/configuration/inbound/http.md index 3b14905015..cd2ec35dc8 100644 --- a/docs/configuration/inbound/http.md +++ b/docs/configuration/inbound/http.md @@ -20,7 +20,7 @@ ### Listen Fields -See [Listen Fields](/configuration/shared/listen) for details. +See [Listen Fields](/configuration/shared/listen/) for details. ### Fields diff --git a/docs/configuration/inbound/hysteria.md b/docs/configuration/inbound/hysteria.md index 789dffeada..4725aafcea 100644 --- a/docs/configuration/inbound/hysteria.md +++ b/docs/configuration/inbound/hysteria.md @@ -31,7 +31,7 @@ ### Listen Fields -See [Listen Fields](/configuration/shared/listen) for details. +See [Listen Fields](/configuration/shared/listen/) for details. ### Fields diff --git a/docs/configuration/inbound/hysteria2.md b/docs/configuration/inbound/hysteria2.md index 7d9d504f39..7c611e6491 100644 --- a/docs/configuration/inbound/hysteria2.md +++ b/docs/configuration/inbound/hysteria2.md @@ -35,7 +35,7 @@ ### Listen Fields -See [Listen Fields](/configuration/shared/listen) for details. +See [Listen Fields](/configuration/shared/listen/) for details. ### Fields diff --git a/docs/configuration/inbound/index.md b/docs/configuration/inbound/index.md index 830d86a95c..5f8019c172 100644 --- a/docs/configuration/inbound/index.md +++ b/docs/configuration/inbound/index.md @@ -17,22 +17,22 @@ | Type | Format | Injectable | |---------------|------------------------------|------------| -| `direct` | [Direct](./direct) | X | -| `mixed` | [Mixed](./mixed) | TCP | -| `socks` | [SOCKS](./socks) | TCP | -| `http` | [HTTP](./http) | TCP | -| `shadowsocks` | [Shadowsocks](./shadowsocks) | TCP | -| `vmess` | [VMess](./vmess) | TCP | -| `trojan` | [Trojan](./trojan) | TCP | -| `naive` | [Naive](./naive) | X | -| `hysteria` | [Hysteria](./hysteria) | X | -| `shadowtls` | [ShadowTLS](./shadowtls) | TCP | -| `tuic` | [TUIC](./tuic) | X | -| `hysteria2` | [Hysteria2](./hysteria2) | X | -| `vless` | [VLESS](./vless) | TCP | -| `tun` | [Tun](./tun) | X | -| `redirect` | [Redirect](./redirect) | X | -| `tproxy` | [TProxy](./tproxy) | X | +| `direct` | [Direct](./direct/) | X | +| `mixed` | [Mixed](./mixed/) | TCP | +| `socks` | [SOCKS](./socks/) | TCP | +| `http` | [HTTP](./http/) | TCP | +| `shadowsocks` | [Shadowsocks](./shadowsocks/) | TCP | +| `vmess` | [VMess](./vmess/) | TCP | +| `trojan` | [Trojan](./trojan/) | TCP | +| `naive` | [Naive](./naive/) | X | +| `hysteria` | [Hysteria](./hysteria/) | X | +| `shadowtls` | [ShadowTLS](./shadowtls/) | TCP | +| `tuic` | [TUIC](./tuic/) | X | +| `hysteria2` | [Hysteria2](./hysteria2/) | X | +| `vless` | [VLESS](./vless/) | TCP | +| `tun` | [Tun](./tun/) | X | +| `redirect` | [Redirect](./redirect/) | X | +| `tproxy` | [TProxy](./tproxy/) | X | #### tag diff --git a/docs/configuration/inbound/index.zh.md b/docs/configuration/inbound/index.zh.md index 5b3592f68f..458cd602d4 100644 --- a/docs/configuration/inbound/index.zh.md +++ b/docs/configuration/inbound/index.zh.md @@ -17,22 +17,22 @@ | 类型 | 格式 | 注入支持 | |---------------|------------------------------|------| -| `direct` | [Direct](./direct) | X | -| `mixed` | [Mixed](./mixed) | TCP | -| `socks` | [SOCKS](./socks) | TCP | -| `http` | [HTTP](./http) | TCP | -| `shadowsocks` | [Shadowsocks](./shadowsocks) | TCP | -| `vmess` | [VMess](./vmess) | TCP | -| `trojan` | [Trojan](./trojan) | TCP | -| `naive` | [Naive](./naive) | X | -| `hysteria` | [Hysteria](./hysteria) | X | -| `shadowtls` | [ShadowTLS](./shadowtls) | TCP | -| `tuic` | [TUIC](./tuic) | X | -| `hysteria2` | [Hysteria2](./hysteria2) | X | -| `vless` | [VLESS](./vless) | TCP | -| `tun` | [Tun](./tun) | X | -| `redirect` | [Redirect](./redirect) | X | -| `tproxy` | [TProxy](./tproxy) | X | +| `direct` | [Direct](./direct/) | X | +| `mixed` | [Mixed](./mixed/) | TCP | +| `socks` | [SOCKS](./socks/) | TCP | +| `http` | [HTTP](./http/) | TCP | +| `shadowsocks` | [Shadowsocks](./shadowsocks/) | TCP | +| `vmess` | [VMess](./vmess/) | TCP | +| `trojan` | [Trojan](./trojan/) | TCP | +| `naive` | [Naive](./naive/) | X | +| `hysteria` | [Hysteria](./hysteria/) | X | +| `shadowtls` | [ShadowTLS](./shadowtls/) | TCP | +| `tuic` | [TUIC](./tuic/) | X | +| `hysteria2` | [Hysteria2](./hysteria2/) | X | +| `vless` | [VLESS](./vless/) | TCP | +| `tun` | [Tun](./tun/) | X | +| `redirect` | [Redirect](./redirect/) | X | +| `tproxy` | [TProxy](./tproxy/) | X | #### tag diff --git a/docs/configuration/inbound/mixed.md b/docs/configuration/inbound/mixed.md index 62313f489d..1f5bf0ac0d 100644 --- a/docs/configuration/inbound/mixed.md +++ b/docs/configuration/inbound/mixed.md @@ -21,7 +21,7 @@ ### Listen Fields -See [Listen Fields](/configuration/shared/listen) for details. +See [Listen Fields](/configuration/shared/listen/) for details. ### Fields diff --git a/docs/configuration/inbound/naive.md b/docs/configuration/inbound/naive.md index 83f2656682..0b4ff4b776 100644 --- a/docs/configuration/inbound/naive.md +++ b/docs/configuration/inbound/naive.md @@ -20,7 +20,7 @@ ### Listen Fields -See [Listen Fields](/configuration/shared/listen) for details. +See [Listen Fields](/configuration/shared/listen/) for details. ### Fields diff --git a/docs/configuration/inbound/redirect.md b/docs/configuration/inbound/redirect.md index 97736e286b..50a5bacd28 100644 --- a/docs/configuration/inbound/redirect.md +++ b/docs/configuration/inbound/redirect.md @@ -15,4 +15,4 @@ ### Listen Fields -See [Listen Fields](/configuration/shared/listen) for details. +See [Listen Fields](/configuration/shared/listen/) for details. diff --git a/docs/configuration/inbound/shadowsocks.md b/docs/configuration/inbound/shadowsocks.md index 415a59138e..4072782bc4 100644 --- a/docs/configuration/inbound/shadowsocks.md +++ b/docs/configuration/inbound/shadowsocks.md @@ -50,7 +50,7 @@ ### Listen Fields -See [Listen Fields](/configuration/shared/listen) for details. +See [Listen Fields](/configuration/shared/listen/) for details. ### Fields diff --git a/docs/configuration/inbound/shadowsocks.zh.md b/docs/configuration/inbound/shadowsocks.zh.md index 36a292bb0c..cdfd80806c 100644 --- a/docs/configuration/inbound/shadowsocks.zh.md +++ b/docs/configuration/inbound/shadowsocks.zh.md @@ -50,7 +50,7 @@ ### Listen Fields -See [Listen Fields](/configuration/shared/listen) for details. +See [Listen Fields](/configuration/shared/listen/) for details. ### 字段 diff --git a/docs/configuration/inbound/shadowtls.md b/docs/configuration/inbound/shadowtls.md index e8b7ba23f7..db010b7908 100644 --- a/docs/configuration/inbound/shadowtls.md +++ b/docs/configuration/inbound/shadowtls.md @@ -35,7 +35,7 @@ ### Listen Fields -See [Listen Fields](/configuration/shared/listen) for details. +See [Listen Fields](/configuration/shared/listen/) for details. ### Fields @@ -66,11 +66,11 @@ Only available in the ShadowTLS protocol 3. ==Required== -Handshake server address and [Dial options](/configuration/shared/dial). +Handshake server address and [Dial options](/configuration/shared/dial/). #### handshake_for_server_name -Handshake server address and [Dial options](/configuration/shared/dial) for specific server name. +Handshake server address and [Dial options](/configuration/shared/dial/) for specific server name. Only available in the ShadowTLS protocol 2/3. diff --git a/docs/configuration/inbound/socks.md b/docs/configuration/inbound/socks.md index 59f7d96f83..4937f39054 100644 --- a/docs/configuration/inbound/socks.md +++ b/docs/configuration/inbound/socks.md @@ -20,7 +20,7 @@ ### Listen Fields -See [Listen Fields](/configuration/shared/listen) for details. +See [Listen Fields](/configuration/shared/listen/) for details. ### Fields diff --git a/docs/configuration/inbound/tproxy.md b/docs/configuration/inbound/tproxy.md index 4975931e89..422885374f 100644 --- a/docs/configuration/inbound/tproxy.md +++ b/docs/configuration/inbound/tproxy.md @@ -17,7 +17,7 @@ ### Listen Fields -See [Listen Fields](/configuration/shared/listen) for details. +See [Listen Fields](/configuration/shared/listen/) for details. ### Fields diff --git a/docs/configuration/inbound/trojan.md b/docs/configuration/inbound/trojan.md index cd45539ddc..bd6c73b311 100644 --- a/docs/configuration/inbound/trojan.md +++ b/docs/configuration/inbound/trojan.md @@ -31,7 +31,7 @@ ### Listen Fields -See [Listen Fields](/configuration/shared/listen) for details. +See [Listen Fields](/configuration/shared/listen/) for details. ### Fields @@ -65,4 +65,4 @@ See [Multiplex](/configuration/shared/multiplex#inbound) for details. #### transport -V2Ray Transport configuration, see [V2Ray Transport](/configuration/shared/v2ray-transport). +V2Ray Transport configuration, see [V2Ray Transport](/configuration/shared/v2ray-transport/). diff --git a/docs/configuration/inbound/trojan.zh.md b/docs/configuration/inbound/trojan.zh.md index 54144ae680..d8b30cae68 100644 --- a/docs/configuration/inbound/trojan.zh.md +++ b/docs/configuration/inbound/trojan.zh.md @@ -67,4 +67,4 @@ TLS 配置, 参阅 [TLS](/zh/configuration/shared/tls/#inbound)。 #### transport -V2Ray 传输配置，参阅 [V2Ray 传输层](/zh/configuration/shared/v2ray-transport)。 \ No newline at end of file +V2Ray 传输配置，参阅 [V2Ray 传输层](/zh/configuration/shared/v2ray-transport/)。 \ No newline at end of file diff --git a/docs/configuration/inbound/tuic.md b/docs/configuration/inbound/tuic.md index 04624a895d..8a2d8c7e06 100644 --- a/docs/configuration/inbound/tuic.md +++ b/docs/configuration/inbound/tuic.md @@ -24,7 +24,7 @@ ### Listen Fields -See [Listen Fields](/configuration/shared/listen) for details. +See [Listen Fields](/configuration/shared/listen/) for details. ### Fields diff --git a/docs/configuration/inbound/tun.md b/docs/configuration/inbound/tun.md index de977e76c4..f39dc3cd67 100644 --- a/docs/configuration/inbound/tun.md +++ b/docs/configuration/inbound/tun.md @@ -261,4 +261,4 @@ System HTTP proxy settings. ### Listen Fields -See [Listen Fields](/configuration/shared/listen) for details. +See [Listen Fields](/configuration/shared/listen/) for details. diff --git a/docs/configuration/inbound/vless.md b/docs/configuration/inbound/vless.md index f78ae01c19..93faf716a2 100644 --- a/docs/configuration/inbound/vless.md +++ b/docs/configuration/inbound/vless.md @@ -22,7 +22,7 @@ ### Listen Fields -See [Listen Fields](/configuration/shared/listen) for details. +See [Listen Fields](/configuration/shared/listen/) for details. ### Fields @@ -56,4 +56,4 @@ See [Multiplex](/configuration/shared/multiplex#inbound) for details. #### transport -V2Ray Transport configuration, see [V2Ray Transport](/configuration/shared/v2ray-transport). +V2Ray Transport configuration, see [V2Ray Transport](/configuration/shared/v2ray-transport/). diff --git a/docs/configuration/inbound/vless.zh.md b/docs/configuration/inbound/vless.zh.md index 4beecd6faa..30b151dad3 100644 --- a/docs/configuration/inbound/vless.zh.md +++ b/docs/configuration/inbound/vless.zh.md @@ -56,4 +56,4 @@ TLS 配置, 参阅 [TLS](/zh/configuration/shared/tls/#inbound)。 #### transport -V2Ray 传输配置，参阅 [V2Ray 传输层](/zh/configuration/shared/v2ray-transport)。 +V2Ray 传输配置，参阅 [V2Ray 传输层](/zh/configuration/shared/v2ray-transport/)。 diff --git a/docs/configuration/inbound/vmess.md b/docs/configuration/inbound/vmess.md index 0e559d1ef6..f38a6cae8e 100644 --- a/docs/configuration/inbound/vmess.md +++ b/docs/configuration/inbound/vmess.md @@ -22,7 +22,7 @@ ### Listen Fields -See [Listen Fields](/configuration/shared/listen) for details. +See [Listen Fields](/configuration/shared/listen/) for details. ### Fields @@ -51,4 +51,4 @@ See [Multiplex](/configuration/shared/multiplex#inbound) for details. #### transport -V2Ray Transport configuration, see [V2Ray Transport](/configuration/shared/v2ray-transport). +V2Ray Transport configuration, see [V2Ray Transport](/configuration/shared/v2ray-transport/). diff --git a/docs/configuration/inbound/vmess.zh.md b/docs/configuration/inbound/vmess.zh.md index 9554ab79e0..9aef44df51 100644 --- a/docs/configuration/inbound/vmess.zh.md +++ b/docs/configuration/inbound/vmess.zh.md @@ -51,4 +51,4 @@ TLS 配置, 参阅 [TLS](/zh/configuration/shared/tls/#inbound)。 #### transport -V2Ray 传输配置，参阅 [V2Ray 传输层](/zh/configuration/shared/v2ray-transport)。 +V2Ray 传输配置，参阅 [V2Ray 传输层](/zh/configuration/shared/v2ray-transport/)。 diff --git a/docs/configuration/index.md b/docs/configuration/index.md index a4ade70726..d16aa80777 100644 --- a/docs/configuration/index.md +++ b/docs/configuration/index.md @@ -20,13 +20,13 @@ sing-box uses JSON for configuration files. | Key | Format | |----------------|--------------------------------| -| `log` | [Log](./log) | -| `dns` | [DNS](./dns) | -| `ntp` | [NTP](./ntp) | -| `inbounds` | [Inbound](./inbound) | -| `outbounds` | [Outbound](./outbound) | -| `route` | [Route](./route) | -| `experimental` | [Experimental](./experimental) | +| `log` | [Log](./log/) | +| `dns` | [DNS](./dns/) | +| `ntp` | [NTP](./ntp/) | +| `inbounds` | [Inbound](./inbound/) | +| `outbounds` | [Outbound](./outbound/) | +| `route` | [Route](./route/) | +| `experimental` | [Experimental](./experimental/) | ### Check diff --git a/docs/configuration/index.zh.md b/docs/configuration/index.zh.md index 80b2ebd385..80797be579 100644 --- a/docs/configuration/index.zh.md +++ b/docs/configuration/index.zh.md @@ -19,12 +19,12 @@ sing-box 使用 JSON 作为配置文件格式。 | Key | Format | |----------------|-----------------------| -| `log` | [日志](./log) | -| `dns` | [DNS](./dns) | -| `inbounds` | [入站](./inbound) | -| `outbounds` | [出站](./outbound) | -| `route` | [路由](./route) | -| `experimental` | [实验性](./experimental) | +| `log` | [日志](./log/) | +| `dns` | [DNS](./dns/) | +| `inbounds` | [入站](./inbound/) | +| `outbounds` | [出站](./outbound/) | +| `route` | [路由](./route/) | +| `experimental` | [实验性](./experimental/) | ### 检查 diff --git a/docs/configuration/ntp/index.md b/docs/configuration/ntp/index.md index 8b3570a3d4..b95b9b1f8b 100644 --- a/docs/configuration/ntp/index.md +++ b/docs/configuration/ntp/index.md @@ -47,4 +47,4 @@ Time synchronization interval. ### Dial Fields -See [Dial Fields](/configuration/shared/dial) for details. \ No newline at end of file +See [Dial Fields](/configuration/shared/dial/) for details. \ No newline at end of file diff --git a/docs/configuration/outbound/direct.md b/docs/configuration/outbound/direct.md index 68eb0daf19..c2f5671a6b 100644 --- a/docs/configuration/outbound/direct.md +++ b/docs/configuration/outbound/direct.md @@ -33,4 +33,4 @@ Protocol value can be `1` or `2`. ### Dial Fields -See [Dial Fields](/configuration/shared/dial) for details. +See [Dial Fields](/configuration/shared/dial/) for details. diff --git a/docs/configuration/outbound/http.md b/docs/configuration/outbound/http.md index c69422231f..0b9dfa2369 100644 --- a/docs/configuration/outbound/http.md +++ b/docs/configuration/outbound/http.md @@ -55,4 +55,4 @@ TLS configuration, see [TLS](/configuration/shared/tls/#outbound). ### Dial Fields -See [Dial Fields](/configuration/shared/dial) for details. +See [Dial Fields](/configuration/shared/dial/) for details. diff --git a/docs/configuration/outbound/hysteria.md b/docs/configuration/outbound/hysteria.md index 8caa9248c2..90190e051f 100644 --- a/docs/configuration/outbound/hysteria.md +++ b/docs/configuration/outbound/hysteria.md @@ -109,4 +109,4 @@ TLS configuration, see [TLS](/configuration/shared/tls/#outbound). ### Dial Fields -See [Dial Fields](/configuration/shared/dial) for details. +See [Dial Fields](/configuration/shared/dial/) for details. diff --git a/docs/configuration/outbound/hysteria2.md b/docs/configuration/outbound/hysteria2.md index 26d5b72800..ae0b96edda 100644 --- a/docs/configuration/outbound/hysteria2.md +++ b/docs/configuration/outbound/hysteria2.md @@ -84,4 +84,4 @@ Enable debug information logging for Hysteria Brutal CC. ### Dial Fields -See [Dial Fields](/configuration/shared/dial) for details. +See [Dial Fields](/configuration/shared/dial/) for details. diff --git a/docs/configuration/outbound/index.md b/docs/configuration/outbound/index.md index 2fa8f09a9f..c5dc291769 100644 --- a/docs/configuration/outbound/index.md +++ b/docs/configuration/outbound/index.md @@ -17,24 +17,24 @@ | Type | Format | |----------------|--------------------------------| -| `direct` | [Direct](./direct) | -| `block` | [Block](./block) | -| `socks` | [SOCKS](./socks) | -| `http` | [HTTP](./http) | -| `shadowsocks` | [Shadowsocks](./shadowsocks) | -| `vmess` | [VMess](./vmess) | -| `trojan` | [Trojan](./trojan) | -| `wireguard` | [Wireguard](./wireguard) | -| `hysteria` | [Hysteria](./hysteria) | -| `vless` | [VLESS](./vless) | -| `shadowtls` | [ShadowTLS](./shadowtls) | -| `tuic` | [TUIC](./tuic) | -| `hysteria2` | [Hysteria2](./hysteria2) | -| `tor` | [Tor](./tor) | -| `ssh` | [SSH](./ssh) | -| `dns` | [DNS](./dns) | -| `selector` | [Selector](./selector) | -| `urltest` | [URLTest](./urltest) | +| `direct` | [Direct](./direct/) | +| `block` | [Block](./block/) | +| `socks` | [SOCKS](./socks/) | +| `http` | [HTTP](./http/) | +| `shadowsocks` | [Shadowsocks](./shadowsocks/) | +| `vmess` | [VMess](./vmess/) | +| `trojan` | [Trojan](./trojan/) | +| `wireguard` | [Wireguard](./wireguard/) | +| `hysteria` | [Hysteria](./hysteria/) | +| `vless` | [VLESS](./vless/) | +| `shadowtls` | [ShadowTLS](./shadowtls/) | +| `tuic` | [TUIC](./tuic/) | +| `hysteria2` | [Hysteria2](./hysteria2/) | +| `tor` | [Tor](./tor/) | +| `ssh` | [SSH](./ssh/) | +| `dns` | [DNS](./dns/) | +| `selector` | [Selector](./selector/) | +| `urltest` | [URLTest](./urltest/) | #### tag diff --git a/docs/configuration/outbound/index.zh.md b/docs/configuration/outbound/index.zh.md index 2f1406f639..c7ee59e91d 100644 --- a/docs/configuration/outbound/index.zh.md +++ b/docs/configuration/outbound/index.zh.md @@ -17,24 +17,24 @@ | 类型 | 格式 | |----------------|--------------------------------| -| `direct` | [Direct](./direct) | -| `block` | [Block](./block) | -| `socks` | [SOCKS](./socks) | -| `http` | [HTTP](./http) | -| `shadowsocks` | [Shadowsocks](./shadowsocks) | -| `vmess` | [VMess](./vmess) | -| `trojan` | [Trojan](./trojan) | -| `wireguard` | [Wireguard](./wireguard) | -| `hysteria` | [Hysteria](./hysteria) | -| `vless` | [VLESS](./vless) | -| `shadowtls` | [ShadowTLS](./shadowtls) | -| `tuic` | [TUIC](./tuic) | -| `hysteria2` | [Hysteria2](./hysteria2) | -| `tor` | [Tor](./tor) | -| `ssh` | [SSH](./ssh) | -| `dns` | [DNS](./dns) | -| `selector` | [Selector](./selector) | -| `urltest` | [URLTest](./urltest) | +| `direct` | [Direct](./direct/) | +| `block` | [Block](./block/) | +| `socks` | [SOCKS](./socks/) | +| `http` | [HTTP](./http/) | +| `shadowsocks` | [Shadowsocks](./shadowsocks/) | +| `vmess` | [VMess](./vmess/) | +| `trojan` | [Trojan](./trojan/) | +| `wireguard` | [Wireguard](./wireguard/) | +| `hysteria` | [Hysteria](./hysteria/) | +| `vless` | [VLESS](./vless/) | +| `shadowtls` | [ShadowTLS](./shadowtls/) | +| `tuic` | [TUIC](./tuic/) | +| `hysteria2` | [Hysteria2](./hysteria2/) | +| `tor` | [Tor](./tor/) | +| `ssh` | [SSH](./ssh/) | +| `dns` | [DNS](./dns/) | +| `selector` | [Selector](./selector/) | +| `urltest` | [URLTest](./urltest/) | #### tag diff --git a/docs/configuration/outbound/shadowsocks.md b/docs/configuration/outbound/shadowsocks.md index 6fc9348408..a088d2718e 100644 --- a/docs/configuration/outbound/shadowsocks.md +++ b/docs/configuration/outbound/shadowsocks.md @@ -89,7 +89,7 @@ Both is enabled by default. UDP over TCP configuration. -See [UDP Over TCP](/configuration/shared/udp-over-tcp) for details. +See [UDP Over TCP](/configuration/shared/udp-over-tcp/) for details. Conflict with `multiplex`. @@ -99,4 +99,4 @@ See [Multiplex](/configuration/shared/multiplex#outbound) for details. ### Dial Fields -See [Dial Fields](/configuration/shared/dial) for details. +See [Dial Fields](/configuration/shared/dial/) for details. diff --git a/docs/configuration/outbound/shadowsocks.zh.md b/docs/configuration/outbound/shadowsocks.zh.md index 6d9b7a5c85..818a4fa988 100644 --- a/docs/configuration/outbound/shadowsocks.zh.md +++ b/docs/configuration/outbound/shadowsocks.zh.md @@ -89,7 +89,7 @@ Shadowsocks SIP003 插件参数。 UDP over TCP 配置。 -参阅 [UDP Over TCP](/zh/configuration/shared/udp-over-tcp)。 +参阅 [UDP Over TCP](/zh/configuration/shared/udp-over-tcp/)。 与 `multiplex` 冲突。 diff --git a/docs/configuration/outbound/shadowtls.md b/docs/configuration/outbound/shadowtls.md index 1fa08c774f..a54391b500 100644 --- a/docs/configuration/outbound/shadowtls.md +++ b/docs/configuration/outbound/shadowtls.md @@ -53,4 +53,4 @@ TLS configuration, see [TLS](/configuration/shared/tls/#outbound). ### Dial Fields -See [Dial Fields](/configuration/shared/dial) for details. +See [Dial Fields](/configuration/shared/dial/) for details. diff --git a/docs/configuration/outbound/socks.md b/docs/configuration/outbound/socks.md index 94d83fe56d..b04e67b653 100644 --- a/docs/configuration/outbound/socks.md +++ b/docs/configuration/outbound/socks.md @@ -59,8 +59,8 @@ Both is enabled by default. UDP over TCP protocol settings. -See [UDP Over TCP](/configuration/shared/udp-over-tcp) for details. +See [UDP Over TCP](/configuration/shared/udp-over-tcp/) for details. ### Dial Fields -See [Dial Fields](/configuration/shared/dial) for details. +See [Dial Fields](/configuration/shared/dial/) for details. diff --git a/docs/configuration/outbound/socks.zh.md b/docs/configuration/outbound/socks.zh.md index 75548da734..dd9a1ac9fe 100644 --- a/docs/configuration/outbound/socks.zh.md +++ b/docs/configuration/outbound/socks.zh.md @@ -59,7 +59,7 @@ SOCKS5 密码。 UDP over TCP 配置。 -参阅 [UDP Over TCP](/zh/configuration/shared/udp-over-tcp)。 +参阅 [UDP Over TCP](/zh/configuration/shared/udp-over-tcp/)。 ### 拨号字段 diff --git a/docs/configuration/outbound/ssh.md b/docs/configuration/outbound/ssh.md index 1384f8ddf4..45ec72b2b5 100644 --- a/docs/configuration/outbound/ssh.md +++ b/docs/configuration/outbound/ssh.md @@ -68,4 +68,4 @@ Client version. Random version will be used if empty. ### Dial Fields -See [Dial Fields](/configuration/shared/dial) for details. +See [Dial Fields](/configuration/shared/dial/) for details. diff --git a/docs/configuration/outbound/tor.md b/docs/configuration/outbound/tor.md index e3188ea330..ac77833509 100644 --- a/docs/configuration/outbound/tor.md +++ b/docs/configuration/outbound/tor.md @@ -48,4 +48,4 @@ See [tor(1)](https://linux.die.net/man/1/tor) for details. ### Dial Fields -See [Dial Fields](/configuration/shared/dial) for details. +See [Dial Fields](/configuration/shared/dial/) for details. diff --git a/docs/configuration/outbound/trojan.md b/docs/configuration/outbound/trojan.md index 34b16c7d38..6a45fd02cc 100644 --- a/docs/configuration/outbound/trojan.md +++ b/docs/configuration/outbound/trojan.md @@ -55,8 +55,8 @@ See [Multiplex](/configuration/shared/multiplex#outbound) for details. #### transport -V2Ray Transport configuration, see [V2Ray Transport](/configuration/shared/v2ray-transport). +V2Ray Transport configuration, see [V2Ray Transport](/configuration/shared/v2ray-transport/). ### Dial Fields -See [Dial Fields](/configuration/shared/dial) for details. +See [Dial Fields](/configuration/shared/dial/) for details. diff --git a/docs/configuration/outbound/trojan.zh.md b/docs/configuration/outbound/trojan.zh.md index 55bb970911..2248c739bc 100644 --- a/docs/configuration/outbound/trojan.zh.md +++ b/docs/configuration/outbound/trojan.zh.md @@ -55,7 +55,7 @@ TLS 配置, 参阅 [TLS](/zh/configuration/shared/tls/#outbound)。 #### transport -V2Ray 传输配置，参阅 [V2Ray 传输层](/zh/configuration/shared/v2ray-transport)。 +V2Ray 传输配置，参阅 [V2Ray 传输层](/zh/configuration/shared/v2ray-transport/)。 ### 拨号字段 diff --git a/docs/configuration/outbound/tuic.md b/docs/configuration/outbound/tuic.md index 69a1a6d63c..4f4ef4850d 100644 --- a/docs/configuration/outbound/tuic.md +++ b/docs/configuration/outbound/tuic.md @@ -68,7 +68,7 @@ Conflict with `udp_over_stream`. #### udp_over_stream -This is the TUIC port of the [UDP over TCP protocol](/configuration/shared/udp-over-tcp), designed to provide a QUIC +This is the TUIC port of the [UDP over TCP protocol](/configuration/shared/udp-over-tcp/), designed to provide a QUIC stream based UDP relay mode that TUIC does not provide. Since it is an add-on protocol, you will need to use sing-box or another program compatible with the protocol as a server. @@ -93,4 +93,4 @@ TLS configuration, see [TLS](/configuration/shared/tls/#outbound). ### Dial Fields -See [Dial Fields](/configuration/shared/dial) for details. +See [Dial Fields](/configuration/shared/dial/) for details. diff --git a/docs/configuration/outbound/tuic.zh.md b/docs/configuration/outbound/tuic.zh.md index aca0274543..ee8fd15d3f 100644 --- a/docs/configuration/outbound/tuic.zh.md +++ b/docs/configuration/outbound/tuic.zh.md @@ -66,7 +66,7 @@ UDP 包中继模式 #### udp_over_stream -这是 TUIC 的 [UDP over TCP 协议](/configuration/shared/udp-over-tcp) 移植， 旨在提供 TUIC 不提供的 基于 QUIC 流的 UDP 中继模式。 由于它是一个附加协议，因此您需要使用 sing-box 或其他兼容的程序作为服务器。 +这是 TUIC 的 [UDP over TCP 协议](/configuration/shared/udp-over-tcp/) 移植， 旨在提供 TUIC 不提供的 基于 QUIC 流的 UDP 中继模式。 由于它是一个附加协议，因此您需要使用 sing-box 或其他兼容的程序作为服务器。 此模式在正确的 UDP 代理场景中没有任何积极作用，仅适用于中继流式 UDP 流量（基本上是 QUIC 流）。 diff --git a/docs/configuration/outbound/vless.md b/docs/configuration/outbound/vless.md index 0d2fadc646..28134e55ce 100644 --- a/docs/configuration/outbound/vless.md +++ b/docs/configuration/outbound/vless.md @@ -75,8 +75,8 @@ See [Multiplex](/configuration/shared/multiplex#outbound) for details. #### transport -V2Ray Transport configuration, see [V2Ray Transport](/configuration/shared/v2ray-transport). +V2Ray Transport configuration, see [V2Ray Transport](/configuration/shared/v2ray-transport/). ### Dial Fields -See [Dial Fields](/configuration/shared/dial) for details. +See [Dial Fields](/configuration/shared/dial/) for details. diff --git a/docs/configuration/outbound/vless.zh.md b/docs/configuration/outbound/vless.zh.md index 3d3f24ee65..8978a6ac6b 100644 --- a/docs/configuration/outbound/vless.zh.md +++ b/docs/configuration/outbound/vless.zh.md @@ -75,7 +75,7 @@ UDP 包编码，默认使用 xudp。 #### transport -V2Ray 传输配置，参阅 [V2Ray 传输层](/zh/configuration/shared/v2ray-transport)。 +V2Ray 传输配置，参阅 [V2Ray 传输层](/zh/configuration/shared/v2ray-transport/)。 ### 拨号字段 diff --git a/docs/configuration/outbound/vmess.md b/docs/configuration/outbound/vmess.md index ac29559e72..536601afd7 100644 --- a/docs/configuration/outbound/vmess.md +++ b/docs/configuration/outbound/vmess.md @@ -100,8 +100,8 @@ See [Multiplex](/configuration/shared/multiplex#outbound) for details. #### transport -V2Ray Transport configuration, see [V2Ray Transport](/configuration/shared/v2ray-transport). +V2Ray Transport configuration, see [V2Ray Transport](/configuration/shared/v2ray-transport/). ### Dial Fields -See [Dial Fields](/configuration/shared/dial) for details. +See [Dial Fields](/configuration/shared/dial/) for details. diff --git a/docs/configuration/outbound/vmess.zh.md b/docs/configuration/outbound/vmess.zh.md index dbf1612e51..295b8ddef0 100644 --- a/docs/configuration/outbound/vmess.zh.md +++ b/docs/configuration/outbound/vmess.zh.md @@ -100,7 +100,7 @@ UDP 包编码。 #### transport -V2Ray 传输配置，参阅 [V2Ray 传输层](/zh/configuration/shared/v2ray-transport)。 +V2Ray 传输配置，参阅 [V2Ray 传输层](/zh/configuration/shared/v2ray-transport/)。 ### 拨号字段 diff --git a/docs/configuration/outbound/wireguard.md b/docs/configuration/outbound/wireguard.md index c375fc3033..42ca832244 100644 --- a/docs/configuration/outbound/wireguard.md +++ b/docs/configuration/outbound/wireguard.md @@ -150,4 +150,4 @@ Both is enabled by default. ### Dial Fields -See [Dial Fields](/configuration/shared/dial) for details. +See [Dial Fields](/configuration/shared/dial/) for details. diff --git a/docs/configuration/route/index.md b/docs/configuration/route/index.md index 7c1787eaea..5deb44f5b7 100644 --- a/docs/configuration/route/index.md +++ b/docs/configuration/route/index.md @@ -32,18 +32,18 @@ icon: material/alert-decagram | Key | Format | |-----------|----------------------| -| `geoip` | [GeoIP](./geoip) | -| `geosite` | [Geosite](./geosite) | +| `geoip` | [GeoIP](./geoip/) | +| `geosite` | [Geosite](./geosite/) | #### rules -List of [Route Rule](./rule) +List of [Route Rule](./rule/) #### rule_set !!! question "Since sing-box 1.8.0" -List of [Rule Set](/configuration/rule-set) +List of [Rule Set](/configuration/rule-set/) #### final diff --git a/docs/configuration/route/index.zh.md b/docs/configuration/route/index.zh.md index b5302727a3..05461c1453 100644 --- a/docs/configuration/route/index.zh.md +++ b/docs/configuration/route/index.zh.md @@ -32,19 +32,19 @@ icon: material/alert-decagram | 键 | 格式 | |------------|-----------------------------------| -| `geoip` | [GeoIP](./geoip) | -| `geosite` | [Geosite](./geosite) | +| `geoip` | [GeoIP](./geoip/) | +| `geosite` | [Geosite](./geosite/) | #### rule -一组 [路由规则](./rule)。 +一组 [路由规则](./rule/)。 #### rule_set !!! question "自 sing-box 1.8.0 起" -一组 [规则集](/configuration/rule-set)。 +一组 [规则集](/configuration/rule-set/)。 #### final diff --git a/docs/configuration/route/rule.md b/docs/configuration/route/rule.md index ec19d0efb7..9bedef8675 100644 --- a/docs/configuration/route/rule.md +++ b/docs/configuration/route/rule.md @@ -144,7 +144,7 @@ icon: material/alert-decagram #### inbound -Tags of [Inbound](/configuration/inbound). +Tags of [Inbound](/configuration/inbound/). #### ip_version diff --git a/docs/configuration/route/rule.zh.md b/docs/configuration/route/rule.zh.md index 53cad72333..0e6f989604 100644 --- a/docs/configuration/route/rule.zh.md +++ b/docs/configuration/route/rule.zh.md @@ -142,7 +142,7 @@ icon: material/alert-decagram #### inbound -[入站](/zh/configuration/inbound) 标签。 +[入站](/zh/configuration/inbound/) 标签。 #### ip_version diff --git a/docs/configuration/rule-set/source-format.md b/docs/configuration/rule-set/source-format.md index 116c1ee66f..943496712b 100644 --- a/docs/configuration/rule-set/source-format.md +++ b/docs/configuration/rule-set/source-format.md @@ -31,4 +31,4 @@ Version of Rule Set, must be `1`. ==Required== -List of [Headless Rule](./headless-rule.md). +List of [Headless Rule](./headless-rule/). diff --git a/docs/configuration/shared/multiplex.md b/docs/configuration/shared/multiplex.md index eab2116381..bf722127c9 100644 --- a/docs/configuration/shared/multiplex.md +++ b/docs/configuration/shared/multiplex.md @@ -35,7 +35,7 @@ If enabled, non-padded connections will be rejected. #### brutal -See [TCP Brutal](/configuration/shared/tcp-brutal) for details. +See [TCP Brutal](/configuration/shared/tcp-brutal/) for details. ### Outbound Fields @@ -83,4 +83,4 @@ Enable padding. #### brutal -See [TCP Brutal](/configuration/shared/tcp-brutal) for details. +See [TCP Brutal](/configuration/shared/tcp-brutal/) for details. diff --git a/docs/configuration/shared/multiplex.zh.md b/docs/configuration/shared/multiplex.zh.md index ae1cad64e7..124fe49b00 100644 --- a/docs/configuration/shared/multiplex.zh.md +++ b/docs/configuration/shared/multiplex.zh.md @@ -34,7 +34,7 @@ #### brutal -参阅 [TCP Brutal](/zh/configuration/shared/tcp-brutal)。 +参阅 [TCP Brutal](/zh/configuration/shared/tcp-brutal/)。 ### 出站字段 @@ -82,4 +82,4 @@ #### brutal -参阅 [TCP Brutal](/zh/configuration/shared/tcp-brutal)。 \ No newline at end of file +参阅 [TCP Brutal](/zh/configuration/shared/tcp-brutal/)。 \ No newline at end of file diff --git a/docs/configuration/shared/tls.md b/docs/configuration/shared/tls.md index 8dead243bb..20a3abf8d8 100644 --- a/docs/configuration/shared/tls.md +++ b/docs/configuration/shared/tls.md @@ -363,7 +363,7 @@ The MAC key. ACME DNS01 challenge field. If configured, other challenge methods will be disabled. -See [DNS01 Challenge Fields](/configuration/shared/dns01_challenge) for details. +See [DNS01 Challenge Fields](/configuration/shared/dns01_challenge/) for details. ### Reality Fields @@ -373,7 +373,7 @@ See [DNS01 Challenge Fields](/configuration/shared/dns01_challenge) for details. ==Required== -Handshake server address and [Dial options](/configuration/shared/dial). +Handshake server address and [Dial options](/configuration/shared/dial/). #### private_key diff --git a/docs/configuration/shared/tls.zh.md b/docs/configuration/shared/tls.zh.md index 1e00b93fbe..1af7b01499 100644 --- a/docs/configuration/shared/tls.zh.md +++ b/docs/configuration/shared/tls.zh.md @@ -352,7 +352,7 @@ MAC 密钥。 ACME DNS01 验证字段。如果配置，将禁用其他验证方法。 -参阅 [DNS01 验证字段](/configuration/shared/dns01_challenge)。 +参阅 [DNS01 验证字段](/configuration/shared/dns01_challenge/)。 ### Reality 字段 diff --git a/docs/deprecated.md b/docs/deprecated.md index 2243acd351..d3f3893882 100644 --- a/docs/deprecated.md +++ b/docs/deprecated.md @@ -19,7 +19,7 @@ The maxmind GeoIP National Database, as an IP classification database, is not entirely suitable for traffic bypassing, and all existing implementations suffer from high memory usage and difficult management. -sing-box 1.8.0 introduces [Rule Set](/configuration/rule_set), which can completely replace GeoIP, +sing-box 1.8.0 introduces [Rule Set](/configuration/rule_set/), which can completely replace GeoIP, check [Migration](/migration/#migrate-geoip-to-rule-sets). #### Geosite @@ -29,7 +29,7 @@ Geosite is deprecated and may be removed in the future. Geosite, the `domain-list-community` project maintained by V2Ray as an early traffic bypassing solution, suffers from a number of problems, including lack of maintenance, inaccurate rules, and difficult management. -sing-box 1.8.0 introduces [Rule Set](/configuration/rule_set), which can completely replace Geosite, +sing-box 1.8.0 introduces [Rule Set](/configuration/rule_set/), which can completely replace Geosite, check [Migration](/migration/#migrate-geosite-to-rule-sets). Geosite，即由 V2Ray 维护的 domain-list-community 项目，作为早期流量绕过解决方案，存在着大量问题，包括缺少维护、规则不准确、管理困难。 diff --git a/docs/deprecated.zh.md b/docs/deprecated.zh.md index c8a61d049d..a1d6f51804 100644 --- a/docs/deprecated.zh.md +++ b/docs/deprecated.zh.md @@ -18,7 +18,7 @@ GeoIP 已废弃且可能在不久的将来移除。 maxmind GeoIP 国家数据库作为 IP 分类数据库，不完全适合流量绕过， 且现有的实现均存在内存使用大与管理困难的问题。 -sing-box 1.8.0 引入了[规则集](/configuration/rule_set)， +sing-box 1.8.0 引入了[规则集](/configuration/rule_set/)， 可以完全替代 GeoIP， 参阅 [迁移指南](/zh/migration/#geoip)。 #### Geosite @@ -28,7 +28,7 @@ Geosite 已废弃且可能在不久的将来移除。 Geosite，即由 V2Ray 维护的 domain-list-community 项目，作为早期流量绕过解决方案， 存在着包括缺少维护、规则不准确和管理困难内的大量问题。 -sing-box 1.8.0 引入了[规则集](/configuration/rule_set)， +sing-box 1.8.0 引入了[规则集](/configuration/rule_set/)， 可以完全替代 Geosite，参阅 [迁移指南](/zh/migration/#geosite)。 ## 1.6.0 diff --git a/docs/installation/build-from-source.md b/docs/installation/build-from-source.md index 5d4c3f7912..c2ee272390 100644 --- a/docs/installation/build-from-source.md +++ b/docs/installation/build-from-source.md @@ -55,17 +55,17 @@ go build -tags "tag_a tag_b" ./cmd/sing-box | Build Tag | Enabled by default | Description | |------------------------------------|--------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| `with_quic` | :material-check: | Build with QUIC support, see [QUIC and HTTP3 DNS transports](/configuration/dns/server), [Naive inbound](/configuration/inbound/naive), [Hysteria Inbound](/configuration/inbound/hysteria), [Hysteria Outbound](/configuration/outbound/hysteria) and [V2Ray Transport#QUIC](/configuration/shared/v2ray-transport#quic). | +| `with_quic` | :material-check: | Build with QUIC support, see [QUIC and HTTP3 DNS transports](/configuration/dns/server/), [Naive inbound](/configuration/inbound/naive/), [Hysteria Inbound](/configuration/inbound/hysteria/), [Hysteria Outbound](/configuration/outbound/hysteria/) and [V2Ray Transport#QUIC](/configuration/shared/v2ray-transport#quic). | | `with_grpc` | :material-close:️ | Build with standard gRPC support, see [V2Ray Transport#gRPC](/configuration/shared/v2ray-transport#grpc). | -| `with_dhcp` | :material-check: | Build with DHCP support, see [DHCP DNS transport](/configuration/dns/server). | -| `with_wireguard` | :material-check: | Build with WireGuard support, see [WireGuard outbound](/configuration/outbound/wireguard). | +| `with_dhcp` | :material-check: | Build with DHCP support, see [DHCP DNS transport](/configuration/dns/server/). | +| `with_wireguard` | :material-check: | Build with WireGuard support, see [WireGuard outbound](/configuration/outbound/wireguard/). | | `with_ech` | :material-check: | Build with TLS ECH extension support for TLS outbound, see [TLS](/configuration/shared/tls#ech). | | `with_utls` | :material-check: | Build with [uTLS](https://github.com/refraction-networking/utls) support for TLS outbound, see [TLS](/configuration/shared/tls#utls). | -| `with_reality_server` | :material-check: | Build with reality TLS server support, see [TLS](/configuration/shared/tls). | -| `with_acme` | :material-check: | Build with ACME TLS certificate issuer support, see [TLS](/configuration/shared/tls). | +| `with_reality_server` | :material-check: | Build with reality TLS server support, see [TLS](/configuration/shared/tls/). | +| `with_acme` | :material-check: | Build with ACME TLS certificate issuer support, see [TLS](/configuration/shared/tls/). | | `with_clash_api` | :material-check: | Build with Clash API support, see [Experimental](/configuration/experimental#clash-api-fields). | | `with_v2ray_api` | :material-close:️ | Build with V2Ray API support, see [Experimental](/configuration/experimental#v2ray-api-fields). | | `with_gvisor` | :material-check: | Build with gVisor support, see [Tun inbound](/configuration/inbound/tun#stack) and [WireGuard outbound](/configuration/outbound/wireguard#system_interface). | -| `with_embedded_tor` (CGO required) | :material-close:️ | Build with embedded Tor support, see [Tor outbound](/configuration/outbound/tor). | +| `with_embedded_tor` (CGO required) | :material-close:️ | Build with embedded Tor support, see [Tor outbound](/configuration/outbound/tor/). | It is not recommended to change the default build tag list unless you really know what you are adding. diff --git a/docs/installation/build-from-source.zh.md b/docs/installation/build-from-source.zh.md index 4cac68ba1d..a1a09b9312 100644 --- a/docs/installation/build-from-source.zh.md +++ b/docs/installation/build-from-source.zh.md @@ -55,17 +55,17 @@ go build -tags "tag_a tag_b" ./cmd/sing-box | 构建标记 | 默认启动 | 说明 | |------------------------------------|-------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| `with_quic` | :material-check: | Build with QUIC support, see [QUIC and HTTP3 DNS transports](/configuration/dns/server), [Naive inbound](/configuration/inbound/naive), [Hysteria Inbound](/configuration/inbound/hysteria), [Hysteria Outbound](/configuration/outbound/hysteria) and [V2Ray Transport#QUIC](/configuration/shared/v2ray-transport#quic). | +| `with_quic` | :material-check: | Build with QUIC support, see [QUIC and HTTP3 DNS transports](/configuration/dns/server/), [Naive inbound](/configuration/inbound/naive/), [Hysteria Inbound](/configuration/inbound/hysteria/), [Hysteria Outbound](/configuration/outbound/hysteria/) and [V2Ray Transport#QUIC](/configuration/shared/v2ray-transport#quic). | | `with_grpc` | :material-close:️ | Build with standard gRPC support, see [V2Ray Transport#gRPC](/configuration/shared/v2ray-transport#grpc). | -| `with_dhcp` | :material-check: | Build with DHCP support, see [DHCP DNS transport](/configuration/dns/server). | -| `with_wireguard` | :material-check: | Build with WireGuard support, see [WireGuard outbound](/configuration/outbound/wireguard). | +| `with_dhcp` | :material-check: | Build with DHCP support, see [DHCP DNS transport](/configuration/dns/server/). | +| `with_wireguard` | :material-check: | Build with WireGuard support, see [WireGuard outbound](/configuration/outbound/wireguard/). | | `with_ech` | :material-check: | Build with TLS ECH extension support for TLS outbound, see [TLS](/configuration/shared/tls#ech). | | `with_utls` | :material-check: | Build with [uTLS](https://github.com/refraction-networking/utls) support for TLS outbound, see [TLS](/configuration/shared/tls#utls). | -| `with_reality_server` | :material-check: | Build with reality TLS server support, see [TLS](/configuration/shared/tls). | -| `with_acme` | :material-check: | Build with ACME TLS certificate issuer support, see [TLS](/configuration/shared/tls). | +| `with_reality_server` | :material-check: | Build with reality TLS server support, see [TLS](/configuration/shared/tls/). | +| `with_acme` | :material-check: | Build with ACME TLS certificate issuer support, see [TLS](/configuration/shared/tls/). | | `with_clash_api` | :material-check: | Build with Clash API support, see [Experimental](/configuration/experimental#clash-api-fields). | | `with_v2ray_api` | :material-close:️ | Build with V2Ray API support, see [Experimental](/configuration/experimental#v2ray-api-fields). | | `with_gvisor` | :material-check: | Build with gVisor support, see [Tun inbound](/configuration/inbound/tun#stack) and [WireGuard outbound](/configuration/outbound/wireguard#system_interface). | -| `with_embedded_tor` (CGO required) | :material-close:️ | Build with embedded Tor support, see [Tor outbound](/configuration/outbound/tor). | +| `with_embedded_tor` (CGO required) | :material-close:️ | Build with embedded Tor support, see [Tor outbound](/configuration/outbound/tor/). | 除非您确实知道您正在启用什么，否则不建议更改默认构建标签列表。 diff --git a/docs/migration.md b/docs/migration.md index ea2875265a..5fa1dbff17 100644 --- a/docs/migration.md +++ b/docs/migration.md @@ -12,8 +12,8 @@ icon: material/arrange-bring-forward !!! info "References" - [Clash API](/configuration/experimental/clash-api) / - [Cache File](/configuration/experimental/cache-file) + [Clash API](/configuration/experimental/clash-api/) / + [Cache File](/configuration/experimental/cache-file/) === ":material-card-remove: Deprecated" @@ -50,11 +50,11 @@ icon: material/arrange-bring-forward !!! info "References" - [GeoIP](/configuration/route/geoip) / - [Route](/configuration/route) / - [Route Rule](/configuration/route/rule) / - [DNS Rule](/configuration/dns/rule) / - [Rule Set](/configuration/rule-set) + [GeoIP](/configuration/route/geoip/) / + [Route](/configuration/route/) / + [Route Rule](/configuration/route/rule/) / + [DNS Rule](/configuration/dns/rule/) / + [Rule Set](/configuration/rule-set/) !!! tip @@ -135,11 +135,11 @@ icon: material/arrange-bring-forward !!! info "References" - [Geosite](/configuration/route/geosite) / - [Route](/configuration/route) / - [Route Rule](/configuration/route/rule) / - [DNS Rule](/configuration/dns/rule) / - [Rule Set](/configuration/rule-set) + [Geosite](/configuration/route/geosite/) / + [Route](/configuration/route/) / + [Route Rule](/configuration/route/rule/) / + [DNS Rule](/configuration/dns/rule/) / + [Rule Set](/configuration/rule-set/) !!! tip diff --git a/docs/migration.zh.md b/docs/migration.zh.md index cdde2a6377..d1d78ed61c 100644 --- a/docs/migration.zh.md +++ b/docs/migration.zh.md @@ -12,8 +12,8 @@ icon: material/arrange-bring-forward !!! info "参考" - [Clash API](/zh/configuration/experimental/clash-api) / - [Cache File](/zh/configuration/experimental/cache-file) + [Clash API](/zh/configuration/experimental/clash-api/) / + [Cache File](/zh/configuration/experimental/cache-file/) === ":material-card-remove: 弃用的" @@ -50,11 +50,11 @@ icon: material/arrange-bring-forward !!! info "参考" - [GeoIP](/zh/configuration/route/geoip) / - [路由](/zh/configuration/route) / - [路由规则](/zh/configuration/route/rule) / - [DNS 规则](/zh/configuration/dns/rule) / - [规则集](/zh/configuration/rule-set) + [GeoIP](/zh/configuration/route/geoip/) / + [路由](/zh/configuration/route/) / + [路由规则](/zh/configuration/route/rule/) / + [DNS 规则](/zh/configuration/dns/rule/) / + [规则集](/zh/configuration/rule-set/) !!! tip @@ -135,11 +135,11 @@ icon: material/arrange-bring-forward !!! info "参考" - [Geosite](/zh/configuration/route/geosite) / - [路由](/zh/configuration/route) / - [路由规则](/zh/configuration/route/rule) / - [DNS 规则](/zh/configuration/dns/rule) / - [规则集](/zh/configuration/rule-set) + [Geosite](/zh/configuration/route/geosite/) / + [路由](/zh/configuration/route/) / + [路由规则](/zh/configuration/route/rule/) / + [DNS 规则](/zh/configuration/dns/rule/) / + [规则集](/zh/configuration/rule-set/) !!! tip