black-internet-days-ahead/sing-box
1
0
Fork 0
mirror of https://github.com/SagerNet/sing-box.git synced 2024-11-22 16:41:30 +00:00
Code Issues Packages Projects Releases Wiki Activity

Update documentation

Browse source
This commit is contained in:
世界 2022-08-26 11:10:02 +08:00
parent 07a0381f8b
commit 9d8d1cd69d
No known key found for this signature in database
GPG key ID: CD109927C34A63C4
13 changed files with 38 additions and 30 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
docs/configuration/dns/server.zh.md
View file

@ -47,7 +47,7 @@ DNS 服务器的地址。
!!! warning "" !!! warning ""
默认安装不包含 QUIC 和 HTTP3 传输层，请参阅 [安装](/zh/#installation)。 默认安装不包含 QUIC 和 HTTP3 传输层，请参阅 [安装](/zh/#_2)。
!!! info "" !!! info ""

2
docs/configuration/experimental/index.zh.md
View file

@ -18,7 +18,7 @@
!!! error "" !!! error ""
默认安装不包含 Clash API，参阅 [安装](/zh/#installation)。 默认安装不包含 Clash API，参阅 [安装](/zh/#_2)。
!!! note "" !!! note ""

2
docs/configuration/inbound/hysteria.zh.md
View file

@ -32,7 +32,7 @@
!!! warning "" !!! warning ""
默认安装不包含被 Hysteria 依赖的 QUIC，参阅 [安装](/zh/#installation)。 默认安装不包含被 Hysteria 依赖的 QUIC，参阅 [安装](/zh/#_2)。
### Hysteria 字段 ### Hysteria 字段

2
docs/configuration/inbound/naive.zh.md
View file

@ -30,7 +30,7 @@
!!! warning "" !!! warning ""
默认安装不包含 HTTP3 传输层, 参阅 [安装](/zh/#installation)。 默认安装不包含 HTTP3 传输层, 参阅 [安装](/zh/#_2)。
### Naive 字段 ### Naive 字段

2
docs/configuration/inbound/tun.zh.md
View file

@ -107,7 +107,7 @@ TCP/IP 栈。
!!! warning "" !!! warning ""
默认安装不包含 LWIP 栈，请参阅 [安装](/zh/#installation)。 默认安装不包含 LWIP 栈，请参阅 [安装](/zh/#_2)。
#### include_uid #### include_uid

2
docs/configuration/outbound/hysteria.zh.md
View file

@ -38,7 +38,7 @@
!!! warning "" !!! warning ""
默认安装不包含被 Hysteria 依赖的 QUIC，参阅 [安装](/zh/#installation)。 默认安装不包含被 Hysteria 依赖的 QUIC，参阅 [安装](/zh/#_2)。
### Hysteria 字段 ### Hysteria 字段

2
docs/configuration/outbound/tor.zh.md
View file

@ -30,7 +30,7 @@
!!! info "" !!! info ""
默认安装不包含嵌入式 Tor, 参阅 [安装](/zh/#installation)。 默认安装不包含嵌入式 Tor, 参阅 [安装](/zh/#_2)。
### Tor 字段 ### Tor 字段

2
docs/configuration/outbound/wireguard.zh.md
View file

@ -35,7 +35,7 @@
!!! warning "" !!! warning ""
默认安装不包含 WireGuard, 参阅 [安装](/zh/#installation)。 默认安装不包含 WireGuard, 参阅 [安装](/zh/#_2)。
### WireGuard 字段 ### WireGuard 字段

2
docs/configuration/shared/tls.zh.md
View file

@ -32,7 +32,7 @@
!!! warning "" !!! warning ""
默认安装不包含 ACME，参阅 [安装](/zh/#installation)。 默认安装不包含 ACME，参阅 [安装](/zh/#_2)。
### 出站 ### 出站

4
docs/configuration/shared/v2ray-transport.md
View file

@ -108,6 +108,10 @@ It needs to be consistent with the server.
} }
``` ```
!!! warning ""
QUIC is not included by default, see [Installation](/#installation).
!!! warning "Difference from v2ray-core" !!! warning "Difference from v2ray-core"
No additional encryption support: No additional encryption support:

6
docs/configuration/shared/v2ray-transport.zh.md
View file

@ -107,6 +107,10 @@ HTTP 请求的额外标头。
} }
``` ```
!!! warning ""
默认安装不包含 QUIC, 参阅 [安装](/zh/#_2)。
!!! warning "与 v2ray-core 的区别" !!! warning "与 v2ray-core 的区别"
没有额外的加密支持： 没有额外的加密支持：
@ -116,7 +120,7 @@ HTTP 请求的额外标头。
!!! warning "" !!! warning ""
默认安装不包含 gRPC, 参阅 [安装](/zh/#installation)。 默认安装不包含 gRPC, 参阅 [安装](/zh/#_2)。
```json ```json
{ {

20
docs/index.md
View file

@ -22,16 +22,16 @@ Install with options:
go install -v -tags with_clash_api github.com/sagernet/sing-box/cmd/sing-box@latest go install -v -tags with_clash_api github.com/sagernet/sing-box/cmd/sing-box@latest
``` ```
| Build Tag | Description | | 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) and [Hysteria Outbound](./configuration/outbound/hysteria). | | `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 gRPC support, see [V2Ray Transport#gRPC](/configuration/shared/v2ray-transport#grpc). | | `with_grpc` | Build with gRPC support, see [V2Ray Transport#gRPC](./configuration/shared/v2ray-transport#grpc). |
| `with_wireguard` | Build with WireGuard support, see [WireGuard outbound](./configuration/outbound/wireguard). | | `with_wireguard` | Build with WireGuard support, see [WireGuard outbound](./configuration/outbound/wireguard). |
| `with_acme` | Build with ACME TLS certificate issuer 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_clash_api` | Build with Clash API support, see [Experimental](./configuration/experimental#clash-api-fields). |
| `no_gvisor` | Build without gVisor Tun stack support, see [Tun inbound](./configuration/inbound/tun#stack). | | `no_gvisor` | Build without gVisor Tun stack support, see [Tun inbound](./configuration/inbound/tun#stack). |
| `with_embedded_tor` (CGO required) | Build with embedded Tor support, see [Tor outbound](./configuration/outbound/tor). | | `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). | | `with_lwip` (CGO required) | Build with LWIP Tun stack support, see [Tun inbound](./configuration/inbound/tun#stack). |
The binary is built under $GOPATH/bin The binary is built under $GOPATH/bin

20
docs/index.zh.md
View file

@ -22,16 +22,16 @@ go install -v github.com/sagernet/sing-box/cmd/sing-box@latest
go install -v -tags with_clash_api github.com/sagernet/sing-box/cmd/sing-box@latest 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)。 | | `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_grpc` | 启用 gRPC 支持，参阅 [V2Ray 传输层#gRPC](./configuration/shared/v2ray-transport#grpc)。 |
| `with_wireguard` | 启用 WireGuard 支持，参阅 [WireGuard 出站](./configuration/outbound/wireguard)。 | | `with_wireguard` | 启用 WireGuard 支持，参阅 [WireGuard 出站](./configuration/outbound/wireguard)。 |
| `with_acme` | 启用 ACME TLS 证书签发支持，参阅 [TLS](./configuration/shared/tls)。 | | `with_acme` | 启用 ACME TLS 证书签发支持，参阅 [TLS](./configuration/shared/tls)。 |
| `with_clash_api` | 启用 Clash api 支持，参阅 [实验性](./configuration/experimental#clash-api-fields)。 | | `with_clash_api` | 启用 Clash api 支持，参阅 [实验性](./configuration/experimental#clash-api-fields)。 |
| `no_gvisor` | 禁用 gVisor Tun 栈支持，参阅 [Tun 入站](./configuration/inbound/tun#stack)。 | | `no_gvisor` | 禁用 gVisor Tun 栈支持，参阅 [Tun 入站](./configuration/inbound/tun#stack)。 |
| `with_embedded_tor` (需要 CGO) | 启用 嵌入式 Tor 支持，参阅 [Tor 出站](./configuration/outbound/tor)。 | | `with_embedded_tor` (需要 CGO) | 启用 嵌入式 Tor 支持，参阅 [Tor 出站](./configuration/outbound/tor)。 |
| `with_lwip` (需要 CGO) | 启用 LWIP Tun 栈支持，参阅 [Tun 入站](./configuration/inbound/tun#stack)。 | | `with_lwip` (需要 CGO) | 启用 LWIP Tun 栈支持，参阅 [Tun 入站](./configuration/inbound/tun#stack)。 |
二进制文件将被构建在 `$GOPATH/bin` 下。 二进制文件将被构建在 `$GOPATH/bin` 下。