Enhanced documentation. Use "default" port 6667 in the example for server links.

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

diff --git a/doc/sample-ngircd.conf b/doc/sample-ngircd.conf
index 534af79c1f00bdd3f12d275b26a5a7d9701cd92b..48bb996ee75bc3699c0f3a54592bb96124d746f8 100644 (file)
--- a/doc/sample-ngircd.conf
+++ b/doc/sample-ngircd.conf
@@ -1,4 +1,4 @@
-# $Id: sample-ngircd.conf,v 1.28 2004/12/27 00:55:06 alex Exp $
+# $Id: sample-ngircd.conf,v 1.36 2006/01/09 11:03:35 alex Exp $
 
 #
 # This is a sample configuration file for the ngIRCd, which must be adepted
@@ -33,7 +33,7 @@
        ;AdminEMail = admin@irc.server
  
        # Ports on which the server should listen. There may be more than
-       # one port, separated with ";". (Default: 6667)
+       # one port, separated with ",". (Default: 6667)
        ;Ports = 6667, 6668, 6669
 
        # IP address on which the server should listen. (Default: empty,
@@ -67,6 +67,12 @@
        # with root privileges!
        ;ChrootDir = /var/empty
 
+       # This tells ngircd to write its current process id to a file.
+       # Note that the pidfile is written AFTER chroot and switching uid,
+       # i. e. the Directory the pidfile resides in must be writeable by
+       # the ngircd user and exist in the chroot directory.
+       ;PidFile = /var/run/ngircd/ngircd.pid
+
        # After <PingTimeout> seconds of inactivity the server will send a
        # PING to the peer to test whether it is alive or not.
        ;PingTimeout = 120
@@ -83,6 +89,10 @@
        # they are not(!) channel-operators?
        ;OperCanUseMode = no
 
+       # Mask IRC Operator mode requests as if they were coming from the
+       # server? (This is a compatibility hack for ircd-irc2 servers)
+       ;OperServerMode = no
+       
        # Maximum number of simultaneous connection the server is allowed
        # to accept (<=0: unlimited):
        ;MaxConnections = -1
@@ -104,6 +114,9 @@
        # Password of the IRC operator
        ;Password = ThePwd
 
+       # Optional Mask from which /OPER will be accepted
+       ;Mask = *!ident@somewhere.example.com
+
 [Operator]
        # More [Operator] sections, if you like ...
 
@@ -121,15 +134,17 @@
        # in the given group. But the ngircd never tries to connect to two
        # servers with the same group ID.
        
-       # IRC name of the server
+       # IRC name of the remote server, must match the "Name" variable in
+       # the [Global] section of the other server (when using ngIRCd).
        ;Name = irc2.the.net
    
-       # Internet host name of the peer
+       # Internet host name or IP address of the peer (only required when
+       # this server should establish the connection).
        ;Host = connect-to-host.the.net
 
        # Port of the server to which the ngIRCd should connect. If you
        # assign no port the ngIRCd waits for incoming connections.
-       ;Port = 6666
+       ;Port = 6667
 
        # Own password for the connection. This password has to be configured
        # as "PeerPassword" on the other server.