black-internet-days-ahead/sing-box
1
0
Fork 0
mirror of https://github.com/SagerNet/sing-box.git synced 2024-11-24 17:41:29 +00:00
Code Issues Packages Projects Releases Wiki Activity

documentation: Fix link format

Browse source
This commit is contained in:
世界 2023-12-14 22:23:52 +08:00
parent c05c798221
commit bb1ebfda83
No known key found for this signature in database
GPG key ID: CD109927C34A63C4
66 changed files with 292 additions and 292 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

140
docs/changelog.md
View file

@ -29,8 +29,8 @@ by the Apple App Store, so updates to Apple Platforms will be delayed._
Important changes since 1.6: Important changes since 1.6:
* Add [exclude route support](/configuration/inbound/tun) for TUN inbound * Add [exclude route support](/configuration/inbound/tun/) for TUN inbound
* Add `udp_disable_domain_unmapping` [inbound listen option](/configuration/shared/listen) **1** * Add `udp_disable_domain_unmapping` [inbound listen option](/configuration/shared/listen/) **1**
* Add [HTTPUpgrade V2Ray transport](/configuration/shared/v2ray-transport#HTTPUpgrade) support **2** * Add [HTTPUpgrade V2Ray transport](/configuration/shared/v2ray-transport#HTTPUpgrade) support **2**
* Migrate multiplex and UoT server to inbound **3** * Migrate multiplex and UoT server to inbound **3**
* Add TCP Brutal support for multiplex **4** * Add TCP Brutal support for multiplex **4**
@ -60,7 +60,7 @@ and needs to be turned on explicitly in inbound options.
**4** **4**
Hysteria Brutal Congestion Control Algorithm in TCP. A kernel module needs to be installed on the Linux server, 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**: **5**:
@ -149,7 +149,7 @@ Only supported in graphical clients on Android and iOS.
#### 1.6.1 #### 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 * Fixes and improvements
#### 1.7.0-alpha.6 #### 1.7.0-alpha.6
@ -169,7 +169,7 @@ options.
**2** **2**
Hysteria Brutal Congestion Control Algorithm in TCP. A kernel module needs to be installed on the Linux server, 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 #### 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: 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 BBR congestion control for TUIC and Hysteria2 **1**
* Update brutal congestion control for Hysteria2 * Update brutal congestion control for Hysteria2
* Add `brutal_debug` option for Hysteria2 * Add `brutal_debug` option for Hysteria2
* Update legacy Hysteria protocol **2** * Update legacy Hysteria protocol **2**
* Add TLS self sign key pair generate command * Add TLS self sign key pair generate command
* Remove [Deprecated Features](/deprecated) by agreement * Remove [Deprecated Features](/deprecated/) by agreement
**1**: **1**:
@ -212,8 +212,8 @@ the old protocol (Hysteria 1) have been updated to be consistent with Hysteria 2
#### 1.7.0-alpha.1 #### 1.7.0-alpha.1
* Add [exclude route support](/configuration/inbound/tun) for TUN inbound * Add [exclude route support](/configuration/inbound/tun/) for TUN inbound
* Add `udp_disable_domain_unmapping` [inbound listen option](/configuration/shared/listen) **1** * Add `udp_disable_domain_unmapping` [inbound listen option](/configuration/shared/listen/) **1**
* Fixes and improvements * Fixes and improvements
**1**: **1**:
@ -331,7 +331,7 @@ introduce new issues.
#### 1.5.2 #### 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 * Fixes and improvements
#### 1.6.0-alpha.3 #### 1.6.0-alpha.3
@ -351,7 +351,7 @@ introduce new issues.
* Update BBR congestion control for TUIC and Hysteria2 **1** * Update BBR congestion control for TUIC and Hysteria2 **1**
* Update quic-go to v0.39.0 * Update quic-go to v0.39.0
* Update gVisor to 20230814.0 * Update gVisor to 20230814.0
* Remove [Deprecated Features](/deprecated) by agreement * Remove [Deprecated Features](/deprecated/) by agreement
* Fixes and improvements * Fixes and improvements
**1**: **1**:
@ -365,7 +365,7 @@ This update is intended to address the multi-send defects of the old implementat
Important changes since 1.4: 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 * Improve TLS TCH client configuration
* Add TLS ECH key pair generator **1** * Add TLS ECH key pair generator **1**
* Add TLS ECH support for QUIC based protocols **2** * 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 `interrupt_exist_connections` option for `Selector` and `URLTest` outbounds **4**
* Add DNS01 challenge support for ACME TLS certificate issuer **5** * Add DNS01 challenge support for ACME TLS certificate issuer **5**
* Add `merge` command **6** * Add `merge` command **6**
* Mark [Deprecated Features](/deprecated) * Mark [Deprecated Features](/deprecated/)
**1**: **1**:
@ -386,7 +386,7 @@ All inbounds and outbounds are supported, including `Naiveproxy`, `Hysteria[/2]`
**3**: **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) 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**: **5**:
Only `Alibaba Cloud DNS` and `Cloudflare` are supported, see [ACME Fields](/configuration/shared/tls#acme-fields) 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**: **6**:
@ -481,7 +481,7 @@ Global Flags:
Only `Alibaba Cloud DNS` and `Cloudflare` are supported, Only `Alibaba Cloud DNS` and `Cloudflare` are supported,
see [ACME Fields](/configuration/shared/tls#acme-fields) 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 #### 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 * Fix compatibility issues with official Hysteria2 server and client
* Fixes and improvements * Fixes and improvements
* Mark [deprecated features](/deprecated) * Mark [deprecated features](/deprecated/)
#### 1.5.0-beta.3 #### 1.5.0-beta.3
@ -529,13 +529,13 @@ Hysteria2 server and client when using `fastOpen=false` or UDP MTU >= 1200.
**1**: **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) For protocol description, please refer to [https://v2.hysteria.network](https://v2.hysteria.network)
#### 1.5.0-beta.1 #### 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 * Improve TLS TCH client configuration
* Add TLS ECH key pair generator **1** * Add TLS ECH key pair generator **1**
* Add TLS ECH support for QUIC based protocols **2** * Add TLS ECH support for QUIC based protocols **2**
@ -568,12 +568,12 @@ Important changes since 1.3:
*1*: *1*:
See [TUIC inbound](/configuration/inbound/tuic) See [TUIC inbound](/configuration/inbound/tuic/)
and [TUIC outbound](/configuration/outbound/tuic) and [TUIC outbound](/configuration/outbound/tuic/)
**2**: **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 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. another program compatible with the protocol as a server.
@ -604,7 +604,7 @@ Requires sing-box to be compiled with Go 1.21.
**1**: **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 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. another program compatible with the protocol as a server.
@ -642,8 +642,8 @@ Requires sing-box to be compiled with Go 1.21.
*1*: *1*:
See [TUIC inbound](/configuration/inbound/tuic) See [TUIC inbound](/configuration/inbound/tuic/)
and [TUIC outbound](/configuration/outbound/tuic) and [TUIC outbound](/configuration/outbound/tuic/)
#### 1.3.6 #### 1.3.6
@ -652,7 +652,7 @@ and [TUIC outbound](/configuration/outbound/tuic)
#### 1.3.5 #### 1.3.5
* Fixes and improvements * 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 per app proxy and app installed/updated trigger support for Android client
* Add profile sharing support for Android/iOS/macOS clients * Add profile sharing support for Android/iOS/macOS clients
@ -679,7 +679,7 @@ downloaded through TestFlight.
#### 1.3.1-beta.3 #### 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 * Fixes and improvements
**1**: **1**:
@ -700,7 +700,7 @@ The old testflight link and app are no longer valid.
Important changes since 1.2: Important changes since 1.2:
* Add [FakeIP](/configuration/dns/fakeip) support **1** * Add [FakeIP](/configuration/dns/fakeip/) support **1**
* Improve multiplex **2** * Improve multiplex **2**
* Add [DNS reverse mapping](/configuration/dns#reverse_mapping) support * Add [DNS reverse mapping](/configuration/dns#reverse_mapping) support
* Add `rewrite_ttl` DNS rule action * Add `rewrite_ttl` DNS rule action
@ -727,11 +727,11 @@ Important changes since 1.2:
*1*: *1*:
See [FAQ](/faq/fakeip) for more information. See [FAQ](/faq/fakeip/) for more information.
*2*: *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 #### 1.3-rc2
@ -793,7 +793,7 @@ Improved performance and reduced memory usage.
*1*: *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 #### 1.2.6
@ -845,25 +845,25 @@ This is an incompatible update for XUDP in VLESS if vision flow is enabled.
#### 1.3-beta1 #### 1.3-beta1
* Add [DNS reverse mapping](/configuration/dns#reverse_mapping) support * 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 `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 `store_fakeip` Clash API option
* Add multi-peer support for [WireGuard](/configuration/outbound/wireguard#peers) outbound * Add multi-peer support for [WireGuard](/configuration/outbound/wireguard#peers) outbound
* Add loopback detect * Add loopback detect
*1*: *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. at the IP layer.
*2*: *2*:
See [FAQ](/faq/fakeip) for more information. See [FAQ](/faq/fakeip/) for more information.
#### 1.2.3 #### 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 * Improve UDP domain destination NAT
* Update reality protocol * Update reality protocol
* Fix TTL calculation for DNS response * Fix TTL calculation for DNS response
@ -892,16 +892,16 @@ to `domain` rule.
Important changes since 1.1: Important changes since 1.1:
* Introducing our [new iOS client application](/installation/clients/sfi) * Introducing our [new iOS client application](/installation/clients/sfi/)
* Introducing [UDP over TCP protocol version 2](/configuration/shared/udp-over-tcp) * Introducing [UDP over TCP protocol version 2](/configuration/shared/udp-over-tcp/)
* Add [platform options](/configuration/inbound/tun#platform) for tun inbound * 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 [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 [VLESS server](/configuration/inbound/vless/) and [vision](/configuration/outbound/vless#flow) support
* Add [reality TLS](/configuration/shared/tls) support * Add [reality TLS](/configuration/shared/tls/) support
* Add [NTP service](/configuration/ntp) * Add [NTP service](/configuration/ntp/)
* Add [DHCP DNS server](/configuration/dns/server) support * Add [DHCP DNS server](/configuration/dns/server/) support
* Add SSH [host key validation](/configuration/outbound/ssh) support * Add SSH [host key validation](/configuration/outbound/ssh/) support
* Add [query_type](/configuration/dns/rule) DNS rule item * Add [query_type](/configuration/dns/rule/) DNS rule item
* Add fallback support for v2ray transport * Add fallback support for v2ray transport
* Add custom TLS server support for http based v2ray transports * Add custom TLS server support for http based v2ray transports
* Add health check support for http-based v2ray transports * Add health check support for http-based v2ray transports
@ -932,7 +932,7 @@ name.
#### 1.2-beta9 #### 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 * Add health check support for http-based v2ray transports
* Remove length limit on short_id for reality TLS config * Remove length limit on short_id for reality TLS config
* Fix bugs and update dependencies * Fix bugs and update dependencies
@ -949,7 +949,7 @@ name.
#### 1.2-beta6 #### 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 [platform options](/configuration/inbound/tun#platform) for tun inbound
* Add custom TLS server support for http based v2ray transports * Add custom TLS server support for http based v2ray transports
* Add generate commands * Add generate commands
@ -962,8 +962,8 @@ name.
#### 1.2-beta5 #### 1.2-beta5
* Add [VLESS server](/configuration/inbound/vless) and [vision](/configuration/outbound/vless#flow) support * Add [VLESS server](/configuration/inbound/vless/) and [vision](/configuration/outbound/vless#flow) support
* Add [reality TLS](/configuration/shared/tls) support * Add [reality TLS](/configuration/shared/tls/) support
* Fix match private address * Fix match private address
#### 1.1.6 #### 1.1.6
@ -978,7 +978,7 @@ name.
#### 1.2-beta4 #### 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 Add multiple server names and multi-user support for shadowtls
* Add strict mode support for shadowtls v3 * Add strict mode support for shadowtls v3
* Add uTLS support for shadowtls v3 * Add uTLS support for shadowtls v3
@ -998,9 +998,9 @@ name.
#### 1.2-beta1 #### 1.2-beta1
* Add [DHCP DNS server](/configuration/dns/server) support * Add [DHCP DNS server](/configuration/dns/server/) support
* Add SSH [host key validation](/configuration/outbound/ssh) support * Add SSH [host key validation](/configuration/outbound/ssh/) support
* Add [query_type](/configuration/dns/rule) DNS rule item * Add [query_type](/configuration/dns/rule/) DNS rule item
* Add v2ray [user stats](/configuration/experimental#statsusers) api * Add v2ray [user stats](/configuration/experimental#statsusers) api
* Add new clash DNS query api * Add new clash DNS query api
* Improve vmess request * Improve vmess request
@ -1229,7 +1229,7 @@ and [ShadowTLS outbound](/configuration/outbound/shadowtls#version)
#### 1.1-beta6 #### 1.1-beta6
* Add [URLTest outbound](/configuration/outbound/urltest) * Add [URLTest outbound](/configuration/outbound/urltest/)
* Fix bugs in 1.1-beta5 * Fix bugs in 1.1-beta5
#### 1.1-beta5 #### 1.1-beta5
@ -1261,8 +1261,8 @@ The default tun stack is changed to system.
#### 1.1-beta4 #### 1.1-beta4
* Add internal simple-obfs and v2ray-plugin [Shadowsocks plugins](/configuration/outbound/shadowsocks#plugin) * Add internal simple-obfs and v2ray-plugin [Shadowsocks plugins](/configuration/outbound/shadowsocks#plugin)
* Add [ShadowsocksR outbound](/configuration/outbound/shadowsocksr) * Add [ShadowsocksR outbound](/configuration/outbound/shadowsocksr/)
* Add [VLESS outbound and XUDP](/configuration/outbound/vless) * Add [VLESS outbound and XUDP](/configuration/outbound/vless/)
* Skip wait for hysteria tcp handshake response * Skip wait for hysteria tcp handshake response
* Fix socks4 client * Fix socks4 client
* Fix hysteria inbound * Fix hysteria inbound
@ -1289,7 +1289,7 @@ The default tun stack is changed to system.
*1*: *1*:
Switching modes using the Clash API, and `store-selected` are now supported, Switching modes using the Clash API, and `store-selected` are now supported,
see [Experimental](/configuration/experimental). see [Experimental](/configuration/experimental/).
*2*: *2*:
@ -1370,15 +1370,15 @@ and [Listen Fields](/configuration/shared/listen#udp_fragment).
* Fix write trojan udp * Fix write trojan udp
* Fix DNS routing * Fix DNS routing
* Add attribute support for geosite * Add attribute support for geosite
* Update documentation for [Dial Fields](/configuration/shared/dial) * Update documentation for [Dial Fields](/configuration/shared/dial/)
#### 1.0-beta3 #### 1.0-beta3
* Add [chained inbound](/configuration/shared/listen#detour) support * Add [chained inbound](/configuration/shared/listen#detour) support
* Add process_path rule item * Add process_path rule item
* Add macOS redirect support * Add macOS redirect support
* Add ShadowTLS [Inbound](/configuration/inbound/shadowtls), [Outbound](/configuration/outbound/shadowtls) * Add ShadowTLS [Inbound](/configuration/inbound/shadowtls/), [Outbound](/configuration/outbound/shadowtls/)
and [Examples](/examples/shadowtls) and [Examples](/examples/shadowtls/)
* Fix search android package in non-owner users * Fix search android package in non-owner users
* Fix socksaddr type condition * Fix socksaddr type condition
* Fix smux session status * Fix smux session status
@ -1422,7 +1422,7 @@ and [Listen Fields](/configuration/shared/listen#udp_fragment).
##### 2022/08/23 ##### 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) * Allow plain http request in Naive inbound (It can now be used with nginx)
* Add proxy protocol support * Add proxy protocol support
* Free memory after start * Free memory after start
@ -1431,13 +1431,13 @@ and [Listen Fields](/configuration/shared/listen#udp_fragment).
##### 2022/08/22 ##### 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 * Add bind address to outbound options
##### 2022/08/21 ##### 2022/08/21
* Add [Tor outbound](/configuration/outbound/tor) * Add [Tor outbound](/configuration/outbound/tor/)
* Add [SSH outbound](/configuration/outbound/ssh) * Add [SSH outbound](/configuration/outbound/ssh/)
##### 2022/08/20 ##### 2022/08/20
@ -1451,8 +1451,8 @@ and [Listen Fields](/configuration/shared/listen#udp_fragment).
##### 2022/08/19 ##### 2022/08/19
* Add Hysteria [Inbound](/configuration/inbound/hysteria) and [Outbund](/configuration/outbound/hysteria) * Add Hysteria [Inbound](/configuration/inbound/hysteria/) and [Outbund](/configuration/outbound/hysteria/)
* Add [ACME TLS certificate issuer](/configuration/shared/tls) * Add [ACME TLS certificate issuer](/configuration/shared/tls/)
* Allow read config from stdin (-c stdin) * Allow read config from stdin (-c stdin)
* Update gVisor to 20220815.0 * Update gVisor to 20220815.0
@ -1470,11 +1470,11 @@ and [Listen Fields](/configuration/shared/listen#udp_fragment).
##### 2022/08/16 ##### 2022/08/16
* Add ip_version (route/dns) rule item * Add ip_version (route/dns) rule item
* Add [WireGuard](/configuration/outbound/wireguard) outbound * Add [WireGuard](/configuration/outbound/wireguard/) outbound
##### 2022/08/15 ##### 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 ##### 2022/08/13
@ -1483,15 +1483,15 @@ and [Listen Fields](/configuration/shared/listen#udp_fragment).
##### 2022/08/12 ##### 2022/08/12
* Performance improvements * Performance improvements
* Add UoT option for [SOCKS](/configuration/outbound/socks) outbound * Add UoT option for [SOCKS](/configuration/outbound/socks/) outbound
##### 2022/08/11 ##### 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 ##### 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 * Fix default dns server option [#9] by iKirby
##### 2022/08/09 ##### 2022/08/09

10
docs/clients/index.md
View file

@ -2,11 +2,11 @@
Maintained by Project S to provide a unified experience and platform-specific functionality. Maintained by Project S to provide a unified experience and platform-specific functionality.
| Platform | Client | | Platform | Client |
|---------------------------------------|-----------------------------------------| |---------------------------------------|------------------------------------------|
| :material-android: Android | [sing-box for Android](./android) | | :material-android: Android | [sing-box for Android](./android/) |
| :material-apple: iOS/macOS/Apple tvOS | [sing-box for Apple platforms](./apple) | | :material-apple: iOS/macOS/Apple tvOS | [sing-box for Apple platforms](./apple/) |
| :material-laptop: Desktop | Working in progress | | :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 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 motivation of the maintainers of such projects is to acquire more users, and even though they provide friendly VPN

4
docs/clients/index.zh.md
View file

@ -4,8 +4,8 @@
| 平台 | 客户端 | | 平台 | 客户端 |
|---------------------------------------|-----------------------------------------| |---------------------------------------|-----------------------------------------|
| :material-android: Android | [sing-box for Android](./android) | | :material-android: Android | [sing-box for Android](./android/) |
| :material-apple: iOS/macOS/Apple tvOS | [sing-box for Apple platforms](./apple) | | :material-apple: iOS/macOS/Apple tvOS | [sing-box for Apple platforms](./apple/) |
| :material-laptop: Desktop | 施工中 | | :material-laptop: Desktop | 施工中 |
此处没有列出一些声称使用或以 sing-box 为卖点的第三方项目。此类项目维护者的动机是获得更多用户，即使它们提供友好的商业 此处没有列出一些声称使用或以 sing-box 为卖点的第三方项目。此类项目维护者的动机是获得更多用户，即使它们提供友好的商业

8
docs/configuration/dns/index.md
View file

@ -23,9 +23,9 @@
| Key | Format | | Key | Format |
|----------|--------------------------------| |----------|--------------------------------|
| `server` | List of [DNS Server](./server) | | `server` | List of [DNS Server](./server/) |
| `rules` | List of [DNS Rule](./rule) | | `rules` | List of [DNS Rule](./rule/) |
| `fakeip` | [FakeIP](./fakeip) | | `fakeip` | [FakeIP](./fakeip/) |
#### final #### final
@ -62,4 +62,4 @@ problematic in environments such as macOS, where DNS is proxied and cached by th
#### fakeip #### fakeip
[FakeIP](./fakeip) settings. [FakeIP](./fakeip/) settings.

10
docs/configuration/dns/index.zh.md
View file

@ -21,10 +21,10 @@
### 字段 ### 字段
| 键 | 格式 | | 键 | 格式 |
|----------|------------------------| |----------|-------------------------|
| `server` | 一组 [DNS 服务器](./server) | | `server` | 一组 [DNS 服务器](./server/) |
| `rules` | 一组 [DNS 规则](./rule) | | `rules` | 一组 [DNS 规则](./rule/) |
#### final #### final
@ -60,4 +60,4 @@
#### fakeip #### fakeip
[FakeIP](./fakeip) 设置。 [FakeIP](./fakeip/) 设置。

2
docs/configuration/dns/rule.md
View file

@ -124,7 +124,7 @@
#### inbound #### inbound
Tags of [Inbound](/configuration/inbound). Tags of [Inbound](/configuration/inbound/).
#### ip_version #### ip_version

2
docs/configuration/dns/rule.zh.md
View file

@ -121,7 +121,7 @@
#### inbound #### inbound
[入站](/zh/configuration/inbound) 标签. [入站](/zh/configuration/inbound/) 标签.
#### ip_version #### ip_version

24
docs/configuration/dns/server.md
View file

@ -30,18 +30,18 @@ The tag of the dns server.
The address of the dns server. The address of the dns server.
| Protocol | Format | | Protocol | Format |
|-------------------------------------|-------------------------------| |--------------------------------------|-------------------------------|
| `System` | `local` | | `System` | `local` |
| `TCP` | `tcp://1.0.0.1` | | `TCP` | `tcp://1.0.0.1` |
| `UDP` | `8.8.8.8` `udp://8.8.4.4` | | `UDP` | `8.8.8.8` `udp://8.8.4.4` |
| `TLS` | `tls://dns.google` | | `TLS` | `tls://dns.google` |
| `HTTPS` | `https://1.1.1.1/dns-query` | | `HTTPS` | `https://1.1.1.1/dns-query` |
| `QUIC` | `quic://dns.adguard.com` | | `QUIC` | `quic://dns.adguard.com` |
| `HTTP3` | `h3://8.8.8.8/dns-query` | | `HTTP3` | `h3://8.8.8.8/dns-query` |
| `RCode` | `rcode://refused` | | `RCode` | `rcode://refused` |
| `DHCP` | `dhcp://auto` or `dhcp://en0` | | `DHCP` | `dhcp://auto` or `dhcp://en0` |
| [FakeIP](/configuration/dns/fakeip) | `fakeip` | | [FakeIP](/configuration/dns/fakeip/) | `fakeip` |
!!! warning "" !!! warning ""

24
docs/configuration/dns/server.zh.md
View file

@ -30,18 +30,18 @@ DNS 服务器的标签。
DNS 服务器的地址。 DNS 服务器的地址。
| 协议 | 格式 | | 协议 | 格式 |
|-------------------------------------|------------------------------| |--------------------------------------|------------------------------|
| `System` | `local` | | `System` | `local` |
| `TCP` | `tcp://1.0.0.1` | | `TCP` | `tcp://1.0.0.1` |
| `UDP` | `8.8.8.8` `udp://8.8.4.4` | | `UDP` | `8.8.8.8` `udp://8.8.4.4` |
| `TLS` | `tls://dns.google` | | `TLS` | `tls://dns.google` |
| `HTTPS` | `https://1.1.1.1/dns-query` | | `HTTPS` | `https://1.1.1.1/dns-query` |
| `QUIC` | `quic://dns.adguard.com` | | `QUIC` | `quic://dns.adguard.com` |
| `HTTP3` | `h3://8.8.8.8/dns-query` | | `HTTP3` | `h3://8.8.8.8/dns-query` |
| `RCode` | `rcode://refused` | | `RCode` | `rcode://refused` |
| `DHCP` | `dhcp://auto` 或 `dhcp://en0` | | `DHCP` | `dhcp://auto` 或 `dhcp://en0` |
| [FakeIP](/configuration/dns/fakeip) | `fakeip` | | [FakeIP](/configuration/dns/fakeip/) | `fakeip` |
!!! warning "" !!! warning ""

2
docs/configuration/inbound/direct.md
View file

@ -17,7 +17,7 @@
### Listen Fields ### Listen Fields
See [Listen Fields](/configuration/shared/listen) for details. See [Listen Fields](/configuration/shared/listen/) for details.
### Fields ### Fields

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

@ -20,7 +20,7 @@
### Listen Fields ### Listen Fields
See [Listen Fields](/configuration/shared/listen) for details. See [Listen Fields](/configuration/shared/listen/) for details.
### Fields ### Fields

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

@ -35,7 +35,7 @@
### Listen Fields ### Listen Fields
See [Listen Fields](/configuration/shared/listen) for details. See [Listen Fields](/configuration/shared/listen/) for details.
### Fields ### Fields

2
docs/configuration/inbound/hysteria2.md
View file

@ -39,7 +39,7 @@
### Listen Fields ### Listen Fields
See [Listen Fields](/configuration/shared/listen) for details. See [Listen Fields](/configuration/shared/listen/) for details.
### Fields ### Fields

36
docs/configuration/inbound/index.md
View file

@ -15,24 +15,24 @@
### Fields ### Fields
| Type | Format | Injectable | | Type | Format | Injectable |
|---------------|------------------------------|------------| |---------------|-------------------------------|------------|
| `direct` | [Direct](./direct) | X | | `direct` | [Direct](./direct/) | X |
| `mixed` | [Mixed](./mixed) | TCP | | `mixed` | [Mixed](./mixed/) | TCP |
| `socks` | [SOCKS](./socks) | TCP | | `socks` | [SOCKS](./socks/) | TCP |
| `http` | [HTTP](./http) | TCP | | `http` | [HTTP](./http/) | TCP |
| `shadowsocks` | [Shadowsocks](./shadowsocks) | TCP | | `shadowsocks` | [Shadowsocks](./shadowsocks/) | TCP |
| `vmess` | [VMess](./vmess) | TCP | | `vmess` | [VMess](./vmess/) | TCP |
| `trojan` | [Trojan](./trojan) | TCP | | `trojan` | [Trojan](./trojan/) | TCP |
| `naive` | [Naive](./naive) | X | | `naive` | [Naive](./naive/) | X |
| `hysteria` | [Hysteria](./hysteria) | X | | `hysteria` | [Hysteria](./hysteria/) | X |
| `shadowtls` | [ShadowTLS](./shadowtls) | TCP | | `shadowtls` | [ShadowTLS](./shadowtls/) | TCP |
| `tuic` | [TUIC](./tuic) | X | | `tuic` | [TUIC](./tuic/) | X |
| `hysteria2` | [Hysteria2](./hysteria2) | X | | `hysteria2` | [Hysteria2](./hysteria2/) | X |
| `vless` | [VLESS](./vless) | TCP | | `vless` | [VLESS](./vless/) | TCP |
| `tun` | [Tun](./tun) | X | | `tun` | [Tun](./tun/) | X |
| `redirect` | [Redirect](./redirect) | X | | `redirect` | [Redirect](./redirect/) | X |
| `tproxy` | [TProxy](./tproxy) | X | | `tproxy` | [TProxy](./tproxy/) | X |
#### tag #### tag

32
docs/configuration/inbound/index.zh.md
View file

@ -17,22 +17,22 @@
| 类型 | 格式 | 注入支持 | | 类型 | 格式 | 注入支持 |
|---------------|------------------------------|------| |---------------|------------------------------|------|
| `direct` | [Direct](./direct) | X | | `direct` | [Direct](./direct/) | X |
| `mixed` | [Mixed](./mixed) | TCP | | `mixed` | [Mixed](./mixed/) | TCP |
| `socks` | [SOCKS](./socks) | TCP | | `socks` | [SOCKS](./socks/) | TCP |
| `http` | [HTTP](./http) | TCP | | `http` | [HTTP](./http/) | TCP |
| `shadowsocks` | [Shadowsocks](./shadowsocks) | TCP | | `shadowsocks` | [Shadowsocks](./shadowsocks/) | TCP |
| `vmess` | [VMess](./vmess) | TCP | | `vmess` | [VMess](./vmess/) | TCP |
| `trojan` | [Trojan](./trojan) | TCP | | `trojan` | [Trojan](./trojan/) | TCP |
| `naive` | [Naive](./naive) | X | | `naive` | [Naive](./naive/) | X |
| `hysteria` | [Hysteria](./hysteria) | X | | `hysteria` | [Hysteria](./hysteria/) | X |
| `shadowtls` | [ShadowTLS](./shadowtls) | TCP | | `shadowtls` | [ShadowTLS](./shadowtls/) | TCP |
| `tuic` | [TUIC](./tuic) | X | | `tuic` | [TUIC](./tuic/) | X |
| `hysteria2` | [Hysteria2](./hysteria2) | X | | `hysteria2` | [Hysteria2](./hysteria2/) | X |
| `vless` | [VLESS](./vless) | TCP | | `vless` | [VLESS](./vless/) | TCP |
| `tun` | [Tun](./tun) | X | | `tun` | [Tun](./tun/) | X |
| `redirect` | [Redirect](./redirect) | X | | `redirect` | [Redirect](./redirect/) | X |
| `tproxy` | [TProxy](./tproxy) | X | | `tproxy` | [TProxy](./tproxy/) | X |
#### tag #### tag

2
docs/configuration/inbound/mixed.md
View file

@ -21,7 +21,7 @@
### Listen Fields ### Listen Fields
See [Listen Fields](/configuration/shared/listen) for details. See [Listen Fields](/configuration/shared/listen/) for details.
### Fields ### Fields

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

@ -24,7 +24,7 @@
### Listen Fields ### Listen Fields
See [Listen Fields](/configuration/shared/listen) for details. See [Listen Fields](/configuration/shared/listen/) for details.
### Fields ### Fields

2
docs/configuration/inbound/redirect.md
View file

@ -15,4 +15,4 @@
### Listen Fields ### Listen Fields
See [Listen Fields](/configuration/shared/listen) for details. See [Listen Fields](/configuration/shared/listen/) for details.

2
docs/configuration/inbound/shadowsocks.md
View file

@ -50,7 +50,7 @@
### Listen Fields ### Listen Fields
See [Listen Fields](/configuration/shared/listen) for details. See [Listen Fields](/configuration/shared/listen/) for details.
### Fields ### Fields

2
docs/configuration/inbound/shadowsocks.zh.md
View file

@ -50,7 +50,7 @@
### Listen Fields ### Listen Fields
See [Listen Fields](/configuration/shared/listen) for details. See [Listen Fields](/configuration/shared/listen/) for details.
### 字段 ### 字段

6
docs/configuration/inbound/shadowtls.md
View file

@ -35,7 +35,7 @@
### Listen Fields ### Listen Fields
See [Listen Fields](/configuration/shared/listen) for details. See [Listen Fields](/configuration/shared/listen/) for details.
### Fields ### Fields
@ -66,11 +66,11 @@ Only available in the ShadowTLS protocol 3.
==Required== ==Required==
Handshake server address and [Dial options](/configuration/shared/dial). Handshake server address and [Dial options](/configuration/shared/dial/).
#### handshake_for_server_name #### 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. Only available in the ShadowTLS protocol 2/3.

2
docs/configuration/inbound/socks.md
View file

@ -20,7 +20,7 @@
### Listen Fields ### Listen Fields
See [Listen Fields](/configuration/shared/listen) for details. See [Listen Fields](/configuration/shared/listen/) for details.
### Fields ### Fields

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

@ -17,7 +17,7 @@
### Listen Fields ### Listen Fields
See [Listen Fields](/configuration/shared/listen) for details. See [Listen Fields](/configuration/shared/listen/) for details.
### Fields ### Fields

4
docs/configuration/inbound/trojan.md
View file

@ -31,7 +31,7 @@
### Listen Fields ### Listen Fields
See [Listen Fields](/configuration/shared/listen) for details. See [Listen Fields](/configuration/shared/listen/) for details.
### Fields ### Fields
@ -65,4 +65,4 @@ See [Multiplex](/configuration/shared/multiplex#inbound) for details.
#### transport #### transport
V2Ray Transport configuration, see [V2Ray Transport](/configuration/shared/v2ray-transport). V2Ray Transport configuration, see [V2Ray Transport](/configuration/shared/v2ray-transport/).

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

@ -67,4 +67,4 @@ TLS 配置, 参阅 [TLS](/zh/configuration/shared/tls/#inbound)。
#### transport #### transport
V2Ray 传输配置，参阅 [V2Ray 传输层](/zh/configuration/shared/v2ray-transport)。 V2Ray 传输配置，参阅 [V2Ray 传输层](/zh/configuration/shared/v2ray-transport/)。

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

@ -28,7 +28,7 @@
### Listen Fields ### Listen Fields
See [Listen Fields](/configuration/shared/listen) for details. See [Listen Fields](/configuration/shared/listen/) for details.
### Fields ### Fields

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

@ -241,4 +241,4 @@ System HTTP proxy settings.
### Listen Fields ### Listen Fields
See [Listen Fields](/configuration/shared/listen) for details. See [Listen Fields](/configuration/shared/listen/) for details.

4
docs/configuration/inbound/vless.md
View file

@ -22,7 +22,7 @@
### Listen Fields ### Listen Fields
See [Listen Fields](/configuration/shared/listen) for details. See [Listen Fields](/configuration/shared/listen/) for details.
### Fields ### Fields
@ -56,4 +56,4 @@ See [Multiplex](/configuration/shared/multiplex#inbound) for details.
#### transport #### transport
V2Ray Transport configuration, see [V2Ray Transport](/configuration/shared/v2ray-transport). V2Ray Transport configuration, see [V2Ray Transport](/configuration/shared/v2ray-transport/).

2
docs/configuration/inbound/vless.zh.md
View file

@ -56,4 +56,4 @@ TLS 配置, 参阅 [TLS](/zh/configuration/shared/tls/#inbound)。
#### transport #### transport
V2Ray 传输配置，参阅 [V2Ray 传输层](/zh/configuration/shared/v2ray-transport)。 V2Ray 传输配置，参阅 [V2Ray 传输层](/zh/configuration/shared/v2ray-transport/)。

4
docs/configuration/inbound/vmess.md
View file

@ -22,7 +22,7 @@
### Listen Fields ### Listen Fields
See [Listen Fields](/configuration/shared/listen) for details. See [Listen Fields](/configuration/shared/listen/) for details.
### Fields ### Fields
@ -51,4 +51,4 @@ See [Multiplex](/configuration/shared/multiplex#inbound) for details.
#### transport #### transport
V2Ray Transport configuration, see [V2Ray Transport](/configuration/shared/v2ray-transport). V2Ray Transport configuration, see [V2Ray Transport](/configuration/shared/v2ray-transport/).

2
docs/configuration/inbound/vmess.zh.md
View file

@ -51,4 +51,4 @@ TLS 配置, 参阅 [TLS](/zh/configuration/shared/tls/#inbound)。
#### transport #### transport
V2Ray 传输配置，参阅 [V2Ray 传输层](/zh/configuration/shared/v2ray-transport)。 V2Ray 传输配置，参阅 [V2Ray 传输层](/zh/configuration/shared/v2ray-transport/)。

18
docs/configuration/index.md
View file

@ -18,15 +18,15 @@ sing-box uses JSON for configuration files.
### Fields ### Fields
| Key | Format | | Key | Format |
|----------------|--------------------------------| |----------------|---------------------------------|
| `log` | [Log](./log) | | `log` | [Log](./log/) |
| `dns` | [DNS](./dns) | | `dns` | [DNS](./dns/) |
| `ntp` | [NTP](./ntp) | | `ntp` | [NTP](./ntp/) |
| `inbounds` | [Inbound](./inbound) | | `inbounds` | [Inbound](./inbound/) |
| `outbounds` | [Outbound](./outbound) | | `outbounds` | [Outbound](./outbound/) |
| `route` | [Route](./route) | | `route` | [Route](./route/) |
| `experimental` | [Experimental](./experimental) | | `experimental` | [Experimental](./experimental/) |
### Check ### Check

16
docs/configuration/index.zh.md
View file

@ -17,14 +17,14 @@ sing-box 使用 JSON 作为配置文件格式。
### 字段 ### 字段
| Key | Format | | Key | Format |
|----------------|-----------------------| |----------------|------------------------|
| `log` | [日志](./log) | | `log` | [日志](./log/) |
| `dns` | [DNS](./dns) | | `dns` | [DNS](./dns/) |
| `inbounds` | [入站](./inbound) | | `inbounds` | [入站](./inbound/) |
| `outbounds` | [出站](./outbound) | | `outbounds` | [出站](./outbound/) |
| `route` | [路由](./route) | | `route` | [路由](./route/) |
| `experimental` | [实验性](./experimental) | | `experimental` | [实验性](./experimental/) |
### 检查 ### 检查

2
docs/configuration/ntp/index.md
View file

@ -47,4 +47,4 @@ Time synchronization interval.
### Dial Fields ### Dial Fields
See [Dial Fields](/configuration/shared/dial) for details. See [Dial Fields](/configuration/shared/dial/) for details.

2
docs/configuration/outbound/direct.md
View file

@ -33,4 +33,4 @@ Protocol value can be `1` or `2`.
### Dial Fields ### Dial Fields
See [Dial Fields](/configuration/shared/dial) for details. See [Dial Fields](/configuration/shared/dial/) for details.

2
docs/configuration/outbound/http.md
View file

@ -55,4 +55,4 @@ TLS configuration, see [TLS](/configuration/shared/tls/#outbound).
### Dial Fields ### Dial Fields
See [Dial Fields](/configuration/shared/dial) for details. See [Dial Fields](/configuration/shared/dial/) for details.

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

@ -113,4 +113,4 @@ TLS configuration, see [TLS](/configuration/shared/tls/#outbound).
### Dial Fields ### Dial Fields
See [Dial Fields](/configuration/shared/dial) for details. See [Dial Fields](/configuration/shared/dial/) for details.

2
docs/configuration/outbound/hysteria2.md
View file

@ -88,4 +88,4 @@ Enable debug information logging for Hysteria Brutal CC.
### Dial Fields ### Dial Fields
See [Dial Fields](/configuration/shared/dial) for details. See [Dial Fields](/configuration/shared/dial/) for details.

42
docs/configuration/outbound/index.md
View file

@ -15,27 +15,27 @@
### Fields ### Fields
| Type | Format | | Type | Format |
|----------------|--------------------------------| |----------------|---------------------------------|
| `direct` | [Direct](./direct) | | `direct` | [Direct](./direct/) |
| `block` | [Block](./block) | | `block` | [Block](./block/) |
| `socks` | [SOCKS](./socks) | | `socks` | [SOCKS](./socks/) |
| `http` | [HTTP](./http) | | `http` | [HTTP](./http/) |
| `shadowsocks` | [Shadowsocks](./shadowsocks) | | `shadowsocks` | [Shadowsocks](./shadowsocks/) |
| `vmess` | [VMess](./vmess) | | `vmess` | [VMess](./vmess/) |
| `trojan` | [Trojan](./trojan) | | `trojan` | [Trojan](./trojan/) |
| `wireguard` | [Wireguard](./wireguard) | | `wireguard` | [Wireguard](./wireguard/) |
| `hysteria` | [Hysteria](./hysteria) | | `hysteria` | [Hysteria](./hysteria/) |
| `shadowsocksr` | [ShadowsocksR](./shadowsocksr) | | `shadowsocksr` | [ShadowsocksR](./shadowsocksr/) |
| `vless` | [VLESS](./vless) | | `vless` | [VLESS](./vless/) |
| `shadowtls` | [ShadowTLS](./shadowtls) | | `shadowtls` | [ShadowTLS](./shadowtls/) |
| `tuic` | [TUIC](./tuic) | | `tuic` | [TUIC](./tuic/) |
| `hysteria2` | [Hysteria2](./hysteria2) | | `hysteria2` | [Hysteria2](./hysteria2/) |
| `tor` | [Tor](./tor) | | `tor` | [Tor](./tor/) |
| `ssh` | [SSH](./ssh) | | `ssh` | [SSH](./ssh/) |
| `dns` | [DNS](./dns) | | `dns` | [DNS](./dns/) |
| `selector` | [Selector](./selector) | | `selector` | [Selector](./selector/) |
| `urltest` | [URLTest](./urltest) | | `urltest` | [URLTest](./urltest/) |
#### tag #### tag

42
docs/configuration/outbound/index.zh.md
View file

@ -15,27 +15,27 @@
### 字段 ### 字段
| 类型 | 格式 | | 类型 | 格式 |
|----------------|--------------------------------| |----------------|---------------------------------|
| `direct` | [Direct](./direct) | | `direct` | [Direct](./direct/) |
| `block` | [Block](./block) | | `block` | [Block](./block/) |
| `socks` | [SOCKS](./socks) | | `socks` | [SOCKS](./socks/) |
| `http` | [HTTP](./http) | | `http` | [HTTP](./http/) |
| `shadowsocks` | [Shadowsocks](./shadowsocks) | | `shadowsocks` | [Shadowsocks](./shadowsocks/) |
| `vmess` | [VMess](./vmess) | | `vmess` | [VMess](./vmess/) |
| `trojan` | [Trojan](./trojan) | | `trojan` | [Trojan](./trojan/) |
| `wireguard` | [Wireguard](./wireguard) | | `wireguard` | [Wireguard](./wireguard/) |
| `hysteria` | [Hysteria](./hysteria) | | `hysteria` | [Hysteria](./hysteria/) |
| `shadowsocksr` | [ShadowsocksR](./shadowsocksr) | | `shadowsocksr` | [ShadowsocksR](./shadowsocksr/) |
| `vless` | [VLESS](./vless) | | `vless` | [VLESS](./vless/) |
| `shadowtls` | [ShadowTLS](./shadowtls) | | `shadowtls` | [ShadowTLS](./shadowtls/) |
| `tuic` | [TUIC](./tuic) | | `tuic` | [TUIC](./tuic/) |
| `hysteria2` | [Hysteria2](./hysteria2) | | `hysteria2` | [Hysteria2](./hysteria2/) |
| `tor` | [Tor](./tor) | | `tor` | [Tor](./tor/) |
| `ssh` | [SSH](./ssh) | | `ssh` | [SSH](./ssh/) |
| `dns` | [DNS](./dns) | | `dns` | [DNS](./dns/) |
| `selector` | [Selector](./selector) | | `selector` | [Selector](./selector/) |
| `urltest` | [URLTest](./urltest) | | `urltest` | [URLTest](./urltest/) |
#### tag #### tag

4
docs/configuration/outbound/shadowsocks.md
View file

@ -89,7 +89,7 @@ Both is enabled by default.
UDP over TCP configuration. 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`. Conflict with `multiplex`.
@ -99,4 +99,4 @@ See [Multiplex](/configuration/shared/multiplex#outbound) for details.
### Dial Fields ### Dial Fields
See [Dial Fields](/configuration/shared/dial) for details. See [Dial Fields](/configuration/shared/dial/) for details.

2
docs/configuration/outbound/shadowsocks.zh.md
View file

@ -89,7 +89,7 @@ Shadowsocks SIP003 插件参数。
UDP over TCP 配置。 UDP over TCP 配置。
参阅 [UDP Over TCP](/zh/configuration/shared/udp-over-tcp)。 参阅 [UDP Over TCP](/zh/configuration/shared/udp-over-tcp/)。
与 `multiplex` 冲突。 与 `multiplex` 冲突。

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

@ -103,4 +103,4 @@ Both is enabled by default.
### Dial Fields ### Dial Fields
See [Dial Fields](/configuration/shared/dial) for details. See [Dial Fields](/configuration/shared/dial/) for details.

2
docs/configuration/outbound/shadowtls.md
View file

@ -53,4 +53,4 @@ TLS configuration, see [TLS](/configuration/shared/tls/#outbound).
### Dial Fields ### Dial Fields
See [Dial Fields](/configuration/shared/dial) for details. See [Dial Fields](/configuration/shared/dial/) for details.

4
docs/configuration/outbound/socks.md
View file

@ -59,8 +59,8 @@ Both is enabled by default.
UDP over TCP protocol settings. 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 ### Dial Fields
See [Dial Fields](/configuration/shared/dial) for details. See [Dial Fields](/configuration/shared/dial/) for details.

2
docs/configuration/outbound/socks.zh.md
View file

@ -59,7 +59,7 @@ SOCKS5 密码。
UDP over TCP 配置。 UDP over TCP 配置。
参阅 [UDP Over TCP](/zh/configuration/shared/udp-over-tcp)。 参阅 [UDP Over TCP](/zh/configuration/shared/udp-over-tcp/)。
### 拨号字段 ### 拨号字段

2
docs/configuration/outbound/ssh.md
View file

@ -68,4 +68,4 @@ Client version. Random version will be used if empty.
### Dial Fields ### Dial Fields
See [Dial Fields](/configuration/shared/dial) for details. See [Dial Fields](/configuration/shared/dial/) for details.

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

@ -48,4 +48,4 @@ See [tor(1)](https://linux.die.net/man/1/tor) for details.
### Dial Fields ### Dial Fields
See [Dial Fields](/configuration/shared/dial) for details. See [Dial Fields](/configuration/shared/dial/) for details.

4
docs/configuration/outbound/trojan.md
View file

@ -55,8 +55,8 @@ See [Multiplex](/configuration/shared/multiplex#outbound) for details.
#### transport #### transport
V2Ray Transport configuration, see [V2Ray Transport](/configuration/shared/v2ray-transport). V2Ray Transport configuration, see [V2Ray Transport](/configuration/shared/v2ray-transport/).
### Dial Fields ### Dial Fields
See [Dial Fields](/configuration/shared/dial) for details. See [Dial Fields](/configuration/shared/dial/) for details.

2
docs/configuration/outbound/trojan.zh.md
View file

@ -55,7 +55,7 @@ TLS 配置, 参阅 [TLS](/zh/configuration/shared/tls/#outbound)。
#### transport #### transport
V2Ray 传输配置，参阅 [V2Ray 传输层](/zh/configuration/shared/v2ray-transport)。 V2Ray 传输配置，参阅 [V2Ray 传输层](/zh/configuration/shared/v2ray-transport/)。
### 拨号字段 ### 拨号字段

4
docs/configuration/outbound/tuic.md
View file

@ -72,7 +72,7 @@ Conflict with `udp_over_stream`.
#### 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 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. another program compatible with the protocol as a server.
@ -97,4 +97,4 @@ TLS configuration, see [TLS](/configuration/shared/tls/#outbound).
### Dial Fields ### Dial Fields
See [Dial Fields](/configuration/shared/dial) for details. See [Dial Fields](/configuration/shared/dial/) for details.

2
docs/configuration/outbound/tuic.zh.md
View file

@ -70,7 +70,7 @@ UDP 包中继模式
#### udp_over_stream #### 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 流）。 此模式在正确的 UDP 代理场景中没有任何积极作用，仅适用于中继流式 UDP 流量（基本上是 QUIC 流）。

4
docs/configuration/outbound/vless.md
View file

@ -75,8 +75,8 @@ See [Multiplex](/configuration/shared/multiplex#outbound) for details.
#### transport #### transport
V2Ray Transport configuration, see [V2Ray Transport](/configuration/shared/v2ray-transport). V2Ray Transport configuration, see [V2Ray Transport](/configuration/shared/v2ray-transport/).
### Dial Fields ### Dial Fields
See [Dial Fields](/configuration/shared/dial) for details. See [Dial Fields](/configuration/shared/dial/) for details.

2
docs/configuration/outbound/vless.zh.md
View file

@ -75,7 +75,7 @@ UDP 包编码，默认使用 xudp。
#### transport #### transport
V2Ray 传输配置，参阅 [V2Ray 传输层](/zh/configuration/shared/v2ray-transport)。 V2Ray 传输配置，参阅 [V2Ray 传输层](/zh/configuration/shared/v2ray-transport/)。
### 拨号字段 ### 拨号字段

4
docs/configuration/outbound/vmess.md
View file

@ -100,8 +100,8 @@ See [Multiplex](/configuration/shared/multiplex#outbound) for details.
#### transport #### transport
V2Ray Transport configuration, see [V2Ray Transport](/configuration/shared/v2ray-transport). V2Ray Transport configuration, see [V2Ray Transport](/configuration/shared/v2ray-transport/).
### Dial Fields ### Dial Fields
See [Dial Fields](/configuration/shared/dial) for details. See [Dial Fields](/configuration/shared/dial/) for details.

2
docs/configuration/outbound/vmess.zh.md
View file

@ -100,7 +100,7 @@ UDP 包编码。
#### transport #### transport
V2Ray 传输配置，参阅 [V2Ray 传输层](/zh/configuration/shared/v2ray-transport)。 V2Ray 传输配置，参阅 [V2Ray 传输层](/zh/configuration/shared/v2ray-transport/)。
### 拨号字段 ### 拨号字段

2
docs/configuration/outbound/wireguard.md
View file

@ -139,4 +139,4 @@ Both is enabled by default.
### Dial Fields ### Dial Fields
See [Dial Fields](/configuration/shared/dial) for details. See [Dial Fields](/configuration/shared/dial/) for details.

10
docs/configuration/route/index.md
View file

@ -19,11 +19,11 @@
### Fields ### Fields
| Key | Format | | Key | Format |
|------------|------------------------------------| |-----------|-------------------------------|
| `geoip` | [GeoIP](./geoip) | | `geoip` | [GeoIP](./geoip/) |
| `geosite` | [Geosite](./geosite) | | `geosite` | [Geosite](./geosite/) |
| `rules` | List of [Route Rule](./rule) | | `rules` | List of [Route Rule](./rule/) |
#### final #### final

10
docs/configuration/route/index.zh.md
View file

@ -20,11 +20,11 @@
### 字段 ### 字段
| 键 | 格式 | | 键 | 格式 |
|------------|-------------------------| |-----------|-----------------------|
| `geoip` | [GeoIP](./geoip) | | `geoip` | [GeoIP](./geoip/) |
| `geosite` | [GeoSite](./geosite) | | `geosite` | [GeoSite](./geosite/) |
| `rules` | 一组 [路由规则](./rule) | | `rules` | 一组 [路由规则](./rule/) |
#### final #### final

2
docs/configuration/route/rule.md
View file

@ -122,7 +122,7 @@
#### inbound #### inbound
Tags of [Inbound](/configuration/inbound). Tags of [Inbound](/configuration/inbound/).
#### ip_version #### ip_version

2
docs/configuration/route/rule.zh.md
View file

@ -120,7 +120,7 @@
#### inbound #### inbound
[入站](/zh/configuration/inbound) 标签。 [入站](/zh/configuration/inbound/) 标签。
#### ip_version #### ip_version

4
docs/configuration/shared/multiplex.md
View file

@ -35,7 +35,7 @@ If enabled, non-padded connections will be rejected.
#### brutal #### brutal
See [TCP Brutal](/configuration/shared/tcp-brutal) for details. See [TCP Brutal](/configuration/shared/tcp-brutal/) for details.
### Outbound Fields ### Outbound Fields
@ -83,4 +83,4 @@ Enable padding.
#### brutal #### brutal
See [TCP Brutal](/configuration/shared/tcp-brutal) for details. See [TCP Brutal](/configuration/shared/tcp-brutal/) for details.

4
docs/configuration/shared/multiplex.zh.md
View file

@ -34,7 +34,7 @@
#### brutal #### brutal
参阅 [TCP Brutal](/zh/configuration/shared/tcp-brutal)。 参阅 [TCP Brutal](/zh/configuration/shared/tcp-brutal/)。
### 出站字段 ### 出站字段
@ -82,4 +82,4 @@
#### brutal #### brutal
参阅 [TCP Brutal](/zh/configuration/shared/tcp-brutal)。 参阅 [TCP Brutal](/zh/configuration/shared/tcp-brutal/)。

4
docs/configuration/shared/tls.md
View file

@ -353,7 +353,7 @@ The MAC key.
ACME DNS01 challenge field. If configured, other challenge methods will be disabled. 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 ### Reality Fields
@ -371,7 +371,7 @@ See [DNS01 Challenge Fields](/configuration/shared/dns01_challenge) for details.
==Required== ==Required==
Handshake server address and [Dial options](/configuration/shared/dial). Handshake server address and [Dial options](/configuration/shared/dial/).
#### private_key #### private_key

2
docs/configuration/shared/tls.zh.md
View file

@ -344,7 +344,7 @@ MAC 密钥。
ACME DNS01 验证字段。如果配置，将禁用其他验证方法。 ACME DNS01 验证字段。如果配置，将禁用其他验证方法。
参阅 [DNS01 验证字段](/configuration/shared/dns01_challenge)。 参阅 [DNS01 验证字段](/configuration/shared/dns01_challenge/)。
### Reality 字段 ### Reality 字段

30
docs/installation/build-from-source.md
View file

@ -43,21 +43,21 @@ go build -tags "tag_a tag_b" ./cmd/sing-box
## :material-folder-settings: Build Tags ## :material-folder-settings: Build Tags
| Build Tag | Enabled by default | Description | | 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_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_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_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_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_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_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_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_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_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_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_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_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). | | `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. It is not recommended to change the default build tag list unless you really know what you are adding.