summaryrefslogtreecommitdiffstats
path: root/roles/pihole/meta/argument_specs.yml
blob: c86fd5a0ca2775ed8fe731ab1da4617d0ad1f730 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
---
argument_specs:
  main:
    options:
      pihole_password:
        type: "str"
        description: "The pi-hole web-server plain text password (double sha265 hashed) default: changeme"
        default: "{{ ('changeme' | hash('sha256') | hash('sha256'))[:64] }}"
      pihole_totp_secret:
        type: "str"
        description: "The pi-hole TOTP 2FA secret"
        default: "CHANGEME"
      pihole_dns:
        type: "list"
        description: "The list of DNS servers to use as upstreams"
        elements: "str"
        default:
          - "1.1.1.1" # Cloudflare
          - "8.8.8.8" # Google
      pihole_interface:
        type: "str"
        description: "The interface to bind the pi-hole on"
        default: "eth0"
      pihole_dns_blocking_enabled:
        type: "bool"
        description: "The boolean flag to toggle DNS blocking"
        default: true
      pihole_dhcp_enabled:
        type: "bool"
        description: "The boolean flag to toggle DHCP on the pi-hole"
        default: false
      pihole_dhcp_start:
        type: "str"
        description: "The dhcp start address"
      pihole_dhcp_end:
        type: "str"
        description: "The dhcp end address"
      pihole_dhcp_router:
        type: "str"
        description: "The dhcp server router (gateway) address"
      pihole_dhcp_lease_time:
        type: "str"
        description: "The dhcp lease time string ex. ('45m', '1h', '2d', '1w') empty defaults to dnsmasq default"
        default: ""
      pihole_dhcp_domain:
        type: "str"
        description: "The dhcp local domain extension"
        default: "local"
      pihole_dhcp_hosts:
        type: "list"
        description: "The list of static DHCP host reservations (format: MAC,IP,hostname)"
        elements: "str"
        default: []
      pihole_domain:
        type: "str"
        description: "The domain name to be configured when the pi is exposed over the internet"
        default: ""
      pihole_port:
        type: "str"
        description: "The port to serve pihole on, when empty use pihole default 80,433"
        default: "8081"
      pihole_hostname:
        type: "str"
        description: "FQDN for the pihole nginx vhost (e.g. 'dns.home.arpa')."
        default: "dns.home.arpa"
      pihole_dns_hosts:
        type: "list"
        description: "Custom DNS A records written to pihole.toml [dns] hosts (format: 'IP HOSTNAME')"
        elements: "str"
        default: []