sing-box/docs/index.zh.md
世界 8ce244dd04
Fix documentation
Signed-off-by: 世界 <i@sekai.icu>
Signed-off-by: unknowndevQwQ <unknowndevQwQ@pm.me>
2022-09-26 12:25:18 +08:00

5.4 KiB
Raw Blame History

description
欢迎来到该 sing-box 项目的文档页。

开始

欢迎来到该 sing-box 项目的文档页。

通用代理平台。

安装

sing-box 需要 Golang 1.18.5 或更高版本。

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
构建标志 描述
with_quic 启用 QUIC 支持,参阅 QUIC 和 HTTP3 DNS 传输层Naive 入站Hysteria 入站Hysteria 出站V2Ray 传输层#QUIC
with_grpc 启用标准 gRPC 支持,参阅 V2Ray 传输层#gRPC
with_wireguard 启用 WireGuard 支持,参阅 WireGuard 出站
with_shadowsocksr 启用 ShadowsocksR 支持,参阅 ShadowsocksR 出站
with_ech 启用 TLS ECH 扩展支持,参阅 TLS
with_utls 启用 uTLS 支持,参阅 实验性
with_acme 启用 ACME TLS 证书签发支持,参阅 TLS
with_clash_api 启用 Clash API 支持,参阅 实验性
with_gvisor 启用 gVisor 支持,参阅 Tun 入站WireGuard 出站
with_embedded_tor (需要 CGO) 启用 嵌入式 Tor 支持,参阅 Tor 出站
with_lwip (需要 CGO) 启用 LWIP Tun 栈支持,参阅 Tun 入站

二进制文件将被构建在 $GOPATH/bin 下。

sing-box version

同时推荐使用 systemd 来管理 sing-box 服务器实例。 参阅 Linux 服务器安装示例

授权

Copyright (C) 2022 by nekohasekai <contact-sagernet@sekai.icu>

This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.

This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License
along with this program. If not, see <http://www.gnu.org/licenses/>.