2 .\" ngircd.conf(5) manual page template
4 .TH ngircd.conf 5 "Dec 2008" ngircd "ngIRCd Manual"
6 ngircd.conf \- configuration file of ngIRCd
8 .B :ETCDIR:/ngircd.conf
11 is the configuration file of the
13 Internet Relay Chat (IRC) daemon which you should adept to your local
14 preferences and needs.
16 Most variables can be modified while the ngIRCd daemon is already running:
17 It will reload its configuration when a HUP signal is received.
19 The file consists of sections and parameters. A section begins with the name
20 of the section in square brackets and continues until the next section
23 Sections contain parameters of the form
31 Empty lines and any line beginning with a semicolon (';') or a hash ('#')
32 character are treated as a comment and will be ignored. Leading and trailing
33 whitespaces are trimmed before any processing takes place.
35 The file format is line-based - that means, each non-empty newline-terminated
36 line represents either a comment, a section name, or a parameter.
38 Section and parameter names are not case sensitive.
39 .SH "SECTION OVERVIEW"
40 The file can contain blocks of four types: [Global], [Operator], [Server],
43 The main configuration of the server is stored in the
45 section, like the server name, administrative information and the
46 ports on which the server should be listening. IRC operators of this
51 is the section where server links are configured. And
53 blocks are used to configure pre-defined ("persistent") IRC channels.
55 There can be more than one [Operator], [Server] and [Channel] sections
56 per configuration file, but only one [Global] section.
60 section is used to define the server main configuration, like the server
61 name and the ports on which the server should be listening.
64 Server name in the IRC network. This is an individual name of the IRC
65 server, it is not related to the DNS host name. It must be unique in the
66 IRC network and must contain at least one dot (".") character.
69 Info text of the server. This will be shown by WHOIS and LINKS requests for
73 Global password for all users needed to connect to the server. The default
74 is empty, so no password is required.
77 Password required for using the WEBIRC command used by some Web-to-IRC
78 gateways. If not set or empty, the WEBIRC command can't be used.
81 \fBAdminInfo1\fR, \fBAdminInfo2\fR, \fBAdminEMail\fR
82 Information about the server and the administrator, used by the ADMIN
86 Ports on which the server should listen. There may be more than one port,
87 separated with commas (","). Default: 6667, unless \fBSSL_Ports\fR are also
91 Same as \fBPorts\fR , except that ngIRCd will expect incoming connections
92 to be SSL/TLS encrypted. Common port numbers for SSL-encrypted IRC are 6669
93 and 6697. Default: none.
96 Filename of SSL Server Key to be used for SSL connections. This is required for
99 \fBSSLKeyFilePassword\fR
100 (OpenSSL only:) Password to decrypt private key.
103 Certificate file of the private key.
106 Name of the Diffie-Hellman Parameter file. Can be created with gnutls
107 "certtool \-\-generate-dh-params" or "openssl dhparam".
108 If this file is not present, it will be generated on startup when ngIRCd
109 was compiled with gnutls support (this may take some time). If ngIRCd
110 was compiled with OpenSSL, then (Ephemeral)-Diffie-Hellman Key Exchanges and several
111 Cipher Suites will not be available.
114 A comma separated list of IP address on which the server should listen.
115 If unset, the defaults value is "0.0.0.0" or, if ngIRCd was compiled
116 with IPv6 support, "::,0.0.0.0". So the server listens on all configured
117 IP addresses and interfaces by default.
120 Text file with the "message of the day" (MOTD). This message will be shown
121 to all users connecting to the server.
124 A simple Phrase (<256 chars) if you don't want to use a MOTD file.
125 If this variable is set, no \fBMotdFile\fR will be read at all which can be
126 handy if the daemon should run inside a chroot directory.
129 User ID under which the server should run; you can use the name of the user
135 For this to work the server must have been
136 started with root privileges! In addition, the configuration and MOTD files
137 must be readable by this user, otherwise RESTART and REHASH won't work!
141 Group ID under which the ngIRCd should run; you can use the name of the
142 group or the numerical ID.
147 For this to work the server must have
148 been started with root privileges!
152 A directory to chroot in when everything is initialized. It doesn't need
153 to be populated if ngIRCd is compiled as a static binary. By default ngIRCd
154 won't use the chroot() feature.
159 For this to work the server must have
160 been started with root privileges!
164 This tells ngIRCd to write its current process ID to a file. Note that the
165 pidfile is written AFTER chroot and switching the user ID, i. e. the
166 directory the pidfile resides in must be writeable by the ngIRCd user and
167 exist in the chroot directory (if configured, see above).
171 After <PingTimeout> seconds of inactivity the server will send a PING to
172 the peer to test whether it is alive or not. Default: 120.
175 If a client fails to answer a PING with a PONG within <PongTimeout>
176 seconds, it will be disconnected by the server. Default: 20.
179 The server tries every <ConnectRetry> seconds to establish a link to not yet
180 (or no longer) connected servers. Default: 60.
183 Should IRC Operators be allowed to use the MODE command even if they are
184 not(!) channel-operators? Default: no.
187 If \fBOperCanUseMode\fR is enabled, this may lead the compatibility problems with
188 Servers that run the ircd-irc2 Software. This Option "masks" mode requests
189 by non-chanops as if they were coming from the server. Default: no.
191 \fBAllowRemoteOper\fR
192 Are IRC operators connected to remote servers allowed to control this server,
193 e. g. are they allowed to use administrative commands like CONNECT, DIE,
194 SQUIT, ... that affect this server? Default: no.
196 \fBPredefChannelsOnly\fR
197 If enabled, no new channels can be created. Useful if
198 you do not want to have channels other than those defined in
199 [Channel] sections in the configuration file.
203 If set to true, ngIRCd will not make DNS lookups when clients connect.
204 If you configure the daemon to connect to other servers, ngIRCd may still
205 perform a DNS lookup if required.
209 If ngIRCd is compiled with IDENT support this can be used to disable IDENT
214 If ngIRCd is compiled with PAM support this can be used to disable all calls
215 to the PAM library at runtime; all users connecting without password are
216 allowed to connect, all passwords given will fail.
220 Set this to no if you do not want ngIRCd to connect to other IRC servers using
221 IPv4. This allows usage of ngIRCd in IPv6-only setups.
225 Set this to no if you do not want ngIRCd to connect to other irc servers using IPv6.
229 Maximum number of simultaneous in- and outbound connections the server is
230 allowed to accept (0: unlimited). Default: 0.
232 \fBMaxConnectionsIP\fR
233 Maximum number of simultaneous connections from a single IP address that
234 the server will accept (0: unlimited). This configuration options lowers
235 the risk of denial of service attacks (DoS). Default: 5.
238 Maximum number of channels a user can be member of (0: no limit).
242 Maximum length of an user nick name (Default: 9, as in RFC 2812). Please
243 note that all servers in an IRC network MUST use the same maximum nick name
247 sections are used to define IRC Operators. There may be more than one
249 block, one for each local operator.
252 ID of the operator (may be different of the nick name).
255 Password of the IRC operator.
258 Mask that is to be checked before an /OPER for this account is accepted.
259 Example: nick!ident@*.example.com
261 Other servers are configured in
263 sections. If you configure a port for the connection, then this ngIRCd
264 tries to connect to to the other server on the given port (active);
265 if not, it waits for the other server to connect (passive).
267 ngIRCd supports "server groups": You can assign an "ID" to every server
268 with which you want this ngIRCd to link, and the daemon ensures that at
269 any given time only one direct link exists to servers with the same ID.
270 So if a server of a group won't answer, ngIRCd tries to connect to the next
271 server in the given group (="with the same ID"), but never tries to connect
272 to more than one server of this group simultaneously.
274 There may be more than one
279 IRC name of the remote server.
282 Internet host name (or IP address) of the peer.
285 IP address to use as source IP for the outgoing connection. Default is
286 to let the operating system decide.
289 Port of the remote server to which ngIRCd should connect (active).
290 If no port is assigned to a configured server, the daemon only waits for
291 incoming connections (passive, default).
294 Own password for this connection. This password has to be configured as
295 \fBPeerPassword\fR on the other server. Must not have ':' as first character.
298 Foreign password for this connection. This password has to be configured as
299 \fBMyPassword\fR on the other server.
302 Group of this server (optional).
305 Disable automatic connection even if port value is specified. Default: false.
306 You can use the IRC Operator command CONNECT later on to create the link.
309 Connect to the remote server using TLS/SSL. Default: false.
312 Define a (case insensitive) mask matching nick names that should be treated as
313 IRC services when introduced via this remote server. REGULAR SERVERS DON'T NEED
314 this parameter, so leave it empty (which is the default).
317 When you are connecting IRC services which mask as a IRC server and which use
318 "virtual users" to communicate with, for example "NickServ" and "ChanServ",
319 you should set this parameter to something like "*Serv".
321 Pre-defined channels can be configured in
323 sections. Such channels are created by the server when starting up and even
324 persist when there are no more members left.
326 Persistent channels are marked with the mode 'P', which can be set and unset
327 by IRC operators like other modes on the fly.
329 There may be more than one
334 Name of the channel, including channel prefix ("#" or "&").
337 Topic for this channel.
340 Initial channel modes.
343 Sets initial channel key (only relevant if channel mode "k" is set).
346 Path and file name of a "key file" containing individual channel keys for
347 different users. The file consists of plain text lines with the following
348 syntax (without spaces!):
362 can contain the wildcard character "*".
365 is an arbitrary password.
377 The key file is read on each JOIN command when this channel has a key
378 (channel mode +k). Access is granted, if a) the channel key set using the
379 MODE +k command or b) one of the lines in the key file match.
383 The file is not reopened on each access, so you can modify and overwrite it
384 without problems, but moving or deleting the file will have not effect until
385 the daemon re-reads its configuration!
389 Set maximum user limit for this channel (only relevant if channel mode "l"
392 It's wise to use "ngircd \-\-configtest" to validate the configuration file
393 after changing it. See
398 .UR mailto:alex@barton.de
402 .UR http://ngircd.barton.de/
projects / ngircd-alex.git / blob