Describe "CloakHostModeX" in sample-ngircd.conf an ngircd.conf(5)

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

diff --git a/doc/sample-ngircd.conf.tmpl b/doc/sample-ngircd.conf.tmpl
index 26103a759b938ef9fdc1739522b64462de5baaae..e8b2fb0df098088fa2ebfd082fbcae0525c0b4ef 100644 (file)
--- a/doc/sample-ngircd.conf.tmpl
+++ b/doc/sample-ngircd.conf.tmpl
@@ -127,7 +127,13 @@
        # 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
+       ;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!
+       ;CloakHostModeX = cloaked.user
 
        # Set every clients' user name to their nick name
        ;CloakUserToNick = yes
@@ -140,6 +146,8 @@
        ;DNS = yes
 
        # Do IDENT lookups if ngIRCd has been compiled with support for it.
+       # Users identified using IDENT are registered without the "~" character
+       # prepended to their user name.
        ;Ident = yes
 
        # Enhance user privacy slightly (useful for IRC server on TOR or I2P)
@@ -160,8 +168,23 @@
        ;OperServerMode = no
 
        # Use PAM if ngIRCd has been compiled with support for it.
+       # Users identified using PAM are registered without the "~" character
+       # prepended to their user name.
        ;PAM = yes
 
+       # When PAM is enabled, all clients are required to be authenticated
+       # using PAM; connecting to the server without successful PAM
+       # authentication isn't possible.
+       # If this option is set, clients not sending a password are still
+       # allowed to connect: they won't become "identified" and keep the "~"
+       # character prepended to their supplied user name.
+       # Please note: To make some use of this behavior, it most probably
+       # isn't useful to enable "Ident", "PAM" and "PAMIsOptional" at the
+       # same time, because you wouldn't be able to distinguish between
+       # Ident'ified and PAM-authenticated users: both don't have a "~"
+       # character prepended to their respective user names!
+       ;PAMIsOptional = no
+
        # Allow Pre-Defined Channels only (see Section [Channels])
        ;PredefChannelsOnly = no