aboutsummaryrefslogtreecommitdiffstatshomepage
path: root/roles/wireguard/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'roles/wireguard/README.md')
-rw-r--r--roles/wireguard/README.md6
1 files changed, 6 insertions, 0 deletions
diff --git a/roles/wireguard/README.md b/roles/wireguard/README.md
new file mode 100644
index 0000000..47b8091
--- /dev/null
+++ b/roles/wireguard/README.md
@@ -0,0 +1,6 @@
+This role configures a WireGuard interface using wireguard-tools and the
+wg-quick systemd service.
+
+It accepts the interface name, the private key and a list of peers; see the
+template file to discover what parameters are supported. I use it to set up all
+of my WireGuard servers.