Tobias/WireGuard-Server-Ansible
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Update README.md

Browse Source
This commit is contained in:
Tobias
2026-06-07 11:29:48 +01:00
parent 978bfc1605
commit 5a9c4cbd44
1 changed files with 8 additions and 8 deletions
Download Patch File Download Diff File Expand all files Collapse all files

16
README.md
View File

@@ -43,11 +43,11 @@ For this task, WireGuard's cryptography, asymmetric key-paring and minimal overh
## Features ## Features
- Fully automated server-side deployment via an Ansible playbook - Fully automated server-side deployment via an Ansible playbook, handling WireGuard installation and configuration, virtual network interfaces, IP forwarding kernel parameters and firewalld rules
- Efficent use of address space, following RFC 3021, utilizing a /31 subnet prefix. Intended for one man use - Efficient use of address space, following RFC 3021 and utilizing a /31 subnet prefix. Optimized for a point-to-point connection with a single 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 - Support for Dynamic home IP addresses via [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 - Lightweight, with a dedicated virtual machine requiring less than 256MBs of RAM
@@ -59,7 +59,7 @@ For this task, WireGuard's cryptography, asymmetric key-paring and minimal overh
This only automates the server-side set up, the client will still need to be manually configured. This only automates the server-side set up, the client will still need to be manually configured.
The wireguard.ini file must be edited with the relevant host/user/python interpreter information. The ``` wireguard.ini ``` file must be edited with the appropriate host, user and python interpreter information.
The playbook is written for a RHEL-based WireGuard server. The playbook is written for a RHEL-based WireGuard server.
@@ -71,11 +71,11 @@ ansible-playbook -i wireguard.ini playbooks/master.yml
Relevant port forwarding will need to be implemented on the router/firewall. 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. It is also highly recommended to make a DHCP reservation for the WireGuard VM, or to manually assign a static IP, to prevent the VPN tunnel breaking through IP changes.
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. After setup, the 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, A typical client configuration is:
#### Interface #### Interface
@@ -85,7 +85,7 @@ A typical client set up is,
- Server Public Key, Allowed IPs (10.10.10.0/31, LAN IP range), Endpoint:51820, Persistent Keep Alive 25 seconds - Server Public Key, Allowed IPs (10.10.10.0/31, LAN IP range), Endpoint:51820, Persistent Keep Alive 25 seconds
Persistent keep alive will send a dummy packet every 25 seconds to maintain a connection, useful for when you are roaming with a mobile device and subject to frequent IP change. Persistent keep alive will send a dummy packet every 25 seconds to maintain a connection, useful for when you are roaming with a mobile device that is subject to frequent IP change.
## Extremely useful Linux tools in debugging ## Extremely useful Linux tools in debugging