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