Fix spelling in some documents.

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

diff --git a/doc/sample-ngircd.conf b/doc/sample-ngircd.conf
index 87a94d9df8be365b4de8d2597cf06ed4d316800b..526e8801c95c8db6ac90e43734b621ec09da3840 100644 (file)
--- a/doc/sample-ngircd.conf
+++ b/doc/sample-ngircd.conf
@@ -1,18 +1,19 @@
-# $Id: sample-ngircd.conf,v 1.44 2008/01/07 23:02:29 alex Exp $
-
 #
-# This is a sample configuration file for the ngIRCd, which must be adepted
-# to the local preferences and needs.
+# This is a sample configuration file for the ngIRCd IRC daemon, which must
+# be customized to the local preferences and needs.
 #
 # Comments are started with "#" or ";".
 #
 # A lot of configuration options in this file start with a ";". You have
 # to remove the ";" in front of each variable to actually set a value!
-# The disabled variables are shown with example values for completeness.
+# The disabled variables are shown with example values for completeness only
+# and the daemon is using compiled-in default settings.
 #
 # 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.
+#
 
 [Global]
        # The [Global] section of this file is used to define the main
@@ -40,7 +41,22 @@
        # one port, separated with ",". (Default: 6667)
        ;Ports = 6667, 6668, 6669
 
-       # comma seperated list of IP addresses on which the server should
+       # Additional Listen Ports that expect SSL/TLS encrypted connections
+       ;SSLPorts = 9999,6668
+
+       # SSL Server Key
+        ;SSLKeyFile = /usr/local/etc/ngircd/ssl/server-key.pem
+
+       # password to decrypt SSLKeyFile (OpenSSL only)
+       ;SSLKeyFilePassword = secret
+
+       # SSL Server Key Certificate
+       ;SSLCertFile = /usr/local/etc/ngircd/ssl/server-cert.pem
+
+       # Diffie-Hellman parameters
+       ;SSLDHFile = /usr/local/etc/ngircd/ssl/dhparams.pem
+
+       # comma separated list of IP addresses on which the server should
        # listen. Default values are:
        # "0.0.0.0" or (if compiled with IPv6 support) "::,0.0.0.0"
        # so the server listens on all IP addresses of the system by default.
@@ -105,12 +121,16 @@
        # 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
+
        # try to connect to other irc servers using ipv4 and ipv6, if possible
        ;ConnectIPv6 = yes
        ;ConnectIPv4 = yes
 
-       # Maximum number of simultaneous connection the server is allowed
-       # to accept (0: unlimited):
+       # Maximum number of simultaneous in- and outbound connections the
+       # server is allowed to accept (0: unlimited):
        ;MaxConnections = 0
 
        # Maximum number of simultaneous connections from a single IP address
@@ -158,13 +178,13 @@
        # 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
-  
+
        # Internet host name or IP address of the peer (only required when
        # this server should establish the connection).
        ;Host = connect-to-host.the.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.
        ;Bind = 10.0.0.1
 
        # Port of the server to which the ngIRCd should connect. If you
@@ -184,11 +204,24 @@
 
        # Set the "Passive" option to "yes" if you don't want this ngIRCd to
        # connect to the configured peer (same as leaving the "Port" variable
-       # empty). The advantage of this option is that you can actually configure
-       # a port an use the IRC command CONNECT more easily to manually connect
-       # this specific server later.
+       # empty). The advantage of this option is that you can actually
+       # configure a port an use the IRC command CONNECT more easily to
+       # manually connect this specific server later.
        ;Passive = no
 
+       # Connect to the remote server using TLS/SSL (Default: false)
+       ;SSLConnect = yes
+
+       # Define a (case insensitive) mask matching nick names that should be
+       # treated as IRC services when introduced via this remote server.
+       # REGULAR SERVERS DON'T NEED this parameter, so leave it empty
+       # (which is the default).
+       # When you are connecting IRC services which mask as a IRC server
+       # and which use "virtual users" to communicate with, for example
+       # "NickServ" and "ChanServ", you should set this parameter to
+       # something like "*Serv".
+       ;ServiceMask = *Serv
+
 [Server]
        # More [Server] sections, if you like ...