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