README.md 3.46 KB
Newer Older
1 2
# Knot DNS Resolver

3
[![Build Status](https://img.shields.io/travis/CZ-NIC/knot-resolver/master.svg)](https://travis-ci.org/CZ-NIC/knot-resolver)
Marek Vavruša's avatar
Marek Vavruša committed
4 5
[![Coverage Status](https://img.shields.io/coveralls/CZ-NIC/knot-resolver.svg)](https://coveralls.io/r/CZ-NIC/knot-resolver)
[![Coverity](https://img.shields.io/coverity/scan/3912.svg)](https://scan.coverity.com/projects/3912)
Marek Vavruša's avatar
Marek Vavruša committed
6
[![Documentation Status](https://readthedocs.org/projects/knot-resolver/badge/?version=latest)](https://readthedocs.org/projects/knot-resolver/?badge=latest)
7

8

9
The Knot DNS Resolver is a caching full resolver implementation written in C and [LuaJIT][luajit], both a resolver library and a daemon. The core architecture is tiny and efficient, and provides a foundation and
10
a state-machine like API for extensions. There are three of those built-in - *iterator*, *cache*, *validator*, and most of the [rich features](https://knot-resolver.readthedocs.io/en/latest/modules.html) are written in LuaJIT, Go and C. Batteries are included, but optional. 
11

12
The LuaJIT modules, support for DNS privacy and DNSSEC, and persistent cache with low memory footprint make it a great personal DNS resolver or a research tool to tap into DNS data. TL;DR it's the [OpenResty][openresty] of DNS.
13

14
Several cache backends (LMDB, Redis and Memcached), strong filtering rules, and auto-configuration with etcd make it a great large-scale resolver solution. 
15

16
The server adopts a [different scaling strategy][scaling] than the rest of the DNS recursors - no threading, shared-nothing architecture (except MVCC cache that may be shared) that allows you to pin instances on available CPU cores and grow by self-replication. You can start and stop additional nodes depending on the contention without downtime.
17

Marek Vavrusa's avatar
Marek Vavrusa committed
18 19 20 21 22 23 24
It also has strong support for DNS over TCP, notably TCP Fast-Open, query pipelining and deduplication, and response reordering.

### Packages

Knot Resolver is packaged for Debian, Fedora, Ubuntu and [openSUSE](https://build.opensuse.org/package/show/server:dns/knot-resolver).
See [project page](https://www.knot-resolver.cz/pages/try.html) for more information.

25 26
### Building from sources

27
The Knot DNS Resolver [depends][depends] on the 2.1 version of the Knot DNS library, [LuaJIT][luajit] and [libuv][libuv].
28
See the [Building project][depends] documentation page for more information.
Marek Vavruša's avatar
Marek Vavruša committed
29 30 31 32

### Docker image

This is simple and doesn't require any dependencies or system modifications, just run:
33 34

```
35
$ docker run -it cznic/knot-resolver
36 37
```

38
See the build page [hub.docker.com/r/cznic/knot-resolver](https://hub.docker.com/r/cznic/knot-resolver/) for more information and options.
Marek Vavruša's avatar
Marek Vavruša committed
39 40

### Running
41

Marek Vavrusa's avatar
Marek Vavrusa committed
42
The project builds a resolver library in the `lib` directory, and a daemon in the `daemon` directory. It requires no configuration or parameters to run a server on localhost.
43 44

```
Marek Vavrusa's avatar
Marek Vavrusa committed
45
$ kresd
46
```
Marek Vavruša's avatar
Marek Vavruša committed
47

48
See the documentation at [knot-resolver.readthedocs.io][doc] for more options.
Marek Vavruša's avatar
Marek Vavruša committed
49

50 51 52
[depends]: https://knot-resolver.readthedocs.io/en/latest/build.html
[doc]: https://knot-resolver.readthedocs.io/en/latest/index.html
[scaling]: https://knot-resolver.readthedocs.io/en/latest/daemon.html#scaling-out
Marek Vavruša's avatar
Marek Vavruša committed
53
[deckard]: https://gitlab.labs.nic.cz/knot/deckard
54 55 56
[luajit]: http://luajit.org/
[libuv]: https://github.com/libuv/libuv
[openresty]: https://openresty.org/
The Gitter Badger's avatar
The Gitter Badger committed
57 58 59 60

### Contacting us

[![Join the chat at https://gitter.im/CZ-NIC/knot-resolver](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/CZ-NIC/knot-resolver?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)