2 2275add3 2007-06-28 fw .\" $Id: ngircd.conf.5.tmpl,v 1.3 2007/06/28 05:15:14 fw Exp $
4 f6ce2d55 2006-12-25 alex .TH ngircd.conf 5 "August 2005" ngircd "ngIRCd Manual"
6 f6ce2d55 2006-12-25 alex ngircd.conf \- configuration file of ngIRCd
8 f6ce2d55 2006-12-25 alex .B :ETCDIR:/ngircd.conf
9 f6ce2d55 2006-12-25 alex .SH DESCRIPTION
10 f6ce2d55 2006-12-25 alex .BR ngircd.conf
11 f6ce2d55 2006-12-25 alex is the configuration file of the
12 f6ce2d55 2006-12-25 alex .BR ngircd (8)
13 f6ce2d55 2006-12-25 alex Internet Relay Chat (IRC) daemon which you should adept to your local
14 f6ce2d55 2006-12-25 alex preferences and needs.
15 f6ce2d55 2006-12-25 alex .SH "FILE FORMAT"
16 f6ce2d55 2006-12-25 alex The file consists of sections and parameters. A section begins with the name
17 f6ce2d55 2006-12-25 alex of the section in square brackets and continues until the next section
20 f6ce2d55 2006-12-25 alex Sections contain parameters of the form
28 f6ce2d55 2006-12-25 alex Empty lines and any line beginning with a semicolon (';') or a hash ('#')
29 f6ce2d55 2006-12-25 alex character is treated as a comment and will be ignored.
31 f6ce2d55 2006-12-25 alex The file format is line-based - that means, each newline-terminated line
32 f6ce2d55 2006-12-25 alex represents either a comment, a section name or a parameter.
34 f6ce2d55 2006-12-25 alex Section and parameter names are not case sensitive.
35 f6ce2d55 2006-12-25 alex .SH "SECTION OVERVIEW"
36 f6ce2d55 2006-12-25 alex The file can contain blocks of four types: [Global], [Operator], [Server],
37 f6ce2d55 2006-12-25 alex and [Channel].
41 f6ce2d55 2006-12-25 alex section, there is the main configuration like the server name and the
42 f6ce2d55 2006-12-25 alex ports on which the server should be listening. IRC operators of this
43 f6ce2d55 2006-12-25 alex server are defined in
44 f6ce2d55 2006-12-25 alex .I [Operator]
47 f6ce2d55 2006-12-25 alex is the section where server links are configured. And
48 f6ce2d55 2006-12-25 alex .I [Channel]
49 f6ce2d55 2006-12-25 alex blocks are used to configure pre-defined ("persistent") IRC channels.
51 f6ce2d55 2006-12-25 alex There can be more than one [Operator], [Server] and [Channel] sections
52 f6ce2d55 2006-12-25 alex per configuration file, but only one [Global] section.
53 f6ce2d55 2006-12-25 alex .SH [GLOBAL]
56 f6ce2d55 2006-12-25 alex section is used to define the server main configuration, like the server
57 f6ce2d55 2006-12-25 alex name and the ports on which the server should be listening.
60 f6ce2d55 2006-12-25 alex Server name in the IRC network
63 f6ce2d55 2006-12-25 alex Info text of the server. This will be shown by WHOIS and LINKS requests for
66 f6ce2d55 2006-12-25 alex \fBAdminInfo1\fR, \fBAdminInfo2\fR, \fBAdminEMail\fR
67 f6ce2d55 2006-12-25 alex Information about the server and the administrator, used by the ADMIN
71 f6ce2d55 2006-12-25 alex Ports on which the server should listen. There may be more than one port,
72 f6ce2d55 2006-12-25 alex separated with ','. Default: 6667.
74 f6ce2d55 2006-12-25 alex \fBListen\fR
75 f6ce2d55 2006-12-25 alex The IP address on which the server should listen. Default is empty, so
76 f6ce2d55 2006-12-25 alex the server listens on all configured IP addresses and interfaces.
78 f6ce2d55 2006-12-25 alex \fBMotdFile\fR
79 f6ce2d55 2006-12-25 alex Text file with the "message of the day" (MOTD). This message will be shown
80 f6ce2d55 2006-12-25 alex to all users connecting to the server.
82 f6ce2d55 2006-12-25 alex \fBMotdPhrase\fR
83 f6ce2d55 2006-12-25 alex A simple Phrase (<256 chars) if you don't want to use a MOTD file.
84 f6ce2d55 2006-12-25 alex If it is set no MotdFile will be read at all.
86 f6ce2d55 2006-12-25 alex \fBServerUID\fR
87 f6ce2d55 2006-12-25 alex User ID under which the server should run; you can use the name of the user
88 f6ce2d55 2006-12-25 alex or the numerical ID.
91 f6ce2d55 2006-12-25 alex .B Attention:
93 f6ce2d55 2006-12-25 alex For this to work the server must have been
94 f6ce2d55 2006-12-25 alex started with root privileges! In addition, the configuration and MOTD files
95 f6ce2d55 2006-12-25 alex must be readable by this user, otherwise RESTART and REHASH won't work!
98 f6ce2d55 2006-12-25 alex \fBServerGID\fR
99 f6ce2d55 2006-12-25 alex Group ID under which the ngIRCd should run; you can use the name of the
100 f6ce2d55 2006-12-25 alex group or the numerical ID.
103 f6ce2d55 2006-12-25 alex .B Attention:
105 f6ce2d55 2006-12-25 alex For this to work the server must have
106 f6ce2d55 2006-12-25 alex been started with root privileges!
109 f6ce2d55 2006-12-25 alex \fBChrootDir\fR
110 f6ce2d55 2006-12-25 alex A directory to chroot in when everything is initialized. It doesn't need
111 f6ce2d55 2006-12-25 alex to be populated if ngIRCd is compiled as a static binary. By default ngIRCd
112 f6ce2d55 2006-12-25 alex won't use the chroot() feature.
115 f6ce2d55 2006-12-25 alex .B Attention:
117 f6ce2d55 2006-12-25 alex For this to work the server must have
118 f6ce2d55 2006-12-25 alex been started with root privileges!
121 f6ce2d55 2006-12-25 alex \fBPidFile\fR
122 f6ce2d55 2006-12-25 alex This tells ngIRCd to write its current process ID to a file. Note that the
123 f6ce2d55 2006-12-25 alex pidfile is written AFTER chroot and switching the user ID, i. e. the
124 f6ce2d55 2006-12-25 alex directory the pidfile resides in must be writeable by the ngIRCd user and
125 f6ce2d55 2006-12-25 alex exist in the chroot directory (if configured, see above).
128 f6ce2d55 2006-12-25 alex \fBPingTimeout\fR
129 f6ce2d55 2006-12-25 alex After <PingTimeout> seconds of inactivity the server will send a PING to
130 f6ce2d55 2006-12-25 alex the peer to test whether it is alive or not. Default: 120.
132 f6ce2d55 2006-12-25 alex \fBPongTimeout\fR
133 f6ce2d55 2006-12-25 alex If a client fails to answer a PING with a PONG within <PongTimeout>
134 f6ce2d55 2006-12-25 alex seconds, it will be disconnected by the server. Default: 20.
136 f6ce2d55 2006-12-25 alex \fBConnectRetry\fR
137 f6ce2d55 2006-12-25 alex The server tries every <ConnectRetry> seconds to establish a link to not yet
138 f6ce2d55 2006-12-25 alex (or no longer) connected servers. Default: 60.
140 f6ce2d55 2006-12-25 alex \fBOperCanUseMode\fR
141 f6ce2d55 2006-12-25 alex Should IRC Operators be allowed to use the MODE command even if they are
142 f6ce2d55 2006-12-25 alex not(!) channel-operators? Default: no.
144 f6ce2d55 2006-12-25 alex \fBOperServerMode\fR
145 f6ce2d55 2006-12-25 alex If OperCanUseMode is enabled, this may lead the compatibility problems with
146 f6ce2d55 2006-12-25 alex Servers that run the ircd-irc2 Software. This Option "masks" mode requests
147 f6ce2d55 2006-12-25 alex by non-chanops as if they were coming from the server. Default: no.
149 f6ce2d55 2006-12-25 alex \fBPredefChannelsOnly\fR
150 f6ce2d55 2006-12-25 alex If enabled, no new channels can be created. Useful if
151 f6ce2d55 2006-12-25 alex you do not want to have channels other than those defined in
152 f6ce2d55 2006-12-25 alex the config file.
154 f6ce2d55 2006-12-25 alex \fBMaxConnections\fR
155 f6ce2d55 2006-12-25 alex Maximum number of simultaneous connection the server is allowed to accept
156 f6ce2d55 2006-12-25 alex (<=0: unlimited). Default: -1.
158 f6ce2d55 2006-12-25 alex \fBMaxConnectionsIP\fR
159 f6ce2d55 2006-12-25 alex Maximum number of simultaneous connections from a single IP address that
160 f6ce2d55 2006-12-25 alex the server will accept (<=0: unlimited). This configuration options lowers
161 f6ce2d55 2006-12-25 alex the risk of denial of service attacks (DoS). Default: 5.
163 f6ce2d55 2006-12-25 alex \fBMaxJoins\fR
164 f6ce2d55 2006-12-25 alex Maximum number of channels a user can be member of (<=0: no limit).
165 f6ce2d55 2006-12-25 alex Default: 10.
166 f6ce2d55 2006-12-25 alex .SH [OPERATOR]
167 f6ce2d55 2006-12-25 alex .I [Operator]
168 f6ce2d55 2006-12-25 alex sections are used to define IRC Operators. There may be more than one
169 f6ce2d55 2006-12-25 alex .I [Operator]
170 f6ce2d55 2006-12-25 alex block, one for each local operator.
173 f6ce2d55 2006-12-25 alex ID of the operator (may be different of the nick name).
175 f6ce2d55 2006-12-25 alex \fBPassword\fR
176 f6ce2d55 2006-12-25 alex Password of the IRC operator.
179 f6ce2d55 2006-12-25 alex Mask that is to be checked before an /OPER for this account is accepted.
180 f6ce2d55 2006-12-25 alex Example: nick!ident@*.example.com
181 f6ce2d55 2006-12-25 alex .SH [SERVER]
182 f6ce2d55 2006-12-25 alex Other servers are configured in
183 f6ce2d55 2006-12-25 alex .I [Server]
184 f6ce2d55 2006-12-25 alex sections. If you configure a port for the connection, then this ngIRCd
185 f6ce2d55 2006-12-25 alex tries to connect to to the other server on the given port; if not, it waits
186 f6ce2d55 2006-12-25 alex for the other server to connect.
188 f6ce2d55 2006-12-25 alex The ngIRCd allows "server groups": You can assign an "ID" to every server
189 f6ce2d55 2006-12-25 alex with which you want this ngIRCd to link. If a server of a group won't
190 f6ce2d55 2006-12-25 alex answer, the ngIRCd tries to connect to the next server in the given group.
191 f6ce2d55 2006-12-25 alex But ngIRCd never tries to connect to two servers with the same group ID.
193 f6ce2d55 2006-12-25 alex There may be more than one
194 f6ce2d55 2006-12-25 alex .I [Server]
198 f6ce2d55 2006-12-25 alex IRC name of the server
201 f6ce2d55 2006-12-25 alex Internet host name of the peer
204 f6ce2d55 2006-12-25 alex Port of the server to which the ngIRCd should connect. If you assign no port
205 f6ce2d55 2006-12-25 alex the ngIRCd waits for incoming connections.
207 f6ce2d55 2006-12-25 alex \fBMyPassword\fR
208 f6ce2d55 2006-12-25 alex Own password for this connection. This password has to be configured as
209 f6ce2d55 2006-12-25 alex "PeerPassword" on the other server. Must not have ':' as first character.
211 f6ce2d55 2006-12-25 alex \fBPeerPassword\fR
212 f6ce2d55 2006-12-25 alex Foreign password for this connection. This password has to be configured as
213 f6ce2d55 2006-12-25 alex "MyPassword" on the other server.
215 f6ce2d55 2006-12-25 alex \fBGroup\fR
216 f6ce2d55 2006-12-25 alex Group of this server (optional).
217 2275add3 2007-06-28 fw \fBPassive\fR
218 2275add3 2007-06-28 fw Disable automatic connection even if port value is specified. Default: false.
219 2275add3 2007-06-28 fw You can use the IRC Operator command CONNECT later on to create the link.
220 f6ce2d55 2006-12-25 alex .SH [CHANNEL]
221 f6ce2d55 2006-12-25 alex Pre-defined channels can be configured in
222 f6ce2d55 2006-12-25 alex .I [Channel]
223 f6ce2d55 2006-12-25 alex sections. Such channels are created by the server when starting up and even
224 f6ce2d55 2006-12-25 alex persist when there are no more members left.
226 f6ce2d55 2006-12-25 alex Persistent channels are marked with the mode 'P', which can be set and unset
227 f6ce2d55 2006-12-25 alex by IRC operators like other modes on the fly.
229 f6ce2d55 2006-12-25 alex There may be more than one
230 f6ce2d55 2006-12-25 alex .I [Channel]
234 f6ce2d55 2006-12-25 alex Name of the channel
236 f6ce2d55 2006-12-25 alex \fBTopic\fR
237 f6ce2d55 2006-12-25 alex Topic for this channel
239 f6ce2d55 2006-12-25 alex \fBModes\fR
240 f6ce2d55 2006-12-25 alex Initial channel modes.
243 1b852fce 2006-12-29 fw Sets initial channel key (only relevant if mode k is set)
245 1b852fce 2006-12-29 fw \fBMaxUsers\fR
246 1b852fce 2006-12-29 fw Set maximum user limit for this channel (only relevant if mode l is set)
248 f6ce2d55 2006-12-25 alex It's wise to use "ngircd --configtest" to validate the configuration file
249 f6ce2d55 2006-12-25 alex after changing it. See
250 f6ce2d55 2006-12-25 alex .BR ngircd (8)
251 f6ce2d55 2006-12-25 alex for details.
253 f6ce2d55 2006-12-25 alex Alexander Barton,
254 f6ce2d55 2006-12-25 alex .UR mailto:alex@barton.de
255 f6ce2d55 2006-12-25 alex alex@barton.de
259 f6ce2d55 2006-12-25 alex .UR http://ngircd.barton.de/
260 f6ce2d55 2006-12-25 alex http://ngircd.barton.de/
262 f6ce2d55 2006-12-25 alex .SH "SEE ALSO"
263 f6ce2d55 2006-12-25 alex .BR ngircd (8)
