diff --git a/README.md b/README.md index 1a7d002..3b72d76 100644 --- a/README.md +++ b/README.md @@ -518,6 +518,8 @@ dig example.com A ¶ `ListenPort = 51820``PrivateKey = localPrivateKeyAbcAbcAbc=``DNS = 1.1.1.1,8.8.8.8``Table = 12345``MTU = 1500``PreUp = /bin/example arg1 arg2 %i``PostUp = /bin/example arg1 arg2 %i``PreDown = /bin/example arg1 arg2 %i` @@ -589,6 +591,7 @@ When the node is acting as a public bounce server, it should hardcode a port to * Using custom WireGuard port `ListenPort = 7000` + #### `PrivateKey` This is the private key for the local node, never shared with other servers. @@ -600,6 +603,7 @@ This key can be generated with `wg genkey > example.key` `PrivateKey = somePrivateKeyAbcdAbcdAbcdAbcd=` + #### `DNS` The DNS server(s) to announce to VPN clients via DHCP, most clients will use this server for DNS requests over the VPN, but clients can also override this value locally on their nodes @@ -612,6 +616,39 @@ The DNS server(s) to announce to VPN clients via DHCP, most clients will use thi * or multiple DNS servers can be provided `DNS = 1.1.1.1,8.8.8.8` + +#### `Table` + +Optionally defines which routing table to use for the WireGuard routes, not necessary to configure for most setups. + +There are two special values: ‘off’ disables the creation of routes altogether, and ‘auto’ (the default) adds routes to the default table and enables special handling of default routes. + +https://git.zx2c4.com/WireGuard/about/src/tools/man/wg-quick.8 + +**Examples** + +```ini +Table = 1234 +``` + + +#### `MTU` + +Optionally defines the maximum transmission unit (MTU, aka packet/frame size) to use when connecting to the peer, not necessary to configure for most setups. + +The MTU is automatically determined from the endpoint addresses or the system default route, which is usually a sane choice. + +There are two special values: ‘off’ disables the creation of routes altogether, and ‘auto’ (the default) adds routes to the default table and enables special handling of default routes. + +https://git.zx2c4.com/WireGuard/about/src/tools/man/wg-quick.8 + +**Examples** + +```ini +MTU = 1500 +``` + + #### `PreUp` Optionally run a command before the interface is brought up.