Initial documentation for using PAM with ngIRCd

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

diff --git a/doc/sample-ngircd.conf b/doc/sample-ngircd.conf
index 041542e7d6a68b8586ebcb8c448a57adcae06dbe..daa0801211af2d60088520b9410fef1abf0483a8 100644 (file)
--- a/doc/sample-ngircd.conf
+++ b/doc/sample-ngircd.conf
@@ -28,9 +28,15 @@
        # LINKS requests for example.
        Info = Server Info Text
 
-       # Global password for all users needed to connect to the server
+       # Global password for all users needed to connect to the server.
+       # (Default: not set)
        ;Password = abc
 
+       # Password required for using the WEBIRC command used by some
+       # Web-to-IRC gateways. If not set/empty, the WEBIRC command can't
+       # be used. (Default: not set)
+       ;WebircPassword = xyz
+
        # Information about the server and the administrator, used by the
        # ADMIN command. Not required by server but by RFC!
        ;AdminInfo1 = Description
@@ -42,7 +48,7 @@
        ;Ports = 6667, 6668, 6669
 
        # Additional Listen Ports that expect SSL/TLS encrypted connections
-       ;SSLPorts = 9999,6668
+       ;SSLPorts = 6697, 9999
 
        # SSL Server Key
         ;SSLKeyFile = /usr/local/etc/ngircd/ssl/server-key.pem
@@ -56,7 +62,7 @@
        # Diffie-Hellman parameters
        ;SSLDHFile = /usr/local/etc/ngircd/ssl/dhparams.pem
 
-       # comma seperated list of IP addresses on which the server should
+       # 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.
@@ -115,6 +121,10 @@
        # server? (This is a compatibility hack for ircd-irc2 servers)
        ;OperServerMode = no
 
+       # Are remote IRC operators allowed to control this server, e. g.
+       # use commands like CONNECT, SQUIT, DIE, ...?
+       ;AllowRemoteOper = no
+
        # Allow Pre-Defined Channels only (see Section [Channels])
        ;PredefChannelsOnly = no
 
@@ -212,13 +222,13 @@
        # Connect to the remote server using TLS/SSL (Default: false)
        ;SSLConnect = yes
 
-       # Define a (case insensitive) mask matching nick names that sould be
+       # 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" amd "ChanServ", you should set this parameter to
+       # "NickServ" and "ChanServ", you should set this parameter to
        # something like "*Serv".
        ;ServiceMask = *Serv
 
@@ -245,6 +255,10 @@
        # initial channel password (mode k)
        ;Key = Secret
 
+       # Key file, syntax for each line: "<user>:<nick>:<key>".
+       # Default: none.
+       ;KeyFile = /etc/ngircd/#chan.key
+
        # maximum users per channel (mode l)
        ;MaxUsers = 23