Skip to content

Commit

Permalink
simpler README
Browse files Browse the repository at this point in the history
  • Loading branch information
pforemski committed Sep 19, 2016
1 parent 06c618e commit 0f5a041
Showing 1 changed file with 12 additions and 10 deletions.
22 changes: 12 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,18 +1,20 @@
# dingo

A caching DNS proxy for the [Google DNS-over-HTTPS](https://developers.google.com/speed/public-dns/docs/dns-over-https).
A DNS client in Go that supports the [Google DNS-over-HTTPS](https://developers.google.com/speed/public-dns/docs/dns-over-https).
It effectively encrypts all your DNS traffic.

For now, it resolves DNS queries over HTTPS/1.1, in a few independent threads (configurable).
Future plans include HTTP/2.0 and QUIC support, better caching, and support for other resolvers.
The ultimate goal for the project is to provide a secure, caching DNS proxy that communicates with recursive DNS resolvers over encrypted channels only. For now, it resolves DNS queries over HTTPS/1.1, in a few independent threads. The plans for future plans include HTTP/2.0 and QUIC support, better caching, and other resolvers (e.g. [OpenResolve](https://www.openresolve.com/) by OpenDNS).

You can start it as root using:
```
root@localhost:~# go run ./dingo.go ./gdns.go -port=53
```
# How to use it?

Remember to prepare your Go environment and download all dependencies first.
Download a pre-built binary for your platform from [the latest release](https://github.com/pforemski/dingo/releases/latest) (or build your own).

Alternatively, use pre-built binaries in the `./release` sub-directory.
Run dingo as root on port 53. For example, on Linux:
```
$ sudo ./dingo-linux-amd64 -port=53
```

Note that you will need to update your `/etc/resolv.conf` file to use `dingo` as your system-wide resolver.
Update your DNS configuration. On Linux, update your `/etc/resolv.conf` file as root (remember to make backup first):
```
$ sudo sh -c "echo nameserver 127.0.0.1 > /etc/resolv.conf"
```

0 comments on commit 0f5a041

Please sign in to comment.