From 9a6ac67e2037e2d1cabe107010bf8654390c80cc Mon Sep 17 00:00:00 2001 From: Jose Date: Sun, 25 Jan 2026 10:44:26 +0100 Subject: [PATCH] =?UTF-8?q?docs=20=F0=9F=93=9D:=20Reformatted=20README.md?= =?UTF-8?q?=20for=20better=20readability=20and=20added=20table=20of=20cont?= =?UTF-8?q?ents.?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Improved the structure and accessibility of the README file by reformatting it and adding a table of contents to make it easier for users to navigate. --- README.md | 25 +++++++++++++------------ 1 file changed, 13 insertions(+), 12 deletions(-) diff --git a/README.md b/README.md index 87076cd..7509c3a 100644 --- a/README.md +++ b/README.md @@ -1,22 +1,23 @@ # ansible_proxmox_WOL An Ansible role that configures **persistent Wake‑on‑LAN (WOL)** on Proxmox VE hosts. -It discovers all physical Ethernet interfaces, validates WOL support, and then enables or disables WOL on the interfaces that back the bridges you specify. -Unlike many WOL setups that rely on *udev* rules, this role uses a lightweight **systemd template unit** (`wol@.service`) so the setting is applied automatically each time an interface comes up, and it survives reboots without any extra steps. +It discovers all physical Ethernet interfaces, validates WOL support, and then enables or disables +WOL on the interfaces that back the bridges you specify. Unlike many WOL setups that rely on *udev* rules, +this role uses a lightweight **systemd template unit** (`wol@.service`) so the setting is applied automatically each time an interface comes up, and it survives reboots without any extra steps. --- ## Table of Contents -- [Features](#features) -- [Prerequisites](#prerequisites) -- [Role Variables](#role-variables) -- [How It Works](#how-it-works) -- [Usage](#usage) -- [Common Proxmox Scenarios](#common-proxmox-scenarios) -- [Troubleshooting](#troubleshooting) -- [License](#license) -- [Author](#author) +- [Features](#features) +- [Prerequisites](#prerequisites) +- [Role Variables](#role-variables) +- [How It Works](#how-it-works) +- [Usage](#usage) +- [Common Proxmox Scenarios](#common-proxmox-scenarios) +- [Troubleshooting](#troubleshooting) +- [License](#license) +- [Author](#author) --- @@ -53,7 +54,7 @@ Unlike many WOL setups that rely on *udev* rules, this role uses a lightweight * wol_bridges: vmbr0 # string or list – bridges that should have WOL enabled wol_mode: "g" # "g"=magic packet (recommended), "d"=disable, "p"/"u"/"m"/"b" for other modes wol_verify: true # Verify the interface state after changes -wol_report_mac: true # Include MAC addresses of WOL‑capable senders in the report +wol_report_mac: true # Include MAC addresses of WOL-capable senders in the report ``` | Variable | Default | Type | Description |