New configuration option "IdleTimeout": exit daemon when idle
[ngircd-alex.git] / man / ngircd.conf.5.tmpl
1 .\"
2 .\" ngircd.conf(5) manual page template
3 .\"
4 .TH ngircd.conf 5 "Feb 2013" 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 must be customized to the 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 file when a HUP signal or REHASH command
18 is received.
19 .SH "FILE FORMAT"
20 The file consists of sections and parameters. A section begins with the name
21 of the section in square brackets and continues until the next section
22 begins.
23 .PP
24 Sections contain parameters of the form
25 .PP
26 .RS
27 .I name
28 =
29 .I value
30 .RE
31 .PP
32 Empty lines and any line beginning with a semicolon (';') or a hash ('#')
33 character are treated as a comment and will be ignored. Leading and trailing
34 whitespaces are trimmed before any processing takes place.
35 .PP
36 The file format is line-based - that means, each non-empty newline-terminated
37 line represents either a comment, a section name, or a parameter.
38 .PP
39 Section and parameter names are not case sensitive.
40 .PP
41 There are three types of variables:
42 .I booleans,
43 .I text strings,
44 and
45 .I numbers.
46 Boolean values are
47 .I true
48 if they are "yes", "true", or any non-null integer. Text strings are used 1:1
49 without leading and following spaces; there is no way to quote strings. And
50 for numbers all decimal integer values are valid.
51 .PP
52 In addition, some string or numerical variables accept lists of values,
53 separated by commas (",").
54 .SH "SECTION OVERVIEW"
55 The file can contain blocks of seven types: [Global], [Limits], [Options],
56 [SSL], [Operator], [Server], and [Channel].
57 .PP
58 The main configuration of the server is stored in the
59 .I [Global]
60 section, like the server name, administrative information and the ports on
61 which the server should be listening. The variables in this section have to be
62 adjusted to the local requirements most of the time, whereas all the variables
63 in the other sections can be left on there defaults very often.
64 .PP
65 Options in the
66 .I [Limits]
67 block are used to tweak different limits and timeouts of the daemon, like the
68 maximum number of clients allowed to connect to this server. Variables in the
69 .I [Options]
70 section can be used to enable or disable specific features of ngIRCd, like
71 support for IDENT, PAM, IPv6, and protocol and cloaking features. The
72 .I [SSL]
73 block contains all SSL-related configuration variables. These three sections
74 are all optional.
75 .PP
76 IRC operators of this server are defined in
77 .I [Operator]
78 blocks. Links to remote servers are configured in
79 .I [Server]
80 sections. And
81 .I [Channel]
82 blocks are used to configure pre-defined ("persistent") IRC channels.
83 .PP
84 There can be more than one [Operator], [Server] and [Channel] section per
85 configuration file (one for each operator, server, and channel), but only
86 exactly one [Global], one [Limits], one [Options], and one [SSL] section.
87 .SH [GLOBAL]
88 The
89 .I [Global]
90 section of this file is used to define the main configuration of the server,
91 like the server name and the ports on which the server should be listening.
92 These settings depend on your personal preferences, so you should make sure
93 that they correspond to your installation and setup!
94 .TP
95 \fBName\fR (string; required)
96 Server name in the IRC network. This is an individual name of the IRC
97 server, it is not related to the DNS host name. It must be unique in the
98 IRC network and must contain at least one dot (".") character.
99 .TP
100 \fBAdminInfo1\fR, \fBAdminInfo2\fR, \fBAdminEMail\fR (string)
101 Information about the server and the administrator, used by the ADMIN
102 command. This information is not required by the server but by RFC!
103 .TP
104 \fBHelpFile\fR (string)
105 Text file which contains the ngIRCd help text. This file is required
106 to display help texts when using the "HELP <cmd>" command.
107 Please note: Changes made to this file take effect when ngircd starts up
108 or is instructed to re-read its configuration file.
109 .TP
110 \fBInfo\fR (string)
111 Info text of the server. This will be shown by WHOIS and LINKS requests for
112 example.
113 .TP
114 \fBListen\fR (list of strings)
115 A comma separated list of IP address on which the server should listen.
116 If unset, the defaults value is "0.0.0.0" or, if ngIRCd was compiled
117 with IPv6 support, "::,0.0.0.0". So the server listens on all configured
118 IP addresses and interfaces by default.
119 .TP
120 \fBMotdFile\fR (string)
121 Text file with the "message of the day" (MOTD). This message will be shown to
122 all users connecting to the server. Please note: Changes made to this file
123 take effect when ngircd starts up or is instructed to re-read its
124 configuration file.
125 .TP
126 \fBMotdPhrase\fR (string)
127 A simple Phrase (<256 chars) if you don't want to use a MOTD file.
128 .TP
129 \fBPassword\fR (string)
130 Global password for all users needed to connect to the server. The default is
131 empty, so no password is required. Please note: This feature is not available
132 if ngIRCd is using PAM!
133 .TP
134 \fBPidFile\fR (string)
135 This tells ngIRCd to write its current process ID to a file. Note that the
136 pidfile is written AFTER chroot and switching the user ID, e.g. the directory
137 the pidfile resides in must be writable by the ngIRCd user and exist in the
138 chroot directory (if configured, see above).
139 .TP
140 \fBPorts\fR (list of numbers)
141 Ports on which the server should listen for unencrypted connections. There
142 may be more than one port, separated with commas (","). Default: 6667.
143 .TP
144 \fBServerGID\fR (string or number)
145 Group ID under which the ngIRCd should run; you can use the name of the
146 group or the numerical ID.
147 .PP
148 .RS
149 .B Attention:
150 .br
151 For this to work the server must have been started with root privileges!
152 .RE
153 .TP
154 \fBServerUID\fR (string or number)
155 User ID under which the server should run; you can use the name of the user
156 or the numerical ID.
157 .PP
158 .RS
159 .B Attention:
160 .br
161 For this to work the server must have been started with root privileges! In
162 addition, the configuration and MOTD files must be readable by this user,
163 otherwise RESTART and REHASH won't work!
164 .RE
165 .SH [LIMITS]
166 Define some limits and timeouts for this ngIRCd instance. Default values
167 should be safe, but it is wise to double-check :-)
168 .TP
169 \fBConnectRetry\fR (number)
170 The server tries every <ConnectRetry> seconds to establish a link to not yet
171 (or no longer) connected servers. Default: 60.
172 .TP
173 \fBIdleTimeout\fR (number)
174 Number of seconds after which the whole daemon should shutdown when no
175 connections are left active after handling at least one client (0: never). This
176 can be useful for testing or when ngIRCd is started using "socket activation"
177 with systemd(8), for example. Default: 0.
178 .TP
179 \fBMaxConnections\fR (number)
180 Maximum number of simultaneous in- and outbound connections the server is
181 allowed to accept (0: unlimited). Default: 0.
182 .TP
183 \fBMaxConnectionsIP\fR (number)
184 Maximum number of simultaneous connections from a single IP address that
185 the server will accept (0: unlimited). This configuration options lowers
186 the risk of denial of service attacks (DoS). Default: 5.
187 .TP
188 \fBMaxJoins\fR (number)
189 Maximum number of channels a user can be member of (0: no limit).
190 Default: 10.
191 .TP
192 \fBMaxNickLength\fR (number)
193 Maximum length of an user nickname (Default: 9, as in RFC 2812). Please
194 note that all servers in an IRC network MUST use the same maximum nickname
195 length!
196 .TP
197 \fBMaxListSize\fR (number)
198 Maximum number of channels returned in response to a LIST command. Default: 100.
199 .TP
200 \fBPingTimeout\fR (number)
201 After <PingTimeout> seconds of inactivity the server will send a PING to
202 the peer to test whether it is alive or not. Default: 120.
203 .TP
204 \fBPongTimeout\fR (number)
205 If a client fails to answer a PING with a PONG within <PongTimeout>
206 seconds, it will be disconnected by the server. Default: 20.
207 .SH [OPTIONS]
208 Optional features and configuration options to further tweak the behavior of
209 ngIRCd. If you want to get started quickly, you most probably don't have to
210 make changes here -- they are all optional.
211 .TP
212 \fBAllowRemoteOper\fR (boolean)
213 Are IRC operators connected to remote servers allowed to control this server,
214 e.g. are they allowed to use administrative commands like CONNECT, DIE,
215 SQUIT, ... that affect this server? Default: no.
216 .TP
217 \fBChrootDir\fR (string)
218 A directory to chroot in when everything is initialized. It doesn't need
219 to be populated if ngIRCd is compiled as a static binary. By default ngIRCd
220 won't use the chroot() feature.
221 .PP
222 .RS
223 .B Attention:
224 .br
225 For this to work the server must have been started with root privileges!
226 .RE
227 .TP
228 \fBCloakHost\fR (string)
229 Set this hostname for every client instead of the real one. Default: empty,
230 don't change. Use %x to add the hashed value of the original hostname.
231 .TP
232 \fBCloakHostModeX\fR (string)
233 Use this hostname for hostname cloaking on clients that have the user mode
234 "+x" set, instead of the name of the server. Default: empty, use the name
235 of the server. Use %x to add the hashed value of the original hostname
236 .TP
237 \fBCloakHostSalt\fR (string)
238 The Salt for cloaked hostname hashing. When undefined a random hash is
239 generated after each server start.
240 .TP
241 \fBCloakUserToNick\fR (boolean)
242 Set every clients' user name to their nickname and hide the one supplied
243 by the IRC client. Default: no.
244 .TP
245 \fBConnectIPv4\fR (boolean)
246 Set this to no if you do not want ngIRCd to connect to other IRC servers using
247 the IPv4 protocol. This allows the usage of ngIRCd in IPv6-only setups.
248 Default: yes.
249 .TP
250 \fBConnectIPv6\fR (boolean)
251 Set this to no if you do not want ngIRCd to connect to other IRC servers using
252 the IPv6 protocol.
253 Default: yes.
254 .TP
255 \fBDNS\fR (boolean)
256 If set to false, ngIRCd will not make any DNS lookups when clients connect.
257 If you configure the daemon to connect to other servers, ngIRCd may still
258 perform a DNS lookup if required.
259 Default: yes.
260 .TP
261 \fBIdent\fR (boolean)
262 If ngIRCd is compiled with IDENT support this can be used to disable IDENT
263 lookups at run time.
264 Users identified using IDENT are registered without the "~" character
265 prepended to their user name.
266 Default: yes.
267 .TP
268 \fBMorePrivacy\fR (boolean)
269 This will cause ngIRCd to censor user idle time, logon time as well as the
270 part/quit messages (that are sometimes used to inform everyone about which
271 client software is being used). WHOWAS requests are also silently ignored.
272 This option is most useful when ngIRCd is being used together with
273 anonymizing software such as TOR or I2P and one does not wish to make it
274 too easy to collect statistics on the users.
275 Default: no.
276 .TP
277 \fBNoticeAuth\fR (boolean)
278 Normally ngIRCd doesn't send any messages to a client until it is registered.
279 Enable this option to let the daemon send "NOTICE AUTH" messages to clients
280 while connecting. Default: no.
281 .TP
282 \fBOperCanUseMode\fR (boolean)
283 Should IRC Operators be allowed to use the MODE command even if they are
284 not(!) channel-operators? Default: no.
285 .TP
286 \fBOperChanPAutoOp\fR (boolean)
287 Should IRC Operators get AutoOp (+o) in persistent (+P) channels?
288 Default: yes.
289 .TP
290 \fBOperServerMode\fR (boolean)
291 If \fBOperCanUseMode\fR is enabled, this may lead the compatibility problems
292 with Servers that run the ircd-irc2 Software. This Option "masks" mode
293 requests by non-chanops as if they were coming from the server. Default: no;
294 only enable it if you have ircd-irc2 servers in your IRC network.
295 .TP
296 \fBPAM\fR (boolean)
297 If ngIRCd is compiled with PAM support this can be used to disable all calls
298 to the PAM library at runtime; all users connecting without password are
299 allowed to connect, all passwords given will fail.
300 Users identified using PAM are registered without the "~" character
301 prepended to their user name.
302 Default: yes.
303 .TP
304 \fBPAMIsOptional\fR (boolean)
305 When PAM is enabled, all clients are required to be authenticated using PAM;
306 connecting to the server without successful PAM authentication isn't possible.
307 If this option is set, clients not sending a password are still allowed to
308 connect: they won't become "identified" and keep the "~" character prepended
309 to their supplied user name.
310 Please note:
311 To make some use of this behavior, it most probably isn't useful to enable
312 "Ident", "PAM" and "PAMIsOptional" at the same time, because you wouldn't be
313 able to distinguish between Ident'ified and PAM-authenticated users: both
314 don't have a "~" character prepended to their respective user names!
315 Default: no.
316 .TP
317 \fBPredefChannelsOnly\fR (boolean)
318 If enabled, no new channels can be created. Useful if you do not want to have
319 other channels than those defined in [Channel] sections in the configuration
320 file on this server.
321 Default: no.
322 .TP
323 \fBRequireAuthPing\fR (boolean)
324 Let ngIRCd send an "authentication PING" when a new client connects, and
325 register this client only after receiving the corresponding "PONG" reply.
326 Default: no.
327 .TP
328 \fBScrubCTCP\fR (boolean)
329 If set to true, ngIRCd will silently drop all CTCP requests sent to it from
330 both clients and servers. It will also not forward CTCP requests to any
331 other servers. CTCP requests can be used to query user clients about which
332 software they are using and which versions said software is. CTCP can also be
333 used to reveal clients IP numbers. ACTION CTCP requests are not blocked,
334 this means that /me commands will not be dropped, but please note that
335 blocking CTCP will disable file sharing between users!
336 Default: no.
337 .TP
338 \fBSyslogFacility\fR (string)
339 Syslog "facility" to which ngIRCd should send log messages. Possible
340 values are system dependent, but most probably "auth", "daemon", "user"
341 and "local1" through "local7" are possible values; see syslog(3).
342 Default is "local5" for historical reasons, you probably want to
343 change this to "daemon", for example.
344 .TP
345 \fBWebircPassword\fR (string)
346 Password required for using the WEBIRC command used by some Web-to-IRC
347 gateways. If not set or empty, the WEBIRC command can't be used.
348 Default: not set.
349 .SH [SSL]
350 All SSL-related configuration variables are located in the
351 .I [SSL]
352 section. Please note that this whole section is only recognized by ngIRCd
353 when it is compiled with support for SSL using OpenSSL or GnuTLS!
354 .TP
355 \fBCertFile\fR (string)
356 SSL Certificate file of the private server key.
357 .TP
358 \fBDHFile\fR (string)
359 Name of the Diffie-Hellman Parameter file. Can be created with GnuTLS
360 "certtool \-\-generate-dh-params" or "openssl dhparam". If this file is not
361 present, it will be generated on startup when ngIRCd was compiled with GnuTLS
362 support (this may take some time). If ngIRCd was compiled with OpenSSL, then
363 (Ephemeral)-Diffie-Hellman Key Exchanges and several Cipher Suites will not be
364 available.
365 .TP
366 \fBKeyFile\fR (string)
367 Filename of SSL Server Key to be used for SSL connections. This is required
368 for SSL/TLS support.
369 .TP
370 \fBKeyFilePassword\fR (string)
371 OpenSSL only: Password to decrypt the private key file.
372 .TP
373 \fBPorts\fR (list of numbers)
374 Same as \fBPorts\fR , except that ngIRCd will expect incoming connections
375 to be SSL/TLS encrypted. Common port numbers for SSL-encrypted IRC are 6669
376 and 6697. Default: none.
377 .SH [OPERATOR]
378 .I [Operator]
379 sections are used to define IRC Operators. There may be more than one
380 .I [Operator]
381 block, one for each local operator.
382 .TP
383 \fBName\fR (string)
384 ID of the operator (may be different of the nickname).
385 .TP
386 \fBPassword\fR (string)
387 Password of the IRC operator.
388 .TP
389 \fBMask\fR (string)
390 Mask that is to be checked before an /OPER for this account is accepted.
391 Example: nick!ident@*.example.com
392 .SH [SERVER]
393 Other servers are configured in
394 .I [Server]
395 sections. If you configure a port for the connection, then this ngIRCd
396 tries to connect to to the other server on the given port (active);
397 if not, it waits for the other server to connect (passive).
398 .PP
399 ngIRCd supports "server groups": You can assign an "ID" to every server
400 with which you want this ngIRCd to link, and the daemon ensures that at
401 any given time only one direct link exists to servers with the same ID.
402 So if a server of a group won't answer, ngIRCd tries to connect to the next
403 server in the given group (="with the same ID"), but never tries to connect
404 to more than one server of this group simultaneously.
405 .PP
406 There may be more than one
407 .I [Server]
408 block.
409 .TP
410 \fBName\fR (string)
411 IRC name of the remote server.
412 .TP
413 \fBHost\fR (string)
414 Internet host name (or IP address) of the peer.
415 .TP
416 \fBBind\fR (string)
417 IP address to use as source IP for the outgoing connection. Default is
418 to let the operating system decide.
419 .TP
420 \fBPort\fR (number)
421 Port of the remote server to which ngIRCd should connect (active).
422 If no port is assigned to a configured server, the daemon only waits for
423 incoming connections (passive, default).
424 .TP
425 \fBMyPassword\fR (string)
426 Own password for this connection. This password has to be configured as
427 \fBPeerPassword\fR on the other server. Must not have ':' as first character.
428 .TP
429 \fBPeerPassword\fR (string)
430 Foreign password for this connection. This password has to be configured as
431 \fBMyPassword\fR on the other server.
432 .TP
433 \fBGroup\fR (number)
434 Group of this server (optional).
435 .TP
436 \fBPassive\fR (boolean)
437 Disable automatic connection even if port value is specified. Default: false.
438 You can use the IRC Operator command CONNECT later on to create the link.
439 .TP
440 \fBSSLConnect\fR (boolean)
441 Connect to the remote server using TLS/SSL. Default: false.
442 .TP
443 \fBServiceMask\fR (string)
444 Define a (case insensitive) list of masks matching nicknames that should be
445 treated as IRC services when introduced via this remote server, separated
446 by commas (","). REGULAR SERVERS DON'T NEED this parameter, so leave it empty
447 (which is the default).
448 .PP
449 .RS
450 When you are connecting IRC services which mask as a IRC server and which use
451 "virtual users" to communicate with, for example "NickServ" and "ChanServ",
452 you should set this parameter to something like "*Serv", "*Serv,OtherNick",
453 or "NickServ,ChanServ,XyzServ".
454 .SH [CHANNEL]
455 Pre-defined channels can be configured in
456 .I [Channel]
457 sections. Such channels are created by the server when starting up and even
458 persist when there are no more members left.
459 .PP
460 Persistent channels are marked with the mode 'P', which can be set and unset
461 by IRC operators like other modes on the fly.
462 .PP
463 There may be more than one
464 .I [Channel]
465 block.
466 .TP
467 \fBName\fR (string)
468 Name of the channel, including channel prefix ("#" or "&").
469 .TP
470 \fBTopic\fR (string)
471 Topic for this channel.
472 .TP
473 \fBModes\fR (string)
474 Initial channel modes.
475 .TP
476 \fBKey\fR (string)
477 Sets initial channel key (only relevant if channel mode "k" is set).
478 .TP
479 \fBKeyFile\fR (string)
480 Path and file name of a "key file" containing individual channel keys for
481 different users. The file consists of plain text lines with the following
482 syntax (without spaces!):
483 .PP
484 .RS
485 .RS
486 .I user
487 :
488 .I nick
489 :
490 .I key
491 .RE
492 .PP
493 .I user
494 and
495 .I nick
496 can contain the wildcard character "*".
497 .br
498 .I key
499 is an arbitrary password.
500 .PP
501 Valid examples are:
502 .PP
503 .RS
504 *:*:KeY
505 .br
506 *:nick:123
507 .br
508 ~user:*:xyz
509 .RE
510 .PP
511 The key file is read on each JOIN command when this channel has a key
512 (channel mode +k). Access is granted, if a) the channel key set using the
513 MODE +k command or b) one of the lines in the key file match.
514 .PP
515 .B Please note:
516 .br
517 The file is not reopened on each access, so you can modify and overwrite it
518 without problems, but moving or deleting the file will have not effect until
519 the daemon re-reads its configuration!
520 .RE
521 .TP
522 \fBMaxUsers\fR (number)
523 Set maximum user limit for this channel (only relevant if channel mode "l"
524 is set).
525 .SH HINTS
526 It's wise to use "ngircd \-\-configtest" to validate the configuration file
527 after changing it. See
528 .BR ngircd (8)
529 for details.
530 .SH AUTHOR
531 Alexander Barton, <alex@barton.de>
532 .br
533 Florian Westphal, <fw@strlen.de>
534 .PP
535 Homepage: http://ngircd.barton.de/
536 .SH "SEE ALSO"
537 .BR ngircd (8)
538 .\"
539 .\" -eof-