summaryrefslogtreecommitdiffstats
path: root/roles/pihole/README.md
diff options
context:
space:
mode:
authorAhmed Abdelhalim <[email protected]>2025-08-11 21:50:28 +0200
committerAhmed Abdelhalim <[email protected]>2025-08-11 23:28:42 +0200
commit8f539a76effcfb794145905736106de9e7f6aa8d (patch)
tree2538bb504082370f3d14da549b6a5e7e6f5ad487 /roles/pihole/README.md
parentbed8aaaeb0b63b2072fbd030d76f8f928432e7b8 (diff)
Add pihole role to configure raspberry pi
Diffstat (limited to 'roles/pihole/README.md')
-rw-r--r--roles/pihole/README.md13
1 files changed, 13 insertions, 0 deletions
diff --git a/roles/pihole/README.md b/roles/pihole/README.md
new file mode 100644
index 00000000..719020b5
--- /dev/null
+++ b/roles/pihole/README.md
@@ -0,0 +1,13 @@
+# Ansible Role: pihole
+
+This role configure the [pihole](https://github.com/pi-hole/pi-hole) DNS Sinkhole.
+
+## Role Variables
+
+- `pihole_password` the pi-hole web-server plain text password (default: `changeme`).
+- `pihole_totp_secret` the pi-hole TOTP 2FA secret (default: `CHANGEME`).
+- `pihole_interface` the interface to bind the pi-hole on (default: "{{ ansible_default_ipv4.interface }}").
+- `pihole_dns` the list of DNS servers to use as upstreams (default: `[9.9.9.9, 1.1.1.1, 8.8.8.8]`).
+- `pihole_dns_blocking_enabled` the boolean flag to toggle DNS blocking (default: true).
+- `pihole_dhcp_enabled` the boolean flag to toggle DHCP on the pi-hole (default: false).
+- `pihole_domain` the domain name to be configured when the pi is exposed over the internet (default: "").