]> arthur.barton.de Git - ngircd-alex.git/blobdiff - doc/sample-ngircd.conf.tmpl
Add documentation for "ScrubCTCP" configuration option
[ngircd-alex.git] / doc / sample-ngircd.conf.tmpl
index e07b520544c5599d44ed14d04dc22de3f92e1d47..02c8bee1387bf679c1fb789e3016ee7f9bcb1e73 100644 (file)
        # 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.
+       # These settings depend on your personal preferences, so you should
+       # make sure that they correspond to your installation and setup!
 
        # Server name in the IRC network, must contain at least one dot
        # (".") and be unique in the IRC network. Required!
        Name = irc.example.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.
-       # (Default: not set)
-       ;Password = abc
-
-       # Password required for using the WEBIRC command used by some
-       # Web-to-IRC gateways. If not set/empty, the WEBIRC command can't
-       # be used. (Default: not set)
-       ;WebircPassword = xyz
-
        # Information about the server and the administrator, used by the
        # ADMIN command. Not required by server but by RFC!
        ;AdminInfo1 = Description
        ;AdminInfo2 = Location
        ;AdminEMail = admin@irc.server
 
-       # Ports on which the server should listen. There may be more than
-       # one port, separated with ",". (Default: 6667)
-       ;Ports = 6667, 6668, 6669
-
-       # Additional Listen Ports that expect SSL/TLS encrypted connections
-       ;SSLPorts = 6697, 9999
-
-       # SSL Server Key
-       ;SSLKeyFile = :ETCDIR:/ssl/server-key.pem
-
-       # password to decrypt SSLKeyFile (OpenSSL only)
-       ;SSLKeyFilePassword = secret
-
-       # SSL Server Key Certificate
-       ;SSLCertFile = :ETCDIR:/ssl/server-cert.pem
-
-       # Diffie-Hellman parameters
-       ;SSLDHFile = :ETCDIR:/ssl/dhparams.pem
+       # Info text of the server. This will be shown by WHOIS and
+       # LINKS requests for example.
+       Info = Server Info Text
 
-       # comma separated list of IP addresses on which the server should
+       # Comma separated 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
 
-       # Syslog "facility" to which ngIRCd should send log messages.
-       # Possible values are system dependant, but most probably auth, daemon,
-       # user and local1 through local7 are possible values; see syslog(3).
-       # Default is "local5" for historical reasons, you probably want to
-       # change this to "daemon", for example.
-       SyslogFacility = local1
-
        # Text file with the "message of the day" (MOTD). This message will
        # be shown to all users connecting to the server:
        ;MotdFile = :ETCDIR:/ngircd.motd
        # A simple Phrase (<256 chars) if you don't want to use a motd file.
        ;MotdPhrase = "Hello world!"
 
+       # Global password for all users needed to connect to the server.
+       # (Default: not set)
+       ;Password = abc
+
+       # This tells ngIRCd to write its current process ID to a file.
+       # Note that the pidfile is written AFTER chroot and switching the
+       # user ID, e.g. 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
+
+       # Ports on which the server should listen. There may be more than
+       # one port, separated with ",". (Default: 6667)
+       ;Ports = 6667, 6668, 6669
+
+       # Group ID under which the ngIRCd should run; you can use the name
+       # of the group or the numerical ID. ATTENTION: For this to work the
+       # server must have been started with root privileges!
+       ;ServerGID = 65534
+
        # User ID under which the server should run; you can use the name
        # of the user or the numerical ID. ATTENTION: For this to work the
        # server must have been started with root privileges! In addition,
        # otherwise RESTART and REHASH won't work!
        ;ServerUID = 65534
 
-       # Group ID under which the ngircd should run; you can use the name
-       # of the group or the numerical ID. ATTENTION: For this to work the
-       # server must have been started with root privileges!
-       ;ServerGID = 65534
-
-       # A directory to chroot in when everything is initialized. It
-       # doesn't need to be populated if ngIRCd is compiled as a static
-       # binary. By default ngIRCd won't use the chroot() feature.
-       # ATTENTION: For this to work the server must have been started
-       # with root privileges!
-       ;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 directory.
-       ;PidFile = /var/run/ngircd/ngircd.pid
-
-       # After <PingTimeout> seconds of inactivity the server will send a
-       # PING to the peer to test whether it is alive or not.
-       ;PingTimeout = 120
-
-       # If a client fails to answer a PING with a PONG within <PongTimeout>
-       # seconds, it will be disconnected by the server.
-       ;PongTimeout = 20
+[Limits]
+       # Define some limits and timeouts for this ngIRCd instance. Default
+       # values should be safe, but it is wise to double-check :-)
 
        # The server tries every <ConnectRetry> seconds to establish a link
        # to not yet (or no longer) connected servers.
        ;ConnectRetry = 60
 
-       # Should IRC Operators be allowed to use the MODE command even if
-       # they are not(!) channel-operators?
-       ;OperCanUseMode = no
-
-       # Mask IRC Operator mode requests as if they were coming from the
-       # server? (This is a compatibility hack for ircd-irc2 servers)
-       ;OperServerMode = no
-
-       # Are remote IRC operators allowed to control this server, e. g.
-       # use commands like CONNECT, SQUIT, DIE, ...?
-       ;AllowRemoteOper = no
-
-       # Allow Pre-Defined Channels only (see Section [Channels])
-       ;PredefChannelsOnly = 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 nick name length!
        ;MaxNickLength = 9
 
+       # After <PingTimeout> seconds of inactivity the server will send a
+       # PING to the peer to test whether it is alive or not.
+       ;PingTimeout = 120
+
+       # If a client fails to answer a PING with a PONG within <PongTimeout>
+       # seconds, it will be disconnected by the server.
+       ;PongTimeout = 20
+
+[Options]
+       # Optional features and configuration options to further tweak the
+       # behavior of ngIRCd. If you wan't to get started quickly, you most
+       # probably don't have to make changes here -- they are all optional.
+
+       # Are remote IRC operators allowed to control this server, e.g.
+       # use commands like CONNECT, SQUIT, DIE, ...?
+       ;AllowRemoteOper = no
+
+       # A directory to chroot in when everything is initialized. It
+       # doesn't need to be populated if ngIRCd is compiled as a static
+       # binary. By default ngIRCd won't use the chroot() feature.
+       # ATTENTION: For this to work the server must have been started
+       # with root privileges!
+       ;ChrootDir = /var/empty
+
        # Set this hostname for every client instead of the real one.
        # Please note: don't use the percentage sign ("%"), it is reserved for
        # future extensions!
        # Set every clients' user name to their nick name
        ;CloakUserToNick = yes
 
-[Features]
+       # Try to connect to other IRC servers using IPv4 and IPv6, if possible.
+       ;ConnectIPv6 = yes
+       ;ConnectIPv4 = yes
+
        # Do any DNS lookups when a client connects to the server.
        ;DNS = yes
 
-       # Do any IDENT lookups if ngIRCd has been compiled with support for it.
+       # Do IDENT lookups if ngIRCd has been compiled with support for it.
        ;Ident = yes
 
+       # Normally ngIRCd doesn't send any messages to a client until it is
+       # registered. Enable this option to let the daemon send "NOTICE AUTH"
+       # messages to clients while connecting.
+       ;NoticeAuth = no
+
+       # Should IRC Operators be allowed to use the MODE command even if
+       # they are not(!) channel-operators?
+       ;OperCanUseMode = no
+
+       # Mask IRC Operator mode requests as if they were coming from the
+       # server? (This is a compatibility hack for ircd-irc2 servers)
+       ;OperServerMode = no
+
        # Use PAM if ngIRCd has been compiled with support for it.
        ;PAM = no
 
+       # Allow Pre-Defined Channels only (see Section [Channels])
+       ;PredefChannelsOnly = no
+
+       # Let ngIRCd send an "authentication PING" when a new client connects,
+       # and register this client only after receiving the corresponding
+       # "PONG" reply.
+       ;RequireAuthPing = no
+
+       # Silently drop all incomming CTCP requests.
+       ;ScrubCTCP = no
+
+       # SSL Server Key Certificate
+       ;SSLCertFile = :ETCDIR:/ssl/server-cert.pem
+
+       # Diffie-Hellman parameters
+       ;SSLDHFile = :ETCDIR:/ssl/dhparams.pem
+
+       # SSL Server Key
+       ;SSLKeyFile = :ETCDIR:/ssl/server-key.pem
+
+       # password to decrypt SSLKeyFile (OpenSSL only)
+       ;SSLKeyFilePassword = secret
+
+       # Additional Listen Ports that expect SSL/TLS encrypted connections
+       ;SSLPorts = 6697, 9999
+
+       # Syslog "facility" to which ngIRCd should send log messages.
+       # Possible values are system dependent, but most probably auth, daemon,
+       # user and local1 through local7 are possible values; see syslog(3).
+       # Default is "local5" for historical reasons, you probably want to
+       # change this to "daemon", for example.
+       SyslogFacility = local1
+
+       # Password required for using the WEBIRC command used by some
+       # Web-to-IRC gateways. If not set/empty, the WEBIRC command can't
+       # be used. (Default: not set)
+       ;WebircPassword = xyz
+
 [Operator]
        # [Operator] sections are used to define IRC Operators. There may be
        # more than one [Operator] block, one for each local operator.