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