README.md 1.74 KB
Newer Older
Jan Včelák's avatar
Jan Včelák committed
1 2
# Knot DNS Resolver

Marek Vavruša's avatar
Marek Vavruša committed
3 4 5
[![Build Status](https://img.shields.io/travis/CZ-NIC/knot-resolver.svg)](https://travis-ci.org/CZ-NIC/knot-resolver)
[![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)
6

7

Marek Vavruša's avatar
Marek Vavruša committed
8 9
The Knot DNS Resolver is a minimalistic caching resolver implementation. The project provides both a resolver
library and a small daemon. Modular architecture of the library keeps the core tiny and efficient, and provides
10 11
a state-machine like API for extensions. There are two built-in modules: *iterator* and *cache*,
and each module can be flipped on and off.
12

Marek Vavruša's avatar
Marek Vavruša committed
13
### Try it out?
14

Marek Vavruša's avatar
Marek Vavruša committed
15 16 17 18 19
The Knot DNS Resolver is currently in an early development phase, you shouldn't put it in the production right away.

### Docker image

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

```
Marek Vavruša's avatar
Marek Vavruša committed
22
$ docker run cznic/knot-resolver
23 24
```

Marek Vavruša's avatar
Marek Vavruša committed
25
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
26 27 28

### Building from sources 

29 30
The Knot DNS Resolver [depends][depends] on the pre-release version of the Knot DNS library and other projects.
See the [Building project][depends] documentation page for more information.
31

Marek Vavruša's avatar
Marek Vavruša committed
32
### Running
33

34
The project builds a resolver library in the `lib` directory, and a daemon in the `daemon` directory.
35 36 37

```
$ ./daemon/kresolved -h
38
$ ./daemon/kresolved [working_directory]
39
```
Marek Vavruša's avatar
Marek Vavruša committed
40 41 42 43 44

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

[depends]: http://knot-resolver.readthedocs.org/en/latest/build.html
[doc]: http://knot-resolver.readthedocs.org/en/latest/index.html