ngIRCd Release 27

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

diff --git a/doc/sample-ngircd.conf.tmpl b/doc/sample-ngircd.conf.tmpl
index 7905da482c722ce2e39d2a342d4a886ea849cc48..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
        # 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!
 
        # 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
        ;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
        ;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:
 
        # 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
        ;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.
        ;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.
 
        # 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)
        ;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 ...
 
        # 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
 
        # SSL Server Key Certificate
        ;CertFile = :ETCDIR:/ssl/server-cert.pem
 


@@ -309,7 +324,7 @@
 [Server]
        # Other servers are configured in [Server] sections. If you
        # configure a port for the connection, then this ngircd tries to
 [Server]
        # Other servers are configured in [Server] sections. If you
        # configure a port for the connection, then this ngircd tries to

-       # connect to to the other server on the given port; if not it waits
+       # connect to the other server on the given port; if not it waits

        # for the other server to connect.
        # There may be more than one server block, one for each server.
        #
        # for the other server to connect.
        # There may be more than one server block, one for each server.
        #


@@ -357,6 +372,10 @@
        # Connect to the remote server using TLS/SSL (Default: false)
        ;SSLConnect = yes
 
        # 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 (",").
        # 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 (",").


@@ -385,19 +404,21 @@
        # Topic for this channel
        ;Topic = a great topic
 
        # Topic for this channel
        ;Topic = a great topic
 

-       # Initial channel modes
-       ;Modes = tnk
+       # Initial channel modes, as used in "MODE" commands. Modifying lists
+       # (ban list, invite list, exception list) is supported.
+       # This option can be specified multiple times, evaluated top to bottom.
+       ;Modes = +tnk mykey +l 5
+       ;Modes = +b nick!~user@bad.host.example.com

 
 

-       # initial channel password (mode k)
-       ;Key = Secret
+       # Should ngIRCd automatically join ("autojoin") all users to this
+       # channel on connect? Note: The users must have permissions to access
+       # the channel, otherwise joining them will fail!
+       ;Autojoin = yes

 
        # Key file, syntax for each line: "<user>:<nick>:<key>".
        # Default: none.
        ;KeyFile = :ETCDIR:/#chan.key
 
 
        # Key file, syntax for each line: "<user>:<nick>:<key>".
        # Default: none.
        ;KeyFile = :ETCDIR:/#chan.key
 

-       # maximum users per channel (mode l)
-       ;MaxUsers = 23
-

 [Channel]
        # More [Channel] sections, if you like ...
 
 [Channel]
        # More [Channel] sections, if you like ...