Skip to content

Commit ac7cc09

Browse files
nekohasekainekohasekai
committed
Update documentation
1 parent d032e35 commit ac7cc09

File tree

9 files changed

+181
-82
lines changed

9 files changed

+181
-82
lines changed

‎docs/assets/icon.svg

+37
Loading

‎docs/changelog.md

+13
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,16 @@
1+
#### 1.2-beta6
2+
3+
* Introducing our [new iOS client application](/installation/clients/sfi)
4+
* Add [platform options](/configuration/inbound/tun#platform) for tun inbound
5+
* Add custom TLS server support for http based v2ray transports
6+
* Add generate commands
7+
* Enable XUDP by default in VLESS
8+
* Update reality server
9+
* Update vision protocol
10+
* Fixed [user flow in vless server](/configuration/inbound/vless#usersflow)
11+
* Bug fixes
12+
* Update dependencies
13+
114
#### 1.2-beta5
215

316
* Add [VLESS server](/configuration/inbound/vless) and [vision](/configuration/outbound/vless#flow) support

‎docs/index.md

-40
Original file line numberDiff line numberDiff line change
@@ -8,46 +8,6 @@ Welcome to the wiki page for the sing-box project.
88

99
The universal proxy platform.
1010

11-
## Installation
12-
13-
sing-box requires Golang **1.18.5** or a higher version.
14-
15-
```bash
16-
go install -v github.com/sagernet/sing-box/cmd/sing-box@latest
17-
```
18-
19-
Install with options:
20-
21-
```bash
22-
go install -v -tags with_clash_api github.com/sagernet/sing-box/cmd/sing-box@latest
23-
```
24-
25-
| Build Tag | Description |
26-
|------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
27-
| `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). |
28-
| `with_grpc` | Build with standard gRPC support, see [V2Ray Transport#gRPC](./configuration/shared/v2ray-transport#grpc). |
29-
| `with_dhcp` | Build with DHCP support, see [DHCP DNS transport](./configuration/dns/server). |
30-
| `with_wireguard` | Build with WireGuard support, see [WireGuard outbound](./configuration/outbound/wireguard). |
31-
| `with_shadowsocksr` | Build with ShadowsocksR support, see [ShadowsocksR outbound](./configuration/outbound/shadowsocksr). |
32-
| `with_ech` | Build with TLS ECH extension support for TLS outbound, see [TLS](./configuration/shared/tls#ech). |
33-
| `with_utls` | Build with [uTLS](https://github.com/refraction-networking/utls) support for TLS outbound, see [TLS](./configuration/shared/tls#utls). |
34-
| `with_reality_server` | Build with reality TLS server support, see [TLS](./configuration/shared/tls). |
35-
| `with_acme` | Build with ACME TLS certificate issuer support, see [TLS](./configuration/shared/tls). |
36-
| `with_clash_api` | Build with Clash API support, see [Experimental](./configuration/experimental#clash-api-fields). |
37-
| `with_v2ray_api` | Build with V2Ray API support, see [Experimental](./configuration/experimental#v2ray-api-fields). |
38-
| `with_gvisor` | Build with gVisor support, see [Tun inbound](./configuration/inbound/tun#stack) and [WireGuard outbound](./configuration/outbound/wireguard#system_interface). |
39-
| `with_embedded_tor` (CGO required) | Build with embedded Tor support, see [Tor outbound](./configuration/outbound/tor). |
40-
| `with_lwip` (CGO required) | Build with LWIP Tun stack support, see [Tun inbound](./configuration/inbound/tun#stack). |
41-
42-
The binary is built under $GOPATH/bin
43-
44-
```bash
45-
sing-box version
46-
```
47-
48-
It is also recommended to use systemd to manage sing-box service,
49-
see [Linux server installation example](./examples/linux-server-installation).
50-
5111
## License
5212

5313
```

‎docs/index.zh.md

-40
Original file line numberDiff line numberDiff line change
@@ -8,46 +8,6 @@ description: 欢迎来到该 sing-box 项目的文档页。
88

99
通用代理平台。
1010

11-
## 安装
12-
13-
sing-box 需要 Golang **1.18.5** 或更高版本。
14-
15-
```bash
16-
go install -v github.com/sagernet/sing-box/cmd/sing-box@latest
17-
```
18-
19-
自定义安装：
20-
21-
```bash
22-
go install -v -tags with_clash_api github.com/sagernet/sing-box/cmd/sing-box@latest
23-
```
24-
25-
| 构建标志 | 描述 |
26-
|------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
27-
| `with_quic` | 启用 QUIC 支持，参阅 [QUIC 和 HTTP3 DNS 传输层](./configuration/dns/server)，[Naive 入站](./configuration/inbound/naive)，[Hysteria 入站](./configuration/inbound/hysteria)，[Hysteria 出站](./configuration/outbound/hysteria) 和 [V2Ray 传输层#QUIC](./configuration/shared/v2ray-transport#quic)。 |
28-
| `with_grpc` | 启用标准 gRPC 支持，参阅 [V2Ray 传输层#gRPC](./configuration/shared/v2ray-transport#grpc)。 |
29-
| `with_dhcp` | 启用 DHCP 支持，参阅 [DHCP DNS 传输层](./configuration/dns/server)。 |
30-
| `with_wireguard` | 启用 WireGuard 支持，参阅 [WireGuard 出站](./configuration/outbound/wireguard)。 |
31-
| `with_shadowsocksr` | 启用 ShadowsocksR 支持，参阅 [ShadowsocksR 出站](./configuration/outbound/shadowsocksr)。 |
32-
| `with_ech` | 启用 TLS ECH 扩展支持，参阅 [TLS](./configuration/shared/tls#ech)。 |
33-
| `with_utls` | 启用 [uTLS](https://github.com/refraction-networking/utls) 支持，参阅 [TLS](./configuration/shared/tls#utls)。 |
34-
| `with_reality_server` | 启用 reality TLS 服务器支持，参阅 [TLS](./configuration/shared/tls)。 |
35-
| `with_acme` | 启用 ACME TLS 证书签发支持，参阅 [TLS](./configuration/shared/tls)。 |
36-
| `with_clash_api` | 启用 Clash API 支持，参阅 [实验性](./configuration/experimental#clash-api-fields)。 |
37-
| `with_v2ray_api` | 启用 V2Ray API 支持，参阅 [实验性](./configuration/experimental#v2ray-api-fields)。 |
38-
| `with_gvisor` | 启用 gVisor 支持，参阅 [Tun 入站](./configuration/inbound/tun#stack) 和 [WireGuard 出站](./configuration/outbound/wireguard#system_interface)。 |
39-
| `with_embedded_tor` (需要 CGO) | 启用 嵌入式 Tor 支持，参阅 [Tor 出站](./configuration/outbound/tor)。 |
40-
| `with_lwip` (需要 CGO) | 启用 LWIP Tun 栈支持，参阅 [Tun 入站](./configuration/inbound/tun#stack)。 |
41-
42-
二进制文件将被构建在 `$GOPATH/bin` 下。
43-
44-
```bash
45-
sing-box version
46-
```
47-
48-
同时推荐使用 systemd 来管理 sing-box 服务器实例。
49-
参阅 [Linux 服务器安装示例](./examples/linux-server-installation)。
50-
5111
## 授权
5212

5313
```

‎docs/installation/clients/sfi/index.md

+21
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
# SFI
2+
3+
Experimental official iOS client for sing-box.
4+
5+
#### Requirements
6+
7+
* iOS 15.0+
8+
* macOS 12.0+ with Apple Silicon
9+
10+
#### Download
11+
12+
* [TestFlight](https://testflight.apple.com/join/c6ylui2j)
13+
14+
#### Limit
15+
16+
* `system` tun stack not working
17+
18+
#### Privacy policy
19+
20+
* SFI did not collect or share personal data.
21+
* The data generated by the software is always on your device.

‎docs/installation/clients/sfi/index.zh.md

+21
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
# SFI
2+
3+
实验性的官方 iOS sing-box 客户端。
4+
5+
#### 要求
6+
7+
* iOS 15.0+
8+
* macOS 12.0+ with Apple Silicon
9+
10+
#### 下载
11+
12+
* [TestFlight](https://testflight.apple.com/join/c6ylui2j)
13+
14+
#### 限制
15+
16+
* `system` tun stack 不工作
17+
18+
#### 隐私政策
19+
20+
* SFI 不收集或共享个人数据。
21+
* 软件生成的数据始终在您的设备上。

0 commit comments

Comments
 (0)