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