diff --git a/README.md b/README.md index 08dd99d..50dec5f 100644 --- a/README.md +++ b/README.md @@ -618,20 +618,22 @@ The config file name must be in the format `${name of the new WireGuard interfac Config files can opt to use the limited set of `wg` config options, or the more extended `wg-quick` options, depending on what command is preferred to start WireGuard. These docs recommend sticking to `wg-quick` as it provides a more powerful and user-friendly config experience. +The core `wg(8)` config format covers peer/session state such as `PrivateKey`, `ListenPort`, `FwMark`, `PublicKey`, `PresharedKey`, `AllowedIPs`, `Endpoint`, and `PersistentKeepalive`. The convenience keys `Address`, `DNS`, `Table`, `MTU`, `PreUp`, `PostUp`, `PreDown`, and `PostDown` below are `wg-quick(8)` extensions. See [wg(8)](https://man7.org/linux/man-pages/man8/wg.8.html) and [wg-quick(8)](https://man7.org/linux/man-pages/man8/wg-quick.8.html). + **Jump to definition:** ¶ `[Interface]``# Name = node1.example.tld``Address = 192.0.2.3/32``Address = 192.0.2.3/32` (wg-quick only)
`ListenPort = 51820``PrivateKey = localPrivateKeyAbcAbcAbc=``DNS = 1.1.1.1,8.8.8.8``Table = 12345``MTU = 1420``PreUp = /bin/example arg1 arg2 %i``PostUp = /bin/example arg1 arg2 %i``PreDown = /bin/example arg1 arg2 %i``PostDown = /bin/example arg1 arg2 %i``DNS = 1.1.1.1,8.8.8.8` (wg-quick only)
`Table = 12345` (wg-quick only)
`MTU = 1420` (wg-quick only)
`PreUp = /bin/example arg1 arg2 %i` (wg-quick only)
`PostUp = /bin/example arg1 arg2 %i` (wg-quick only)
`PreDown = /bin/example arg1 arg2 %i` (wg-quick only)
`PostDown = /bin/example arg1 arg2 %i` (wg-quick only)
`[Peer]`