deploy_adguard/README.md

deploy_adguard
=========
> This repository is only a mirror. Development and testing is done on a private gitea server.

This role install and configure adguard, with optionally virtual IP, metrics, and consul integration on **debian-based** distributions.

Requirements
------------

This role assumes you have `docker`, `docker-compose`, and eventually `consul` installed if using the consul integration. The role will not install these components, but you can install them using the [install_docker](https://github.com/ednz_cloud/install_docker) and [hashicorp_consul](https://github.com/ednz_cloud/hashicorp_consul) roles.

Role Variables
--------------
Available variables are listed below, along with default values. A sample file for the default values is available in `default/deploy_adguard.yml.sample` in case you need it for any `group_vars` or `host_vars` configuration.

```yaml
deploy_adguard_directory: /opt/adguard # by default, set to /opt/adguard
```
This variable defines the data directory used to store all files related to adguard, as well as the volumes mounted by the docker containers.

```yaml
deploy_adguard_timezone: "Europe/Paris" # by default set to Europe/Paris
```
This variable defines the timezone that the container will use.

```yaml
deploy_adguard_enable_admin_interface: true #by default, set to true
```

```yaml
deploy_adguard_enable_dhcp: false # by default, set to false
```
Whether or not this server will be used as a dhcp server. This manages the port forwarding to the adguard container.

```yaml
deploy_adguard_enable_doh: true # by default, set to true
```
Whether or not this server will use DNS-over-HTTPS. This manages the port forwarding to the adguard container.

```yaml
deploy_adguard_enable_dot: false # by default, set to false
```
Whether or not this server will use DNS-over-TLS. This manages the port forwarding to the adguard container.

```yaml
deploy_adguard_enable_doq: false # by default, set to false
```
Whether or not this server will use DNS-over-QUIC. This manages the port forwarding to the adguard container.

```yaml
deploy_adguard_enable_dnscrypt: false # by default, set to false
```
Whether or not this server will use dnscrypt. This manages the port forwarding to the adguard container.


```yaml
deploy_adguard_start_service: false # by default, set to false
```
This variable manages whether or not to start the adguard service during the play, or when config files are changed. This can be useful to disable it if you plan on building golden images with this role and you don't want the containers to start during the build process. Please note that the service will ALWAYS be enabled, meaning that it'll automatically start upon reboot of the host.

```yaml
deploy_adguard_virtual_ip: # by default, set to the following
  enable: false
  interface: eth0
  vip_addr: "192.168.1.53"
```
This variable handles the use of a virtual IP for the dns server. You can either choose to use the host IP address to serve DNs, or you can choose to attach a virtual IP to the server, so that replacing the underlying machine will not force you to change dns settings everywhere.

```yaml
deploy_adguard_node_exporter: # by default, set to the following
  enable: false
  protocol: http
  port: 80
  username: changeme
  password: changeme
  exporter_port: 9617
  interval: 10s
  log_limit: 10000
```
This variable handles the use of the [prometheus-node-exporter](https://github.com/ebrianne/adguard-exporter). Please refer to the [documentation](https://github.com/ebrianne/adguard-exporter/blob/master/README.md) for more information.

```yaml
deploy_adguard_consul: # by default, set to the following
  enable: false
  consul_addr: http://127.0.0.1:8500
  consul_token: someUUIDhere
  configuration:
    service:
      name: adguard
      address: "{{ ansible_default_ipv4.address }}"
      port: 80
      tags: []
      connect:
        sidecar_service: {}
```
This variable handles registering adguard as a [consul](https://developer.hashicorp.com/consul) service, for healthchecking and other features. Note that this role will not install consul, envoy, or any other binary necessary for this feature to work. You can check the [hashicorp_consul](https://github.com/ednz_cloud/hashicorp_consul) ansible role, to deploy a consul agent on the same node.

```yaml
deploy_adguard_config: {} # by default, set to {}
```
This variable handles autoconfiguration of the adguard server. This variable will be parsed and injected as-is in the `AdGuardhome.yaml` file, si it must be a valid configuration file. You can refer to the [documentation](https://github.com/AdguardTeam/AdGuardHome/wiki/Configuration#configuration-file) to learn more about adguard configuration file. This method of passing configuration allows for compatibility with every configuration parameters that adguard has to offer.

Dependencies
------------

None.

Example Playbook
----------------

```yaml
# calling the role inside a playbook with either the default or group_vars/host_vars
- hosts: servers
  roles:
    - ednz_cloud.deploy_adguard
```

License
-------

MIT / BSD

Author Information
------------------

This role was created by Bertrand Lanson in 2023.