sing-box/docs/index.md

Home

Welcome to the wiki page for the sing-box project.

The universal proxy platform.

Installation

sing-box requires Golang 1.18.5 or a higher version.

go install -v github.com/sagernet/sing-box/cmd/sing-box@latest

Install with options:

go install -v -tags with_clash_api github.com/sagernet/sing-box/cmd/sing-box@latest

Build Tag	Description
with_quic	Build with QUIC support, see QUIC and HTTP3 dns transports, Naive inbound, Hysteria Inbound and Hysteria Outbound.
with_wireguard	Build with WireGuard support, see WireGuard outbound.
with_acme	Build with ACME TLS certificate issuer support, see TLS.
with_clash_api	Build with Clash api support, see Experimental.
no_gvisor	Build without gVisor tun stack support, see Tun inbound.
with_embedded_tor (CGO required)	Build with embedded Tor support, see Tor outbound.
with_lwip (CGO required)	Build with LWIP tun stack support, see Tun inbound.

The binary is built under $GOPATH/bin

sing-box version

It is also recommended to use systemd to manage sing-box service, see Linux server installation example.

Contributors

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/>.