ansible-pi-hole

Eine Ansible-Rolle zur Installation von Pi-Hole

Rollenkonfiguration

• pi_hole_repo (Standard: "https://github.com/pi-hole/pi-hole.git") - definiert das pi-hole Repository
• pi_hole_prerequisites (Standard: "git") - definiert die Voraussetzungen für pi-hole

Pi-hole Konfiguration definieren

Fügen Sie die pi-hole Variablen für die Konfiguration hinzu. Diese Variablen können weggelassen werden.

• pi_hole_version - (Standard: "HEAD") - definiert den Branch/Tag/Commit des pi-hole Repositories, der geklont werden soll
• pi_hole_download_dir - (Standard: "/home/pihole") - definiert das Basisverzeichnis für den Klon von pi-hole
• pi_hole_install_dir - (Standard: "pi-hole") - definiert das Verzeichnis, in das pi-hole geklont werden soll
• pi_hole_query_logging - (Standard: true) - definiert, ob pi-hole Abfragen protokolliert
• pi_hole_install_web_server - (Standard: true) - definiert, ob der pi-hole Webserver installiert werden muss
• pi_hole_install_web_interface - (Standard: true) - definiert, ob die pi-hole Weboberfläche installiert werden muss
• pi_hole_enable_lighttpd - (Standard: true) - ob lighttpd aktiviert werden muss
• pi_hole_webpasswd - (Standard: weglassen) - definiert das Passwort für die pi-hole Weboberfläche, falls es weggelassen wird, wird eines generiert
• pi_hole_dnsmasq_listening - (Standard: "single") -
• pi_hole_dns_1 - (Standard: "8.8.8.8") - der pi-hole Upstream DNS-Server
• pi_hole_dns_1_port - (Standard: "53") - der Port des pi-hole Upstream DNS-Servers
• pi_hole_dns_2 - (Standard: "8.8.4.4") - der pi-hole Upstream DNS-Server
• pi_hole_dns_1_port - (Standard: "53") - der Port des pi-hole Upstream DNS-Servers
• pi_hole_fqdn_required - (Standard: false) - ob pi-hole vollständige FQDN-Abfragen benötigt
• pi_hole_bogus_priv - (Standard: false) - ob pi-hole falsche Antworten für private Zonen gibt
• pi_hole_dnssec - (Standard: false) - ob pi-hole DNSSEC verwendet
• pi_hole_rev_server - (Standard: true) - ob pi-hole auf rückwärts gerichtete Abfragen antwortet
• pi_hole_rev_server_domain - (Standard: "") - der rückwärts gerichtete Domainname von pi-hole
• pi_hole_rev_server_target - (Standard: "") - das Ziel des rückwärts gerichteten Servers von pi-hole
• pi_hole_rev_server_cidr - (Standard: "") - CIDR für den rückwärts gerichteten pi-hole
• pi_hole_blocking_enabled - (Standard: true) - aktiviert das Blockieren durch pi-hole

Pi-hole DHCP-Konfiguration definieren

• pi_hole_dhcp_active - (Standard: false) - aktiviert den pi-hole DHCP-Server
• pi_hole_dhcp_start - (Standard: "") - die erste zu vergebende IP-Adresse
• pi_hole_dhcp_end - (Standard: "") - die letzte zu vergebende IP-Adresse
• pi_hole_dhcp_router - (Standard: "") - Gateway-IP-Adresse
• pi_hole_dhcp_leasetime - (Standard: "24") - DHCP-Leasing-Zeit
• pi_hole_domain - (Standard: "lan") - der Domainname von pi-hole
• pi_hole_dhcp_ipv6 - (Standard: false) - aktiviert die Unterstützung für IPv6
• pi_hole_dhcp_rapid_commit - (Standard: false) - aktiviert DHCPv4 schnelles Commit

Pi-hole lokale DNS-Konfiguration definieren

• pi_hole_local_dns_records - (Standard: "") - definiert lokale DNS-Einträge für pi-hole. Erwartet eine Liste von Dictionaries, wobei jedes Element einen Schlüssel ip und name enthält.

Beispiel:

vars:
  pi_hole_local_dns_records:
    - name: db.lan
      ip: 10.0.13.37
    - name: web.lan
      ip: 10.0.13.38

Pi-hole FTL-Konfiguration definieren

Fügen Sie die pi-hole-FTL Variablen für die Konfiguration hinzu. Diese Variablen können weggelassen werden.

• pi_hole_ftl_blockingmode - (Standard: "NULL") - Wie sollte FTL auf blockierte Abfragen antworten?
• pi_hole_ftl_cname_deep_inspect - (Standard: true) - Verwenden Sie diese Option, um die tiefgehende CNAME-Inspektion zu deaktivieren. Dies kann für sehr schwache Geräte von Vorteil sein.
• pi_hole_ftl_block_esni - (Standard: true) - Verschlüsselte Servernamenindikation (ESNI) ist ein guter Schritt in die richtige Richtung, um die Privatsphäre im Web zu verbessern. ESNI verhindert, dass Beobachter den TLS Servernamenindikations- (SNI-) Erweiterung abfangen, indem sie diese verschlüsselt. Dadurch wird verhindert, dass die SNI verwendet wird, um zu bestimmen, welche Websites Benutzer besuchen.
• pi_hole_ftl_maxlogage - (Standard: "24.0") - Wie viele Stunden an Abfragen sollten aus der Datenbank und den Protokollen importiert werden?
• pi_hole_ftl_privacylevel - (Standard: "0") - Welches Datenschutzniveau wird verwendet?
• pi_hole_ftl_ignore_localhost - (Standard: "no") - Soll FTL Abfragen von der lokalen Maschine ignorieren?
• pi_hole_ftl_query_analysis - (Standard: "yes") - Soll FTL AAAA-Abfragen analysieren? Der DNS-Server bearbeitet AAAA-Abfragen unabhängig von dieser Einstellung gleich. Diese Einstellung ignoriert nur AAAA-Abfragen bei der Berechnung der Statistiken von Pi-hole. Diese Einstellung gilt als veraltet und kann in einer zukünftigen Version entfernt werden.
• pi_hole_ftl_analyze_only_a_and_aaaa - (Standard: false) - Soll FTL nur A und AAAA-Abfragen analysieren?
• pi_hole_ftl_socket_listening - (Standard: "localonly") - Nur für lokale Socket-Verbindungen hören oder alle Verbindungen zulassen
• pi_hole_ftl_port - (Standard: "4711") - Auf welchem Port sollte FTL hören?
• pi_hole_ftl_resolve_ipv6 - (Standard: "yes") - Soll FTL versuchen, IPv6-Adressen in Hostnamen aufzulösen?
• pi_hole_ftl_resolve_ipv4 - (Standard: "yes") - Soll FTL versuchen, IPv4-Adressen in Hostnamen aufzulösen?
• pi_hole_ftl_delay_startup - (Standard: "0") - Bei bestimmten Konfigurationen möchten Sie möglicherweise, dass FTL eine bestimmte Zeit wartet, bevor es versucht, den DNS-Resolver zu starten. Dies ist typischerweise der Fall, wenn Netzwerkschnittstellen erst spät während des Systemstarts erscheinen und die Startup-Prioritäten der Schnittstellen nicht korrekt konfiguriert sind. Diese Einstellung kann jeden ganzen Wert zwischen 0 und 300 Sekunden annehmen.
• pi_hole_ftl_nice - (Standard: "-10") - Kann verwendet werden, um die Priorität von Pi-hole FTL zu ändern. Standardwert ist -10 und kann vollständig deaktiviert werden, indem ein Wert von -999 gesetzt wird.
• pi_hole_ftl_names_from_netdb - (Standard: true) - Steuert, ob FTL die Rückfalloption nutzen sollte, um Clientnamen aus der Überprüfung der Netzwerktabelle zu erhalten. Dieses Verhalten kann mit dieser Option deaktiviert werden.
• pi_hole_refresh_hostnames - (Standard: "IPV4") - Mit dieser Option können Sie ändern, wie (und ob) stündliche PTR-Anfragen gestellt werden, um Änderungen in den Client- und Upstream-Server-Hostnamen zu überprüfen.
• pi_hole_ftl_dbimport - (Standard: "true") - Soll FTL Informationen aus der Datenbank beim Start laden, um über die neuesten Historien informiert zu sein?
• pi_hole_ftl_maxdbdays - (Standard: "365") - Wie lange sollen Abfragen in der Datenbank gespeichert werden? Wenn auf 0 gesetzt, wird die Datenbank deaktiviert.
• pi_hole_ftl_dbinterval - (Standard: "1.0") - Wie häufig speichern wir Abfragen in der Datenbank von FTL [Minuten]?
• pi_hole_ftl_dbfile - (Standard: "/etc/pihole/pihole-FTL.db") - Geben Sie den Pfad und den Dateinamen der SQLite3-Datenbank von FTL an. Wenn dies auf DBFILE= gesetzt wird, deaktiviert es die Datenbank vollständig.
• pi_hole_ftl_logfile - (Standard: "/var/log/pihole-FTL.log") - Der Speicherort der Protokolldatei von FTL. Wenn Sie die Protokolldatei an einen anderen Ort verschieben möchten.
• pi_hole_ftl_pidfile - (Standard: "/run/pihole-FTL.pid") - Die Datei, die die PID des Hauptprozesses von FTL enthält.
• pi_hole_ftl_portfile - (Standard: "/run/pihole-FTL.port") - Die Datei, die den Port enthält, auf dem die API von FTL lauscht.
• pi_hole_ftl_socket_file - (Standard: "/run/pihole/FTL.sock") - Die Datei, die den Socket enthält, auf dem die API von FTL lauscht.
• pi_hole_ftl_setupvarsfile - (Standard: "/etc/pihole/setupVars.conf") - Die Konfigurationsdatei von Pi-hole, die z.B. den aktuellen Blockierungsstatus enthält (nicht ändern).
• pi_hole_ftl_macvendordb - (Standard: "/etc/pihole/macvendor.db") - Die Datenbank enthält MAC -> Herstellerinformationen für die Netzwerktabelle.
• pi_hole_ftl_gravitydb - (Standard: "/etc/pihole/gravity.db") - Geben Sie den Pfad und den Dateinamen der SQLite3-Gravitationsdatenbank von FTL an. Diese Datenbank enthält alle für die DNS-Blockierung von Pi-hole relevanten Domains.
• pi_hole_ftl_debug_all - (Standard: false) - Aktiviert alle Debug-Flags. Wenn dies auf true gesetzt ist, werden alle anderen Debug-Konfigurationsoptionen ignoriert.
• pi_hole_ftl_debug_database - (Standard: false) - Gibt Debugging-Informationen zu Datenbankaktionen aus. Dies zeigt die durchgeführten SQL-Anweisungen sowie einige allgemeine Informationen wie die Zeit, die benötigt wurde, um die Abfragen zu speichern, und wie viele in der Datenbank gespeichert wurden.
• pi_hole_ftl_debug_networking - (Standard: false) - Gibt eine Liste der bei der Initialisierung von Pi-hole-FTL erkannten Schnittstellen aus. Außerdem wird ausgegeben, ob diese Schnittstellen IPv4 oder IPv6 sind.
• pi_hole_ftl_debug_locks - (Standard: false) - Gibt Informationen zu gemeinsamen Speicherlocks aus. Nachrichten werden erzeugt, während auf einen Lock gewartet, erlangt oder freigegeben wird.
• pi_hole_ftl_debug_queries - (Standard: false) - Gibt umfangreiche Abfrageinformationen aus (Domains, Typen, Antworten usw.). Dies war immer Teil des legacy Debug-Modus von Pi-hole-FTL.
• pi_hole_ftl_debug_flags - (Standard: false) - Gibt die Flags von Abfragen aus, die von den DNS-Hooks empfangen wurden. Nur wirksam, wenn DEBUG_QUERIES ebenfalls aktiviert ist.
• pi_hole_ftl_debug_shmem - (Standard: false) - Gibt Informationen zu Shared-Memory-Puffern aus. Nachrichten beziehen sich entweder auf das Erstellen oder Vergrößern von Shared-Memory-Objekten oder auf String-Injektionen.
• pi_hole_ftl_debug_gc - (Standard: false) - Gibt Informationen zur Garbage Collection (GC) aus: Was entfernt werden soll, wie viele entfernt wurden und wie lange GC gedauert hat.
• pi_hole_ftl_debug_arp - (Standard: false) - Gibt Informationen zur Verarbeitung der ARP-Tabelle aus: Wie lange das Parsen gedauert hat, ob die gelesenen MAC-Adressen gültig sind und ob die macvendor.db-Datei existiert.
• pi_hole_ftl_debug_regex - (Standard: false) - Steuert, ob FTLDNS erweiterte Details zur Regex-Übereinstimmung in die Protokolle von pihole-FTL ausgeben soll.
• Auf Grund von veralteten Gründen unterstützen wir auch die folgende Einstellung für dasselbe Verhalten: REGEX_DEBUGMODE=false|true. Beachten Sie, dass wenn eine von beiden auf true gesetzt wird, die andere nicht verwendet werden kann, um diese Einstellung wieder zu deaktivieren.
• pi_hole_ftl_debug_api - (Standard: false) - Gibt zusätzliche Debugging-Informationen während der Telnet-API-Aufrufe aus. Derzeit nur verwendet, um zusätzliche Informationen beim Abrufen aller Abfragen zu senden.
• pi_hole_ftl_debug_overtime - (Standard: false) - Gibt Informationen zu überzeitlichen Speicheroperationen aus, wie z.B. zur Initialisierung oder zum Verschieben von überzeitlichen Slots.
• pi_hole_ftl_debug_extbloqued - (Standard: false) - Gibt Informationen darüber aus, warum FTL entschieden hat, dass bestimmte Abfragen als extern blockiert erkannt wurden.
• pi_hole_ftl_debug_caps - (Standard: false) - Gibt Informationen zu den Berechtigungen aus, die dem Prozess pihole-FTL erteilt wurden. Die aktuellen Berechtigungen werden beim Empfang von SIGHUP ausgegeben, d.h. die aktuelle Berechtigungssetzung kann ohne Neustart von pihole-FTL abgefragt werden (indem DEBUG_CAPS=true gesetzt wird und danach killall -HUP pihole-FTL gesendet wird).
• pi_hole_ftl_debug_dnsmasq_lines - (Standard: false) - Gibt die Datei und die Zeile an, die ein dnsmasq-Ereignis in die Protokolldateien von FTL verursacht hat. Dies ist nützlich, um zusätzliche Hooks zu implementieren, die in FTL fehlen.
• pi_hole_ftl_debug_vectors - (Standard: false) - FTL verwendet dynamisch zugewiesene Vektoren für verschiedene Aufgaben. Diese Konfigurationsoption aktiviert umfangreiche Debugging-Informationen, wie z.B. Informationen zu Zuweisung, Referenzierung, Löschung und Anhängen.
• pi_hole_ftl_debug_resolver - (Standard: false) - Umfangreiche Informationen zur Auflösung von Hostnamen, wie z.B. welche DNS-Server bei den ersten und zweiten Versuchen zur Auflösung von Hostnamen verwendet werden (betrifft nur intern generierte PTR-Abfragen).
• pi_hole_ftl_rate_limit - (Standard: "1000/60") - Blockiert Clients, die mehr als x Abfragen (Standardwert 1000) innerhalb von y Sekunden (Standardwert 60) stellen. Die Ratenbeschränkung kann vollständig deaktiviert werden, indem beide Werte auf null gesetzt werden.