Ansible Role: adguardhome

This role installs AdGuardHome on Linux computers.

Versioning Policy

Each minor version of this role works with a matching patch release of AdGuardHome. For example, version 107.52.x works with AdGuardHome version 0.107.52. This is because of changes made in the settings file, allowing for bug fixes in the role between updates.

Installation

To install using Ansible Galaxy, run the following command:

ansible-galaxy install bcook254.adguardhome>=107.52,<107.53

Requirements

You need permission to:

• Create or change users/groups
• Create or change needed directories

Role Variables

Here is a list of some available variables and their default values. For more variables for the AdGuardHome configuration, check defaults/main.yml.

• adguardhome_version: 0.107.52

  • This is the version of AdGuardHome that will be installed.

• adguardhome_user: adguardhome

• adguardhome_group: adguardhome

  • These define the user and group that will be created for running AdGuardHome.

• adguardhome_daemon: adguardhome

  • This is the name of the service used to control AdGuardHome.

• Default directories for AdGuardHome:

  • adguardhome_home_dir: /var/lib/adguardhome
  • adguardhome_data_dir: "{{ adguardhome_home_dir }}"
  • adguardhome_bin_dir: /usr/local/bin
  • adguardhome_config_dir: /etc/adguardhome

• Default file names for AdGuardHome:

  • adguardhome_bin_file: "{{ adguardhome_bin_dir }}/AdGuardHome"
  • adguardhome_config_file: "{{ adguardhome_config_dir }}/AdGuardHome"

• adguardhome_download_uri:

  • This is an optional URI to replace the default AdGuardHome URL. It must point to a tarball with the same structure as the official AdGuardHome release. If it points to a file, it must already exist on the remote machine. This is only needed for custom or local builds or if the role does not detect the architecture correctly.

Dependencies

None.

Example Playbook

Here’s how to use the role in a playbook:

- hosts: servers
  roles:
     - role: bcook254.adguardhome
       become: yes

License

MIT / BSD

Author Information

This role was created by Benjamin Cook.