blob: 4d0704c984e29f94d0ebae3fddcc8d6bc2751cf0 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
|
/*!
\defgroup server Server control module.
\defgroup threading Threading API.
\defgroup network Socket API.
\defgroup query_processing DNS query processing.
\defgroup utils Utilities, constants and macros.
\defgroup debugging Server debugging API.
\defgroup logging Server logging API.
\defgroup statistics Statistics module (optional).
\defgroup dnslib dnslib - Generic DNS library.
\defgroup hashing Hash table and functions.
\defgroup common_lib Common library.
\defgroup alloc Memory allocation.
\defgroup tests Unit tests.
\defgroup zoneparser Zone compiler utility
\defgroup ctl Control utility
\mainpage Knot API documentation.
Knot is an open-source, high-performace, purely authoritative DNS server.
<h2>Requirements</h2>
- liburcu (at least 0.4.5): http://lttng.org/urcu
- automake
- autoconf
- libtool
<h2>Installation</h2>
Knot uses autotools to generate makefiles.
\todo Add some more info about usage and requirements.
\code
$ autoreconf -i
$ ./configure
$ make
\endcode
<h2>Starting the server</h2>
When compiled, the following executables are created (in the src/ directory):
- \em knotd - The server
- \em knotc - Control utility
- \em knot-zcompile - Zone compiler
- \em unittests - Unit tests for the server and dnslib
- \em unittests-zcompile - Unit tests for the zone compiler
1. Add path to knotd and knot-zcompile executables to PATH
2. Prepare a configuration file. You may copy and edit the one provided with
the server (\em samples/knot.conf.sample).
2. Compile zone
\code
$ src/knotc -c path-to-config-file compile
\endcode
3. Run the server
\code
$ src/knotc -c path-to-config-file start
\endcode
<h2>Server modules</h2>
- \ref server
- \ref threading
- \ref network
- \ref query_processing
- \ref utils
- \ref debugging
- \ref logging
- \ref statistics
<h2>DNS library</h2>
- \ref dnslib
- \ref hashing
<h2>Common library</h2>
- \ref common_lib
- \ref alloc
<h2>Other modules</h2>
- \ref tests
- \ref zoneparser
- \ref ctl
*/
|
