AdGuardHome/README.md at 398da7e2d3fec554db4bc7d658abf7c367cea9ab

mirror of https://github.com/AdguardTeam/AdGuardHome.git synced 2024-11-25 06:25:44 +03:00

Andrey Meshkov 65acfb75dd Merge: + install.sh

Merge in DNS/adguard-home from install.sh to master
Fix #995

Squashed commit of the following:

commit 81a5b6385574fa5bc14f7e9cc8cd707fcdc491c3
Merge: 825062a9 fb7ca942
Author: Andrey Meshkov <am@adguard.com>
Date:   Wed Oct 7 20:40:30 2020 +0300

    Merge branch 'master' into install.sh

commit 825062a9cb77447bec0967635bde334218437e1f
Author: Andrey Meshkov <am@adguard.com>
Date:   Wed Oct 7 20:04:04 2020 +0300

    minor fixes

commit 22205d80479a1f894fe6c72afe22ba555a9e611e
Author: Andrey Meshkov <am@adguard.com>
Date:   Wed Oct 7 20:01:56 2020 +0300

    * (home): fix install script

commit 073b5fb8e27351094b95d85335dd3d08f65f9ee8
Author: Andrey Meshkov <am@adguard.com>
Date:   Wed Oct 7 19:59:07 2020 +0300

    * (home): update readme and install script

commit d4d2e4c35ca1ea1f365e40081098ee9398196ef3
Author: Andrey Meshkov <am@adguard.com>
Date:   Wed Oct 7 14:43:49 2020 +0300

    disable parallel build

commit a639b9ae44c534c7fdecd34894f5ad4ae6217472
Author: Andrey Meshkov <am@adguard.com>
Date:   Wed Oct 7 02:48:52 2020 +0300

    * (home): improve install.sh

commit 4c564da714850002d1810d4d10dce859f340e3ab
Author: Simon Zolin <s.zolin@adguard.com>
Date:   Thu Oct 1 15:32:53 2020 +0300

    minor

commit 0ecc1a03a41201a632f650ba995f3b07a6539889
Author: Simon Zolin <s.zolin@adguard.com>
Date:   Thu Oct 1 15:08:07 2020 +0300

    * install.sh: use /opt/AdGuardHome output directory

commit fd3ad73606c69e8ede086e67bc557772f9e34406
Author: Simon Zolin <s.zolin@adguard.com>
Date:   Wed Sep 30 12:13:56 2020 +0300

    * install.sh: prompt for an output directory

commit 8917e8cb3d794cfa1fd7b358c89695ff719e7e4d
Author: Simon Zolin <s.zolin@adguard.com>
Date:   Tue Sep 29 18:56:54 2020 +0300

    + install.sh

2020-10-07 21:01:30 +03:00

20 KiB

Raw Blame History

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

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 to build from source
Contributing
Projects that use AdGuardHome
Acknowledgments

Getting Started

Automated install (Linux and Mac)

Run the following command in your terminal:

curl -sSL https://raw.githubusercontent.com/AdguardTeam/AdGuardHome/master/scripts/install.sh | sh

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.

Snap Store

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

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).

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 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.14 or later.
node.js v10.16.2 or later.
npm v6.14 or later.

Optionally, for Go devs:

golangci-lint

Building

Open Terminal and execute these commands:

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

Check the Makefile to learn about other commands.

Building for a different platform. You can build AdGuard for any OS/ARCH just like any other Golang project. In order to do this, specify GOOS and GOARCH env variables before running make.

For example:

GOOS=linux GOARCH=arm64 make

Preparing release

You'll need this to prepare a release build:

Commands:

make release - builds a snapshot build (CHANNEL=edge)
CHANNEL=beta make release - builds beta version, tag is mandatory.
CHANNEL=release make release - builds release version, tag is mandatory.

Docker image

Run make docker to build the Docker image locally.
Run make docker-multi-arch to build the multi-arch Docker image (the one that we publish to Docker Hub).

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 builder: docker buildx create --name buildx-builder --driver docker-container --use

Resources that we update periodically

scripts/translations
scripts/whotracksme

Contributing

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.

Test unstable versions

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:

Snap Store -- look for "beta" and "edge" channels there.
Docker Hub -- look for "beta" and "edge" tags there.
Standalone builds. Use the automated installation script or look for the available builds below.

Beta:

curl -sSL https://raw.githubusercontent.com/AdguardTeam/AdGuardHome/master/scripts/install.sh | sh -s beta

Edge:

curl -sSL https://raw.githubusercontent.com/AdguardTeam/AdGuardHome/master/scripts/install.sh | sh -s edge

Beta channel builds
- Linux: 64-bit, 32-bit
- Linux ARM: 32-bit ARMv6 (recommended for Rapsberry Pi), 64-bit, 32-bit ARMv5, 32-bit ARMv7
- Linux MIPS: 32-bit MIPS, 32-bit MIPSLE, 64-bit MIPS, 64-bit MIPSLE
- Windows: 64-bit, 32-bit
- MacOS: 64-bit, 32-bit
- FreeBSD: 64-bit, 32-bit
- FreeBSD ARM: 64-bit, 32-bit ARMv5, 32-bit ARMv6, 32-bit ARMv7
Edge channel builds
- Linux: 64-bit, 32-bit
- Linux ARM: 32-bit ARMv6 (recommended for Rapsberry Pi), 64-bit, 32-bit ARMv5, 32-bit ARMv7
- Linux MIPS: 32-bit MIPS, 32-bit MIPSLE, 64-bit MIPS, 64-bit MIPSLE
- Windows: 64-bit, 32-bit
- MacOS: 64-bit, 32-bit
- FreeBSD: 64-bit, 32-bit
- FreeBSD ARM: 64-bit, 32-bit ARMv5, 32-bit ARMv6, 32-bit ARMv7

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

Other

Here's what you can also do to contribute:

Look for issues marked as "help wanted".
Actualize the list of Blocked services. It it can be found in dnsfilter/blocked_services.go.
Actualize the list of known trackers. It it can be found in client/src/helpers/trackers/adguard.json.
Actualize the list of vetted blocklists. It it can be found in client/src/helpers/filters/filters.json.

Projects that use AdGuardHome

Python library (https://github.com/frenck/python-adguardhome)
Hass.io add-on (https://github.com/hassio-addons/addon-adguard-home)
OpenWrt LUCI app (https://github.com/rufengsuixing/luci-app-adguardhome)

Acknowledgments

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.

20 KiB Raw Blame History