Implement new configuration option "IncludeDir"

[ngircd-alex.git] / doc / sample-ngircd.conf.tmpl

diff --git a/doc/sample-ngircd.conf.tmpl b/doc/sample-ngircd.conf.tmpl
index e8b2fb0df098088fa2ebfd082fbcae0525c0b4ef..31333ec2c7265cb40253a2e63291c781a2d47c90 100644 (file)
--- a/doc/sample-ngircd.conf.tmpl
+++ b/doc/sample-ngircd.conf.tmpl
@@ -33,6 +33,10 @@
        ;AdminInfo2 = Location
        ;AdminEMail = admin@irc.server
 
+       # Text file which contains the ngIRCd help text. This file is required
+       # to display help texts when using the "HELP <cmd>" command.
+       ;HelpFile = :DOCDIR:/Commands.txt
+
        # Info text of the server. This will be shown by WHOIS and
        # LINKS requests for example.
        Info = Server Info Text
@@ -84,6 +88,13 @@
        # to not yet (or no longer) connected servers.
        ;ConnectRetry = 60
 
+       # Number of seconds after which the whole daemon should shutdown when
+       # no connections are left active after handling at least one client
+       # (0: never, which is the default).
+       # This can be useful for testing or when ngIRCd is started using
+       # "socket activation" with systemd(8), for example.
+       ;IdleTimeout = 0
+
        # Maximum number of simultaneous in- and outbound connections the
        # server is allowed to accept (0: unlimited):
        ;MaxConnections = 0
@@ -95,11 +106,15 @@
        # 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).
+       # Maximum length of an user nickname (Default: 9, as in RFC 2812).
        # Please note that all servers in an IRC network MUST use the same
-       # maximum nick name length!
+       # maximum nickname length!
        ;MaxNickLength = 9
 
+       # Maximum number of channels returned in response to a /list
+       # command (0: unlimited):
+       ;MaxListSize = 100
+
        # After <PingTimeout> seconds of inactivity the server will send a
        # PING to the peer to test whether it is alive or not.
        ;PingTimeout = 120
@@ -125,17 +140,19 @@
        ;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!
+       # Use %x to add the hashed value of the original hostname.
        ;CloakHost = cloaked.host
 
        # Use this hostname for hostname cloaking on clients that have the
        # user mode "+x" set, instead of the name of the server.
-       # Please note: don't use the percentage sign ("%"), it is reserved for
-       # future extensions!
+       # Use %x to add the hashed value of the original hostname.
        ;CloakHostModeX = cloaked.user
 
-       # Set every clients' user name to their nick name
+       # The Salt for cloaked hostname hashing. When undefined a random
+       # hash is generated after each server start.
+       ;CloakHostSalt = abcdefghijklmnopqrstuvwxyz
+
+       # Set every clients' user name to their nickname
        ;CloakUserToNick = yes
 
        # Try to connect to other IRC servers using IPv4 and IPv6, if possible.
@@ -150,6 +167,10 @@
        # prepended to their user name.
        ;Ident = yes
 
+       # Directory containing configuration snippets (*.conf), that should
+       # be read in after parsing this configuration file.
+       ;IncludeDir = :ETCDIR:/conf.d
+
        # Enhance user privacy slightly (useful for IRC server on TOR or I2P)
        # by censoring some information like idle time, logon time, etc.
        ;MorePrivacy = no
@@ -163,6 +184,9 @@
        # they are not(!) channel-operators?
        ;OperCanUseMode = no
 
+       # Should IRC Operators get AutoOp (+o) in persistent (+P) channels?
+       ;OperChanPAutoOp = yes
+
        # Mask IRC Operator mode requests as if they were coming from the
        # server? (This is a compatibility hack for ircd-irc2 servers)
        ;OperServerMode = no
@@ -232,7 +256,7 @@
        # [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)
+       # ID of the operator (may be different of the nickname)
        ;Name = TheOper
 
        # Password of the IRC operator
@@ -295,15 +319,16 @@
        # Connect to the remote server using TLS/SSL (Default: false)
        ;SSLConnect = yes
 
-       # Define a (case insensitive) mask matching nick names that should be
-       # treated as IRC services when introduced via this remote server.
+       # Define a (case insensitive) list of masks matching nicknames that
+       # should be treated as IRC services when introduced via this remote
+       # server, separated by commas (",").
        # 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" and "ChanServ", you should set this parameter to
-       # something like "*Serv".
-       ;ServiceMask = *Serv
+       # something like "*Serv" or "NickServ,ChanServ,XyzServ".
+       ;ServiceMask = *Serv,Global
 
 [Server]
        # More [Server] sections, if you like ...