A simple, go-based DNS resolver/caching server
Go to file
kenshinx dc60b4c9a2 Supplement test case, www.google.com should match /google.com/ 2018-02-01 18:39:40 +08:00
etc Merge https://github.com/bigeagle/godns into domain-specs-name-server 2018-02-01 15:39:47 +08:00
.gitignore add IPv6 support 2015-02-03 20:33:54 +08:00
LICENSE godns under the MIT license 2015-05-25 17:18:57 +08:00
README.md Update documents 2017-05-18 18:28:23 +08:00
cache.go Use pack and unpack from dns library. 2016-02-13 15:25:19 +05:30
godns_test.go CodeReviewComments#imports 2015-02-10 17:04:57 +08:00
handler.go Merge https://github.com/bigeagle/godns into domain-specs-name-server 2018-02-01 15:39:47 +08:00
hosts.go Extract public functions into utils 2018-02-01 17:09:02 +08:00
log.go Log Module 2015-10-13 18:44:42 +08:00
log_test.go Log Module 2015-10-13 18:44:42 +08:00
main.go CPU & MEM pprof output #12 2015-10-14 15:21:21 +08:00
resolver.go more pretty logging and ensure query the specific upstream nameserver in async Lookup() function. 2018-02-01 18:30:41 +08:00
server.go use net.JoinHostPort() 2017-02-07 06:07:58 +01:00
settings.go Merge https://github.com/bigeagle/godns into domain-specs-name-server 2018-02-01 15:39:47 +08:00
sfx_tree.go dnsmasq style domain specific server supported 2015-02-03 22:53:57 +08:00
sfx_tree_test.go Supplement test case, www.google.com should match /google.com/ 2018-02-01 18:39:40 +08:00
utils.go Extract public functions into utils 2018-02-01 17:09:02 +08:00
utils_test.go Extract public functions into utils 2018-02-01 17:09:02 +08:00

README.md

GODNS

A simple and fast dns cache server written by go.

Similar to dnsmasq, but supports some difference features:

  • Keep hosts records in redis and the local file /etc/hosts

  • Auto-Reloads when hosts configuration is changed. (Yes, dnsmasq needs to be reloaded)

Installation & Running

  1. Install

     $ go get github.com/kenshinx/godns
    
  2. Build

     $ cd $GOPATH/src/github.com/kenshinx/godns 
     $ go build -o godns 
    
  3. Running

     $ sudo ./godns -c godns.conf
    
  4. Test

     $ dig www.github.com @127.0.0.1
    

More details about how to install and running godns can reference my blog (Chinese)

Use godns

	$ sudo vi /etc/resolv.conf
	nameserver #the ip of godns running

Configuration

All the configuration in godns.conf is a TOML format config file.
More about Toml :https://github.com/mojombo/toml

resolv.conf

Upstream server can be configured by changing file from somewhere other than "/etc/resolv.conf"

[resolv]
resolv-file = "/etc/resolv.conf"

If multiple namerservers are set in resolv.conf, the upsteam server will try in a top to bottom order

cache

Only the local memory storage backend is currently implemented. The redis backend is in the todo list

[cache]
backend = "memory"   
expire = 600  # default expire time 10 minutes
maxcount = 100000

hosts

Force resolve domain to assigned ip, support two types hosts configuration:

  • locale hosts file
  • remote redis hosts

hosts file

can be assigned at godns.conf,default : /etc/hosts

[hosts]
host-file = "/etc/hosts"

Hosts file format is described in linux man pages. More than that , *. wildcard is supported additional.

redis hosts

This is a special requirment in our system. Must maintain a global hosts configuration, and support update the host records from other remote server. Therefore, while "redis-hosts" be enabled, will query the redis db when each dns request is reached.

The hosts record is organized with redis hash map. and the key of the map is configured.

[hosts]
redis-key = "godns:hosts"

Insert hosts records into redis

redis > hset godns:hosts www.test.com 1.1.1.1

Compared with file-backend records, redis-backend hosts support multiple A entries.

redis > hset godns:hosts www.test.com 1.1.1.1,2.2.2.2

Benchmark

Debug close

$ go test -bench=.

testing: warning: no tests to run
PASS
BenchmarkDig-8     50000             57945 ns/op
ok      _/usr/home/keqiang/godns        3.259s

The result : 15342 queries/per second

The test environment:

CentOS release 6.4

  • CPU:
    Intel Xeon 2.40GHZ 4 cores

  • MEM:
    46G

Web console

Joke: A web console for godns

https://github.com/kenshinx/joke

screenshot

joke

Deployment

Deployment in productive supervisord highly recommended.


[program:godns]
command=/usr/local/bin/godns -c /etc/godns.conf
autostart=true
autorestart=true
user=root
stdout_logfile_maxbytes = 50MB
stdoiut_logfile_backups = 20
stdout_logfile = /var/log/godns.log

TODO

  • The redis cache backend
  • Update ttl

LICENSE

godns is under the MIT license. See the LICENSE file for details.