Skip to content

Commit 7ebbd58

Browse files
nekohasekainekohasekai
committed
Update documentation
1 parent d0095fd commit 7ebbd58

13 files changed

+279
-59
lines changed

‎constant/version.go

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,3 @@
11
package constant
22

3-
var Version = "1.1-rc1"
3+
var Version = "1.1"

‎docs/changelog.md

+29
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,32 @@
1+
#### 1.1
2+
3+
* Fix close clash cache
4+
5+
Important changes since 1.0:
6+
7+
* Add support for use with android VPNService
8+
* Add tun support for WireGuard outbound
9+
* Add system tun stack
10+
* Add comment filter for config
11+
* Add option for allow optional proxy protocol header
12+
* Add Clash mode and persistence support
13+
* Add TLS ECH and uTLS support for outbound TLS options
14+
* Add internal simple-obfs and v2ray-plugin
15+
* Add ShadowsocksR outbound
16+
* Add VLESS outbound and XUDP
17+
* Skip wait for hysteria tcp handshake response
18+
* Add v2ray mux support for all inbound
19+
* Add XUDP support for VMess
20+
* Improve websocket writer
21+
* Refine tproxy write back
22+
* Fix DNS leak caused by
23+
Windows' ordinary multihomed DNS resolution behavior
24+
* Add sniff_timeout listen option
25+
* Add custom route support for tun
26+
* Add option for custom wireguard reserved bytes
27+
* Split bind_address into ipv4 and ipv6
28+
* Add ShadowTLS v1 and v2 support
29+
130
#### 1.1-rc1
231

332
* Fix TLS config for h2 server

‎docs/examples/clash-api.md

+52
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,52 @@
1+
```json
2+
{
3+
"dns": {
4+
"rules": [
5+
{
6+
"domain": [
7+
"clash.razord.top",
8+
"yacd.haishan.me"
9+
],
10+
"server": "local"
11+
},
12+
{
13+
"clash_mode": "direct",
14+
"server": "local"
15+
}
16+
]
17+
},
18+
"outbounds": [
19+
{
20+
"type": "selector",
21+
"tag": "default",
22+
"outbounds": [
23+
"proxy-a",
24+
"proxy-b"
25+
]
26+
}
27+
],
28+
"route": {
29+
"rules": [
30+
{
31+
"clash_mode": "direct",
32+
"outbound": "direct"
33+
},
34+
{
35+
"domain": [
36+
"clash.razord.top",
37+
"yacd.haishan.me"
38+
],
39+
"outbound": "direct"
40+
}
41+
],
42+
"final": "default"
43+
},
44+
"experimental": {
45+
"clash_api": {
46+
"external_controller": "127.0.0.1:9090",
47+
"store_selected": true
48+
}
49+
}
50+
}
51+
52+
```

‎docs/examples/index.md

+5-4
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,8 @@
33
Configuration examples for sing-box.
44

55
* [Linux Server Installation](./linux-server-installation)
6-
* [Shadowsocks Server](./ss-server)
7-
* [Shadowsocks Client](./ss-client)
8-
* [Shadowsocks Tun](./ss-tun)
9-
* [DNS Hijack](./dns-hijack.md)
6+
* [Tun](./tun)
7+
* [DNS Hijack](./dns-hijack.md)
8+
* [Shadowsocks](./shadowsocks)
9+
* [ShadowTLS](./shadowtls)
10+
* [Clash API](./clash-api)

‎docs/examples/index.zh.md

+5-4
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,8 @@
33
sing-box 的配置示例。
44

55
* [Linux 服务器安装](./linux-server-installation)
6-
* [Shadowsocks 服务器](./ss-server)
7-
* [Shadowsocks 客户端](./ss-client)
8-
* [Shadowsocks Tun](./ss-tun)
9-
* [DNS 劫持](./dns-hijack.md)
6+
* [Tun](./tun)
7+
* [DNS 劫持](./dns-hijack.md)
8+
* [Shadowsocks](./shadowsocks)
9+
* [ShadowTLS](./shadowtls)
10+
* [Clash API](./clash-api)

‎docs/examples/shadowsocks.md

+157
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,157 @@
1+
# Shadowsocks
2+
3+
## Single User
4+
5+
#### Server
6+
7+
```json
8+
{
9+
"inbounds": [
10+
{
11+
"type": "shadowsocks",
12+
"listen": "::",
13+
"listen_port": 8080,
14+
"method": "2022-blake3-aes-128-gcm",
15+
"password": "8JCsPssfgS8tiRwiMlhARg=="
16+
}
17+
]
18+
}
19+
```
20+
21+
#### Client
22+
23+
```json
24+
{
25+
"inbounds": [
26+
{
27+
"type": "mixed",
28+
"listen": "::",
29+
"listen_port": 2080
30+
}
31+
],
32+
"outbounds": [
33+
{
34+
"type": "shadowsocks",
35+
"server": "127.0.0.1",
36+
"server_port": 8080,
37+
"method": "2022-blake3-aes-128-gcm",
38+
"password": "8JCsPssfgS8tiRwiMlhARg=="
39+
}
40+
]
41+
}
42+
43+
```
44+
45+
## Multiple Users
46+
47+
#### Server
48+
49+
```json
50+
{
51+
"inbounds": [
52+
{
53+
"type": "shadowsocks",
54+
"listen": "::",
55+
"listen_port": 8080,
56+
"method": "2022-blake3-aes-128-gcm",
57+
"password": "8JCsPssfgS8tiRwiMlhARg==",
58+
"users": [
59+
{
60+
"name": "sekai",
61+
"password": "BXYxVUXJ9NgF7c7KPLQjkg=="
62+
}
63+
]
64+
}
65+
]
66+
}
67+
```
68+
69+
#### Client
70+
71+
```json
72+
{
73+
"inbounds": [
74+
{
75+
"type": "mixed",
76+
"listen": "::",
77+
"listen_port": 2080
78+
}
79+
],
80+
"outbounds": [
81+
{
82+
"type": "shadowsocks",
83+
"server": "127.0.0.1",
84+
"server_port": 8080,
85+
"method": "2022-blake3-aes-128-gcm",
86+
"password": "8JCsPssfgS8tiRwiMlhARg==:BXYxVUXJ9NgF7c7KPLQjkg=="
87+
}
88+
]
89+
}
90+
91+
```
92+
93+
## Relay
94+
95+
#### Server
96+
97+
```json
98+
{
99+
"inbounds": [
100+
{
101+
"type": "shadowsocks",
102+
"listen": "::",
103+
"listen_port": 8080,
104+
"method": "2022-blake3-aes-128-gcm",
105+
"password": "8JCsPssfgS8tiRwiMlhARg=="
106+
}
107+
]
108+
}
109+
```
110+
111+
#### Relay
112+
113+
```json
114+
{
115+
"inbounds": [
116+
{
117+
"type": "shadowsocks",
118+
"listen": "::",
119+
"listen_port": 8081,
120+
"method": "2022-blake3-aes-128-gcm",
121+
"password": "BXYxVUXJ9NgF7c7KPLQjkg==",
122+
"destinations": [
123+
{
124+
"name": "my_server",
125+
"password": "8JCsPssfgS8tiRwiMlhARg==",
126+
"server": "127.0.0.1",
127+
"server_port": 8080
128+
}
129+
]
130+
}
131+
]
132+
}
133+
```
134+
135+
#### Client
136+
137+
```json
138+
{
139+
"inbounds": [
140+
{
141+
"type": "mixed",
142+
"listen": "::",
143+
"listen_port": 2080
144+
}
145+
],
146+
"outbounds": [
147+
{
148+
"type": "shadowsocks",
149+
"server": "127.0.0.1",
150+
"server_port": 8081,
151+
"method": "2022-blake3-aes-128-gcm",
152+
"password": "8JCsPssfgS8tiRwiMlhARg==:BXYxVUXJ9NgF7c7KPLQjkg=="
153+
}
154+
]
155+
}
156+
157+
```

‎docs/examples/shadowtls.md

+4
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,8 @@
77
"type": "shadowtls",
88
"listen": "::",
99
"listen_port": 4443,
10+
"version": 2,
11+
"password": "fuck me till the daylight",
1012
"handshake": {
1113
"server": "google.com",
1214
"server_port": 443
@@ -45,6 +47,8 @@
4547
"tag": "shadowtls-out",
4648
"server": "127.0.0.1",
4749
"server_port": 4443,
50+
"version": 2,
51+
"password": "fuck me till the daylight",
4852
"tls": {
4953
"enabled": true,
5054
"server_name": "google.com"

‎docs/examples/ss-client.md

-21
This file was deleted.

‎docs/examples/ss-server.md

-13
This file was deleted.

‎docs/examples/ss-tun.md renamed to ‎docs/examples/tun.md

+18-5
Original file line numberDiff line numberDiff line change
@@ -10,9 +10,18 @@
1010
"tag": "local",
1111
"address": "223.5.5.5",
1212
"detour": "direct"
13+
},
14+
{
15+
"tag": "block",
16+
"address": "rcode://success"
1317
}
1418
],
1519
"rules": [
20+
{
21+
"geosite": "category-ads-all",
22+
"server": "block",
23+
"disable_cache": true
24+
},
1625
{
1726
"domain": "mydomain.com",
1827
"geosite": "cn",
@@ -26,6 +35,7 @@
2635
"type": "tun",
2736
"inet4_address": "172.19.0.1/30",
2837
"auto_route": true,
38+
"strict_route": false,
2939
"sniff": true
3040
}
3141
],
@@ -57,14 +67,17 @@
5767
"protocol": "dns",
5868
"outbound": "dns-out"
5969
},
60-
{
61-
"geosite": "category-ads-all",
62-
"outbound": "block"
63-
},
6470
{
6571
"geosite": "cn",
66-
"geoip": "cn",
72+
"geoip": [
73+
"private",
74+
"cn"
75+
],
6776
"outbound": "direct"
77+
},
78+
{
79+
"geosite": "category-ads-all",
80+
"outbound": "block"
6881
}
6982
],
7083
"auto_detect_interface": true

‎docs/faq/known-issues.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -7,11 +7,11 @@ the public internet.
77

88
##### on Android
99

10-
`auto-route` cannot automatically hijack DNS requests when Android's `Private DNS` is enabled.
10+
`auto-route` cannot automatically hijack DNS requests when Android's `Private DNS` enabled or `strict_route` disabled.
1111

1212
##### on Linux
1313

14-
`auto-route` cannot automatically hijack DNS requests with `systemd-resolved` enabled, you can switch to NetworkManager.
14+
`auto-route` cannot automatically hijack DNS requests with `systemd-resolved` enabled and `strict_route` disabled.
1515

1616
#### System proxy
1717

0 commit comments

Comments
 (0)