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 f136d27ce4973770dcd6b2c473deb0446412ab16..48bb996ee75bc3699c0f3a54592bb96124d746f8 100644 (file)
--- a/doc/sample-ngircd.conf
+++ b/doc/sample-ngircd.conf
@@ -1,4 +1,4 @@
-# $Id: sample-ngircd.conf,v 1.25 2003/12/19 14:32:59 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
@@ -11,7 +11,6 @@
 #
 
 [Global]
-
        # The [Global] section of this file is used to define the main
        # configuration of the server, like the server name and the ports
        # on which the server should be listening.
@@ -34,8 +33,8 @@
        ;AdminEMail = admin@irc.server
  
        # Ports on which the server should listen. There may be more than
-       # one port, separated with ";". (Default: 6667)
-       ;Ports = 6667, 6668, 66694
+       # one port, separated with ",". (Default: 6667)
+       ;Ports = 6667, 6668, 6669
 
        # IP address on which the server should listen. (Default: empty,
        # so the server listens on all IP addresses of the system)
@@ -45,6 +44,10 @@
        # 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
        # of the user or the numerical ID. ATTENTION: For this to work the
        # server must have been started with root privileges! In addition,
@@ -57,6 +60,19 @@
        # server must have been started with root privileges!
        ;ServerGID = 65534
 
+       # A directory to chroot in when everything is initialized. It
+       # doesn't need to be populated if ngIRCd is compiled as a static
+       # binary. By default ngIRCd won't use the chroot() feature.
+       # ATTENTION: For this to work the server must have been started
+       # 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
@@ -73,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
@@ -94,6 +114,12 @@
        # 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 ...
+
 [Server]
        # Other servers are configured in [Server] sections. If you
        # configure a port for the connection, then this ngircd tries to
@@ -108,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.
@@ -129,6 +157,9 @@
        # Group of this server (optional)
        ;Group = 123
 
+[Server]
+       # More [Server] sections, if you like ...
+
 [Channel]
        # Pre-defined channels can be configured in [Channel] sections.
        # Such channels are created by the server when starting up and even
@@ -146,4 +177,7 @@
        # Initial channel modes
        ;Modes = tn
 
+[Channel]
+       # More [Channel] sections, if you like ...
+
 # -eof-