black-internet-days-ahead/sing-box
1
0
Fork 0
mirror of https://github.com/SagerNet/sing-box.git synced 2024-11-22 16:41:30 +00:00
Code Issues Packages Projects Releases Wiki Activity
sing-box/docs/installation/build-from-source.md
世界 89c723e3e4
Improve read wait interface & 
Refactor Authenticator interface to struct &
Update smux &
Update gVisor to 20231204.0 &
Update quic-go to v0.40.1 &
Update wireguard-go &
Add GSO support for TUN/WireGuard &
Fix router pre-start &
Fix bind forwarder to interface for systems stack
2024-01-03 12:21:47 +08:00

6.2 KiB
Raw Blame History

icon
material/file-code

Build from source

:material-graph: 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 - ~ with tag with_quic enabled

Since sing-box 1.5.0:

  • Go 1.18.5 - ~
  • Go 1.20.0 - ~ with tag with_quic or with_ech enabled

Since sing-box 1.8.0:

  • Go 1.18.5 - ~
  • Go 1.20.0 - ~ with tag with_quic, with_ech, or with_utls enabled

You can download and install Go from: https://go.dev/doc/install, latest version is recommended.

:material-fast-forward: Simple Build

make

Or build and install binary to $GOBIN:

make install

:material-cog: Custom Build

TAGS="tag_a tag_b" make

or

go build -tags "tag_a tag_b" ./cmd/sing-box

:material-folder-settings: Build Tags

Build Tag Enabled by default Description
with_quic :material-check: Build with QUIC support, see QUIC and HTTP3 DNS transports, Naive inbound, Hysteria Inbound, Hysteria Outbound and V2Ray Transport#QUIC.
with_grpc :material-close:️ Build with standard gRPC support, see V2Ray Transport#gRPC.
with_dhcp :material-check: Build with DHCP support, see DHCP DNS transport.
with_wireguard :material-check: Build with WireGuard support, see WireGuard outbound.
with_ech :material-check: Build with TLS ECH extension support for TLS outbound, see TLS.
with_utls :material-check: Build with uTLS support for TLS outbound, see TLS.
with_reality_server :material-check: Build with reality TLS server support, see TLS.
with_acme :material-check: Build with ACME TLS certificate issuer support, see TLS.
with_clash_api :material-check: Build with Clash API support, see Experimental.
with_v2ray_api :material-close:️ Build with V2Ray API support, see Experimental.
with_gvisor :material-check: Build with gVisor support, see Tun inbound and WireGuard outbound.
with_embedded_tor (CGO required) :material-close:️ Build with embedded Tor support, see Tor outbound.

It is not recommended to change the default build tag list unless you really know what you are adding.