Skip to content

Commit e8c4c94

Browse files
nekohasekainekohasekai
committed
documentation: Bump version & Refactor docs
1 parent 253976d commit e8c4c94

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

104 files changed

+2170
-1767
lines changed

‎Makefile

+9-1
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ MAIN_PARAMS = $(PARAMS) -tags $(TAGS)
1414
MAIN = ./cmd/sing-box
1515
PREFIX ?= $(shell go env GOPATH)
1616

17-
.PHONY: test release
17+
.PHONY: test release docs
1818

1919
build:
2020
go build $(MAIN_PARAMS) $(MAIN)
@@ -182,6 +182,14 @@ lib_install:
182182
go install -v github.com/sagernet/gomobile/cmd/[email protected]
183183
go install -v github.com/sagernet/gomobile/cmd/[email protected]
184184

185+
docs:
186+
mkdocs serve
187+
188+
publish_docs:
189+
mkdocs gh-deploy -m "Update" --force --ignore-version --no-history
190+
191+
docs_install:
192+
pip install --force-reinstall mkdocs-material=="9.*" mkdocs-static-i18n=="1.2.*"
185193
clean:
186194
rm -rf bin dist sing-box
187195
rm -f $(shell go env GOPATH)/sing-box

‎docs/changelog.md

+122
Original file line numberDiff line numberDiff line change
@@ -1,27 +1,86 @@
1+
---
2+
icon: material/alert-decagram
3+
---
4+
5+
# ChangeLog
6+
7+
#### 1.7.0-rc.3
8+
9+
* Fixes and improvements
10+
111
#### 1.6.7
212

313
* macOS: Add button for uninstall SystemExtension in the standalone graphical client
414
* Fix missing UDP user context on TUIC/Hysteria2 inbounds
515
* Fixes and improvements
616

17+
#### 1.7.0-rc.2
18+
19+
* Fix missing UDP user context on TUIC/Hysteria2 inbounds
20+
* macOS: Add button for uninstall SystemExtension in the standalone graphical client
21+
722
#### 1.6.6
823

924
* Fixes and improvements
1025

26+
#### 1.7.0-rc.1
27+
28+
* Fixes and improvements
29+
30+
#### 1.7.0-beta.5
31+
32+
* Update gVisor to 20231113.0
33+
* Fixes and improvements
34+
35+
#### 1.7.0-beta.4
36+
37+
* Add `wifi_ssid` and `wifi_bssid` route and DNS rules **1**
38+
* Fixes and improvements
39+
40+
**1**:
41+
42+
Only supported in graphical clients on Android and iOS.
43+
44+
#### 1.7.0-beta.3
45+
46+
* Fix zero TTL was incorrectly reset
47+
* Fixes and improvements
48+
1149
#### 1.6.5
1250

1351
* Fix crash if TUIC inbound authentication failed
1452
* Fixes and improvements
1553

54+
#### 1.7.0-beta.2
55+
56+
* Fix crash if TUIC inbound authentication failed
57+
* Update quic-go to v0.40.0
58+
* Fixes and improvements
59+
1660
#### 1.6.4
1761

1862
* Fixes and improvements
1963

64+
#### 1.7.0-beta.1
65+
66+
* Fixes and improvements
67+
2068
#### 1.6.3
2169

2270
* iOS/Android: Fix profile auto update
2371
* Fixes and improvements
2472

73+
#### 1.7.0-alpha.11
74+
75+
* iOS/Android: Fix profile auto update
76+
* Fixes and improvements
77+
78+
#### 1.7.0-alpha.10
79+
80+
* Fix tcp-brutal not working with TLS
81+
* Fix Android client not closing in some cases
82+
* Fixes and improvements
83+
2584
#### 1.6.2
2685

2786
* Fixes and improvements
@@ -31,6 +90,34 @@
3190
* Our [Android client](/installation/clients/sfa) is now available in the Google Play Store ▶️
3291
* Fixes and improvements
3392

93+
#### 1.7.0-alpha.6
94+
95+
* Fixes and improvements
96+
97+
#### 1.7.0-alpha.4
98+
99+
* Migrate multiplex and UoT server to inbound **1**
100+
* Add TCP Brutal support for multiplex **2**
101+
102+
**1**:
103+
104+
Starting in 1.7.0, multiplexing support is no longer enabled by default and needs to be turned on explicitly in inbound options.
105+
106+
**2**
107+
108+
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.
109+
110+
#### 1.7.0-alpha.3
111+
112+
* Add [HTTPUpgrade V2Ray transport](/configuration/shared/v2ray-transport#HTTPUpgrade) support **1**
113+
* Fixes and improvements
114+
115+
**1**:
116+
117+
Introduced in V2Ray 5.10.0.
118+
119+
The new HTTPUpgrade transport has better performance than WebSocket and is better suited for CDN abuse.
120+
34121
#### 1.6.0
35122

36123
* Fixes and improvements
@@ -55,6 +142,23 @@ This update is intended to address the multi-send defects of the old implementat
55142
Based on discussions with the original author, the brutal CC and QUIC protocol parameters of
56143
the old protocol (Hysteria 1) have been updated to be consistent with Hysteria 2
57144

145+
#### 1.7.0-alpha.2
146+
147+
* Fix bugs introduced in 1.7.0-alpha.1
148+
149+
#### 1.7.0-alpha.1
150+
151+
* Add [exclude route support](/configuration/inbound/tun) for TUN inbound
152+
* Add `udp_disable_domain_unmapping` [inbound listen option](/configuration/shared/listen) **1**
153+
* Fixes and improvements
154+
155+
**1**:
156+
157+
If enabled, for UDP proxy requests addressed to a domain,
158+
the original packet address will be sent in the response instead of the mapped domain.
159+
160+
This option is used for compatibility with clients that
161+
do not support receiving UDP packets with domain addresses, such as Surge.
58162

59163
#### 1.5.5
60164

@@ -116,6 +220,24 @@ the old protocol (Hysteria 1) have been updated to be consistent with Hysteria 2
116220
* Update golang.org/x/net to v0.17.0
117221
* Fixes and improvements
118222

223+
#### 1.6.0-beta.3
224+
225+
* Update the legacy Hysteria protocol **1**
226+
* Fixes and improvements
227+
228+
**1**
229+
230+
Based on discussions with the original author, the brutal CC and QUIC protocol parameters of
231+
the old protocol (Hysteria 1) have been updated to be consistent with Hysteria 2
232+
233+
#### 1.6.0-beta.2
234+
235+
* Add TLS self sign key pair generate command
236+
* Update brutal congestion control for Hysteria2
237+
* Fix Clash cache crash on arm32 devices
238+
* Update golang.org/x/net to v0.17.0
239+
* Fixes and improvements
240+
119241
#### 1.5.3
120242

121243
* Fix compatibility with Android 14

‎docs/clients/android/features.md

+64
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,64 @@
1+
# :material-decagram: Features
2+
3+
#### UI options
4+
5+
* Display realtime network speed in the notification
6+
7+
#### Service
8+
9+
SFA allows you to run sing-box through ForegroundService or VpnService (when TUN is required).
10+
11+
#### TUN
12+
13+
SFA provides an unprivileged TUN implementation through Android VpnService.
14+
15+
| TUN inbound option | Available | Note |
16+
|-------------------------------|------------------|--------------------|
17+
| `interface_name` | :material-close: | Managed by Android |
18+
| `inet4_address` | :material-check: | / |
19+
| `inet6_address` | :material-check: | / |
20+
| `mtu` | :material-check: | / |
21+
| `auto_route` | :material-check: | / |
22+
| `strict_route` | :material-close: | Not implemented |
23+
| `inet4_route_address` | :material-check: | / |
24+
| `inet6_route_address` | :material-check: | / |
25+
| `inet4_route_exclude_address` | :material-check: | / |
26+
| `inet6_route_exclude_address` | :material-check: | / |
27+
| `endpoint_independent_nat` | :material-check: | / |
28+
| `stack` | :material-check: | / |
29+
| `include_interface` | :material-close: | No permission |
30+
| `exclude_interface` | :material-close: | No permission |
31+
| `include_uid` | :material-close: | No permission |
32+
| `exclude_uid` | :material-close: | No permission |
33+
| `include_android_user` | :material-close: | No permission |
34+
| `include_package` | :material-check: | / |
35+
| `exclude_package` | :material-check: | / |
36+
| `platform` | :material-check: | / |
37+
38+
| Route/DNS rule option | Available | Note |
39+
|-----------------------|------------------|-----------------------------------|
40+
| `process_name` | :material-close: | No permission |
41+
| `process_path` | :material-close: | No permission |
42+
| `package_name` | :material-check: | / |
43+
| `user` | :material-close: | Use `package_name` instead |
44+
| `user_id` | :material-close: | Use `package_name` instead |
45+
| `wifi_ssid` | :material-check: | Fine location permission required |
46+
| `wifi_bssid` | :material-check: | Fine location permission required |
47+
48+
### Override
49+
50+
Overrides profile configuration items with platform-specific values.
51+
52+
#### Per-app proxy
53+
54+
SFA allows you to select a list of Android apps that require proxying or bypassing in the graphical interface to
55+
override the `include_package` and `exclude_package` configuration items.
56+
57+
In particular, the selector also provides the “China apps” scanning feature, providing Chinese users with an excellent
58+
experience to bypass apps that do not require a proxy. Specifically, by scanning China application or SDK
59+
characteristics through dex class path and other means, there will be almost no missed reports.
60+
61+
### Chore
62+
63+
* The working directory is located at `/sdcard/Android/data/io.nekohasekai.sfa/files` (External files directory)
64+
* Crash logs is located in `$working_directory/stderr.log`

‎docs/clients/android/index.md

+22
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
---
2+
icon: material/android
3+
---
4+
5+
# sing-box for Android
6+
7+
SFA allows users to manage and run local or remote sing-box configuration files, and provides
8+
platform-specific function implementation, such as TUN transparent proxy implementation.
9+
10+
## :material-graph: Requirements
11+
12+
* Android 5.0+
13+
14+
## :material-download: Download
15+
16+
* [Play Store](https://play.google.com/store/apps/details?id=io.nekohasekai.sfa)
17+
* [Play Store (Beta)](https://play.google.com/apps/testing/io.nekohasekai.sfa)
18+
* [GitHub Releases](https://github.com/SagerNet/sing-box/releases)
19+
20+
## :material-source-repository: Source code
21+
22+
* [GitHub](https://github.com/SagerNet/sing-box-for-android)

‎docs/clients/apple/features.md

+52
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,52 @@
1+
# :material-decagram: Features
2+
3+
#### UI options
4+
5+
* Always On
6+
* Include All Networks (Proxy traffic for LAN and cellular services)
7+
* (Apple tvOS) Import profile from iPhone/iPad
8+
9+
#### Service
10+
11+
SFI/SFM/SFT allows you to run sing-box through NetworkExtension with Application Extension or System Extension.
12+
13+
#### TUN
14+
15+
SFI/SFM/SFT provides an unprivileged TUN implementation through NetworkExtension.
16+
17+
| TUN inbound option | Available | Note |
18+
|-------------------------------|-----------|-------------------|
19+
| `interface_name` | ✖️ | Managed by Darwin |
20+
| `inet4_address` | ✔️ | / |
21+
| `inet6_address` | ✔️ | / |
22+
| `mtu` | ✔️ | / |
23+
| `auto_route` | ✔️ | / |
24+
| `strict_route` | ✖️ | Not implemented |
25+
| `inet4_route_address` | ✔️ | / |
26+
| `inet6_route_address` | ✔️ | / |
27+
| `inet4_route_exclude_address` | ✔️ | / |
28+
| `inet6_route_exclude_address` | ✔️ | / |
29+
| `endpoint_independent_nat` | ✔️ | / |
30+
| `stack` | ✔️ | / |
31+
| `include_interface` | ✖️ | Not implemented |
32+
| `exclude_interface` | ✖️ | Not implemented |
33+
| `include_uid` | ✖️ | Not implemented |
34+
| `exclude_uid` | ✖️ | Not implemented |
35+
| `include_android_user` | ✖️ | Not implemented |
36+
| `include_package` | ✖️ | Not implemented |
37+
| `exclude_package` | ✖️ | Not implemented |
38+
| `platform` | ✔️ | / |
39+
40+
| Route/DNS rule option | Available | Note |
41+
|-----------------------|------------------|-----------------------|
42+
| `process_name` | :material-close: | No permission |
43+
| `process_path` | :material-close: | No permission |
44+
| `package_name` | :material-close: | / |
45+
| `user` | :material-close: | No permission |
46+
| `user_id` | :material-close: | No permission |
47+
| `wifi_ssid` | :material-alert: | Only supported on iOS |
48+
| `wifi_bssid` | :material-alert: | Only supported on iOS |
49+
50+
### Chore
51+
52+
* Crash logs is located in `Settings` -> `View Service Log`

‎docs/clients/apple/index.md

+32
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
---
2+
icon: material/apple
3+
---
4+
5+
# sing-box for Apple platforms
6+
7+
SFI/SFM/SFT allows users to manage and run local or remote sing-box configuration files, and provides
8+
platform-specific function implementation, such as TUN transparent proxy implementation.
9+
10+
## :material-graph: Requirements
11+
12+
* iOS 15.0+ / macOS 13.0+ / Apple tvOS 17.0+
13+
* An Apple account outside of mainland China
14+
15+
## :material-download: Download
16+
17+
* [App Store](https://apps.apple.com/us/app/sing-box/id6451272673)
18+
* [TestFlight (Beta)](https://testflight.apple.com/join/AcqO44FH)
19+
20+
## :material-file-download: Download (macOS standalone version)
21+
22+
* [Homebrew Cask](https://formulae.brew.sh/cask/sfm)
23+
24+
```bash
25+
brew install sfm
26+
```
27+
28+
* [GitHub Releases](https://github.com/SagerNet/sing-box/releases)
29+
30+
## :material-source-repository: Source code
31+
32+
* [GitHub](https://github.com/SagerNet/sing-box-for-apple)

0 commit comments

Comments
 (0)