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 9bfa9d41a11a41717ee3b3353639ec39e2ea1214..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!
 
        # 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.
 
        # Info text of the server. This will be shown by WHOIS and
        # LINKS requests for example.


@@ -134,19 +134,6 @@
        # Allow Pre-Defined Channels only (see Section [Channels])
        ;PredefChannelsOnly = no
 
        # Allow Pre-Defined Channels only (see Section [Channels])
        ;PredefChannelsOnly = no
 

-       # 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
-
-       # Use ZeroConf service registration if ngIRCd has been
-       # compiled with support for it (e.g. Howl, Avahi, Mac OS X).
-       ;ZeroConf = no
-

        # try to connect to other irc servers using ipv4 and ipv6, if possible
        ;ConnectIPv6 = yes
        ;ConnectIPv4 = yes
        # try to connect to other irc servers using ipv4 and ipv6, if possible
        ;ConnectIPv6 = yes
        ;ConnectIPv4 = yes


@@ -167,6 +154,29 @@
        # maximum nick name length!
        ;MaxNickLength = 9
 
        # 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.
 [Operator]
        # [Operator] sections are used to define IRC Operators. There may be
        # more than one [Operator] block, one for each local operator.


@@ -199,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).
 
        # 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).
 
        # 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.
 
        # IP address to use as _source_ address for the connection. if
        # unspecified, ngircd will let the operating system pick an address.