u20024804 / adguardhome Goto Github PK

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

AdGuard.com | Wiki | Reddit | Twitter | Telegram

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
• Comparing AdGuard Home to other solutions
  • How is this different from public AdGuard DNS servers?
  • How does AdGuard Home compare to Pi-Hole
  • How does AdGuard Home compare to traditional ad blockers
• How to build from source
• Contributing
  • Test unstable versions
  • Reporting issues
  • Help with translations
• Acknowledgments

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.

• Configuration
• AdGuard Home as a DNS-over-HTTPS or DNS-over-TLS server
• How to install and run AdGuard Home on Raspberry Pi
• How to install and run AdGuard Home on a Virtual Private Server

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.

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.

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.

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.

You will need:

• go v1.13 or later.
• node.js v10 or later.

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

brew install go node

Open Terminal and execute these commands:

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

node upload.js

node download.js

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

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.

• Docker Hub
• Beta builds
  • Rapsberry Pi (32-bit ARM)
  • MacOS
  • Windows 64-bit
  • Windows 32-bit
  • Linux 64-bit
  • Linux 32-bit
  • FreeBSD 64-bit
  • 64-bit ARM
  • MIPS
  • MIPSLE

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

This software wouldn't have been possible without:

• Go and it's libraries:
  • packr
  • gcache
  • miekg's dns
  • go-yaml
  • service
  • dnsproxy
  • urlfilter
• Node.js and it's libraries:
  • React.js
  • Tabler
  • And many more node.js packages.
• whotracks.me data

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.