wireguard-go Documentation

To build the project, you must have the latest version of Go installed. Clone the repository and use make to compile.

$ git clone https://git.zx2c4.com/wireguard-go
$ cd wireguard-go
$ make

To create a WireGuard interface and fork the process into the background, run the command followed by the desired interface name (e.g., wg0).

Once running, you can configure the interface using standard tools like wg(8), ip(8), or ifconfig(8). To remove the interface, use ip link del <interface_name>. If your system does not support direct interface removal, you can shut down wireguard-go by removing its control socket: rm -f /var/run/wireguard/<interface_name>.sock.

$ wireguard-go wg0

To run wireguard-go without forking to the background, use the -f or --foreground flag. This is useful for debugging or running within a process manager.

$ wireguard-go -f wg0

To run wireguard-go with increased logging verbosity, set the LOG_LEVEL environment variable to debug.

LOG_LEVEL=debug

The wireguard-go CLI uses the following exit codes:

• 0: ExitSetupSuccess - Setup completed successfully.
• 1: ExitSetupFailed - Setup failed.

You can control the behavior of wireguard-go using the following environment variables:

The wireguard-go binary can be executed as a userspace WireGuard daemon. By default, it daemonizes itself unless the foreground flag is provided. You must specify an interface name.

Usage: wireguard-go [-f|--foreground] INTERFACE-NAME

Arguments:

• -f, --foreground: Run the process in the foreground. If not provided, the process will daemonize.
• INTERFACE-NAME: The name of the network interface to create.

Version Check: Use --version to print the current version and build information.

The current version of the wireguard-go implementation is exported as a constant named Version within the main package.

const Version = "0.0.20250522"