New configuration variable "PidFile", section "[Global]": if defined,

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

diff --git a/doc/sample-ngircd.conf b/doc/sample-ngircd.conf
index 0e4439309a9c16c7e9519a471c916d8ba7096df4..a34f04801ed84b6c6a071a86d6811fe66293660e 100644 (file)
--- a/doc/sample-ngircd.conf
+++ b/doc/sample-ngircd.conf
@@ -1,23 +1,22 @@
-# $Id: sample-ngircd.conf,v 1.24 2003/11/05 21:41:02 alex Exp $
+# $Id: sample-ngircd.conf,v 1.30 2005/02/04 14:24:21 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]
-
        # 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.
        
        # Server name in the IRC network, must contain at least one dot
-       # (".") and be unique in the IRC network.
+       # (".") and be unique in the IRC network. Required!
        Name = irc.the.net
        
        # Info text of the server. This will be shown by WHOIS and
@@ -28,14 +27,14 @@
        ;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
  
        # 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 dir.
+       ;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
@@ -94,6 +110,9 @@
        # Password of the IRC operator
        ;Password = ThePwd
 
+[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
@@ -129,6 +148,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 +168,7 @@
        # Initial channel modes
        ;Modes = tn
 
+[Channel]
+       # More [Channel] sections, if you like ...
+
 # -eof-