2021-08-08 09:56:42 +02:00
<!--
N.B.: This README was automatically generated by https://github.com/YunoHost/apps/tree/master/tools/README-generator
It shall NOT be edited by hand.
-->
2019-01-09 09:31:49 +01:00
2021-08-08 09:56:42 +02:00
# AdGuard Home for YunoHost
2019-04-03 17:01:48 +02:00
2021-08-08 09:56:42 +02:00
[](https://dash.yunohost.org/appci/app/adguardhome)  
[](https://install-app.yunohost.org/?app=adguardhome)
2019-01-09 09:31:49 +01:00
2021-08-08 09:56:42 +02:00
*[Lire ce readme en français.](./README_fr.md)*
2019-01-09 09:31:49 +01:00
2021-08-08 09:56:42 +02:00
> *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 ](https://yunohost.org/#/install ) to learn how to install it.*
2019-01-09 09:31:49 +01:00
2021-08-08 09:56:42 +02:00
## Overview
2019-01-09 09:31:49 +01:00
2021-09-21 22:54:10 +02:00
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.
2019-01-09 09:31:49 +01:00
2022-01-03 16:14:02 +01:00
**Shipped version:** 0.107.2~ynh1
2019-01-09 09:31:49 +01:00
2021-09-21 19:49:23 +02:00
2019-01-09 09:31:49 +01:00
2021-08-08 09:56:42 +02:00
## Screenshots
2019-01-24 11:51:24 +01:00
2021-08-08 09:56:42 +02:00
2019-01-24 11:51:24 +01:00
2021-08-08 09:56:42 +02:00
## Documentation and resources
2019-04-03 17:03:03 +02:00
2021-08-08 09:56:42 +02:00
* Official app website: https://adguard.com/adguard-home.html
2021-09-21 19:49:23 +02:00
* Official user documentation: https://kb.adguard.com/en
* Official admin documentation: https://github.com/AdguardTeam/AdGuardHome/wiki
2021-08-08 09:56:42 +02:00
* Upstream app code repository: https://github.com/AdguardTeam/AdGuardHome
* YunoHost documentation for this app: https://yunohost.org/app_adguardhome
* Report a bug: https://github.com/YunoHost-Apps/adguardhome_ynh/issues
2019-01-09 09:31:49 +01:00
2021-08-08 09:56:42 +02:00
## Developer info
2019-01-09 09:31:49 +01:00
2021-08-08 09:56:42 +02:00
Please send your pull request to the [testing branch ](https://github.com/YunoHost-Apps/adguardhome_ynh/tree/testing ).
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
