New configuration option "NoZeroConf" to disable ZeroConf registration

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

diff --git a/doc/sample-ngircd.conf b/doc/sample-ngircd.conf
index 459d51d4e1765054735c97430939f4178e8df61f..fe34dffae1afc58230ecd4335ac4ebbb9eca972e 100644 (file)
--- a/doc/sample-ngircd.conf
+++ b/doc/sample-ngircd.conf
@@ -1,14 +1,13 @@
-# $Id: sample-ngircd.conf,v 1.44 2008/01/07 23:02:29 alex Exp $
-
 #
-# This is a sample configuration file for the ngIRCd, which must be adepted
-# to the local preferences and needs.
+# This is a sample configuration file for the ngIRCd IRC daemon, which must
+# be customized to the local preferences and needs.
 #
 # Comments are started with "#" or ";".
 #
 # A lot of configuration options in this file start with a ";". You have
 # to remove the ";" in front of each variable to actually set a value!
-# The disabled variables are shown with example values for completeness.
+# The disabled variables are shown with example values for completeness only
+# and the daemon is using compiled-in default settings.
 #
 # Use "ngircd --configtest" (see manual page ngircd(8)) to validate that the
 # server interprets the configuration file as expected!
@@ -29,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
@@ -43,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
@@ -57,18 +62,24 @@
        # 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.
        ;Listen = 127.0.0.1,192.168.0.1
 
+       # Syslog "facility" to which ngIRCd should send log messages.
+       # Possible values are system dependant, but most probably auth, daemon,
+       # user and local1 through local7 are possible values; see syslog(3).
+       # Default is "local5" for historical reasons, you probably want to
+       # change this to "daemon", for example.
+       SyslogFacility = local1
+
        # Text file with the "message of the day" (MOTD). This message will
        # be shown to all users connecting to the server:
        ;MotdFile = /usr/local/etc/ngircd.motd
 
        # A simple Phrase (<256 chars) if you don't want to use a motd file.
-       # If it is set no MotdFile will be read at all.
        ;MotdPhrase = "Hello world!"
 
        # User ID under which the server should run; you can use the name
@@ -116,12 +127,27 @@
        # 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
 
        # Don't do any DNS lookups when a client connects to the server.
        ;NoDNS = no
 
+       # Don't do any IDENT lookups, even if ngIRCd has been compiled
+       # with support for it.
+       ;NoIdent = no
+
+       # Don't use PAM, even if ngIRCd has been compiled with support for it.
+       ;NoPAM = no
+
+       # Don't use ZeroConf service registration, even if ngIRCd has been
+       # compiled with support for it (e.g. Howl, Avahi, Mac OS X).
+       ;NoZeroConf = no
+
        # try to connect to other irc servers using ipv4 and ipv6, if possible
        ;ConnectIPv6 = yes
        ;ConnectIPv4 = yes
@@ -207,15 +233,15 @@
        ;Passive = no
 
        # Connect to the remote server using TLS/SSL (Default: false)
-       ; SSLConnect = yes
+       ;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
 
@@ -242,6 +268,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