X-Git-Url: https://arthur.barton.de/cgi-bin/gitweb.cgi?p=ngircd-alex.git;a=blobdiff_plain;f=doc%2Fsample-ngircd.conf.tmpl;h=e8b2fb0df098088fa2ebfd082fbcae0525c0b4ef;hp=f5d7c8a6f7a7c5c0ca61fa63bdaa5c3ad0461876;hb=bf121ae95fa352d74ec710fda33c08148562a52c;hpb=b80e115f3947eae39aba39d1647f0a81f3d95fa3

diff --git a/doc/sample-ngircd.conf.tmpl b/doc/sample-ngircd.conf.tmpl
index f5d7c8a6..e8b2fb0d 100644
--- a/doc/sample-ngircd.conf.tmpl
+++ b/doc/sample-ngircd.conf.tmpl
@@ -12,7 +12,8 @@
 # Use "ngircd --configtest" (see manual page ngircd(8)) to validate that the
 # server interprets the configuration file as expected!
 #
-# Please see ngircd.conf(5) for a complete list of configuration options.
+# Please see ngircd.conf(5) for a complete list of configuration options
+# and their descriptions.
 #
 
 [Global]
@@ -56,7 +57,7 @@
 	# This tells ngIRCd to write its current process ID to a file.
 	# Note that the pidfile is written AFTER chroot and switching the
 	# user ID, e.g. the directory the pidfile resides in must be
-	# writeable by the ngIRCd user and exist in the chroot directory.
+	# writable by the ngIRCd user and exist in the chroot directory.
 	;PidFile = /var/run/ngircd/ngircd.pid
 
 	# Ports on which the server should listen. There may be more than
@@ -109,7 +110,7 @@
 
 [Options]
 	# Optional features and configuration options to further tweak the
-	# behavior of ngIRCd. If you wan't to get started quickly, you most
+	# behavior of ngIRCd. If you want to get started quickly, you most
 	# probably don't have to make changes here -- they are all optional.
 
 	# Are remote IRC operators allowed to control this server, e.g.
@@ -126,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
@@ -139,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)
@@ -159,7 +168,22 @@
 	;OperServerMode = no
 
 	# Use PAM if ngIRCd has been compiled with support for it.
-	;PAM = no
+	# 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
@@ -169,33 +193,41 @@
 	# "PONG" reply.
 	;RequireAuthPing = no
 
-	# SSL Server Key Certificate
-	;SSLCertFile = :ETCDIR:/ssl/server-cert.pem
-
-	# Diffie-Hellman parameters
-	;SSLDHFile = :ETCDIR:/ssl/dhparams.pem
-
-	# SSL Server Key
-	;SSLKeyFile = :ETCDIR:/ssl/server-key.pem
-
-	# password to decrypt SSLKeyFile (OpenSSL only)
-	;SSLKeyFilePassword = secret
-
-	# Additional Listen Ports that expect SSL/TLS encrypted connections
-	;SSLPorts = 6697, 9999
+	# Silently drop all incoming CTCP requests.
+	;ScrubCTCP = no
 
 	# Syslog "facility" to which ngIRCd should send log messages.
 	# Possible values are system dependent, but most probably auth, daemon,
 	# user and local1 through local7 are possible values; see syslog(3).
 	# Default is "local5" for historical reasons, you probably want to
 	# change this to "daemon", for example.
-	SyslogFacility = local1
+	;SyslogFacility = local1
 
 	# Password required for using the WEBIRC command used by some
 	# Web-to-IRC gateways. If not set/empty, the WEBIRC command can't
 	# be used. (Default: not set)
 	;WebircPassword = xyz
 
+;[SSL]
+	# SSL-related configuration options. Please note that this section
+	# is only available when ngIRCd is compiled with support for SSL!
+	# So don't forget to remove the ";" above if this is the case ...
+
+	# SSL Server Key Certificate
+	;CertFile = :ETCDIR:/ssl/server-cert.pem
+
+	# Diffie-Hellman parameters
+	;DHFile = :ETCDIR:/ssl/dhparams.pem
+
+	# SSL Server Key
+	;KeyFile = :ETCDIR:/ssl/server-key.pem
+
+	# password to decrypt SSLKeyFile (OpenSSL only)
+	;KeyFilePassword = secret
+
+	# Additional Listen Ports that expect SSL/TLS encrypted connections
+	;Ports = 6697, 9999
+
 [Operator]
 	# [Operator] sections are used to define IRC Operators. There may be
 	# more than one [Operator] block, one for each local operator.