71aaa1e0e2e89601739a0c109724f6301e9d57e3
[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 \fBMotdFile\fR
120 Text file with the "message of the day" (MOTD). This message will be shown
121 to all users connecting to the server. Changes made to this file
122 take effect when ngircd is instructed to re-read its configuration file.
123 .TP
124 \fBMotdPhrase\fR
125 A simple Phrase (<256 chars) if you don't want to use a MOTD file.
126 .TP
127 \fBServerUID\fR
128 User ID under which the server should run; you can use the name of the user
129 or the numerical ID.
130 .PP
131 .RS
132 .B Attention:
133 .br
134 For this to work the server must have been
135 started with root privileges! In addition, the configuration and MOTD files
136 must be readable by this user, otherwise RESTART and REHASH won't work!
137 .RE
138 .TP
139 \fBServerGID\fR
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
147 been started with root privileges!
148 .RE
149 .TP
150 \fBChrootDir\fR
151 A directory to chroot in when everything is initialized. It doesn't need
152 to be populated if ngIRCd is compiled as a static binary. By default ngIRCd
153 won't use the chroot() feature.
154 .PP
155 .RS
156 .B Attention:
157 .br
158 For this to work the server must have
159 been started with root privileges!
160 .RE
161 .TP
162 \fBPidFile\fR
163 This tells ngIRCd to write its current process ID to a file. Note that the
164 pidfile is written AFTER chroot and switching the user ID, i. e. the
165 directory the pidfile resides in must be writeable by the ngIRCd user and
166 exist in the chroot directory (if configured, see above).
167 .RE
168 .TP
169 \fBPingTimeout\fR
170 After <PingTimeout> seconds of inactivity the server will send a PING to
171 the peer to test whether it is alive or not. Default: 120.
172 .TP
173 \fBPongTimeout\fR
174 If a client fails to answer a PING with a PONG within <PongTimeout>
175 seconds, it will be disconnected by the server. Default: 20.
176 .TP
177 \fBConnectRetry\fR
178 The server tries every <ConnectRetry> seconds to establish a link to not yet
179 (or no longer) connected servers. Default: 60.
180 .TP
181 \fBOperCanUseMode\fR
182 Should IRC Operators be allowed to use the MODE command even if they are
183 not(!) channel-operators? Default: no.
184 .TP
185 \fBOperServerMode\fR
186 If \fBOperCanUseMode\fR is enabled, this may lead the compatibility problems with
187 Servers that run the ircd-irc2 Software. This Option "masks" mode requests
188 by non-chanops as if they were coming from the server. Default: no.
189 .TP
190 \fBAllowRemoteOper\fR
191 Are IRC operators connected to remote servers allowed to control this server,
192 e. g. are they allowed to use administrative commands like CONNECT, DIE,
193 SQUIT, ... that affect this server? Default: no.
194 .TP
195 \fBPredefChannelsOnly\fR
196 If enabled, no new channels can be created. Useful if
197 you do not want to have channels other than those defined in
198 [Channel] sections in the configuration file.
199 Default: no.
200 .TP
201 \fBNoDNS\fR
202 If set to true, ngIRCd will not make DNS lookups when clients connect.
203 If you configure the daemon to connect to other servers, ngIRCd may still
204 perform a DNS lookup if required.
205 Default: no.
206 .TP
207 \fBNoIdent\fR
208 If ngIRCd is compiled with IDENT support this can be used to disable IDENT
209 lookups at run time.
210 Default: no.
211 .TP
212 \fBNoPAM\fR
213 If ngIRCd is compiled with PAM support this can be used to disable all calls
214 to the PAM library at runtime; all users connecting without password are
215 allowed to connect, all passwords given will fail.
216 Default: no.
217 .TP
218 \fBConnectIPv4\fR
219 Set this to no if you do not want ngIRCd to connect to other IRC servers using
220 IPv4. This allows usage of ngIRCd in IPv6-only setups.
221 Default: yes.
222 .TP
223 \fBConnectIPv6\fR
224 Set this to no if you do not want ngIRCd to connect to other irc servers using IPv6.
225 Default: yes.
226 .TP
227 \fBMaxConnections\fR
228 Maximum number of simultaneous in- and outbound connections the server is
229 allowed to accept (0: unlimited). Default: 0.
230 .TP
231 \fBMaxConnectionsIP\fR
232 Maximum number of simultaneous connections from a single IP address that
233 the server will accept (0: unlimited). This configuration options lowers
234 the risk of denial of service attacks (DoS). Default: 5.
235 .TP
236 \fBMaxJoins\fR
237 Maximum number of channels a user can be member of (0: no limit).
238 Default: 10.
239 .TP
240 \fBMaxNickLength\fR
241 Maximum length of an user nick name (Default: 9, as in RFC 2812). Please
242 note that all servers in an IRC network MUST use the same maximum nick name
243 length!
244 .SH [OPERATOR]
245 .I [Operator]
246 sections are used to define IRC Operators. There may be more than one
247 .I [Operator]
248 block, one for each local operator.
249 .TP
250 \fBName\fR
251 ID of the operator (may be different of the nick name).
252 .TP
253 \fBPassword\fR
254 Password of the IRC operator.
255 .TP
256 \fBMask\fR
257 Mask that is to be checked before an /OPER for this account is accepted.
258 Example: nick!ident@*.example.com
259 .SH [SERVER]
260 Other servers are configured in
261 .I [Server]
262 sections. If you configure a port for the connection, then this ngIRCd
263 tries to connect to to the other server on the given port (active);
264 if not, it waits for the other server to connect (passive).
265 .PP
266 ngIRCd supports "server groups": You can assign an "ID" to every server
267 with which you want this ngIRCd to link, and the daemon ensures that at
268 any given time only one direct link exists to servers with the same ID.
269 So if a server of a group won't answer, ngIRCd tries to connect to the next
270 server in the given group (="with the same ID"), but never tries to connect
271 to more than one server of this group simultaneously.
272 .PP
273 There may be more than one
274 .I [Server]
275 block.
276 .TP
277 \fBName\fR
278 IRC name of the remote server.
279 .TP
280 \fBHost\fR
281 Internet host name (or IP address) of the peer.
282 .TP
283 \fBBind\fR
284 IP address to use as source IP for the outgoing connection. Default is
285 to let the operating system decide.
286 .TP
287 \fBPort\fR
288 Port of the remote server to which ngIRCd should connect (active).
289 If no port is assigned to a configured server, the daemon only waits for
290 incoming connections (passive, default).
291 .TP
292 \fBMyPassword\fR
293 Own password for this connection. This password has to be configured as
294 \fBPeerPassword\fR on the other server. Must not have ':' as first character.
295 .TP
296 \fBPeerPassword\fR
297 Foreign password for this connection. This password has to be configured as
298 \fBMyPassword\fR on the other server.
299 .TP
300 \fBGroup\fR
301 Group of this server (optional).
302 .TP
303 \fBPassive\fR
304 Disable automatic connection even if port value is specified. Default: false.
305 You can use the IRC Operator command CONNECT later on to create the link.
306 .TP
307 \fBSSLConnect\fR
308 Connect to the remote server using TLS/SSL. Default: false.
309 .TP
310 \fBServiceMask\fR
311 Define a (case insensitive) mask matching nick names that should be treated as
312 IRC services when introduced via this remote server. REGULAR SERVERS DON'T NEED
313 this parameter, so leave it empty (which is the default).
314 .PP
315 .RS
316 When you are connecting IRC services which mask as a IRC server and which use
317 "virtual users" to communicate with, for example "NickServ" and "ChanServ",
318 you should set this parameter to something like "*Serv".
319 .SH [CHANNEL]
320 Pre-defined channels can be configured in
321 .I [Channel]
322 sections. Such channels are created by the server when starting up and even
323 persist when there are no more members left.
324 .PP
325 Persistent channels are marked with the mode 'P', which can be set and unset
326 by IRC operators like other modes on the fly.
327 .PP
328 There may be more than one
329 .I [Channel]
330 block.
331 .TP
332 \fBName\fR
333 Name of the channel, including channel prefix ("#" or "&").
334 .TP
335 \fBTopic\fR
336 Topic for this channel.
337 .TP
338 \fBModes\fR
339 Initial channel modes.
340 .TP
341 \fBKey\fR
342 Sets initial channel key (only relevant if channel mode "k" is set).
343 .TP
344 \fBKeyFile\fR
345 Path and file name of a "key file" containing individual channel keys for
346 different users. The file consists of plain text lines with the following
347 syntax (without spaces!):
348 .PP
349 .RS
350 .RS
351 .I user
352 :
353 .I nick
354 :
355 .I key
356 .RE
357 .PP
358 .I user
359 and
360 .I nick
361 can contain the wildcard character "*".
362 .br
363 .I key
364 is an arbitrary password.
365 .PP
366 Valid examples are:
367 .PP
368 .RS
369 *:*:KeY
370 .br
371 *:nick:123
372 .br
373 ~user:*:xyz
374 .RE
375 .PP
376 The key file is read on each JOIN command when this channel has a key
377 (channel mode +k). Access is granted, if a) the channel key set using the
378 MODE +k command or b) one of the lines in the key file match.
379 .PP
380 .B Please note:
381 .br
382 The file is not reopened on each access, so you can modify and overwrite it
383 without problems, but moving or deleting the file will have not effect until
384 the daemon re-reads its configuration!
385 .RE
386 .TP
387 \fBMaxUsers\fR
388 Set maximum user limit for this channel (only relevant if channel mode "l"
389 is set).
390 .SH HINTS
391 It's wise to use "ngircd \-\-configtest" to validate the configuration file
392 after changing it. See
393 .BR ngircd (8)
394 for details.
395 .SH AUTHOR
396 Alexander Barton,
397 .UR mailto:alex@barton.de
398 .UE
399 .br
400 Homepage:
401 .UR http://ngircd.barton.de/
402 .UE
403 .SH "SEE ALSO"
404 .BR ngircd (8)
405 .\"
406 .\" -eof-