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 \fBAdminInfo1\fR, \fBAdminInfo2\fR, \fBAdminEMail\fR
  77 Information about the server and the administrator, used by the ADMIN
  78 command.
  79 .TP
  80 \fBPorts\fR
  81 Ports on which the server should listen. There may be more than one port,
  82 separated with commas (","). Default: 6667, unless \fBSSL_Ports\fR are also
  83 specified.
  84 .TP
  85 \fBSSLPorts\fR
  86 Same as \fBPorts\fR , except that ngIRCd will expect incoming connections
  87 to be SSL/TLS encrypted. Common port numbers for SSL-encrypted IRC are 6669
  88 and 6697. Default: none.
  89 .TP
  90 \fBSSLKeyFile\fR
  91 Filename of SSL Server Key to be used for SSL connections. This is required for
  92 SSL/TLS support.
  93 .TP
  94 \fBSSLKeyFilePassword\fR
  95 (OpenSSL only:) Password to decrypt private key.
  96 .TP
  97 \fBSSLCertFile\fR
  98 Certificate file of the private key.
  99 .TP
 100 \fBSSLDHFile\fR
 101 Name of the Diffie-Hellman Parameter file. Can be created with gnutls
 102 "certtool \-\-generate-dh-params" or "openssl dhparam".
 103 If this file is not present, it will be generated on startup when ngIRCd
 104 was compiled with gnutls support (this may take some time). If ngIRCd
 105 was compiled with OpenSSL, then (Ephemeral)-Diffie-Hellman Key Exchanges and several
 106 Cipher Suites will not be available.
 107 .TP
 108 \fBListen\fR
 109 A comma separated list of IP address on which the server should listen.
 110 If unset, the defaults value is "0.0.0.0" or, if ngIRCd was compiled
 111 with IPv6 support, "::,0.0.0.0". So the server listens on all configured
 112 IP addresses and interfaces by default.
 113 .TP
 114 \fBMotdFile\fR
 115 Text file with the "message of the day" (MOTD). This message will be shown
 116 to all users connecting to the server.
 117 .TP
 118 \fBMotdPhrase\fR
 119 A simple Phrase (<256 chars) if you don't want to use a MOTD file.
 120 If this variable is set, no \fBMotdFile\fR will be read at all which can be
 121 handy if the daemon should run inside a chroot directory.
 122 .TP
 123 \fBServerUID\fR
 124 User ID under which the server should run; you can use the name of the user
 125 or the numerical ID.
 126 .PP
 127 .RS
 128 .B Attention:
 129 .br
 130 For this to work the server must have been
 131 started with root privileges! In addition, the configuration and MOTD files
 132 must be readable by this user, otherwise RESTART and REHASH won't work!
 133 .RE
 134 .TP
 135 \fBServerGID\fR
 136 Group ID under which the ngIRCd should run; you can use the name of the
 137 group or the numerical ID.
 138 .PP
 139 .RS
 140 .B Attention:
 141 .br
 142 For this to work the server must have
 143 been started with root privileges!
 144 .RE
 145 .TP
 146 \fBChrootDir\fR
 147 A directory to chroot in when everything is initialized. It doesn't need
 148 to be populated if ngIRCd is compiled as a static binary. By default ngIRCd
 149 won't use the chroot() feature.
 150 .PP
 151 .RS
 152 .B Attention:
 153 .br
 154 For this to work the server must have
 155 been started with root privileges!
 156 .RE
 157 .TP
 158 \fBPidFile\fR
 159 This tells ngIRCd to write its current process ID to a file. Note that the
 160 pidfile is written AFTER chroot and switching the user ID, i. e. the
 161 directory the pidfile resides in must be writeable by the ngIRCd user and
 162 exist in the chroot directory (if configured, see above).
 163 .RE
 164 .TP
 165 \fBPingTimeout\fR
 166 After <PingTimeout> seconds of inactivity the server will send a PING to
 167 the peer to test whether it is alive or not. Default: 120.
 168 .TP
 169 \fBPongTimeout\fR
 170 If a client fails to answer a PING with a PONG within <PongTimeout>
 171 seconds, it will be disconnected by the server. Default: 20.
 172 .TP
 173 \fBConnectRetry\fR
 174 The server tries every <ConnectRetry> seconds to establish a link to not yet
 175 (or no longer) connected servers. Default: 60.
 176 .TP
 177 \fBOperCanUseMode\fR
 178 Should IRC Operators be allowed to use the MODE command even if they are
 179 not(!) channel-operators? Default: no.
 180 .TP
 181 \fBOperServerMode\fR
 182 If \fBOperCanUseMode\fR is enabled, this may lead the compatibility problems with
 183 Servers that run the ircd-irc2 Software. This Option "masks" mode requests
 184 by non-chanops as if they were coming from the server. Default: no.
 185 .TP
 186 \fBAllowRemoteOper\fR
 187 Are IRC operators connected to remote servers allowed to control this server,
 188 e. g. are they allowed to use administrative commands like CONNECT, DIE,
 189 SQUIT, ... that affect this server? Default: no.
 190 .TP
 191 \fBPredefChannelsOnly\fR
 192 If enabled, no new channels can be created. Useful if
 193 you do not want to have channels other than those defined in
 194 [Channel] sections in the configuration file.
 195 Default: no.
 196 .TP
 197 \fBNoDNS\fR
 198 If set to true, ngIRCd will not make DNS lookups when clients connect.
 199 If you configure the daemon to connect to other servers, ngIRCd may still
 200 perform a DNS lookup if required.
 201 Default: no.
 202 .TP
 203 \fBNoIdent\fR
 204 If ngIRCd is compiled with IDENT support this can be used to disable IDENT
 205 lookups at run time.
 206 Default: no.
 207 .TP
 208 \fBConnectIPv4\fR
 209 Set this to no if you do not want ngIRCd to connect to other IRC servers using
 210 IPv4. This allows usage of ngIRCd in IPv6-only setups.
 211 Default: yes.
 212 .TP
 213 \fBConnectIPv6\fR
 214 Set this to no if you do not want ngIRCd to connect to other irc servers using IPv6.
 215 Default: yes.
 216 .TP
 217 \fBMaxConnections\fR
 218 Maximum number of simultaneous in- and outbound connections the server is
 219 allowed to accept (0: unlimited). Default: 0.
 220 .TP
 221 \fBMaxConnectionsIP\fR
 222 Maximum number of simultaneous connections from a single IP address that
 223 the server will accept (0: unlimited). This configuration options lowers
 224 the risk of denial of service attacks (DoS). Default: 5.
 225 .TP
 226 \fBMaxJoins\fR
 227 Maximum number of channels a user can be member of (0: no limit).
 228 Default: 10.
 229 .TP
 230 \fBMaxNickLength\fR
 231 Maximum length of an user nick name (Default: 9, as in RFC 2812). Please
 232 note that all servers in an IRC network MUST use the same maximum nick name
 233 length!
 234 .SH [OPERATOR]
 235 .I [Operator]
 236 sections are used to define IRC Operators. There may be more than one
 237 .I [Operator]
 238 block, one for each local operator.
 239 .TP
 240 \fBName\fR
 241 ID of the operator (may be different of the nick name).
 242 .TP
 243 \fBPassword\fR
 244 Password of the IRC operator.
 245 .TP
 246 \fBMask\fR
 247 Mask that is to be checked before an /OPER for this account is accepted.
 248 Example: nick!ident@*.example.com
 249 .SH [SERVER]
 250 Other servers are configured in
 251 .I [Server]
 252 sections. If you configure a port for the connection, then this ngIRCd
 253 tries to connect to to the other server on the given port (active);
 254 if not, it waits for the other server to connect (passive).
 255 .PP
 256 ngIRCd supports "server groups": You can assign an "ID" to every server
 257 with which you want this ngIRCd to link, and the daemon ensures that at
 258 any given time only one direct link exists to servers with the same ID.
 259 So if a server of a group won't answer, ngIRCd tries to connect to the next
 260 server in the given group (="with the same ID"), but never tries to connect
 261 to more than one server of this group simultaneously.
 262 .PP
 263 There may be more than one
 264 .I [Server]
 265 block.
 266 .TP
 267 \fBName\fR
 268 IRC name of the remote server.
 269 .TP
 270 \fBHost\fR
 271 Internet host name (or IP address) of the peer.
 272 .TP
 273 \fBBind\fR
 274 IP address to use as source IP for the outgoing connection. Default is
 275 to let the operating system decide.
 276 .TP
 277 \fBPort\fR
 278 Port of the remote server to which ngIRCd should connect (active).
 279 If no port is assigned to a configured server, the daemon only waits for
 280 incoming connections (passive, default).
 281 .TP
 282 \fBMyPassword\fR
 283 Own password for this connection. This password has to be configured as
 284 \fBPeerPassword\fR on the other server. Must not have ':' as first character.
 285 .TP
 286 \fBPeerPassword\fR
 287 Foreign password for this connection. This password has to be configured as
 288 \fBMyPassword\fR on the other server.
 289 .TP
 290 \fBGroup\fR
 291 Group of this server (optional).
 292 .TP
 293 \fBPassive\fR
 294 Disable automatic connection even if port value is specified. Default: false.
 295 You can use the IRC Operator command CONNECT later on to create the link.
 296 .TP
 297 \fBSSLConnect\fR
 298 Connect to the remote server using TLS/SSL. Default: false.
 299 .TP
 300 \fBServiceMask\fR
 301 Define a (case insensitive) mask matching nick names that should be treated as
 302 IRC services when introduced via this remote server. REGULAR SERVERS DON'T NEED
 303 this parameter, so leave it empty (which is the default).
 304 .PP
 305 .RS
 306 When you are connecting IRC services which mask as a IRC server and which use
 307 "virtual users" to communicate with, for example "NickServ" and "ChanServ",
 308 you should set this parameter to something like "*Serv".
 309 .SH [CHANNEL]
 310 Pre-defined channels can be configured in
 311 .I [Channel]
 312 sections. Such channels are created by the server when starting up and even
 313 persist when there are no more members left.
 314 .PP
 315 Persistent channels are marked with the mode 'P', which can be set and unset
 316 by IRC operators like other modes on the fly.
 317 .PP
 318 There may be more than one
 319 .I [Channel]
 320 block.
 321 .TP
 322 \fBName\fR
 323 Name of the channel, including channel prefix ("#" or "&").
 324 .TP
 325 \fBTopic\fR
 326 Topic for this channel.
 327 .TP
 328 \fBModes\fR
 329 Initial channel modes.
 330 .TP
 331 \fBKey\fR
 332 Sets initial channel key (only relevant if channel mode "k" is set).
 333 .TP
 334 \fBKeyFile\fR
 335 Path and file name of a "key file" containing individual channel keys for
 336 different users. The file consists of plain text lines with the following
 337 syntax (without spaces!):
 338 .PP
 339 .RS
 340 .RS
 341 .I user
 342 :
 343 .I nick
 344 :
 345 .I key
 346 .RE
 347 .PP
 348 .I user
 349 and
 350 .I nick
 351 can contain the wildcard character "*".
 352 .br
 353 .I key
 354 is an arbitrary password.
 355 .PP
 356 Valid examples are:
 357 .PP
 358 .RS
 359 *:*:KeY
 360 .br
 361 *:nick:123
 362 .br
 363 ~user:*:xyz
 364 .RE
 365 .PP
 366 The key file is read on each JOIN command when this channel has a key
 367 (channel mode +k). Access is granted, if a) the channel key set using the
 368 MODE +k command or b) one of the lines in the key file match.
 369 .PP
 370 .B Please note:
 371 .br
 372 The file is not reopened on each access, so you can modify and overwrite it
 373 without problems, but moving or deleting the file will have not effect until
 374 the daemon re-reads its configuration!
 375 .RE
 376 .TP
 377 \fBMaxUsers\fR
 378 Set maximum user limit for this channel (only relevant if channel mode "l"
 379 is set).
 380 .SH HINTS
 381 It's wise to use "ngircd \-\-configtest" to validate the configuration file
 382 after changing it. See
 383 .BR ngircd (8)
 384 for details.
 385 .SH AUTHOR
 386 Alexander Barton,
 387 .UR mailto:alex@barton.de
 388 .UE
 389 .br
 390 Homepage:
 391 .UR http://ngircd.barton.de/
 392 .UE
 393 .SH "SEE ALSO"
 394 .BR ngircd (8)
 395 .\"
 396 .\" -eof-