f4f7f6e67f4febbc188b2d7aae14403069ad9e86
[ngircd-alex.git] / man / ngircd.conf.5.tmpl
1 .\"
2 .\" ngircd.conf(5) manual page template
3 .\"
4 .TH ngircd.conf 5 "Dec 2008" 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 you should adept to your 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 when a HUP signal is received.
18 .SH "FILE FORMAT"
19 The file consists of sections and parameters. A section begins with the name
20 of the section in square brackets and continues until the next section
21 begins.
22 .PP
23 Sections contain parameters of the form
24 .PP
25 .RS
26 .I name
27 =
28 .I value
29 .RE
30 .PP
31 Empty lines and any line beginning with a semicolon (';') or a hash ('#')
32 character are treated as a comment and will be ignored. Leading and trailing
33 whitespaces are trimmed before any processing takes place.
34 .PP
35 The file format is line-based - that means, each non-empty newline-terminated
36 line represents either a comment, a section name, or a parameter.
37 .PP
38 Section and parameter names are not case sensitive.
39 .SH "SECTION OVERVIEW"
40 The file can contain blocks of four types: [Global], [Operator], [Server],
41 and [Channel].
42 .PP
43 The main configuration of the server is stored in the
44 .I [Global]
45 section, like the server name, administrative information and the
46 ports on which the server should be listening. IRC operators of this
47 server are defined in
48 .I [Operator]
49 blocks.
50 .I [Server]
51 is the section where server links are configured. And
52 .I [Channel]
53 blocks are used to configure pre-defined ("persistent") IRC channels.
54 .PP
55 There can be more than one [Operator], [Server] and [Channel] sections
56 per configuration file, but only one [Global] section.
57 .SH [GLOBAL]
58 The
59 .I [Global]
60 section is used to define the server main configuration, like the server
61 name and the ports on which the server should be listening.
62 .TP
63 \fBName\fR
64 Server name in the IRC network. This is an individual name of the IRC
65 server, it is not related to the DNS host name. It must be unique in the
66 IRC network and must contain at least one dot (".") character.
67 .TP
68 \fBInfo\fR
69 Info text of the server. This will be shown by WHOIS and LINKS requests for
70 example.
71 .TP
72 \fBPassword\fR
73 Global password for all users needed to connect to the server. The default
74 is empty, so no password is required.
75 .TP
76 \fBWebircPassword\fR
77 Password required for using the WEBIRC command used by some Web-to-IRC
78 gateways. If not set or empty, the WEBIRC command can't be used.
79 Default: not set.
80 .TP
81 \fBAdminInfo1\fR, \fBAdminInfo2\fR, \fBAdminEMail\fR
82 Information about the server and the administrator, used by the ADMIN
83 command.
84 .TP
85 \fBPorts\fR
86 Ports on which the server should listen. There may be more than one port,
87 separated with commas (","). Default: 6667, unless \fBSSL_Ports\fR are also
88 specified.
89 .TP
90 \fBSSLPorts\fR
91 Same as \fBPorts\fR , except that ngIRCd will expect incoming connections
92 to be SSL/TLS encrypted. Common port numbers for SSL-encrypted IRC are 6669
93 and 6697. Default: none.
94 .TP
95 \fBSSLKeyFile\fR
96 Filename of SSL Server Key to be used for SSL connections. This is required for
97 SSL/TLS support.
98 .TP
99 \fBSSLKeyFilePassword\fR
100 (OpenSSL only:) Password to decrypt private key.
101 .TP
102 \fBSSLCertFile\fR
103 Certificate file of the private key.
104 .TP
105 \fBSSLDHFile\fR
106 Name of the Diffie-Hellman Parameter file. Can be created with gnutls
107 "certtool \-\-generate-dh-params" or "openssl dhparam".
108 If this file is not present, it will be generated on startup when ngIRCd
109 was compiled with gnutls support (this may take some time). If ngIRCd
110 was compiled with OpenSSL, then (Ephemeral)-Diffie-Hellman Key Exchanges and several
111 Cipher Suites will not be available.
112 .TP
113 \fBListen\fR
114 A comma separated list of IP address on which the server should listen.
115 If unset, the defaults value is "0.0.0.0" or, if ngIRCd was compiled
116 with IPv6 support, "::,0.0.0.0". So the server listens on all configured
117 IP addresses and interfaces by default.
118 .TP
119 \fBSyslogFacility\fR
120 Syslog "facility" to which ngIRCd should send log messages. Possible
121 values are system dependant, but most probably "auth", "daemon", "user"
122 and "local1" through "local7" are possible values; see syslog(3).
123 Default is "local5" for historical reasons, you probably want to
124 change this to "daemon", for example.
125 .TP
126 \fBMotdFile\fR
127 Text file with the "message of the day" (MOTD). This message will be shown
128 to all users connecting to the server. Changes made to this file
129 take effect when ngircd is instructed to re-read its configuration file.
130 .TP
131 \fBMotdPhrase\fR
132 A simple Phrase (<256 chars) if you don't want to use a MOTD file.
133 .TP
134 \fBServerUID\fR
135 User ID under which the server should run; you can use the name of the user
136 or the numerical ID.
137 .PP
138 .RS
139 .B Attention:
140 .br
141 For this to work the server must have been
142 started with root privileges! In addition, the configuration and MOTD files
143 must be readable by this user, otherwise RESTART and REHASH won't work!
144 .RE
145 .TP
146 \fBServerGID\fR
147 Group ID under which the ngIRCd should run; you can use the name of the
148 group or the numerical ID.
149 .PP
150 .RS
151 .B Attention:
152 .br
153 For this to work the server must have
154 been started with root privileges!
155 .RE
156 .TP
157 \fBChrootDir\fR
158 A directory to chroot in when everything is initialized. It doesn't need
159 to be populated if ngIRCd is compiled as a static binary. By default ngIRCd
160 won't use the chroot() feature.
161 .PP
162 .RS
163 .B Attention:
164 .br
165 For this to work the server must have
166 been started with root privileges!
167 .RE
168 .TP
169 \fBPidFile\fR
170 This tells ngIRCd to write its current process ID to a file. Note that the
171 pidfile is written AFTER chroot and switching the user ID, i. e. the
172 directory the pidfile resides in must be writeable by the ngIRCd user and
173 exist in the chroot directory (if configured, see above).
174 .RE
175 .TP
176 \fBPingTimeout\fR
177 After <PingTimeout> seconds of inactivity the server will send a PING to
178 the peer to test whether it is alive or not. Default: 120.
179 .TP
180 \fBPongTimeout\fR
181 If a client fails to answer a PING with a PONG within <PongTimeout>
182 seconds, it will be disconnected by the server. Default: 20.
183 .TP
184 \fBConnectRetry\fR
185 The server tries every <ConnectRetry> seconds to establish a link to not yet
186 (or no longer) connected servers. Default: 60.
187 .TP
188 \fBOperCanUseMode\fR
189 Should IRC Operators be allowed to use the MODE command even if they are
190 not(!) channel-operators? Default: no.
191 .TP
192 \fBOperServerMode\fR
193 If \fBOperCanUseMode\fR is enabled, this may lead the compatibility problems with
194 Servers that run the ircd-irc2 Software. This Option "masks" mode requests
195 by non-chanops as if they were coming from the server. Default: no.
196 .TP
197 \fBAllowRemoteOper\fR
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 \fBPredefChannelsOnly\fR
203 If enabled, no new channels can be created. Useful if
204 you do not want to have channels other than those defined in
205 [Channel] sections in the configuration file.
206 Default: no.
207 .TP
208 \fBNoDNS\fR
209 If set to true, ngIRCd will not make DNS lookups when clients connect.
210 If you configure the daemon to connect to other servers, ngIRCd may still
211 perform a DNS lookup if required.
212 Default: no.
213 .TP
214 \fBNoIdent\fR
215 If ngIRCd is compiled with IDENT support this can be used to disable IDENT
216 lookups at run time.
217 Default: no.
218 .TP
219 \fBNoPAM\fR
220 If ngIRCd is compiled with PAM support this can be used to disable all calls
221 to the PAM library at runtime; all users connecting without password are
222 allowed to connect, all passwords given will fail.
223 Default: no.
224 .TP
225 \fBConnectIPv4\fR
226 Set this to no if you do not want ngIRCd to connect to other IRC servers using
227 IPv4. This allows usage of ngIRCd in IPv6-only setups.
228 Default: yes.
229 .TP
230 \fBConnectIPv6\fR
231 Set this to no if you do not want ngIRCd to connect to other irc servers using IPv6.
232 Default: yes.
233 .TP
234 \fBMaxConnections\fR
235 Maximum number of simultaneous in- and outbound connections the server is
236 allowed to accept (0: unlimited). Default: 0.
237 .TP
238 \fBMaxConnectionsIP\fR
239 Maximum number of simultaneous connections from a single IP address that
240 the server will accept (0: unlimited). This configuration options lowers
241 the risk of denial of service attacks (DoS). Default: 5.
242 .TP
243 \fBMaxJoins\fR
244 Maximum number of channels a user can be member of (0: no limit).
245 Default: 10.
246 .TP
247 \fBMaxNickLength\fR
248 Maximum length of an user nick name (Default: 9, as in RFC 2812). Please
249 note that all servers in an IRC network MUST use the same maximum nick name
250 length!
251 .SH [OPERATOR]
252 .I [Operator]
253 sections are used to define IRC Operators. There may be more than one
254 .I [Operator]
255 block, one for each local operator.
256 .TP
257 \fBName\fR
258 ID of the operator (may be different of the nick name).
259 .TP
260 \fBPassword\fR
261 Password of the IRC operator.
262 .TP
263 \fBMask\fR
264 Mask that is to be checked before an /OPER for this account is accepted.
265 Example: nick!ident@*.example.com
266 .SH [SERVER]
267 Other servers are configured in
268 .I [Server]
269 sections. If you configure a port for the connection, then this ngIRCd
270 tries to connect to to the other server on the given port (active);
271 if not, it waits for the other server to connect (passive).
272 .PP
273 ngIRCd supports "server groups": You can assign an "ID" to every server
274 with which you want this ngIRCd to link, and the daemon ensures that at
275 any given time only one direct link exists to servers with the same ID.
276 So if a server of a group won't answer, ngIRCd tries to connect to the next
277 server in the given group (="with the same ID"), but never tries to connect
278 to more than one server of this group simultaneously.
279 .PP
280 There may be more than one
281 .I [Server]
282 block.
283 .TP
284 \fBName\fR
285 IRC name of the remote server.
286 .TP
287 \fBHost\fR
288 Internet host name (or IP address) of the peer.
289 .TP
290 \fBBind\fR
291 IP address to use as source IP for the outgoing connection. Default is
292 to let the operating system decide.
293 .TP
294 \fBPort\fR
295 Port of the remote server to which ngIRCd should connect (active).
296 If no port is assigned to a configured server, the daemon only waits for
297 incoming connections (passive, default).
298 .TP
299 \fBMyPassword\fR
300 Own password for this connection. This password has to be configured as
301 \fBPeerPassword\fR on the other server. Must not have ':' as first character.
302 .TP
303 \fBPeerPassword\fR
304 Foreign password for this connection. This password has to be configured as
305 \fBMyPassword\fR on the other server.
306 .TP
307 \fBGroup\fR
308 Group of this server (optional).
309 .TP
310 \fBPassive\fR
311 Disable automatic connection even if port value is specified. Default: false.
312 You can use the IRC Operator command CONNECT later on to create the link.
313 .TP
314 \fBSSLConnect\fR
315 Connect to the remote server using TLS/SSL. Default: false.
316 .TP
317 \fBServiceMask\fR
318 Define a (case insensitive) mask matching nick names that should be treated as
319 IRC services when introduced via this remote server. REGULAR SERVERS DON'T NEED
320 this parameter, so leave it empty (which is the default).
321 .PP
322 .RS
323 When you are connecting IRC services which mask as a IRC server and which use
324 "virtual users" to communicate with, for example "NickServ" and "ChanServ",
325 you should set this parameter to something like "*Serv".
326 .SH [CHANNEL]
327 Pre-defined channels can be configured in
328 .I [Channel]
329 sections. Such channels are created by the server when starting up and even
330 persist when there are no more members left.
331 .PP
332 Persistent channels are marked with the mode 'P', which can be set and unset
333 by IRC operators like other modes on the fly.
334 .PP
335 There may be more than one
336 .I [Channel]
337 block.
338 .TP
339 \fBName\fR
340 Name of the channel, including channel prefix ("#" or "&").
341 .TP
342 \fBTopic\fR
343 Topic for this channel.
344 .TP
345 \fBModes\fR
346 Initial channel modes.
347 .TP
348 \fBKey\fR
349 Sets initial channel key (only relevant if channel mode "k" is set).
350 .TP
351 \fBKeyFile\fR
352 Path and file name of a "key file" containing individual channel keys for
353 different users. The file consists of plain text lines with the following
354 syntax (without spaces!):
355 .PP
356 .RS
357 .RS
358 .I user
359 :
360 .I nick
361 :
362 .I key
363 .RE
364 .PP
365 .I user
366 and
367 .I nick
368 can contain the wildcard character "*".
369 .br
370 .I key
371 is an arbitrary password.
372 .PP
373 Valid examples are:
374 .PP
375 .RS
376 *:*:KeY
377 .br
378 *:nick:123
379 .br
380 ~user:*:xyz
381 .RE
382 .PP
383 The key file is read on each JOIN command when this channel has a key
384 (channel mode +k). Access is granted, if a) the channel key set using the
385 MODE +k command or b) one of the lines in the key file match.
386 .PP
387 .B Please note:
388 .br
389 The file is not reopened on each access, so you can modify and overwrite it
390 without problems, but moving or deleting the file will have not effect until
391 the daemon re-reads its configuration!
392 .RE
393 .TP
394 \fBMaxUsers\fR
395 Set maximum user limit for this channel (only relevant if channel mode "l"
396 is set).
397 .SH HINTS
398 It's wise to use "ngircd \-\-configtest" to validate the configuration file
399 after changing it. See
400 .BR ngircd (8)
401 for details.
402 .SH AUTHOR
403 Alexander Barton,
404 .UR mailto:alex@barton.de
405 .UE
406 .br
407 Homepage:
408 .UR http://ngircd.barton.de/
409 .UE
410 .SH "SEE ALSO"
411 .BR ngircd (8)
412 .\"
413 .\" -eof-