diff --git a/wireguard/README.md b/wireguard/README.md new file mode 100644 index 0000000..df836aa --- /dev/null +++ b/wireguard/README.md @@ -0,0 +1,28 @@ +This script create a call point to checj the status of a remote WG server. + +1 - Open firewall to income traefik on port 9876. If using firewalld and depending your config: + +``` +sudo firewall-cmd --permanent --remove-rich-rule='rule family="ipv4" source address="origin_ip" port protocol="tcp" port="9876" accept' +``` + +2 - Enable and start the service: + +``` +sudo systemctl enable --now wg-health-api.service +``` + +3 - Check you WG interface name and change it in the Python script: + +``` +sudo wg show +``` + +4 - Test the call point be using curl from a machine in a diffrent IP to full test firewall and the script as example: + +``` +curl http://remote-wg-ip:9876/health +{"message":"WireGuard interface \"wg0\" is active.","status":"ok"} +``` + +This can be added as example to uptime-kuma! \ No newline at end of file