chunyu/sing-box
1
0
Fork 0
mirror of https://github.com/SagerNet/sing-box.git synced 2025-06-13 21:54:13 +08:00
Code Issues Packages Projects Releases Wiki Activity

documentation: Bump version & Refactor docs

Browse Source
This commit is contained in:
世界 2023-11-09 17:04:08 +08:00 committed by Kyōchikutō | キョウチクトウ
parent 0acfd6a1c6
commit 6fab7c0c83
No known key found for this signature in database
GPG Key ID: A98846921CD44363
8 changed files with 75 additions and 203 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

56
docs/changelog.md
View File

@ -4,62 +4,6 @@ icon: material/alert-decagram
# ChangeLog # ChangeLog
#### 1.7.0
* Fixes and improvements
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 [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**
* Add `wifi_ssid` and `wifi_bssid` route and DNS rules **5**
* Update quic-go to v0.40.0
* Update gVisor to 20231113.0
**1**:
If enabled, for UDP proxy requests addressed to a domain,
the original packet address will be sent in the response instead of the mapped domain.
This option is used for compatibility with clients that
do not support receiving UDP packets with domain addresses, such as Surge.
**2**:
Introduced in V2Ray 5.10.0.
The new HTTPUpgrade transport has better performance than WebSocket and is better suited for CDN abuse.
**3**:
Starting in 1.7.0, multiplexing support is no longer enabled by default 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.
**5**:
Only supported in graphical clients on Android and iOS.
#### 1.7.0-rc.3
* Fixes and improvements
#### 1.6.7
* macOS: Add button for uninstall SystemExtension in the standalone graphical client
* Fix missing UDP user context on TUIC/Hysteria2 inbounds
* Fixes and improvements
#### 1.7.0-rc.2
* Fix missing UDP user context on TUIC/Hysteria2 inbounds
* macOS: Add button for uninstall SystemExtension in the standalone graphical client
#### 1.6.6 #### 1.6.6
* Fixes and improvements * Fixes and improvements

4
docs/clients/android/index.md
View File

@ -15,8 +15,8 @@ platform-specific function implementation, such as TUN transparent proxy impleme
* [Play Store](https://play.google.com/store/apps/details?id=io.nekohasekai.sfa) * [Play Store](https://play.google.com/store/apps/details?id=io.nekohasekai.sfa)
* [Play Store (Beta)](https://play.google.com/apps/testing/io.nekohasekai.sfa) * [Play Store (Beta)](https://play.google.com/apps/testing/io.nekohasekai.sfa)
* [GitHub Releases](https://github.com/SagerNet/sing-box/releases) * [Github Releases](https://github.com/SagerNet/sing-box/releases)
## :material-source-repository: Source code ## :material-source-repository: Source code
* [GitHub](https://github.com/SagerNet/sing-box-for-android) * [Github](https://github.com/SagerNet/sing-box-for-android)

6
docs/clients/apple/index.md
View File

@ -14,7 +14,7 @@ platform-specific function implementation, such as TUN transparent proxy impleme
## :material-download: Download ## :material-download: Download
* [App Store](https://apps.apple.com/us/app/sing-box/id6451272673) * [AppStore](https://apps.apple.com/us/app/sing-box/id6451272673)
* [TestFlight (Beta)](https://testflight.apple.com/join/AcqO44FH) * [TestFlight (Beta)](https://testflight.apple.com/join/AcqO44FH)
## :material-file-download: Download (macOS standalone version) ## :material-file-download: Download (macOS standalone version)
@ -25,8 +25,8 @@ platform-specific function implementation, such as TUN transparent proxy impleme
brew install sfm brew install sfm
``` ```
* [GitHub Releases](https://github.com/SagerNet/sing-box/releases) * [Github Releases](https://github.com/SagerNet/sing-box/releases)
## :material-source-repository: Source code ## :material-source-repository: Source code
* [GitHub](https://github.com/SagerNet/sing-box-for-apple) * [Github](https://github.com/SagerNet/sing-box-for-apple)

2
docs/manual/proxy-protocol/tuic.md
View File

@ -12,7 +12,7 @@ A recently popular Chinese-made simple protocol based on QUIC, the selling point
| Specification | Binary Characteristics | Active Detect Hiddenness | | Specification | Binary Characteristics | Active Detect Hiddenness |
|-----------------------------------------------------------|------------------------|--------------------------| |-----------------------------------------------------------|------------------------|--------------------------|
| [GitHub](https://github.com/EAimTY/tuic/blob/dev/SPEC.md) | :material-alert: | :material-check: | | [Github](https://github.com/EAimTY/tuic/blob/dev/SPEC.md) | :material-alert: | :material-check: |
## Password Generator ## Password Generator

138
docs/manual/proxy/client.md
View File

@ -285,141 +285,3 @@ flowchart TB
} }
} }
``` ```
### Traffic bypass usage for Chinese users
=== ":material-dns: DNS rules"
!!! info
DNS rules are optional if FakeIP is used.
```json
{
"dns": {
"servers": [
{
"tag": "google",
"address": "tls://8.8.8.8"
},
{
"tag": "local",
"address": "223.5.5.5",
"detour": "direct"
}
],
"rules": [
{
"outbound": "any",
"server": "local"
},
{
"clash_mode": "Direct",
"server": "local"
},
{
"clash_mode": "Global",
"server": "google"
},
{
"type": "logical",
"mode": "and",
"rules": [
{
"geosite": "geolocation-!cn",
"invert": true
},
{
"geosite": [
"cn",
"category-companies@cn"
],
}
],
"server": "local"
}
]
}
}
```
=== ":material-router-network: Route rules"
```json
{
"outbounds": [
{
"type": "direct",
"tag": "direct"
},
{
"type": "block",
"tag": "block"
}
],
"route": {
"rules": [
{
"type": "logical",
"mode": "or",
"rules": [
{
"protocol": "dns"
},
{
"port": 53
}
],
"outbound": "dns"
},
{
"geoip": "private",
"outbound": "direct"
},
{
"clash_mode": "Direct",
"outbound": "direct"
},
{
"clash_mode": "Global",
"outbound": "default"
},
{
"type": "logical",
"mode": "or",
"rules": [
{
"port": 853
},
{
"network": "udp",
"port": 443
},
{
"protocol": "stun"
}
],
"outbound": "block"
},
{
"type": "logical",
"mode": "and",
"rules": [
{
"geosite": "geolocation-!cn",
"invert": true
},
{
"geosite": [
"cn",
"category-companies@cn"
],
"geoip": "cn"
}
],
"outbound": "direct"
}
]
}
}
```

66
docs/manual/proxy/tun.md Normal file
View File

@ -0,0 +1,66 @@
# :material-expansion-card: TUN
## :material-text-box: Definition
Refers to TUNnel, a virtual network device supported by the kernel.
It’s also used in sing-box to denote the extensive functionality surrounding TUN inbound:
including traffic assembly, automatic routing, and network and default interface monitoring.
The following flow chart describes the minimal TUN-based transparent proxy process in sing-box:
``` mermaid
flowchart LR
subgraph inbound [Inbound]
direction TB
packet[IP Packet]
packet --> windows[Windows / macOS]
packet --> linux[Linux]
tun[TUN interface]
windows -. route .-> tun
linux -. iproute2 route/rule .-> tun
tun --> gvisor[gVisor TUN stack]
tun --> system[system TUN stack]
assemble([L3 to L4 assemble])
gvisor --> assemble
system --> assemble
assemble --> conn[TCP and UDP connections]
conn --> router[sing-box Router]
end
subgraph outbound [Outbound]
direction TB
direct[Direct outbound]
proxy[Proxy outbounds]
direct --> adi([auto detect interface])
proxy --> adi
adi --> default[Default network interface in the system]
default --> destination[Destination server]
default --> proxy_server[Proxy server]
proxy_server --> destination
end
inbound --> outbound
```
## :material-help-box: How to
A basic TUN-based transparent proxy configuration file includes: an TUN inbound, `route.auto_detect_interface`, like:
```json
{
"inbounds": [
{
"type": "tun",
"inet4_address": "172.19.0.1/30",
"inet6_address": "fdfe:dcba:9876::1/126",
"auto_route": true,
"strict_route": true
}
],
"route": {
"auto_detect_interface": true
}
}
```
TODO: finish this wiki

2
docs/support.md
View File

@ -7,7 +7,7 @@ icon: material/forum
| Channel | Link | | Channel | Link |
|:------------------------------|:--------------------------------------------| |:------------------------------|:--------------------------------------------|
| Community | https://community.sagernet.org | | Community | https://community.sagernet.org |
| GitHub Issues | https://github.com/SagerNet/sing-box/issues | | Github Issues | https://github.com/SagerNet/sing-box/issues |
| Telegram notification channel | https://t.me/yapnc | | Telegram notification channel | https://t.me/yapnc |
| Telegram user group | https://t.me/yapug | | Telegram user group | https://t.me/yapug |
| Email | contact@sagernet.org | | Email | contact@sagernet.org |

2
docs/support.zh.md
View File

@ -7,7 +7,7 @@ icon: material/forum
| 通道 | 链接 | | 通道 | 链接 |
|:--------------|:--------------------------------------------| |:--------------|:--------------------------------------------|
| 社区 | https://community.sagernet.org | | 社区 | https://community.sagernet.org |
| GitHub Issues | https://github.com/SagerNet/sing-box/issues | | Github Issues | https://github.com/SagerNet/sing-box/issues |
| Telegram 通知频道 | https://t.me/yapnc | | Telegram 通知频道 | https://t.me/yapnc |
| Telegram 用户组 | https://t.me/yapug | | Telegram 用户组 | https://t.me/yapug |
| 邮件 | contact@sagernet.org | | 邮件 | contact@sagernet.org |