Skip to content

/ AdGuardHome

Network-wide ads & trackers blocking DNS server
dns adblock privacy golang adguard open-source
Go JavaScript Other
  1. Go 96.9%
  2. JavaScript 1.4%
  3. Other 1.7%
Branch: master
Find file
Clone or download

Clone with HTTPS

Use Git or checkout with SVN using the web URL.

Open in Desktop Download ZIP

Launching GitHub Desktop

If nothing happens, download GitHub Desktop and try again.

Launching GitHub Desktop

If nothing happens, download GitHub Desktop and try again.

Launching Xcode

If nothing happens, download Xcode and try again.

Launching Visual Studio

If nothing happens, download the GitHub extension for Visual Studio and try again.

Latest commit

@ameshkov
ameshkov Merge: - DNS: filtering didn't work 
Fix #1504

* commit '7c192212410ef877aea5c0d018cc0f9ae8b41879':
  minor
  - DNS: filtering didn't work
Latest commit c73dd55 Mar 24, 2020

Files

Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.github fix typo2 Aug 2, 2019
client Merge: + qlog: anonymize_client_ip setting Mar 20, 2020
dhcpd * refactor Mar 17, 2020
dnsfilter Merge: + DNS: use rules from /etc/hosts Mar 20, 2020
dnsforward - DNS: filtering didn't work Mar 24, 2020
doc * tech doc: update architecture picture Mar 17, 2020
home Merge: + DNS, Web: use only secure TLSv1.2 ciphers Mar 23, 2020
isdelve -(global): fixing the installation flow on windows Dec 23, 2019
openapi + qlog: hide_client_ip setting Mar 20, 2020
querylog + qlog: hide_client_ip setting Mar 20, 2020
scripts *(global): update trackers db Jan 30, 2020
stats + qlog: hide_client_ip setting Mar 20, 2020
util minor Mar 24, 2020
.codecov.yml Added codecov, goreport Jan 25, 2019
.gitattributes fix gh language Oct 17, 2018
.gitignore Merge: fix #822 - Whitelist filter rules Feb 26, 2020
.golangci.yml *(global): CI scripts Oct 2, 2019
.gometalinter.json Fix review comments Feb 11, 2019
.travis.yml -(global): docker image - dirty version Dec 19, 2019
.twosky.json + client: add thai and romanian languages Mar 11, 2020
AGHTechDoc.md Merge: + qlog: anonymize_client_ip setting Mar 20, 2020
Dockerfile Update ports in docker files Jun 4, 2019
Dockerfile.travis Merge branch 'master' of ssh://bit.adguard.com:7999/dns/adguard-dns Jun 4, 2019
LICENSE.txt Initial commit Aug 30, 2018
Makefile *(global): fix ARM build auto-update Feb 6, 2020
README.md Update README.md Jan 28, 2020
build_docker.sh Build latest from tag branch, edge from master Feb 11, 2019
changelog.config.js +: git-cz config file Jul 24, 2019
ci.sh Merge: * use upstream servers directly for the internal DNS resolver Dec 11, 2019
go.mod Merge: + DNS: new settings cache_ttl_min, cache_ttl_max Mar 20, 2020
go.sum Merge: + DNS: new settings cache_ttl_min, cache_ttl_max Mar 20, 2020
main.go *(global): fix ARM build auto-update Feb 6, 2020
release.sh + release.sh: add armv5 build Jan 15, 2020

README.md

 

AdGuard Home

Privacy protection center for you and your devices

Free and open source, powerful network-wide ads & trackers blocking DNS server.

AdGuard.com | Wiki | Reddit | Twitter | Telegram

Build status Code Coverage Go Report Card GolangCI Latest release


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.

Getting Started

Please read the Getting Started article on our Wiki to learn how to install AdGuard Home, and how to configure your devices to use it.

Alternatively, you can use our official Docker image.

Guides

API

If you want to integrate with AdGuard Home, you can use our REST API. Alternatively, you can use this python client, which is used to build the AdGuard Home Hass.io Add-on.

Comparing AdGuard Home to other solutions

How is this different from public AdGuard DNS servers?

Running your own AdGuard Home server allows you to do much more than using a public DNS server. It's a completely different level. See for yourself:

  • Choose what exactly will the server block or not block.
  • Monitor your network activity.
  • Add your own custom filtering rules.
  • Most importantly, this is your own server, and you are the only one who's in control.

How does AdGuard Home compare to Pi-Hole

At this point, AdGuard Home has a lot in common with Pi-Hole. Both block ads and trackers using "DNS sinkholing" method, and both allow customizing what's blocked.

We're not going to stop here. DNS sinkholing is not a bad starting point, but this is just the beginning.

AdGuard Home provides a lot of features out-of-the-box with no need to install and configure additional software. We want it to be simple to the point when even casual users can set it up with minimal effort.

Disclaimer: some of the listed features can be added to Pi-Hole by installing additional software or by manually using SSH terminal and reconfiguring one of the utilities Pi-Hole consists of. However, in our opinion, this cannot be legitimately counted as a Pi-Hole's feature.

Feature AdGuard Home Pi-Hole
Blocking ads and trackers ✅ ✅
Customizing blocklists ✅ ✅
Built-in DHCP server ✅ ✅
HTTPS for the Admin interface ✅ Kind of, but you'll need to manually configure lighthttpd
Encrypted DNS upstream servers (DNS-over-HTTPS, DNS-over-TLS, DNSCrypt) ✅ ❌ (requires additional software)
Cross-platform ✅ ❌ (not natively, only via Docker)
Running as a DNS-over-HTTPS or DNS-over-TLS server ✅ ❌ (requires additional software)
Blocking phishing and malware domains ✅ ❌
Parental control (blocking adult domains) ✅ ❌
Force Safe search on search engines ✅ ❌
Per-client (device) configuration ✅ ❌
Access settings (choose who can use AGH DNS) ✅ ❌

How does AdGuard Home compare to traditional ad blockers

It depends.

"DNS sinkholing" is capable of blocking a big percentage of ads, but it lacks flexibility and power of traditional ad blockers. You can get a good impression about the difference between these methods by reading this article. It compares AdGuard for Android (a traditional ad blocker) to hosts-level ad blockers (which are almost identical to DNS-based blockers in their capabilities). However, this level of protection is enough for some users. Additionally, using a DNS-based blocker can help to block ads, tracking and analytics requests on other types of devices, such as SmartTVs, smart speakers or other kinds of IoT devices (on which you can't install tradtional ad blockers).

How to build from source

Prerequisites

You will need:

You can either install them via the provided links or use brew.sh if you're on Mac:

brew install go node

Building

Open Terminal and execute these commands:

git clone https://github.com/AdguardTeam/AdGuardHome
cd AdGuardHome
make

(For devs) Upload translations

node upload.js

(For devs) Download translations

node download.js

Contributing

You are welcome to fork this repository, make your changes and submit a pull request — https://github.com/AdguardTeam/AdGuardHome/pulls

Test unstable versions

There are two options how you can install an unstable version. You can either install a beta version of AdGuard Home which we update periodically, or you can use the Docker image from the edge tag, which is synced with the repo master branch.

Report issues

If you run into any problem or have a suggestion, head to this page and click on the New issue button.

Help with translations

If you want to help with AdGuard Home translations, please learn more about translating AdGuard products here: https://kb.adguard.com/en/general/adguard-translations

Here is a link to AdGuard Home project: https://crowdin.com/project/adguard-applications/en#/adguard-home

Projects that use AdGuardHome

Acknowledgments

This software wouldn't have been possible without:

You might have seen that CoreDNS was mentioned here before — we've stopped using it in AdGuardHome. While we still use it on our servers for AdGuard DNS service, it seemed like an overkill for Home as it impeded with Home features that we plan to implement.

For a full list of all node.js packages in use, please take a look at client/package.json file.

You can’t perform that action at this time.