Add documentation for "RequireAuthPing" configuration option

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

diff --git a/doc/sample-ngircd.conf.tmpl b/doc/sample-ngircd.conf.tmpl
index c6dde60da6ac48db669bd0fe7219eb22de5d1dca..6e02048ffd93774bbe955f1490e05c43aaed80a9 100644 (file)
--- a/doc/sample-ngircd.conf.tmpl
+++ b/doc/sample-ngircd.conf.tmpl
@@ -22,7 +22,7 @@
 
        # Server name in the IRC network, must contain at least one dot
        # (".") and be unique in the IRC network. Required!
-       Name = irc.the.net
+       Name = irc.example.net
 
        # Info text of the server. This will be shown by WHOIS and
        # LINKS requests for example.
@@ -51,16 +51,16 @@
        ;SSLPorts = 6697, 9999
 
        # SSL Server Key
-       ;SSLKeyFile = :ETCDIR:ssl/server-key.pem
+       ;SSLKeyFile = :ETCDIR:/ssl/server-key.pem
 
        # password to decrypt SSLKeyFile (OpenSSL only)
        ;SSLKeyFilePassword = secret
 
        # SSL Server Key Certificate
-       ;SSLCertFile = :ETCDIR:ssl/server-cert.pem
+       ;SSLCertFile = :ETCDIR:/ssl/server-cert.pem
 
        # Diffie-Hellman parameters
-       ;SSLDHFile = :ETCDIR:ssl/dhparams.pem
+       ;SSLDHFile = :ETCDIR:/ssl/dhparams.pem
 
        # comma separated list of IP addresses on which the server should
        # listen. Default values are:
@@ -77,7 +77,7 @@
 
        # 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
+       ;MotdFile = :ETCDIR:/ngircd.motd
 
        # A simple Phrase (<256 chars) if you don't want to use a motd file.
        ;MotdPhrase = "Hello world!"
@@ -134,20 +134,6 @@
        # 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
-
-       # Don't use PAM, even if ngIRCd has been compiled with support for it.
-       ;NoPAM = no
-
-       # Don't use ZeroConf service registration, even if ngIRCd has been
-       # compiled with support for it (e.g. Howl, Avahi, Mac OS X).
-       ;NoZeroConf = no
-
        # try to connect to other irc servers using ipv4 and ipv6, if possible
        ;ConnectIPv6 = yes
        ;ConnectIPv4 = yes
@@ -168,6 +154,29 @@
        # maximum nick name length!
        ;MaxNickLength = 9
 
+       # Let ngIRCd send an "authentication PING" when a new client connects,
+       # and register this client only after receiving the corresponding
+       # "PONG" reply.
+       ;RequireAuthPing = no
+
+       # 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!
+       ;CloakHost = irc.example.net
+
+       # Set every clients' user name to their nick name
+       ;CloakUserToNick = yes
+
+[Features]
+       # 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.
+       ;Ident = yes
+
+       # Use PAM if ngIRCd has been compiled with support for it.
+       ;PAM = no
+
 [Operator]
        # [Operator] sections are used to define IRC Operators. There may be
        # more than one [Operator] block, one for each local operator.
@@ -200,11 +209,11 @@
 
        # 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
+       ;Name = irc2.example.net
 
        # Internet host name or IP address of the peer (only required when
        # this server should establish the connection).
-       ;Host = connect-to-host.the.net
+       ;Host = connect-to-host.example.net
 
        # IP address to use as _source_ address for the connection. if
        # unspecified, ngircd will let the operating system pick an address.
@@ -270,7 +279,7 @@
 
        # Key file, syntax for each line: "<user>:<nick>:<key>".
        # Default: none.
-       ;KeyFile = :ETCDIR:#chan.key
+       ;KeyFile = :ETCDIR:/#chan.key
 
        # maximum users per channel (mode l)
        ;MaxUsers = 23