mirror of
https://github.com/SagerNet/sing-box.git
synced 2024-11-22 00:21:30 +00:00
Update documentation
This commit is contained in:
世界
parent
d0095fd0f4
commit
7ebbd58b00
|
|
@ -1,3 +1,3 @@
|
||||||
package constant
|
package constant
|
||||||
|
|
||||||
var Version = "1.1-rc1"
|
var Version = "1.1"
|
||||||
|
|
|
||||||
|
|
@ -1,3 +1,32 @@
|
||||||
|
#### 1.1
|
||||||
|
|
||||||
|
* Fix close clash cache
|
||||||
|
|
||||||
|
Important changes since 1.0:
|
||||||
|
|
||||||
|
* Add support for use with android VPNService
|
||||||
|
* Add tun support for WireGuard outbound
|
||||||
|
* Add system tun stack
|
||||||
|
* Add comment filter for config
|
||||||
|
* Add option for allow optional proxy protocol header
|
||||||
|
* Add Clash mode and persistence support
|
||||||
|
* Add TLS ECH and uTLS support for outbound TLS options
|
||||||
|
* Add internal simple-obfs and v2ray-plugin
|
||||||
|
* Add ShadowsocksR outbound
|
||||||
|
* Add VLESS outbound and XUDP
|
||||||
|
* Skip wait for hysteria tcp handshake response
|
||||||
|
* Add v2ray mux support for all inbound
|
||||||
|
* Add XUDP support for VMess
|
||||||
|
* Improve websocket writer
|
||||||
|
* Refine tproxy write back
|
||||||
|
* Fix DNS leak caused by
|
||||||
|
Windows' ordinary multihomed DNS resolution behavior
|
||||||
|
* Add sniff_timeout listen option
|
||||||
|
* Add custom route support for tun
|
||||||
|
* Add option for custom wireguard reserved bytes
|
||||||
|
* Split bind_address into ipv4 and ipv6
|
||||||
|
* Add ShadowTLS v1 and v2 support
|
||||||
|
|
||||||
#### 1.1-rc1
|
#### 1.1-rc1
|
||||||
|
|
||||||
* Fix TLS config for h2 server
|
* Fix TLS config for h2 server
|
||||||
|
|
|
||||||
52
docs/examples/clash-api.md
Normal file
52
docs/examples/clash-api.md
Normal file
|
|
@ -0,0 +1,52 @@
|
||||||
|
```json
|
||||||
|
{
|
||||||
|
"dns": {
|
||||||
|
"rules": [
|
||||||
|
{
|
||||||
|
"domain": [
|
||||||
|
"clash.razord.top",
|
||||||
|
"yacd.haishan.me"
|
||||||
|
],
|
||||||
|
"server": "local"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"clash_mode": "direct",
|
||||||
|
"server": "local"
|
||||||
|
}
|
||||||
|
]
|
||||||
|
},
|
||||||
|
"outbounds": [
|
||||||
|
{
|
||||||
|
"type": "selector",
|
||||||
|
"tag": "default",
|
||||||
|
"outbounds": [
|
||||||
|
"proxy-a",
|
||||||
|
"proxy-b"
|
||||||
|
]
|
||||||
|
}
|
||||||
|
],
|
||||||
|
"route": {
|
||||||
|
"rules": [
|
||||||
|
{
|
||||||
|
"clash_mode": "direct",
|
||||||
|
"outbound": "direct"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"domain": [
|
||||||
|
"clash.razord.top",
|
||||||
|
"yacd.haishan.me"
|
||||||
|
],
|
||||||
|
"outbound": "direct"
|
||||||
|
}
|
||||||
|
],
|
||||||
|
"final": "default"
|
||||||
|
},
|
||||||
|
"experimental": {
|
||||||
|
"clash_api": {
|
||||||
|
"external_controller": "127.0.0.1:9090",
|
||||||
|
"store_selected": true
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
```
|
||||||
|
|
@ -3,7 +3,8 @@
|
||||||
Configuration examples for sing-box.
|
Configuration examples for sing-box.
|
||||||
|
|
||||||
* [Linux Server Installation](./linux-server-installation)
|
* [Linux Server Installation](./linux-server-installation)
|
||||||
* [Shadowsocks Server](./ss-server)
|
* [Tun](./tun)
|
||||||
* [Shadowsocks Client](./ss-client)
|
* [DNS Hijack](./dns-hijack.md)
|
||||||
* [Shadowsocks Tun](./ss-tun)
|
* [Shadowsocks](./shadowsocks)
|
||||||
* [DNS Hijack](./dns-hijack.md)
|
* [ShadowTLS](./shadowtls)
|
||||||
|
* [Clash API](./clash-api)
|
||||||
|
|
|
||||||
|
|
@ -3,7 +3,8 @@
|
||||||
sing-box 的配置示例。
|
sing-box 的配置示例。
|
||||||
|
|
||||||
* [Linux 服务器安装](./linux-server-installation)
|
* [Linux 服务器安装](./linux-server-installation)
|
||||||
* [Shadowsocks 服务器](./ss-server)
|
* [Tun](./tun)
|
||||||
* [Shadowsocks 客户端](./ss-client)
|
* [DNS 劫持](./dns-hijack.md)
|
||||||
* [Shadowsocks Tun](./ss-tun)
|
* [Shadowsocks](./shadowsocks)
|
||||||
* [DNS 劫持](./dns-hijack.md)
|
* [ShadowTLS](./shadowtls)
|
||||||
|
* [Clash API](./clash-api)
|
||||||
|
|
|
||||||
157
docs/examples/shadowsocks.md
Normal file
157
docs/examples/shadowsocks.md
Normal file
|
|
@ -0,0 +1,157 @@
|
||||||
|
# Shadowsocks
|
||||||
|
|
||||||
|
## Single User
|
||||||
|
|
||||||
|
#### Server
|
||||||
|
|
||||||
|
```json
|
||||||
|
{
|
||||||
|
"inbounds": [
|
||||||
|
{
|
||||||
|
"type": "shadowsocks",
|
||||||
|
"listen": "::",
|
||||||
|
"listen_port": 8080,
|
||||||
|
"method": "2022-blake3-aes-128-gcm",
|
||||||
|
"password": "8JCsPssfgS8tiRwiMlhARg=="
|
||||||
|
}
|
||||||
|
]
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
#### Client
|
||||||
|
|
||||||
|
```json
|
||||||
|
{
|
||||||
|
"inbounds": [
|
||||||
|
{
|
||||||
|
"type": "mixed",
|
||||||
|
"listen": "::",
|
||||||
|
"listen_port": 2080
|
||||||
|
}
|
||||||
|
],
|
||||||
|
"outbounds": [
|
||||||
|
{
|
||||||
|
"type": "shadowsocks",
|
||||||
|
"server": "127.0.0.1",
|
||||||
|
"server_port": 8080,
|
||||||
|
"method": "2022-blake3-aes-128-gcm",
|
||||||
|
"password": "8JCsPssfgS8tiRwiMlhARg=="
|
||||||
|
}
|
||||||
|
]
|
||||||
|
}
|
||||||
|
|
||||||
|
```
|
||||||
|
|
||||||
|
## Multiple Users
|
||||||
|
|
||||||
|
#### Server
|
||||||
|
|
||||||
|
```json
|
||||||
|
{
|
||||||
|
"inbounds": [
|
||||||
|
{
|
||||||
|
"type": "shadowsocks",
|
||||||
|
"listen": "::",
|
||||||
|
"listen_port": 8080,
|
||||||
|
"method": "2022-blake3-aes-128-gcm",
|
||||||
|
"password": "8JCsPssfgS8tiRwiMlhARg==",
|
||||||
|
"users": [
|
||||||
|
{
|
||||||
|
"name": "sekai",
|
||||||
|
"password": "BXYxVUXJ9NgF7c7KPLQjkg=="
|
||||||
|
}
|
||||||
|
]
|
||||||
|
}
|
||||||
|
]
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
#### Client
|
||||||
|
|
||||||
|
```json
|
||||||
|
{
|
||||||
|
"inbounds": [
|
||||||
|
{
|
||||||
|
"type": "mixed",
|
||||||
|
"listen": "::",
|
||||||
|
"listen_port": 2080
|
||||||
|
}
|
||||||
|
],
|
||||||
|
"outbounds": [
|
||||||
|
{
|
||||||
|
"type": "shadowsocks",
|
||||||
|
"server": "127.0.0.1",
|
||||||
|
"server_port": 8080,
|
||||||
|
"method": "2022-blake3-aes-128-gcm",
|
||||||
|
"password": "8JCsPssfgS8tiRwiMlhARg==:BXYxVUXJ9NgF7c7KPLQjkg=="
|
||||||
|
}
|
||||||
|
]
|
||||||
|
}
|
||||||
|
|
||||||
|
```
|
||||||
|
|
||||||
|
## Relay
|
||||||
|
|
||||||
|
#### Server
|
||||||
|
|
||||||
|
```json
|
||||||
|
{
|
||||||
|
"inbounds": [
|
||||||
|
{
|
||||||
|
"type": "shadowsocks",
|
||||||
|
"listen": "::",
|
||||||
|
"listen_port": 8080,
|
||||||
|
"method": "2022-blake3-aes-128-gcm",
|
||||||
|
"password": "8JCsPssfgS8tiRwiMlhARg=="
|
||||||
|
}
|
||||||
|
]
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
#### Relay
|
||||||
|
|
||||||
|
```json
|
||||||
|
{
|
||||||
|
"inbounds": [
|
||||||
|
{
|
||||||
|
"type": "shadowsocks",
|
||||||
|
"listen": "::",
|
||||||
|
"listen_port": 8081,
|
||||||
|
"method": "2022-blake3-aes-128-gcm",
|
||||||
|
"password": "BXYxVUXJ9NgF7c7KPLQjkg==",
|
||||||
|
"destinations": [
|
||||||
|
{
|
||||||
|
"name": "my_server",
|
||||||
|
"password": "8JCsPssfgS8tiRwiMlhARg==",
|
||||||
|
"server": "127.0.0.1",
|
||||||
|
"server_port": 8080
|
||||||
|
}
|
||||||
|
]
|
||||||
|
}
|
||||||
|
]
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
#### Client
|
||||||
|
|
||||||
|
```json
|
||||||
|
{
|
||||||
|
"inbounds": [
|
||||||
|
{
|
||||||
|
"type": "mixed",
|
||||||
|
"listen": "::",
|
||||||
|
"listen_port": 2080
|
||||||
|
}
|
||||||
|
],
|
||||||
|
"outbounds": [
|
||||||
|
{
|
||||||
|
"type": "shadowsocks",
|
||||||
|
"server": "127.0.0.1",
|
||||||
|
"server_port": 8081,
|
||||||
|
"method": "2022-blake3-aes-128-gcm",
|
||||||
|
"password": "8JCsPssfgS8tiRwiMlhARg==:BXYxVUXJ9NgF7c7KPLQjkg=="
|
||||||
|
}
|
||||||
|
]
|
||||||
|
}
|
||||||
|
|
||||||
|
```
|
||||||
|
|
@ -7,6 +7,8 @@
|
||||||
"type": "shadowtls",
|
"type": "shadowtls",
|
||||||
"listen": "::",
|
"listen": "::",
|
||||||
"listen_port": 4443,
|
"listen_port": 4443,
|
||||||
|
"version": 2,
|
||||||
|
"password": "fuck me till the daylight",
|
||||||
"handshake": {
|
"handshake": {
|
||||||
"server": "google.com",
|
"server": "google.com",
|
||||||
"server_port": 443
|
"server_port": 443
|
||||||
|
|
@ -45,6 +47,8 @@
|
||||||
"tag": "shadowtls-out",
|
"tag": "shadowtls-out",
|
||||||
"server": "127.0.0.1",
|
"server": "127.0.0.1",
|
||||||
"server_port": 4443,
|
"server_port": 4443,
|
||||||
|
"version": 2,
|
||||||
|
"password": "fuck me till the daylight",
|
||||||
"tls": {
|
"tls": {
|
||||||
"enabled": true,
|
"enabled": true,
|
||||||
"server_name": "google.com"
|
"server_name": "google.com"
|
||||||
|
|
|
||||||
|
|
@ -1,21 +0,0 @@
|
||||||
```json
|
|
||||||
{
|
|
||||||
"inbounds": [
|
|
||||||
{
|
|
||||||
"type": "mixed",
|
|
||||||
"listen": "::",
|
|
||||||
"listen_port": 2080
|
|
||||||
}
|
|
||||||
],
|
|
||||||
"outbounds": [
|
|
||||||
{
|
|
||||||
"type": "shadowsocks",
|
|
||||||
"server": "::",
|
|
||||||
"server_port": 8080,
|
|
||||||
"method": "2022-blake3-aes-128-gcm",
|
|
||||||
"password": "8JCsPssfgS8tiRwiMlhARg=="
|
|
||||||
}
|
|
||||||
]
|
|
||||||
}
|
|
||||||
|
|
||||||
```
|
|
||||||
|
|
@ -1,13 +0,0 @@
|
||||||
```json
|
|
||||||
{
|
|
||||||
"inbounds": [
|
|
||||||
{
|
|
||||||
"type": "shadowsocks",
|
|
||||||
"listen": "::",
|
|
||||||
"listen_port": 8080,
|
|
||||||
"method": "2022-blake3-aes-128-gcm",
|
|
||||||
"password": "8JCsPssfgS8tiRwiMlhARg=="
|
|
||||||
}
|
|
||||||
]
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
@ -10,9 +10,18 @@
|
||||||
"tag": "local",
|
"tag": "local",
|
||||||
"address": "223.5.5.5",
|
"address": "223.5.5.5",
|
||||||
"detour": "direct"
|
"detour": "direct"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"tag": "block",
|
||||||
|
"address": "rcode://success"
|
||||||
}
|
}
|
||||||
],
|
],
|
||||||
"rules": [
|
"rules": [
|
||||||
|
{
|
||||||
|
"geosite": "category-ads-all",
|
||||||
|
"server": "block",
|
||||||
|
"disable_cache": true
|
||||||
|
},
|
||||||
{
|
{
|
||||||
"domain": "mydomain.com",
|
"domain": "mydomain.com",
|
||||||
"geosite": "cn",
|
"geosite": "cn",
|
||||||
|
|
@ -26,6 +35,7 @@
|
||||||
"type": "tun",
|
"type": "tun",
|
||||||
"inet4_address": "172.19.0.1/30",
|
"inet4_address": "172.19.0.1/30",
|
||||||
"auto_route": true,
|
"auto_route": true,
|
||||||
|
"strict_route": false,
|
||||||
"sniff": true
|
"sniff": true
|
||||||
}
|
}
|
||||||
],
|
],
|
||||||
|
|
@ -58,13 +68,16 @@
|
||||||
"outbound": "dns-out"
|
"outbound": "dns-out"
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
"geosite": "category-ads-all",
|
"geosite": "cn",
|
||||||
"outbound": "block"
|
"geoip": [
|
||||||
|
"private",
|
||||||
|
"cn"
|
||||||
|
],
|
||||||
|
"outbound": "direct"
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
"geosite": "cn",
|
"geosite": "category-ads-all",
|
||||||
"geoip": "cn",
|
"outbound": "block"
|
||||||
"outbound": "direct"
|
|
||||||
}
|
}
|
||||||
],
|
],
|
||||||
"auto_detect_interface": true
|
"auto_detect_interface": true
|
||||||
|
|
@ -7,11 +7,11 @@ the public internet.
|
||||||
|
|
||||||
##### on Android
|
##### on Android
|
||||||
|
|
||||||
`auto-route` cannot automatically hijack DNS requests when Android's `Private DNS` is enabled.
|
`auto-route` cannot automatically hijack DNS requests when Android's `Private DNS` enabled or `strict_route` disabled.
|
||||||
|
|
||||||
##### on Linux
|
##### on Linux
|
||||||
|
|
||||||
`auto-route` cannot automatically hijack DNS requests with `systemd-resolved` enabled, you can switch to NetworkManager.
|
`auto-route` cannot automatically hijack DNS requests with `systemd-resolved` enabled and `strict_route` disabled.
|
||||||
|
|
||||||
#### System proxy
|
#### System proxy
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -6,11 +6,11 @@
|
||||||
|
|
||||||
##### Android
|
##### Android
|
||||||
|
|
||||||
`auto-route` 无法自动劫持 DNS 请求如果 `私人 DNS` 开启.
|
`auto-route` 无法自动劫持 DNS 请求如果 `私人 DNS` 开启或 `strict_route` 禁用。
|
||||||
|
|
||||||
##### Linux
|
##### Linux
|
||||||
|
|
||||||
`auto-route` 无法自动劫持 DNS 请求如果 `systemd-resolved` 开启, 您可以切换到 NetworkManager.
|
`auto-route` 无法自动劫持 DNS 请求如果 `systemd-resolved` 开启且 `strict_route` 禁用。
|
||||||
|
|
||||||
#### 系统代理
|
#### 系统代理
|
||||||
|
|
||||||
|
|
|
||||||
11
mkdocs.yml
11
mkdocs.yml
|
|
@ -97,11 +97,11 @@ nav:
|
||||||
- Examples:
|
- Examples:
|
||||||
- examples/index.md
|
- examples/index.md
|
||||||
- Linux Server Installation: examples/linux-server-installation.md
|
- Linux Server Installation: examples/linux-server-installation.md
|
||||||
- Shadowsocks Server: examples/ss-server.md
|
- Tun: examples/tun.md
|
||||||
- Shadowsocks Client: examples/ss-client.md
|
|
||||||
- Shadowsocks Tun: examples/ss-tun.md
|
|
||||||
- ShadowTLS: examples/shadowtls.md
|
|
||||||
- DNS Hijack: examples/dns-hijack.md
|
- DNS Hijack: examples/dns-hijack.md
|
||||||
|
- Shadowsocks: examples/shadowsocks.md
|
||||||
|
- ShadowTLS: examples/shadowtls.md
|
||||||
|
- Clash API: examples/clash-api.md
|
||||||
- Contributing:
|
- Contributing:
|
||||||
- contributing/index.md
|
- contributing/index.md
|
||||||
- Developing:
|
- Developing:
|
||||||
|
|
@ -168,7 +168,4 @@ plugins:
|
||||||
Known Issues: 已知问题
|
Known Issues: 已知问题
|
||||||
Examples: 示例
|
Examples: 示例
|
||||||
Linux Server Installation: Linux 服务器安装
|
Linux Server Installation: Linux 服务器安装
|
||||||
Shadowsocks Server: Shadowsocks 服务器
|
|
||||||
Shadowsocks Client: Shadowsocks 客户端
|
|
||||||
Shadowsocks Tun: Shadowsocks Tun
|
|
||||||
DNS Hijack: DNS 劫持
|
DNS Hijack: DNS 劫持
|
||||||
Loading…
Reference in a new issue