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 f136d27ce4973770dcd6b2c473deb0446412ab16..e8178a5a7483f6c010604d66b1c40b119f4c1992 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.26 2004/05/07 11:19:20 alex Exp $

 
 #
 # This is a sample configuration file for the ngIRCd, which must be adepted
 
 #
 # This is a sample configuration file for the ngIRCd, which must be adepted


@@ -45,6 +45,10 @@
        # be shown to all users connecting to the server:
        ;MotdFile = /usr/local/etc/ngircd.motd
 
        # 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,
        # 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 +61,13 @@
        # server must have been started with root privileges!
        ;ServerGID = 65534
 
        # 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
        # After <PingTimeout> seconds of inactivity the server will send a
        # PING to the peer to test whether it is alive or not.
        ;PingTimeout = 120