From 92082e7dd4fbfa8e64810d75a42ab4824fd761d0 Mon Sep 17 00:00:00 2001 From: Orazio Date: Mon, 14 Sep 2020 16:42:11 +0200 Subject: [PATCH] Updated WireGuard (markdown) --- WireGuard.md | 42 ++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 42 insertions(+) diff --git a/WireGuard.md b/WireGuard.md index 57c5c7b..bf480d4 100644 --- a/WireGuard.md +++ b/WireGuard.md @@ -1,3 +1,45 @@ +# Managing the PiVPN + +## `pivpn add` +You will be prompted to enter a name for your client. Pick anything you like and hit 'enter'. +The script will assemble the client .conf file and place it in the directory 'configs' within your +home directory. + +## `pivpn remove` +Asks you for the name of the client to remove. Once you remove a client, it will no longer allow you to use +the given client config (specifically its public key) to connect. This is useful for many reasons but some ex: +You have a profile on a mobile phone and it was lost or stolen. Remove its key and generate a new +one for your new phone. Or even if you suspect that a key may have been compromised in any way, +just remove it and generate a new one. + +## `pivpn list` +If you add more than a few clients, this gives you a nice list of their names and associated keys. + +# Connecting to the PiVPN + +## Windows/Mac + +Download the [WireGuard GUI app](https://www.wireguard.com/install/), import the configuration and activate the tunnel. + +## Linux + +Install [WireGuard](https://www.wireguard.com/install/) following the instructions for your distribution. Now, as root user, create the /etc/wireguard folder and prevent anyone but root to enter it (you only need to do this the first time): +``` +mkdir -p /etc/wireguard +chown root:root /etc/wireguard +chmod 700 /etc/wireguard +``` +Move the config and activate the tunnel: +``` +mv whatever.conf /etc/wireguard/ +wg-quick up whatever +``` +Run `wg-quick down whatever` to deactivate the tunnel. + +## Android/iOS + +Run `pivpn -qr` on the PiVPN server to generate a QR code of your config, download the Wireguard app [Android link](https://play.google.com/store/apps/details?id=com.wireguard.android) / [iOS link](https://apps.apple.com/it/app/wireguard/id1441195209), click the '+' sign and scan the QR code with your phone's camera. Flip the switch to activate the tunnel. + # FAQ (Frequently Asked Questions) ## How do I use Pi-hole with PiVPN?