AdGuardHome/README.md

361 lines
22 KiB
Markdown
Raw Normal View History

2018-10-15 15:20:57 +01:00
 
<p align="center">
<img src="https://cdn.adguard.com/public/Adguard/Common/adguard_home.svg" width="300px" alt="AdGuard Home" />
</p>
<h3 align="center">Privacy protection center for you and your devices</h3>
<p align="center">
Free and open source, powerful network-wide ads & trackers blocking DNS server.
</p>
<p align="center">
<a href="https://adguard.com/">AdGuard.com</a> |
<a href="https://github.com/AdguardTeam/AdGuardHome/wiki">Wiki</a> |
<a href="https://reddit.com/r/Adguard">Reddit</a> |
2019-01-25 09:55:13 +00:00
<a href="https://twitter.com/AdGuard">Twitter</a> |
<a href="https://t.me/adguard_en">Telegram</a>
2018-10-15 15:20:57 +01:00
<br /><br />
2019-01-25 09:55:13 +00:00
<a href="https://codecov.io/github/AdguardTeam/AdGuardHome?branch=master">
<img src="https://img.shields.io/codecov/c/github/AdguardTeam/AdGuardHome/master.svg" alt="Code Coverage" />
</a>
<a href="https://goreportcard.com/report/AdguardTeam/AdGuardHome">
<img src="https://goreportcard.com/badge/github.com/AdguardTeam/AdGuardHome" alt="Go Report Card" />
</a>
2020-08-27 21:54:48 +01:00
<a href="https://hub.docker.com/r/adguard/adguardhome">
<img alt="Docker Pulls" src="https://img.shields.io/docker/pulls/adguard/adguardhome.svg?maxAge=604800" />
</a>
<a href="https://hub.docker.com/r/adguard/adguardhome">
<img alt="Docker Stars" src="https://img.shields.io/docker/stars/adguard/adguardhome.svg?maxAge=604800" />
2019-01-25 19:23:09 +00:00
</a>
2020-04-27 14:18:35 +01:00
<br />
2018-10-15 15:20:57 +01:00
<a href="https://github.com/AdguardTeam/AdGuardHome/releases">
<img src="https://img.shields.io/github/release/AdguardTeam/AdGuardHome/all.svg" alt="Latest release" />
2018-10-15 15:20:57 +01:00
</a>
<a href="https://snapcraft.io/adguard-home">
<img alt="adguard-home" src="https://snapcraft.io/adguard-home/badge.svg" />
</a>
2018-10-15 15:20:57 +01:00
</p>
<br />
<p align="center">
<img src="https://cdn.adguard.com/public/Adguard/Common/adguard_home.gif" width="800" />
</p>
<hr />
2018-08-30 16:16:37 +01:00
2018-10-15 15:20:57 +01:00
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.
2018-08-30 15:25:33 +01:00
2021-01-05 17:49:28 +00:00
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](https://adguard.com/en/adguard-dns/overview.html) servers -- both share a lot of common code.
2018-08-30 15:25:33 +01:00
2019-02-24 15:42:44 +00:00
* [Getting Started](#getting-started)
2019-06-06 14:00:35 +01:00
* [Comparing AdGuard Home to other solutions](#comparison)
* [How is this different from public AdGuard DNS servers?](#comparison-adguard-dns)
* [How does AdGuard Home compare to Pi-Hole](#comparison-pi-hole)
* [How does AdGuard Home compare to traditional ad blockers](#comparison-adblock)
2019-02-24 15:42:44 +00:00
* [How to build from source](#how-to-build)
* [Contributing](#contributing)
2019-06-06 14:00:35 +01:00
* [Test unstable versions](#test-unstable-versions)
* [Reporting issues](#reporting-issues)
* [Help with translations](#translate)
+ client: Add choosing filter lists Fix #1325 Squashed commit of the following: commit d8f7de72226855a961051e09b4b78f4dd71baadd Merge: f9bbe861 36f3218b Author: Andrey Meshkov <am@adguard.com> Date: Mon Jul 6 19:34:53 2020 +0300 Merge branch 'master' into feature/1325 commit f9bbe861c9dbd631b5708f8eb073270b83a3f70f Merge: 99710fef 4f8138bd Author: Andrey Meshkov <am@adguard.com> Date: Mon Jul 6 19:33:53 2020 +0300 Merge branch 'master' into feature/1325 commit 99710fef0825966b224e4a30a979e4d45f929af1 Merge: 8329326d a5380ead Author: ArtemBaskal <a.baskal@adguard.com> Date: Mon Jul 6 18:04:32 2020 +0300 Merge branch 'feature/1325' of ssh://bit.adguard.com:7999/dns/adguard-home into feature/1325 commit 8329326d6470dfcf2cdc4479e0290f7cc56ddca4 Author: ArtemBaskal <a.baskal@adguard.com> Date: Mon Jul 6 18:03:56 2020 +0300 Update locales, add title for select modal commit a5380ead56d15eba3f36c38f8fc0eedc89c2c57a Author: Andrey Meshkov <am@adguard.com> Date: Mon Jul 6 17:26:37 2020 +0300 Update readme commit dfe6e254d909ee6994cacef53d417bb073dfd802 Author: ArtemBaskal <a.baskal@adguard.com> Date: Mon Jul 6 13:44:19 2020 +0300 Change info icon width commit 06120cf3da9065fc9cc3a2864b976563d4cfe06a Author: ArtemBaskal <a.baskal@adguard.com> Date: Mon Jul 6 13:38:58 2020 +0300 Review changes commit ae3c6cacc5610a0f95bec2f6ef8a63e90041e4dd Merge: dd56a3bb 73c5d9ea Author: ArtemBaskal <a.baskal@adguard.com> Date: Mon Jul 6 12:01:57 2020 +0300 Merge branch 'master' into feature/1325 commit dd56a3bbb851687823242fa653cc3bb63dedf5e4 Author: Andrey Meshkov <am@adguard.com> Date: Fri Jul 3 15:52:01 2020 +0300 Added blocklists commit f08f0eb0cdd8cd488d3a8f1182854b72775cf06e Merge: 854d4f88 21dfb5ff Author: Andrey Meshkov <am@adguard.com> Date: Fri Jul 3 14:06:19 2020 +0300 Merge branch 'master' into feature/1325 commit 854d4f88017a33dc7f788835dc98591cec9b213f Merge: 23946266 2c47053c Author: ArtemBaskal <a.baskal@adguard.com> Date: Mon Jun 22 14:09:31 2020 +0300 Merge branch 'master' into feature/1325 commit 23946266d4913479bcecfcb7702a096983d20685 Author: ArtemBaskal <a.baskal@adguard.com> Date: Tue May 26 19:00:26 2020 +0300 Math filters by url commit 661e0482f01ffea0d0f5aa81b3b253143d0ca112 Author: ArtemBaskal <a.baskal@adguard.com> Date: Mon May 25 21:07:21 2020 +0300 Change data format commit ac4ff483b6b06ec0be49a41b5ddd3329f4ae2bbb Author: ArtemBaskal <a.baskal@adguard.com> Date: Thu May 14 19:52:45 2020 +0300 + client: Add choosing filter lists
2020-07-06 17:58:44 +01:00
* [Other](#help-other)
Pull request: all: add a new Makefile and scripts, remove goreleaaser Merge in DNS/adguard-home from 2276-releases to master Updates #2276. Squashed commit of the following: commit 84961947c51477aae53606ec6e2e0cce0bdfc139 Author: Ainar Garipov <A.Garipov@AdGuard.COM> Date: Wed Dec 30 14:36:13 2020 +0300 all: fix github build commit 54af2adbf2f433e80393fb142e66ba6b3a78b13e Author: Ainar Garipov <A.Garipov@AdGuard.COM> Date: Wed Dec 30 14:34:02 2020 +0300 all: remove old Dockerfile, improve build scripts commit 99bb2f2ba1458d32074ac0911b5c02ce6669e43e Merge: 2292b677a 5e20ac7ed Author: Ainar Garipov <A.Garipov@AdGuard.COM> Date: Wed Dec 30 13:47:19 2020 +0300 Merge branch 'master' into WIP-2276-releases commit 2292b677a20ce8e93d9e6e2bb042cd468606fec3 Author: Ainar Garipov <A.Garipov@AdGuard.COM> Date: Wed Dec 30 13:30:10 2020 +0300 all: improve docker build commit 0bcc97c41f105ee4a4363f20fa4775c7643bf0cc Merge: c7d3f12ef aef4659e9 Author: Ainar Garipov <A.Garipov@AdGuard.COM> Date: Tue Dec 29 17:47:45 2020 +0300 Merge branch 'master' into WIP-2276-releases commit c7d3f12ef2b63ddfa2acf46e3129fcbc56fb0a90 Author: Ainar Garipov <A.Garipov@AdGuard.COM> Date: Tue Dec 29 16:28:25 2020 +0300 all: improve build scripts commit 55de1e5d7ef0fbdbd1a76cfb71362d16ca0a1966 Author: Ainar Garipov <A.Garipov@AdGuard.COM> Date: Tue Dec 29 15:36:47 2020 +0300 all: fix Makefile commit d11b1fe28d0fde1efeaf6160a614951b19d0ef94 Author: Ainar Garipov <A.Garipov@AdGuard.COM> Date: Tue Dec 29 14:16:19 2020 +0300 scripts: fix build-release commit ecc0577e2451afa86c37da7283a63a9d26fb37ba Merge: dde64ed8e 483f02c92 Author: Ainar Garipov <A.Garipov@AdGuard.COM> Date: Tue Dec 29 13:59:32 2020 +0300 Merge branch 'master' into WIP-2276-releases commit dde64ed8e456f73559f21c2ca549dc3b46724add Author: Ainar Garipov <A.Garipov@AdGuard.COM> Date: Fri Dec 25 18:04:46 2020 +0300 all: imp docs, other improvements commit be8574408db79901bb15c1d31916db3ca352a35f Author: Ainar Garipov <A.Garipov@AdGuard.COM> Date: Fri Dec 25 14:48:30 2020 +0300 all: imp docker build commit fc1876f34b93d667bf166226f4bc666d394f10c7 Merge: fa5a304c8 955b735c8 Author: Ainar Garipov <A.Garipov@AdGuard.COM> Date: Fri Dec 25 13:54:29 2020 +0300 Merge branch 'master' into WIP-2276-releases commit fa5a304c83d86145796a2de4141de6d18f7c56bf Author: Ainar Garipov <A.Garipov@AdGuard.COM> Date: Thu Dec 24 19:10:51 2020 +0300 all: improve scripts commit 3f32e3fd5e658d058d5c5172519384efc6cfef83 Author: Ainar Garipov <A.Garipov@AdGuard.COM> Date: Thu Dec 24 18:50:01 2020 +0300 all: improve scripts commit 2d38b81421acab4b90a7a19da7598c75063e8e93 Author: Ainar Garipov <A.Garipov@AdGuard.COM> Date: Thu Dec 24 18:25:21 2020 +0300 all: fix shell for windows, improve go-lint.sh commit d695285cd6dc476c0d972cfe0c49bbeea5f5a049 Merge: 313b020e9 9fb6bf82c Author: Ainar Garipov <A.Garipov@AdGuard.COM> Date: Thu Dec 24 18:14:38 2020 +0300 Merge branch 'master' into WIP-2276-releases commit 313b020e9dfcdab736670cee72b2171eac8c32b7 Author: Ainar Garipov <A.Garipov@AdGuard.COM> Date: Thu Dec 24 18:13:31 2020 +0300 Makefile: use npm ci again commit 5acee9d6a6c8cd2a7dd04b173a73929650882bad Author: Ainar Garipov <A.Garipov@AdGuard.COM> Date: Thu Dec 24 17:57:54 2020 +0300 all: try fixing windows build commit c63a2a54641ac8cd032a3306bb35e49b9ae74728 Author: Ainar Garipov <A.Garipov@AdGuard.COM> Date: Thu Dec 24 17:39:30 2020 +0300 all: imp scripts, try another goproxy and direct commit 423229e8b63ee73caeee8e84c23f67d145aff9df Author: Ainar Garipov <A.Garipov@AdGuard.COM> Date: Thu Dec 24 17:25:29 2020 +0300 all: imp HACKING.md, try a new proxy ... and 1 more commit
2020-12-30 15:26:25 +00:00
* [Projects that use AdGuard Home](#uses)
2019-02-24 15:42:44 +00:00
* [Acknowledgments](#acknowledgments)
* [Privacy](#privacy)
2018-08-30 15:25:33 +01:00
2019-02-24 15:42:44 +00:00
<a id="getting-started"></a>
## Getting Started
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 19:01:30 +01:00
### Automated install (Linux and Mac)
Run the following command in your terminal:
```
Pull request: improve installation script Merge in DNS/adguard-home from 2542-2462-imp-script to master Closes #2462. Updates #2542. Updates #2613. Squashed commit of the following: commit 4a7472200f2ae07aeccc3511a75a94674b655cdb Author: Eugene Burkov <e.burkov@adguard.com> Date: Mon May 17 15:11:08 2021 +0300 scripts: imp naming, docs commit acbb5864a34e81d8c80767dd7ef57dffb189dc64 Author: Eugene Burkov <e.burkov@adguard.com> Date: Mon May 17 15:05:57 2021 +0300 scripts: imp fix commit 64777015b6d50e7330fbe7546de1f436f4cb707f Author: Eugene Burkov <e.burkov@adguard.com> Date: Mon May 17 14:54:05 2021 +0300 scripts: fix bsd commit 3308921f4c253c8670c4be70896c55f7a892ff3e Author: Eugene Burkov <e.burkov@adguard.com> Date: Mon May 17 14:04:04 2021 +0300 scripts: imp requirements checking commit 453cf7a4ce676d2eb09d423304e4d5a8962ac4e5 Author: Eugene Burkov <e.burkov@adguard.com> Date: Mon May 17 13:54:38 2021 +0300 scripts: fix docs commit a2229052f6cf747247c8290cd0de27cc88c14977 Merge: 0852c87b 120ba967 Author: Eugene Burkov <e.burkov@adguard.com> Date: Mon May 17 13:50:45 2021 +0300 Merge branch 'master' into 2542-2462-imp-script commit 0852c87bf33b833095644e649bbcedbf89ad4f82 Author: Eugene Burkov <e.burkov@adguard.com> Date: Mon May 17 13:49:27 2021 +0300 scripts: add os-specific requirements check commit 6313d8fd19f70c41b7091511ca8d979859ddb10c Merge: 1b4092d5 a031cae4 Author: Eugene Burkov <e.burkov@adguard.com> Date: Fri May 14 19:46:57 2021 +0300 Merge branch 'master' into 2542-2462-imp-script commit 1b4092d5ee1de5b56c6252bf9debe8b90cdf954e Author: Eugene Burkov <e.burkov@adguard.com> Date: Fri May 14 19:46:09 2021 +0300 scripts: imp install.sh a little commit 0584b30b4648b88f542fff6f2879c4a7ae042af4 Merge: 22621c86 9d788a29 Author: Eugene Burkov <e.burkov@adguard.com> Date: Fri May 14 19:27:47 2021 +0300 Merge branch 'master' into 2542-2462-imp-script commit 22621c86a70e61f98850a10f0c5e450c8aeaa90f Author: Eugene Burkov <e.burkov@adguard.com> Date: Fri May 14 19:25:47 2021 +0300 all: imp code commit a38f4adc4688995ca515f8d0d8d271427365623c Author: Eugene Burkov <e.burkov@adguard.com> Date: Fri May 14 18:40:37 2021 +0300 all: fix url variable commit 238cb859184da4af025137d99216d51d3b481dc0 Author: Eugene Burkov <e.burkov@adguard.com> Date: Fri May 14 18:27:13 2021 +0300 imp code quality commit 0e36c125369d47612fd97c2841a2a688bed5841d Author: Eugene Burkov <e.burkov@adguard.com> Date: Fri May 14 16:34:49 2021 +0300 all: fix typos commit b20f0b72141f5abb5e598324a3f2bd750164e612 Author: Eugene Burkov <e.burkov@adguard.com> Date: Thu Apr 29 14:02:40 2021 +0300 all: imp installation script
2021-05-17 13:24:05 +01:00
curl -s -S -L https://raw.githubusercontent.com/AdguardTeam/AdGuardHome/master/scripts/install.sh | sh -s -- -v
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 19:01:30 +01:00
```
Pull request: improve installation script Merge in DNS/adguard-home from 2542-2462-imp-script to master Closes #2462. Updates #2542. Updates #2613. Squashed commit of the following: commit 4a7472200f2ae07aeccc3511a75a94674b655cdb Author: Eugene Burkov <e.burkov@adguard.com> Date: Mon May 17 15:11:08 2021 +0300 scripts: imp naming, docs commit acbb5864a34e81d8c80767dd7ef57dffb189dc64 Author: Eugene Burkov <e.burkov@adguard.com> Date: Mon May 17 15:05:57 2021 +0300 scripts: imp fix commit 64777015b6d50e7330fbe7546de1f436f4cb707f Author: Eugene Burkov <e.burkov@adguard.com> Date: Mon May 17 14:54:05 2021 +0300 scripts: fix bsd commit 3308921f4c253c8670c4be70896c55f7a892ff3e Author: Eugene Burkov <e.burkov@adguard.com> Date: Mon May 17 14:04:04 2021 +0300 scripts: imp requirements checking commit 453cf7a4ce676d2eb09d423304e4d5a8962ac4e5 Author: Eugene Burkov <e.burkov@adguard.com> Date: Mon May 17 13:54:38 2021 +0300 scripts: fix docs commit a2229052f6cf747247c8290cd0de27cc88c14977 Merge: 0852c87b 120ba967 Author: Eugene Burkov <e.burkov@adguard.com> Date: Mon May 17 13:50:45 2021 +0300 Merge branch 'master' into 2542-2462-imp-script commit 0852c87bf33b833095644e649bbcedbf89ad4f82 Author: Eugene Burkov <e.burkov@adguard.com> Date: Mon May 17 13:49:27 2021 +0300 scripts: add os-specific requirements check commit 6313d8fd19f70c41b7091511ca8d979859ddb10c Merge: 1b4092d5 a031cae4 Author: Eugene Burkov <e.burkov@adguard.com> Date: Fri May 14 19:46:57 2021 +0300 Merge branch 'master' into 2542-2462-imp-script commit 1b4092d5ee1de5b56c6252bf9debe8b90cdf954e Author: Eugene Burkov <e.burkov@adguard.com> Date: Fri May 14 19:46:09 2021 +0300 scripts: imp install.sh a little commit 0584b30b4648b88f542fff6f2879c4a7ae042af4 Merge: 22621c86 9d788a29 Author: Eugene Burkov <e.burkov@adguard.com> Date: Fri May 14 19:27:47 2021 +0300 Merge branch 'master' into 2542-2462-imp-script commit 22621c86a70e61f98850a10f0c5e450c8aeaa90f Author: Eugene Burkov <e.burkov@adguard.com> Date: Fri May 14 19:25:47 2021 +0300 all: imp code commit a38f4adc4688995ca515f8d0d8d271427365623c Author: Eugene Burkov <e.burkov@adguard.com> Date: Fri May 14 18:40:37 2021 +0300 all: fix url variable commit 238cb859184da4af025137d99216d51d3b481dc0 Author: Eugene Burkov <e.burkov@adguard.com> Date: Fri May 14 18:27:13 2021 +0300 imp code quality commit 0e36c125369d47612fd97c2841a2a688bed5841d Author: Eugene Burkov <e.burkov@adguard.com> Date: Fri May 14 16:34:49 2021 +0300 all: fix typos commit b20f0b72141f5abb5e598324a3f2bd750164e612 Author: Eugene Burkov <e.burkov@adguard.com> Date: Thu Apr 29 14:02:40 2021 +0300 all: imp installation script
2021-05-17 13:24:05 +01:00
The script also accepts some options:
* `-c <channel>` 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.
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 19:01:30 +01:00
### Alternative methods
#### Manual installation
Please read the **[Getting Started](https://github.com/AdguardTeam/AdGuardHome/wiki/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](https://hub.docker.com/r/adguard/adguardhome).
2018-08-30 15:25:33 +01:00
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 19:01:30 +01:00
#### 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](https://snapcraft.io/adguard-home).
2019-02-24 17:13:58 +00:00
### Guides
Pull request: all: client id support Merge in DNS/adguard-home from 1383-client-id to master Updates #1383. Squashed commit of the following: commit ebe2678bfa9bf651a2cb1e64499b38edcf19a7ad Author: Ildar Kamalov <ik@adguard.com> Date: Wed Jan 27 17:51:59 2021 +0300 - client: check if IP is valid commit 0c330585a170ea149ee75e43dfa65211e057299c Author: Ildar Kamalov <ik@adguard.com> Date: Wed Jan 27 17:07:50 2021 +0300 - client: find clients by client_id commit 71c9593ee35d996846f061e114b7867c3aa3c978 Merge: 9104f161 3e9edd9e Author: Ainar Garipov <A.Garipov@AdGuard.COM> Date: Wed Jan 27 16:09:45 2021 +0300 Merge branch 'master' into 1383-client-id commit 9104f1615d2d462606c52017df25a422df872cea Author: Ainar Garipov <A.Garipov@AdGuard.COM> Date: Wed Jan 27 13:28:50 2021 +0300 dnsforward: imp tests commit ed47f26e611ade625a2cc2c2f71a291b796bbf8f Author: Ainar Garipov <A.Garipov@AdGuard.COM> Date: Wed Jan 27 12:39:52 2021 +0300 dnsforward: fix address commit 98b222ba69a5d265f620c180c960d01c84a1fb3b Author: Ainar Garipov <A.Garipov@AdGuard.COM> Date: Tue Jan 26 19:50:31 2021 +0300 home: imp code commit 4f3966548a2d8437d0b68207dd108dd1a6cb7d20 Merge: 199fdc05 c215b820 Author: Ainar Garipov <A.Garipov@AdGuard.COM> Date: Tue Jan 26 19:45:13 2021 +0300 Merge branch 'master' into 1383-client-id commit 199fdc056f8a8be5500584f3aaee32865188aedc Author: Ainar Garipov <A.Garipov@AdGuard.COM> Date: Tue Jan 26 19:20:37 2021 +0300 all: imp tests, logging, etc commit 35ff14f4d534251aecb2ea60baba225f3eed8a3e Author: Ildar Kamalov <ik@adguard.com> Date: Tue Jan 26 18:55:19 2021 +0300 + client: remove block button from clients with client_id commit 32991a0b4c56583a02fb5e00bba95d96000bce20 Author: Ildar Kamalov <ik@adguard.com> Date: Tue Jan 26 18:54:25 2021 +0300 + client: add requests count for client_id commit 2d68df4d2eac4a296d7469923e601dad4575c1a1 Author: Ainar Garipov <A.Garipov@AdGuard.COM> Date: Tue Jan 26 15:49:50 2021 +0300 stats: handle client ids commit 4e14ab3590328f93a8cd6e9cbe1665baf74f220b Author: Ainar Garipov <A.Garipov@AdGuard.COM> Date: Tue Jan 26 13:45:25 2021 +0300 openapi: fix example commit ca9cf3f744fe197cace2c28ddc5bc68f71dad1f3 Author: Ainar Garipov <A.Garipov@AdGuard.COM> Date: Tue Jan 26 13:37:10 2021 +0300 openapi: improve clients find api docs commit f79876e550c424558b704bc316a4cd04f25db011 Author: Ainar Garipov <A.Garipov@AdGuard.COM> Date: Tue Jan 26 13:18:52 2021 +0300 home: accept ids in clients find commit 5b72595122aa0bd64debadfd753ed8a0e0840629 Merge: 607e241f abf8f65f Author: Ainar Garipov <A.Garipov@AdGuard.COM> Date: Mon Jan 25 18:34:56 2021 +0300 Merge branch 'master' into 1383-client-id commit 607e241f1c339dd6397218f70b8301e3de6a1ee0 Author: Ainar Garipov <A.Garipov@AdGuard.COM> Date: Mon Jan 25 18:30:39 2021 +0300 dnsforward: fix quic commit f046352fef93e46234c2bbe8ae316d21034260e5 Author: Ainar Garipov <A.Garipov@AdGuard.COM> Date: Mon Jan 25 16:53:09 2021 +0300 all: remove wildcard requirement commit 3b679489bae82c54177372be453fe184d8f0bab6 Author: Andrey Meshkov <am@adguard.com> Date: Mon Jan 25 16:02:28 2021 +0300 workDir now supports symlinks commit 0647ab4f113de2223f6949df001f42ecab05c995 Author: Ildar Kamalov <ik@adguard.com> Date: Mon Jan 25 14:59:46 2021 +0300 - client: remove wildcard from domain validation commit b1aec04a4ecadc9d65648ed6d284188fecce01c3 Author: Ildar Kamalov <ik@adguard.com> Date: Mon Jan 25 14:55:39 2021 +0300 + client: add form to download mobileconfig ... and 12 more commits
2021-01-27 15:32:13 +00:00
* [Getting Started](https://github.com/AdguardTeam/AdGuardHome/wiki/Getting-Started)
* [FAQ](https://github.com/AdguardTeam/AdGuardHome/wiki/FAQ)
* [How to Write Hosts Blocklists](https://github.com/AdguardTeam/AdGuardHome/wiki/Hosts-Blocklists)
* [Comparing AdGuard Home to Other Solutions](https://github.com/AdguardTeam/AdGuardHome/wiki/Comparison)
* Configuring AdGuard
* [Configuration](https://github.com/AdguardTeam/AdGuardHome/wiki/Configuration)
* [Configuring AdGuard Home Clients](https://github.com/AdguardTeam/AdGuardHome/wiki/Clients)
* [AdGuard Home as a DoH, DoT, or DoQ Server](https://github.com/AdguardTeam/AdGuardHome/wiki/Encryption)
* [AdGuard Home as a DNSCrypt Server](https://github.com/AdguardTeam/AdGuardHome/wiki/DNSCrypt)
* [AdGuard Home as a DHCP Server](https://github.com/AdguardTeam/AdGuardHome/wiki/DHCP)
* Installing AdGuard Home
* [Docker](https://github.com/AdguardTeam/AdGuardHome/wiki/Docker)
* [How to Install and Run AdGuard Home on a Raspberry Pi](https://github.com/AdguardTeam/AdGuardHome/wiki/Raspberry-Pi)
* [How to Install and Run AdGuard Home on a Virtual Private Server](https://github.com/AdguardTeam/AdGuardHome/wiki/VPS)
* [Verifying Releases](https://github.com/AdguardTeam/AdGuardHome/wiki/Verify-Releases)
2019-07-12 13:57:20 +01:00
### API
If you want to integrate with AdGuard Home, you can use our [REST API](https://github.com/AdguardTeam/AdGuardHome/tree/master/openapi).
Alternatively, you can use this [python client](https://pypi.org/project/adguardhome/), which is used to build the [AdGuard Home Hass.io Add-on](https://community.home-assistant.io/t/community-hass-io-add-on-adguard-home).
2019-06-06 14:00:35 +01:00
<a id="comparison"></a>
## Comparing AdGuard Home to other solutions
<a id="comparison-adguard-dns"></a>
### 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.**
<a id="comparison-pi-hole"></a>
### 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&nbsp;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 lighttpd |
| 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) | ✅ | ❌ |
2020-12-28 09:28:47 +00:00
| Running [without root privileges](https://github.com/AdguardTeam/AdGuardHome/wiki/Getting-Started#running-without-superuser) | ✅ | ❌ |
2019-06-06 14:00:35 +01:00
<a id="comparison-adblock"></a>
### How does AdGuard Home compare to traditional ad blockers
It depends.
2020-06-29 15:46:58 +01:00
"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](https://adguard.com/en/blog/adguard-vs-adaway-dns66/). 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).
2020-06-29 15:46:58 +01:00
**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](https://github.com/AdguardTeam/AdGuardHome/issues/1228) 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.
2019-06-06 14:00:35 +01:00
2019-02-24 15:42:44 +00:00
<a id="how-to-build"></a>
2018-09-20 16:15:52 +01:00
## How to build from source
### Prerequisites
Run `make init` to prepare the development environment.
You will need this to build AdGuard Home:
2018-09-20 16:15:52 +01:00
* [go](https://golang.org/dl/) v1.16 or later.
2020-08-03 16:39:19 +01:00
* [node.js](https://nodejs.org/en/download/) v10.16.2 or later.
2021-01-06 09:41:53 +00:00
* [npm](https://www.npmjs.com/) v6.14 or later (temporary requirement, TODO: remove when redesign is finished).
* [yarn](https://yarnpkg.com/) v1.22.5 or later.
2020-08-03 16:39:19 +01:00
### Building
2018-09-20 16:15:52 +01:00
Open Terminal and execute these commands:
2018-09-20 16:15:52 +01:00
```bash
git clone https://github.com/AdguardTeam/AdGuardHome
cd AdGuardHome
make
```
Please note, that 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`](https://github.com/AdguardTeam/AdGuardHome/blob/master/Makefile) to learn about other commands.
2019-06-06 14:00:35 +01:00
**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 `GOOS` and `GOARCH` env variables before running make.
For example:
```
Pull request: all: add a new Makefile and scripts, remove goreleaaser Merge in DNS/adguard-home from 2276-releases to master Updates #2276. Squashed commit of the following: commit 84961947c51477aae53606ec6e2e0cce0bdfc139 Author: Ainar Garipov <A.Garipov@AdGuard.COM> Date: Wed Dec 30 14:36:13 2020 +0300 all: fix github build commit 54af2adbf2f433e80393fb142e66ba6b3a78b13e Author: Ainar Garipov <A.Garipov@AdGuard.COM> Date: Wed Dec 30 14:34:02 2020 +0300 all: remove old Dockerfile, improve build scripts commit 99bb2f2ba1458d32074ac0911b5c02ce6669e43e Merge: 2292b677a 5e20ac7ed Author: Ainar Garipov <A.Garipov@AdGuard.COM> Date: Wed Dec 30 13:47:19 2020 +0300 Merge branch 'master' into WIP-2276-releases commit 2292b677a20ce8e93d9e6e2bb042cd468606fec3 Author: Ainar Garipov <A.Garipov@AdGuard.COM> Date: Wed Dec 30 13:30:10 2020 +0300 all: improve docker build commit 0bcc97c41f105ee4a4363f20fa4775c7643bf0cc Merge: c7d3f12ef aef4659e9 Author: Ainar Garipov <A.Garipov@AdGuard.COM> Date: Tue Dec 29 17:47:45 2020 +0300 Merge branch 'master' into WIP-2276-releases commit c7d3f12ef2b63ddfa2acf46e3129fcbc56fb0a90 Author: Ainar Garipov <A.Garipov@AdGuard.COM> Date: Tue Dec 29 16:28:25 2020 +0300 all: improve build scripts commit 55de1e5d7ef0fbdbd1a76cfb71362d16ca0a1966 Author: Ainar Garipov <A.Garipov@AdGuard.COM> Date: Tue Dec 29 15:36:47 2020 +0300 all: fix Makefile commit d11b1fe28d0fde1efeaf6160a614951b19d0ef94 Author: Ainar Garipov <A.Garipov@AdGuard.COM> Date: Tue Dec 29 14:16:19 2020 +0300 scripts: fix build-release commit ecc0577e2451afa86c37da7283a63a9d26fb37ba Merge: dde64ed8e 483f02c92 Author: Ainar Garipov <A.Garipov@AdGuard.COM> Date: Tue Dec 29 13:59:32 2020 +0300 Merge branch 'master' into WIP-2276-releases commit dde64ed8e456f73559f21c2ca549dc3b46724add Author: Ainar Garipov <A.Garipov@AdGuard.COM> Date: Fri Dec 25 18:04:46 2020 +0300 all: imp docs, other improvements commit be8574408db79901bb15c1d31916db3ca352a35f Author: Ainar Garipov <A.Garipov@AdGuard.COM> Date: Fri Dec 25 14:48:30 2020 +0300 all: imp docker build commit fc1876f34b93d667bf166226f4bc666d394f10c7 Merge: fa5a304c8 955b735c8 Author: Ainar Garipov <A.Garipov@AdGuard.COM> Date: Fri Dec 25 13:54:29 2020 +0300 Merge branch 'master' into WIP-2276-releases commit fa5a304c83d86145796a2de4141de6d18f7c56bf Author: Ainar Garipov <A.Garipov@AdGuard.COM> Date: Thu Dec 24 19:10:51 2020 +0300 all: improve scripts commit 3f32e3fd5e658d058d5c5172519384efc6cfef83 Author: Ainar Garipov <A.Garipov@AdGuard.COM> Date: Thu Dec 24 18:50:01 2020 +0300 all: improve scripts commit 2d38b81421acab4b90a7a19da7598c75063e8e93 Author: Ainar Garipov <A.Garipov@AdGuard.COM> Date: Thu Dec 24 18:25:21 2020 +0300 all: fix shell for windows, improve go-lint.sh commit d695285cd6dc476c0d972cfe0c49bbeea5f5a049 Merge: 313b020e9 9fb6bf82c Author: Ainar Garipov <A.Garipov@AdGuard.COM> Date: Thu Dec 24 18:14:38 2020 +0300 Merge branch 'master' into WIP-2276-releases commit 313b020e9dfcdab736670cee72b2171eac8c32b7 Author: Ainar Garipov <A.Garipov@AdGuard.COM> Date: Thu Dec 24 18:13:31 2020 +0300 Makefile: use npm ci again commit 5acee9d6a6c8cd2a7dd04b173a73929650882bad Author: Ainar Garipov <A.Garipov@AdGuard.COM> Date: Thu Dec 24 17:57:54 2020 +0300 all: try fixing windows build commit c63a2a54641ac8cd032a3306bb35e49b9ae74728 Author: Ainar Garipov <A.Garipov@AdGuard.COM> Date: Thu Dec 24 17:39:30 2020 +0300 all: imp scripts, try another goproxy and direct commit 423229e8b63ee73caeee8e84c23f67d145aff9df Author: Ainar Garipov <A.Garipov@AdGuard.COM> Date: Thu Dec 24 17:25:29 2020 +0300 all: imp HACKING.md, try a new proxy ... and 1 more commit
2020-12-30 15:26:25 +00:00
env GOOS='linux' GOARCH='arm64' make
```
Or:
```
make GOOS='linux' GOARCH='arm64'
```
#### Preparing release
You'll need this to prepare a release build:
* [snapcraft](https://snapcraft.io/)
2020-07-10 21:24:43 +01:00
Commands:
Pull request: all: add a new Makefile and scripts, remove goreleaaser Merge in DNS/adguard-home from 2276-releases to master Updates #2276. Squashed commit of the following: commit 84961947c51477aae53606ec6e2e0cce0bdfc139 Author: Ainar Garipov <A.Garipov@AdGuard.COM> Date: Wed Dec 30 14:36:13 2020 +0300 all: fix github build commit 54af2adbf2f433e80393fb142e66ba6b3a78b13e Author: Ainar Garipov <A.Garipov@AdGuard.COM> Date: Wed Dec 30 14:34:02 2020 +0300 all: remove old Dockerfile, improve build scripts commit 99bb2f2ba1458d32074ac0911b5c02ce6669e43e Merge: 2292b677a 5e20ac7ed Author: Ainar Garipov <A.Garipov@AdGuard.COM> Date: Wed Dec 30 13:47:19 2020 +0300 Merge branch 'master' into WIP-2276-releases commit 2292b677a20ce8e93d9e6e2bb042cd468606fec3 Author: Ainar Garipov <A.Garipov@AdGuard.COM> Date: Wed Dec 30 13:30:10 2020 +0300 all: improve docker build commit 0bcc97c41f105ee4a4363f20fa4775c7643bf0cc Merge: c7d3f12ef aef4659e9 Author: Ainar Garipov <A.Garipov@AdGuard.COM> Date: Tue Dec 29 17:47:45 2020 +0300 Merge branch 'master' into WIP-2276-releases commit c7d3f12ef2b63ddfa2acf46e3129fcbc56fb0a90 Author: Ainar Garipov <A.Garipov@AdGuard.COM> Date: Tue Dec 29 16:28:25 2020 +0300 all: improve build scripts commit 55de1e5d7ef0fbdbd1a76cfb71362d16ca0a1966 Author: Ainar Garipov <A.Garipov@AdGuard.COM> Date: Tue Dec 29 15:36:47 2020 +0300 all: fix Makefile commit d11b1fe28d0fde1efeaf6160a614951b19d0ef94 Author: Ainar Garipov <A.Garipov@AdGuard.COM> Date: Tue Dec 29 14:16:19 2020 +0300 scripts: fix build-release commit ecc0577e2451afa86c37da7283a63a9d26fb37ba Merge: dde64ed8e 483f02c92 Author: Ainar Garipov <A.Garipov@AdGuard.COM> Date: Tue Dec 29 13:59:32 2020 +0300 Merge branch 'master' into WIP-2276-releases commit dde64ed8e456f73559f21c2ca549dc3b46724add Author: Ainar Garipov <A.Garipov@AdGuard.COM> Date: Fri Dec 25 18:04:46 2020 +0300 all: imp docs, other improvements commit be8574408db79901bb15c1d31916db3ca352a35f Author: Ainar Garipov <A.Garipov@AdGuard.COM> Date: Fri Dec 25 14:48:30 2020 +0300 all: imp docker build commit fc1876f34b93d667bf166226f4bc666d394f10c7 Merge: fa5a304c8 955b735c8 Author: Ainar Garipov <A.Garipov@AdGuard.COM> Date: Fri Dec 25 13:54:29 2020 +0300 Merge branch 'master' into WIP-2276-releases commit fa5a304c83d86145796a2de4141de6d18f7c56bf Author: Ainar Garipov <A.Garipov@AdGuard.COM> Date: Thu Dec 24 19:10:51 2020 +0300 all: improve scripts commit 3f32e3fd5e658d058d5c5172519384efc6cfef83 Author: Ainar Garipov <A.Garipov@AdGuard.COM> Date: Thu Dec 24 18:50:01 2020 +0300 all: improve scripts commit 2d38b81421acab4b90a7a19da7598c75063e8e93 Author: Ainar Garipov <A.Garipov@AdGuard.COM> Date: Thu Dec 24 18:25:21 2020 +0300 all: fix shell for windows, improve go-lint.sh commit d695285cd6dc476c0d972cfe0c49bbeea5f5a049 Merge: 313b020e9 9fb6bf82c Author: Ainar Garipov <A.Garipov@AdGuard.COM> Date: Thu Dec 24 18:14:38 2020 +0300 Merge branch 'master' into WIP-2276-releases commit 313b020e9dfcdab736670cee72b2171eac8c32b7 Author: Ainar Garipov <A.Garipov@AdGuard.COM> Date: Thu Dec 24 18:13:31 2020 +0300 Makefile: use npm ci again commit 5acee9d6a6c8cd2a7dd04b173a73929650882bad Author: Ainar Garipov <A.Garipov@AdGuard.COM> Date: Thu Dec 24 17:57:54 2020 +0300 all: try fixing windows build commit c63a2a54641ac8cd032a3306bb35e49b9ae74728 Author: Ainar Garipov <A.Garipov@AdGuard.COM> Date: Thu Dec 24 17:39:30 2020 +0300 all: imp scripts, try another goproxy and direct commit 423229e8b63ee73caeee8e84c23f67d145aff9df Author: Ainar Garipov <A.Garipov@AdGuard.COM> Date: Thu Dec 24 17:25:29 2020 +0300 all: imp HACKING.md, try a new proxy ... and 1 more commit
2020-12-30 15:26:25 +00:00
```
make build-release CHANNEL='...' VERSION='...'
```
#### Docker image
Pull request: all: add a new Makefile and scripts, remove goreleaaser Merge in DNS/adguard-home from 2276-releases to master Updates #2276. Squashed commit of the following: commit 84961947c51477aae53606ec6e2e0cce0bdfc139 Author: Ainar Garipov <A.Garipov@AdGuard.COM> Date: Wed Dec 30 14:36:13 2020 +0300 all: fix github build commit 54af2adbf2f433e80393fb142e66ba6b3a78b13e Author: Ainar Garipov <A.Garipov@AdGuard.COM> Date: Wed Dec 30 14:34:02 2020 +0300 all: remove old Dockerfile, improve build scripts commit 99bb2f2ba1458d32074ac0911b5c02ce6669e43e Merge: 2292b677a 5e20ac7ed Author: Ainar Garipov <A.Garipov@AdGuard.COM> Date: Wed Dec 30 13:47:19 2020 +0300 Merge branch 'master' into WIP-2276-releases commit 2292b677a20ce8e93d9e6e2bb042cd468606fec3 Author: Ainar Garipov <A.Garipov@AdGuard.COM> Date: Wed Dec 30 13:30:10 2020 +0300 all: improve docker build commit 0bcc97c41f105ee4a4363f20fa4775c7643bf0cc Merge: c7d3f12ef aef4659e9 Author: Ainar Garipov <A.Garipov@AdGuard.COM> Date: Tue Dec 29 17:47:45 2020 +0300 Merge branch 'master' into WIP-2276-releases commit c7d3f12ef2b63ddfa2acf46e3129fcbc56fb0a90 Author: Ainar Garipov <A.Garipov@AdGuard.COM> Date: Tue Dec 29 16:28:25 2020 +0300 all: improve build scripts commit 55de1e5d7ef0fbdbd1a76cfb71362d16ca0a1966 Author: Ainar Garipov <A.Garipov@AdGuard.COM> Date: Tue Dec 29 15:36:47 2020 +0300 all: fix Makefile commit d11b1fe28d0fde1efeaf6160a614951b19d0ef94 Author: Ainar Garipov <A.Garipov@AdGuard.COM> Date: Tue Dec 29 14:16:19 2020 +0300 scripts: fix build-release commit ecc0577e2451afa86c37da7283a63a9d26fb37ba Merge: dde64ed8e 483f02c92 Author: Ainar Garipov <A.Garipov@AdGuard.COM> Date: Tue Dec 29 13:59:32 2020 +0300 Merge branch 'master' into WIP-2276-releases commit dde64ed8e456f73559f21c2ca549dc3b46724add Author: Ainar Garipov <A.Garipov@AdGuard.COM> Date: Fri Dec 25 18:04:46 2020 +0300 all: imp docs, other improvements commit be8574408db79901bb15c1d31916db3ca352a35f Author: Ainar Garipov <A.Garipov@AdGuard.COM> Date: Fri Dec 25 14:48:30 2020 +0300 all: imp docker build commit fc1876f34b93d667bf166226f4bc666d394f10c7 Merge: fa5a304c8 955b735c8 Author: Ainar Garipov <A.Garipov@AdGuard.COM> Date: Fri Dec 25 13:54:29 2020 +0300 Merge branch 'master' into WIP-2276-releases commit fa5a304c83d86145796a2de4141de6d18f7c56bf Author: Ainar Garipov <A.Garipov@AdGuard.COM> Date: Thu Dec 24 19:10:51 2020 +0300 all: improve scripts commit 3f32e3fd5e658d058d5c5172519384efc6cfef83 Author: Ainar Garipov <A.Garipov@AdGuard.COM> Date: Thu Dec 24 18:50:01 2020 +0300 all: improve scripts commit 2d38b81421acab4b90a7a19da7598c75063e8e93 Author: Ainar Garipov <A.Garipov@AdGuard.COM> Date: Thu Dec 24 18:25:21 2020 +0300 all: fix shell for windows, improve go-lint.sh commit d695285cd6dc476c0d972cfe0c49bbeea5f5a049 Merge: 313b020e9 9fb6bf82c Author: Ainar Garipov <A.Garipov@AdGuard.COM> Date: Thu Dec 24 18:14:38 2020 +0300 Merge branch 'master' into WIP-2276-releases commit 313b020e9dfcdab736670cee72b2171eac8c32b7 Author: Ainar Garipov <A.Garipov@AdGuard.COM> Date: Thu Dec 24 18:13:31 2020 +0300 Makefile: use npm ci again commit 5acee9d6a6c8cd2a7dd04b173a73929650882bad Author: Ainar Garipov <A.Garipov@AdGuard.COM> Date: Thu Dec 24 17:57:54 2020 +0300 all: try fixing windows build commit c63a2a54641ac8cd032a3306bb35e49b9ae74728 Author: Ainar Garipov <A.Garipov@AdGuard.COM> Date: Thu Dec 24 17:39:30 2020 +0300 all: imp scripts, try another goproxy and direct commit 423229e8b63ee73caeee8e84c23f67d145aff9df Author: Ainar Garipov <A.Garipov@AdGuard.COM> Date: Thu Dec 24 17:25:29 2020 +0300 all: imp HACKING.md, try a new proxy ... and 1 more commit
2020-12-30 15:26:25 +00:00
* Run `make build-docker` to build the Docker image locally (the one that we publish to DockerHub).
2020-07-10 12:57:53 +01:00
Please note, that we're using [Docker Buildx](https://docs.docker.com/buildx/working-with-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`
2019-06-06 14:00:35 +01:00
2019-02-24 15:42:44 +00:00
<a id="contributing"></a>
## Contributing
You are welcome to fork this repository, make your changes and submit a pull request — https://github.com/AdguardTeam/AdGuardHome/pulls
2020-08-19 16:23:05 +01:00
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.
2020-07-31 09:31:47 +01:00
2019-06-06 14:00:35 +01:00
<a id="test-unstable-versions"></a>
### 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:
1. [Snap Store](https://snapcraft.io/adguard-home) -- look for "beta" and "edge" channels there.
2. [Docker Hub](https://hub.docker.com/r/adguard/adguardhome) -- look for "beta" and "edge" tags there.
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 19:01:30 +01:00
3. Standalone builds. Use the automated installation script or look for the available builds below.
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 19:01:30 +01:00
Beta:
```
curl -sSL https://raw.githubusercontent.com/AdguardTeam/AdGuardHome/master/scripts/install.sh | sh -s beta
```
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 19:01:30 +01:00
Edge:
```
curl -sSL https://raw.githubusercontent.com/AdguardTeam/AdGuardHome/master/scripts/install.sh | sh -s edge
```
2019-06-06 14:00:35 +01:00
* Beta channel builds
* Linux: [64-bit](https://static.adguard.com/adguardhome/beta/AdGuardHome_linux_amd64.tar.gz), [32-bit](https://static.adguard.com/adguardhome/beta/AdGuardHome_linux_386.tar.gz)
* Linux ARM: [32-bit ARMv6](https://static.adguard.com/adguardhome/beta/AdGuardHome_linux_armv6.tar.gz) (recommended for Raspberry Pi), [64-bit](https://static.adguard.com/adguardhome/beta/AdGuardHome_linux_arm64.tar.gz), [32-bit ARMv5](https://static.adguard.com/adguardhome/beta/AdGuardHome_linux_armv5.tar.gz), [32-bit ARMv7](https://static.adguard.com/adguardhome/beta/AdGuardHome_linux_armv7.tar.gz)
* Linux MIPS: [32-bit MIPS](https://static.adguard.com/adguardhome/beta/AdGuardHome_linux_mips_softfloat.tar.gz), [32-bit MIPSLE](https://static.adguard.com/adguardhome/beta/AdGuardHome_linux_mipsle_softfloat.tar.gz), [64-bit MIPS](https://static.adguard.com/adguardhome/beta/AdGuardHome_linux_mips64_softfloat.tar.gz), [64-bit MIPSLE](https://static.adguard.com/adguardhome/beta/AdGuardHome_linux_mips64le_softfloat.tar.gz)
* Windows: [64-bit](https://static.adguard.com/adguardhome/beta/AdGuardHome_windows_amd64.zip), [32-bit](https://static.adguard.com/adguardhome/beta/AdGuardHome_windows_386.zip)
* MacOS: [64-bit](https://static.adguard.com/adguardhome/beta/AdGuardHome_darwin_amd64.zip), [32-bit](https://static.adguard.com/adguardhome/beta/AdGuardHome_darwin_386.zip)
* FreeBSD: [64-bit](https://static.adguard.com/adguardhome/beta/AdGuardHome_freebsd_amd64.tar.gz), [32-bit](https://static.adguard.com/adguardhome/beta/AdGuardHome_freebsd_386.tar.gz)
* FreeBSD ARM: [64-bit](https://static.adguard.com/adguardhome/beta/AdGuardHome_freebsd_arm64.tar.gz), [32-bit ARMv5](https://static.adguard.com/adguardhome/beta/AdGuardHome_freebsd_armv5.tar.gz), [32-bit ARMv6](https://static.adguard.com/adguardhome/beta/AdGuardHome_freebsd_armv6.tar.gz), [32-bit ARMv7](https://static.adguard.com/adguardhome/beta/AdGuardHome_freebsd_armv7.tar.gz)
* Edge channel builds
* Linux: [64-bit](https://static.adguard.com/adguardhome/edge/AdGuardHome_linux_amd64.tar.gz), [32-bit](https://static.adguard.com/adguardhome/edge/AdGuardHome_linux_386.tar.gz)
* Linux ARM: [32-bit ARMv6](https://static.adguard.com/adguardhome/edge/AdGuardHome_linux_armv6.tar.gz) (recommended for Raspberry Pi), [64-bit](https://static.adguard.com/adguardhome/edge/AdGuardHome_linux_arm64.tar.gz), [32-bit ARMv5](https://static.adguard.com/adguardhome/edge/AdGuardHome_linux_armv5.tar.gz), [32-bit ARMv7](https://static.adguard.com/adguardhome/edge/AdGuardHome_linux_armv7.tar.gz)
* Linux MIPS: [32-bit MIPS](https://static.adguard.com/adguardhome/edge/AdGuardHome_linux_mips_softfloat.tar.gz), [32-bit MIPSLE](https://static.adguard.com/adguardhome/edge/AdGuardHome_linux_mipsle_softfloat.tar.gz), [64-bit MIPS](https://static.adguard.com/adguardhome/edge/AdGuardHome_linux_mips64_softfloat.tar.gz), [64-bit MIPSLE](https://static.adguard.com/adguardhome/edge/AdGuardHome_linux_mips64le_softfloat.tar.gz)
* Windows: [64-bit](https://static.adguard.com/adguardhome/edge/AdGuardHome_windows_amd64.zip), [32-bit](https://static.adguard.com/adguardhome/edge/AdGuardHome_windows_386.zip)
* MacOS: [64-bit](https://static.adguard.com/adguardhome/edge/AdGuardHome_darwin_amd64.zip), [32-bit](https://static.adguard.com/adguardhome/edge/AdGuardHome_darwin_386.zip)
* FreeBSD: [64-bit](https://static.adguard.com/adguardhome/edge/AdGuardHome_freebsd_amd64.tar.gz), [32-bit](https://static.adguard.com/adguardhome/edge/AdGuardHome_freebsd_386.tar.gz)
* FreeBSD ARM: [64-bit](https://static.adguard.com/adguardhome/edge/AdGuardHome_freebsd_arm64.tar.gz), [32-bit ARMv5](https://static.adguard.com/adguardhome/edge/AdGuardHome_freebsd_armv5.tar.gz), [32-bit ARMv6](https://static.adguard.com/adguardhome/edge/AdGuardHome_freebsd_armv6.tar.gz), [32-bit ARMv7](https://static.adguard.com/adguardhome/edge/AdGuardHome_freebsd_armv7.tar.gz)
2019-06-06 14:00:35 +01:00
<a id="reporting-issues"></a>
### Report issues
If you run into any problem or have a suggestion, head to [this page](https://github.com/AdguardTeam/AdGuardHome/issues) and click on the `New issue` button.
<a id="translate"></a>
### 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
2019-08-29 09:12:34 +01:00
Here is a link to AdGuard Home project: https://crowdin.com/project/adguard-applications/en#/adguard-home
2018-11-19 16:23:57 +00:00
+ client: Add choosing filter lists Fix #1325 Squashed commit of the following: commit d8f7de72226855a961051e09b4b78f4dd71baadd Merge: f9bbe861 36f3218b Author: Andrey Meshkov <am@adguard.com> Date: Mon Jul 6 19:34:53 2020 +0300 Merge branch 'master' into feature/1325 commit f9bbe861c9dbd631b5708f8eb073270b83a3f70f Merge: 99710fef 4f8138bd Author: Andrey Meshkov <am@adguard.com> Date: Mon Jul 6 19:33:53 2020 +0300 Merge branch 'master' into feature/1325 commit 99710fef0825966b224e4a30a979e4d45f929af1 Merge: 8329326d a5380ead Author: ArtemBaskal <a.baskal@adguard.com> Date: Mon Jul 6 18:04:32 2020 +0300 Merge branch 'feature/1325' of ssh://bit.adguard.com:7999/dns/adguard-home into feature/1325 commit 8329326d6470dfcf2cdc4479e0290f7cc56ddca4 Author: ArtemBaskal <a.baskal@adguard.com> Date: Mon Jul 6 18:03:56 2020 +0300 Update locales, add title for select modal commit a5380ead56d15eba3f36c38f8fc0eedc89c2c57a Author: Andrey Meshkov <am@adguard.com> Date: Mon Jul 6 17:26:37 2020 +0300 Update readme commit dfe6e254d909ee6994cacef53d417bb073dfd802 Author: ArtemBaskal <a.baskal@adguard.com> Date: Mon Jul 6 13:44:19 2020 +0300 Change info icon width commit 06120cf3da9065fc9cc3a2864b976563d4cfe06a Author: ArtemBaskal <a.baskal@adguard.com> Date: Mon Jul 6 13:38:58 2020 +0300 Review changes commit ae3c6cacc5610a0f95bec2f6ef8a63e90041e4dd Merge: dd56a3bb 73c5d9ea Author: ArtemBaskal <a.baskal@adguard.com> Date: Mon Jul 6 12:01:57 2020 +0300 Merge branch 'master' into feature/1325 commit dd56a3bbb851687823242fa653cc3bb63dedf5e4 Author: Andrey Meshkov <am@adguard.com> Date: Fri Jul 3 15:52:01 2020 +0300 Added blocklists commit f08f0eb0cdd8cd488d3a8f1182854b72775cf06e Merge: 854d4f88 21dfb5ff Author: Andrey Meshkov <am@adguard.com> Date: Fri Jul 3 14:06:19 2020 +0300 Merge branch 'master' into feature/1325 commit 854d4f88017a33dc7f788835dc98591cec9b213f Merge: 23946266 2c47053c Author: ArtemBaskal <a.baskal@adguard.com> Date: Mon Jun 22 14:09:31 2020 +0300 Merge branch 'master' into feature/1325 commit 23946266d4913479bcecfcb7702a096983d20685 Author: ArtemBaskal <a.baskal@adguard.com> Date: Tue May 26 19:00:26 2020 +0300 Math filters by url commit 661e0482f01ffea0d0f5aa81b3b253143d0ca112 Author: ArtemBaskal <a.baskal@adguard.com> Date: Mon May 25 21:07:21 2020 +0300 Change data format commit ac4ff483b6b06ec0be49a41b5ddd3329f4ae2bbb Author: ArtemBaskal <a.baskal@adguard.com> Date: Thu May 14 19:52:45 2020 +0300 + client: Add choosing filter lists
2020-07-06 17:58:44 +01:00
<a id="help-other"></a>
### Other
Here's what you can also do to contribute:
1. [Look for issues](https://github.com/AdguardTeam/AdGuardHome/issues?q=is%3Aissue+is%3Aopen+label%3A%22help+wanted%22+) marked as "help wanted".
2. Actualize the list of *Blocked services*. It it can be found in [filtering/blocked.go](https://github.com/AdguardTeam/AdGuardHome/blob/master/internal/filtering/blocked.go).
+ client: Add choosing filter lists Fix #1325 Squashed commit of the following: commit d8f7de72226855a961051e09b4b78f4dd71baadd Merge: f9bbe861 36f3218b Author: Andrey Meshkov <am@adguard.com> Date: Mon Jul 6 19:34:53 2020 +0300 Merge branch 'master' into feature/1325 commit f9bbe861c9dbd631b5708f8eb073270b83a3f70f Merge: 99710fef 4f8138bd Author: Andrey Meshkov <am@adguard.com> Date: Mon Jul 6 19:33:53 2020 +0300 Merge branch 'master' into feature/1325 commit 99710fef0825966b224e4a30a979e4d45f929af1 Merge: 8329326d a5380ead Author: ArtemBaskal <a.baskal@adguard.com> Date: Mon Jul 6 18:04:32 2020 +0300 Merge branch 'feature/1325' of ssh://bit.adguard.com:7999/dns/adguard-home into feature/1325 commit 8329326d6470dfcf2cdc4479e0290f7cc56ddca4 Author: ArtemBaskal <a.baskal@adguard.com> Date: Mon Jul 6 18:03:56 2020 +0300 Update locales, add title for select modal commit a5380ead56d15eba3f36c38f8fc0eedc89c2c57a Author: Andrey Meshkov <am@adguard.com> Date: Mon Jul 6 17:26:37 2020 +0300 Update readme commit dfe6e254d909ee6994cacef53d417bb073dfd802 Author: ArtemBaskal <a.baskal@adguard.com> Date: Mon Jul 6 13:44:19 2020 +0300 Change info icon width commit 06120cf3da9065fc9cc3a2864b976563d4cfe06a Author: ArtemBaskal <a.baskal@adguard.com> Date: Mon Jul 6 13:38:58 2020 +0300 Review changes commit ae3c6cacc5610a0f95bec2f6ef8a63e90041e4dd Merge: dd56a3bb 73c5d9ea Author: ArtemBaskal <a.baskal@adguard.com> Date: Mon Jul 6 12:01:57 2020 +0300 Merge branch 'master' into feature/1325 commit dd56a3bbb851687823242fa653cc3bb63dedf5e4 Author: Andrey Meshkov <am@adguard.com> Date: Fri Jul 3 15:52:01 2020 +0300 Added blocklists commit f08f0eb0cdd8cd488d3a8f1182854b72775cf06e Merge: 854d4f88 21dfb5ff Author: Andrey Meshkov <am@adguard.com> Date: Fri Jul 3 14:06:19 2020 +0300 Merge branch 'master' into feature/1325 commit 854d4f88017a33dc7f788835dc98591cec9b213f Merge: 23946266 2c47053c Author: ArtemBaskal <a.baskal@adguard.com> Date: Mon Jun 22 14:09:31 2020 +0300 Merge branch 'master' into feature/1325 commit 23946266d4913479bcecfcb7702a096983d20685 Author: ArtemBaskal <a.baskal@adguard.com> Date: Tue May 26 19:00:26 2020 +0300 Math filters by url commit 661e0482f01ffea0d0f5aa81b3b253143d0ca112 Author: ArtemBaskal <a.baskal@adguard.com> Date: Mon May 25 21:07:21 2020 +0300 Change data format commit ac4ff483b6b06ec0be49a41b5ddd3329f4ae2bbb Author: ArtemBaskal <a.baskal@adguard.com> Date: Thu May 14 19:52:45 2020 +0300 + client: Add choosing filter lists
2020-07-06 17:58:44 +01:00
3. Actualize the list of known *trackers*. It it can be found in [client/src/helpers/trackers/adguard.json](https://github.com/AdguardTeam/AdGuardHome/blob/master/client/src/helpers/trackers/adguard.json).
4. Actualize the list of vetted *blocklists*. It it can be found in [client/src/helpers/filters/filters.json](https://github.com/AdguardTeam/AdGuardHome/blob/master/client/src/helpers/filters/filters.json).
<a id="uses"></a>
2020-12-21 16:34:19 +00:00
## Projects that use AdGuard Home
* [AdGuard Home Remote](https://apps.apple.com/app/apple-store/id1543143740) - iOS app by [Joost](https://rocketscience-it.nl/)
2021-02-05 23:07:33 +00:00
* [Python library](https://github.com/frenck/python-adguardhome) by [@frenck](https://github.com/frenck)
* [Home Assistant add-on](https://github.com/hassio-addons/addon-adguard-home) by [@frenck](https://github.com/frenck)
* [OpenWrt LUCI app](https://github.com/kongfl888/luci-app-adguardhome) by [@kongfl888](https://github.com/kongfl888) (originally by [@rufengsuixing](https://github.com/rufengsuixing))
* [Prometheus exporter for AdGuard Home](https://github.com/ebrianne/adguard-exporter) by [@ebrianne](https://github.com/ebrianne)
* [AdGuard Home on GLInet routers](https://forum.gl-inet.com/t/adguardhome-on-gl-routers/10664) by [Gl-Inet](https://gl-inet.com/)
2021-02-05 23:07:33 +00:00
* [Cloudron app](https://git.cloudron.io/cloudron/adguard-home-app) by [@gramakri](https://github.com/gramakri)
2019-02-24 15:42:44 +00:00
<a id="acknowledgments"></a>
## Acknowledgments
This software wouldn't have been possible without:
* [Go](https://golang.org/dl/) and it's libraries:
* [gcache](https://github.com/bluele/gcache)
* [miekg's dns](https://github.com/miekg/dns)
* [go-yaml](https://github.com/go-yaml/yaml)
* [service](https://godoc.org/github.com/kardianos/service)
2019-02-24 15:42:44 +00:00
* [dnsproxy](https://github.com/AdguardTeam/dnsproxy)
2019-06-06 14:18:12 +01:00
* [urlfilter](https://github.com/AdguardTeam/urlfilter)
* [Node.js](https://nodejs.org/) and it's libraries:
* [React.js](https://reactjs.org)
* [Tabler](https://github.com/tabler/tabler)
* And many more node.js packages.
* [whotracks.me data](https://github.com/cliqz-oss/whotracks.me)
Pull request: all: add a new Makefile and scripts, remove goreleaaser Merge in DNS/adguard-home from 2276-releases to master Updates #2276. Squashed commit of the following: commit 84961947c51477aae53606ec6e2e0cce0bdfc139 Author: Ainar Garipov <A.Garipov@AdGuard.COM> Date: Wed Dec 30 14:36:13 2020 +0300 all: fix github build commit 54af2adbf2f433e80393fb142e66ba6b3a78b13e Author: Ainar Garipov <A.Garipov@AdGuard.COM> Date: Wed Dec 30 14:34:02 2020 +0300 all: remove old Dockerfile, improve build scripts commit 99bb2f2ba1458d32074ac0911b5c02ce6669e43e Merge: 2292b677a 5e20ac7ed Author: Ainar Garipov <A.Garipov@AdGuard.COM> Date: Wed Dec 30 13:47:19 2020 +0300 Merge branch 'master' into WIP-2276-releases commit 2292b677a20ce8e93d9e6e2bb042cd468606fec3 Author: Ainar Garipov <A.Garipov@AdGuard.COM> Date: Wed Dec 30 13:30:10 2020 +0300 all: improve docker build commit 0bcc97c41f105ee4a4363f20fa4775c7643bf0cc Merge: c7d3f12ef aef4659e9 Author: Ainar Garipov <A.Garipov@AdGuard.COM> Date: Tue Dec 29 17:47:45 2020 +0300 Merge branch 'master' into WIP-2276-releases commit c7d3f12ef2b63ddfa2acf46e3129fcbc56fb0a90 Author: Ainar Garipov <A.Garipov@AdGuard.COM> Date: Tue Dec 29 16:28:25 2020 +0300 all: improve build scripts commit 55de1e5d7ef0fbdbd1a76cfb71362d16ca0a1966 Author: Ainar Garipov <A.Garipov@AdGuard.COM> Date: Tue Dec 29 15:36:47 2020 +0300 all: fix Makefile commit d11b1fe28d0fde1efeaf6160a614951b19d0ef94 Author: Ainar Garipov <A.Garipov@AdGuard.COM> Date: Tue Dec 29 14:16:19 2020 +0300 scripts: fix build-release commit ecc0577e2451afa86c37da7283a63a9d26fb37ba Merge: dde64ed8e 483f02c92 Author: Ainar Garipov <A.Garipov@AdGuard.COM> Date: Tue Dec 29 13:59:32 2020 +0300 Merge branch 'master' into WIP-2276-releases commit dde64ed8e456f73559f21c2ca549dc3b46724add Author: Ainar Garipov <A.Garipov@AdGuard.COM> Date: Fri Dec 25 18:04:46 2020 +0300 all: imp docs, other improvements commit be8574408db79901bb15c1d31916db3ca352a35f Author: Ainar Garipov <A.Garipov@AdGuard.COM> Date: Fri Dec 25 14:48:30 2020 +0300 all: imp docker build commit fc1876f34b93d667bf166226f4bc666d394f10c7 Merge: fa5a304c8 955b735c8 Author: Ainar Garipov <A.Garipov@AdGuard.COM> Date: Fri Dec 25 13:54:29 2020 +0300 Merge branch 'master' into WIP-2276-releases commit fa5a304c83d86145796a2de4141de6d18f7c56bf Author: Ainar Garipov <A.Garipov@AdGuard.COM> Date: Thu Dec 24 19:10:51 2020 +0300 all: improve scripts commit 3f32e3fd5e658d058d5c5172519384efc6cfef83 Author: Ainar Garipov <A.Garipov@AdGuard.COM> Date: Thu Dec 24 18:50:01 2020 +0300 all: improve scripts commit 2d38b81421acab4b90a7a19da7598c75063e8e93 Author: Ainar Garipov <A.Garipov@AdGuard.COM> Date: Thu Dec 24 18:25:21 2020 +0300 all: fix shell for windows, improve go-lint.sh commit d695285cd6dc476c0d972cfe0c49bbeea5f5a049 Merge: 313b020e9 9fb6bf82c Author: Ainar Garipov <A.Garipov@AdGuard.COM> Date: Thu Dec 24 18:14:38 2020 +0300 Merge branch 'master' into WIP-2276-releases commit 313b020e9dfcdab736670cee72b2171eac8c32b7 Author: Ainar Garipov <A.Garipov@AdGuard.COM> Date: Thu Dec 24 18:13:31 2020 +0300 Makefile: use npm ci again commit 5acee9d6a6c8cd2a7dd04b173a73929650882bad Author: Ainar Garipov <A.Garipov@AdGuard.COM> Date: Thu Dec 24 17:57:54 2020 +0300 all: try fixing windows build commit c63a2a54641ac8cd032a3306bb35e49b9ae74728 Author: Ainar Garipov <A.Garipov@AdGuard.COM> Date: Thu Dec 24 17:39:30 2020 +0300 all: imp scripts, try another goproxy and direct commit 423229e8b63ee73caeee8e84c23f67d145aff9df Author: Ainar Garipov <A.Garipov@AdGuard.COM> Date: Thu Dec 24 17:25:29 2020 +0300 all: imp HACKING.md, try a new proxy ... and 1 more commit
2020-12-30 15:26:25 +00:00
You might have seen that [CoreDNS](https://coredns.io) was mentioned here before — we've stopped using it in AdGuard Home. While we still use it on our servers for [AdGuard DNS](https://adguard.com/adguard-dns/overview.html) 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](https://github.com/AdguardTeam/AdGuardHome/blob/master/client/package.json) file.
<a id="privacy"></a>
## 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. Full policy with every bit that _could in theory be_ sent by AdGuard Home is available [here](https://adguard.com/en/privacy/home.html).