mirror of
https://github.com/AdguardTeam/AdGuardHome.git
synced 2024-11-15 18:08:30 -07:00
67 lines
2.3 KiB
Markdown
67 lines
2.3 KiB
Markdown
|
# 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](#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.
|
||
|
|
|
||
|
|
## How to build your own
|
||
|
|
|
||
|
|
### Prerequisites
|
||
|
|
|
||
|
|
You will need:
|
||
|
|
* [go](https://golang.org/dl/)
|
||
|
|
* [node.js](https://nodejs.org/en/download/)
|
||
|
|
* [yarn](https://yarnpkg.com/en/docs/install)
|
||
|
|
|
||
|
|
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
|
||
|
|
```
|
||
|
|
|
||
|
|
## How to run
|
||
|
|
|
||
|
|
DNS works on port 53, which requires superuser privileges. Therefore, you need to run it with sudo:
|
||
|
|
```bash
|
||
|
|
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:
|
||
|
|
```yaml
|
||
|
|
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](https://github.com/AdguardTeam/AdguardDNS/issues) and click on the New issue button.
|