sing-box/docs/installation/from-source.md
2023-08-20 13:31:48 +08:00

6.2 KiB

Install from source

Requirements

Before sing-box 1.4.0:

  • Go 1.18.5 - 1.20.x

Since sing-box 1.4.0:

  • Go 1.18.5 - ~
  • Go 1.20.0 - ~ if with_quic tag enabled

Installation

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

Install with options:

go install -v -tags with_quic,with_wireguard 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, Hysteria Outbound and V2Ray Transport#QUIC.
with_grpc Build with standard gRPC support, see V2Ray Transport#gRPC.
with_dhcp Build with DHCP support, see DHCP DNS transport.
with_wireguard Build with WireGuard support, see WireGuard outbound.
with_shadowsocksr Build with ShadowsocksR support, see ShadowsocksR outbound.
with_ech Build with TLS ECH extension support for TLS outbound, see TLS.
with_utls Build with uTLS support for TLS outbound, see TLS.
with_reality_server Build with reality TLS server support, see TLS.
with_acme Build with ACME TLS certificate issuer support, see TLS.
with_clash_api Build with Clash API support, see Experimental.
with_v2ray_api Build with V2Ray API support, see Experimental.
with_gvisor Build with gVisor support, see Tun inbound and WireGuard outbound.
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.