github.com/sagernet/sing-box@v1.9.0-rc.20/docs/installation/build-from-source.md (about)

     1  ---
     2  icon: material/file-code
     3  ---
     4  
     5  # Build from source
     6  
     7  ## :material-graph: Requirements
     8  
     9  Before sing-box 1.4.0:
    10  
    11  * Go 1.18.5 - 1.20.x
    12  
    13  Since sing-box 1.4.0:
    14  
    15  * Go 1.18.5 - ~
    16  * Go 1.20.0 - ~ with tag `with_quic` enabled
    17  
    18  Since sing-box 1.5.0:
    19  
    20  * Go 1.18.5 - ~
    21  * Go 1.20.0 - ~ with tag `with_quic` or `with_ech` enabled
    22  
    23  Since sing-box 1.8.0:
    24  
    25  * Go 1.18.5 - ~
    26  * Go 1.20.0 - ~ with tag `with_quic`, or `with_utls` enabled
    27  * Go 1.21.0 - ~ with tag `with_ech` enabled
    28  
    29  You can download and install Go from: https://go.dev/doc/install, latest version is recommended.
    30  
    31  ## :material-fast-forward: Simple Build
    32  
    33  ```bash
    34  make
    35  ```
    36  
    37  Or build and install binary to `$GOBIN`:
    38  
    39  ```bash
    40  make install
    41  ```
    42  
    43  ## :material-cog: Custom Build
    44  
    45  ```bash
    46  TAGS="tag_a tag_b" make
    47  ```
    48  
    49  or
    50  
    51  ```bash
    52  go build -tags "tag_a tag_b" ./cmd/sing-box
    53  ```
    54  
    55  ## :material-folder-settings: Build Tags
    56  
    57  | Build Tag                          | Enabled by default | Description                                                                                                                                                                                                                                                                                                                    |
    58  |------------------------------------|--------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
    59  | `with_quic`                        | :material-check:   | 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). |
    60  | `with_grpc`                        | :material-close:️  | Build with standard gRPC support, see [V2Ray Transport#gRPC](/configuration/shared/v2ray-transport#grpc).                                                                                                                                                                                                                      |
    61  | `with_dhcp`                        | :material-check:   | Build with DHCP support, see [DHCP DNS transport](/configuration/dns/server/).                                                                                                                                                                                                                                                 |
    62  | `with_wireguard`                   | :material-check:   | Build with WireGuard support, see [WireGuard outbound](/configuration/outbound/wireguard/).                                                                                                                                                                                                                                    |
    63  | `with_ech`                         | :material-check:   | Build with TLS ECH extension support for TLS outbound, see [TLS](/configuration/shared/tls#ech).                                                                                                                                                                                                                               |
    64  | `with_utls`                        | :material-check:   | Build with [uTLS](https://github.com/refraction-networking/utls) support for TLS outbound, see [TLS](/configuration/shared/tls#utls).                                                                                                                                                                                          |
    65  | `with_reality_server`              | :material-check:   | Build with reality TLS server support,  see [TLS](/configuration/shared/tls/).                                                                                                                                                                                                                                                 |
    66  | `with_acme`                        | :material-check:   | Build with ACME TLS certificate issuer support, see [TLS](/configuration/shared/tls/).                                                                                                                                                                                                                                         |
    67  | `with_clash_api`                   | :material-check:   | Build with Clash API support, see [Experimental](/configuration/experimental#clash-api-fields).                                                                                                                                                                                                                                |
    68  | `with_v2ray_api`                   | :material-close:️  | Build with V2Ray API support, see [Experimental](/configuration/experimental#v2ray-api-fields).                                                                                                                                                                                                                                |
    69  | `with_gvisor`                      | :material-check:   | Build with gVisor support, see [Tun inbound](/configuration/inbound/tun#stack) and [WireGuard outbound](/configuration/outbound/wireguard#system_interface).                                                                                                                                                                   |
    70  | `with_embedded_tor` (CGO required) | :material-close:️  | Build with embedded Tor support, see [Tor outbound](/configuration/outbound/tor/).                                                                                                                                                                                                                                             |
    71  
    72  It is not recommended to change the default build tag list unless you really know what you are adding.