man/ngircd.conf.5

   1 .\"
   2 .\" $Id: ngircd.conf.5,v 1.18 2005/06/04 13:39:20 alex Exp $
   3 .\"
   4 .TH ngircd.conf 5 "Juni 2005" ngircd "ngIRCd Manual"
   5 .SH NAME
   6 ngircd.conf \- configuration file of ngIRCd
   7 .SH SYNOPSIS
   8 .B /usr/local/etc/ngircd.conf
   9 .SH DESCRIPTION
  10 .BR ngircd.conf
  11 is the configuration file for
  12 .BR ngircd (8)
  13 which you should adept to your local preferences and needs.
  14 .SH "FILE FORMAT"
  15 The file consists of sections and parameters. A section begins with the name
  16 of the section in square brackets and continues until the next section
  17 begins.
  18 .PP
  19 Sections contain parameters of the form
  20 .PP
  21 .RS
  22 .I name
  23 =
  24 .I value
  25 .RE
  26 .PP
  27 Any line beginning with a semicolon (';') or a hash ('#') character is
  28 treated as a comment and ignored.
  29 .PP
  30 The file format is line-based - that means, each newline-terminated line
  31 represents either a comment, a section name or a parameter.
  32 .PP
  33 Section and parameter names are not case sensitive.
  34 .SH "SECTION OVERVIEW"
  35 The file can contain blocks of four types: [Global], [Operator], [Server],
  36 and [Channel].
  37 .PP
  38 In the
  39 .I [Global]
  40 section, there is the main configuration like the server name and the
  41 ports on which the server should be listening. IRC operators of this
  42 server are defined in
  43 .I [Operator]
  44 blocks.
  45 .I [Server]
  46 is the section where server links are configured. And
  47 .I [Channel]
  48 blocks are used to configure pre-defined ("persistent") IRC channels.
  49 .PP
  50 There can be more than one [Operator], [Server] and [Channel] sections
  51 per configuration file, but only one [Global] section.
  52 .SH [GLOBAL]
  53 The
  54 .I [Global]
  55 section is used to define the server main configuration, like the server
  56 name and the ports on which the server should be listening.
  57 .TP
  58 \fBName\fR
  59 Server name in the IRC network
  60 .TP
  61 \fBInfo\fR
  62 Info text of the server. This will be shown by WHOIS and LINKS requests for
  63 example.
  64 .TP
  65 \fBAdminInfo1\fR, \fBAdminInfo2\fR, \fBAdminEMail\fR
  66 Information about the server and the administrator, used by the ADMIN
  67 command.
  68 .TP
  69 \fBPorts\fR
  70 Ports on which the server should listen. There may be more than one port,
  71 separated with ','. Default: 6667.
  72 .TP
  73 \fBListen\fR
  74 The IP address on which the server should listen. Default is empty, so
  75 the server listens on all configured IP addresses and interfaces.
  76 .TP
  77 \fBMotdFile\fR
  78 Text file with the "message of the day" (MOTD). This message will be shown
  79 to all users connecting to the server.
  80 .TP
  81 \fBMotdPhrase\fR
  82 A simple Phrase (<256 chars) if you don't want to use a MOTD file.
  83 If it is set no MotdFile will be read at all.
  84 .TP
  85 \fBServerUID\fR
  86 User ID under which the server should run; you can use the name of the user
  87 or the numerical ID.
  88 .PP
  89 .RS
  90 .B Attention:
  91 .br
  92 For this to work the server must have been
  93 started with root privileges! In addition, the configuration and MOTD files
  94 must be readable by this user, otherwise RESTART and REHASH won't work!
  95 .RE
  96 .TP
  97 \fBServerGID\fR
  98 Group ID under which the ngIRCd should run; you can use the name of the
  99 group or the numerical ID.
 100 .PP
 101 .RS
 102 .B Attention:
 103 .br
 104 For this to work the server must have
 105 been started with root privileges!
 106 .RE
 107 .TP
 108 \fBChrootDir\fR
 109 A directory to chroot in when everything is initialized. It doesn't need
 110 to be populated if ngIRCd is compiled as a static binary. By default ngIRCd
 111 won't use the chroot() feature.
 112 .PP
 113 .RS
 114 .B Attention:
 115 .br
 116 For this to work the server must have
 117 been started with root privileges!
 118 .RE
 119 .TP
 120 \fBPidFile\fR
 121 This tells ngIRCd to write its current process ID to a file. Note that the
 122 pidfile is written AFTER chroot and switching the user ID, i. e. the
 123 directory the pidfile resides in must be writeable by the ngIRCd user and
 124 exist in the chroot directory (if configured, see above).
 125 .RE
 126 .TP
 127 \fBPingTimeout\fR
 128 After <PingTimeout> seconds of inactivity the server will send a PING to
 129 the peer to test whether it is alive or not. Default: 120.
 130 .TP
 131 \fBPongTimeout\fR
 132 If a client fails to answer a PING with a PONG within <PongTimeout>
 133 seconds, it will be disconnected by the server. Default: 20.
 134 .TP
 135 \fBConnectRetry\fR
 136 The server tries every <ConnectRetry> seconds to establish a link to not yet
 137 (or no longer) connected servers. Default: 60.
 138 .TP
 139 \fBOperCanUseMode\fR
 140 Should IRC Operators be allowed to use the MODE command even if they are
 141 not(!) channel-operators? Default: no.
 142 .TP
 143 \fBOperServerMode\fR
 144 If OperCanUseMode is enabled, this may lead the compatibility problems with
 145 Servers that run the ircd-irc2 Software. This Option "masks" mode requests
 146 by non-chanops as if they were coming from the server. Default: no.
 147 .TP
 148 \fBMaxConnections\fR
 149 Maximum number of simultaneous connection the server is allowed to accept
 150 (<=0: unlimited). Default: -1.
 151 .TP
 152 \fBMaxConnectionsIP\fR
 153 Maximum number of simultaneous connections from a single IP address that
 154 the server will accept (<=0: unlimited). This configuration options lowers
 155 the risk of denial of service attacks (DoS). Default: 5.
 156 .TP
 157 \fBMaxJoins\fR
 158 Maximum number of channels a user can be member of (<=0: no limit).
 159 Default: 10.
 160 .SH [OPERATOR]
 161 .I [Operator]
 162 sections are used to define IRC Operators. There may be more than one
 163 .I [Operator]
 164 block, one for each local operator.
 165 .TP
 166 \fBName\fR
 167 ID of the operator (may be different of the nick name).
 168 .TP
 169 \fBPassword\fR
 170 Password of the IRC operator.
 171 .TP
 172 \fBMask\fR
 173 Mask that is to be checked before an /OPER for this account is accepted.
 174 Example: nick!ident@*.example.com
 175 .SH [SERVER]
 176 Other servers are configured in
 177 .I [Server]
 178 sections. If you configure a port for the connection, then this ngIRCd
 179 tries to connect to to the other server on the given port; if not, it waits
 180 for the other server to connect.
 181 .PP
 182 The ngIRCd allows "server groups": You can assign an "ID" to every server
 183 with which you want this ngIRCd to link. If a server of a group won't
 184 answer, the ngIRCd tries to connect to the next server in the given group.
 185 But ngIRCd never tries to connect to two servers with the same group ID.
 186 .PP
 187 There may be more than one
 188 .I [Server]
 189 block.
 190 .TP
 191 \fBName\fR
 192 IRC name of the server
 193 .TP
 194 \fBHost\fR
 195 Internet host name of the peer
 196 .TP
 197 \fBPort\fR
 198 Port of the server to which the ngIRCd should connect. If you assign no port
 199 the ngIRCd waits for incoming connections.
 200 .TP
 201 \fBMyPassword\fR
 202 Own password for this connection. This password has to be configured as
 203 "PeerPassword" on the other server.
 204 .TP
 205 \fBPeerPassword\fR
 206 Foreign password for this connection. This password has to be configured as
 207 "MyPassword" on the other server.
 208 .TP
 209 \fBGroup\fR
 210 Group of this server (optional).
 211 .SH [CHANNEL]
 212 Pre-defined channels can be configured in
 213 .I [Channel]
 214 sections. Such channels are created by the server when starting up and even
 215 persist when there are no more members left.
 216 .PP
 217 Persistent channels are marked with the mode 'P', which can be set and unset
 218 by IRC operators like other modes on the fly.
 219 .PP
 220 There may be more than one
 221 .I [Channel]
 222 block.
 223 .TP
 224 \fBName\fR
 225 Name of the channel
 226 .TP
 227 \fBTopic\fR
 228 Topic for this channel
 229 .TP
 230 \fBModes\fR
 231 Initial channel modes.
 232 .SH HINTS
 233 It's wise to use "ngircd --configtest" to validate the configuration file
 234 after changing it. See
 235 .BR ngircd (8)
 236 for details.
 237 .SH AUTHOR
 238 Alexander Barton,
 239 .UR mailto:alex@barton.de
 240 alex@barton.de
 241 .UE
 242 .br
 243 Homepage:
 244 .UR http://arthur.ath.cx/~alex/ngircd/
 245 http://arthur.ath.cx/~alex/ngircd/
 246 .UE
 247 .SH "SEE ALSO"
 248 .BR ngircd (8)
 249 .\"
 250 .\" -eof-