8321900926d6218ec9ffb7ad34a3166a90f608dd
[ngircd-alex.git] / man / ngircd.conf.5.tmpl
1 .\"
2 .\" $Id: ngircd.conf.5.tmpl,v 1.5 2007/10/25 11:01:19 fw Exp $
3 .\"
4 .TH ngircd.conf 5 "August 2005" 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 is treated as a comment and will be ignored.
30 .PP
31 The file format is line-based - that means, each newline-terminated line
32 represents either a comment, a section name or a parameter.
33 .PP
34 Section and parameter names are not case sensitive.
35 .SH "SECTION OVERVIEW"
36 The file can contain blocks of four types: [Global], [Operator], [Server],
37 and [Channel].
38 .PP
39 In the
40 .I [Global]
41 section, there is the main configuration like the server name and the
42 ports on which the server should be listening. IRC operators of this
43 server are defined in
44 .I [Operator]
45 blocks.
46 .I [Server]
47 is the section where server links are configured. And
48 .I [Channel]
49 blocks are used to configure pre-defined ("persistent") IRC channels.
50 .PP
51 There can be more than one [Operator], [Server] and [Channel] sections
52 per configuration file, but only one [Global] section.
53 .SH [GLOBAL]
54 The
55 .I [Global]
56 section is used to define the server main configuration, like the server
57 name and the ports on which the server should be listening.
58 .TP
59 \fBName\fR
60 Server name in the IRC network
61 .TP
62 \fBInfo\fR
63 Info text of the server. This will be shown by WHOIS and LINKS requests for
64 example.
65 .TP
66 \fBAdminInfo1\fR, \fBAdminInfo2\fR, \fBAdminEMail\fR
67 Information about the server and the administrator, used by the ADMIN
68 command.
69 .TP
70 \fBPorts\fR
71 Ports on which the server should listen. There may be more than one port,
72 separated with ','. Default: 6667.
73 .TP
74 \fBListen\fR
75 The IP address on which the server should listen. Default is empty, so
76 the server listens on all configured IP addresses and interfaces.
77 .TP
78 \fBMotdFile\fR
79 Text file with the "message of the day" (MOTD). This message will be shown
80 to all users connecting to the server.
81 .TP
82 \fBMotdPhrase\fR
83 A simple Phrase (<256 chars) if you don't want to use a MOTD file.
84 If it is set no MotdFile will be read at all.
85 .TP
86 \fBServerUID\fR
87 User ID under which the server should run; you can use the name of the user
88 or the numerical ID.
89 .PP
90 .RS
91 .B Attention:
92 .br
93 For this to work the server must have been
94 started with root privileges! In addition, the configuration and MOTD files
95 must be readable by this user, otherwise RESTART and REHASH won't work!
96 .RE
97 .TP
98 \fBServerGID\fR
99 Group ID under which the ngIRCd should run; you can use the name of the
100 group or the numerical ID.
101 .PP
102 .RS
103 .B Attention:
104 .br
105 For this to work the server must have
106 been started with root privileges!
107 .RE
108 .TP
109 \fBChrootDir\fR
110 A directory to chroot in when everything is initialized. It doesn't need
111 to be populated if ngIRCd is compiled as a static binary. By default ngIRCd
112 won't use the chroot() feature.
113 .PP
114 .RS
115 .B Attention:
116 .br
117 For this to work the server must have
118 been started with root privileges!
119 .RE
120 .TP
121 \fBPidFile\fR
122 This tells ngIRCd to write its current process ID to a file. Note that the
123 pidfile is written AFTER chroot and switching the user ID, i. e. the
124 directory the pidfile resides in must be writeable by the ngIRCd user and
125 exist in the chroot directory (if configured, see above).
126 .RE
127 .TP
128 \fBPingTimeout\fR
129 After <PingTimeout> seconds of inactivity the server will send a PING to
130 the peer to test whether it is alive or not. Default: 120.
131 .TP
132 \fBPongTimeout\fR
133 If a client fails to answer a PING with a PONG within <PongTimeout>
134 seconds, it will be disconnected by the server. Default: 20.
135 .TP
136 \fBConnectRetry\fR
137 The server tries every <ConnectRetry> seconds to establish a link to not yet
138 (or no longer) connected servers. Default: 60.
139 .TP
140 \fBOperCanUseMode\fR
141 Should IRC Operators be allowed to use the MODE command even if they are
142 not(!) channel-operators? Default: no.
143 .TP
144 \fBOperServerMode\fR
145 If OperCanUseMode is enabled, this may lead the compatibility problems with
146 Servers that run the ircd-irc2 Software. This Option "masks" mode requests
147 by non-chanops as if they were coming from the server. Default: no.
148 .TP
149 \fBPredefChannelsOnly\fR
150 If enabled, no new channels can be created. Useful if
151 you do not want to have channels other than those defined in
152 the config file.
153 Default: No.
154 .TP
155 \fBNoDNS\fR
156 If enabled, ngircd will not make DNS lookups when clients connect.
157 If you configure ngircd to connect to other servers, ngircd may still
158 perform a DNS lookup if required.
159 Default: No.
160 .TP
161 \fBMaxConnections\fR
162 Maximum number of simultaneous connection the server is allowed to accept
163 (0: unlimited). Default: 0.
164 .TP
165 \fBMaxConnectionsIP\fR
166 Maximum number of simultaneous connections from a single IP address that
167 the server will accept (0: unlimited). This configuration options lowers
168 the risk of denial of service attacks (DoS). Default: 5.
169 .TP
170 \fBMaxJoins\fR
171 Maximum number of channels a user can be member of (0: no limit).
172 Default: 10.
173 .SH [OPERATOR]
174 .I [Operator]
175 sections are used to define IRC Operators. There may be more than one
176 .I [Operator]
177 block, one for each local operator.
178 .TP
179 \fBName\fR
180 ID of the operator (may be different of the nick name).
181 .TP
182 \fBPassword\fR
183 Password of the IRC operator.
184 .TP
185 \fBMask\fR
186 Mask that is to be checked before an /OPER for this account is accepted.
187 Example: nick!ident@*.example.com
188 .SH [SERVER]
189 Other servers are configured in
190 .I [Server]
191 sections. If you configure a port for the connection, then this ngIRCd
192 tries to connect to to the other server on the given port; if not, it waits
193 for the other server to connect.
194 .PP
195 The ngIRCd allows "server groups": You can assign an "ID" to every server
196 with which you want this ngIRCd to link. If a server of a group won't
197 answer, the ngIRCd tries to connect to the next server in the given group.
198 But ngIRCd never tries to connect to two servers with the same group ID.
199 .PP
200 There may be more than one
201 .I [Server]
202 block.
203 .TP
204 \fBName\fR
205 IRC name of the server
206 .TP
207 \fBHost\fR
208 Internet host name of the peer
209 .TP
210 \fBPort\fR
211 Port of the server to which the ngIRCd should connect. If you assign no port
212 the ngIRCd waits for incoming connections.
213 .TP
214 \fBMyPassword\fR
215 Own password for this connection. This password has to be configured as
216 "PeerPassword" on the other server. Must not have ':' as first character.
217 .TP
218 \fBPeerPassword\fR
219 Foreign password for this connection. This password has to be configured as
220 "MyPassword" on the other server.
221 .TP
222 \fBGroup\fR
223 Group of this server (optional).
224 \fBPassive\fR
225 Disable automatic connection even if port value is specified. Default: false.
226 You can use the IRC Operator command CONNECT later on to create the link.
227 .SH [CHANNEL]
228 Pre-defined channels can be configured in
229 .I [Channel]
230 sections. Such channels are created by the server when starting up and even
231 persist when there are no more members left.
232 .PP
233 Persistent channels are marked with the mode 'P', which can be set and unset
234 by IRC operators like other modes on the fly.
235 .PP
236 There may be more than one
237 .I [Channel]
238 block.
239 .TP
240 \fBName\fR
241 Name of the channel
242 .TP
243 \fBTopic\fR
244 Topic for this channel
245 .TP
246 \fBModes\fR
247 Initial channel modes.
248 .TP
249 \fBKey\fR
250 Sets initial channel key (only relevant if mode k is set)
251 .TP
252 \fBMaxUsers\fR
253 Set maximum user limit for this channel (only relevant if mode l is set)
254 .SH HINTS
255 It's wise to use "ngircd --configtest" to validate the configuration file
256 after changing it. See
257 .BR ngircd (8)
258 for details.
259 .SH AUTHOR
260 Alexander Barton,
261 .UR mailto:alex@barton.de
262 alex@barton.de
263 .UE
264 .br
265 Homepage:
266 .UR http://ngircd.barton.de/
267 http://ngircd.barton.de/
268 .UE
269 .SH "SEE ALSO"
270 .BR ngircd (8)
271 .\"
272 .\" -eof-