Skip to content

Commit 6e5afe3

Browse files
committed
Documentation & minor tag
1 parent 958c6c3 commit 6e5afe3

File tree

3 files changed

+41
-0
lines changed

3 files changed

+41
-0
lines changed

.gitattributes

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
*.yml linguist-detectable=true
2+
*.yaml linguist-detectable=true

README.md

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1 +1,38 @@
11
# Pihole Ansible role
2+
3+
[![Build Status](https://travis-ci.com/blalop/pihole_role.svg?branch=main)](https://travis-ci.com/blalop/pihole_role)
4+
5+
This role installs pihole via installation script. Tested on Debian && Raspbian.
6+
7+
## Requirements
8+
9+
No special requirements.
10+
11+
12+
## Role vars
13+
14+
| Variable | Default | Additional comments |
15+
| :--- | :--- | :--- |
16+
| `pihole_required_packages` | [procps] | |
17+
| `pihole_password` | pihole | Pihole web interface password |
18+
| `pihole_force_reinstall` | false | Forces reinstallation |
19+
| `pihole_lighttpd_port` | 80 | Web interface port |
20+
| `pihole_interface` | eth0 | [Pihole setup vars](https://discourse.pi-hole.net/t/what-is-setupvars-conf-and-how-do-i-use-it/3533) |
21+
| `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) |
22+
| `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) |
23+
| `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) |
24+
| `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) |
25+
| `pihole_query_logging` | true | [Pihole setup vars](https://discourse.pi-hole.net/t/what-is-setupvars-conf-and-how-do-i-use-it/3533) |
26+
| `pihole_web_server` | true | [Pihole setup vars](https://discourse.pi-hole.net/t/what-is-setupvars-conf-and-how-do-i-use-it/3533) |
27+
| `pihole_web_interface` | true | [Pihole setup vars](https://discourse.pi-hole.net/t/what-is-setupvars-conf-and-how-do-i-use-it/3533) |
28+
| `pihole_lighttpd_enabled` | true | [Pihole setup vars](https://discourse.pi-hole.net/t/what-is-setupvars-conf-and-how-do-i-use-it/3533) |
29+
30+
31+
## Testing
32+
33+
Test the role via molecule:
34+
35+
```
36+
pipenv sync
37+
pipenv run molecule test
38+
```

tasks/main.yml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,8 @@
55
register: pihole_version_check
66
ignore_errors: true
77
changed_when: false
8+
tags:
9+
- pihole_install
810

911
- name: Pi-hole | Install
1012
include: install.yml

0 commit comments

Comments
 (0)