From a373a6dac4b701c8f6e1c6eafcdcc4108ad2f053 Mon Sep 17 00:00:00 2001 From: Claudio Maradonna Date: Mon, 21 Nov 2022 17:40:47 +0100 Subject: [PATCH] update README pi-hole role --- roles/os-updates/README.md | 2 +- roles/pi-hole/README.md | 24 ++++++++++++------------ 2 files changed, 13 insertions(+), 13 deletions(-) diff --git a/roles/os-updates/README.md b/roles/os-updates/README.md index 5bf7924..9439132 100644 --- a/roles/os-updates/README.md +++ b/roles/os-updates/README.md @@ -22,7 +22,7 @@ Dependencies Example Playbook ---------------- -`ansible-playbook -i inventory/hive.yml os-update.yml --extra-vars="target=odroid"` +`ansible-playbook -i inventory/example.yml os-update.yml --extra-vars="target=example_target"` License ------- diff --git a/roles/pi-hole/README.md b/roles/pi-hole/README.md index 225dd44..ff79cd7 100644 --- a/roles/pi-hole/README.md +++ b/roles/pi-hole/README.md @@ -1,38 +1,38 @@ -Role Name +pi-hole ========= -A brief description of the role goes here. +This role setup minimal requirements for pi-hole setup but actually cannot install pi-hole for you. In addition setup firewall for you; can install custom list directly in the Database or update DNS Database List Requirements ------------ -Any pre-requisites that may not be covered by Ansible itself or the role should be mentioned here. For instance, if the role uses the EC2 module, it may be a good idea to mention in this section that the boto package is required. +. Role Variables -------------- -A description of the settable variables for this role should go here, including any variables that are in defaults/main.yml, vars/main.yml, and any variables that can/should be set via parameters to the role. Any variables that are read from other roles and/or the global scope (ie. hostvars, group vars, etc.) should be mentioned here as well. +**pihole_enabled** (boolean): Enable or disable pi-hole support +**pihole_install_custom_list** (boolean): If true will install custom list into the pi-hole database +**pihole_update_gravity** (boolean): If true the dns database will be updated + +**pihole_custom_list** (array): Array of URLs that can be installed as DNS lists. **Actually doesn't clean old lists before install!** Dependencies ------------ -A list of other roles hosted on Galaxy should go here, plus any details in regards to parameters that may need to be set for other roles, or variables that are used from other roles. +. Example Playbook ---------------- -Including an example of how to use your role (for instance, with variables passed in as parameters) is always nice for users too: - - - hosts: servers - roles: - - { role: username.rolename, x: 42 } +`ansible-playbook -i inventory/example.yml pi-hole.yml --extra-vars="target=example_target"` License ------- -BSD +GPLv3 Author Information ------------------ -An optional section for the role authors to include contact information, or a website (HTML is not allowed). +- [Claudio Maradonna](https://social.unitoo.it/claudio)