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