Mirror of adguardteam/adguardhome@github.com - DNS resolver with privacy protections
Go to file
Aleksey Dmitrevskiy 6b223e2992 * dnsfilter: extend logging 2019-03-18 14:50:33 +03:00
client Merge pull request #168 in DNS/adguard-dns from fix/625 to master 2019-03-14 11:30:21 +03:00
dhcpd + DHCP: step-by-step guide for test setup with Virtual Box 2019-03-15 14:00:32 +03:00
dnsfilter * dnsfilter: extend logging 2019-03-18 14:50:33 +03:00
dnsforward Merge branch 'master' into fix/596 2019-03-06 18:25:42 +03:00
openapi Merge branch 'master' into fix/596 2019-03-06 18:25:42 +03:00
scripts + client: added Simplified Chinese 2019-03-12 12:04:41 +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 add temporary packr output to gitignore 2019-02-15 16:28:28 +03:00
.golangci.yml ingnore Shutdown by golangci 2019-02-07 13:52:14 +03:00
.gometalinter.json Fix review comments 2019-02-11 14:22:36 +03:00
.travis.yml Merge pull request #153 in DNS/adguard-dns from fix/595 to master 2019-02-28 18:05:27 +03:00
Dockerfile Add exposed ports 2019-02-12 11:54:40 +03:00
Dockerfile.travis Add exposed ports 2019-02-12 11:54:40 +03:00
LICENSE.txt Initial commit 2018-08-30 17:25:33 +03:00
Makefile Makefile -- no need for go get -d . anymore 2019-02-07 18:24:42 +03:00
README.md Fix #595 - Start using GO 1.12 2019-02-26 15:32:56 +03:00
app.go + app, config: add symlink support, allow to specify absolute path in log_file 2019-03-15 11:49:58 +03:00
build_docker.sh Build latest from tag branch, edge from master 2019-02-11 15:10:36 +03:00
config.go * use golibs v0.1.1: file.SafeWrite() 2019-03-15 13:56:45 +03:00
control.go * control: safely restart DHCP server 2019-03-15 13:56:45 +03:00
control_test.go * tlsConfigStatus.usable is public, renamed ("ValidPair") and is exported to json ("valid_pair") 2019-02-27 17:36:02 +03:00
control_tls.go * control: use single line comment 2019-02-28 15:28:49 +03:00
dhcp.go * control: add logs 2019-03-15 14:00:32 +03:00
dns.go Merge branch 'fix/542' into fix/596 2019-02-28 11:16:03 +03:00
filter.go Fix function comments based on best practices from Effective Go 2019-03-15 14:59:05 +03:00
go.mod * dnsfilter: extend logging 2019-03-18 14:50:33 +03:00
go.sum * dnsfilter: extend logging 2019-03-18 14:50:33 +03:00
helpers.go * control: safely restart DHCP server 2019-03-15 13:56:45 +03:00
helpers_test.go * use new logger - AdguardTeam/golibs/log 2019-02-27 15:02:11 +03:00
i18n.go + client: added Simplified Chinese 2019-03-12 12:04:41 +03:00
issue_template.md Fix some UI issues, rename DNS->Home 2018-10-14 17:49:07 +03:00
release.sh Bump version to v0.93 2019-02-25 19:04:41 +03:00
service.go Fix #598 - [change] service: windows: register sercive to work under local system user 2019-03-11 19:18:18 +03:00
syslog_others.go service properties to constants 2019-02-05 14:21:07 +03:00
syslog_windows.go service properties to constants 2019-02-05 14:21:07 +03:00
upgrade.go * use golibs v0.1.1: file.SafeWrite() 2019-03-15 13:56:45 +03:00
upgrade_test.go [change] upgrade_test: rework tests 2019-03-01 11:27:15 +03:00
version.json Bump version to v0.93 2019-02-25 19:04:41 +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

How to build from source

Prerequisites

You will need:

You can either install it 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

Contributing

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

How to update 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 direct link to AdGuard Home project: http://translate.adguard.com/collaboration/project?id=153384

Before updating translations you need to install dependencies:

cd scripts/translations
npm install

Create file oneskyapp.json in scripts/translations folder.

Example of oneskyapp.json

{
    "url": "https://platform.api.onesky.io/1/projects/",
    "projectId": <PROJECT ID>,
    "apiKey": <API KEY>,
    "secretKey": <SECRET KEY>
}

Upload translations

node upload.js

Download translations

node download.js

Reporting issues

If you run into any problem or have a suggestion, head to this page and click on the New issue button.

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.