sing-box/docs/index.zh.md

66 lines
5.4 KiB
Markdown
Raw Normal View History

2022-08-25 13:08:29 +00:00
---
description: 欢迎来到该 sing-box 项目的文档页。
---
2022-08-24 04:08:51 +00:00
# 开始
欢迎来到该 sing-box 项目的文档页。
通用代理平台。
## 安装
sing-box 需要 Golang **1.18.5** 或更高版本。
2022-08-24 04:08:51 +00:00
```bash
2022-09-09 05:54:02 +00:00
go install -v github.com/sagernet/sing-box/cmd/sing-box@latest
2022-08-24 04:08:51 +00:00
```
自定义安装:
2022-08-24 04:08:51 +00:00
```bash
2022-09-09 05:54:02 +00:00
go install -v -tags with_clash_api github.com/sagernet/sing-box/cmd/sing-box@latest
2022-08-24 04:08:51 +00:00
```
2022-08-26 03:10:02 +00:00
| 构建标志 | 描述 |
|------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `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)。 |
2022-08-26 03:10:02 +00:00
| `with_wireguard` | 启用 WireGuard 支持,参阅 [WireGuard 出站](./configuration/outbound/wireguard)。 |
2022-09-13 03:24:33 +00:00
| `with_shadowsocksr` | 启用 ShadowsocksR 支持,参阅 [ShadowsocksR 出站](./configuration/outbound/shadowsocksr)。 |
2022-09-10 14:42:20 +00:00
| `with_ech` | 启用 TLS ECH 扩展支持,参阅 [TLS](./configuration/shared/tls#ech)。 |
| `with_utls` | 启用 uTLS 支持,参阅 [实验性](./configuration/experimental#clash-api-fields)。 |
| `with_acme` | 启用 ACME TLS 证书签发支持,参阅 [TLS](./configuration/shared/tls)。 |
| `with_clash_api` | 启用 Clash API 支持,参阅 [实验性](./configuration/experimental#clash-api-fields)。 |
2022-09-15 04:20:38 +00:00
| `with_gvisor` | 启用 gVisor 支持,参阅 [Tun 入站](./configuration/inbound/tun#stack) 和 [WireGuard 出站](./configuration/outbound/wireguard#system_interface)。 |
2022-08-26 03:10:02 +00:00
| `with_embedded_tor` (需要 CGO) | 启用 嵌入式 Tor 支持,参阅 [Tor 出站](./configuration/outbound/tor)。 |
| `with_lwip` (需要 CGO) | 启用 LWIP Tun 栈支持,参阅 [Tun 入站](./configuration/inbound/tun#stack)。 |
2022-08-24 04:08:51 +00:00
二进制文件将被构建在 `$GOPATH/bin` 下。
2022-08-24 04:08:51 +00:00
```bash
sing-box version
```
同时推荐使用 systemd 来管理 sing-box 服务器实例。
参阅 [Linux 服务器安装示例](./examples/linux-server-installation)。
2022-08-24 04:08:51 +00:00
## 授权
```
Copyright (C) 2022 by nekohasekai <contact-sagernet@sekai.icu>
2022-08-24 04:08:51 +00:00
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.
2022-08-24 04:08:51 +00:00
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.
2022-08-24 04:08:51 +00:00
You should have received a copy of the GNU General Public License
along with this program. If not, see <http://www.gnu.org/licenses/>.
2022-08-24 04:08:51 +00:00
```