unitoo/configurations-ansible
1
0
Fork 1
Code Issues 4 Pull requests Releases Packages Activity

update README pi-hole role

Browse source
This commit is contained in:
Claudio Maradonna 2022-11-21 17:40:47 +01:00
parent 83ead6aefa
commit a373a6dac4
Signed by untrusted user who does not match committer: claudiomaradonna
GPG key ID: 0CBA58694C5680D9
2 changed files with 13 additions and 13 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
roles/os-updates/README.md
View file

@ -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
-------

24
roles/pi-hole/README.md
View file

@ -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)