-# $Id: sample-ngircd.conf,v 1.22 2003/04/29 12:36:09 alex Exp $
+# $Id: sample-ngircd.conf,v 1.39 2006/12/29 14:09:48 fw 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 interprets 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
# LINKS requests for example.
Info = Server Info Text
# Global password for all users needed to connect to the server
;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)
+ ;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,
# 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
# 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
+
+ # Allow Pre-Defined Channels only (see Section [Channels])
+ ;PredefChannelsOnly = no
+
# 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
[Operator]
# [Operator] sections are used to define IRC Operators. There may be
# more than one [Operator] block, one for each local operator.
-
+
# ID of the operator (may be different of the nick name)
;Name = TheOper
# 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
# connect to to the other server on the given port; if not it waits
# for the other server to connect.
- # There may be more than one server block.
+ # There may be more than one server block, one for each server.
#
# Server Groups:
# The ngIRCd allows "server groups": You can assign an "ID" to every
# group won't answer, the ngIRCd tries to connect to the next server
# 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.
# Foreign password for this connection. This password has to be
# configured as "MyPassword" on the other server.
;PeerPassword = PeerSecret
-
+
# 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
# persist when there are no more members left.
# Persistent channels are marked with the mode 'P', which can be set
# and unset by IRC operators like other modes on the fly.
- # There may be more than one [Channel] block.
-
+ # There may be more than one [Channel] block, one for each channel.
+
# Name of the channel
;Name = #TheName
# Topic for this channel
;Topic = a great topic
-
+
# Initial channel modes
- ;Modes = tn
+ ;Modes = tnk
+
+ # initial channel password (mode k)
+ ;Key = Secret
+
+ # maximum users per channel (mode l)
+ ;MaxUsers = 23
+
+[Channel]
+ # More [Channel] sections, if you like ...
# -eof-
projects / ngircd-alex.git / blobdiff