diff --git a/docs/changelog.md b/docs/changelog.md index 14056900..bfbb4415 100644 --- a/docs/changelog.md +++ b/docs/changelog.md @@ -29,8 +29,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** @@ -60,7 +60,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**: @@ -149,7 +149,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 @@ -169,7 +169,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 @@ -188,13 +188,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**: @@ -212,8 +212,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**: @@ -331,7 +331,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 @@ -351,7 +351,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**: @@ -365,7 +365,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** @@ -374,7 +374,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**: @@ -386,7 +386,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) @@ -399,7 +399,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**: @@ -481,7 +481,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 @@ -510,7 +510,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 @@ -529,13 +529,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** @@ -568,12 +568,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. @@ -604,7 +604,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. @@ -642,8 +642,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 @@ -652,7 +652,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 @@ -679,7 +679,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**: @@ -700,7 +700,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 @@ -727,11 +727,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 @@ -793,7 +793,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 @@ -845,25 +845,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 @@ -892,16 +892,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 @@ -932,7 +932,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 @@ -949,7 +949,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 @@ -962,8 +962,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 @@ -978,7 +978,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 @@ -998,9 +998,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 @@ -1229,7 +1229,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 @@ -1261,8 +1261,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 @@ -1289,7 +1289,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*: @@ -1370,15 +1370,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 @@ -1422,7 +1422,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 @@ -1431,13 +1431,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 @@ -1451,8 +1451,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 @@ -1470,11 +1470,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 @@ -1483,15 +1483,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 b80c1618..45d2c9a9 100644 --- a/docs/clients/index.md +++ b/docs/clients/index.md @@ -2,11 +2,11 @@ Maintained by Project S to provide a unified experience and platform-specific functionality. -| Platform | Client | -|---------------------------------------|-----------------------------------------| -| :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 | +| Platform | Client | +|---------------------------------------|------------------------------------------| +| :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 motivation of the maintainers of such projects is to acquire more users, and even though they provide friendly VPN diff --git a/docs/clients/index.zh.md b/docs/clients/index.zh.md index ef643086..81e41291 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 5f8b2547..e2832c42 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 b84f9528..afc6e931 100644 --- a/docs/configuration/dns/index.zh.md +++ b/docs/configuration/dns/index.zh.md @@ -21,10 +21,10 @@ ### 字段 -| 键 | 格式 | -|----------|------------------------| -| `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 18e352b4..297a2968 100644 --- a/docs/configuration/dns/rule.md +++ b/docs/configuration/dns/rule.md @@ -124,7 +124,7 @@ #### 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 98bfa8ab..9cb4e89d 100644 --- a/docs/configuration/dns/rule.zh.md +++ b/docs/configuration/dns/rule.zh.md @@ -121,7 +121,7 @@ #### inbound -[入站](/zh/configuration/inbound) 标签. +[入站](/zh/configuration/inbound/) 标签. #### ip_version diff --git a/docs/configuration/dns/server.md b/docs/configuration/dns/server.md index 2ce50b38..e408b804 100644 --- a/docs/configuration/dns/server.md +++ b/docs/configuration/dns/server.md @@ -30,18 +30,18 @@ The tag of the dns server. The address of the dns server. -| Protocol | Format | -|-------------------------------------|-------------------------------| -| `System` | `local` | -| `TCP` | `tcp://1.0.0.1` | -| `UDP` | `8.8.8.8` `udp://8.8.4.4` | -| `TLS` | `tls://dns.google` | -| `HTTPS` | `https://1.1.1.1/dns-query` | -| `QUIC` | `quic://dns.adguard.com` | -| `HTTP3` | `h3://8.8.8.8/dns-query` | -| `RCode` | `rcode://refused` | -| `DHCP` | `dhcp://auto` or `dhcp://en0` | -| [FakeIP](/configuration/dns/fakeip) | `fakeip` | +| Protocol | Format | +|--------------------------------------|-------------------------------| +| `System` | `local` | +| `TCP` | `tcp://1.0.0.1` | +| `UDP` | `8.8.8.8` `udp://8.8.4.4` | +| `TLS` | `tls://dns.google` | +| `HTTPS` | `https://1.1.1.1/dns-query` | +| `QUIC` | `quic://dns.adguard.com` | +| `HTTP3` | `h3://8.8.8.8/dns-query` | +| `RCode` | `rcode://refused` | +| `DHCP` | `dhcp://auto` or `dhcp://en0` | +| [FakeIP](/configuration/dns/fakeip/) | `fakeip` | !!! warning "" diff --git a/docs/configuration/dns/server.zh.md b/docs/configuration/dns/server.zh.md index 36d0fb63..4ce8c01d 100644 --- a/docs/configuration/dns/server.zh.md +++ b/docs/configuration/dns/server.zh.md @@ -30,18 +30,18 @@ DNS 服务器的标签。 DNS 服务器的地址。 -| 协议 | 格式 | -|-------------------------------------|------------------------------| -| `System` | `local` | -| `TCP` | `tcp://1.0.0.1` | -| `UDP` | `8.8.8.8` `udp://8.8.4.4` | -| `TLS` | `tls://dns.google` | -| `HTTPS` | `https://1.1.1.1/dns-query` | -| `QUIC` | `quic://dns.adguard.com` | -| `HTTP3` | `h3://8.8.8.8/dns-query` | -| `RCode` | `rcode://refused` | -| `DHCP` | `dhcp://auto` 或 `dhcp://en0` | -| [FakeIP](/configuration/dns/fakeip) | `fakeip` | +| 协议 | 格式 | +|--------------------------------------|------------------------------| +| `System` | `local` | +| `TCP` | `tcp://1.0.0.1` | +| `UDP` | `8.8.8.8` `udp://8.8.4.4` | +| `TLS` | `tls://dns.google` | +| `HTTPS` | `https://1.1.1.1/dns-query` | +| `QUIC` | `quic://dns.adguard.com` | +| `HTTP3` | `h3://8.8.8.8/dns-query` | +| `RCode` | `rcode://refused` | +| `DHCP` | `dhcp://auto` 或 `dhcp://en0` | +| [FakeIP](/configuration/dns/fakeip/) | `fakeip` | !!! warning "" diff --git a/docs/configuration/inbound/direct.md b/docs/configuration/inbound/direct.md index 706c6775..6dc93578 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 3b149050..cd2ec35d 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 f027a056..a0b24866 100644 --- a/docs/configuration/inbound/hysteria.md +++ b/docs/configuration/inbound/hysteria.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/hysteria2.md b/docs/configuration/inbound/hysteria2.md index 4427b651..c0ae52b7 100644 --- a/docs/configuration/inbound/hysteria2.md +++ b/docs/configuration/inbound/hysteria2.md @@ -39,7 +39,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 830d86a9..9591ae86 100644 --- a/docs/configuration/inbound/index.md +++ b/docs/configuration/inbound/index.md @@ -15,24 +15,24 @@ ### Fields -| 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 | +| 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 | #### tag diff --git a/docs/configuration/inbound/index.zh.md b/docs/configuration/inbound/index.zh.md index 5b3592f6..458cd602 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 62313f48..1f5bf0ac 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 562a7070..0e4b8cea 100644 --- a/docs/configuration/inbound/naive.md +++ b/docs/configuration/inbound/naive.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/redirect.md b/docs/configuration/inbound/redirect.md index 97736e28..50a5bacd 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 415a5913..4072782b 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 36a292bb..cdfd8080 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 e8b7ba23..db010b79 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 59f7d96f..4937f390 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 4975931e..42288537 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 cd45539d..bd6c73b3 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 54144ae6..d8b30cae 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 d4d9aafd..4ed3dca9 100644 --- a/docs/configuration/inbound/tuic.md +++ b/docs/configuration/inbound/tuic.md @@ -28,7 +28,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 f8a9df3b..d954de6b 100644 --- a/docs/configuration/inbound/tun.md +++ b/docs/configuration/inbound/tun.md @@ -241,4 +241,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 f78ae01c..93faf716 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 4beecd6f..30b151da 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 0e559d1e..f38a6cae 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 9554ab79..9aef44df 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 a4ade707..0c22fc25 100644 --- a/docs/configuration/index.md +++ b/docs/configuration/index.md @@ -18,15 +18,15 @@ sing-box uses JSON for configuration files. ### Fields -| Key | Format | -|----------------|--------------------------------| -| `log` | [Log](./log) | -| `dns` | [DNS](./dns) | -| `ntp` | [NTP](./ntp) | -| `inbounds` | [Inbound](./inbound) | -| `outbounds` | [Outbound](./outbound) | -| `route` | [Route](./route) | -| `experimental` | [Experimental](./experimental) | +| Key | Format | +|----------------|---------------------------------| +| `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 80b2ebd3..0d24a7ca 100644 --- a/docs/configuration/index.zh.md +++ b/docs/configuration/index.zh.md @@ -17,14 +17,14 @@ sing-box 使用 JSON 作为配置文件格式。 ### 字段 -| Key | Format | -|----------------|-----------------------| -| `log` | [日志](./log) | -| `dns` | [DNS](./dns) | -| `inbounds` | [入站](./inbound) | -| `outbounds` | [出站](./outbound) | -| `route` | [路由](./route) | -| `experimental` | [实验性](./experimental) | +| Key | Format | +|----------------|------------------------| +| `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 8b3570a3..b95b9b1f 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 68eb0daf..c2f5671a 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 c6942223..0b9dfa23 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 ff9974de..ab9191d7 100644 --- a/docs/configuration/outbound/hysteria.md +++ b/docs/configuration/outbound/hysteria.md @@ -113,4 +113,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 90860c1c..eacb284e 100644 --- a/docs/configuration/outbound/hysteria2.md +++ b/docs/configuration/outbound/hysteria2.md @@ -88,4 +88,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 3fcd636d..1ce5405f 100644 --- a/docs/configuration/outbound/index.md +++ b/docs/configuration/outbound/index.md @@ -15,27 +15,27 @@ ### Fields -| 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) | -| `shadowsocksr` | [ShadowsocksR](./shadowsocksr) | -| `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) | +| 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/) | +| `shadowsocksr` | [ShadowsocksR](./shadowsocksr/) | +| `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 3b950e4d..f1577dd4 100644 --- a/docs/configuration/outbound/index.zh.md +++ b/docs/configuration/outbound/index.zh.md @@ -15,27 +15,27 @@ ### 字段 -| 类型 | 格式 | -|----------------|--------------------------------| -| `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) | -| `shadowsocksr` | [ShadowsocksR](./shadowsocksr) | -| `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/) | +| `shadowsocksr` | [ShadowsocksR](./shadowsocksr/) | +| `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 6fc93484..a088d271 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 6d9b7a5c..818a4fa9 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/shadowsocksr.md b/docs/configuration/outbound/shadowsocksr.md index 0c7f1b32..2ac145f3 100644 --- a/docs/configuration/outbound/shadowsocksr.md +++ b/docs/configuration/outbound/shadowsocksr.md @@ -103,4 +103,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/outbound/shadowtls.md b/docs/configuration/outbound/shadowtls.md index 1fa08c77..a54391b5 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 94d83fe5..b04e67b6 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 75548da7..dd9a1ac9 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 1384f8dd..45ec72b2 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 fe7e4ff6..0c1baf96 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 34b16c7d..6a45fd02 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 55bb9709..2248c739 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 522e7892..80baf41e 100644 --- a/docs/configuration/outbound/tuic.md +++ b/docs/configuration/outbound/tuic.md @@ -72,7 +72,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. @@ -97,4 +97,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 11d44448..b81ffb52 100644 --- a/docs/configuration/outbound/tuic.zh.md +++ b/docs/configuration/outbound/tuic.zh.md @@ -70,7 +70,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 0d2fadc6..28134e55 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 3d3f24ee..8978a6ac 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 ac29559e..536601af 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 dbf1612e..295b8dde 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 c9c49c79..f0d0ab83 100644 --- a/docs/configuration/outbound/wireguard.md +++ b/docs/configuration/outbound/wireguard.md @@ -139,4 +139,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 846d4973..1ab85a4d 100644 --- a/docs/configuration/route/index.md +++ b/docs/configuration/route/index.md @@ -19,11 +19,11 @@ ### Fields -| Key | Format | -|------------|------------------------------------| -| `geoip` | [GeoIP](./geoip) | -| `geosite` | [Geosite](./geosite) | -| `rules` | List of [Route Rule](./rule) | +| Key | Format | +|-----------|-------------------------------| +| `geoip` | [GeoIP](./geoip/) | +| `geosite` | [Geosite](./geosite/) | +| `rules` | List of [Route Rule](./rule/) | #### final diff --git a/docs/configuration/route/index.zh.md b/docs/configuration/route/index.zh.md index 8bef5bea..92e98e49 100644 --- a/docs/configuration/route/index.zh.md +++ b/docs/configuration/route/index.zh.md @@ -20,11 +20,11 @@ ### 字段 -| 键 | 格式 | -|------------|-------------------------| -| `geoip` | [GeoIP](./geoip) | -| `geosite` | [GeoSite](./geosite) | -| `rules` | 一组 [路由规则](./rule) | +| 键 | 格式 | +|-----------|-----------------------| +| `geoip` | [GeoIP](./geoip/) | +| `geosite` | [GeoSite](./geosite/) | +| `rules` | 一组 [路由规则](./rule/) | #### final diff --git a/docs/configuration/route/rule.md b/docs/configuration/route/rule.md index abbfde6f..2342ce22 100644 --- a/docs/configuration/route/rule.md +++ b/docs/configuration/route/rule.md @@ -122,7 +122,7 @@ #### 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 f4ab7890..7c49eb43 100644 --- a/docs/configuration/route/rule.zh.md +++ b/docs/configuration/route/rule.zh.md @@ -120,7 +120,7 @@ #### inbound -[入站](/zh/configuration/inbound) 标签。 +[入站](/zh/configuration/inbound/) 标签。 #### ip_version diff --git a/docs/configuration/shared/multiplex.md b/docs/configuration/shared/multiplex.md index eab21163..bf722127 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 ae1cad64..124fe49b 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 9a02bbff..8540d59c 100644 --- a/docs/configuration/shared/tls.md +++ b/docs/configuration/shared/tls.md @@ -353,7 +353,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 @@ -371,7 +371,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 bbb08719..620956df 100644 --- a/docs/configuration/shared/tls.zh.md +++ b/docs/configuration/shared/tls.zh.md @@ -344,7 +344,7 @@ MAC 密钥。 ACME DNS01 验证字段。如果配置，将禁用其他验证方法。 -参阅 [DNS01 验证字段](/configuration/shared/dns01_challenge)。 +参阅 [DNS01 验证字段](/configuration/shared/dns01_challenge/)。 ### Reality 字段 diff --git a/docs/installation/build-from-source.md b/docs/installation/build-from-source.md index 0ac7169a..9c9f6162 100644 --- a/docs/installation/build-from-source.md +++ b/docs/installation/build-from-source.md @@ -43,21 +43,21 @@ go build -tags "tag_a tag_b" ./cmd/sing-box ## :material-folder-settings: Build Tags -| Build Tag | Enabled by default | Description | -|------------------------------------|--------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| `with_quic` | ✔ | 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` | ✖️ | Build with standard gRPC support, see [V2Ray Transport#gRPC](/configuration/shared/v2ray-transport#grpc). | -| `with_dhcp` | ✔ | Build with DHCP support, see [DHCP DNS transport](/configuration/dns/server). | -| `with_wireguard` | ✔ | Build with WireGuard support, see [WireGuard outbound](/configuration/outbound/wireguard). | -| `with_ech` | ✔ | Build with TLS ECH extension support for TLS outbound, see [TLS](/configuration/shared/tls#ech). | -| `with_utls` | ✔ | Build with [uTLS](https://github.com/refraction-networking/utls) support for TLS outbound, see [TLS](/configuration/shared/tls#utls). | -| `with_reality_server` | ✔ | Build with reality TLS server support, see [TLS](/configuration/shared/tls). | -| `with_acme` | ✔ | Build with ACME TLS certificate issuer support, see [TLS](/configuration/shared/tls). | -| `with_clash_api` | ✔ | Build with Clash API support, see [Experimental](/configuration/experimental#clash-api-fields). | -| `with_v2ray_api` | ✖️ | Build with V2Ray API support, see [Experimental](/configuration/experimental#v2ray-api-fields). | -| `with_gvisor` | ✔ | Build with gVisor support, see [Tun inbound](/configuration/inbound/tun#stack) and [WireGuard outbound](/configuration/outbound/wireguard#system_interface). | -| `with_embedded_tor` (CGO required) | ✖️ | Build with embedded Tor support, see [Tor outbound](/configuration/outbound/tor). | -| `with_lwip` (CGO required) | ✖️ | Build with LWIP Tun stack support, see [Tun inbound](/configuration/inbound/tun#stack). | +| Build Tag | Enabled by default | Description | +|------------------------------------|--------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| `with_quic` | ✔ | 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` | ✖️ | Build with standard gRPC support, see [V2Ray Transport#gRPC](/configuration/shared/v2ray-transport#grpc). | +| `with_dhcp` | ✔ | Build with DHCP support, see [DHCP DNS transport](/configuration/dns/server/). | +| `with_wireguard` | ✔ | Build with WireGuard support, see [WireGuard outbound](/configuration/outbound/wireguard/). | +| `with_ech` | ✔ | Build with TLS ECH extension support for TLS outbound, see [TLS](/configuration/shared/tls#ech). | +| `with_utls` | ✔ | Build with [uTLS](https://github.com/refraction-networking/utls) support for TLS outbound, see [TLS](/configuration/shared/tls#utls). | +| `with_reality_server` | ✔ | Build with reality TLS server support, see [TLS](/configuration/shared/tls/). | +| `with_acme` | ✔ | Build with ACME TLS certificate issuer support, see [TLS](/configuration/shared/tls/). | +| `with_clash_api` | ✔ | Build with Clash API support, see [Experimental](/configuration/experimental#clash-api-fields). | +| `with_v2ray_api` | ✖️ | Build with V2Ray API support, see [Experimental](/configuration/experimental#v2ray-api-fields). | +| `with_gvisor` | ✔ | Build with gVisor support, see [Tun inbound](/configuration/inbound/tun#stack) and [WireGuard outbound](/configuration/outbound/wireguard#system_interface). | +| `with_embedded_tor` (CGO required) | ✖️ | Build with embedded Tor support, see [Tor outbound](/configuration/outbound/tor/). | +| `with_lwip` (CGO required) | ✖️ | Build with LWIP Tun stack support, see [Tun inbound](/configuration/inbound/tun#stack). | It is not recommended to change the default build tag list unless you really know what you are adding.