ngIRCd Release 22

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

diff --git a/doc/sample-ngircd.conf b/doc/sample-ngircd.conf
index 3cf53a6872c51ce8f6b91c7d01a78fefe1626fa9..4eb3c9250946922adbfab8e160f9ed8e660e3d80 100644 (file)
--- a/doc/sample-ngircd.conf
+++ b/doc/sample-ngircd.conf
@@ -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 = /usr/local/share/doc/ngircd/Commands.txt
+
        # Info text of the server. This will be shown by WHOIS and
        # LINKS requests for example.
        Info = Server Info Text
@@ -45,7 +49,7 @@
 
        # Text file with the "message of the day" (MOTD). This message will
        # be shown to all users connecting to the server:
-       ;MotdFile = /opt/ngircd/alex.git/etc/ngircd.motd
+       ;MotdFile = /usr/local/etc/ngircd.motd
 
        # A simple Phrase (<256 chars) if you don't want to use a motd file.
        ;MotdPhrase = "Hello world!"
@@ -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
@@ -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
@@ -148,7 +165,12 @@
        ;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 = /usr/local/etc/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.
@@ -223,13 +246,22 @@
        # So don't forget to remove the ";" above if this is the case ...
 
        # SSL Server Key Certificate
-       ;CertFile = /opt/ngircd/alex.git/etc/ssl/server-cert.pem
+       ;CertFile = /usr/local/etc/ssl/server-cert.pem
+
+       # Select cipher suites allowed for SSL/TLS connections. This defaults
+       # to HIGH:!aNULL:@STRENGTH (OpenSSL) or SECURE128 (GnuTLS).
+       # See 'man 1ssl ciphers' (OpenSSL) or 'man 3 gnutls_priority_init'
+       # (GnuTLS) for details.
+       # For OpenSSL:
+       ;CipherList = HIGH:!aNULL:@STRENGTH
+       # For GnuTLS:
+       ;CipherList = SECURE128
 
        # Diffie-Hellman parameters
-       ;DHFile = /opt/ngircd/alex.git/etc/ssl/dhparams.pem
+       ;DHFile = /usr/local/etc/ssl/dhparams.pem
 
        # SSL Server Key
-       ;KeyFile = /opt/ngircd/alex.git/etc/ssl/server-key.pem
+       ;KeyFile = /usr/local/etc/ssl/server-key.pem
 
        # password to decrypt SSLKeyFile (OpenSSL only)
        ;KeyFilePassword = secret
@@ -340,7 +372,7 @@
 
        # Key file, syntax for each line: "<user>:<nick>:<key>".
        # Default: none.
-       ;KeyFile = /opt/ngircd/alex.git/etc/#chan.key
+       ;KeyFile = /usr/local/etc/#chan.key
 
        # maximum users per channel (mode l)
        ;MaxUsers = 23