configurations-ansible/roles/pi-hole/README.md

37 lines
959 B
Markdown

pi-hole
=========
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
------------
.
Role Variables
--------------
- **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
------------
.
Example Playbook
----------------
`ansible-playbook -i inventory/example.yml pi-hole.yml --extra-vars="target=example_target"`
License
-------
GPLv3
Author Information
------------------
- [Claudio Maradonna](https://social.unitoo.it/claudio)