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