aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md19
1 files changed, 17 insertions, 2 deletions
diff --git a/README.md b/README.md
index ca7e944..85affbc 100644
--- a/README.md
+++ b/README.md
@@ -1,6 +1,6 @@
1# Wireguard configuration manager 1# Wireguard server manager
2 2
3`wgmgr` is a command-line configuration manager for the [Wireguard](https://wireguard.org) VPN solution. It expects a traditional client-server relationship, and cannot be used to handle meshed networks. 3`wgmgr` is a command-line manager for the server part of the [Wireguard](https://wireguard.org) VPN solution. It expects a traditional client-server relationship, and cannot be used to handle meshed networks.
4 4
5It handles client creation and removal, and will auto-generate the corresponding private and public keys. It can also generate the configuration file for each client. 5It handles client creation and removal, and will auto-generate the corresponding private and public keys. It can also generate the configuration file for each client.
6 6
@@ -53,6 +53,21 @@ Options:
53 -V, --version Print version 53 -V, --version Print version
54``` 54```
55 55
56## Wireguard configuration file
57
58This software will parse and edit the Wireguard configuration file specified in `/etc/wgmgr.conf`. While several protections are in place, be advised that this software *might* permanently destroy your Wireguard configuration. Always have backups!
59
60Each new client is added to the configuration file with a `[Peer]` stanza like the following:
61
62```
63# The Peer Name
64[Peer]
65AllowedIPs = 10.8.0.2/32
66PublicKey = GSiujJjngvyLTR0/93l/EUGIs7ohDpKDhoa0WrEXJnA=
67```
68
69The corresponding private key will be stored in `/etc/wireguard/private_keys/The Peer Name`. Permissions should automatically be set to `rw-------` (600), preventing anyone but root from reading it.
70
56## Reporting bugs 71## Reporting bugs
57 72
58Please report any bugs you find to [bugs+wgmgr@sixfoisneuf.fr](mailto:bugs+wgmgr@sixfoisneuf.fr). Contributions are welcomed, as long as they follow the [git send-email](https://git-send-email.io) format. 73Please report any bugs you find to [bugs+wgmgr@sixfoisneuf.fr](mailto:bugs+wgmgr@sixfoisneuf.fr). Contributions are welcomed, as long as they follow the [git send-email](https://git-send-email.io) format.