frenck / adguardhome Goto Github PK

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
• How to build from source
• Contributing
• Reporting issues
• Acknowledgments

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.

• Configuration
• AdGuard Home as a DNS-over-HTTPS or DNS-over-TLS server
• How to install and run AdGuard Home on Raspberry Pi
• How to install and run AdGuard Home on a Virtual Private Server

You will need:

• go v1.12 or later.
• node.js v10 or later.

You can either install it via the provided links or use brew.sh if you're on Mac:

brew install go node

Open Terminal and execute these commands:

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

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

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>
}

node upload.js

node download.js

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

This software wouldn't have been possible without:

• Go and it's libraries:
  • packr
  • gcache
  • miekg's dns
  • go-yaml
  • service
  • dnsproxy
• 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.