Franck Nijhof c464056402
Making our website faster, cleaner and prettier (#9853)
* 🔥 Removes octopress.js

* 🔥 Removes use of root_url var

* 🔥 Removes Octopress generator reference from feed

* 🔥 Removes delicious support

* 🔥 Removes support for Pinboard

* 🔥 Removes support for Disqus

* 🔥 Removes support for Google Plus

* ↩️ Migrate custom after_footer to default template

* ↩️ Migrate custom footer to default template

* ↩️ Migrate custom header to default template

* 🔥 Removes unused template files

* 🚀 Places time to read directly in post template

* 🚀 Removes unneeded capture from archive_post.html template

* 🔥 🚀 Removes unused, but heaving sorting call in component page

* 🚀 Merged javascripts into a single file

* 🔥 Removes more uses of root_url

* 🚀 Removal of unneeded captures from head

* 🔥 🚀 Removal of expensive liquid HTML compressor

* 🔥 Removes unneeded templates

* 🚀 Replaces kramdown with GitHub's CommonMark 🚀

* 💄 Adds Prism code syntax highlighting

*  Adds support for redirect in Netlify

* ↩️ 🔥 Let Netlify handle all developer doc redirects

* ✏️ Fixes typo in redirects file: Netify -> Netlify

* 🔥 Removes unused .themes folder

* 🔥 Removes unused aside.html template

* 🔥 Removes Disqus config leftover

* 🔥 Removes rouge highlighter config

* 🔥 Removes Octopress 🎉

* 💄 Adjust code block font size and adds soft wraps

* 💄 Adds styling for inline code blocks

* 💄 Improve styling of note/warning/info boxes + div support

* 🔨 Rewrites all note/warning/info boxes
2019-07-15 22:17:54 +02:00

3.9 KiB

title, description, logo, ha_category, ha_release, ha_iot_class
title description logo ha_category ha_release ha_iot_class
AdGuard Home Instructions on how to integrate AdGuard Home with Home Assistant. adguard.png
Network
Sensor
Switch
0.95 Local Polling

AdGuard Home is a network-wide ad-and-tracker blocking DNS server with parental control (adult content blocking) capabilities. The adguard integration allows you to control and monitor your AdGuard Home instance in Home Assistant.

Configuration via the frontend

Menu: Configuration -> Integrations.

Click on the + sign to add an integration and click on AdGuard Home. Follow the configuration flow, after finishing, the AdGuard Home integration will be available.

Sensors

This integration provides sensors for the following information from AdGuard Home:

  • Number of DNS queries.
  • Number of blocked DNS queries.
  • Ratio (%) of blocked DNS queries.
  • Number of requests blocked by safe browsing.
  • Number of safe searches enforced.
  • Number of requests blocked by parental control.
  • Total number of active filter rules loaded.
  • Average response time of AdGuard's DNS server in milliseconds.

Switches

The integration will create a number of switches:

  • AdGuard Protection (master switch).
  • Filtering.
  • Safe Browsing.
  • Parental Control.
  • Safe Search.
  • Query Log.

These switches allow you to automate things easily. For example, one could write an automation to turn off Safe Search after the kids' bedtime.

The "AdGuard Protection" switch, is a master switch. It will turn off and bypass all AdGuard feature, regardless if they are switched on or not.

Turning off Query Log will result in all sensors not receiving updates anymore. AdGuard relies on Query Log to provide stats.

Services

These services allow one to manage filter subscriptions in AdGuard Home. Using these services in automations could be helpful to block certain sites/domains at certain times.

For example, you could create a custom filter list blocking social media sites, during the day and release them during the evening, using a simple automation.

Service add_url

Add a new filter subscription to AdGuard Home.

Service data attribute Optional Description
name No The name of the filter subscription.
url No The filter URL to subscribe to, containing the filter rules.

Service remove_url

Removes a filter subscription from AdGuard Home.

Service data attribute Optional Description
url No The filter subscription URL to remove.

Service enable_url

Enables a filter subscription in AdGuard Home.

Service data attribute Optional Description
url No The filter subscription URL to enable.

Service disable_url

Disables a filter subscription in AdGuard Home.

Service data attribute Optional Description
url No The filter subscription URL to disable.

Service refresh

Refresh all filter subscriptions in AdGuard Home.

Service data attribute Optional Description
force Yes Force update (bypasses AdGuard Home throttling).

By default, force is set to false. Forcing an update bypasses AdGuard Home's throttling logic, so use with care.