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