man/ngircd.conf.5.tmpl

   1 .\"
   2 .\" ngircd.conf(5) manual page template
   3 .\"
   4 .TH ngircd.conf 5 "Dec 2010" 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 [Features]
  51 can be used to disable compile-time features at run time, e.g. if ngircd
  52 was built to support ident lookups, but you do not want ngircd to perform
  53 ident lookups you can disable them here.
  54 This section is optional.
  55 .I [Server]
  56 is the section where server links are configured. And
  57 .I [Channel]
  58 blocks are used to configure pre-defined ("persistent") IRC channels.
  59 .PP
  60 There can be more than one [Operator], [Server] and [Channel] sections
  61 per configuration file, but only one [Global] and one [Features] section.
  62 .SH [GLOBAL]
  63 The
  64 .I [Global]
  65 section is used to define the server main configuration, like the server
  66 name and the ports on which the server should be listening.
  67 .TP
  68 \fBName\fR
  69 Server name in the IRC network. This is an individual name of the IRC
  70 server, it is not related to the DNS host name. It must be unique in the
  71 IRC network and must contain at least one dot (".") character.
  72 .TP
  73 \fBInfo\fR
  74 Info text of the server. This will be shown by WHOIS and LINKS requests for
  75 example.
  76 .TP
  77 \fBPassword\fR
  78 Global password for all users needed to connect to the server. The default
  79 is empty, so no password is required.
  80 .TP
  81 \fBWebircPassword\fR
  82 Password required for using the WEBIRC command used by some Web-to-IRC
  83 gateways. If not set or empty, the WEBIRC command can't be used.
  84 Default: not set.
  85 .TP
  86 \fBAdminInfo1\fR, \fBAdminInfo2\fR, \fBAdminEMail\fR
  87 Information about the server and the administrator, used by the ADMIN
  88 command.
  89 .TP
  90 \fBPorts\fR
  91 Ports on which the server should listen. There may be more than one port,
  92 separated with commas (","). Default: 6667, unless \fBSSL_Ports\fR are also
  93 specified.
  94 .TP
  95 \fBSSLPorts\fR
  96 Same as \fBPorts\fR , except that ngIRCd will expect incoming connections
  97 to be SSL/TLS encrypted. Common port numbers for SSL-encrypted IRC are 6669
  98 and 6697. Default: none.
  99 .TP
 100 \fBSSLKeyFile\fR
 101 Filename of SSL Server Key to be used for SSL connections. This is required for
 102 SSL/TLS support.
 103 .TP
 104 \fBSSLKeyFilePassword\fR
 105 (OpenSSL only:) Password to decrypt private key.
 106 .TP
 107 \fBSSLCertFile\fR
 108 Certificate file of the private key.
 109 .TP
 110 \fBSSLDHFile\fR
 111 Name of the Diffie-Hellman Parameter file. Can be created with gnutls
 112 "certtool \-\-generate-dh-params" or "openssl dhparam".
 113 If this file is not present, it will be generated on startup when ngIRCd
 114 was compiled with gnutls support (this may take some time). If ngIRCd
 115 was compiled with OpenSSL, then (Ephemeral)-Diffie-Hellman Key Exchanges and several
 116 Cipher Suites will not be available.
 117 .TP
 118 \fBListen\fR
 119 A comma separated list of IP address on which the server should listen.
 120 If unset, the defaults value is "0.0.0.0" or, if ngIRCd was compiled
 121 with IPv6 support, "::,0.0.0.0". So the server listens on all configured
 122 IP addresses and interfaces by default.
 123 .TP
 124 \fBSyslogFacility\fR
 125 Syslog "facility" to which ngIRCd should send log messages. Possible
 126 values are system dependant, but most probably "auth", "daemon", "user"
 127 and "local1" through "local7" are possible values; see syslog(3).
 128 Default is "local5" for historical reasons, you probably want to
 129 change this to "daemon", for example.
 130 .TP
 131 \fBMotdFile\fR
 132 Text file with the "message of the day" (MOTD). This message will be shown
 133 to all users connecting to the server. Changes made to this file
 134 take effect when ngircd is instructed to re-read its configuration file.
 135 .TP
 136 \fBMotdPhrase\fR
 137 A simple Phrase (<256 chars) if you don't want to use a MOTD file.
 138 .TP
 139 \fBServerUID\fR
 140 User ID under which the server should run; you can use the name of the user
 141 or the numerical ID.
 142 .PP
 143 .RS
 144 .B Attention:
 145 .br
 146 For this to work the server must have been
 147 started with root privileges! In addition, the configuration and MOTD files
 148 must be readable by this user, otherwise RESTART and REHASH won't work!
 149 .RE
 150 .TP
 151 \fBServerGID\fR
 152 Group ID under which the ngIRCd should run; you can use the name of the
 153 group or the numerical ID.
 154 .PP
 155 .RS
 156 .B Attention:
 157 .br
 158 For this to work the server must have
 159 been started with root privileges!
 160 .RE
 161 .TP
 162 \fBChrootDir\fR
 163 A directory to chroot in when everything is initialized. It doesn't need
 164 to be populated if ngIRCd is compiled as a static binary. By default ngIRCd
 165 won't use the chroot() feature.
 166 .PP
 167 .RS
 168 .B Attention:
 169 .br
 170 For this to work the server must have
 171 been started with root privileges!
 172 .RE
 173 .TP
 174 \fBPidFile\fR
 175 This tells ngIRCd to write its current process ID to a file. Note that the
 176 pidfile is written AFTER chroot and switching the user ID, i. e. the
 177 directory the pidfile resides in must be writeable by the ngIRCd user and
 178 exist in the chroot directory (if configured, see above).
 179 .RE
 180 .TP
 181 \fBPingTimeout\fR
 182 After <PingTimeout> seconds of inactivity the server will send a PING to
 183 the peer to test whether it is alive or not. Default: 120.
 184 .TP
 185 \fBPongTimeout\fR
 186 If a client fails to answer a PING with a PONG within <PongTimeout>
 187 seconds, it will be disconnected by the server. Default: 20.
 188 .TP
 189 \fBConnectRetry\fR
 190 The server tries every <ConnectRetry> seconds to establish a link to not yet
 191 (or no longer) connected servers. Default: 60.
 192 .TP
 193 \fBOperCanUseMode\fR
 194 Should IRC Operators be allowed to use the MODE command even if they are
 195 not(!) channel-operators? Default: no.
 196 .TP
 197 \fBOperServerMode\fR
 198 If \fBOperCanUseMode\fR is enabled, this may lead the compatibility problems with
 199 Servers that run the ircd-irc2 Software. This Option "masks" mode requests
 200 by non-chanops as if they were coming from the server. Default: no.
 201 .TP
 202 \fBAllowRemoteOper\fR
 203 Are IRC operators connected to remote servers allowed to control this server,
 204 e. g. are they allowed to use administrative commands like CONNECT, DIE,
 205 SQUIT, ... that affect this server? Default: no.
 206 .TP
 207 \fBPredefChannelsOnly\fR
 208 If enabled, no new channels can be created. Useful if
 209 you do not want to have channels other than those defined in
 210 [Channel] sections in the configuration file.
 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 .TP
 240 \fBCloakHost\fR
 241 Set this hostname for every client instead of the real one. Default: empty,
 242 don't change.
 243 .PP
 244 .RS
 245 .B Please note:
 246 .br
 247 Don't use the percentage sign ("%"), it is reserved for future extensions!
 248 .RE
 249 .TP
 250 \fBCloakUserToNick\fR
 251 Set every clients' user name to their nick name and hide the one supplied
 252 by the IRC client. Default: no.
 253 .SH [OPERATOR]
 254 .I [Operator]
 255 sections are used to define IRC Operators. There may be more than one
 256 .I [Operator]
 257 block, one for each local operator.
 258 .TP
 259 \fBName\fR
 260 ID of the operator (may be different of the nick name).
 261 .TP
 262 \fBPassword\fR
 263 Password of the IRC operator.
 264 .TP
 265 \fBMask\fR
 266 Mask that is to be checked before an /OPER for this account is accepted.
 267 Example: nick!ident@*.example.com
 268 .SH [FEATURES]
 269 An optional section that can be used to disable features at
 270 run-time. A feature is enabled by default if if ngircd was built with
 271 support for it.
 272 \fBDNS\fR
 273 If set to false, ngIRCd will not make DNS lookups when clients connect.
 274 If you configure the daemon to connect to other servers, ngIRCd may still
 275 perform a DNS lookup if required.
 276 Default: yes.
 277 .TP
 278 \fBIdent\fR
 279 If ngIRCd is compiled with IDENT support this can be used to disable IDENT
 280 lookups at run time.
 281 Default: yes.
 282 .TP
 283 \fBPAM\fR
 284 If ngIRCd is compiled with PAM support this can be used to disable all calls
 285 to the PAM library at runtime; all users connecting without password are
 286 allowed to connect, all passwords given will fail.
 287 Default: yes.
 288 .TP
 289 .SH [SERVER]
 290 Other servers are configured in
 291 .I [Server]
 292 sections. If you configure a port for the connection, then this ngIRCd
 293 tries to connect to to the other server on the given port (active);
 294 if not, it waits for the other server to connect (passive).
 295 .PP
 296 ngIRCd supports "server groups": You can assign an "ID" to every server
 297 with which you want this ngIRCd to link, and the daemon ensures that at
 298 any given time only one direct link exists to servers with the same ID.
 299 So if a server of a group won't answer, ngIRCd tries to connect to the next
 300 server in the given group (="with the same ID"), but never tries to connect
 301 to more than one server of this group simultaneously.
 302 .PP
 303 There may be more than one
 304 .I [Server]
 305 block.
 306 .TP
 307 \fBName\fR
 308 IRC name of the remote server.
 309 .TP
 310 \fBHost\fR
 311 Internet host name (or IP address) of the peer.
 312 .TP
 313 \fBBind\fR
 314 IP address to use as source IP for the outgoing connection. Default is
 315 to let the operating system decide.
 316 .TP
 317 \fBPort\fR
 318 Port of the remote server to which ngIRCd should connect (active).
 319 If no port is assigned to a configured server, the daemon only waits for
 320 incoming connections (passive, default).
 321 .TP
 322 \fBMyPassword\fR
 323 Own password for this connection. This password has to be configured as
 324 \fBPeerPassword\fR on the other server. Must not have ':' as first character.
 325 .TP
 326 \fBPeerPassword\fR
 327 Foreign password for this connection. This password has to be configured as
 328 \fBMyPassword\fR on the other server.
 329 .TP
 330 \fBGroup\fR
 331 Group of this server (optional).
 332 .TP
 333 \fBPassive\fR
 334 Disable automatic connection even if port value is specified. Default: false.
 335 You can use the IRC Operator command CONNECT later on to create the link.
 336 .TP
 337 \fBSSLConnect\fR
 338 Connect to the remote server using TLS/SSL. Default: false.
 339 .TP
 340 \fBServiceMask\fR
 341 Define a (case insensitive) mask matching nick names that should be treated as
 342 IRC services when introduced via this remote server. REGULAR SERVERS DON'T NEED
 343 this parameter, so leave it empty (which is the default).
 344 .PP
 345 .RS
 346 When you are connecting IRC services which mask as a IRC server and which use
 347 "virtual users" to communicate with, for example "NickServ" and "ChanServ",
 348 you should set this parameter to something like "*Serv".
 349 .SH [CHANNEL]
 350 Pre-defined channels can be configured in
 351 .I [Channel]
 352 sections. Such channels are created by the server when starting up and even
 353 persist when there are no more members left.
 354 .PP
 355 Persistent channels are marked with the mode 'P', which can be set and unset
 356 by IRC operators like other modes on the fly.
 357 .PP
 358 There may be more than one
 359 .I [Channel]
 360 block.
 361 .TP
 362 \fBName\fR
 363 Name of the channel, including channel prefix ("#" or "&").
 364 .TP
 365 \fBTopic\fR
 366 Topic for this channel.
 367 .TP
 368 \fBModes\fR
 369 Initial channel modes.
 370 .TP
 371 \fBKey\fR
 372 Sets initial channel key (only relevant if channel mode "k" is set).
 373 .TP
 374 \fBKeyFile\fR
 375 Path and file name of a "key file" containing individual channel keys for
 376 different users. The file consists of plain text lines with the following
 377 syntax (without spaces!):
 378 .PP
 379 .RS
 380 .RS
 381 .I user
 382 :
 383 .I nick
 384 :
 385 .I key
 386 .RE
 387 .PP
 388 .I user
 389 and
 390 .I nick
 391 can contain the wildcard character "*".
 392 .br
 393 .I key
 394 is an arbitrary password.
 395 .PP
 396 Valid examples are:
 397 .PP
 398 .RS
 399 *:*:KeY
 400 .br
 401 *:nick:123
 402 .br
 403 ~user:*:xyz
 404 .RE
 405 .PP
 406 The key file is read on each JOIN command when this channel has a key
 407 (channel mode +k). Access is granted, if a) the channel key set using the
 408 MODE +k command or b) one of the lines in the key file match.
 409 .PP
 410 .B Please note:
 411 .br
 412 The file is not reopened on each access, so you can modify and overwrite it
 413 without problems, but moving or deleting the file will have not effect until
 414 the daemon re-reads its configuration!
 415 .RE
 416 .TP
 417 \fBMaxUsers\fR
 418 Set maximum user limit for this channel (only relevant if channel mode "l"
 419 is set).
 420 .SH HINTS
 421 It's wise to use "ngircd \-\-configtest" to validate the configuration file
 422 after changing it. See
 423 .BR ngircd (8)
 424 for details.
 425 .SH AUTHOR
 426 Alexander Barton, <alex@barton.de>
 427 .br
 428 Florian Westphal, <fw@strlen.de>
 429 .PP
 430 Homepage: http://ngircd.barton.de/
 431 .SH "SEE ALSO"
 432 .BR ngircd (8)
 433 .\"
 434 .\" -eof-