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