.\"
-.\" $Id: ngircd.conf.5,v 1.9 2003/03/10 00:58:06 alex Exp $
+.\" $Id: ngircd.conf.5,v 1.21 2006/12/11 22:07:09 fw Exp $
.\"
-.TH ngircd.conf 5 "March 2003" ngircd "ngIRCd Manual"
+.TH ngircd.conf 5 "August 2005" ngircd "ngIRCd Manual"
.SH NAME
ngircd.conf \- configuration file of ngIRCd
.SH SYNOPSIS
.B /usr/local/etc/ngircd.conf
.SH DESCRIPTION
.BR ngircd.conf
-is the configuration file for
+is the configuration file of the
.BR ngircd (8)
-which you should adept to your local preferences and needs.
+Internet Relay Chat (IRC) daemon which you should adept to your local
+preferences and needs.
.SH "FILE FORMAT"
The file consists of sections and parameters. A section begins with the name
of the section in square brackets and continues until the next section
.I value
.RE
.PP
-Any line beginning with a semicolon (';') or a hash ('#') character is
-treated as a comment and ignored.
+Empty lines and any line beginning with a semicolon (';') or a hash ('#')
+character is treated as a comment and will be ignored.
.PP
The file format is line-based - that means, each newline-terminated line
represents either a comment, a section name or a parameter.
.PP
Section and parameter names are not case sensitive.
.SH "SECTION OVERVIEW"
-The file is separated in four blocks: [Global], [Operator], [Server],
+The file can contain blocks of four types: [Global], [Operator], [Server],
and [Channel].
.PP
In the
.I [Global]
section, there is the main configuration like the server name and the
-ports, on which the server should be listening. IRC operators of this
+ports on which the server should be listening. IRC operators of this
server are defined in
.I [Operator]
blocks.
is the section where server links are configured. And
.I [Channel]
blocks are used to configure pre-defined ("persistent") IRC channels.
+.PP
+There can be more than one [Operator], [Server] and [Channel] sections
+per configuration file, but only one [Global] section.
.SH [GLOBAL]
The
.I [Global]
.TP
\fBPorts\fR
Ports on which the server should listen. There may be more than one port,
-separated with ';'. Default: 6667.
+separated with ','. Default: 6667.
+.TP
+\fBListen\fR
+The IP address on which the server should listen. Default is empty, so
+the server listens on all configured IP addresses and interfaces.
.TP
\fBMotdFile\fR
Text file with the "message of the day" (MOTD). This message will be shown
to all users connecting to the server.
.TP
+\fBMotdPhrase\fR
+A simple Phrase (<256 chars) if you don't want to use a MOTD file.
+If it is set no MotdFile will be read at all.
+.TP
\fBServerUID\fR
User ID under which the server should run; you can use the name of the user
or the numerical ID.
been started with root privileges!
.RE
.TP
+\fBChrootDir\fR
+A directory to chroot in when everything is initialized. It doesn't need
+to be populated if ngIRCd is compiled as a static binary. By default ngIRCd
+won't use the chroot() feature.
+.PP
+.RS
+.B Attention:
+.br
+For this to work the server must have
+been started with root privileges!
+.RE
+.TP
+\fBPidFile\fR
+This tells ngIRCd to write its current process ID to a file. Note that the
+pidfile is written AFTER chroot and switching the user ID, i. e. the
+directory the pidfile resides in must be writeable by the ngIRCd user and
+exist in the chroot directory (if configured, see above).
+.RE
+.TP
\fBPingTimeout\fR
After <PingTimeout> seconds of inactivity the server will send a PING to
the peer to test whether it is alive or not. Default: 120.
\fBPongTimeout\fR
If a client fails to answer a PING with a PONG within <PongTimeout>
seconds, it will be disconnected by the server. Default: 20.
-.IT
+.TP
\fBConnectRetry\fR
The server tries every <ConnectRetry> seconds to establish a link to not yet
(or no longer) connected servers. Default: 60.
Should IRC Operators be allowed to use the MODE command even if they are
not(!) channel-operators? Default: no.
.TP
+\fBOperServerMode\fR
+If OperCanUseMode is enabled, this may lead the compatibility problems with
+Servers that run the ircd-irc2 Software. This Option "masks" mode requests
+by non-chanops as if they were coming from the server. Default: no.
+.TP
+\fBPredefChannelsOnly\fR
+If enabled, no new channels can be created. Useful if
+you do not want to have channels other than those defined in
+the config file.
+.TP
\fBMaxConnections\fR
Maximum number of simultaneous connection the server is allowed to accept
(<=0: unlimited). Default: -1.
.TP
+\fBMaxConnectionsIP\fR
+Maximum number of simultaneous connections from a single IP address that
+the server will accept (<=0: unlimited). This configuration options lowers
+the risk of denial of service attacks (DoS). Default: 5.
+.TP
\fBMaxJoins\fR
Maximum number of channels a user can be member of (<=0: no limit).
Default: 10.
.TP
\fBPassword\fR
Password of the IRC operator.
+.TP
+\fBMask\fR
+Mask that is to be checked before an /OPER for this account is accepted.
+Example: nick!ident@*.example.com
.SH [SERVER]
Other servers are configured in
.I [Server]
.TP
\fBMyPassword\fR
Own password for this connection. This password has to be configured as
-"PeerPassword" on the other server.
+"PeerPassword" on the other server. Must not have ':' as first character.
.TP
\fBPeerPassword\fR
Foreign password for this connection. This password has to be configured as
.UE
.br
Homepage:
-.UR http://arthur.ath.cx/~alex/ngircd/
-http://arthur.ath.cx/~alex/ngircd/
+.UR http://ngircd.barton.de/
+http://ngircd.barton.de/
.UE
.SH "SEE ALSO"
.BR ngircd (8)
projects / ngircd-alex.git / blobdiff