https://github.com/AdguardTeam/AdGuardHome Skip to content Toggle navigation Sign up * Product + Actions Automate any workflow + Packages Host and manage packages + Security Find and fix vulnerabilities + Codespaces Instant dev environments + Copilot Write better code with AI + Code review Manage code changes + Issues Plan and track work + Discussions Collaborate outside of code + Explore + All features + Documentation + GitHub Skills + Blog * Solutions + By Plan + Enterprise + Teams + Compare all + By Solution + CI/CD & Automation + DevOps + DevSecOps + Case Studies + Customer Stories + Resources * Open Source + GitHub Sponsors Fund open source developers + The ReadME Project GitHub community articles + Repositories + Topics + Trending + Collections * Pricing [ ] * # In this repository All GitHub | Jump to | * No suggested jump to results * # In this repository All GitHub | Jump to | * # In this organization All GitHub | Jump to | * # In this repository All GitHub | Jump to | Sign in Sign up {{ message }} AdguardTeam / AdGuardHome Public * Notifications * Fork 1.3k * Star 13.3k Network-wide ads & trackers blocking DNS server adguard.com/adguard-home.html License GPL-3.0 license 13.3k stars 1.3k forks Star Notifications * Code * Issues 620 * Pull requests 17 * Discussions * Actions * Projects 0 * Wiki * Security * Insights More * Code * Issues * Pull requests * Discussions * Actions * Projects * Wiki * Security * Insights AdguardTeam/AdGuardHome This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository. master Switch branches/tags [ ] Branches Tags Could not load branches Nothing to show {{ refName }} default View all branches Could not load tags Nothing to show {{ refName }} default View all tags Name already in use A tag already exists with the provided branch name. Many Git commands accept both tag and branch names, so creating this branch may cause unexpected behavior. Are you sure you want to create this branch? Cancel Create 41 branches 122 tags Code * Clone HTTPS GitHub CLI [https://github.com/A] Use Git or checkout with SVN using the web URL. [gh repo clone Adguar] Work fast with our official CLI. Learn more. * Open with GitHub 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 Code Your codespace will open once ready. There was a problem preparing your codespace, please try again. Latest commit @ainar-g ainar-g Pull request: imp-ups-tests ... ac7634d Oct 28, 2022 Pull request: imp-ups-tests Merge in DNS/adguard-home from imp-ups-tests to master Squashed commit of the following: commit 60c22e8 Author: Ainar Garipov Date: Fri Oct 28 19:26:34 2022 +0300 all: imp names, fix aaaa commit c3bd8a9 Merge: 23f8223 746e9df Author: Ainar Garipov Date: Fri Oct 28 19:16:56 2022 +0300 Merge branch 'master' into imp-ups-tests commit 23f8223 Author: Ainar Garipov Date: Fri Oct 28 18:14:27 2022 +0300 all: imp upstream tests ac7634d Git stats * 3,543 commits Files Permalink Failed to load latest commit information. Type Name Latest commit message Commit time .github Pull request: 3972-hostlists-registry Oct 21, 2022 bamboo-specs Pull request: upd-go Oct 7, 2022 build Pull request: all: update go and backend tools May 21, 2021 build2 Pull request: all: update go and backend tools May 21, 2021 client Pull request: 3972-hostlists-services Oct 27, 2022 client2 Add '/blocked_services/services' API Apr 25, 2022 doc Fix #4366 Color scheme based logo Aug 24, 2022 internal Pull request: imp-ups-tests Oct 28, 2022 openapi Pull request: 3972-hostlists-services Oct 27, 2022 scripts Pull request: 3972-hostlists-services Oct 27, 2022 .codecov.yml Pull request: all: reformat yaml, add yaml formatting standard Nov 20, 2020 .dockerignore Pull request: all: add a new Makefile and scripts, remove goreleaaser Dec 30, 2020 .gitattributes Pull request: all: upd go Feb 11, 2022 .gitignore Pull request: 3172 fix mobileconfig Jun 1, 2021 .twosky.json Pull request: add-ar-i18n Aug 10, 2022 AGHTechDoc.md Add '/blocked_services/services' API Apr 25, 2022 CHANGELOG.md Pull request: 3972-hostlists-services Oct 27, 2022 HACKING.md Pull request: all: add links to new guidelines Jul 28, 2021 LICENSE.txt Initial commit Aug 30, 2018 Makefile Pull request: websvc-config-manager Oct 4, 2022 README.md Pull request: 5023-readme-debug Oct 13, 2022 SECURITY.md Pull request: HOFTIX-csrf Sep 29, 2022 changelog.config.js Pull request: all: less annoying pkg names May 21, 2021 go.mod Pull request: upd-pkgs-tools Oct 28, 2022 go.sum Pull request: upd-pkgs-tools Oct 28, 2022 main.go Pull request: websvc-config-manager Oct 4, 2022 main_next.go Pull request: websvc-config-manager Oct 4, 2022 staticcheck.conf Pull request: all: imp docs, names Jun 18, 2021 View code [ ] Privacy protection center for you and your devices Getting Started Automated install (Unix) Alternative methods Manual installation Docker Snap Store Guides API 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 Known limitations How to build from source Prerequisites Building Building for a different platform Preparing releases Docker image Debugging the frontend Contributing Test unstable versions Report issues Help with translations Other Projects that use AdGuard Home Acknowledgments Privacy 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 Code Coverage Go Report Card Docker Pulls Latest release adguard-home [68747470733a2f2f63646e2e6164746964792e6f72672f7075626c69632f416467756172642f436f6d6d6f6e2f616467756172645f686f6d6] --------------------------------------------------------------------- AdGuard Home is a network-wide software for blocking ads and 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, and both share a lot of code. * Getting Started + Automated install (Unix) + Alternative methods + Guides + API * 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 + Known limitations * How to build from source + Prerequisites + Building * Contributing + Test unstable versions + Reporting issues + Help with translations + Other * Projects that use AdGuard Home * Acknowledgments * Privacy Getting Started Automated install (Unix) Run the following command in your terminal: curl -s -S -L https://raw.githubusercontent.com/AdguardTeam/AdGuardHome/master/scripts/install.sh | sh -s -- -v The script also accepts some options: * -c to use specified channel; * -r to reinstall AdGuard Home; * -u to uninstall AdGuard Home; * -v for verbose output. Note that options -r and -u are mutually exclusive. Alternative methods Manual installation 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. Docker You can use our official Docker image on Docker Hub. Snap Store If you're running Linux, there's a secure and easy way to install AdGuard Home: get it from the Snap Store. Guides See our Wiki. 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 the server blocks and permits. * Monitor your network activity. * Add your own custom filtering rules. * Most importantly, it's 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 the so-called "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 Kind of, but you'll need HTTPS for the Admin interface to manually configure lighttpd Encrypted DNS upstream servers (requires additional (DNS-over-HTTPS, DNS-over-TLS, software) DNSCrypt) Cross-platform (not natively, only via Docker) Running as a DNS-over-HTTPS or (requires additional DNS-over-TLS server software) Blocking phishing and malware (requires non-default domains 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 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 the flexibility and the power of traditional ad blockers. You can get a good impression about the difference between these methods by reading this article, which compares AdGuard for Android (a traditional ad blocker) to hosts-level ad blockers (which are almost identical to DNS-based blockers in their capabilities). 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). Known limitations Here are some examples of what cannot be blocked by a DNS-level blocker: * YouTube, Twitch ads; * Facebook, Twitter, Instagram sponsored posts. 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 a complicated configuration. How to build from source Prerequisites Run make init to prepare the development environment. You will need this to build AdGuard Home: * Go v1.18 or later; * Node.js v10.16.2 or later; * npm v6.14 or later; * yarn v1.22.5 or later. Building Open your terminal and execute these commands: git clone https://github.com/AdguardTeam/AdGuardHome cd AdGuardHome make NOTE: The non-standard -j flag is currently not supported, so building with 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. Check the Makefile to learn about other commands. Building for a different platform You can build AdGuard Home for any OS/ARCH that Go supports. In order to do this, specify GOOS and GOARCH environment variables as macros when running make. For example: env GOOS='linux' GOARCH='arm64' make or: make GOOS='linux' GOARCH='arm64' Preparing releases You'll need snapcraft to prepare a release build. Once installed, run the following command: make build-release CHANNEL='...' VERSION='...' See the build-release target documentation. Docker image Run make build-docker to 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: * (Linux-only) Install Qemu: docker run --rm --privileged multiarch/qemu-user-static --reset -p yes --credential yes * Prepare the builder: docker buildx create --name buildx-builder --driver docker-container --use See the build-docker target documentation. Debugging the frontend When you need to debug the frontend without recompiling the production version every time, for example to check how your labels would look on a form, you can run the frontend build a development environment. 1. In a separate terminal, run: ( cd ./client/ && env NODE_ENV='development' npm run watch ) 2. Run your AdGuardHome binary with the --local-frontend flag, which instructs AdGuard Home to ignore the built-in frontend files and use those from the ./build/ directory. 3. Now any changes you make in the ./client/ directory should be recompiled and become available on the web UI. Make sure that you disable the browser cache to make sure that you actually get the recompiled version. Contributing You are welcome to fork this repository, make your changes and submit a pull request. Please make sure you follow our code guidelines though. Please note that we don't expect people to contribute to both UI and backend parts of the program simultaneously. Ideally, the backend 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. Test unstable versions There are two update channels that you can use: * beta: beta versions of AdGuard Home. More or less stable versions, usually released every two weeks or more often. * edge: the newest version of AdGuard Home from the development branch. New updates are pushed to this channel daily. There are three options how you can install an unstable version: 1. Snap Store: look for the beta and edge channels. 2. Docker Hub: look for the beta and edge tags. 3. Standalone builds. Use the automated installation script or look for the available builds on the Wiki. Script to install a beta version: curl -s -S -L https://raw.githubusercontent.com/AdguardTeam/AdGuardHome/master/scripts/install.sh | sh -s -- -c beta Script to install an edge version: curl -s -S -L https://raw.githubusercontent.com/AdguardTeam/AdGuardHome/master/scripts/install.sh | sh -s -- -c edge 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 in our Knowledge Base. You can contribute to the AdGuardHome project on CrowdIn. Other Another way you can contribute is by looking for issues marked as help wanted, asking if the issue is up for grabs, and sending a PR fixing the bug or implementing the feature. Projects that use AdGuard Home * AdGuard Home Remote: iOS app by Joost. * Python library by @frenck. * Home Assistant add-on by @frenck. * OpenWrt LUCI app by @kongfl888 (originally by @rufengsuixing). * Prometheus exporter for AdGuard Home by @ebrianne. * AdGuard Home on GLInet routers by Gl-Inet. * Cloudron app by @gramakri. * Asuswrt-Merlin-AdGuardHome-Installer by @jumpsmm7 aka @SomeWhereOverTheRainBow. * Node.js library by @Andrea055. Acknowledgments This software wouldn't have been possible without: * Go and its libraries: + gcache + miekg's dns + go-yaml + service + dnsproxy + urlfilter * Node.js and its libraries: + And many more Node.js packages. + React.js + Tabler * whotracks.me data You might have seen that CoreDNS was mentioned here before, but we've stopped using it in AdGuard Home. For the full list of all Node.js packages in use, please take a look at client/package.json file. Privacy 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. See also the full privacy policy with every bit that could in theory be sent by AdGuard Home is available. About Network-wide ads & trackers blocking DNS server adguard.com/adguard-home.html Topics dns golang open-source privacy dnscrypt adblock adguard dns-over-https dns-over-tls dns-over-quic Resources Readme License GPL-3.0 license Security policy Security policy Stars 13.3k stars Watchers 253 watching Forks 1.3k forks Releases 110 AdGuard Home v0.107.16 Latest Oct 7, 2022 + 109 releases Contributors 79 * @szolin * @ainar-g * @ameshkov * @IldarKamalov * @hmage * @EugeneOne1 * @ArtemBaskal * @traviscibot * @hoang-rio * @nkartyshov * @ssrahul96 + 68 contributors Languages * Go 45.3% * JavaScript 23.7% * TypeScript 15.0% * CSS 13.8% * Shell 1.7% * HTML 0.2% * Other 0.3% Footer (c) 2022 GitHub, Inc. Footer navigation * Terms * Privacy * Security * Status * Docs * Contact GitHub * Pricing * API * Training * Blog * About You can't perform that action at this time. You signed in with another tab or window. Reload to refresh your session. You signed out in another tab or window. Reload to refresh your session.