deploy_adguard/README.md

Deploy AdGuard
=========
> This repository is only a mirror. Development and testing is done on a private gitlab 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/ednxzu/install_docker) and [hashicorp_consul](https://github.com/ednxzu/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.

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

None.

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

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

License
-------

MIT / BSD

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

This role was created by Bertrand Lanson in 2023.
added handlers + readme typo 2023-05-31 20:05:56 +00:00			`Deploy AdGuard`
starting with a few defaults 2023-05-28 18:03:38 +00:00			`=========`
			`> This repository is only a mirror. Development and testing is done on a private gitlab server.`
Initial commit 2023-05-28 17:24:32 +00:00
starting with a few defaults 2023-05-28 18:03:38 +00:00			`This role install and configure adguard, with optionally virtual IP, metrics, and consul integration on debian-based distributions.`
Initial commit 2023-05-28 17:24:32 +00:00
starting with a few defaults 2023-05-28 18:03:38 +00:00			`Requirements`
			`------------`
Initial commit 2023-05-28 17:24:32 +00:00
starting with a few defaults 2023-05-28 18:03:38 +00:00			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/ednxzu/install_docker) and [hashicorp_consul](https://github.com/ednxzu/hashicorp_consul) roles.
Initial commit 2023-05-28 17:24:32 +00:00
starting with a few defaults 2023-05-28 18:03:38 +00:00			`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.
Initial commit 2023-05-28 17:24:32 +00:00
starting with a few defaults 2023-05-28 18:03:38 +00:00			`Dependencies`
			`------------`
Initial commit 2023-05-28 17:24:32 +00:00
few changes 2023-06-02 13:25:56 +00:00			`None.`
Initial commit 2023-05-28 17:24:32 +00:00
starting with a few defaults 2023-05-28 18:03:38 +00:00			`Example Playbook`
			`----------------`
Initial commit 2023-05-28 17:24:32 +00:00
starting with a few defaults 2023-05-28 18:03:38 +00:00			```yaml
			`# calling the role inside a playbook with either the default or group_vars/host_vars`
			`- hosts: servers`
			`roles:`
few changes 2023-06-02 13:25:56 +00:00			`- ednxzu.deploy_adguard`
Initial commit 2023-05-28 17:24:32 +00:00			```

starting with a few defaults 2023-05-28 18:03:38 +00:00			`License`
			`-------`
Initial commit 2023-05-28 17:24:32 +00:00
starting with a few defaults 2023-05-28 18:03:38 +00:00			`MIT / BSD`
Initial commit 2023-05-28 17:24:32 +00:00
starting with a few defaults 2023-05-28 18:03:38 +00:00			`Author Information`
			`------------------`
Initial commit 2023-05-28 17:24:32 +00:00
starting with a few defaults 2023-05-28 18:03:38 +00:00			`This role was created by Bertrand Lanson in 2023.`