mirrors/AdGuardHome
1
0
Fork 0
mirror of https://github.com/AdguardTeam/AdGuardHome.git synced 2024-11-25 06:25:44 +03:00
Code Issues Projects Releases Packages Wiki Activity
Network-wide ads & trackers blocking DNS server
1887 commits 95 branches 201 tags 51 MiB
Go 60.3%
TypeScript 24.8%
CSS 12.4%
Shell 2%
Makefile 0.2%
Other 0.2%
Find a file
Andrey Meshkov 7a3eda02ce Fix #1069 install: check static ip 
Squashed commit of the following:

commit 57466233cb
Merge: 2df5f281 867bf545
Author: Andrey Meshkov <am@adguard.com>
Date:   Thu Feb 13 18:39:15 2020 +0300

    Merge branch 'master' into 1069-install-static-ip

commit 2df5f281c4
Author: Andrey Meshkov <am@adguard.com>
Date:   Thu Feb 13 18:35:54 2020 +0300

    *: lang fix

commit b4649a6b27
Merge: c2785253 f61d5f0f
Author: Andrey Meshkov <am@adguard.com>
Date:   Thu Feb 13 16:47:30 2020 +0300

    *(home): fixed issues with setting static IP on Mac

commit c27852537d
Author: Andrey Meshkov <am@adguard.com>
Date:   Thu Feb 13 14:14:30 2020 +0300

    +(dhcpd): added static IP for MacOS

commit f61d5f0f85
Author: Ildar Kamalov <i.kamalov@adguard.com>
Date:   Thu Feb 13 14:13:35 2020 +0300

    + client: show confirm before setting static IP

commit 7afa16fbe7
Author: Ildar Kamalov <i.kamalov@adguard.com>
Date:   Thu Feb 13 13:51:52 2020 +0300

    - client: fix text

commit 019bff0851
Author: Ildar Kamalov <i.kamalov@adguard.com>
Date:   Thu Feb 13 13:49:16 2020 +0300

    - client: pass all params to the check_config request

commit 194bed72f5
Author: Andrey Meshkov <am@adguard.com>
Date:   Wed Feb 12 17:12:16 2020 +0300

    *: fix home_test

commit 9359f6b55f
Merge: ae299058 c5ca2a77
Author: Andrey Meshkov <am@adguard.com>
Date:   Wed Feb 12 15:54:54 2020 +0300

    Merge with master

commit ae2990582d
Author: Andrey Meshkov <am@adguard.com>
Date:   Wed Feb 12 15:53:36 2020 +0300

    *(global): refactoring - moved runtime properties to Context

commit d8d48c5386
Author: Andrey Meshkov <am@adguard.com>
Date:   Wed Feb 12 15:04:25 2020 +0300

    *(dhcpd): refactoring, use dhcpd/network_utils where possible

commit 8d039c572f
Author: Ildar Kamalov <i.kamalov@adguard.com>
Date:   Fri Feb 7 18:37:39 2020 +0300

    - client: fix button position

commit 26c47e59dd
Author: Ildar Kamalov <i.kamalov@adguard.com>
Date:   Fri Feb 7 18:08:56 2020 +0300

    - client: fix static ip description

commit cb12babc46
Author: Andrey Meshkov <am@adguard.com>
Date:   Fri Feb 7 17:08:39 2020 +0300

    *: lower log level for some commands

commit d9001ff848
Author: Andrey Meshkov <am@adguard.com>
Date:   Fri Feb 7 16:17:59 2020 +0300

    *(documentation): updated openapi

commit 1d213d53c8
Merge: 8406d7d2 80861860
Author: Andrey Meshkov <am@adguard.com>
Date:   Fri Feb 7 15:16:46 2020 +0300

    *: merge with master

commit 8406d7d288
Author: Ildar Kamalov <i.kamalov@adguard.com>
Date:   Fri Jan 31 16:52:22 2020 +0300

    - client: fix locales

commit fb476b0117
Author: Simon Zolin <s.zolin@adguard.com>
Date:   Fri Jan 31 13:29:03 2020 +0300

    linter

commit 84b5708e71
Author: Simon Zolin <s.zolin@adguard.com>
Date:   Fri Jan 31 13:27:53 2020 +0300

    linter

commit 143a86a28a
Author: Simon Zolin <s.zolin@adguard.com>
Date:   Fri Jan 31 13:26:47 2020 +0300

    linter

... and 7 more commits
2020-02-13 18:42:07 +03:00
.github fix typo2 2019-08-02 14:55:58 +03:00
client Fix #1069 install: check static ip 2020-02-13 18:42:07 +03:00
dhcpd Fix #1069 install: check static ip 2020-02-13 18:42:07 +03:00
dnsfilter *(dnsforward): fix safe search returning nxdomain 2020-02-05 14:30:43 +03:00
dnsforward *(dnsforward): fix safe search returning nxdomain 2020-02-05 14:30:43 +03:00
doc * doc: filtering logic with a diagram 2019-12-03 17:01:26 +03:00
home Fix #1069 install: check static ip 2020-02-13 18:42:07 +03:00
isdelve -(global): fixing the installation flow on windows 2019-12-23 14:57:10 +03:00
openapi Fix #1069 install: check static ip 2020-02-13 18:42:07 +03:00
querylog Merge: - install: recover from error on DNS server start 2020-01-16 14:25:40 +03:00
scripts *(global): update trackers db 2020-01-30 18:40:58 +03:00
stats Merge: - install: recover from error on DNS server start 2020-01-16 14:25:40 +03:00
util Fix #1069 install: check static ip 2020-02-13 18:42:07 +03:00
.codecov.yml Added codecov, goreport 2019-01-25 20:13:57 +03:00
.gitattributes fix gh language 2018-10-17 13:14:45 +03:00
.gitignore *(global): CI scripts 2019-10-02 15:41:14 +03:00
.golangci.yml *(global): CI scripts 2019-10-02 15:41:14 +03:00
.gometalinter.json Fix review comments 2019-02-11 14:22:36 +03:00
.travis.yml -(global): docker image - dirty version 2019-12-19 19:50:12 +03:00
.twosky.json + client: remove locales from js bundle 2020-01-31 15:57:20 +03:00
AGHTechDoc.md Fix #1069 install: check static ip 2020-02-13 18:42:07 +03:00
build_docker.sh Build latest from tag branch, edge from master 2019-02-11 15:10:36 +03:00
changelog.config.js +: git-cz config file 2019-07-24 17:26:21 +03:00
ci.sh Merge: * use upstream servers directly for the internal DNS resolver 2019-12-11 12:38:58 +03:00
Dockerfile Update ports in docker files 2019-06-04 16:30:55 +03:00
Dockerfile.travis Merge branch 'master' of ssh://bit.adguard.com:7999/dns/adguard-dns 2019-06-04 16:30:59 +03:00
go.mod Merge: - filtering: fix host rules matching 2020-01-30 19:06:09 +03:00
go.sum Merge: - filtering: fix host rules matching 2020-01-30 19:06:09 +03:00
LICENSE.txt Initial commit 2018-08-30 17:25:33 +03:00
main.go *(global): fix ARM build auto-update 2020-02-06 20:55:37 +03:00
Makefile *(global): fix ARM build auto-update 2020-02-06 20:55:37 +03:00
README.md Update README.md 2020-01-28 13:07:08 +03:00
release.sh + release.sh: add armv5 build 2020-01-15 18:58:12 +03:00

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.