From ac7cc09694f39b3f802cc56638c17e50bab41e0d Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E4=B8=96=E7=95=8C?= Date: Sun, 5 Mar 2023 21:48:36 +0800 Subject: [PATCH] Update documentation --- docs/assets/icon.svg | 37 +++++++++++++++++++++ docs/changelog.md | 13 ++++++++ docs/index.md | 40 ----------------------- docs/index.zh.md | 40 ----------------------- docs/installation/clients/sfi/index.md | 21 ++++++++++++ docs/installation/clients/sfi/index.zh.md | 21 ++++++++++++ docs/installation/from-source.md | 39 ++++++++++++++++++++++ docs/installation/from-source.zh.md | 39 ++++++++++++++++++++++ mkdocs.yml | 13 ++++++-- 9 files changed, 181 insertions(+), 82 deletions(-) create mode 100644 docs/assets/icon.svg create mode 100644 docs/installation/clients/sfi/index.md create mode 100644 docs/installation/clients/sfi/index.zh.md create mode 100644 docs/installation/from-source.md create mode 100644 docs/installation/from-source.zh.md diff --git a/docs/assets/icon.svg b/docs/assets/icon.svg new file mode 100644 index 00000000..146d085a --- /dev/null +++ b/docs/assets/icon.svg @@ -0,0 +1,37 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/docs/changelog.md b/docs/changelog.md index 4aeefd29..2ec2e9b9 100644 --- a/docs/changelog.md +++ b/docs/changelog.md @@ -1,3 +1,16 @@ +#### 1.2-beta6 + +* Introducing our [new iOS client application](/installation/clients/sfi) +* Add [platform options](/configuration/inbound/tun#platform) for tun inbound +* Add custom TLS server support for http based v2ray transports +* Add generate commands +* Enable XUDP by default in VLESS +* Update reality server +* Update vision protocol +* Fixed [user flow in vless server](/configuration/inbound/vless#usersflow) +* Bug fixes +* Update dependencies + #### 1.2-beta5 * Add [VLESS server](/configuration/inbound/vless) and [vision](/configuration/outbound/vless#flow) support diff --git a/docs/index.md b/docs/index.md index 6a7c0b70..d12e3e2d 100644 --- a/docs/index.md +++ b/docs/index.md @@ -8,46 +8,6 @@ Welcome to the wiki page for the sing-box project. The universal proxy platform. -## Installation - -sing-box requires Golang **1.18.5** or a higher version. - -```bash -go install -v github.com/sagernet/sing-box/cmd/sing-box@latest -``` - -Install with options: - -```bash -go install -v -tags with_clash_api github.com/sagernet/sing-box/cmd/sing-box@latest -``` - -| Build Tag | Description | -|------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| `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). | -| `with_grpc` | Build with standard gRPC support, see [V2Ray Transport#gRPC](./configuration/shared/v2ray-transport#grpc). | -| `with_dhcp` | Build with DHCP support, see [DHCP DNS transport](./configuration/dns/server). | -| `with_wireguard` | Build with WireGuard support, see [WireGuard outbound](./configuration/outbound/wireguard). | -| `with_shadowsocksr` | Build with ShadowsocksR support, see [ShadowsocksR outbound](./configuration/outbound/shadowsocksr). | -| `with_ech` | Build with TLS ECH extension support for TLS outbound, see [TLS](./configuration/shared/tls#ech). | -| `with_utls` | Build with [uTLS](https://github.com/refraction-networking/utls) support for TLS outbound, see [TLS](./configuration/shared/tls#utls). | -| `with_reality_server` | Build with reality TLS server support, see [TLS](./configuration/shared/tls). | -| `with_acme` | Build with ACME TLS certificate issuer support, see [TLS](./configuration/shared/tls). | -| `with_clash_api` | Build with Clash API support, see [Experimental](./configuration/experimental#clash-api-fields). | -| `with_v2ray_api` | Build with V2Ray API support, see [Experimental](./configuration/experimental#v2ray-api-fields). | -| `with_gvisor` | Build with gVisor support, see [Tun inbound](./configuration/inbound/tun#stack) and [WireGuard outbound](./configuration/outbound/wireguard#system_interface). | -| `with_embedded_tor` (CGO required) | Build with embedded Tor support, see [Tor outbound](./configuration/outbound/tor). | -| `with_lwip` (CGO required) | Build with LWIP Tun stack support, see [Tun inbound](./configuration/inbound/tun#stack). | - -The binary is built under $GOPATH/bin - -```bash -sing-box version -``` - -It is also recommended to use systemd to manage sing-box service, -see [Linux server installation example](./examples/linux-server-installation). - ## License ``` diff --git a/docs/index.zh.md b/docs/index.zh.md index d4b16983..894186b3 100644 --- a/docs/index.zh.md +++ b/docs/index.zh.md @@ -8,46 +8,6 @@ description: 欢迎来到该 sing-box 项目的文档页。 通用代理平台。 -## 安装 - -sing-box 需要 Golang **1.18.5** 或更高版本。 - -```bash -go install -v github.com/sagernet/sing-box/cmd/sing-box@latest -``` - -自定义安装： - -```bash -go install -v -tags with_clash_api github.com/sagernet/sing-box/cmd/sing-box@latest -``` - -| 构建标志 | 描述 | -|------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| `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)。 | -| `with_grpc` | 启用标准 gRPC 支持，参阅 [V2Ray 传输层#gRPC](./configuration/shared/v2ray-transport#grpc)。 | -| `with_dhcp` | 启用 DHCP 支持，参阅 [DHCP DNS 传输层](./configuration/dns/server)。 | -| `with_wireguard` | 启用 WireGuard 支持，参阅 [WireGuard 出站](./configuration/outbound/wireguard)。 | -| `with_shadowsocksr` | 启用 ShadowsocksR 支持，参阅 [ShadowsocksR 出站](./configuration/outbound/shadowsocksr)。 | -| `with_ech` | 启用 TLS ECH 扩展支持，参阅 [TLS](./configuration/shared/tls#ech)。 | -| `with_utls` | 启用 [uTLS](https://github.com/refraction-networking/utls) 支持，参阅 [TLS](./configuration/shared/tls#utls)。 | -| `with_reality_server` | 启用 reality TLS 服务器支持，参阅 [TLS](./configuration/shared/tls)。 | -| `with_acme` | 启用 ACME TLS 证书签发支持，参阅 [TLS](./configuration/shared/tls)。 | -| `with_clash_api` | 启用 Clash API 支持，参阅 [实验性](./configuration/experimental#clash-api-fields)。 | -| `with_v2ray_api` | 启用 V2Ray API 支持，参阅 [实验性](./configuration/experimental#v2ray-api-fields)。 | -| `with_gvisor` | 启用 gVisor 支持，参阅 [Tun 入站](./configuration/inbound/tun#stack) 和 [WireGuard 出站](./configuration/outbound/wireguard#system_interface)。 | -| `with_embedded_tor` (需要 CGO) | 启用 嵌入式 Tor 支持，参阅 [Tor 出站](./configuration/outbound/tor)。 | -| `with_lwip` (需要 CGO) | 启用 LWIP Tun 栈支持，参阅 [Tun 入站](./configuration/inbound/tun#stack)。 | - -二进制文件将被构建在 `$GOPATH/bin` 下。 - -```bash -sing-box version -``` - -同时推荐使用 systemd 来管理 sing-box 服务器实例。 -参阅 [Linux 服务器安装示例](./examples/linux-server-installation)。 - ## 授权 ``` diff --git a/docs/installation/clients/sfi/index.md b/docs/installation/clients/sfi/index.md new file mode 100644 index 00000000..e8708c8a --- /dev/null +++ b/docs/installation/clients/sfi/index.md @@ -0,0 +1,21 @@ +# SFI + +Experimental official iOS client for sing-box. + +#### Requirements + +* iOS 15.0+ +* macOS 12.0+ with Apple Silicon + +#### Download + +* [TestFlight](https://testflight.apple.com/join/c6ylui2j) + +#### Limit + +* `system` tun stack not working + +#### Privacy policy + +* SFI did not collect or share personal data. +* The data generated by the software is always on your device. diff --git a/docs/installation/clients/sfi/index.zh.md b/docs/installation/clients/sfi/index.zh.md new file mode 100644 index 00000000..0d164e9a --- /dev/null +++ b/docs/installation/clients/sfi/index.zh.md @@ -0,0 +1,21 @@ +# SFI + +实验性的官方 iOS sing-box 客户端。 + +#### 要求 + +* iOS 15.0+ +* macOS 12.0+ with Apple Silicon + +#### 下载 + +* [TestFlight](https://testflight.apple.com/join/c6ylui2j) + +#### 限制 + +* `system` tun stack 不工作 + +#### 隐私政策 + +* SFI 不收集或共享个人数据。 +* 软件生成的数据始终在您的设备上。 diff --git a/docs/installation/from-source.md b/docs/installation/from-source.md new file mode 100644 index 00000000..25e0cc5e --- /dev/null +++ b/docs/installation/from-source.md @@ -0,0 +1,39 @@ +# Install from source + +sing-box requires Golang **1.18.5** or a higher version. + +```bash +go install -v github.com/sagernet/sing-box/cmd/sing-box@latest +``` + +Install with options: + +```bash +go install -v -tags with_clash_api github.com/sagernet/sing-box/cmd/sing-box@latest +``` + +| Build Tag | Description | +|------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| `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). | +| `with_grpc` | Build with standard gRPC support, see [V2Ray Transport#gRPC](./configuration/shared/v2ray-transport#grpc). | +| `with_dhcp` | Build with DHCP support, see [DHCP DNS transport](./configuration/dns/server). | +| `with_wireguard` | Build with WireGuard support, see [WireGuard outbound](./configuration/outbound/wireguard). | +| `with_shadowsocksr` | Build with ShadowsocksR support, see [ShadowsocksR outbound](./configuration/outbound/shadowsocksr). | +| `with_ech` | Build with TLS ECH extension support for TLS outbound, see [TLS](./configuration/shared/tls#ech). | +| `with_utls` | Build with [uTLS](https://github.com/refraction-networking/utls) support for TLS outbound, see [TLS](./configuration/shared/tls#utls). | +| `with_reality_server` | Build with reality TLS server support, see [TLS](./configuration/shared/tls). | +| `with_acme` | Build with ACME TLS certificate issuer support, see [TLS](./configuration/shared/tls). | +| `with_clash_api` | Build with Clash API support, see [Experimental](./configuration/experimental#clash-api-fields). | +| `with_v2ray_api` | Build with V2Ray API support, see [Experimental](./configuration/experimental#v2ray-api-fields). | +| `with_gvisor` | Build with gVisor support, see [Tun inbound](./configuration/inbound/tun#stack) and [WireGuard outbound](./configuration/outbound/wireguard#system_interface). | +| `with_embedded_tor` (CGO required) | Build with embedded Tor support, see [Tor outbound](./configuration/outbound/tor). | +| `with_lwip` (CGO required) | Build with LWIP Tun stack support, see [Tun inbound](./configuration/inbound/tun#stack). | + +The binary is built under $GOPATH/bin + +```bash +sing-box version +``` + +It is also recommended to use systemd to manage sing-box service, +see [Linux server installation example](./examples/linux-server-installation). \ No newline at end of file diff --git a/docs/installation/from-source.zh.md b/docs/installation/from-source.zh.md new file mode 100644 index 00000000..3cb2f9d2 --- /dev/null +++ b/docs/installation/from-source.zh.md @@ -0,0 +1,39 @@ +# 从源代码安装 + +sing-box 需要 Golang **1.18.5** 或更高版本。 + +```bash +go install -v github.com/sagernet/sing-box/cmd/sing-box@latest +``` + +自定义安装： + +```bash +go install -v -tags with_clash_api github.com/sagernet/sing-box/cmd/sing-box@latest +``` + +| 构建标志 | 描述 | +|------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| `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)。 | +| `with_grpc` | 启用标准 gRPC 支持，参阅 [V2Ray 传输层#gRPC](./configuration/shared/v2ray-transport#grpc)。 | +| `with_dhcp` | 启用 DHCP 支持，参阅 [DHCP DNS 传输层](./configuration/dns/server)。 | +| `with_wireguard` | 启用 WireGuard 支持，参阅 [WireGuard 出站](./configuration/outbound/wireguard)。 | +| `with_shadowsocksr` | 启用 ShadowsocksR 支持，参阅 [ShadowsocksR 出站](./configuration/outbound/shadowsocksr)。 | +| `with_ech` | 启用 TLS ECH 扩展支持，参阅 [TLS](./configuration/shared/tls#ech)。 | +| `with_utls` | 启用 [uTLS](https://github.com/refraction-networking/utls) 支持，参阅 [TLS](./configuration/shared/tls#utls)。 | +| `with_reality_server` | 启用 reality TLS 服务器支持，参阅 [TLS](./configuration/shared/tls)。 | +| `with_acme` | 启用 ACME TLS 证书签发支持，参阅 [TLS](./configuration/shared/tls)。 | +| `with_clash_api` | 启用 Clash API 支持，参阅 [实验性](./configuration/experimental#clash-api-fields)。 | +| `with_v2ray_api` | 启用 V2Ray API 支持，参阅 [实验性](./configuration/experimental#v2ray-api-fields)。 | +| `with_gvisor` | 启用 gVisor 支持，参阅 [Tun 入站](./configuration/inbound/tun#stack) 和 [WireGuard 出站](./configuration/outbound/wireguard#system_interface)。 | +| `with_embedded_tor` (需要 CGO) | 启用 嵌入式 Tor 支持，参阅 [Tor 出站](./configuration/outbound/tor)。 | +| `with_lwip` (需要 CGO) | 启用 LWIP Tun 栈支持，参阅 [Tun 入站](./configuration/inbound/tun#stack)。 | + +二进制文件将被构建在 `$GOPATH/bin` 下。 + +```bash +sing-box version +``` + +同时推荐使用 systemd 来管理 sing-box 服务器实例。 +参阅 [Linux 服务器安装示例](./examples/linux-server-installation)。 \ No newline at end of file diff --git a/mkdocs.yml b/mkdocs.yml index 773534ba..4bd9f781 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -8,8 +8,8 @@ remote_branch: docs edit_uri: "" theme: name: material - icon: - logo: material/tools + logo: assets/icon.svg + favicon: assets/icon.svg palette: - scheme: default primary: white @@ -35,6 +35,11 @@ nav: - Features: features.md - Support: support.md - Change Log: changelog.md + - Installation: + - From source: installation/from-source.md + - Clients: + - SFI: + - installation/clients/sfi/index.md - Configuration: - configuration/index.md - Log: @@ -153,6 +158,10 @@ plugins: Support: 支持 Change Log: 更新日志 + Installation: 安装 + From source: 从源代码 + Clients: 客户端 + Configuration: 配置 Log: 日志 DNS Server: DNS 服务器