Cipher list selection for OpenSSL

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

diff --git a/doc/sample-ngircd.conf.tmpl b/doc/sample-ngircd.conf.tmpl
index 77948af09cb01b84330ed258e9488b8eab8f8c5c..a4dbf8695987fc2cf117f4d05f1adae33b19654f 100644 (file)
--- a/doc/sample-ngircd.conf.tmpl
+++ b/doc/sample-ngircd.conf.tmpl
@@ -33,6 +33,10 @@
        ;AdminInfo2 = Location
        ;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.
+       ;HelpFile = :DOCDIR:/Commands.txt
+
        # Info text of the server. This will be shown by WHOIS and
        # LINKS requests for example.
        Info = Server Info Text
@@ -84,6 +88,13 @@
        # to not yet (or no longer) connected servers.
        ;ConnectRetry = 60
 
+       # Number of seconds after which the whole daemon should shutdown when
+       # no connections are left active after handling at least one client
+       # (0: never, which is the default).
+       # This can be useful for testing or when ngIRCd is started using
+       # "socket activation" with systemd(8), for example.
+       ;IdleTimeout = 0
+
        # Maximum number of simultaneous in- and outbound connections the
        # server is allowed to accept (0: unlimited):
        ;MaxConnections = 0
@@ -95,9 +106,9 @@
        # Maximum number of channels a user can be member of (0: no limit):
        ;MaxJoins = 10
 
-       # Maximum length of an user nick name (Default: 9, as in RFC 2812).
+       # Maximum length of an user nickname (Default: 9, as in RFC 2812).
        # Please note that all servers in an IRC network MUST use the same
-       # maximum nick name length!
+       # maximum nickname length!
        ;MaxNickLength = 9
 
        # Maximum number of channels returned in response to a /list
@@ -117,6 +128,12 @@
        # behavior of ngIRCd. If you want to get started quickly, you most
        # probably don't have to make changes here -- they are all optional.
 
+       # List of allowed channel types (channel prefixes) for newly created
+       # channels on the local server. By default, all supported channel
+       # types are allowed. Set this variable to the empty string to disallow
+       # creation of new channels by local clients at all.
+       ;AllowedChannelTypes = #&+
+
        # Are remote IRC operators allowed to control this server, e.g.
        # use commands like CONNECT, SQUIT, DIE, ...?
        ;AllowRemoteOper = no
@@ -141,14 +158,19 @@
        # hash is generated after each server start.
        ;CloakHostSalt = abcdefghijklmnopqrstuvwxyz
 
-       # Set every clients' user name to their nick name
+       # Set every clients' user name to their nickname
        ;CloakUserToNick = yes
 
        # Try to connect to other IRC servers using IPv4 and IPv6, if possible.
        ;ConnectIPv6 = yes
        ;ConnectIPv4 = yes
 
-       # Do any DNS lookups when a client connects to the server.
+       # Default user mode(s) to set on new local clients. Please note that
+       # only modes can be set that the client could set on itself, you can't
+       # set "a" (away) or "o" (IRC Op), for example! Default: none.
+       ;DefaultUserModes = i
+
+       # Do DNS lookups when a client connects to the server.
        ;DNS = yes
 
        # Do IDENT lookups if ngIRCd has been compiled with support for it.
@@ -156,6 +178,10 @@
        # prepended to their user name.
        ;Ident = yes
 
+       # Directory containing configuration snippets (*.conf), that should
+       # be read in after parsing this configuration file.
+       ;IncludeDir = :ETCDIR:/conf.d
+
        # Enhance user privacy slightly (useful for IRC server on TOR or I2P)
        # by censoring some information like idle time, logon time, etc.
        ;MorePrivacy = no
@@ -194,9 +220,6 @@
        # character prepended to their respective user names!
        ;PAMIsOptional = no
 
-       # Allow Pre-Defined Channels only (see Section [Channels])
-       ;PredefChannelsOnly = no
-
        # Let ngIRCd send an "authentication PING" when a new client connects,
        # and register this client only after receiving the corresponding
        # "PONG" reply.
@@ -225,6 +248,13 @@
        # SSL Server Key Certificate
        ;CertFile = :ETCDIR:/ssl/server-cert.pem
 
+       # Select cipher suites allowed for SSL/TLS connections (OpenSSL only).
+       # This defaults to the empty string, so all supported ciphers are
+       # allowed. Please see 'man 1ssl ciphers' for details.
+       # The example below only allows "high strength" cipher suites, disables
+       # the ones without authentication, and sorts by strength:
+       ;CipherList = HIGH:!aNULL:@STRENGTH
+
        # Diffie-Hellman parameters
        ;DHFile = :ETCDIR:/ssl/dhparams.pem
 
@@ -241,7 +271,7 @@
        # [Operator] sections are used to define IRC Operators. There may be
        # more than one [Operator] block, one for each local operator.
 
-       # ID of the operator (may be different of the nick name)
+       # ID of the operator (may be different of the nickname)
        ;Name = TheOper
 
        # Password of the IRC operator
@@ -304,7 +334,7 @@
        # Connect to the remote server using TLS/SSL (Default: false)
        ;SSLConnect = yes
 
-       # Define a (case insensitive) list of masks matching nick names that
+       # 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 (",").
        # REGULAR SERVERS DON'T NEED this parameter, so leave it empty