Add new server config option to disable automatic connect. (Tassilo Schweyer)
[ngircd-alex.git] / man / ngircd.conf.5.tmpl
1 .\"
2 .\" $Id: ngircd.conf.5.tmpl,v 1.3 2007/06/28 05:15:14 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 .TP
154 \fBMaxConnections\fR
155 Maximum number of simultaneous connection the server is allowed to accept
156 (<=0: unlimited). Default: -1.
157 .TP
158 \fBMaxConnectionsIP\fR
159 Maximum number of simultaneous connections from a single IP address that
160 the server will accept (<=0: unlimited). This configuration options lowers
161 the risk of denial of service attacks (DoS). Default: 5.
162 .TP
163 \fBMaxJoins\fR
164 Maximum number of channels a user can be member of (<=0: no limit).
165 Default: 10.
166 .SH [OPERATOR]
167 .I [Operator]
168 sections are used to define IRC Operators. There may be more than one
169 .I [Operator]
170 block, one for each local operator.
171 .TP
172 \fBName\fR
173 ID of the operator (may be different of the nick name).
174 .TP
175 \fBPassword\fR
176 Password of the IRC operator.
177 .TP
178 \fBMask\fR
179 Mask that is to be checked before an /OPER for this account is accepted.
180 Example: nick!ident@*.example.com
181 .SH [SERVER]
182 Other servers are configured in
183 .I [Server]
184 sections. If you configure a port for the connection, then this ngIRCd
185 tries to connect to to the other server on the given port; if not, it waits
186 for the other server to connect.
187 .PP
188 The ngIRCd allows "server groups": You can assign an "ID" to every server
189 with which you want this ngIRCd to link. If a server of a group won't
190 answer, the ngIRCd tries to connect to the next server in the given group.
191 But ngIRCd never tries to connect to two servers with the same group ID.
192 .PP
193 There may be more than one
194 .I [Server]
195 block.
196 .TP
197 \fBName\fR
198 IRC name of the server
199 .TP
200 \fBHost\fR
201 Internet host name of the peer
202 .TP
203 \fBPort\fR
204 Port of the server to which the ngIRCd should connect. If you assign no port
205 the ngIRCd waits for incoming connections.
206 .TP
207 \fBMyPassword\fR
208 Own password for this connection. This password has to be configured as
209 "PeerPassword" on the other server. Must not have ':' as first character.
210 .TP
211 \fBPeerPassword\fR
212 Foreign password for this connection. This password has to be configured as
213 "MyPassword" on the other server.
214 .TP
215 \fBGroup\fR
216 Group of this server (optional).
217 \fBPassive\fR
218 Disable automatic connection even if port value is specified. Default: false.
219 You can use the IRC Operator command CONNECT later on to create the link.
220 .SH [CHANNEL]
221 Pre-defined channels can be configured in
222 .I [Channel]
223 sections. Such channels are created by the server when starting up and even
224 persist when there are no more members left.
225 .PP
226 Persistent channels are marked with the mode 'P', which can be set and unset
227 by IRC operators like other modes on the fly.
228 .PP
229 There may be more than one
230 .I [Channel]
231 block.
232 .TP
233 \fBName\fR
234 Name of the channel
235 .TP
236 \fBTopic\fR
237 Topic for this channel
238 .TP
239 \fBModes\fR
240 Initial channel modes.
241 .TP
242 \fBKey\fR
243 Sets initial channel key (only relevant if mode k is set)
244 .TP
245 \fBMaxUsers\fR
246 Set maximum user limit for this channel (only relevant if mode l is set)
247 .SH HINTS
248 It's wise to use "ngircd --configtest" to validate the configuration file
249 after changing it. See
250 .BR ngircd (8)
251 for details.
252 .SH AUTHOR
253 Alexander Barton,
254 .UR mailto:alex@barton.de
255 alex@barton.de
256 .UE
257 .br
258 Homepage:
259 .UR http://ngircd.barton.de/
260 http://ngircd.barton.de/
261 .UE
262 .SH "SEE ALSO"
263 .BR ngircd (8)
264 .\"
265 .\" -eof-