2022-08-25 13:08:29 +00:00
---
description: Welcome to the wiki page for the sing-box project.
---
2022-07-08 09:01:38 +00:00
# Home
Welcome to the wiki page for the sing-box project.
2022-07-08 10:10:39 +00:00
The universal proxy platform.
## Installation
2022-08-08 12:57:50 +00:00
sing-box requires Golang **1.18.5** or a higher version.
2022-07-08 10:10:39 +00:00
```bash
2022-09-09 05:54:02 +00:00
go install -v github.com/sagernet/sing-box/cmd/sing-box@latest
2022-07-08 10:10:39 +00:00
```
2022-07-19 23:36:06 +00:00
Install with options:
```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-07-19 23:36:06 +00:00
```
2022-08-26 03:10:02 +00:00
| Build Tag | Description |
|------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
2023-02-08 08:28:52 +00:00
| `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 ). |
2022-08-27 13:32:20 +00:00
| `with_grpc` | Build with standard gRPC support, see [V2Ray Transport#gRPC ](./configuration/shared/v2ray-transport#grpc ). |
2023-02-08 08:28:52 +00:00
| `with_dhcp` | Build with DHCP support, see [DHCP DNS transport ](./configuration/dns/server ). |
2022-08-26 03:10:02 +00:00
| `with_wireguard` | Build with WireGuard support, see [WireGuard outbound ](./configuration/outbound/wireguard ). |
2022-09-13 03:24:33 +00:00
| `with_shadowsocksr` | Build with ShadowsocksR support, see [ShadowsocksR outbound ](./configuration/outbound/shadowsocksr ). |
2022-09-10 14:42:20 +00:00
| `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 ). |
2023-02-25 09:25:44 +00:00
| `with_reality_server` | Build with reality TLS server support, see [TLS ](./configuration/shared/tls ). |
2022-08-26 03:10:02 +00:00
| `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 ). |
2022-10-01 03:48:46 +00:00
| `with_v2ray_api` | Build with V2Ray API support, see [Experimental ](./configuration/experimental#v2ray-api-fields ). |
2022-09-15 04:20:38 +00:00
| `with_gvisor` | Build with gVisor support, see [Tun inbound ](./configuration/inbound/tun#stack ) and [WireGuard outbound ](./configuration/outbound/wireguard#system_interface ). |
2022-08-26 03:10:02 +00:00
| `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 ). |
2022-07-19 23:36:06 +00:00
2022-07-08 10:10:39 +00:00
The binary is built under $GOPATH/bin
```bash
2022-07-09 06:44:48 +00:00
sing-box version
2022-07-08 10:10:39 +00:00
```
2022-08-10 13:17:02 +00:00
It is also recommended to use systemd to manage sing-box service,
see [Linux server installation example ](./examples/linux-server-installation ).
2022-07-08 10:10:39 +00:00
## License
```
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 / > .
```
