README 3 KB
Newer Older
Marek Vavrusa's avatar
Marek Vavrusa committed
1 2
Dependencies
============
3

Marek Vavrusa's avatar
Marek Vavrusa committed
4 5 6 7 8
Knot DNS has several dependencies:
* libtool
* autoconf > 2.65
* flex >= 2.5.31
* bison >= 2.3
9
* libssl >= 1.0.0    (>= 1.0.1 is required for ECDSA)
10
* liburcu >= 0.5.4
Marek Vavrusa's avatar
Marek Vavrusa committed
11 12

Optional packages:
13
* libcap-ng >= 0.6.4 (for POSIX 1003.1e capabilites(7))
Daniel Salzman's avatar
Daniel Salzman committed
14
* libidn             (for IDNA2003 support in Knot utilities)
15
* lmdb               (for persistent events for slave zones)
16
* libsystemd         (for systemd init system support)
17 18

Dependencies for building documentation:
19
* python-sphinx
Marek Vavrusa's avatar
Marek Vavrusa committed
20

Jan Mercl's avatar
Jan Mercl committed
21 22
Installation
============
23

Daniel Salzman's avatar
Daniel Salzman committed
24
Knot DNS may already be included in your operating system distribution and
25 26 27
therefore can be installed from packages (Linux), ports (BSD) or via
Homebrew (Mac). This is always preferred unless you want to test the latest
features, contribute to Knot development, or you just know what you are doing.
28 29 30

Following sections describe how to build Knot DNS from the source code.

Daniel Salzman's avatar
Daniel Salzman committed
31
1) Install prerequisites
Jan Mercl's avatar
Jan Mercl committed
32

Daniel Salzman's avatar
Daniel Salzman committed
33 34 35
Debian based distributions
--------------------------
Update the system:
Jan Mercl's avatar
Jan Mercl committed
36 37
$ sudo apt-get update
$ sudo apt-get upgrade
38

Daniel Salzman's avatar
Daniel Salzman committed
39 40
Install prerequisites:
$ sudo apt-get install git-core libtool autoconf flex bison libssl-dev liburcu-dev
41

Daniel Salzman's avatar
Daniel Salzman committed
42
Install optional packages:
43
($ sudo apt-get install libcap-ng-dev liblmdb-dev libsystemd-dev)
44

Daniel Salzman's avatar
Daniel Salzman committed
45 46
If the liburcu-dev package is not present, install it from the source code
(http://lttng.org/urcu)
47

Daniel Salzman's avatar
Daniel Salzman committed
48 49
Fedora like distributions
-------------------------
50
Update the system:
Daniel Salzman's avatar
Daniel Salzman committed
51
$ yum upgrade
52 53

Ensure all base development tools are available:
Daniel Salzman's avatar
Daniel Salzman committed
54
$ yum install @buildsys-build
55 56

Ensure all prerequisites are installed:
Daniel Salzman's avatar
Daniel Salzman committed
57
$ yum install libtool autoconf flex bison openssl-devel userspace-rcu-devel
58

Daniel Salzman's avatar
Daniel Salzman committed
59
Install optional packages:
60
($ yum install libcap-ng-devel lmdb-devel systemd-devel)
61

Daniel Salzman's avatar
Daniel Salzman committed
62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82
2) Install Knot DNS

Knot DNS requires compiler to support atomic intrinsics.
GCC version at least 4.1 supports legacy atomic builtins, however 4.7
or newer is preferred.
Clang supports atomics since version 2.9.

Get the source code:
$ git clone git://git.nic.cz/knot-dns.git
Or extract source package to knot-dns directory

Compile Knot
$ cd knot-dns
$ autoreconf -if
$ ./configure
$ make

Install Knot DNS into system:
$ sudo make install
$ sudo ldconfig

83
NOTE: If you want to reduce zscanner compile time, use configure option --disable-fastparser.
84

85 86 87
Running
=======

Daniel Salzman's avatar
Daniel Salzman committed
88 89
1) Each server needs configuration file. Please see samples/knot.sample.conf
for reference or samples/knot.full.conf for more examples.
Jan Kadlec's avatar
Jan Kadlec committed
90
Configuration file has to specify:
Daniel Salzman's avatar
Daniel Salzman committed
91 92 93
- storage for PID files, journal files etc.
- network interfaces
- served zones
Marek Vavrusa's avatar
Marek Vavrusa committed
94

Daniel Salzman's avatar
Daniel Salzman committed
95 96 97 98 99
E.g. use the default config file:
$ cd /etc/knot
$ mv knot.sample.conf knot.conf
Modify the config:
$ vim knot.conf
Marek Vavrusa's avatar
Marek Vavrusa committed
100

Daniel Salzman's avatar
Daniel Salzman committed
101 102
2) Prepare working directory
$ mv example.com.zone /var/lib/knot/
103

Daniel Salzman's avatar
Daniel Salzman committed
104
3) Start the server. This can be done by running the 'knotd' command.
Daniel Salzman's avatar
Daniel Salzman committed
105 106
Alternatively, your distribution should have an init script available, if you've
installed Knot using a binary package.
107

108
Start Knot in the foreground to see if it runs:
Daniel Salzman's avatar
Daniel Salzman committed
109
$ knotd -c myserver.conf
Jan Kadlec's avatar
Jan Kadlec committed
110

Daniel Salzman's avatar
Daniel Salzman committed
111 112 113
For more information, refer to the user manual or:
$ knotc -h
$ knotd -h