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