Welcome to the wiki page for the sing-box project.
The universal proxy platform.
sing-box requires Golang 1.18.5 or a higher version.
go install -v github.com/sagernet/sing-box/cmd/[email protected]
Install with options:
go install -v -tags with_clash_api github.com/sagernet/sing-box/cmd/[email protected]
||Build with QUIC support, see QUIC and HTTP3 dns transports, Naive inbound, Hysteria Inbound, Hysteria Outbound and V2Ray Transport#QUIC.|
||Build with standard gRPC support, see V2Ray Transport#gRPC.|
||Build with WireGuard support, see WireGuard outbound.|
||Build with ShadowsocksR support, see ShadowsocksR outbound.|
||Build with TLS ECH extension support for TLS outbound, see TLS.|
||Build with uTLS support for TLS outbound, see TLS.|
||Build with ACME TLS certificate issuer support, see TLS.|
||Build with Clash API support, see Experimental.|
||Build with V2Ray API support, see Experimental.|
||Build with gVisor support, see Tun inbound and WireGuard outbound.|
||Build with embedded Tor support, see Tor outbound.|
||Build with LWIP Tun stack support, see Tun inbound.|
The binary is built under $GOPATH/bin
It is also recommended to use systemd to manage sing-box service, see Linux server installation example.
Copyright (C) 2022 by nekohasekai <[email protected]> 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/>.