8d23e29190
* Link directly to binary downloads * Move "how to run" section right after binaries. * Add "How does AdGuard DNS work" and "How is this different from public AdGuard DNS servers" sections. * Update phrasing to emphasize that it's "your AdGuard DNS" server. * Remove yarn from `brew install` line. * Mention terminal for bash commands. * Add 32-bit ARM and 32-bit Intel binary links. |
||
---|---|---|
client | ||
coredns_plugin | ||
dnsfilter | ||
packaging | ||
tests | ||
.gitignore | ||
.travis.yml | ||
LICENSE.txt | ||
Makefile | ||
README.md | ||
app.go | ||
config.go | ||
control.go | ||
helpers.go | ||
issue_template.md | ||
openapi.yaml | ||
stats.go |
README.md
Self-hosted AdGuard DNS
AdGuard DNS is an ad-filtering DNS server with built-in phishing protection and optional family-friendly protection.
How does AdGuard DNS work?
If you configure your network to use this DNS server, every time a website sends an ad or phishing request, the server sends back a null response. AdGuard has a database of domain names that serve for ad, tracking or phishing purposes, and this database is regularly updated.
How is this different from public AdGuard DNS servers?
Running your own AdGuard DNS offers you more options:
- Enable/disable blocking of ads on the fly.
- Enable/disable blocking of phishing and malware websites on the fly.
- Enable/disable blocking of adult websites on the fly.
- Enable/disable enforcing of family friendly search results in search engines like Google, Yandex and Bing.
- See which DNS requests are being made by which computer in your network by using query log.
- Add your own filtering rules on the fly.
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 our public AdGuard DNS servers -- they are running same code from this repository and provide same functionality — https://adguard.com/en/adguard-dns/overview.html
Installation
Mac
Download file AdguardDNS_0.1_MacOS.zip, then unpack it and follow how to run instructions below.
Linux 64-bit Intel
Download file AdguardDNS_0.1_linux_amd64.tar.gz, then unpack it and follow how to run instructions below.
Linux 32-bit Intel
Download file AdguardDNS_0.1_linux_386.tar.gz, then unpack it and follow how to run instructions below.
Raspberry Pi (32-bit ARM)
Download file AdguardDNS_0.1_linux_arm.tar.gz, then unpack it and follow how to run instructions below.
How to run
DNS works on port 53, which requires superuser privileges. Therefore, you need to run it with sudo in terminal:
sudo ./AdguardDNS
Now open the browser and point it to http://localhost:3000/ to control your 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.
Additional configuration
Open first execution, a file AdguardDNS.yaml
will be created, with default values written in it. You can modify the file while your AdGuard DNS is not running, otherwise any changes to the file will be lost because they will be overwritten by the program.
Explanation of settings:
bind_host
-- Web interface IP address to listen onbind_port
-- Web interface IP port to listen onauth_name
-- Web interface optional authorization usernameauth_pass
-- Web interface optional authorization passwordcoredns
-- CoreDNS configuration sectionport
-- DNS server port to listen onfiltering_enabled
-- Filtering of DNS requests based on filter listssafebrowsing_enabled
-- Filtering of DNS requests based on safebrowsingsafesearch_enabled
-- Enforcing safe search when accessing search enginesparental_enabled
-- Filtering of DNS requests based on parental safetyparental_sensitivity
-- Age group for filtering based on parental safetyquerylog_enabled
-- Query logging, also used to calculate top 50 clients, blocked domains and requested domains for statsupstream_dns
-- List of upstream DNS servers
filters
-- List of filters, each filter has these values:url
-- URL pointing to the filter contentsenabled
-- Enable/disable current filter
user_rules
-- User-defined filtering rules
Removing an entry from settings file will reset it to default value. Deleting the file will reset all settings to default values.
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
Building
Open Terminal and execute these commands:
git clone https://github.com/AdguardTeam/AdguardDNS
cd AdguardDNS
make
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.