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