New configuration option "NoIdent" to disable IDENT lookups
[ngircd-alex.git] / doc / sample-ngircd.conf
index 72d2e4671fbe82ce6483d1a3d52ea9b5b5965cae..1ccc90c6898557d8b90b96bfed3c2e28eaaf03e8 100644 (file)
@@ -1,4 +1,4 @@
-# $Id: sample-ngircd.conf,v 1.31 2005/03/02 16:07:30 alex Exp $
+# $Id: sample-ngircd.conf,v 1.44 2008/01/07 23:02:29 alex Exp $
 
 #
 # This is a sample configuration file for the ngIRCd, which must be adepted
@@ -6,26 +6,32 @@
 #
 # Comments are started with "#" or ";".
 #
+# A lot of configuration options in this file start with a ";". You have
+# to remove the ";" in front of each variable to actually set a value!
+# The disabled variables are shown with example values for completeness.
+#
 # Use "ngircd --configtest" (see manual page ngircd(8)) to validate that the
-# server interpreted the configuration file as expected!
+# server interprets the configuration file as expected!
+#
+# Please see ngircd.conf(5) for a complete list of configuration options.
 #
 
 [Global]
        # The [Global] section of this file is used to define the main
        # configuration of the server, like the server name and the ports
        # on which the server should be listening.
-       
+
        # Server name in the IRC network, must contain at least one dot
        # (".") and be unique in the IRC network. Required!
        Name = irc.the.net
-       
+
        # Info text of the server. This will be shown by WHOIS and
        # LINKS requests for example.
        Info = Server Info Text
 
        # Global password for all users needed to connect to the server
        ;Password = abc
-       
+
        # Information about the server and the administrator, used by the
        # ADMIN command. Not required by server but by RFC!
        ;AdminInfo1 = Description
        # one port, separated with ",". (Default: 6667)
        ;Ports = 6667, 6668, 6669
 
-       # IP address on which the server should listen. (Default: empty,
-       # so the server listens on all IP addresses of the system)
-       ;Listen = 1.2.3.4
-       
+       # Additional Listen Ports that expect SSL/TLS encrypted connections
+       ;SSLPorts = 9999,6668
+
+       # SSL Server Key
+        ;SSLKeyFile = /usr/local/etc/ngircd/ssl/server-key.pem
+
+       # password to decrypt SSLKeyFile (OpenSSL only)
+       ;SSLKeyFilePassword = secret
+
+       # SSL Server Key Certificate
+       ;SSLCertFile = /usr/local/etc/ngircd/ssl/server-cert.pem
+
+       # Diffie-Hellman parameters
+       ;SSLDHFile = /usr/local/etc/ngircd/ssl/dhparams.pem
+
+       # comma seperated list of IP addresses on which the server should
+       # listen. Default values are:
+       # "0.0.0.0" or (if compiled with IPv6 support) "::,0.0.0.0"
+       # so the server listens on all IP addresses of the system by default.
+       ;Listen = 127.0.0.1,192.168.0.1
+
        # Text file with the "message of the day" (MOTD). This message will
        # be shown to all users connecting to the server:
        ;MotdFile = /usr/local/etc/ngircd.motd
@@ -68,9 +91,9 @@
        ;ChrootDir = /var/empty
 
        # This tells ngircd to write its current process id to a file.
-       # Note that the pidfile is written AFTER chroot and switching uid, i.e.
-       # the Directory the pidfile resides in must be writeable by the ngircd user and
-       # exist in the chroot dir.
+       # Note that the pidfile is written AFTER chroot and switching uid,
+       # i. e. the Directory the pidfile resides in must be writeable by
+       # the ngircd user and exist in the chroot directory.
        ;PidFile = /var/run/ngircd/ngircd.pid
 
        # After <PingTimeout> seconds of inactivity the server will send a
        # they are not(!) channel-operators?
        ;OperCanUseMode = no
 
-       # Maximum number of simultaneous connection the server is allowed
-       # to accept (<=0: unlimited):
-       ;MaxConnections = -1
-       
+       # Mask IRC Operator mode requests as if they were coming from the
+       # server? (This is a compatibility hack for ircd-irc2 servers)
+       ;OperServerMode = no
+
+       # Allow Pre-Defined Channels only (see Section [Channels])
+       ;PredefChannelsOnly = no
+
+       # Don't do any DNS lookups when a client connects to the server.
+       ;NoDNS = no
+
+       # Don't do any IDENT lookups, even if ngIRCd has been compiled
+       # with support for it.
+       ;NoIdent = no
+
+       # try to connect to other irc servers using ipv4 and ipv6, if possible
+       ;ConnectIPv6 = yes
+       ;ConnectIPv4 = yes
+
+       # Maximum number of simultaneous in- and outbound connections the
+       # server is allowed to accept (0: unlimited):
+       ;MaxConnections = 0
+
        # Maximum number of simultaneous connections from a single IP address
-       # the server will accept (<=0: unlimited):
+       # the server will accept (0: unlimited):
        ;MaxConnectionsIP = 5
 
-       # Maximum number of channels a user can be member of (<=0: no limit):
+       # Maximum number of channels a user can be member of (0: no limit):
        ;MaxJoins = 10
 
+       # Maximum length of an user nick name (Default: 9, as in RFC 2812).
+       # Please note that all servers in an IRC network MUST use the same
+       # maximum nick name length!
+       ;MaxNickLength = 9
+
 [Operator]
        # [Operator] sections are used to define IRC Operators. There may be
        # more than one [Operator] block, one for each local operator.
-       
+
        # ID of the operator (may be different of the nick name)
        ;Name = TheOper
 
        # configure a port for the connection, then this ngircd tries to
        # connect to to the other server on the given port; if not it waits
        # for the other server to connect.
-       # There may be more than one server block.
+       # There may be more than one server block, one for each server.
        #
        # Server Groups:
        # The ngIRCd allows "server groups": You can assign an "ID" to every
        # group won't answer, the ngIRCd tries to connect to the next server
        # in the given group. But the ngircd never tries to connect to two
        # servers with the same group ID.
-       
-       # IRC name of the server
+
+       # IRC name of the remote server, must match the "Name" variable in
+       # the [Global] section of the other server (when using ngIRCd).
        ;Name = irc2.the.net
-   
-       # Internet host name of the peer
+
+       # Internet host name or IP address of the peer (only required when
+       # this server should establish the connection).
        ;Host = connect-to-host.the.net
 
+       # IP address to use as _source_ address for the connection. if
+       # unspecified, ngircd will let the operating system pick an address.
+       ;Bind = 10.0.0.1
+
        # Port of the server to which the ngIRCd should connect. If you
        # assign no port the ngIRCd waits for incoming connections.
-       ;Port = 6666
+       ;Port = 6667
 
        # Own password for the connection. This password has to be configured
        # as "PeerPassword" on the other server.
        # Foreign password for this connection. This password has to be
        # configured as "MyPassword" on the other server.
        ;PeerPassword = PeerSecret
-       
+
        # Group of this server (optional)
        ;Group = 123
 
+       # Set the "Passive" option to "yes" if you don't want this ngIRCd to
+       # connect to the configured peer (same as leaving the "Port" variable
+       # empty). The advantage of this option is that you can actually
+       # configure a port an use the IRC command CONNECT more easily to
+       # manually connect this specific server later.
+       ;Passive = no
+
+       # Connect to the remote server using TLS/SSL (Default: false)
+       ; SSLConnect = yes
+
+       # Define a (case insensitive) mask matching nick names that sould be
+       # treated as IRC services when introduced via this remote server.
+       # REGULAR SERVERS DON'T NEED this parameter, so leave it empty
+       # (which is the default).
+       # When you are connecting IRC services which mask as a IRC server
+       # and which use "virtual users" to communicate with, for example
+       # "NickServ" amd "ChanServ", you should set this parameter to
+       # something like "*Serv".
+       ;ServiceMask = *Serv
+
 [Server]
        # More [Server] sections, if you like ...
 
        # persist when there are no more members left.
        # Persistent channels are marked with the mode 'P', which can be set
        # and unset by IRC operators like other modes on the fly.
-       # There may be more than one [Channel] block.
-       
+       # There may be more than one [Channel] block, one for each channel.
+
        # Name of the channel
        ;Name = #TheName
 
        # Topic for this channel
        ;Topic = a great topic
-       
+
        # Initial channel modes
-       ;Modes = tn
+       ;Modes = tnk
+
+       # initial channel password (mode k)
+       ;Key = Secret
+
+       # maximum users per channel (mode l)
+       ;MaxUsers = 23
 
 [Channel]
        # More [Channel] sections, if you like ...