mirrors
/
AdGuardHome
mirror of https://github.com/AdguardTeam/AdGuardHome.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Update readme. 

* 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.
This commit is contained in:
Eugene Bujak 2018-09-20 15:03:34 +03:00
parent a185161ad4
commit 8d23e29190
1 changed files with 46 additions and 28 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

74
README.md
View File

@ -4,49 +4,46 @@
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 AdGuard DNS servers that provide same functionality — https://adguard.com/en/adguard-dns/overview.html
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
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](#How-to-run) instructions below.
Download file [AdguardDNS_0.1_MacOS.zip](https://github.com/AdguardTeam/AdguardDNS/releases/download/v0.1/AdguardDNS_0.1_MacOS.zip), then unpack it and follow [how to run](#how-to-run) instructions below.
### Linux
Download file `AdguardDNS_*_linux_amd64.tar.gz`, then unpack it and follow [how to run](#How-to-run) instructions below.
### Linux 64-bit Intel
Download file [AdguardDNS_0.1_linux_amd64.tar.gz](https://github.com/AdguardTeam/AdguardDNS/releases/download/v0.1/AdguardDNS_0.1_linux_amd64.tar.gz), then unpack it and follow [how to run](#how-to-run) instructions below.
## How to build your own
### Linux 32-bit Intel
Download file [AdguardDNS_0.1_linux_386.tar.gz](https://github.com/AdguardTeam/AdguardDNS/releases/download/v0.1/AdguardDNS_0.1_linux_386.tar.gz), then unpack it and follow [how to run](#how-to-run) instructions below.
### Prerequisites
You will need:
* [go](https://golang.org/dl/)
* [node.js](https://nodejs.org/en/download/)
You can either install it from these websites or use [brew.sh](https://brew.sh/) if you're on Mac:
```bash
brew install go node yarn
```
### Building
Open Terminal and execute these commands:
```bash
git clone https://github.com/AdguardTeam/AdguardDNS
cd AdguardDNS
make
```
### Raspberry Pi (32-bit ARM)
Download file [AdguardDNS_0.1_linux_arm.tar.gz](https://github.com/AdguardTeam/AdguardDNS/releases/download/v0.1/AdguardDNS_0.1_linux_arm.tar.gz), then unpack it and follow [how to run](#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:
DNS works on port 53, which requires superuser privileges. Therefore, you need to run it with sudo in terminal:
```bash
sudo ./AdguardDNS
```
Now open the browser and point it to http://localhost:3000/ to control AdGuard DNS server.
Now open the browser and point it to http://localhost:3000/ to control your AdGuard DNS server.
### Running without superuser
@ -60,7 +57,7 @@ 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 AdGuard DNS is not running, otherwise any changes to the file will be lost because they will be overwritten by the server.
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:
@ -84,6 +81,27 @@ Explanation of settings:
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:
* [go](https://golang.org/dl/)
* [node.js](https://nodejs.org/en/download/)
You can either install it from these websites or use [brew.sh](https://brew.sh/) if you're on Mac:
```bash
brew install go node
```
### Building
Open Terminal and execute these commands:
```bash
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