WireGuard
Deprecated in sing-box 1.11.0
WireGuard outbound is deprecated and will be removed in sing-box 1.13.0, check Migration.
Changes in sing-box 1.11.0
Changes in sing-box 1.8.0
Structure
{
"type": "wireguard",
"tag": "wireguard-out",
"server": "127.0.0.1",
"server_port": 1080,
"system_interface": false,
"interface_name": "wg0",
"local_address": [
"10.0.0.1/32"
],
"private_key": "YNXtAzepDqRv9H52osJVDQnznT5AM11eCK3ESpwSt04=",
"peers": [
{
"server": "127.0.0.1",
"server_port": 1080,
"public_key": "Z1XXLsKYkYxuiYjJIkRvtIKFepCYHTgON+GwPq7SOV4=",
"pre_shared_key": "31aIhAPwktDGpH4JDhA8GNvjFXEf/a6+UaQRyOAiyfM=",
"allowed_ips": [
"0.0.0.0/0"
],
"reserved": [0, 0, 0]
}
],
"peer_public_key": "Z1XXLsKYkYxuiYjJIkRvtIKFepCYHTgON+GwPq7SOV4=",
"pre_shared_key": "31aIhAPwktDGpH4JDhA8GNvjFXEf/a6+UaQRyOAiyfM=",
"reserved": [0, 0, 0],
"workers": 4,
"mtu": 1408,
"network": "tcp",
// Deprecated
"gso": false,
... // Dial Fields
}
Fields
server
Required if multi-peer disabled
The server address.
server_port
Required if multi-peer disabled
The server port.
system_interface
Use system interface.
Requires privilege and cannot conflict with exists system interfaces.
Forced if gVisor not included in the build.
interface_name
Custom interface name for system interface.
gso
Deprecated in sing-box 1.11.0
GSO will be automatically enabled when available since sing-box 1.11.0.
Since sing-box 1.8.0
Only supported on Linux.
Try to enable generic segmentation offload.
local_address
Required
List of IP (v4 or v6) address prefixes to be assigned to the interface.
private_key
Required
WireGuard requires base64-encoded public and private keys. These can be generated using the wg(8) utility:
peers
Multi-peer support.
If enabled, server, server_port, peer_public_key, pre_shared_key will be ignored.
peers.allowed_ips
WireGuard allowed IPs.
peers.reserved
WireGuard reserved field bytes.
$outbound.reserved will be used if empty.
peer_public_key
Required if multi-peer disabled
WireGuard peer public key.
pre_shared_key
WireGuard pre-shared key.
reserved
WireGuard reserved field bytes.
workers
WireGuard worker count.
CPU count is used by default.
mtu
WireGuard MTU.
1408 will be used if empty.
network
Enabled network
One of tcp udp.
Both is enabled by default.
Dial Fields
See Dial Fields for details.