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