Fix some wording, use spellchecker ;-)

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

diff --git a/doc/sample-ngircd.conf.tmpl b/doc/sample-ngircd.conf.tmpl
index b4a498d456575f5880043a812f1074e2ee7593d7..fb5d8262c2ba19dcd1fd5f2f1c4c426b3bb83db9 100644 (file)
--- 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.
@@ -141,6 +142,10 @@
        # Do IDENT lookups if ngIRCd has been compiled with support for it.
        ;Ident = yes
 
+       # Enhance user privacy slightly (useful for IRC server on TOR or I2P)
+       # by censoring some information like idle time, logon time, etc.
+       ;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"
        # messages to clients while connecting.
@@ -165,33 +170,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.