mirror of https://github.com/YunoHost-Apps/adguardhome_ynh.git synced 2024-09-03 18:06:23 +02:00

AdGuard Home package for YunoHost: Network-wide ads & trackers blocking DNS server

Find a file

yunohost-bot 5cf4fa6cb5 Auto-update READMEs		2024-07-27 15:04:05 +00:00
.github	enable DOH/DOQ using Let's Encrypt certs out of the box (#154 )	2024-05-21 18:34:12 +02:00
conf	enable DOH/DOQ using Let's Encrypt certs out of the box (#154 )	2024-05-21 18:34:12 +02:00
doc	fix linter	2024-07-27 17:03:53 +02:00
scripts	add troubleshooting page	2024-07-06 19:31:59 +02:00
.shellcheckrc	enable DOH/DOQ using Let's Encrypt certs out of the box (#154 )	2024-05-21 18:34:12 +02:00
ALL_README.md	Auto-update READMEs	2024-07-27 15:02:23 +00:00
config_panel.toml	enable DOH/DOQ using Let's Encrypt certs out of the box (#154 )	2024-05-21 18:34:12 +02:00
LICENSE	update	2019-01-09 09:31:49 +01:00
manifest.toml	Upgrade to v0.107.52 (#186 )	2024-07-05 04:39:15 +02:00
README.md	Auto-update READMEs	2024-07-27 15:04:05 +00:00
README_es.md	Auto-update READMEs	2024-07-27 15:04:05 +00:00
README_eu.md	Auto-update READMEs	2024-07-27 15:04:05 +00:00
README_fr.md	Auto-update READMEs	2024-07-27 15:04:05 +00:00
README_gl.md	Auto-update READMEs	2024-07-27 15:04:05 +00:00
README_id.md	Auto-update READMEs	2024-07-27 15:04:05 +00:00
README_zh_Hans.md	Auto-update READMEs	2024-07-27 15:04:05 +00:00
tests.toml	enable DOH/DOQ using Let's Encrypt certs out of the box (#154 )	2024-05-21 18:34:12 +02:00

README.md

AdGuard Home for YunoHost

Read this README in other languages.

This package allows you to install AdGuard Home quickly and simply on a YunoHost server.
If you don't have YunoHost, please consult the guide to learn how to install it.

Overview

AdGuard Home is a network-wide software for blocking ads & tracking. After you set it up, it'll cover ALL your home devices, and you don't need any client-side software for that.

It operates as a DNS server that re-routes tracking domains to a "black hole", thus preventing your devices from connecting to those servers. It's based on software we use for our public AdGuard DNS servers -- both share a lot of common code.

Important note: This AdGuard Home package needs to disable Dnsmasq on the main network interface to allow AdGuard Home to listen DNS resquest using it.
However, Dnsmasq is not disabled and will continue to function as the localhost DNS server.

Shipped version: 0.107.52~ynh1

Screenshots

Documentation and resources

Official app website: https://adguard.com/adguard-home.html
Official user documentation: https://kb.adguard.com/en
Official admin documentation: https://github.com/AdguardTeam/AdGuardHome/wiki
Upstream app code repository: https://github.com/AdguardTeam/AdGuardHome
YunoHost Store: https://apps.yunohost.org/app/adguardhome
Report a bug: https://github.com/YunoHost-Apps/adguardhome_ynh/issues

Developer info

Please send your pull request to the testing branch.

To try the testing branch, please proceed like that:

sudo yunohost app install https://github.com/YunoHost-Apps/adguardhome_ynh/tree/testing --debug
or
sudo yunohost app upgrade adguardhome -u https://github.com/YunoHost-Apps/adguardhome_ynh/tree/testing --debug

More info regarding app packaging: https://yunohost.org/packaging_apps