Fix documentation of MotdPhrase length (#254)

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

diff --git a/doc/sample-ngircd.conf.tmpl b/doc/sample-ngircd.conf.tmpl
index 31333ec2c7265cb40253a2e63291c781a2d47c90..7905da482c722ce2e39d2a342d4a886ea849cc48 100644 (file)
--- a/doc/sample-ngircd.conf.tmpl
+++ b/doc/sample-ngircd.conf.tmpl
@@ -51,9 +51,15 @@
        # 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.
+       # A simple Phrase (<127 chars) if you don't want to use a motd file.
        ;MotdPhrase = "Hello world!"
 
+       # The name of the IRC network to which this server belongs. This name
+       # is optional, should only contain ASCII characters, and can't contain
+       # spaces. It is only used to inform clients. The default is empty,
+       # so no network name is announced to clients.
+       ;Network = aIRCnetwork
+
        # Global password for all users needed to connect to the server.
        # (Default: not set)
        ;Password = abc
@@ -111,6 +117,12 @@
        # maximum nickname length!
        ;MaxNickLength = 9
 
+       # Maximum penalty time increase in seconds, per penalty event. Set to -1
+       # for no limit (the default), 0 to disable penalties altogether. The
+       # daemon doesn't use penalty increases higher than 2 seconds during
+       # normal operation, so values greater than 1 rarely make sense.
+       ;MaxPenaltyTime = -1
+
        # Maximum number of channels returned in response to a /list
        # command (0: unlimited):
        ;MaxListSize = 100
@@ -128,6 +140,12 @@
        # behavior of ngIRCd. If you want to get started quickly, you most
        # probably don't have to make changes here -- they are all optional.
 
+       # List of allowed channel types (channel prefixes) for newly created
+       # channels on the local server. By default, all supported channel
+       # types are allowed. Set this variable to the empty string to disallow
+       # creation of new channels by local clients at all.
+       ;AllowedChannelTypes = #&+
+
        # Are remote IRC operators allowed to control this server, e.g.
        # use commands like CONNECT, SQUIT, DIE, ...?
        ;AllowRemoteOper = no
@@ -159,7 +177,12 @@
        ;ConnectIPv6 = yes
        ;ConnectIPv4 = yes
 
-       # Do any DNS lookups when a client connects to the server.
+       # Default user mode(s) to set on new local clients. Please note that
+       # only modes can be set that the client could set using regular MODE
+       # commands, you can't set "a" (away) for example! Default: none.
+       ;DefaultUserModes = i
+
+       # Do DNS lookups when a client connects to the server.
        ;DNS = yes
 
        # Do IDENT lookups if ngIRCd has been compiled with support for it.
@@ -176,9 +199,9 @@
        ;MorePrivacy = no
 
        # Normally ngIRCd doesn't send any messages to a client until it is
-       # registered. Enable this option to let the daemon send "NOTICE AUTH"
+       # registered. Enable this option to let the daemon send "NOTICE *"
        # messages to clients while connecting.
-       ;NoticeAuth = no
+       ;NoticeBeforeRegistration = no
 
        # Should IRC Operators be allowed to use the MODE command even if
        # they are not(!) channel-operators?
@@ -209,8 +232,14 @@
        # character prepended to their respective user names!
        ;PAMIsOptional = no
 
-       # Allow Pre-Defined Channels only (see Section [Channels])
-       ;PredefChannelsOnly = no
+       # When PAM is enabled, this value determines the used PAM
+       # configuration.
+       # This setting allows to run multiple ngIRCd instances with
+       # different PAM configurations on each instance.
+       # If you set it to "ngircd-foo", PAM will use
+       # /etc/pam.d/ngircd-foo instead of the default
+       # /etc/pam.d/ngircd.
+       ;PAMServiceName = ngircd
 
        # Let ngIRCd send an "authentication PING" when a new client connects,
        # and register this client only after receiving the corresponding
@@ -240,6 +269,15 @@
        # SSL Server Key Certificate
        ;CertFile = :ETCDIR:/ssl/server-cert.pem
 
+       # Select cipher suites allowed for SSL/TLS connections. This defaults
+       # to HIGH:!aNULL:@STRENGTH (OpenSSL) or SECURE128 (GnuTLS).
+       # See 'man 1ssl ciphers' (OpenSSL) or 'man 3 gnutls_priority_init'
+       # (GnuTLS) for details.
+       # For OpenSSL:
+       ;CipherList = HIGH:!aNULL:@STRENGTH:!SSLv3
+       # For GnuTLS:
+       ;CipherList = SECURE128:-VERS-SSL3.0
+
        # Diffie-Hellman parameters
        ;DHFile = :ETCDIR:/ssl/dhparams.pem