...
| Property | Description | ||
|---|---|---|---|
| allowed-address (IP/IPv6 prefix; Default: ) | List of IP (v4 or v6) addresses with CIDR masks from which incoming traffic for this peer is allowed and to which outgoing traffic for this peer is directed. The catch-all 0.0.0.0/0 may be specified for matching all IPv4 addresses, and ::/0 may be specified for matching all IPv6 addresses. | ||
| comment (string; Default: ) | Short description of the peer. | ||
| disabled (yes | no; Default: no) | Enables/disables the peer. | ||
| endpoint-address (IP/Hostname; Default: ) | The IP address or hostname. It is used by WireGuard to establish a secure connection between two peers. | ||
| endpoint-port (integer:0..65535; Default: ) | The Endpoint port is the UDP port on which a WireGuard peer listens for incoming traffic. | ||
| client-endpoint (IP/IPv6 prefix; Default: ) | The IP address and port number of the WireGuard Server. | ||
| client-listen-port (integer:0..65535; Default: ) | The local port upon which this WireGuard tunnel will listen for incoming traffic from peers, and the port from which it will source outgoing packets. | ||
| interface (string; Default: ) | Name of the WireGuard interface the peer belongs to. | ||
| persistent-keepalive (integer:0..65535; Default: 0) | A seconds interval, between 1 and 65535 inclusive, of how often to send an authenticated empty packet to the peer for the purpose of keeping a stateful firewall or NAT mapping valid persistently. For example, if the interface very rarely sends traffic, but it might at anytime receive traffic from a peer, and it is behind NAT, the interface might benefit from having a persistent keepalive interval of 25 seconds. | ||
| client-keepalive (integer:0..65535; Default: 0) | Same as persistent-keepalive but from peer side. | ||
| preshared-key (string; Default: ) | A base64 preshared key. Optional, and may be omitted. This option adds an additional layer of symmetric-key cryptography to be mixed into the already existing public-key cryptography, for post-quantum resistance. Also can be generated automatically or entered manually, when the key is provided by the system administrator. | ||
| private-key (auto/none; Default: none) | Can be generated automatically or entered manually, when the key is provided by the system administrator. | ||
public-key (string; Default: ) | The remote peer's calculated public key. It also can be generated if private-key is specified. | ||
show-client-dns (IP/IPv6 prefix; Default: ) | Specify when using WireGuard Server as a VPN gateway for peer traffic. | config | Will show already created Peer configuration and generate a QR code for easier peer setup on a client device. Does not affect the WireGuard Server. |
client-address (; Default: none) | Used for the client-server setup scenario, when the configuration is imported using a qr code for a client: | ||
client-address (IP/IPv6 prefix; Default: ) | When imported using a qr code for a client (for example, a phone), then this address for the wg interface is set on that device. | ||
show-client-config dns (IP/IPv6 prefix; Default: ) | Specify when using WireGuard Server as a VPN gateway for peer traffic. | ||
client-endpoint (IP/IPv6 prefix; Default: ) | The IP address and port number of the WireGuard Server. | ||
client-keepalive (integer:0..65535; Default: 0) | Same as persistent-keepalive but from peer side. | ||
client-listen-port (integer:0..65535; Default: ) | The local port upon which this WireGuard tunnel will listen for incoming traffic from peers, and the port from which it will source outgoing packets Will show already created Peer configuration and generate a QR code for easier peer setup on a client device. Does not affect the WireGuard Server. | ||
| Note |
|---|
Minimum parameters must be specified for importing on the client device by QR-code/file. Example: interface: wireguard1 public-key: v/oIzPyFm1FPHrqhytZgsKjU7mUToQHLrW+Tb5e601M= private-key: KMwxqe/iXAU8Jn9dd1o5pPdHep2blGxNWm9I944/I24= allowed-address: 192.168.88.3/24 client-address: 192.168.88.3/32 client-endpoint: example.com:13231 |
...