README.md 2.81 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

Marek Vavruša's avatar
Marek Vavruša committed
9 10 11 12 13 14 15
The Knot DNS Resolver is a caching full resolver implementation written in C and [LuaJIT][luajit], including both a resolver
library and a daemon. Modular architecture of the library keeps the core tiny and efficient, and provides
a state-machine like API for extensions. There are three built-in modules - *iterator*, *cache*, *validator*, and many external.

The Lua modules, switchable and shareable cache, and fast FFI bindings makes it great to tap into resolution process, or be used for your recursive DNS service. It's the [OpenResty][openresty] of DNS.

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). You can start and stop additional nodes depending on the contention without downtime.
16

Marek Vavruša's avatar
Marek Vavruša committed
17
### Try it out?
18

Marek Vavruša's avatar
Marek Vavruša committed
19
Keep in mind that the Knot DNS Resolver is in beta. While it's being tested by the [DNS test harness][deckard], we'll be super glad to hear out your feedback!
Marek Vavruša's avatar
Marek Vavruša committed
20 21 22 23 24

### Building from sources

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

### Docker image

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

```
Marek Vavruša's avatar
Marek Vavruša committed
31
$ docker run cznic/knot-resolver
32 33
```

Marek Vavruša's avatar
Marek Vavruša committed
34
See the build page [registry.hub.docker.com/u/cznic/knot-resolver](https://registry.hub.docker.com/u/cznic/knot-resolver) for more information and options.
Marek Vavruša's avatar
Marek Vavruša committed
35 36

### Running
37

38
The project builds a resolver library in the `lib` directory, and a daemon in the `daemon` directory.
39 40

```
Marek Vavruša's avatar
Marek Vavruša committed
41
$ kresd -h
42
```
Marek Vavruša's avatar
Marek Vavruša committed
43 44 45 46

See the documentation at [knot-resolver.readthedocs.org][doc].

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

### 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)