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

42 lines
1 KiB
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_custom_list** (array): Array of URLs that can be installed as DNS lists. **Actually doesn't clean old lists before install!**
- **pihole_install_custom_list**: If present will install custom list into the pi-hole database
Role Tags
--------------
- **global.update_only**: `pihole -up`
- **pihole.update_gravity**: If present the dns database will be updated (`pihole updateGravity`)
Dependencies
------------
- curl
- sqlite3 required by `pihole.install_custom_list`
Example Playbook
----------------
`ansible-playbook -i inventory/example.yml handbook.yml --extra-vars="target=example_target" --tags dns_filter`
License
-------
GPLv3
Author Information
------------------
- [Claudio Maradonna](https://social.unitoo.it/claudio)