ansible-pi-hole

Роль ansible для установки Pi-Hole

Конфигурация роли

• pi_hole_repo (по умолчанию: "https://github.com/pi-hole/pi-hole.git") - укажите репозиторий pi-hole
• pi_hole_prerequisites (по умолчанию: "git") - укажите зависимости для установки pi-hole

Настройка конфигурации pi-hole

Добавьте переменную pi-hole для конфигурации. Эти переменные можно пропустить.

• pi_hole_version - (по умолчанию: "HEAD") - укажите ветку/тег/коммит репозитория pi-hole, который будет клонирован
• pi_hole_download_dir - (по умолчанию: "/home/pihole") - укажите базовую директорию для клонирования pi-hole
• pi_hole_install_dir - (по умолчанию: "pi-hole") - укажите директорию, в которую будет клонирован pi-hole
• pi_hole_query_logging - (по умолчанию: true) - укажите, будет ли pi-hole вести журнал запросов
• pi_hole_install_web_server - (по умолчанию: true) - укажите, нужно ли устанавливать веб-сервер pi-hole
• pi_hole_install_web_interface - (по умолчанию: true) - укажите, нужно ли устанавливать веб-интерфейс pi-hole
• pi_hole_enable_lighttpd - (по умолчанию: true) - нужно ли включить lighttpd
• pi_hole_webpasswd - (по умолчанию: пропущено) - укажите веб-пароль для pi-hole; если пропущено, будет сгенерировано
• pi_hole_dnsmasq_listening - (по умолчанию: "single") -
• pi_hole_dns_1 - (по умолчанию: "8.8.8.8") - главный DNS-сервер для pi-hole
• pi_hole_dns_1_port - (по умолчанию: "53") - порт главного DNS-сервера для pi-hole
• pi_hole_dns_2 - (по умолчанию: "8.8.4.4") - второй DNS-сервер для pi-hole
• pi_hole_dns_1_port - (по умолчанию: "53") - порт второго DNS-сервера для pi-hole
• pi_hole_fqdn_required - (по умолчанию: false) - требуется ли для pi-hole полное доменное имя (FQDN)
• pi_hole_bogus_priv - (по умолчанию: false) - будет ли pi-hole отвечать на недостоверные запросы в частной зоне
• pi_hole_dnssec - (по умолчанию: false) - использовать ли pi-hole DNSSEC
• pi_hole_rev_server - (по умолчанию: true) - будет ли pi-hole отвечать на обратные запросы
• pi_hole_rev_server_domain - (по умолчанию: "") - доменное имя для обратных запросов pi-hole
• pi_hole_rev_server_target - (по умолчанию: "") - цель сервера обратных запросов pi-hole
• pi_hole_rev_server_cidr - (по умолчанию: "") - CIDR для обратных запросов pi-hole
• pi_hole_blocking_enabled - (по умолчанию: true) - включить блокировку в pi-hole

Настройка DHCP для pi-hole

• pi_hole_dhcp_active - (по умолчанию: false) - включить DHCP-сервер pi-hole
• pi_hole_dhcp_start - (по умолчанию: "") - первый IP-адрес для раздачи
• pi_hole_dhcp_end - (по умолчанию: "") - последний IP-адрес для раздачи
• pi_hole_dhcp_router - (по умолчанию: "") - IP-адрес шлюза
• pi_hole_dhcp_leasetime - (по умолчанию: "24") - время аренды DHCP
• pi_hole_domain - (по умолчанию: "lan") - доменное имя pi-hole
• pi_hole_dhcp_ipv6 - (по умолчанию: false) - включить поддержку IPv6
• pi_hole_dhcp_rapid_commit - (по умолчанию: false) - включить быстрый коммит DHCP v4

Локальная DNS-конфигурация для pi-hole

• pi_hole_local_dns_records - (по умолчанию: "") - задайте локальные DNS-записи для pi-hole. Ожидается список словарей, в каждом из которых содержится ключ ip и name.

Пример:

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

Настройка FTL для pi-hole

Добавьте переменные для конфигурации pi-hole-FTL. Эти переменные можно пропустить.

• pi_hole_ftl_blockingmode - (по умолчанию: "NULL") - Как FTL должен отвечать на заблокированные запросы?
• pi_hole_ftl_cname_deep_inspect - (по умолчанию: true) - используйте эту опцию, чтобы отключить глубокую проверку CNAME. Это может быть полезно для очень простых устройств.
• pi_hole_ftl_block_esni - (по умолчанию: true) - Шифрование указания имени сервера (ESNI) является хорошим шагом на пути к улучшению конфиденциальности в вебе. Оно предотвращает перехват расширения шифрования TLS указателя имени сервера (SNI) сторонними наблюдателями.
• pi_hole_ftl_maxlogage - (по умолчанию: "24.0") - до скольки часов запросов из базы данных и логов должны быть импортированы?
• pi_hole_ftl_privacylevel - (по умолчанию: "0") - какой уровень конфиденциальности используется?
• pi_hole_ftl_ignore_localhost - (по умолчанию: "no") - должен ли FTL игнорировать запросы с локальной машины?
• pi_hole_ftl_query_analysis - (по умолчанию: "yes") - должен ли FTL анализировать запросы AAAA? DNS-сервер будет обрабатывать запросы AAAA так же, независимо от этой настройки.
• pi_hole_ftl_analyze_only_a_and_aaaa - (по умолчанию: false) - должен ли FTL анализировать только запросы A и AAAA?
• pi_hole_ftl_socket_listening - (по умолчанию: "localonly") - слушает ли только локальные соединения сокета или разрешает все соединения?
• pi_hole_ftl_port - (по умолчанию: "4711") - на каком порту должен слушать FTL?
• pi_hole_ftl_resolve_ipv6 - (по умолчанию: "yes") - должен ли FTL пытаться разрешить IPv6 адреса в имена хостов?
• pi_hole_ftl_resolve_ipv4 - (по умолчанию: "yes") - должен ли FTL пытаться разрешить IPv4 адреса в имена хостов?
• pi_hole_ftl_delay_startup - (по умолчанию: "0") - в некоторых конфигурациях вам может понадобиться, чтобы FTL подождал некоторое время перед тем, как начать работа DNS-рекурсора.
• pi_hole_ftl_nice - (по умолчанию: "-10") - может быть использовано для изменения приоритета Pi-hole FTL. По умолчанию -10, и может быть полностью отключено, установив значение -999.
• pi_hole_ftl_names_from_netdb - (по умолчанию: true) - контролирует, нужно ли FTL использовать резервную опцию для получения имен клиентов из проверки сетевой таблицы.
• pi_hole_refresh_hostnames - (по умолчанию: "IPV4") - с этой опцией вы можете изменить, как (и если) каждый час отправляются запросы PTR для проверки изменений в именах клиентов и именах серверов.
• pi_hole_ftl_dbimport - (по умолчанию: "true") - должен ли FTL загружать информацию из базы данных при старте, чтобы быть в курсе самой свежей истории?
• pi_hole_ftl_maxdbdays - (по умолчанию: "365") - как долго запросы должны храниться в базе данных? Установив это значение в 0, база данных будет отключена.
• pi_hole_ftl_dbinterval - (по умолчанию: "1.0") - как часто мы храним запросы в базе данных FTL [в минутах]?
• pi_hole_ftl_dbfile - (по умолчанию: "/etc/pihole/pihole-FTL.db") - укажите путь и имя файла долгосрочной базы данных SQLite3 FTL. Установив это значение в DBFILE= отключает всю базу данных.
• pi_hole_ftl_logfile - (по умолчанию: "/var/log/pihole-FTL.log") - расположение файла журнала FTL. Если вы хотите переместить файл журнала в другое место.
• pi_hole_ftl_pidfile - (по умолчанию: "/run/pihole-FTL.pid") - файл, содержащий PID главного процесса FTL.
• pi_hole_ftl_portfile - (по умолчанию: "/run/pihole-FTL.port") - файл, содержащий порт, на котором слушает API FTL.
• pi_hole_ftl_socket_file - (по умолчанию: "/run/pihole/FTL.sock") - файл, содержащий сокет, на котором слушает API FTL.
• pi_hole_ftl_setupvarsfile - (по умолчанию: "/etc/pihole/setupVars.conf") - файл конфигурации Pi-hole, содержащий, например, текущий статус блокировки (не изменяйте).
• pi_hole_ftl_macvendordb - (по умолчанию: "/etc/pihole/macvendor.db") - база данных, содержащая информацию о MAC -> Вендор для сетевой таблицы.
• pi_hole_ftl_gravitydb - (по умолчанию: "/etc/pihole/gravity.db") - укажите путь и имя файла для.SQLite3 базы данных гравитации FTL. Эта база данных содержит все домены, относящиеся к блокировке DNS в Pi-hole.
• pi_hole_ftl_debug_all - (по умолчанию: false) - включить все флаги отладки. Если эта опция установлена в true, игнорируются все другие конфигурации отладки.
• pi_hole_ftl_debug_database - (по умолчанию: false) - выводить отладочную информацию о действиях с базой данных. Это выводит выполненные SQL-запросы, а также общую информацию, например, время, потраченное на сохранение запросов, и количество сохраненных запросов.
• pi_hole_ftl_debug_networking - (по умолчанию: false) - вывести список обнаруженных интерфейсов при старте pihole-FTL. Также выведет, являются ли эти интерфейсы интерфейсами IPv4 или IPv6.
• pi_hole_ftl_debug_locks - (по умолчанию: false) - вывести информацию о блокировках общей памяти. Сообщения будут создаваться во время ожидания, получения и освобождения блокировки.
• pi_hole_ftl_debug_queries - (по умолчанию: false) - вывести обширную информацию о запросах (домены, типы, ответы и т.д.). Это всегда было частью режима отладки pihole-FTL.
• pi_hole_ftl_debug_flags - (по умолчанию: false) - вывести флаги запросов, полученных хук-ами DNS. Эффективно только при включении DEBUG_QUERIES.
• pi_hole_ftl_debug_shmem - (по умолчанию: false) - вывести информацию о буферах общей памяти. Сообщения касаются создания или увеличения объектов общей памяти или инъекций строк.
• pi_hole_ftl_debug_gc - (по умолчанию: false) - вывести информацию о сборке мусора (GC): что должно быть удалено, сколько было удалено, и сколько времени заняла GC.
• pi_hole_ftl_debug_arp - (по умолчанию: false) - вывести информацию о обработке таблицы ARP: сколько времени заняло разбор, действительны ли считанные MAC-адреса и существует ли файл macvendor.db.
• pi_hole_ftl_debug_regex - (по умолчанию: false) - контролирует, должен ли FTLDNS выводить подробные сведения о сопоставлении регулярных выражений в pihole-FTL.log.
• pi_hole_ftl_debug_api - (по умолчанию: false) - вывести дополнительную отладочную информацию во время вызовов API telnet. В настоящее время используется только для отправки дополнительной информации при получении всех запросов.
• pi_hole_ftl_debug_overtime - (по умолчанию: false) - вывести информацию о операциях с памятью overTime, таких как инициализация или перемещение слотов overTime.
• pi_hole_ftl_debug_extbloqued - (по умолчанию: false) - вывести информацию о том, почему FTL решил, что определенные запросы были распознаны как внешне заблокированные.
• pi_hole_ftl_debug_caps - (по умолчанию: false) - вывести информацию о возможностях, предоставленных процессу pihole-FTL. Текущие возможности выводятся при получении SIGHUP, т.е. текущий набор возможностей можно запросить без перезапуска pihole-FTL.
• pi_hole_ftl_debug_dnsmasq_lines - (по умолчанию: false) - вывести файл и строку, приводящие к событию dnsmasq в файлы журнала FTL. Это полезно для реализации дополнительных хуков, отсутствующих в FTL.
• pi_hole_ftl_debug_vectors - (по умолчанию: false) - FTL использует динамически выделенные векторы для различных задач. Эта опция конфигурации включает обширную отладочную информацию, такую как информация о выделении, ссылках, удалении и добавлении.
• pi_hole_ftl_debug_resolver - (по умолчанию: false) - обширная информация о разрешении имен хостов, например, какие DNS-серверы используются при первой и второй попытках разрешения имен (касается только внутренних запросов PTR).
• pi_hole_ftl_rate_limit - (по умолчанию: "1000/60") - заблокировать клиентов, которые делают больше чем x запросов (по умолчанию 1000) за y секунд (по умолчанию 60). Ограничение частоты можно полностью отключить, установив оба значения в ноль.