Add documentation for "RequireAuthPing" configuration option
[ngircd-alex.git] / man / ngircd.conf.5.tmpl
1 .\"
2 .\" ngircd.conf(5) manual page template
3 .\"
4 .TH ngircd.conf 5 "Mar 2011" ngircd "ngIRCd Manual"
5 .SH NAME
6 ngircd.conf \- configuration file of ngIRCd
7 .SH SYNOPSIS
8 .B :ETCDIR:/ngircd.conf
9 .SH DESCRIPTION
10 .BR ngircd.conf
11 is the configuration file of the
12 .BR ngircd (8)
13 Internet Relay Chat (IRC) daemon which you should adept to your local
14 preferences and needs.
15 .PP
16 Most variables can be modified while the ngIRCd daemon is already running:
17 It will reload its configuration when a HUP signal is received.
18 .SH "FILE FORMAT"
19 The file consists of sections and parameters. A section begins with the name
20 of the section in square brackets and continues until the next section
21 begins.
22 .PP
23 Sections contain parameters of the form
24 .PP
25 .RS
26 .I name
27 =
28 .I value
29 .RE
30 .PP
31 Empty lines and any line beginning with a semicolon (';') or a hash ('#')
32 character are treated as a comment and will be ignored. Leading and trailing
33 whitespaces are trimmed before any processing takes place.
34 .PP
35 The file format is line-based - that means, each non-empty newline-terminated
36 line represents either a comment, a section name, or a parameter.
37 .PP
38 Section and parameter names are not case sensitive.
39 .PP
40 There are three types of variables:
41 .I booleans,
42 .I text strings,
43 and
44 .I numbers.
45 Boolean values are
46 .I true
47 if they are "yes", "true", or any non-null integer. Text strings are used 1:1
48 without leading and following spaces; there is not way to quote strings. And
49 for numbers all decimal integer values are valid.
50 .PP
51 In addition, some string or numerical variables accept lists of values,
52 separated by commas (",").
53 .SH "SECTION OVERVIEW"
54 The file can contain blocks of four types: [Global], [Operator], [Server],
55 and [Channel].
56 .PP
57 The main configuration of the server is stored in the
58 .I [Global]
59 section, like the server name, administrative information and the
60 ports on which the server should be listening. IRC operators of this
61 server are defined in
62 .I [Operator]
63 blocks.
64 .I [Features]
65 can be used to disable compile-time features at run time, e.g. if ngircd
66 was built to support ident lookups, but you do not want ngircd to perform
67 ident lookups you can disable them here.
68 This section is optional.
69 .I [Server]
70 is the section where server links are configured. And
71 .I [Channel]
72 blocks are used to configure pre-defined ("persistent") IRC channels.
73 .PP
74 There can be more than one [Operator], [Server] and [Channel] sections
75 per configuration file, but only one [Global] and one [Features] section.
76 .SH [GLOBAL]
77 The
78 .I [Global]
79 section is used to define the server main configuration, like the server
80 name and the ports on which the server should be listening.
81 .TP
82 \fBName\fR (string)
83 Server name in the IRC network. This is an individual name of the IRC
84 server, it is not related to the DNS host name. It must be unique in the
85 IRC network and must contain at least one dot (".") character.
86 .TP
87 \fBInfo\fR (string)
88 Info text of the server. This will be shown by WHOIS and LINKS requests for
89 example.
90 .TP
91 \fBPassword\fR (string)
92 Global password for all users needed to connect to the server. The default
93 is empty, so no password is required.
94 .TP
95 \fBWebircPassword\fR (string)
96 Password required for using the WEBIRC command used by some Web-to-IRC
97 gateways. If not set or empty, the WEBIRC command can't be used.
98 Default: not set.
99 .TP
100 \fBAdminInfo1\fR, \fBAdminInfo2\fR, \fBAdminEMail\fR (string)
101 Information about the server and the administrator, used by the ADMIN
102 command.
103 .TP
104 \fBPorts\fR (list of numbers)
105 Ports on which the server should listen. There may be more than one port,
106 separated with commas (","). Default: 6667, unless \fBSSL_Ports\fR are also
107 specified.
108 .TP
109 \fBSSLPorts\fR (list of numbers)
110 Same as \fBPorts\fR , except that ngIRCd will expect incoming connections
111 to be SSL/TLS encrypted. Common port numbers for SSL-encrypted IRC are 6669
112 and 6697. Default: none.
113 .TP
114 \fBSSLKeyFile\fR (string)
115 Filename of SSL Server Key to be used for SSL connections. This is required for
116 SSL/TLS support.
117 .TP
118 \fBSSLKeyFilePassword\fR (string)
119 (OpenSSL only:) Password to decrypt private key.
120 .TP
121 \fBSSLCertFile\fR (string)
122 Certificate file of the private key.
123 .TP
124 \fBSSLDHFile\fR (string)
125 Name of the Diffie-Hellman Parameter file. Can be created with gnutls
126 "certtool \-\-generate-dh-params" or "openssl dhparam".
127 If this file is not present, it will be generated on startup when ngIRCd
128 was compiled with gnutls support (this may take some time). If ngIRCd
129 was compiled with OpenSSL, then (Ephemeral)-Diffie-Hellman Key Exchanges and several
130 Cipher Suites will not be available.
131 .TP
132 \fBListen\fR (list of strings)
133 A comma separated list of IP address on which the server should listen.
134 If unset, the defaults value is "0.0.0.0" or, if ngIRCd was compiled
135 with IPv6 support, "::,0.0.0.0". So the server listens on all configured
136 IP addresses and interfaces by default.
137 .TP
138 \fBSyslogFacility\fR (string)
139 Syslog "facility" to which ngIRCd should send log messages. Possible
140 values are system dependant, but most probably "auth", "daemon", "user"
141 and "local1" through "local7" are possible values; see syslog(3).
142 Default is "local5" for historical reasons, you probably want to
143 change this to "daemon", for example.
144 .TP
145 \fBMotdFile\fR (string)
146 Text file with the "message of the day" (MOTD). This message will be shown
147 to all users connecting to the server. Changes made to this file
148 take effect when ngircd is instructed to re-read its configuration file.
149 .TP
150 \fBMotdPhrase\fR (string)
151 A simple Phrase (<256 chars) if you don't want to use a MOTD file.
152 .TP
153 \fBServerUID\fR (string or number)
154 User ID under which the server should run; you can use the name of the user
155 or the numerical ID.
156 .PP
157 .RS
158 .B Attention:
159 .br
160 For this to work the server must have been
161 started with root privileges! In addition, the configuration and MOTD files
162 must be readable by this user, otherwise RESTART and REHASH won't work!
163 .RE
164 .TP
165 \fBServerGID\fR (string or number)
166 Group ID under which the ngIRCd should run; you can use the name of the
167 group or the numerical ID.
168 .PP
169 .RS
170 .B Attention:
171 .br
172 For this to work the server must have
173 been started with root privileges!
174 .RE
175 .TP
176 \fBChrootDir\fR (string)
177 A directory to chroot in when everything is initialized. It doesn't need
178 to be populated if ngIRCd is compiled as a static binary. By default ngIRCd
179 won't use the chroot() feature.
180 .PP
181 .RS
182 .B Attention:
183 .br
184 For this to work the server must have
185 been started with root privileges!
186 .RE
187 .TP
188 \fBPidFile\fR (string)
189 This tells ngIRCd to write its current process ID to a file. Note that the
190 pidfile is written AFTER chroot and switching the user ID, i. e. the
191 directory the pidfile resides in must be writeable by the ngIRCd user and
192 exist in the chroot directory (if configured, see above).
193 .RE
194 .TP
195 \fBPingTimeout\fR (number)
196 After <PingTimeout> seconds of inactivity the server will send a PING to
197 the peer to test whether it is alive or not. Default: 120.
198 .TP
199 \fBPongTimeout\fR (number)
200 If a client fails to answer a PING with a PONG within <PongTimeout>
201 seconds, it will be disconnected by the server. Default: 20.
202 .TP
203 \fBConnectRetry\fR (number)
204 The server tries every <ConnectRetry> seconds to establish a link to not yet
205 (or no longer) connected servers. Default: 60.
206 .TP
207 \fBOperCanUseMode\fR (boolean)
208 Should IRC Operators be allowed to use the MODE command even if they are
209 not(!) channel-operators? Default: no.
210 .TP
211 \fBOperServerMode\fR (boolean)
212 If \fBOperCanUseMode\fR is enabled, this may lead the compatibility problems with
213 Servers that run the ircd-irc2 Software. This Option "masks" mode requests
214 by non-chanops as if they were coming from the server. Default: no.
215 .TP
216 \fBAllowRemoteOper\fR (boolean)
217 Are IRC operators connected to remote servers allowed to control this server,
218 e. g. are they allowed to use administrative commands like CONNECT, DIE,
219 SQUIT, ... that affect this server? Default: no.
220 .TP
221 \fBPredefChannelsOnly\fR (boolean)
222 If enabled, no new channels can be created. Useful if
223 you do not want to have channels other than those defined in
224 [Channel] sections in the configuration file.
225 Default: no.
226 .TP
227 \fBConnectIPv4\fR (boolean)
228 Set this to no if you do not want ngIRCd to connect to other IRC servers using
229 IPv4. This allows usage of ngIRCd in IPv6-only setups.
230 Default: yes.
231 .TP
232 \fBConnectIPv6\fR (boolean)
233 Set this to no if you do not want ngIRCd to connect to other irc servers using IPv6.
234 Default: yes.
235 .TP
236 \fBMaxConnections\fR (number)
237 Maximum number of simultaneous in- and outbound connections the server is
238 allowed to accept (0: unlimited). Default: 0.
239 .TP
240 \fBMaxConnectionsIP\fR (number)
241 Maximum number of simultaneous connections from a single IP address that
242 the server will accept (0: unlimited). This configuration options lowers
243 the risk of denial of service attacks (DoS). Default: 5.
244 .TP
245 \fBMaxJoins\fR (number)
246 Maximum number of channels a user can be member of (0: no limit).
247 Default: 10.
248 .TP
249 \fBMaxNickLength\fR (number)
250 Maximum length of an user nick name (Default: 9, as in RFC 2812). Please
251 note that all servers in an IRC network MUST use the same maximum nick name
252 length!
253 .TP
254 \fBRequireAuthPing\fR
255 Let ngIRCd send an "authentication PING" when a new client connects, and
256 register this client only after receiving the corresponding "PONG" reply.
257 Default: no.
258 .TP
259 \fBCloakHost\fR
260 Set this hostname for every client instead of the real one. Default: empty,
261 don't change.
262 .PP
263 .RS
264 .B Please note:
265 .br
266 Don't use the percentage sign ("%"), it is reserved for future extensions!
267 .RE
268 .TP
269 \fBCloakUserToNick\fR
270 Set every clients' user name to their nick name and hide the one supplied
271 by the IRC client. Default: no.
272 .SH [OPERATOR]
273 .I [Operator]
274 sections are used to define IRC Operators. There may be more than one
275 .I [Operator]
276 block, one for each local operator.
277 .TP
278 \fBName\fR (string)
279 ID of the operator (may be different of the nick name).
280 .TP
281 \fBPassword\fR (string)
282 Password of the IRC operator.
283 .TP
284 \fBMask\fR (string)
285 Mask that is to be checked before an /OPER for this account is accepted.
286 Example: nick!ident@*.example.com
287 .SH [FEATURES]
288 An optional section that can be used to disable features at
289 run-time. A feature is enabled by default if if ngircd was built with
290 support for it.
291 .TP
292 \fBDNS\fR (boolean)
293 If set to false, ngIRCd will not make DNS lookups when clients connect.
294 If you configure the daemon to connect to other servers, ngIRCd may still
295 perform a DNS lookup if required.
296 Default: yes.
297 .TP
298 \fBIdent\fR (boolean)
299 If ngIRCd is compiled with IDENT support this can be used to disable IDENT
300 lookups at run time.
301 Default: yes.
302 .TP
303 \fBPAM\fR (boolean)
304 If ngIRCd is compiled with PAM support this can be used to disable all calls
305 to the PAM library at runtime; all users connecting without password are
306 allowed to connect, all passwords given will fail.
307 Default: yes.
308 .SH [SERVER]
309 Other servers are configured in
310 .I [Server]
311 sections. If you configure a port for the connection, then this ngIRCd
312 tries to connect to to the other server on the given port (active);
313 if not, it waits for the other server to connect (passive).
314 .PP
315 ngIRCd supports "server groups": You can assign an "ID" to every server
316 with which you want this ngIRCd to link, and the daemon ensures that at
317 any given time only one direct link exists to servers with the same ID.
318 So if a server of a group won't answer, ngIRCd tries to connect to the next
319 server in the given group (="with the same ID"), but never tries to connect
320 to more than one server of this group simultaneously.
321 .PP
322 There may be more than one
323 .I [Server]
324 block.
325 .TP
326 \fBName\fR (string)
327 IRC name of the remote server.
328 .TP
329 \fBHost\fR (string)
330 Internet host name (or IP address) of the peer.
331 .TP
332 \fBBind\fR (string)
333 IP address to use as source IP for the outgoing connection. Default is
334 to let the operating system decide.
335 .TP
336 \fBPort\fR (number)
337 Port of the remote server to which ngIRCd should connect (active).
338 If no port is assigned to a configured server, the daemon only waits for
339 incoming connections (passive, default).
340 .TP
341 \fBMyPassword\fR (string)
342 Own password for this connection. This password has to be configured as
343 \fBPeerPassword\fR on the other server. Must not have ':' as first character.
344 .TP
345 \fBPeerPassword\fR (string)
346 Foreign password for this connection. This password has to be configured as
347 \fBMyPassword\fR on the other server.
348 .TP
349 \fBGroup\fR (number)
350 Group of this server (optional).
351 .TP
352 \fBPassive\fR (boolean)
353 Disable automatic connection even if port value is specified. Default: false.
354 You can use the IRC Operator command CONNECT later on to create the link.
355 .TP
356 \fBSSLConnect\fR (boolean)
357 Connect to the remote server using TLS/SSL. Default: false.
358 .TP
359 \fBServiceMask\fR (string)
360 Define a (case insensitive) mask matching nick names that should be treated as
361 IRC services when introduced via this remote server. REGULAR SERVERS DON'T NEED
362 this parameter, so leave it empty (which is the default).
363 .PP
364 .RS
365 When you are connecting IRC services which mask as a IRC server and which use
366 "virtual users" to communicate with, for example "NickServ" and "ChanServ",
367 you should set this parameter to something like "*Serv".
368 .SH [CHANNEL]
369 Pre-defined channels can be configured in
370 .I [Channel]
371 sections. Such channels are created by the server when starting up and even
372 persist when there are no more members left.
373 .PP
374 Persistent channels are marked with the mode 'P', which can be set and unset
375 by IRC operators like other modes on the fly.
376 .PP
377 There may be more than one
378 .I [Channel]
379 block.
380 .TP
381 \fBName\fR (string)
382 Name of the channel, including channel prefix ("#" or "&").
383 .TP
384 \fBTopic\fR (string)
385 Topic for this channel.
386 .TP
387 \fBModes\fR (string)
388 Initial channel modes.
389 .TP
390 \fBKey\fR (string)
391 Sets initial channel key (only relevant if channel mode "k" is set).
392 .TP
393 \fBKeyFile\fR (string)
394 Path and file name of a "key file" containing individual channel keys for
395 different users. The file consists of plain text lines with the following
396 syntax (without spaces!):
397 .PP
398 .RS
399 .RS
400 .I user
401 :
402 .I nick
403 :
404 .I key
405 .RE
406 .PP
407 .I user
408 and
409 .I nick
410 can contain the wildcard character "*".
411 .br
412 .I key
413 is an arbitrary password.
414 .PP
415 Valid examples are:
416 .PP
417 .RS
418 *:*:KeY
419 .br
420 *:nick:123
421 .br
422 ~user:*:xyz
423 .RE
424 .PP
425 The key file is read on each JOIN command when this channel has a key
426 (channel mode +k). Access is granted, if a) the channel key set using the
427 MODE +k command or b) one of the lines in the key file match.
428 .PP
429 .B Please note:
430 .br
431 The file is not reopened on each access, so you can modify and overwrite it
432 without problems, but moving or deleting the file will have not effect until
433 the daemon re-reads its configuration!
434 .RE
435 .TP
436 \fBMaxUsers\fR (number)
437 Set maximum user limit for this channel (only relevant if channel mode "l"
438 is set).
439 .SH HINTS
440 It's wise to use "ngircd \-\-configtest" to validate the configuration file
441 after changing it. See
442 .BR ngircd (8)
443 for details.
444 .SH AUTHOR
445 Alexander Barton, <alex@barton.de>
446 .br
447 Florian Westphal, <fw@strlen.de>
448 .PP
449 Homepage: http://ngircd.barton.de/
450 .SH "SEE ALSO"
451 .BR ngircd (8)
452 .\"
453 .\" -eof-