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