man/ngircd.conf.5.tmpl

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