README 3.26 KB
Newer Older
1 2
Dependencies
============
3

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
11 12

Optional packages:
13
* libcap-ng >= 0.6.4 (for POSIX 1003.1e capabilites(7))
14
* libidn             (for IDNA2003 support in Knot utilities)
15 16 17

Dependencies for building documentation:
* texinfo
18

Jan Mercl's avatar
Jan Mercl committed
19 20
Installation
============
21

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

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

Daniel Salzman's avatar
Daniel Salzman committed
29
1) Install prerequisites
Jan Mercl's avatar
Jan Mercl committed
30

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

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

Daniel Salzman's avatar
Daniel Salzman committed
40 41
Install optional packages:
($ sudo apt-get install libcap-ng-dev)
42

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

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

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

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

Daniel Salzman's avatar
Daniel Salzman committed
57 58
Install optional packages:
($ yum install libcap-ng-devel)
59

Daniel Salzman's avatar
Daniel Salzman committed
60 61
OS X
----
62 63 64 65 66
Not all prerequisites are preinstalled for OS X.
- liburcu must be compiled from sources
  - liburcu requires gcc-4.6 from MacPorts, as it depends on __thread keyword
  $ CC=gcc-mp-4.6 ARCH=x86_64 ./configure
  $ make && sudo make install
67 68
- liburcu >= 0.7.0 works with supplied compiler, however ARCH must still be set
  - alternative is to set it with configure parameter --target
69

Jan Včelák's avatar
Jan Včelák committed
70
Compiling Knot DNS with gcc-mp-4.6 is recommended, but not necessary.
71

Daniel Salzman's avatar
Daniel Salzman committed
72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92
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

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

95 96 97
Running
=======

Daniel Salzman's avatar
Daniel Salzman committed
98 99
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
100
Configuration file has to specify:
Daniel Salzman's avatar
Daniel Salzman committed
101 102 103
- storage for PID files, journal files etc.
- network interfaces
- served zones
Marek Vavrusa's avatar
Marek Vavrusa committed
104

Daniel Salzman's avatar
Daniel Salzman committed
105 106 107 108 109
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
110

Daniel Salzman's avatar
Daniel Salzman committed
111 112
2) Prepare working directory
$ mv example.com.zone /var/lib/knot/
113

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

Daniel Salzman's avatar
Daniel Salzman committed
118
Start Knot in foreground to see if it runs:
Daniel Salzman's avatar
Daniel Salzman committed
119
$ knotd -c myserver.conf
Jan Kadlec's avatar
Jan Kadlec committed
120

Daniel Salzman's avatar
Daniel Salzman committed
121 122 123
For more information, refer to the user manual or:
$ knotc -h
$ knotd -h
124