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