Fix zh-CN document symbol and format (#29)

This commit is contained in:
Reece 2022-08-25 09:45:22 +08:00 committed by GitHub
parent 97e284e65e
commit 31a2e368cc
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
40 changed files with 297 additions and 297 deletions

View file

@ -27,7 +27,7 @@
默认 DNS 服务器的标签。
将使用第一个服务器,如果为空
默认使用第一个服务器
#### strategy

View file

@ -110,7 +110,7 @@
4 (A DNS 查询) 或 6 (AAAA DNS 查询)。
为空则不限制。
默认不限制。
#### network
@ -142,7 +142,7 @@
#### geosite
匹配 GeoSite.
匹配 GeoSite
#### source_geoip
@ -172,7 +172,7 @@
!!! error ""
仅支持 Linux, Windows, 和 macOS.
仅支持 Linux、Windows 和 macOS.
匹配进程名称。
@ -184,7 +184,7 @@
!!! error ""
仅支持 Linux.
仅支持 Linux
匹配用户名。
@ -192,7 +192,7 @@
!!! error ""
仅支持 Linux.
仅支持 Linux
匹配用户 ID。
@ -212,7 +212,7 @@
#### disable_cache
在此查询中禁用缓存
在此查询中禁用缓存
### 逻辑字段

View file

@ -51,7 +51,7 @@ DNS 服务器的地址。
!!! info ""
RCode 传输层传输层常用于屏蔽请求. 与 DNS 规则和 `disable_cache` 规则选项一起使用.
RCode 传输层传输层常用于屏蔽请求. 与 DNS 规则和 `disable_cache` 规则选项一起使用
| RCode | 描述 |
|-------------------|----------|
@ -72,15 +72,15 @@ DNS 服务器的地址。
用于解析本 DNS 服务器的域名的策略。
可选项:`prefer_ipv4` `prefer_ipv6` `ipv4_only` `ipv6_only`.
可选项:`prefer_ipv4` `prefer_ipv6` `ipv4_only` `ipv6_only`
如果为空,将使用 `dns.strategy`.
默认使用 `dns.strategy`
#### strategy
默认解析策略。
可选项:`prefer_ipv4` `prefer_ipv6` `ipv4_only` `ipv6_only`.
可选项:`prefer_ipv4` `prefer_ipv6` `ipv4_only` `ipv6_only`
如果被其他设置覆盖则不生效。

View file

@ -18,7 +18,7 @@
!!! error ""
默认安装不包含 Clash API, 参阅 [安装](/zh/#installation).
默认安装不包含 Clash API,参阅 [安装](/zh/#installation)。
!!! note ""
@ -26,14 +26,14 @@
#### external_controller
RESTful web API 监听地址。 如果为空则禁用。
RESTful web API 监听地址。
#### external_ui
到静态网页资源目录的相对路径或绝对路径。 sing-box 会在 `http://{{external-controller}}/ui` 下提供它。
到静态网页资源目录的相对路径或绝对路径。sing-box 会在 `http://{{external-controller}}/ui` 下提供它。
#### secret
RESTful API 的密钥(可选)
通过指定 HTTP 标头 `Authorization: Bearer ${secret}` 进行身份验证
如果 RESTful API 正在监听 0.0.0.0,始终设置一个密钥。
如果 RESTful API 正在监听 0.0.0.0始终设置一个密钥。

View file

@ -36,11 +36,11 @@
#### override_address
覆盖连接目标地址
覆盖连接目标地址
#### override_port
覆盖连接目标端口
覆盖连接目标端口
### 监听字段
@ -48,17 +48,17 @@
==必填==
监听地址
监听地址
#### listen_port
==必填==
监听端口
监听端口
#### tcp_fast_open
为监听器启用 TCP 快速打开
为监听器启用 TCP 快速打开
#### sniff
@ -74,7 +74,7 @@
#### domain_strategy
可选值: `prefer_ipv4` `prefer_ipv6` `ipv4_only` `ipv6_only`.
可选值: `prefer_ipv4` `prefer_ipv6` `ipv4_only` `ipv6_only`
如果设置,请求的域名将在路由之前解析为 IP。

View file

@ -32,19 +32,19 @@
#### tls
TLS 配置, 参阅 [TLS](/zh/configuration/shared/tls/#inbound).
TLS 配置, 参阅 [TLS](/zh/configuration/shared/tls/#inbound)
#### users
HTTP 用户
如果为空则不需要验证。
默认不需要验证。
#### set_system_proxy
!!! error ""
仅支持 Linux, Android, Windows, 和 macOS.
仅支持 Linux、Android、Windows 和 macOS。
启动时自动设置系统代理,停止时自动清理。
@ -54,17 +54,17 @@ HTTP 用户
==必填==
监听地址
监听地址
#### listen_port
==必填==
监听端口
监听端口
#### tcp_fast_open
为监听器启用 TCP 快速打开
为监听器启用 TCP 快速打开
#### sniff
@ -80,7 +80,7 @@ HTTP 用户
#### domain_strategy
可选值: `prefer_ipv4` `prefer_ipv6` `ipv4_only` `ipv6_only`.
可选值: `prefer_ipv4` `prefer_ipv6` `ipv4_only` `ipv6_only`
如果设置,请求的域名将在路由之前解析为 IP。

View file

@ -32,7 +32,7 @@
!!! warning ""
默认安装不包含被 Hysteria 依赖的 QUIC, 参阅 [安装](/zh/#installation).
默认安装不包含被 Hysteria 依赖的 QUIC,参阅 [安装](/zh/#installation)。
### Hysteria 字段
@ -40,9 +40,9 @@
==必填==
格式: `[Integer] [Unit]` e.g. `100 Mbps, 640 KBps, 2 Gbps`
格式: `[Integer] [Unit]` 例如: `100 Mbps, 640 KBps, 2 Gbps`
支持的单位 (大小写敏感, b = bits, B = bytes, 8b=1B):
支持的单位 (大小写敏感, b = bits, B = bytes, 8b=1B)
bps (bits per second)
Bps (bytes per second)
@ -59,37 +59,37 @@
==必填==
以 Mbps 为单位的 `up, down`.
以 Mbps 为单位的 `up, down`
#### obfs
混淆密码
混淆密码
#### auth
base64 编码的认证密码
base64 编码的认证密码
#### auth_str
认证密码
认证密码
#### recv_window_conn
用于接收数据的 QUIC 流级流控制窗口。
如果为空,将使用 `15728640 (15 MB/s)`
默认 `15728640 (15 MB/s)`
#### recv_window_client
用于接收数据的 QUIC 连接级流控制窗口。
如果为空,将使用 `67108864 (64 MB/s)`
默认 `67108864 (64 MB/s)`
#### max_conn_client
允许对等点打开的 QUIC 并发双向流的最大数量。
如果为空,将使用 `1024`
默认 `1024`
#### disable_mtu_discovery
@ -101,7 +101,7 @@ base64 编码的认证密码
==必填==
TLS 配置, 参阅 [TLS](/zh/configuration/shared/tls/#inbound).
TLS 配置, 参阅 [TLS](/zh/configuration/shared/tls/#inbound)
### 监听字段
@ -109,19 +109,19 @@ TLS 配置, 参阅 [TLS](/zh/configuration/shared/tls/#inbound).
==必填==
监听地址
监听地址
#### listen_port
==必填==
监听端口
监听端口
#### sniff
启用协议探测。
参阅 [协议探测](/zh/configuration/route/sniff/)
参阅 [协议探测](/zh/configuration/route/sniff/)
#### sniff_override_destination
@ -131,7 +131,7 @@ TLS 配置, 参阅 [TLS](/zh/configuration/shared/tls/#inbound).
#### domain_strategy
可选值: `prefer_ipv4` `prefer_ipv6` `ipv4_only` `ipv6_only`.
可选值: `prefer_ipv4` `prefer_ipv6` `ipv4_only` `ipv6_only`
如果设置,请求的域名将在路由之前解析为 IP。

View file

@ -35,13 +35,13 @@
SOCKS 和 HTTP 用户
如果为空则不需要验证。
默认不需要验证。
#### set_system_proxy
!!! error ""
仅支持 Linux, Android, Windows, 和 macOS.
仅支持 Linux、Android、Windows 和 macOS。
启动时自动设置系统代理,停止时自动清理。
@ -51,23 +51,23 @@ SOCKS 和 HTTP 用户
==必填==
监听地址
监听地址
#### listen_port
==必填==
监听端口
监听端口
#### tcp_fast_open
为监听器启用 TCP 快速打开
为监听器启用 TCP 快速打开
#### sniff
启用协议探测。
参阅 [协议探测](/zh/configuration/route/sniff/)
参阅 [协议探测](/zh/configuration/route/sniff/)
#### sniff_override_destination
@ -77,7 +77,7 @@ SOCKS 和 HTTP 用户
#### domain_strategy
可选值: `prefer_ipv4` `prefer_ipv6` `ipv4_only` `ipv6_only`.
可选值: `prefer_ipv4` `prefer_ipv6` `ipv4_only` `ipv6_only`
如果设置,请求的域名将在路由之前解析为 IP。

View file

@ -30,7 +30,7 @@
!!! warning ""
默认安装不包含 HTTP3 传输层, 参阅 [安装](/zh/#installation).
默认安装不包含 HTTP3 传输层, 参阅 [安装](/zh/#installation)
### Naive 字段
@ -44,11 +44,11 @@
==必填==
Naive 用户
Naive 用户
#### tls
TLS 配置, 参阅 [TLS](/zh/configuration/shared/tls/#inbound).
TLS 配置, 参阅 [TLS](/zh/configuration/shared/tls/#inbound)
### 监听字段
@ -56,23 +56,23 @@ TLS 配置, 参阅 [TLS](/zh/configuration/shared/tls/#inbound).
==必填==
监听地址
监听地址
#### listen_port
==必填==
监听端口
监听端口
#### tcp_fast_open
为监听器启用 TCP 快速打开
为监听器启用 TCP 快速打开
#### sniff
启用协议探测。
参阅 [协议探测](/zh/configuration/route/sniff/)
参阅 [协议探测](/zh/configuration/route/sniff/)
#### sniff_override_destination
@ -82,7 +82,7 @@ TLS 配置, 参阅 [TLS](/zh/configuration/shared/tls/#inbound).
#### domain_strategy
可选值: `prefer_ipv4` `prefer_ipv6` `ipv4_only` `ipv6_only`.
可选值: `prefer_ipv4` `prefer_ipv6` `ipv4_only` `ipv6_only`
如果设置,请求的域名将在路由之前解析为 IP。

View file

@ -23,19 +23,19 @@
==必填==
监听地址
监听地址
#### listen_port
==必填==
监听端口
监听端口
#### sniff
启用协议探测。
参阅 [协议探测](/zh/configuration/route/sniff/)
参阅 [协议探测](/zh/configuration/route/sniff/)
#### sniff_override_destination
@ -45,7 +45,7 @@
#### domain_strategy
可选值: `prefer_ipv4` `prefer_ipv6` `ipv4_only` `ipv6_only`.
可选值: `prefer_ipv4` `prefer_ipv6` `ipv4_only` `ipv6_only`
如果设置,请求的域名将在路由之前解析为 IP。

View file

@ -106,23 +106,23 @@
==必填==
监听地址
监听地址
#### listen_port
==必填==
监听端口
监听端口
#### tcp_fast_open
为监听器启用 TCP 快速打开
为监听器启用 TCP 快速打开
#### sniff
启用协议探测。
参阅 [协议探测](/zh/configuration/route/sniff/)
参阅 [协议探测](/zh/configuration/route/sniff/)
#### sniff_override_destination
@ -132,7 +132,7 @@
#### domain_strategy
可选值: `prefer_ipv4` `prefer_ipv6` `ipv4_only` `ipv6_only`.
可选值: `prefer_ipv4` `prefer_ipv6` `ipv4_only` `ipv6_only`
如果设置,请求的域名将在路由之前解析为 IP。

View file

@ -34,46 +34,46 @@
SOCKS 用户
如果为空则不需要验证。
默认不需要验证。
### Listen Fields
#### listen
==Required==
==必填==
Listen address.
监听地址。
#### listen_port
==Required==
==必填==
Listen port.
监听端口。
#### tcp_fast_open
Enable tcp fast open for listener.
为监听器启用 TCP 快速打开。
#### sniff
Enable sniffing.
启用协议探测。
See [Protocol Sniff](/configuration/route/sniff/) for details.
参阅 [协议探测](/zh/configuration/route/sniff/)。
#### sniff_override_destination
Override the connection destination address with the sniffed domain.
用探测出的域名覆盖连接目标地址。
If the domain name is invalid (like tor), this will not work.
如果域名无效(如 Tor将不生效。
#### domain_strategy
One of `prefer_ipv4` `prefer_ipv6` `ipv4_only` `ipv6_only`.
可选值: `prefer_ipv4` `prefer_ipv6` `ipv4_only` `ipv6_only`
If set, the requested domain name will be resolved to IP before routing.
如果设置,请求的域名将在路由之前解析为 IP。
If `sniff_override_destination` is in effect, its value will be taken as a fallback.
如果 `sniff_override_destination` 生效,它的值将作为后备。
#### proxy_protocol
Parse [Proxy Protocol](https://www.haproxy.org/download/1.8/doc/proxy-protocol.txt) in the connection header.
解析连接头中的 [代理协议](https://www.haproxy.org/download/1.8/doc/proxy-protocol.txt)。

View file

@ -34,19 +34,19 @@
==必填==
监听地址
监听地址
#### listen_port
==必填==
监听端口
监听端口
#### sniff
启用协议探测。
参阅 [协议探测](/zh/configuration/route/sniff/)
参阅 [协议探测](/zh/configuration/route/sniff/)
#### sniff_override_destination
@ -56,7 +56,7 @@
#### domain_strategy
可选值: `prefer_ipv4` `prefer_ipv6` `ipv4_only` `ipv6_only`.
可选值: `prefer_ipv4` `prefer_ipv6` `ipv4_only` `ipv6_only`
如果设置,请求的域名将在路由之前解析为 IP。

View file

@ -38,13 +38,13 @@
==必填==
Trojan 用户.
Trojan 用户
#### tls
==如果启用 HTTP3 则必填==
TLS 配置, 参阅 [TLS](/zh/configuration/shared/tls/#inbound).
TLS 配置, 参阅 [TLS](/zh/configuration/shared/tls/#inbound)
#### fallback
@ -52,7 +52,7 @@ TLS 配置, 参阅 [TLS](/zh/configuration/shared/tls/#inbound).
没有证据表明 GFW 基于 HTTP 响应检测并阻止木马服务器,并且在服务器上打开标准 http/s 端口是一个更大的特征。
备用服务器配置。 如果为空则禁用。
备用服务器配置。默认禁用。
#### transport
@ -64,23 +64,23 @@ V2Ray 传输配置,参阅 [V2Ray 传输层](/zh/configuration/shared/v2ray-tra
==必填==
监听地址
监听地址
#### listen_port
==必填==
监听端口
监听端口
#### tcp_fast_open
为监听器启用 TCP 快速打开
为监听器启用 TCP 快速打开
#### sniff
启用协议探测。
参阅 [协议探测](/zh/configuration/route/sniff/)
参阅 [协议探测](/zh/configuration/route/sniff/)
#### sniff_override_destination
@ -90,7 +90,7 @@ V2Ray 传输配置,参阅 [V2Ray 传输层](/zh/configuration/shared/v2ray-tra
#### domain_strategy
可选值: `prefer_ipv4` `prefer_ipv6` `ipv4_only` `ipv6_only`.
可选值: `prefer_ipv4` `prefer_ipv6` `ipv4_only` `ipv6_only`
如果设置,请求的域名将在路由之前解析为 IP。

View file

@ -1,6 +1,6 @@
!!! error ""
仅支持 Linux, Windows, 和 macOS.
仅支持 Linux、Windows 和 macOS。
### 结构
@ -52,7 +52,7 @@
!!! note ""
当内容只有一项时,可以忽略 JSON 数组 [] 标签
当内容只有一项时,可以忽略 JSON 数组 [] 标签
!!! warning ""
@ -62,7 +62,7 @@
#### interface_name
虚拟设备名称,如果为空则自动选择。
虚拟设备名称,默认自动选择。
#### inet4_address
@ -76,7 +76,7 @@ tun 接口的 IPv6 前缀。
#### mtu
最大传输单元
最大传输单元
#### auto_route
@ -84,7 +84,7 @@ tun 接口的 IPv6 前缀。
!!! error ""
为避免流量环回,请设置 `route.auto_detect_interface``route.default_interface``outbound.bind_interface`
为避免流量环回,请设置 `route.auto_detect_interface``route.default_interface``outbound.bind_interface`
#### endpoint_independent_nat
@ -98,7 +98,7 @@ UDP NAT 过期时间,以秒为单位,默认为 3005 分钟)。
#### stack
TCP/IP 栈.
TCP/IP 栈
| 栈 | 上游 | 状态 |
|------------------|-----------------------------------------------------------------------|-------|
@ -107,15 +107,15 @@ TCP/IP 栈.
!!! warning ""
默认安装不包含 LWIP 栈, 请参阅 [安装](/zh/#installation)。
默认安装不包含 LWIP 栈,请参阅 [安装](/zh/#installation)。
#### include_uid
!!! error ""
UID 规则仅在 Linux 下被支持,并且需要 `auto_route`.
UID 规则仅在 Linux 下被支持,并且需要 `auto_route`
限制被路由的的用户。 默认不限制。
限制被路由的的用户。默认不限制。
#### include_uid_range
@ -133,7 +133,7 @@ TCP/IP 栈.
!!! error ""
Android 用户和应用规则仅在 Android 下被支持,并且需要 `auto_route`.
Android 用户和应用规则仅在 Android 下被支持,并且需要 `auto_route`
限制被路由的 Android 用户。
@ -156,7 +156,7 @@ TCP/IP 栈.
启用协议探测。
参阅 [协议探测](/zh/configuration/route/sniff/)
参阅 [协议探测](/zh/configuration/route/sniff/)
#### sniff_override_destination
@ -166,7 +166,7 @@ TCP/IP 栈.
#### domain_strategy
可选值: `prefer_ipv4` `prefer_ipv6` `ipv4_only` `ipv6_only`.
可选值: `prefer_ipv4` `prefer_ipv6` `ipv4_only` `ipv6_only`
如果设置,请求的域名将在路由之前解析为 IP。

View file

@ -35,7 +35,7 @@
==必填==
VMess 用户.
VMess 用户
| Alter ID | 描述 |
|----------|-------|
@ -48,7 +48,7 @@ VMess 用户.
#### tls
TLS 配置, 参阅 [TLS](/zh/configuration/shared/tls/#inbound).
TLS 配置, 参阅 [TLS](/zh/configuration/shared/tls/#inbound)
#### transport
@ -60,23 +60,23 @@ V2Ray 传输配置,参阅 [V2Ray 传输层](/zh/configuration/shared/v2ray-tra
==必填==
监听地址
监听地址
#### listen_port
==必填==
监听端口
监听端口
#### tcp_fast_open
为监听器启用 TCP 快速打开
为监听器启用 TCP 快速打开
#### sniff
启用协议探测。
参阅 [协议探测](/zh/configuration/route/sniff/)
参阅 [协议探测](/zh/configuration/route/sniff/)
#### sniff_override_destination
@ -86,7 +86,7 @@ V2Ray 传输配置,参阅 [V2Ray 传输层](/zh/configuration/shared/v2ray-tra
#### domain_strategy
可选值: `prefer_ipv4` `prefer_ipv6` `ipv4_only` `ipv6_only`.
可选值: `prefer_ipv4` `prefer_ipv6` `ipv4_only` `ipv6_only`
如果设置,请求的域名将在路由之前解析为 IP。

View file

@ -1,6 +1,6 @@
# 引言
sing-box 使用 JSON 作为配置文件格式.
sing-box 使用 JSON 作为配置文件格式
### 结构

View file

@ -6,7 +6,7 @@
"disabled": false,
"level": "info",
"output": "box.log",
"timestamp": false
"timestamp": true
}
}
@ -20,7 +20,7 @@
#### level
日志等级,可选值:`trace` `debug` `info` `warn` `error` `fatal` `panic`.
日志等级,可选值:`trace` `debug` `info` `warn` `error` `fatal` `panic`
#### output

View file

@ -15,4 +15,4 @@
### 字段
No fields.

View file

@ -1,4 +1,4 @@
`block` 出站关闭所有传入请求
`block` 出站关闭所有传入请求
### 结构
@ -15,4 +15,4 @@
### 字段
字段。

View file

@ -1,4 +1,4 @@
`direct` 出站直接发送请求
`direct` 出站直接发送请求
### 结构
@ -31,17 +31,17 @@
#### override_address
覆盖连接目标地址
覆盖连接目标地址
#### override_port
覆盖连接目标端口
覆盖连接目标端口
#### proxy_protocol
写出 [代理协议](https://www.haproxy.org/download/1.8/doc/proxy-protocol.txt) 到连接头。
可用协议版本值: `1``2`.
可用协议版本值:`1` 或 `2`
### 拨号字段
@ -63,13 +63,13 @@
!!! error ""
仅支持 Linux.
仅支持 Linux
设置 netfilter 路由标记
设置 netfilter 路由标记
#### reuse_addr
重用监听地址
重用监听地址
#### connect_timeout
@ -80,11 +80,11 @@
#### domain_strategy
可选值:`prefer_ipv4` `prefer_ipv6` `ipv4_only` `ipv6_only`.
可选值:`prefer_ipv4` `prefer_ipv6` `ipv4_only` `ipv6_only`
如果设置,域名将在请求发出之前解析为 IP。
如果为空,将使用 `dns.strategy`
默认使用 `dns.strategy`
#### fallback_delay

View file

@ -15,8 +15,8 @@
!!! note ""
There are no outbound connections by the DNS outbound, all requests are handled internally.
DNS 出站没有出站连接,所有请求均在内部处理。
### Fields
### 字段
No fields.
无字段。

View file

@ -35,25 +35,25 @@
==必填==
服务器地址
服务器地址
#### server_port
==必填==
服务器端口
服务器端口
#### username
Basic 认证用户名
Basic 认证用户名
#### password
Basic 认证密码
Basic 认证密码
#### tls
TLS 配置, 参阅 [TLS](/zh/configuration/shared/tls/#outbound).
TLS 配置, 参阅 [TLS](/zh/configuration/shared/tls/#outbound)
### 拨号字段
@ -75,13 +75,13 @@ TLS 配置, 参阅 [TLS](/zh/configuration/shared/tls/#outbound).
!!! error ""
仅支持 Linux.
仅支持 Linux
设置 netfilter 路由标记
设置 netfilter 路由标记
#### reuse_addr
重用监听地址
重用监听地址
#### connect_timeout
@ -92,11 +92,11 @@ TLS 配置, 参阅 [TLS](/zh/configuration/shared/tls/#outbound).
#### domain_strategy
可选值:`prefer_ipv4` `prefer_ipv6` `ipv4_only` `ipv6_only`.
可选值:`prefer_ipv4` `prefer_ipv6` `ipv4_only` `ipv6_only`
如果设置,服务器域名将在连接前解析为 IP。
如果为空,将使用 `dns.strategy`
默认使用 `dns.strategy`
#### fallback_delay

View file

@ -38,7 +38,7 @@
!!! warning ""
默认安装不包含被 Hysteria 依赖的 QUIC, 参阅 [安装](/zh/#installation).
默认安装不包含被 Hysteria 依赖的 QUIC,参阅 [安装](/zh/#installation)。
### Hysteria 字段
@ -46,21 +46,21 @@
==必填==
服务器地址
服务器地址
#### server_port
==必填==
服务器端口
服务器端口
#### up, down
==必填==
格式: `[Integer] [Unit]` e.g. `100 Mbps, 640 KBps, 2 Gbps`
格式 `[Integer] [Unit]` 例如: `100 Mbps, 640 KBps, 2 Gbps`
支持的单位 (大小写敏感, b = bits, B = bytes, 8b=1B):
支持的单位 (大小写敏感, b = bits, B = bytes, 8b=1B)
bps (bits per second)
Bps (bytes per second)
@ -77,31 +77,31 @@
==必填==
以 Mbps 为单位的 `up, down`.
以 Mbps 为单位的 `up, down`
#### obfs
混淆密码
混淆密码
#### auth
base64 编码的认证密码
base64 编码的认证密码
#### auth_str
认证密码
认证密码
#### recv_window_conn
用于接收数据的 QUIC 流级流控制窗口。
如果为空,将使用 `15728640 (15 MB/s)`
默认 `15728640 (15 MB/s)`
#### recv_window
用于接收数据的 QUIC 连接级流控制窗口。
如果为空,将使用 `67108864 (64 MB/s)`
默认 `67108864 (64 MB/s)`
#### disable_mtu_discovery
@ -111,11 +111,11 @@ base64 编码的认证密码
==必填==
TLS 配置, 参阅 [TLS](/zh/configuration/shared/tls/#outbound).
TLS 配置, 参阅 [TLS](/zh/configuration/shared/tls/#outbound)
#### network
启用的网络协议
启用的网络协议
`tcp``udp`
@ -141,9 +141,9 @@ TLS 配置, 参阅 [TLS](/zh/configuration/shared/tls/#outbound).
!!! error ""
仅支持 Linux.
仅支持 Linux
设置 netfilter 路由标记
设置 netfilter 路由标记
#### reuse_addr
@ -158,11 +158,11 @@ TLS 配置, 参阅 [TLS](/zh/configuration/shared/tls/#outbound).
#### domain_strategy
可选值:`prefer_ipv4` `prefer_ipv6` `ipv4_only` `ipv6_only`.
可选值:`prefer_ipv4` `prefer_ipv6` `ipv4_only` `ipv6_only`
如果设置,服务器域名将在连接前解析为 IP。
如果为空,将使用 `dns.strategy`
默认使用 `dns.strategy`
#### fallback_delay

View file

@ -32,4 +32,4 @@
#### default
默认的出站标签。如果为空,则使用第一个出站。
默认的出站标签。默认使用第一个出站。

View file

@ -35,19 +35,19 @@
==必填==
服务器地址
服务器地址
#### server_port
==必填==
服务器端口
服务器端口
#### method
==必填==
加密方法
加密方法
* `2022-blake3-aes-128-gcm`
* `2022-blake3-aes-256-gcm`
@ -59,7 +59,7 @@
* `chacha20-ietf-poly1305`
* `xchacha20-ietf-poly1305`
旧加密方法:
旧加密方法
* `aes-128-ctr`
* `aes-192-ctr`
@ -75,7 +75,7 @@
==必填==
Shadowsocks 密码
Shadowsocks 密码
#### network
@ -93,7 +93,7 @@ Shadowsocks 密码
#### multiplex
多路复用配置, 参阅 [多路复用](/zh/configuration/shared/multiplex).
多路复用配置, 参阅 [多路复用](/zh/configuration/shared/multiplex)
### 拨号字段
@ -115,13 +115,13 @@ Shadowsocks 密码
!!! error ""
仅支持 Linux.
仅支持 Linux
设置 netfilter 路由标记
设置 netfilter 路由标记
#### reuse_addr
重用监听地址
重用监听地址
#### connect_timeout
@ -132,11 +132,11 @@ Shadowsocks 密码
#### domain_strategy
可选值:`prefer_ipv4` `prefer_ipv6` `ipv4_only` `ipv6_only`.
可选值:`prefer_ipv4` `prefer_ipv6` `ipv4_only` `ipv6_only`
如果设置,服务器域名将在连接前解析为 IP。
如果为空,将使用 `dns.strategy`
默认使用 `dns.strategy`
#### fallback_delay

View file

@ -31,33 +31,33 @@
}
```
### SOCKS Fields
### SOCKS 字段
#### server
==必填==
服务器地址
服务器地址
#### server_port
==必填==
服务器端口
服务器端口
#### version
SOCKS 版本, 可为 `4` `4a` `5`.
默认使用 SOCKS5.
默认使用 SOCKS5
#### username
SOCKS 用户名
SOCKS 用户名
#### password
SOCKS5 密码
SOCKS5 密码
#### network
@ -91,13 +91,13 @@ SOCKS5 密码
!!! error ""
仅支持 Linux.
仅支持 Linux
设置 netfilter 路由标记
设置 netfilter 路由标记
#### reuse_addr
重用监听地址
重用监听地址
#### connect_timeout
@ -108,11 +108,11 @@ SOCKS5 密码
#### domain_strategy
可选值:`prefer_ipv4` `prefer_ipv6` `ipv4_only` `ipv6_only`.
可选值:`prefer_ipv4` `prefer_ipv6` `ipv4_only` `ipv6_only`
如果设置,服务器域名将在连接前解析为 IP。
如果为空,将使用 `dns.strategy`
默认使用 `dns.strategy`
#### fallback_delay

View file

@ -37,7 +37,7 @@
==必填==
服务器地址
服务器地址
#### server_port
@ -49,23 +49,23 @@ SSH 用户, 默认使用 root。
#### password
密码
密码
#### private_key
密钥
密钥
#### private_key_path
密钥路径
密钥路径
#### private_key_passphrase
密钥密码
密钥密码
#### host_key_algorithms
主机密钥算法
主机密钥算法
#### client_version
@ -91,13 +91,13 @@ SSH 用户, 默认使用 root。
!!! error ""
仅支持 Linux.
仅支持 Linux
设置 netfilter 路由标记
设置 netfilter 路由标记
#### reuse_addr
重用监听地址
重用监听地址
#### connect_timeout
@ -108,11 +108,11 @@ SSH 用户, 默认使用 root。
#### domain_strategy
可选值:`prefer_ipv4` `prefer_ipv6` `ipv4_only` `ipv6_only`.
可选值:`prefer_ipv4` `prefer_ipv6` `ipv4_only` `ipv6_only`
如果设置,服务器域名将在连接前解析为 IP。
如果为空,将使用 `dns.strategy`
默认使用 `dns.strategy`
#### fallback_delay

View file

@ -30,7 +30,7 @@
!!! info ""
默认安装不包含嵌入式 Tor, 参阅 [安装](/zh/#installation).
默认安装不包含嵌入式 Tor, 参阅 [安装](/zh/#installation)
### Tor 字段
@ -54,9 +54,9 @@ Tor 的数据目录。
#### torrc
torrc 参数表
torrc 参数表
参阅 [tor(1)](https://linux.die.net/man/1/tor)
参阅 [tor(1)](https://linux.die.net/man/1/tor)
### 拨号字段
@ -78,13 +78,13 @@ torrc 参数表
!!! error ""
仅支持 Linux.
仅支持 Linux
设置 netfilter 路由标记
设置 netfilter 路由标记
#### reuse_addr
重用监听地址
重用监听地址
#### connect_timeout
@ -95,11 +95,11 @@ torrc 参数表
#### domain_strategy
可选值:`prefer_ipv4` `prefer_ipv6` `ipv4_only` `ipv6_only`.
可选值:`prefer_ipv4` `prefer_ipv6` `ipv4_only` `ipv6_only`
如果设置,服务器域名将在连接前解析为 IP。
如果为空,将使用 `dns.strategy`
默认使用 `dns.strategy`
#### fallback_delay

View file

@ -35,23 +35,23 @@
==必填==
服务器地址
服务器地址
#### server_port
==必填==
服务器端口
服务器端口
#### password
==必填==
Trojan 密码
Trojan 密码
#### network
启用的网络协议
启用的网络协议
`tcp``udp`
@ -59,11 +59,11 @@ Trojan 密码
#### tls
TLS 配置, 参阅 [TLS](/zh/configuration/shared/tls/#outbound).
TLS 配置, 参阅 [TLS](/zh/configuration/shared/tls/#outbound)
#### multiplex
多路复用配置, 参阅 [多路复用](/zh/configuration/shared/multiplex).
多路复用配置, 参阅 [多路复用](/zh/configuration/shared/multiplex)
#### transport
@ -89,13 +89,13 @@ V2Ray 传输配置,参阅 [V2Ray 传输层](/zh/configuration/shared/v2ray-tra
!!! error ""
仅支持 Linux.
仅支持 Linux
设置 netfilter 路由标记
设置 netfilter 路由标记
#### reuse_addr
重用监听地址
重用监听地址
#### connect_timeout
@ -106,11 +106,11 @@ V2Ray 传输配置,参阅 [V2Ray 传输层](/zh/configuration/shared/v2ray-tra
#### domain_strategy
可选值:`prefer_ipv4` `prefer_ipv6` `ipv4_only` `ipv6_only`.
可选值:`prefer_ipv4` `prefer_ipv6` `ipv4_only` `ipv6_only`
如果设置,服务器域名将在连接前解析为 IP。
如果为空,将使用 `dns.strategy`
默认使用 `dns.strategy`
#### fallback_delay

View file

@ -37,23 +37,23 @@
==必填==
服务器地址
服务器地址
#### server_port
==必填==
服务器端口
服务器端口
#### uuid
==必填==
VMess 用户 ID
VMess 用户 ID
#### security
加密方法:
加密方法
* `auto`
* `none`
@ -61,7 +61,7 @@ VMess 用户 ID
* `aes-128-gcm`
* `chancha20-poly1305`
旧加密方法:
旧加密方法
* `aes-128-ctr`
@ -79,11 +79,11 @@ VMess 用户 ID
#### authenticated_length
协议参数。 启用长度块加密。
协议参数。启用长度块加密。
#### network
启用的网络协议
启用的网络协议
`tcp``udp`
@ -91,11 +91,11 @@ VMess 用户 ID
#### tls
TLS 配置, 参阅 [TLS](/zh/configuration/shared/tls/#outbound).
TLS 配置, 参阅 [TLS](/zh/configuration/shared/tls/#outbound)
#### multiplex
多路复用配置, 参阅 [多路复用](/zh/configuration/shared/multiplex).
多路复用配置, 参阅 [多路复用](/zh/configuration/shared/multiplex)
#### transport
@ -121,13 +121,13 @@ V2Ray 传输配置,参阅 [V2Ray 传输层](/zh/configuration/shared/v2ray-tra
!!! error ""
仅支持 Linux.
仅支持 Linux
设置 netfilter 路由标记
设置 netfilter 路由标记
#### reuse_addr
重用监听地址
重用监听地址
#### connect_timeout
@ -138,11 +138,11 @@ V2Ray 传输配置,参阅 [V2Ray 传输层](/zh/configuration/shared/v2ray-tra
#### domain_strategy
可选值:`prefer_ipv4` `prefer_ipv6` `ipv4_only` `ipv6_only`.
可选值:`prefer_ipv4` `prefer_ipv6` `ipv4_only` `ipv6_only`
如果设置,服务器域名将在连接前解析为 IP。
如果为空,将使用 `dns.strategy`
默认使用 `dns.strategy`
#### fallback_delay

View file

@ -35,7 +35,7 @@
!!! warning ""
默认安装不包含 WireGuard, 参阅 [安装](/zh/#installation).
默认安装不包含 WireGuard, 参阅 [安装](/zh/#installation)
### WireGuard 字段
@ -43,19 +43,19 @@
==必填==
服务器地址
服务器地址
#### server_port
==必填==
服务器端口
服务器端口
#### local_address
==必填==
接口的 IPv4/IPv6 地址或地址段的列表您
接口的 IPv4/IPv6 地址或地址段的列表您
要分配给接口的 IPv4 或 v6地址列表可以选择带有 CIDR 掩码)。
@ -82,7 +82,7 @@ WireGuard 预共享密钥。
#### mtu
WireGuard MTU。 如果为空,将使用 1408。
WireGuard MTU。 默认1408。
#### network
@ -112,13 +112,13 @@ WireGuard MTU。 如果为空,将使用 1408。
!!! error ""
仅支持 Linux.
仅支持 Linux
设置 netfilter 路由标记
设置 netfilter 路由标记
#### reuse_addr
重用监听地址
重用监听地址
#### connect_timeout
@ -129,11 +129,11 @@ WireGuard MTU。 如果为空,将使用 1408。
#### domain_strategy
可选值:`prefer_ipv4` `prefer_ipv6` `ipv4_only` `ipv6_only`.
可选值:`prefer_ipv4` `prefer_ipv6` `ipv4_only` `ipv6_only`
如果设置,服务器域名将在连接前解析为 IP。
如果为空,将使用 `dns.strategy`
默认使用 `dns.strategy`
#### fallback_delay

View file

@ -18,13 +18,13 @@
指定 GeoIP 资源的路径。
如果为空,将使用 `geoip.db`
默认 `geoip.db`
#### download_url
指定 GeoIP 资源的下载接。
指定 GeoIP 资源的下载接。
默认为 `https://github.com/SagerNet/sing-geoip/releases/latest/download/geoip.db`.
默认为 `https://github.com/SagerNet/sing-geoip/releases/latest/download/geoip.db`
#### download_detour

View file

@ -18,13 +18,13 @@
指定 GeoSite 资源的路径。
如果为空,将使用 `geosite.db`
默认 `geosite.db`
#### download_url
指定 GeoSite 资源的下载接。
指定 GeoSite 资源的下载接。
默认为 `https://github.com/SagerNet/sing-geosite/releases/latest/download/geosite.db`.
默认为 `https://github.com/SagerNet/sing-geosite/releases/latest/download/geosite.db`
#### download_detour

View file

@ -16,7 +16,7 @@
}
```
### Fields
### 字段
| 键 | 格式 |
|-----------|----------------------|
@ -32,7 +32,7 @@
!!! error ""
仅支持 Linux, Windows, 和 macOS.
仅支持 Linux、Windows 和 macOS。
默认将出站连接绑定到默认网卡,以防止在 Tun 下出现路由环路。
@ -42,7 +42,7 @@
!!! error ""
仅支持 Linux, Windows, 和 macOS.
仅支持 Linux、Windows 和 macOS。
默认将出站连接绑定到指定网卡,以防止在 Tun 下出现路由环路。
@ -52,7 +52,7 @@
!!! error ""
仅支持 Linux.
仅支持 Linux
默认为出站连接设置路由标记。

View file

@ -93,7 +93,7 @@
!!! note ""
当内容只有一项时,可以忽略 JSON 数组 [] 标签
当内容只有一项时,可以忽略 JSON 数组 [] 标签
### Default Fields
@ -106,13 +106,13 @@
#### inbound
[入站](/zh/configuration/inbound) 标签.
[入站](/zh/configuration/inbound) 标签
#### ip_version
4 或 6.
4 或 6
为空则不限制。
默认不限制。
#### auth_user
@ -144,7 +144,7 @@
#### geosite
匹配 GeoSite.
匹配 GeoSite
#### source_geoip
@ -182,7 +182,7 @@
!!! error ""
仅支持 Linux, Windows, 和 macOS.
仅支持 Linux、Windows 和 macOS。
匹配进程名称。

View file

@ -18,7 +18,7 @@
#### enabled
启用多路复用
启用多路复用
#### protocol
@ -29,22 +29,22 @@
| smux | https://github.com/xtaci/smux |
| yamux | https://github.com/hashicorp/yamux |
默认使用 SMux.
默认使用 SMux
#### max_connections
最大连接数量
最大连接数量
`max_streams` 冲突.
`max_streams` 冲突
#### min_streams
在打开新连接之前,连接中的最小多路复用流数量
在打开新连接之前,连接中的最小多路复用流数量
`max_streams` 冲突.
`max_streams` 冲突
#### max_streams
在打开新连接之前,连接中的最大多路复用流数量
在打开新连接之前,连接中的最大多路复用流数量
`max_connections``min_streams` 冲突.
`max_connections``min_streams` 冲突

View file

@ -32,7 +32,7 @@
!!! warning ""
默认安装不包含 ACME, 参阅 [安装](/zh/#installation).
默认安装不包含 ACME,参阅 [安装](/zh/#installation)。
### 出站
@ -50,14 +50,14 @@
}
```
TLS 版本值:
TLS 版本值
* `1.0`
* `1.1`
* `1.2`
* `1.3`
密码套件值:
密码套件值
* `TLS_RSA_WITH_AES_128_CBC_SHA`
* `TLS_RSA_WITH_AES_256_CBC_SHA`
@ -93,13 +93,13 @@ TLS 版本值:
它还包含在 ClientHello 中以支持虚拟主机,除非它是 IP 地址。
参阅 [Server Name Indication](https://en.wikipedia.org/wiki/Server_Name_Indication).
参阅 [Server Name Indication](https://en.wikipedia.org/wiki/Server_Name_Indication)
#### insecure
==仅客户端==
接受任何服务器证书
接受任何服务器证书
#### alpn
@ -107,13 +107,13 @@ TLS 版本值:
如果两个对等点都支持 ALPN则选择的协议将是此列表中的一个如果没有相互支持的协议则连接将失败。
参阅 [Application-Layer Protocol Negotiation](https://en.wikipedia.org/wiki/Application-Layer_Protocol_Negotiation).
参阅 [Application-Layer Protocol Negotiation](https://en.wikipedia.org/wiki/Application-Layer_Protocol_Negotiation)
#### min_version
可接受的最低 TLS 版本。
默认情况下,当前使用 TLS 1.2 作为客户端的最低要求。作为服务器时使用 TLS 1.0.
默认情况下,当前使用 TLS 1.2 作为客户端的最低要求。作为服务器时使用 TLS 1.0
#### max_version
@ -132,23 +132,23 @@ TLS 版本值:
#### certificate
服务器 PEM 证书
服务器 PEM 证书
#### certificate_path
服务器 PEM 证书路径
服务器 PEM 证书路径
#### key
==仅服务器==
服务器 PEM 私钥
服务器 PEM 私钥
#### key_path
==仅服务器==
服务器 PEM 私钥路径
服务器 PEM 私钥路径
### ACME 字段
@ -156,13 +156,13 @@ TLS 版本值:
一组域名。
如果为空,将禁用 ACME。
默认禁用 ACME。
#### data_directory
ACME 数据目录。
如果为空,将使用 `$XDG_DATA_HOME/certmagic|$HOME/.local/share/certmagic`
默认使用 `$XDG_DATA_HOME/certmagic|$HOME/.local/share/certmagic`
#### default_server_name
@ -212,8 +212,8 @@ EAB外部帐户绑定包含将 ACME 帐户绑定或映射到其他已知
#### external_account.key_id
密钥标识符
密钥标识符
#### external_account.mac_key
MAC 密钥
MAC 密钥

View file

@ -23,7 +23,7 @@ V2Ray Transport 是 v2ray 发明的一组私有协议,并污染了其他协议
!!! note ""
当内容只有一项时,可以忽略 JSON 数组 [] 标签
当内容只有一项时,可以忽略 JSON 数组 [] 标签
### HTTP
@ -39,31 +39,31 @@ V2Ray Transport 是 v2ray 发明的一组私有协议,并污染了其他协议
!!! warning "与 v2ray-core 的区别"
不强制执行 TLS。 如果未配置 TLS将使用纯 HTTP 1.1。
不强制执行 TLS。如果未配置 TLS将使用纯 HTTP 1.1。
#### host
主机域名列表。
客户端将随机选择,如果不为空,服务器将验证。
客户端将随机选择,默认服务器将验证。
#### path
HTTP 请求路径
如果不为空,服务器将验证。
默认服务器将验证。
#### method
HTTP 请求方法
如果不为空,服务器将验证。
默认服务器将验证。
#### headers
HTTP 请求的额外标头
如果不为空,服务器将写入响应。
默认服务器将写入响应。
### WebSocket
@ -81,15 +81,15 @@ HTTP 请求的额外标头
HTTP 请求路径
如果不为空,服务器将验证。
默认服务器将验证。
#### headers
HTTP 请求的额外标头
HTTP 请求的额外标头
#### max_early_data
请求中允许的最大有效负载大小。 如果不为零则启用。
请求中允许的最大有效负载大小。默认启用。
#### early_data_header_name
@ -116,7 +116,7 @@ HTTP 请求的额外标头
!!! warning ""
默认安装不包含 gRPC, 参阅 [安装](/zh/#installation).
默认安装不包含 gRPC, 参阅 [安装](/zh/#installation)
```json
{
@ -127,4 +127,4 @@ HTTP 请求的额外标头
#### service_name
gRPC 服务名称
gRPC 服务名称

View file

@ -6,13 +6,13 @@
## 安装
sing-box 需要 Golang **1.18.5** 或更高版本.
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
@ -20,23 +20,23 @@ go install -v -tags with_clash_api github.com/sagernet/sing-box/cmd/sing-box@lat
| 构建标志 | 描述 |
|------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `with_quic` | 启用 QUIC 支持, 参阅 [QUIC 和 HTTP3 DNS 传输层](./configuration/dns/server), [Naive 入站](./configuration/inbound/naive), [Hysteria 入站](./configuration/inbound/hysteria) 和 [Hysteria 出站](./configuration/outbound/hysteria). |
| `with_grpc` | 启用 gRPC 支持, 参阅 [V2Ray 传输层#gRPC](/configuration/shared/v2ray-transport#grpc). |
| `with_wireguard` | 启用 WireGuard 支持, 参阅 [WireGuard 出站](./configuration/outbound/wireguard). |
| `with_acme` | 启用 ACME TLS 证书签发支持, 参阅 [TLS](./configuration/shared/tls). |
| `with_clash_api` | 启用 Clash api 支持, 参阅 [实验性](./configuration/experimental#clash-api-fields). |
| `no_gvisor` | 禁用 gVisor Tun 栈支持, 参阅 [Tun 入站](./configuration/inbound/tun#stack). |
| `with_embedded_tor` (需要 CGO) | 启用 嵌入式 Tor 支持, 参阅 [Tor 出站](./configuration/outbound/tor). |
| `with_lwip` (需要 CGO) | 启用 LWIP Tun 栈支持, 参阅 [Tun 入站](./configuration/inbound/tun#stack). |
| `with_quic` | 启用 QUIC 支持,参阅 [QUIC 和 HTTP3 DNS 传输层](./configuration/dns/server)[Naive 入站](./configuration/inbound/naive)[Hysteria 入站](./configuration/inbound/hysteria) 和 [Hysteria 出站](./configuration/outbound/hysteria)。 |
| `with_grpc` | 启用 gRPC 支持,参阅 [V2Ray 传输层#gRPC](/configuration/shared/v2ray-transport#grpc)。 |
| `with_wireguard` | 启用 WireGuard 支持,参阅 [WireGuard 出站](./configuration/outbound/wireguard)。 |
| `with_acme` | 启用 ACME TLS 证书签发支持,参阅 [TLS](./configuration/shared/tls)。 |
| `with_clash_api` | 启用 Clash api 支持,参阅 [实验性](./configuration/experimental#clash-api-fields)。 |
| `no_gvisor` | 禁用 gVisor Tun 栈支持,参阅 [Tun 入站](./configuration/inbound/tun#stack)。 |
| `with_embedded_tor` (需要 CGO) | 启用 嵌入式 Tor 支持,参阅 [Tor 出站](./configuration/outbound/tor)。 |
| `with_lwip` (需要 CGO) | 启用 LWIP Tun 栈支持,参阅 [Tun 入站](./configuration/inbound/tun#stack)。 |
二进制文件将被构建在 `$GOPATH/bin`
二进制文件将被构建在 `$GOPATH/bin`
```bash
sing-box version
```
同时推荐使用 Systemd 来管理 sing-box 服务器实例.
参阅 [Linux 服务器安装示例](./examples/linux-server-installation).
同时推荐使用 Systemd 来管理 sing-box 服务器实例
参阅 [Linux 服务器安装示例](./examples/linux-server-installation)
## 贡献者