diff --git a/README.md b/README.md index f26a607..f480f15 100644 --- a/README.md +++ b/README.md @@ -6,7 +6,7 @@ I have various mass-storage NFS/SMB shares which are only available locally, mor Though secure, this imposes the obvious limitation of only being able to access said servers or shares when I'm at home. -While maintaining security, and exposing my network as little as possible, I desired a reliable and minimalistic way to access these resources when away from home. +While maintaining security, and exposing my network as little as possible, I desired a reliable and minimalistic way to access these resources when away from home. For this task, WireGuard's cryptography, asymmetric key-paring and minimal overhead provided the perfect solution. @@ -45,9 +45,9 @@ For this task, WireGuard's cryptography, asymmetric key-paring and minimal overh - Fully automated server-side deployment via an Ansible playbook -- Efficent use of address space with a /31 subnet prefix following RFC 3021, intended for 1 man use and management +- Efficent use of address space, following RFC 3021, utilizing a /31 subnet prefix. Intended for one man use -- Dynamic IP hosting supported via utilizing [BashDDNS](https://git.tobiastime.xyz/Tobias/BashDDNS), and specifying a domain name as the endpoint for the client +- Dynamic IP home addresses supported via utilizing [BashDDNS](https://git.tobiastime.xyz/Tobias/BashDDNS), and specifying a domain name as the endpoint for the client - Lightweight, with a dedicated virtual machine requiring less than 256MBs of RAM @@ -63,7 +63,7 @@ The wireguard.ini file must be edited with the relevant host/user/python interpr The playbook is written for a RHEL-based WireGuard server. -To set up from scratch after cloning this repository, from the root of the directory, on an Ansible Control Node run, +To set up from scratch, after cloning this repository on an Ansible Control Node, from the root of the directory, run: ``` bash ansible-playbook -i wireguard.ini playbooks/master.yml @@ -73,7 +73,7 @@ Relevant port forwarding will need to be implemented on the router/firewall. It is also highly recommended to make a DHCP reservation for the WireGuard VM, or to manaully assign a static IP, to avoid the VPN tunnel breaking through IP changes. -Client and server public/private keys will be located in ``` /etc/wireguard/ ``` after set up on the remote machine, and can be relocated as desired. +After set up client and server public/private keys will be located in ``` /etc/wireguard/ ``` on the remote machine, and can be relocated as desired. A typical client set up is,