summaryrefslogtreecommitdiff
path: root/doc/knot.texi
blob: 4398432fded0249335da471a418b001dbd6bdf7d (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
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
\input texinfo   @c -*-texinfo-*-
@setfilename knot.info
@include version.texi
@documentencoding UTF-8
@settitle Knot DNS @value{VERSION}

@paragraphindent 0

@defindex st
@syncodeindex vr st

@copying
This manual is for Knot DNS (version @value{VERSION}, @value{UPDATED}),
which is a high-performance authoritative-only DNS server.

Copyright @copyright{} 2012 CZ.NIC, z.s.p.o.

@quotation
This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.

This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License
along with this program.  If not, see <http://www.gnu.org/licenses/>.
@end quotation
@end copying

@dircategory Internet-application/server
@direntry
* Knot DNS: (Knot DNS) An authoritative-only DNS server
@end direntry

@titlepage
@title Knot DNS Reference Manual
@subtitle for version @value{VERSION}, @value{UPDATED}
@author Jan Kadlec (@email{jan.kadlec@@nic.cz})
@author Lubos Slovak (@email{lubos.slovak@@nic.cz})
@author Ondrej Sury (@email{ondrej@@sury.org})
@author Marek Vavrusa (@email{marek.vavrusa@@nic.cz})
@author Jan Vcelak (@email{jan.vcelak@@nic.cz})
@page
@vskip 0pt plus 1filll
@insertcopying
@end titlepage

@contents

@ifnottex
@node Top, Introduction, (dir), (dir)
@top Knot DNS

This manual is for Knot DNS (version @value{VERSION}, @value{UPDATED}).
@end ifnottex

@menu
* Introduction::
* Knot DNS Resource Requirements::
* Knot DNS Installation::
* Knot DNS Configuration::
* Running Knot DNS::
* Troubleshooting::
* Statement Index::
* Knot DNS Configuration Reference::

@detailmenu
 --- The Detailed Node Listing ---

Introduction

* What is Knot DNS::
* Knot DNS features::
* Scope of this document::

Knot DNS Resource Requirements

* Hardware requirements::
* CPU requirements::
* Memory requirements::
* Supported operating system::

Knot DNS Installation

* Required build environment::
* Required libraries::
* Installation from the sources::
* Installation from packages::

Required libraries

* Userspace RCU::

Installation from the sources

* Configuring and generating Makefiles::
* Compilation::
* Installation::

Installation from packages

* Installing Knot DNS packages on Debian::
* Installing Knot DNS packages on Ubuntu::
* Installing Knot DNS packages on Fedora::
* Installing Knot DNS from ports on FreeBSD::

Installing Knot DNS packages on Ubuntu

* Adding official PPA repository for Knot DNS::

Knot DNS Configuration

* Minimal configuration::
* Slave configuration::
* Master configuration::
* Configuring multiple interfaces::

Sample Configurations

* Minimal configuration::
* Slave configuration::
* Master configuration::
* Configuring multiple interfaces::
* Enabling zone semantic checks::
* Creating IXFR differences from zone file changes::

Running Knot DNS

* Running a slave server::
* Running a master server::
* Controlling running daemon::

Troubleshooting

* Submitting a bugreport::
* Generating backtrace::
* Debug messages::

Debug messages

* Enabling debug messages in server::

Enabling debug messages in server

* Example::

Knot DNS Configuration Reference

* system::
* keys::
* interfaces::
* remotes::
* groups::
* zones::
* log::
* include::

@code{system} Statement

* system Syntax::
* system Statement Definition and Usage::
* system Example::

Statement Definition and Usage

* identity::
* version::
* nsid::
* storage::
* rundir::
* pidfile::
* workers::
* user::
* max-conn-idle::
* max-conn-hs::
* max-conn-reply::
* rate-limit::
* rate-limit-size::
* rate-limit-slip::

@code{keys} Statement

* keys Syntax::
* keys Statement Definition and Usage::
* Example::

Statement Definition and Usage

* key_id::

interfaces

* interfaces Syntax::
* interfaces Statement Definition and Usage::
* interfaces Examples::

Statement Definition and Usage

* interface_id::

@code{remotes} Statement

* remotes Syntax::
* remotes Statement Definition and Grammar::

@code{groups} Statement

* groups Syntax::
* groups Statement Definition and Grammar::

@code{zones} Statement

* zones Syntax::
* zones Statement Definition and Grammar::
* zones List of zone semantic checks::

@code{log} Statement

* log Syntax::
* log Statement Definition and Grammar::

@code{include} Statement

* include Syntax::

@end detailmenu
@end menu

@c main chapters

@include introduction.texi
@include requirements.texi
@include installation.texi
@include configuration.texi
@include running.texi
@include troubleshooting.texi

@c indices
@include indices.texi

@c appendixes
@include reference.texi

@bye