ansible-pi-hole

Un rol de Ansible para instalar Pi-Hole

Configuración del rol

• pi_hole_repo (por defecto: "https://github.com/pi-hole/pi-hole.git") - define el repositorio de pi-hole
• pi_hole_prerequisites (por defecto: "git") - define los requisitos previos de pi-hole

Definir la configuración de pi-hole

Agrega la variable pi-hole para la configuración. Estas variables pueden ser omitidas.

• pi_hole_version - (por defecto: "HEAD") - define la rama/etiqueta/commit del repositorio pi-hole que se clonará
• pi_hole_download_dir - (por defecto: "/home/pihole") - define el directorio base para clonar pi-hole
• pi_hole_install_dir - (por defecto: "pi-hole") - define el directorio donde clonar pi-hole
• pi_hole_query_logging - (por defecto: true) - define si pi-hole registrará consultas
• pi_hole_install_web_server - (por defecto: true) - define si se necesita instalar el servidor web de pi-hole
• pi_hole_install_web_interface - (por defecto: true) - define si se necesita instalar la interfaz web de pi-hole
• pi_hole_enable_lighttpd - (por defecto: true) - ¿debe habilitarse lighttpd?
• pi_hole_webpasswd - (por defecto: omitir) - define la contraseña web de pi-hole, si se omite se generará una
• pi_hole_dnsmasq_listening - (por defecto: "single") -
• pi_hole_dns_1 - (por defecto: "8.8.8.8") - servidor DNS principal de pi-hole
• pi_hole_dns_1_port - (por defecto: "53") - puerto del servidor DNS principal de pi-hole
• pi_hole_dns_2 - (por defecto: "8.8.4.4") - segundo servidor DNS de pi-hole
• pi_hole_dns_2_port - (por defecto: "53") - puerto del segundo servidor DNS de pi-hole
• pi_hole_fqdn_required - (por defecto: false) - ¿es necesario que pi-hole requiera consultas FQDN?
• pi_hole_bogus_priv - (por defecto: false) - ¿responderá pi-hole con información incorrecta en la zona privada?
• pi_hole_dnssec - (por defecto: false) - pi-hole usa DNSSEC
• pi_hole_rev_server - (por defecto: true) - ¿responderá pi-hole a consultas inversas?
• pi_hole_rev_server_domain - (por defecto: "") - nombre de dominio para consultas inversas de pi-hole
• pi_hole_rev_server_target - (por defecto: "") - destino del servidor inverso de pi-hole
• pi_hole_rev_server_cidr - (por defecto: "") - CIDR inverso de pi-hole
• pi_hole_blocking_enabled - (por defecto: true) - habilitar el bloqueo de pi-hole

Definir la configuración DHCP de pi-hole

• pi_hole_dhcp_active - (por defecto: false) - habilitar el servidor DHCP de pi-hole
• pi_hole_dhcp_start - (por defecto: "") - primera dirección IP a ofrecer
• pi_hole_dhcp_end - (por defecto: "") - última dirección IP a ofrecer
• pi_hole_dhcp_router - (por defecto: "") - dirección IP del gateway
• pi_hole_dhcp_leasetime - (por defecto: "24") - tiempo de arrendamiento DHCP
• pi_hole_domain - (por defecto: "lan") - nombre de dominio de pi-hole
• pi_hole_dhcp_ipv6 - (por defecto: false) - habilitar soporte IPv6
• pi_hole_dhcp_rapid_commit - (por defecto: false) - habilitar compromiso rápido DHCP v4

Definir la configuración DNS local de pi-hole

• pi_hole_local_dns_records - (por defecto: "") - define los registros DNS locales de pi-hole. Espera una lista de diccionarios en los que cada ítem contiene una clave ip y name.

Ejemplo:

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

Definir la configuración FTL de pi-hole

Agrega la variable de configuración pi-hole-FTL. Estas variables pueden ser omitidas.

• pi_hole_ftl_blockingmode - (por defecto: "NULL") - ¿Cómo debe responder FTL a las consultas bloqueadas?
• pi_hole_ftl_cname_deep_inspect - (por defecto: true) - Usa esta opción para desactivar la inspección profunda CNAME. Esto puede ser beneficioso para dispositivos muy básicos.
• pi_hole_ftl_block_esni - (por defecto: true) - La Indicacion de Nombre de Servidor Encriptado (ESNI) es definitivamente un buen paso hacia la mejora de la privacidad en la web. Previene que observadores intermedios, incluyendo ISP y cortafuegos, intercepten la extensión de SNI en TLS al encriptarlo. Esto evita que se use SNI para determinar qué sitios están visitando los usuarios.
• pi_hole_ftl_maxlogage - (por defecto: "24.0") - ¿Cuántas horas de consultas se deben importar de la base de datos y los registros?
• pi_hole_ftl_privacylevel - (por defecto: "0") - ¿Qué nivel de privacidad se utiliza?
• pi_hole_ftl_ignore_localhost - (por defecto: "no") - ¿Debería FTL ignorar las consultas provenientes de la máquina local?
• pi_hole_ftl_query_analysis - (por defecto: "yes") - ¿Debería FTL analizar las consultas AAAA? El servidor DNS manejará las consultas AAAA de la misma manera, sin importar esta configuración. Todo lo que hace es ignorar las consultas AAAA al calcular las estadísticas de Pi-hole, esta configuración se considera obsoleta y puede ser eliminada en una versión futura.
• pi_hole_ftl_analyze_only_a_and_aaaa - (por defecto: false) - ¿Debería FTL solo analizar las consultas A y AAAA?
• pi_hole_ftl_socket_listening - (por defecto: "localonly") - Escuchar solo conexiones de socket locales o permitir todas las conexiones.
• pi_hole_ftl_port - (por defecto: "4711") - ¿En qué puerto debería escuchar FTL?
• pi_hole_ftl_resolve_ipv6 - (por defecto: "yes") - ¿Debería FTL intentar resolver direcciones IPv6 a nombres de host?
• pi_hole_ftl_resolve_ipv4 - (por defecto: "yes") - ¿Debería FTL intentar resolver direcciones IPv4 a nombres de host?
• pi_hole_ftl_delay_startup - (por defecto: "0") - En ciertas configuraciones, es posible que desee que FTL espere un tiempo determinado antes de intentar iniciar el resolvedor DNS. Esto suele ocurrir cuando las interfaces de red aparecen tarde durante el inicio del sistema y las prioridades de inicio de la interfaz están configuradas incorrectamente. Esta configuración acepta cualquier valor entero entre 0 y 300 segundos.
• pi_hole_ftl_nice - (por defecto: "-10") - Se puede utilizar para cambiar la bondad de Pi-hole FTL. Por defecto es -10 y se puede desactivar estableciendo un valor de -999.
• pi_hole_ftl_names_from_netdb - (por defecto: true) - Controla si FTL debe usar la opción de respaldo para intentar obtener nombres de cliente revisando la tabla de red. Este comportamiento se puede desactivar con esta opción.
• pi_hole_refresh_hostnames - (por defecto: "IPV4") - Con esta opción, puede cambiar cómo (y si) se realizan las solicitudes PTR horarias para verificar cambios en los nombres de host de los clientes y servidores ascendentes.
• pi_hole_ftl_dbimport - (por defecto: "true") - ¿Debería FTL cargar información de la base de datos al iniciar para conocer el historial más reciente?
• pi_hole_ftl_maxdbdays - (por defecto: "365") - ¿Cuánto tiempo deben almacenarse las consultas en la base de datos? Establecer esto en 0 desactiva la base de datos.
• pi_hole_ftl_dbinterval - (por defecto: "1.0") - ¿Con qué frecuencia almacenamos consultas en la base de datos de FTL [minutos]?
• pi_hole_ftl_dbfile - (por defecto: "/etc/pihole/pihole-FTL.db") - Especifica la ruta y el nombre del archivo de la base de datos SQLite3 de largo plazo de FTL. Establecer esto en DBFILE= desactiva la base de datos por completo.
• pi_hole_ftl_logfile - (por defecto: "/var/log/pihole-FTL.log") - La ubicación del archivo de registro de FTL. Si desea mover el archivo de registro a otro lugar.
• pi_hole_ftl_pidfile - (por defecto: "/run/pihole-FTL.pid") - El archivo que contiene el PID del proceso principal de FTL.
• pi_hole_ftl_portfile - (por defecto: "/run/pihole-FTL.port") - El archivo que contiene el puerto en el que escucha la API de FTL.
• pi_hole_ftl_socket_file - (por defecto: "/run/pihole/FTL.sock") - El archivo que contiene el socket en el que escucha la API de FTL.
• pi_hole_ftl_setupvarsfile - (por defecto: "/etc/pihole/setupVars.conf") - El archivo de configuración de Pi-hole que contiene, por ejemplo, el estado actual de bloqueo (no cambie).
• pi_hole_ftl_macvendordb - (por defecto: "/etc/pihole/macvendor.db") - La base de datos que contiene información de MAC -> Vendedor para la tabla de red.
• pi_hole_ftl_gravitydb - (por defecto: "/etc/pihole/gravity.db") - Especifica la ruta y el nombre del archivo de la base de datos SQLite3 de gravedad de FTL. Esta base de datos contiene todos los dominios relevantes para el bloqueo DNS de Pi-hole.
• pi_hole_ftl_debug_all - (por defecto: false) - Habilitar todas las banderas de depuración. Si esto se establece en true, se ignoran todas las otras opciones de configuración de depuración.
• pi_hole_ftl_debug_database - (por defecto: false) - Imprimir información de depuración sobre acciones de la base de datos. Esto imprime las declaraciones SQL realizadas, así como información general como el tiempo que tomó almacenar las consultas y cuántas se han guardado en la base de datos.
• pi_hole_ftl_debug_networking - (por defecto: false) - Imprimir una lista de las interfaces detectadas al iniciar pihole-FTL. También, imprime si estas interfaces son IPv4 o IPv6.
• pi_hole_ftl_debug_locks - (por defecto: false) - Imprimir información sobre bloqueos de memoria compartida. Se generarán mensajes al esperar, obtener y liberar un bloqueo.
• pi_hole_ftl_debug_queries - (por defecto: false) - Imprimir información extensa sobre consultas (dominios, tipos, respuestas, etc.). Esto siempre ha sido parte del modo de depuración heredado de pihole-FTL.
• pi_hole_ftl_debug_flags - (por defecto: false) - Imprimir banderas de consultas recibidas por los hooks DNS. Solo efectivo cuando DEBUG_QUERIES también está habilitado.
• pi_hole_ftl_debug_shmem - (por defecto: false) - Imprimir información sobre búferes de memoria compartida. Los mensajes se refieren a la creación o ampliación de objetos de memoria compartida o inyecciones de cadenas.
• pi_hole_ftl_debug_gc - (por defecto: false) - Imprimir información sobre la recolección de basura (GC): qué se va a eliminar, cuántos se han eliminado y cuánto tiempo tomó la GC.
• pi_hole_ftl_debug_arp - (por defecto: false) - Imprimir información sobre el procesamiento de la tabla ARP: cuánto tiempo tomó el análisis, si las direcciones MAC leídas son válidas y si existe el archivo macvendor.db.
• pi_hole_ftl_debug_regex - (por defecto: false) - Controla si FTLDNS debe imprimir detalles extendidos sobre la coincidencia de expresiones regulares en el archivo de registro de pihole-FTL. Por razones de legado, también admitimos la siguiente configuración para habilitar la misma funcionalidad: REGEX_DEBUGMODE=false|true Ten en cuenta que si uno de ellos se establece en true, el otro no se puede usar para deshabilitar esta configuración nuevamente.
• pi_hole_ftl_debug_api - (por defecto: false) - Imprimir información de depuración adicional durante las llamadas de la API de telnet. Actualmente solo se utiliza para enviar información adicional al obtener todas las consultas.
• pi_hole_ftl_debug_overtime - (por defecto: false) - Imprimir información sobre operaciones de memoria overTime, como inicialización o movimiento de ranuras overTime.
• pi_hole_ftl_debug_extbloqued - (por defecto: false) - Imprimir información sobre por qué FTL decidió que ciertas consultas se reconocieron como bloqueadas externamente.
• pi_hole_ftl_debug_caps - (por defecto: false) - Imprimir información sobre las capacidades otorgadas al proceso pihole-FTL. Las capacidades actuales se imprimen al recibir SIGHUP, es decir, el conjunto actual de capacidades se puede consultar sin reiniciar pihole-FTL (configurando DEBUG_CAPS=true y luego enviando killall -HUP pihole-FTL).
• pi_hole_ftl_debug_dnsmasq_lines - (por defecto: false) - Imprimir archivo y línea que causan un evento de dnsmasq en los archivos de registro de FTL. Esto es útil para implementar hooks adicionales que faltan en FTL.
• pi_hole_ftl_debug_vectors - (por defecto: false) - FTL utiliza vectores asignados dinámicamente para varias tareas. Esta opción de configuración habilita información de depuración extensa, como información sobre asignación, referencia, eliminación y anexado.
• pi_hole_ftl_debug_resolver - (por defecto: false) - Información extensa sobre la resolución de nombres de host, como qué servidores DNS se utilizan en los primeros y segundos intentos de resolución de nombres (solo afecta a las consultas PTR generadas internamente).
• pi_hole_ftl_rate_limit - (por defecto: "1000/60") - Bloquear clientes que realicen más de x consultas (por defecto 1000) en y segundos (por defecto 60). El límite de tasa se puede desactivar por completo estableciendo ambos valores en cero.