man/ngircd.conf.5.tmpl

   1 .\"
   2 .\" ngircd.conf(5) manual page template
   3 .\"
   4 .TH ngircd.conf 5 "Dec 2008" 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 .PP
  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.
  18 .SH "FILE FORMAT"
  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
  21 begins.
  22 .PP
  23 Sections contain parameters of the form
  24 .PP
  25 .RS
  26 .I name
  27 =
  28 .I value
  29 .RE
  30 .PP
  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.
  34 .PP
  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.
  37 .PP
  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],
  41 and [Channel].
  42 .PP
  43 The main configuration of the server is stored in the
  44 .I [Global]
  45 section, like the server name, administrative information and the
  46 ports on which the server should be listening. IRC operators of this
  47 server are defined in
  48 .I [Operator]
  49 blocks.
  50 .I [Server]
  51 is the section where server links are configured. And
  52 .I [Channel]
  53 blocks are used to configure pre-defined ("persistent") IRC channels.
  54 .PP
  55 There can be more than one [Operator], [Server] and [Channel] sections
  56 per configuration file, but only one [Global] section.
  57 .SH [GLOBAL]
  58 The
  59 .I [Global]
  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.
  62 .TP
  63 \fBName\fR
  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.
  67 .TP
  68 \fBInfo\fR
  69 Info text of the server. This will be shown by WHOIS and LINKS requests for
  70 example.
  71 .TP
  72 \fBPassword\fR
  73 Global password for all users needed to connect to the server. The default
  74 is empty, so no password is required.
  75 .TP
  76 \fBWebircPassword\fR
  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.
  79 Default: not set.
  80 .TP
  81 \fBAdminInfo1\fR, \fBAdminInfo2\fR, \fBAdminEMail\fR
  82 Information about the server and the administrator, used by the ADMIN
  83 command.
  84 .TP
  85 \fBPorts\fR
  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
  88 specified.
  89 .TP
  90 \fBSSLPorts\fR
  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.
  94 .TP
  95 \fBSSLKeyFile\fR
  96 Filename of SSL Server Key to be used for SSL connections. This is required for
  97 SSL/TLS support.
  98 .TP
  99 \fBSSLKeyFilePassword\fR
 100 (OpenSSL only:) Password to decrypt private key.
 101 .TP
 102 \fBSSLCertFile\fR
 103 Certificate file of the private key.
 104 .TP
 105 \fBSSLDHFile\fR
 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.
 112 .TP
 113 \fBListen\fR
 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.
 118 .TP
 119 \fBMotdFile\fR
 120 Text file with the "message of the day" (MOTD). This message will be shown
 121 to all users connecting to the server.
 122 .TP
 123 \fBMotdPhrase\fR
 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.
 127 .TP
 128 \fBServerUID\fR
 129 User ID under which the server should run; you can use the name of the user
 130 or the numerical ID.
 131 .PP
 132 .RS
 133 .B Attention:
 134 .br
 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!
 138 .RE
 139 .TP
 140 \fBServerGID\fR
 141 Group ID under which the ngIRCd should run; you can use the name of the
 142 group or the numerical ID.
 143 .PP
 144 .RS
 145 .B Attention:
 146 .br
 147 For this to work the server must have
 148 been started with root privileges!
 149 .RE
 150 .TP
 151 \fBChrootDir\fR
 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.
 155 .PP
 156 .RS
 157 .B Attention:
 158 .br
 159 For this to work the server must have
 160 been started with root privileges!
 161 .RE
 162 .TP
 163 \fBPidFile\fR
 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).
 168 .RE
 169 .TP
 170 \fBPingTimeout\fR
 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.
 173 .TP
 174 \fBPongTimeout\fR
 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.
 177 .TP
 178 \fBConnectRetry\fR
 179 The server tries every <ConnectRetry> seconds to establish a link to not yet
 180 (or no longer) connected servers. Default: 60.
 181 .TP
 182 \fBOperCanUseMode\fR
 183 Should IRC Operators be allowed to use the MODE command even if they are
 184 not(!) channel-operators? Default: no.
 185 .TP
 186 \fBOperServerMode\fR
 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.
 190 .TP
 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.
 195 .TP
 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.
 200 Default: no.
 201 .TP
 202 \fBNoDNS\fR
 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.
 206 Default: no.
 207 .TP
 208 \fBNoIdent\fR
 209 If ngIRCd is compiled with IDENT support this can be used to disable IDENT
 210 lookups at run time.
 211 Default: no.
 212 .TP
 213 \fBConnectIPv4\fR
 214 Set this to no if you do not want ngIRCd to connect to other IRC servers using
 215 IPv4. This allows usage of ngIRCd in IPv6-only setups.
 216 Default: yes.
 217 .TP
 218 \fBConnectIPv6\fR
 219 Set this to no if you do not want ngIRCd to connect to other irc servers using IPv6.
 220 Default: yes.
 221 .TP
 222 \fBMaxConnections\fR
 223 Maximum number of simultaneous in- and outbound connections the server is
 224 allowed to accept (0: unlimited). Default: 0.
 225 .TP
 226 \fBMaxConnectionsIP\fR
 227 Maximum number of simultaneous connections from a single IP address that
 228 the server will accept (0: unlimited). This configuration options lowers
 229 the risk of denial of service attacks (DoS). Default: 5.
 230 .TP
 231 \fBMaxJoins\fR
 232 Maximum number of channels a user can be member of (0: no limit).
 233 Default: 10.
 234 .TP
 235 \fBMaxNickLength\fR
 236 Maximum length of an user nick name (Default: 9, as in RFC 2812). Please
 237 note that all servers in an IRC network MUST use the same maximum nick name
 238 length!
 239 .SH [OPERATOR]
 240 .I [Operator]
 241 sections are used to define IRC Operators. There may be more than one
 242 .I [Operator]
 243 block, one for each local operator.
 244 .TP
 245 \fBName\fR
 246 ID of the operator (may be different of the nick name).
 247 .TP
 248 \fBPassword\fR
 249 Password of the IRC operator.
 250 .TP
 251 \fBMask\fR
 252 Mask that is to be checked before an /OPER for this account is accepted.
 253 Example: nick!ident@*.example.com
 254 .SH [SERVER]
 255 Other servers are configured in
 256 .I [Server]
 257 sections. If you configure a port for the connection, then this ngIRCd
 258 tries to connect to to the other server on the given port (active);
 259 if not, it waits for the other server to connect (passive).
 260 .PP
 261 ngIRCd supports "server groups": You can assign an "ID" to every server
 262 with which you want this ngIRCd to link, and the daemon ensures that at
 263 any given time only one direct link exists to servers with the same ID.
 264 So if a server of a group won't answer, ngIRCd tries to connect to the next
 265 server in the given group (="with the same ID"), but never tries to connect
 266 to more than one server of this group simultaneously.
 267 .PP
 268 There may be more than one
 269 .I [Server]
 270 block.
 271 .TP
 272 \fBName\fR
 273 IRC name of the remote server.
 274 .TP
 275 \fBHost\fR
 276 Internet host name (or IP address) of the peer.
 277 .TP
 278 \fBBind\fR
 279 IP address to use as source IP for the outgoing connection. Default is
 280 to let the operating system decide.
 281 .TP
 282 \fBPort\fR
 283 Port of the remote server to which ngIRCd should connect (active).
 284 If no port is assigned to a configured server, the daemon only waits for
 285 incoming connections (passive, default).
 286 .TP
 287 \fBMyPassword\fR
 288 Own password for this connection. This password has to be configured as
 289 \fBPeerPassword\fR on the other server. Must not have ':' as first character.
 290 .TP
 291 \fBPeerPassword\fR
 292 Foreign password for this connection. This password has to be configured as
 293 \fBMyPassword\fR on the other server.
 294 .TP
 295 \fBGroup\fR
 296 Group of this server (optional).
 297 .TP
 298 \fBPassive\fR
 299 Disable automatic connection even if port value is specified. Default: false.
 300 You can use the IRC Operator command CONNECT later on to create the link.
 301 .TP
 302 \fBSSLConnect\fR
 303 Connect to the remote server using TLS/SSL. Default: false.
 304 .TP
 305 \fBServiceMask\fR
 306 Define a (case insensitive) mask matching nick names that should be treated as
 307 IRC services when introduced via this remote server. REGULAR SERVERS DON'T NEED
 308 this parameter, so leave it empty (which is the default).
 309 .PP
 310 .RS
 311 When you are connecting IRC services which mask as a IRC server and which use
 312 "virtual users" to communicate with, for example "NickServ" and "ChanServ",
 313 you should set this parameter to something like "*Serv".
 314 .SH [CHANNEL]
 315 Pre-defined channels can be configured in
 316 .I [Channel]
 317 sections. Such channels are created by the server when starting up and even
 318 persist when there are no more members left.
 319 .PP
 320 Persistent channels are marked with the mode 'P', which can be set and unset
 321 by IRC operators like other modes on the fly.
 322 .PP
 323 There may be more than one
 324 .I [Channel]
 325 block.
 326 .TP
 327 \fBName\fR
 328 Name of the channel, including channel prefix ("#" or "&").
 329 .TP
 330 \fBTopic\fR
 331 Topic for this channel.
 332 .TP
 333 \fBModes\fR
 334 Initial channel modes.
 335 .TP
 336 \fBKey\fR
 337 Sets initial channel key (only relevant if channel mode "k" is set).
 338 .TP
 339 \fBKeyFile\fR
 340 Path and file name of a "key file" containing individual channel keys for
 341 different users. The file consists of plain text lines with the following
 342 syntax (without spaces!):
 343 .PP
 344 .RS
 345 .RS
 346 .I user
 347 :
 348 .I nick
 349 :
 350 .I key
 351 .RE
 352 .PP
 353 .I user
 354 and
 355 .I nick
 356 can contain the wildcard character "*".
 357 .br
 358 .I key
 359 is an arbitrary password.
 360 .PP
 361 Valid examples are:
 362 .PP
 363 .RS
 364 *:*:KeY
 365 .br
 366 *:nick:123
 367 .br
 368 ~user:*:xyz
 369 .RE
 370 .PP
 371 The key file is read on each JOIN command when this channel has a key
 372 (channel mode +k). Access is granted, if a) the channel key set using the
 373 MODE +k command or b) one of the lines in the key file match.
 374 .PP
 375 .B Please note:
 376 .br
 377 The file is not reopened on each access, so you can modify and overwrite it
 378 without problems, but moving or deleting the file will have not effect until
 379 the daemon re-reads its configuration!
 380 .RE
 381 .TP
 382 \fBMaxUsers\fR
 383 Set maximum user limit for this channel (only relevant if channel mode "l"
 384 is set).
 385 .SH HINTS
 386 It's wise to use "ngircd \-\-configtest" to validate the configuration file
 387 after changing it. See
 388 .BR ngircd (8)
 389 for details.
 390 .SH AUTHOR
 391 Alexander Barton,
 392 .UR mailto:alex@barton.de
 393 .UE
 394 .br
 395 Homepage:
 396 .UR http://ngircd.barton.de/
 397 .UE
 398 .SH "SEE ALSO"
 399 .BR ngircd (8)
 400 .\"
 401 .\" -eof-