README.md

selfhosted.adguardhome

Installs AdGuardHome - a network-wide ads & trackers blocking DNS server.

Note

This role is not actively maintained as it is currently not in use (since November 2024). Bugs may be present due to incompatibility with the latest versions of AdGuardHome image.

Warning

This role modifies /etc/resolv.conf file to bind AdGuardHome on port 53. See Note on resolved daemon and adguardhome_dns_port.

Role Variables

• adguardhome_version
  • Default: latest
  • Description: The version of AdGuardHome to install. See tags.
  • Type: str
  • Required: no
• adguardhome_dns_port
  • Default: 53
  • Description: The port on which AdGuardHome will listen for DNS requests. See docs. See Note on resolved daemon and adguardhome_dns_port.
  • Type: int
  • Required: no
• adguardhome_webui_port
  • Default: 3000
  • Description: The port on which AdGuardHome WebUI will be accessible.
  • Type: int
  • Required: no
• adguardhome_install_dir
  • Default: /opt/docker/adguardhome
  • Description: The directory where AdGuardHome will be installed.
  • Type: str
  • Required: no
• adguardhome_env
  • Default: See adguardhome_env_default
  • Description: Docker container environment variables.
  • Type: dict
  • Required: no
• adguardhome_docker_settings
  • Default: See adguardhome_docker_settings_default
  • Description: Docker container settings.
  • Type: dict
  • Required: no

Dependencies

• community.docker

Example Playbook

- hosts: localhost

  roles:
    - artyorsh.selfhosted.adguardhome

Note on resolved daemon and adguardhome_dns_port

If the system is runing resolved daemon, docker will fail to bind on port 53. For this reason a new resolv.conf file is created. See docs and the task.