github.com/inazumav/sing-box@v0.0.0-20230926072359-ab51429a14f1/docs/installation/from-source.md (about)

     1  # Install from source
     2  
     3  ## Requirements
     4  
     5  Before sing-box 1.4.0:
     6  
     7  * Go 1.18.5 - 1.20.x
     8  
     9  Since sing-box 1.4.0:
    10  
    11  * Go 1.18.5 - ~
    12  * Go 1.20.0 - ~ if `with_quic` tag enabled
    13  
    14  ## Installation
    15  
    16  ```bash
    17  go install -v github.com/inazumav/sing-box/cmd/sing-box@latest
    18  ```
    19  
    20  Install with options:
    21  
    22  ```bash
    23  go install -v -tags with_clash_api,with_quic,with_wireguard github.com/inazumav/sing-box/cmd/sing-box@latest
    24  ```
    25  
    26  | Build Tag                          | Description                                                                                                                                                                                                                                                                                                                |
    27  |------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
    28  | `with_quic`                        | 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). |
    29  | `with_grpc`                        | Build with standard gRPC support, see [V2Ray Transport#gRPC](/configuration/shared/v2ray-transport#grpc).                                                                                                                                                                                                                  |
    30  | `with_dhcp`                        | Build with DHCP support, see [DHCP DNS transport](/configuration/dns/server).                                                                                                                                                                                                                                              |
    31  | `with_wireguard`                   | Build with WireGuard support, see [WireGuard outbound](/configuration/outbound/wireguard).                                                                                                                                                                                                                                 |
    32  | `with_shadowsocksr`                | Build with ShadowsocksR support, see [ShadowsocksR outbound](/configuration/outbound/shadowsocksr).                                                                                                                                                                                                                        |
    33  | `with_ech`                         | Build with TLS ECH extension support for TLS outbound, see [TLS](/configuration/shared/tls#ech).                                                                                                                                                                                                                           |
    34  | `with_utls`                        | Build with [uTLS](https://github.com/refraction-networking/utls) support for TLS outbound, see [TLS](/configuration/shared/tls#utls).                                                                                                                                                                                      |
    35  | `with_reality_server`              | Build with reality TLS server support,  see [TLS](/configuration/shared/tls).                                                                                                                                                                                                                                              |
    36  | `with_acme`                        | Build with ACME TLS certificate issuer support, see [TLS](/configuration/shared/tls).                                                                                                                                                                                                                                      |
    37  | `with_clash_api`                   | Build with Clash API support, see [Experimental](/configuration/experimental#clash-api-fields).                                                                                                                                                                                                                            |
    38  | `with_v2ray_api`                   | Build with V2Ray API support, see [Experimental](/configuration/experimental#v2ray-api-fields).                                                                                                                                                                                                                            |
    39  | `with_gvisor`                      | Build with gVisor support, see [Tun inbound](/configuration/inbound/tun#stack) and [WireGuard outbound](/configuration/outbound/wireguard#system_interface).                                                                                                                                                               |
    40  | `with_embedded_tor` (CGO required) | Build with embedded Tor support, see [Tor outbound](/configuration/outbound/tor).                                                                                                                                                                                                                                          |
    41  | `with_lwip` (CGO required)         | Build with LWIP Tun stack support, see [Tun inbound](/configuration/inbound/tun#stack).                                                                                                                                                                                                                                    |
    42  
    43  The binary is built under $GOPATH/bin
    44  
    45  ```bash
    46  sing-box version
    47  ```
    48  
    49  It is also recommended to use systemd to manage sing-box service,
    50  see [Linux server installation example](/examples/linux-server-installation).