Merge in DNS/adguard-home from 2470-session-token to master Updates #2470. Squashed commit of the following: commit
|7 hours ago|
|.github||5 days ago|
|client||2 weeks ago|
|client2||3 weeks ago|
|doc||11 months ago|
|internal||7 hours ago|
|openapi||3 days ago|
|scripts||2 weeks ago|
|.codecov.yml||3 months ago|
|.dockerignore||2 months ago|
|.gitattributes||2 weeks ago|
|.gitignore||2 months ago|
|.twosky.json||5 months ago|
|AGHTechDoc.md||2 months ago|
|CHANGELOG.md||7 hours ago|
|HACKING.md||3 weeks ago|
|LICENSE.txt||2 years ago|
|Makefile||1 month ago|
|README.md||2 weeks ago|
|changelog.config.js||7 months ago|
|go.mod||2 weeks ago|
|go.sum||2 weeks ago|
|main.go||1 month ago|
|staticcheck.conf||2 weeks ago|
|tools.go||7 months ago|
Free and open source, powerful network-wide ads & trackers blocking DNS server.
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.
Run the following command in your terminal:
curl -sSL https://raw.githubusercontent.com/AdguardTeam/AdGuardHome/master/scripts/install.sh | sh
Please read the Getting Started article on our Wiki to learn how to install AdGuard Home manually, and how to configure your devices to use it.
You can use our official Docker image.
If you're running Linux, there's a secure and easy way to install AdGuard Home - you can get it from the Snap Store.
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:
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.
|Blocking ads and trackers||✅||✅|
|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)||✅||❌|
|Running without root privileges||✅||❌|
"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 traditional ad blockers).
Here are some examples of what cannot be blocked by a DNS-level blocker:
Essentially, any advertising that shares a domain with content cannot be blocked by a DNS-level blocker.
Is there a chance to handle this in the future? DNS will never be enough to do this. Our only option is to use a content blocking proxy like what we do in the standalone AdGuard applications. We're going to bring this feature support to AdGuard Home in the future. Unfortunately, even in this case, there still will be cases when this won't be enough or would require quite complicated configuration.
make init to prepare the development environment.
You will need this to build AdGuard Home:
Open Terminal and execute these commands:
git clone https://github.com/AdguardTeam/AdGuardHome cd AdGuardHome make
Please note, that the non-standard
-j flag is currently not supported, so
make -j 4 or setting your
MAKEFLAGS to include, for example,
-j 4 is likely to break the build. If you do have your
MAKEFLAGS set to
that, and you don't want to change it, you can override it by running
make -j 1.
Makefile to learn about other commands.
Building for a different platform. You can build AdGuard for any OS/ARCH just like any other Go project.
In order to do this, specify
GOARCH env variables before running make.
env GOOS='linux' GOARCH='arm64' make
make GOOS='linux' GOARCH='arm64'
You'll need this to prepare a release build:
make build-release CHANNEL='...' VERSION='...'
make build-dockerto build the Docker image locally (the one that we publish to DockerHub).
Please note, that we're using Docker Buildx to build our official image.
You may need to prepare before using these builds:
docker run --rm --privileged multiarch/qemu-user-static --reset -p yes --credential yes
docker buildx create --name buildx-builder --driver docker-container --use
You are welcome to fork this repository, make your changes and submit a pull request — https://github.com/AdguardTeam/AdGuardHome/pulls
Please note that we don't expect people to contribute to both UI and golang parts of the program simultaneously. Ideally, the golang part is implemented first, i.e. configuration, API, and the functionality itself. The UI part can be implemented later in a different pull request by a different person.
There are two update channels that you can use:
beta- beta version of AdGuard Home. More or less stable versions.
edge- the newest version of AdGuard Home. New updates are pushed to this channel daily and it is the closest to the master branch you can get.
There are three options how you can install an unstable version:
curl -sSL https://raw.githubusercontent.com/AdguardTeam/AdGuardHome/master/scripts/install.sh | sh -s beta
curl -sSL https://raw.githubusercontent.com/AdguardTeam/AdGuardHome/master/scripts/install.sh | sh -s edge
Beta channel builds
Edge channel builds
If you run into any problem or have a suggestion, head to this page and click on the
New issue button.
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
Here's what you can also do to contribute:
This software wouldn't have been possible without:
You might have seen that CoreDNS was mentioned here before — we've stopped using it in AdGuard Home. 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.
Our main idea is that you are the one, who should be in control of your data. So it is only natural, that AdGuard Home does not collect any usage statistics, and does not use any web services unless you configure it to do so. Full policy with every bit that could in theory be sent by AdGuard Home is available here.