README.md 1.89 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
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
11 12
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.
13

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

Marek Vavruša's avatar
Marek Vavruša committed
16 17 18 19 20
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:
21 22

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

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

### Building from sources 

30 31
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.
32

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

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

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

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

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