cotugno/AdGuardHome
2
Fork 0
mirror of https://github.com/AdguardTeam/AdGuardHome.git synced 2024-11-16 02:18:28 -07:00
Code Issues Packages Projects Releases Wiki Activity
Network-wide ads & trackers blocking DNS server
44 Commits 94 Branches 201 Tags 67 MiB
Go 60.2%
TypeScript 24.9%
CSS 12.4%
Shell 2%
Makefile 0.2%
Other 0.2%
3189341089
Go to file
Eugene Bujak 3189341089 web interface -- Make refresh buttons reload all data, not just counters
2018-09-07 18:05:10 +03:00
client web interface -- Make refresh buttons reload all data, not just counters 2018-09-07 18:05:10 +03:00
coredns_plugin coredns plugin metrics -- deduplicate code 2018-09-07 16:10:11 +03:00
dnsfilter dnsfilter -- small code cleanup 2018-09-07 16:10:43 +03:00
packaging Initial commit 2018-08-30 17:25:33 +03:00
tests Initial commit 2018-08-30 17:25:33 +03:00
.gitignore Initial commit 2018-08-30 17:25:33 +03:00
.travis.yml travis -- npm installation of dependencies belongs in install section 2018-09-07 16:14:43 +03:00
app.go Start coredns on launch before we serve HTTP -- this checks if port is available 2018-09-06 02:00:57 +03:00
config.go Be more atomic during writing of files -- this prevents other processes from seeing empty or impartial files 2018-09-06 02:03:03 +03:00
control.go Fixup of previous commit -- errand keystroke crept in 2018-09-07 17:59:24 +03:00
helpers.go API /stats_top -- show only top entries for last 3 minutes 2018-09-07 17:49:33 +03:00
issue_template.md Initial commit 2018-08-30 17:25:33 +03:00
LICENSE.txt Initial commit 2018-08-30 17:25:33 +03:00
Makefile makefile -- use npm --prefix syntax instead of doing cd into subdir 2018-09-07 16:14:25 +03:00
openapi.yaml Initial commit 2018-08-30 17:25:33 +03:00
README.md Readme -- remove yarn from prerequisites since it's no longer needed 2018-08-31 18:13:45 +03:00
stats.go Rewrite how historical stats are stored and calculated. 2018-09-06 02:11:36 +03:00

README.md

Build Status

Self-hosted AdGuard DNS

AdGuard DNS is an ad-filtering DNS server with built-in phishing protection and optional family-friendly protection.

This repository describes how to set up and run your self-hosted instance of AdGuard DNS -- it comes with a web dashboard that can be accessed from browser to control the DNS server and change its settings, it also allows you to add your filters in both AdGuard and hosts format.

If this seems too complicated, you can always use AdGuard DNS servers that provide same functionality — https://adguard.com/en/adguard-dns/overview.html

Installation

Go to https://github.com/AdguardTeam/AdguardDNS/releases and download the binaries for your platform:

Mac

Download file AdguardDNS_*_darwin_amd64.tar.gz, then unpack it and follow how to run instructions below.

Linux

Download file AdguardDNS_*_linux_amd64.tar.gz, then unpack it and follow how to run instructions below.

How to build your own

Prerequisites

You will need:

You can either install it from these websites or use brew.sh if you're on Mac:

brew install go node yarn

Building

Open Terminal and execute these commands:

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

How to run

DNS works on port 53, which requires superuser privileges. Therefore, you need to run it with sudo:

sudo ./AdguardDNS

Now open the browser and point it to http://localhost:3000/ to control AdGuard DNS server.

Running without superuser

You can run it without superuser privileges, but you need to instruct it to use other port rather than 53. You can do that by opening AdguardDNS.yaml and adding this line:

coredns:
  port: 53535

If the file does not exist, create it and put these two lines down.

Contributing

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

Reporting issues

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