New "chroot" feature (from Benjamin Pineau), introducing new configuration

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

diff --git a/doc/sample-ngircd.conf b/doc/sample-ngircd.conf
index 186a4ed6b5c98c5dbb4efcea68e09e87d21ce2b5..e8178a5a7483f6c010604d66b1c40b119f4c1992 100644 (file)
--- a/doc/sample-ngircd.conf
+++ b/doc/sample-ngircd.conf
@@ -1,13 +1,13 @@
-# $Id: sample-ngircd.conf,v 1.21 2003/04/27 11:45:27 alex Exp $
+# $Id: sample-ngircd.conf,v 1.26 2004/05/07 11:19:20 alex Exp $
 
 #
-# This is a sample configuration file for the ngIRCd, which must adept to
-# the local preferences and needs.
+# This is a sample configuration file for the ngIRCd, which must be adepted
+# to the local preferences and needs.
 #
 # Comments are started with "#" or ";".
 #
-# Author: Alexander Barton, <alex@barton.de>
-# Initial translation by Ilja Osthoff, <ilja@glide.ath.cx>
+# Use "ngircd --configtest" (see manual page ngircd(8)) to validate that the
+# server interpreted the configuration file as expected!
 #
 
 [Global]
@@ -16,7 +16,8 @@
        # configuration of the server, like the server name and the ports
        # on which the server should be listening.
        
-       # Server name in the IRC-network
+       # Server name in the IRC network, must contain at least one dot
+       # (".") and be unique in the IRC network. Required!
        Name = irc.the.net
        
        # Info text of the server. This will be shown by WHOIS and
@@ -27,7 +28,7 @@
        ;Password = abc
        
        # Information about the server and the administrator, used by the
-       # ADMIN command.
+       # ADMIN command. Not required by server but by RFC!
        ;AdminInfo1 = Description
        ;AdminInfo2 = Location
        ;AdminEMail = admin@irc.server
@@ -35,11 +36,19 @@
        # Ports on which the server should listen. There may be more than
        # one port, separated with ";". (Default: 6667)
        ;Ports = 6667, 6668, 66694
+
+       # IP address on which the server should listen. (Default: empty,
+       # so the server listens on all IP addresses of the system)
+       ;Listen = 1.2.3.4
        
        # 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
        # of the user or the numerical ID. ATTENTION: For this to work the
        # server must have been started with root privileges! In addition,
@@ -52,6 +61,13 @@
        # 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
+
        # After <PingTimeout> seconds of inactivity the server will send a
        # PING to the peer to test whether it is alive or not.
        ;PingTimeout = 120
@@ -71,6 +87,10 @@
        # Maximum number of simultaneous connection the server is allowed
        # to accept (<=0: unlimited):
        ;MaxConnections = -1
+       
+       # Maximum number of simultaneous connections from a single IP address
+       # the server will accept (<=0: unlimited):
+       ;MaxConnectionsIP = 5
 
        # Maximum number of channels a user can be member of (<=0: no limit):
        ;MaxJoins = 10