diff --git a/.gitattributes b/.gitattributes new file mode 100644 index 0000000..aae6a25 --- /dev/null +++ b/.gitattributes @@ -0,0 +1,2 @@ +*.yml linguist-detectable=true +*.yaml linguist-detectable=true diff --git a/README.md b/README.md index c19fa30..e715623 100644 --- a/README.md +++ b/README.md @@ -1 +1,38 @@ # Pihole Ansible role + +[![Build Status](https://travis-ci.com/blalop/pihole_role.svg?branch=main)](https://travis-ci.com/blalop/pihole_role) + +This role installs pihole via installation script. Tested on Debian && Raspbian. + +## Requirements + +No special requirements. + + +## Role vars + +| Variable | Default | Additional comments | +| :--- | :--- | :--- | +| `pihole_required_packages` | [procps] | | +| `pihole_password` | pihole | Pihole web interface password | +| `pihole_force_reinstall` | false | Forces reinstallation | +| `pihole_lighttpd_port` | 80 | Web interface port | +| `pihole_interface` | eth0 | [Pihole setup vars](https://discourse.pi-hole.net/t/what-is-setupvars-conf-and-how-do-i-use-it/3533) | +| `pihole_ipv4_address` | 0.0.0.0 | [Pihole setup vars](https://discourse.pi-hole.net/t/what-is-setupvars-conf-and-how-do-i-use-it/3533) | +| `pihole_ipv6_address` | 0:0:0:0:0:0 | [Pihole setup vars](https://discourse.pi-hole.net/t/what-is-setupvars-conf-and-how-do-i-use-it/3533) | +| `pihole_dns_1` | 8.8.8.8 | [Pihole setup vars](https://discourse.pi-hole.net/t/what-is-setupvars-conf-and-how-do-i-use-it/3533) | +| `pihole_dns_2` | 4.4.4.4 | [Pihole setup vars](https://discourse.pi-hole.net/t/what-is-setupvars-conf-and-how-do-i-use-it/3533) | +| `pihole_query_logging` | true | [Pihole setup vars](https://discourse.pi-hole.net/t/what-is-setupvars-conf-and-how-do-i-use-it/3533) | +| `pihole_web_server` | true | [Pihole setup vars](https://discourse.pi-hole.net/t/what-is-setupvars-conf-and-how-do-i-use-it/3533) | +| `pihole_web_interface` | true | [Pihole setup vars](https://discourse.pi-hole.net/t/what-is-setupvars-conf-and-how-do-i-use-it/3533) | +| `pihole_lighttpd_enabled` | true | [Pihole setup vars](https://discourse.pi-hole.net/t/what-is-setupvars-conf-and-how-do-i-use-it/3533) | + + +## Testing + +Test the role via molecule: + +``` +pipenv sync +pipenv run molecule test +``` diff --git a/tasks/main.yml b/tasks/main.yml index 1906583..6406cc0 100644 --- a/tasks/main.yml +++ b/tasks/main.yml @@ -5,6 +5,8 @@ register: pihole_version_check ignore_errors: true changed_when: false + tags: + - pihole_install - name: Pi-hole | Install include: install.yml