ansible-pi-hole

Rola Ansible do zainstalowania Pi-Hole

Konfiguracja roli

• pi_hole_repo (domyślnie: "https://github.com/pi-hole/pi-hole.git") - zdefiniuj repozytorium pi-hole
• pi_hole_prerequisites (domyślnie: "git") - zdefiniuj wymagania wstępne pi-hole

Definiowanie konfiguracji pi-hole

Dodaj zmienną pi-hole do konfiguracji. Te zmienne mogą być pominięte.

• pi_hole_version - (domyślnie: "HEAD") - zdefiniuj gałąź/tag/komit repozytorium pi-hole, które zostanie sklonowane
• pi_hole_download_dir - (domyślnie: "/home/pihole") - zdefiniuj podstawowy katalog do sklonowania pi-hole
• pi_hole_install_dir - (domyślnie: "pi-hole") - zdefiniuj katalog, w którym ma być sklonowany pi-hole
• pi_hole_query_logging - (domyślnie: true) - zdefiniuj, czy pi-hole będzie rejestrować zapytania
• pi_hole_install_web_server - (domyślnie: true) - zdefiniuj, czy serwer www pi-hole powinien być zainstalowany
• pi_hole_install_web_interface - (domyślnie: true) - zdefiniuj, czy interfejs webowy pi-hole powinien być zainstalowany
• pi_hole_enable_lighttpd - (domyślnie: true) - czy lighttpd ma być włączony
• pi_hole_webpasswd - (domyślnie: pominięte) - zdefiniuj hasło do pi-hole, jeśli pominięte, zostanie wygenerowane
• pi_hole_dnsmasq_listening - (domyślnie: "single") -
• pi_hole_dns_1 - (domyślnie: "8.8.8.8") - serwer DNS upstream pi-hole
• pi_hole_dns_1_port - (domyślnie: "53") - port serwera DNS upstream pi-hole
• pi_hole_dns_2 - (domyślnie: "8.8.4.4") - drugi serwer DNS upstream pi-hole
• pi_hole_dns_2_port - (domyślnie: "53") - port drugiego serwera DNS upstream pi-hole
• pi_hole_fqdn_required - (domyślnie: false) - czy pi-hole wymaga zapytań FQDN
• pi_hole_bogus_priv - (domyślnie: false) - czy pi-hole odpowiada na fałszywe zapytania w prywatnej strefie
• pi_hole_dnssec - (domyślnie: false) - pi-hole używa dnssec
• pi_hole_rev_server - (domyślnie: true) - czy pi-hole odpowiada na zapytania odwrotne
• pi_hole_rev_server_domain - (domyślnie: "") - odwrotna nazwa domeny pi-hole
• pi_hole_rev_server_target - (domyślnie: "") - cel serwera odwrotnego pi-hole
• pi_hole_rev_server_cidr - (domyślnie: "") - CIDR odwrotny dla pi-hole
• pi_hole_blocking_enabled - (domyślnie: true) - włącz blokowanie przez pi-hole

Definiowanie konfiguracji DHCP dla pi-hole

• pi_hole_dhcp_active - (domyślnie: false) - włącz serwer DHCP pi-hole
• pi_hole_dhcp_start - (domyślnie: "") - pierwszy adres IP do przydzielenia
• pi_hole_dhcp_end - (domyślnie: "") - ostatni adres IP do przydzielenia
• pi_hole_dhcp_router - (domyślnie: "") - adres IP bramy
• pi_hole_dhcp_leasetime - (domyślnie: "24") - czas dzierżawy DHCP
• pi_hole_domain - (domyślnie: "lan") - nazwa domeny pi-hole
• pi_hole_dhcp_ipv6 - (domyślnie: false) - włącz obsługę IPv6
• pi_hole_dhcp_rapid_commit - (domyślnie: false) - włącz szybki commit DHCP v4

Definiowanie lokalnej konfiguracji DNS dla pi-hole

• pi_hole_local_dns_records - (domyślnie: "") - zdefiniuj lokalne rekordy DNS pi-hole. Oczekuje listy słowników, z których każdy zawiera klucze ip i name.

Przykład:

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

Definiowanie konfiguracji FTL dla pi-hole

Dodaj zmienną konfiguracji pi-hole-FTL. Te zmienne mogą być pominięte.

• pi_hole_ftl_blockingmode - (domyślnie: "NULL") - Jak FTL powinno odpowiadać na zablokowane zapytania?
• pi_hole_ftl_cname_deep_inspect - (domyślnie: true) - Użyj tej opcji, aby wyłączyć głęboką inspekcję CNAME. Może to być korzystne dla bardzo słabych urządzeń
• pi_hole_ftl_block_esni - (domyślnie: true) - Zaszyfrowane wskazanie nazwy serwera (ESNI) jest krokiem w dobrym kierunku w celu poprawy prywatności w sieci. Zapobiega to przechwytywaniu rozszerzenia TLS SNI przez obserwatorów na ścieżce, w tym dostawców usług internetowych oraz właścicieli kawiarni.
• pi_hole_ftl_maxlogage - (domyślnie: "24.0") - Jak długo zapytania powinny być importowane z bazy danych i logów?
• pi_hole_ftl_privacylevel - (domyślnie: "0") - Jakiego poziomu prywatności używać?
• pi_hole_ftl_ignore_localhost - (domyślnie: "no") - Czy FTL powinno ignorować zapytania przychodzące z lokalnej maszyny?
• pi_hole_ftl_query_analysis - (domyślnie: "yes") - Czy FTL powinno analizować zapytania AAAA?
• pi_hole_ftl_analyze_only_a_and_aaaa - (domyślnie: false) - Czy FTL powinno analizować tylko zapytania A i AAAA?
• pi_hole_ftl_socket_listening - (domyślnie: "localonly") - Słuchaj tylko lokalnych połączeń socketowych lub zezwól na wszystkie połączenia
• pi_hole_ftl_port - (domyślnie: "4711") - Na którym porcie FTL powinien słuchać?
• pi_hole_ftl_resolve_ipv6 - (domyślnie: "yes") - Czy FTL powinno próbować rozwiązywać adresy IPv6 do nazw hostów?
• pi_hole_ftl_resolve_ipv4 - (domyślnie: "yes") - Czy FTL powinno próbować rozwiązywać adresy IPv4 do nazw hostów?
• pi_hole_ftl_delay_startup - (domyślnie: "0") - W niektórych konfiguracjach może być konieczne, aby FTL czekał określoną ilość czasu przed próbą uruchomienia.
• pi_hole_ftl_nice - (domyślnie: "-10") - Można użyć do zmiany priorytetu działania Pi-hole FTL.
• pi_hole_ftl_names_from_netdb - (domyślnie: true) - Kontroluj, czy FTL powinno używać opcji zapasowej do uzyskiwania nazw klientów.
• pi_hole_refresh_hostnames - (domyślnie: "IPV4") - Z tą opcją możesz zmienić, jak (i czy) są wykonywane godzinne zapytania PTR.
• pi_hole_ftl_dbimport - (domyślnie: "true") - Czy FTL powinno wczytać informacje z bazy danych przy starcie?
• pi_hole_ftl_maxdbdays - (domyślnie: "365") - Jak długo zapytania powinny być przechowywane w bazie danych?
• pi_hole_ftl_dbinterval - (domyślnie: "1.0") - Jak często przechowujemy zapytania w bazie danych FTL [w minutach]?
• pi_hole_ftl_dbfile - (domyślnie: "/etc/pihole/pihole-FTL.db") - Specyfikuj ścieżkę i nazwę pliku bazy danych SQLite3 FTL.
• pi_hole_ftl_logfile - (domyślnie: "/var/log/pihole-FTL.log") - Lokalizacja pliku logów FTL. Jeśli chcesz przenieść plik logów w inne miejsce.
• pi_hole_ftl_pidfile - (domyślnie: "/run/pihole-FTL.pid") - Plik zawierający PID głównego procesu FTL.
• pi_hole_ftl_portfile - (domyślnie: "/run/pihole-FTL.port") - Plik zawierający port, na którym nasłuchuje API FTL.
• pi_hole_ftl_socket_file - (domyślnie: "/run/pihole/FTL.sock") - Plik zawierający socket, na którym nasłuchuje API FTL.
• pi_hole_ftl_setupvarsfile - (domyślnie: "/etc/pihole/setupVars.conf") - Plik konfiguracyjny Pi-hole zawierający np. bieżący stan blokowania (nie zmieniać).
• pi_hole_ftl_macvendordb - (domyślnie: "/etc/pihole/macvendor.db") - Baza danych zawierająca informacje o MAC -> Vendor.
• pi_hole_ftl_gravitydb - (domyślnie: "/etc/pihole/gravity.db") - Określ ścieżkę i nazwę pliku bazy danych SQLite3 gravity FTL.
• pi_hole_ftl_debug_all - (domyślnie: false) - Włącz wszystkie flagi debugowania. Jeśli jest to ustawione na true, wszystkie inne opcje debugowania są ignorowane.
• pi_hole_ftl_debug_database - (domyślnie: false) - Wyświetl informacje debugujące o działaniach bazy danych.
• pi_hole_ftl_debug_networking - (domyślnie: false) - Wyświetla listę wykrytych interfejsów podczas uruchamiania pihole-FTL.
• pi_hole_ftl_debug_locks - (domyślnie: false) - Wyświetl informacje o blokadach pamięci współdzielonej.
• pi_hole_ftl_debug_queries - (domyślnie: false) - Wyświetl szczegółowe informacje dotyczące zapytań (domeny, typy, odpowiedzi itp.).
• pi_hole_ftl_debug_flags - (domyślnie: false) - Wyświetl flagi zapytań otrzymanych przez hooki DNS.
• pi_hole_ftl_debug_shmem - (domyślnie: false) - Wyświetl informacje o buforach pamięci współdzielonej.
• pi_hole_ftl_debug_gc - (domyślnie: false) - Wyświetl informacje o zbieraniu nieużywanej pamięci (GC).
• pi_hole_ftl_debug_arp - (domyślnie: false) - Wyświetl informacje o przetwarzaniu tabeli ARP.
• pi_hole_ftl_debug_regex - (domyślnie: false) - Kontroluje, czy FTLDNS powinien wyświetlać szczegółowe informacje o dopasowaniu regex.
• pi_hole_ftl_debug_api - (domyślnie: false) - Wyświetl dodatkowe informacje debugujące podczas wywołań API telnet.
• pi_hole_ftl_debug_overtime - (domyślnie: false) - Wyświetl informacje o operacjach pamięci overtime.
• pi_hole_ftl_debug_extbloqued - (domyślnie: false) - Wyświetl informacje o tym, dlaczego FTL uznał, że niektóre zapytania zostały zablokowane zewnętrznie.
• pi_hole_ftl_debug_caps - (domyślnie: false) - Wyświetl informacje o uprawnieniach nadanych procesowi pihole-FTL.
• pi_hole_ftl_debug_dnsmasq_lines - (domyślnie: false) - Wyświetl plik i linię powodującą zdarzenie dnsmasq w plikach logów FTL.
• pi_hole_ftl_debug_vectors - (domyślnie: false) - FTL używa dynamicznie przydzielonych wektorów do różnych zadań.
• pi_hole_ftl_debug_resolver - (domyślnie: false) - Szerokie informacje dotyczące rozwiązywania nazw hostów.
• pi_hole_ftl_rate_limit - (domyślnie: "1000/60") - Blokuj klientów wykonujących więcej niż x zapytań (domyślnie 1000) w ciągu y sekund (domyślnie 60).