ngIRCd Release 27

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

diff --git a/doc/sample-ngircd.conf.tmpl b/doc/sample-ngircd.conf.tmpl
index cea23a2bd39508a60582478b256dc8dd700aa241..2a08bb43e309c435bdf59393ce957aad94b52388 100644 (file)
--- a/doc/sample-ngircd.conf.tmpl
+++ b/doc/sample-ngircd.conf.tmpl
@@ -24,8 +24,9 @@
        # make sure that they correspond to your installation and setup!
 
        # Server name in the IRC network, must contain at least one dot
-       # (".") and be unique in the IRC network. Required!
-       Name = irc.example.net
+       # (".") and be unique in the IRC network. When not set, ngIRCd tries
+       # to deduce a valid IRC server name from the local host name.
+       ;Name = irc.example.net
 
        # Information about the server and the administrator, used by the
        # ADMIN command. Not required by server but by RFC!
@@ -34,12 +35,14 @@
        ;AdminEMail = admin@irc.server
 
        # Text file which contains the ngIRCd help text. This file is required
-       # to display help texts when using the "HELP <cmd>" command.
+       # to display help texts when using the "HELP <cmd>" command. Default: a
+       # built-in standard path (check "ngircd --configtest").
        ;HelpFile = :DOCDIR:/Commands.txt
 
        # Info text of the server. This will be shown by WHOIS and
-       # LINKS requests for example.
-       Info = Server Info Text
+       # LINKS requests for example. Set to the server software name and
+       # version by default.
+       ;Info = Server Info Text
 
        # Comma separated list of IP addresses on which the server should
        # listen. Default values are:
@@ -48,7 +51,8 @@
        ;Listen = 127.0.0.1,192.168.0.1
 
        # Text file with the "message of the day" (MOTD). This message will
-       # be shown to all users connecting to the server:
+       # be shown to all users connecting to the server: Default: a built-in
+       # standard path (check "ngircd --configtest").
        ;MotdFile = :ETCDIR:/ngircd.motd
 
        # A simple Phrase (<127 chars) if you don't want to use a motd file.
@@ -192,6 +196,9 @@
 
        # Directory containing configuration snippets (*.conf), that should
        # be read in after parsing this configuration file.
+       # Default: a built-in directory name when no configuration file was
+       # explicitly given on the command line (check "ngircd --configtest"),
+       # none (empty) otherwise.
        ;IncludeDir = :ETCDIR:/conf.d
 
        # Enhance user privacy slightly (useful for IRC server on TOR or I2P)
@@ -266,6 +273,14 @@
        # 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 Trusted CA Certificates File for verifying peer certificates.
+       # (Default: not set; so no certificates are trusted)
+       ;CAFile = /etc/ssl/CA/cacert.pem
+
+       # Certificate Revocation File (for marking otherwise valid
+       # certficates as invalid)
+       ;CRLFile = /etc/ssl/CA/crl.pem
+
        # SSL Server Key Certificate
        ;CertFile = :ETCDIR:/ssl/server-cert.pem
 
@@ -357,6 +372,10 @@
        # Connect to the remote server using TLS/SSL (Default: false)
        ;SSLConnect = yes
 
+       # Verify the TLS certificate presented by the remote server
+       # (Default: yes)
+       ;SSLVerify = yes
+
        # Define a (case insensitive) list of masks matching nicknames that
        # should be treated as IRC services when introduced via this remote
        # server, separated by commas (",").