Merge branch 'master' of git://
[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 "August 2005" ngircd "ngIRCd Manual"
6 ngircd.conf \- configuration file of ngIRCd
8 .B :ETCDIR:/ngircd.conf
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.
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.
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.
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 \fBListenIPv4\fR
162 Set this to no if you do not want ngircd to accept clients using the standard internet protocol, ipv4.
163 This allows use of ngircd in ipv6-only setups.
164 Default: Yes.
165 .TP
166 \fBListenIPv6\fR
167 Set this to no if you do not want ngircd to accept clients using the new internet protocol, ipv6.
168 Default: Yes.
169 .TP
170 \fBConnectIPv4\fR
171 Set this to no if you do not want ngircd to connect to other irc servers using ipv4.
172 This allows use of ngircd in ipv6-only setups.
173 Default: Yes.
174 .TP
175 \fBConnectIPv6\fR
176 Set this to no if you do not want ngircd to connect to other irc servers using ipv6.
177 Default: Yes.
178 .TP
179 \fBMaxConnections\fR
180 Maximum number of simultaneous connection the server is allowed to accept
181 (0: unlimited). Default: 0.
182 .TP
183 \fBMaxConnectionsIP\fR
184 Maximum number of simultaneous connections from a single IP address that
185 the server will accept (0: unlimited). This configuration options lowers
186 the risk of denial of service attacks (DoS). Default: 5.
187 .TP
188 \fBMaxJoins\fR
189 Maximum number of channels a user can be member of (0: no limit).
190 Default: 10.
191 .TP
192 \fBMaxNickLength\fR
193 Maximum length of an user nick name (Default: 9, as in RFC 2812). Please
194 note that all servers in an IRC network MUST use the same maximum nick name
195 length!
197 .I [Operator]
198 sections are used to define IRC Operators. There may be more than one
199 .I [Operator]
200 block, one for each local operator.
201 .TP
202 \fBName\fR
203 ID of the operator (may be different of the nick name).
204 .TP
205 \fBPassword\fR
206 Password of the IRC operator.
207 .TP
208 \fBMask\fR
209 Mask that is to be checked before an /OPER for this account is accepted.
210 Example: nick!ident@*
211 .SH [SERVER]
212 Other servers are configured in
213 .I [Server]
214 sections. If you configure a port for the connection, then this ngIRCd
215 tries to connect to to the other server on the given port; if not, it waits
216 for the other server to connect.
217 .PP
218 The ngIRCd allows "server groups": You can assign an "ID" to every server
219 with which you want this ngIRCd to link. If a server of a group won't
220 answer, the ngIRCd tries to connect to the next server in the given group.
221 But ngIRCd never tries to connect to two servers with the same group ID.
222 .PP
223 There may be more than one
224 .I [Server]
225 block.
226 .TP
227 \fBName\fR
228 IRC name of the server
229 .TP
230 \fBHost\fR
231 Internet host name of the peer
232 .TP
233 \fBBind\fR
234 IP address to use as source IP for the outgoing connection. Default ist
235 to let the operating system decide.
236 .TP
237 \fBPort\fR
238 Port of the server to which the ngIRCd should connect. If you assign no port
239 the ngIRCd waits for incoming connections.
240 .TP
241 \fBMyPassword\fR
242 Own password for this connection. This password has to be configured as
243 "PeerPassword" on the other server. Must not have ':' as first character.
244 .TP
245 \fBPeerPassword\fR
246 Foreign password for this connection. This password has to be configured as
247 "MyPassword" on the other server.
248 .TP
249 \fBGroup\fR
250 Group of this server (optional).
251 \fBPassive\fR
252 Disable automatic connection even if port value is specified. Default: false.
253 You can use the IRC Operator command CONNECT later on to create the link.
255 Pre-defined channels can be configured in
256 .I [Channel]
257 sections. Such channels are created by the server when starting up and even
258 persist when there are no more members left.
259 .PP
260 Persistent channels are marked with the mode 'P', which can be set and unset
261 by IRC operators like other modes on the fly.
262 .PP
263 There may be more than one
264 .I [Channel]
265 block.
266 .TP
267 \fBName\fR
268 Name of the channel
269 .TP
270 \fBTopic\fR
271 Topic for this channel
272 .TP
273 \fBModes\fR
274 Initial channel modes.
275 .TP
276 \fBKey\fR
277 Sets initial channel key (only relevant if mode k is set)
278 .TP
279 \fBMaxUsers\fR
280 Set maximum user limit for this channel (only relevant if mode l is set)
282 It's wise to use "ngircd --configtest" to validate the configuration file
283 after changing it. See
284 .BR ngircd (8)
285 for details.
287 Alexander Barton,
288 .UR
290 .UE
291 .br
292 Homepage:
293 .UR
295 .UE
296 .SH "SEE ALSO"
297 .BR ngircd (8)
298 .\"
299 .\" -eof-