Skip to content

/ AdGuardHome

Network-wide ads & trackers blocking DNS server
dns adblock privacy golang adguard open-source
Go Shell JavaScript Other
  1. Go 95.8%
  2. Shell 2.3%
  3. JavaScript 1.3%
  4. Other 0.6%
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

Latest commit

@ameshkov
ameshkov Fix #1810 
- client: Fix query log bugs

Squashed commit of the following:

commit 188bbad
Merge: 15db9e9 ec6e0be
Author: Andrey Meshkov <am@adguard.com>
Date:   Thu Jun 18 22:43:11 2020 +0300

    Merge branch 'master' into fix/1810

commit 15db9e9
Author: ArtemBaskal <a.baskal@adguard.com>
Date:   Thu Jun 18 19:01:10 2020 +0300

    Open tooltip on hover, show scroll on overflow y

commit 19c0133
Author: ArtemBaskal <a.baskal@adguard.com>
Date:   Thu Jun 18 17:17:46 2020 +0300

    Replace tooltip component

commit 7e7103d
Author: ArtemBaskal <a.baskal@adguard.com>
Date:   Thu Jun 18 14:21:54 2020 +0300

    -client: Fix query log bugs
Latest commit aa7b3c3 Jun 18, 2020

Files

Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.github fix typo2 Aug 2, 2019
client Fix #1810 Jun 18, 2020
dhcpd - DHCP: when adding a new static lease: remove dynamic lease with the… Apr 8, 2020
dnsfilter * blocked-services: Added 2 entries for YouTube and Amazon AWS Jun 1, 2020
dnsforward Merge: + new query logs API Jun 17, 2020
doc * tech doc: update architecture picture Mar 17, 2020
home Merge: fix #1421 Jun 17, 2020
isdelve -(global): fixing the installation flow on windows Dec 23, 2019
openapi * openapi: describe top_* array entries in /stats Jun 18, 2020
packaging *: snap: don't use SNAP_COMMON Apr 23, 2020
querylog Merge: + new query logs API Jun 17, 2020
scripts Update locales, add locales scripts, update locales readme Apr 7, 2020
stats + querylog,stats: anonymize client ip: /16 Jun 3, 2020
util * auto-hosts: support '#' comments after ip and hosts Jun 17, 2020
.codecov.yml Added codecov, goreport Jan 25, 2019
.gitattributes fix gh language Oct 17, 2018
.gitignore Add IntelliJ Project files (*.iml) to .gitignore Rename "Portuguese" … May 14, 2020
.golangci.yml -(dnsforward): custom client per-domain upstreams May 13, 2020
.gometalinter.json Fix review comments Feb 11, 2019
.travis.yml *: remove snap from travis Apr 22, 2020
.twosky.json Add IntelliJ Project files (*.iml) to .gitignore Rename "Portuguese" … May 14, 2020
AGHTechDoc.md Merge: fix #1421 Jun 17, 2020
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 *: fix #1656 May 11, 2020
README.md Update README.md Jun 14, 2020
build_docker.sh *: moved docker files to the packaging folder Apr 21, 2020
build_release.sh *: moved docker files to the packaging folder Apr 21, 2020
build_snap.sh fix May 14, 2020
changelog.config.js *(querylog): added offset/limit parameters May 26, 2020
ci.sh Merge: * use upstream servers directly for the internal DNS resolver Dec 11, 2019
go.mod * DNS API: new setting "upstream_mode"; remove "fastest_addr", "paral… Jun 10, 2020
go.sum * DNS API: new setting "upstream_mode"; remove "fastest_addr", "paral… Jun 10, 2020
main.go *: memory usage hacks May 12, 2020
snapcraft.yaml Correct architecture builds May 1, 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 Docker Pulls Docker Stars


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.

If you're running Linux, there's a secure and easy way to install AdGuard Home - you can get it from the Snap Store.

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 ✅ ❌ (requires non-default blocklists)
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 three options how you can install an unstable version.

  1. You can either install a beta version of AdGuard Home which we update periodically.
  2. You can use the Docker image from the edge tag, which is synced with the repo master branch.
  3. You can install AdGuard Home from beta or edge channels on the Snap Store.

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.

For info on which exact domains that are blocked by the Blocked services function, it can be found at dnsfilter/blocked_services.go

You can’t perform that action at this time.