1
0
mirror of https://github.com/osmarks/ngircd.git synced 2024-12-13 10:20:28 +00:00
ngircd/doc/sample-ngircd.conf

182 lines
6.0 KiB
Plaintext
Raw Normal View History

# $Id: sample-ngircd.conf,v 1.35 2005/09/02 14:38:59 fw Exp $
#
# This is a sample configuration file for the ngIRCd, which must be adepted
# to the local preferences and needs.
#
# Comments are started with "#" or ";".
#
# Use "ngircd --configtest" (see manual page ngircd(8)) to validate that the
# server interpreted the configuration file as expected!
#
[Global]
2003-03-10 00:23:34 +00:00
# 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. Required!
Name = irc.the.net
2003-03-10 00:23:34 +00:00
# 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
2002-09-16 10:33:09 +00:00
2003-03-10 00:23:34 +00:00
# Information about the server and the administrator, used by the
# ADMIN command. Not required by server but by RFC!
;AdminInfo1 = Description
;AdminInfo2 = Location
2002-09-16 10:33:09 +00:00
;AdminEMail = admin@irc.server
2003-03-10 00:23:34 +00:00
# Ports on which the server should listen. There may be more than
# one port, separated with ",". (Default: 6667)
2004-12-27 00:48:59 +00:00
;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
2003-03-10 00:23:34 +00:00
# Text file with the "message of the day" (MOTD). This message will
# be shown to all users connecting to the server:
2002-03-29 23:41:23 +00:00
;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!"
2003-03-10 00:23:34 +00:00
# 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,
# the configuration and MOTD files must be readable by this user,
# otherwise RESTART and REHASH won't work!
;ServerUID = 65534
2002-03-29 23:41:23 +00:00
2003-03-10 00:23:34 +00:00
# Group ID under which the ngircd should run; you can use the name
# of the group or the numerical ID. ATTENTION: For this to work the
# 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.
2005-03-15 16:58:01 +00:00
# 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
2003-03-10 00:23:34 +00:00
# After <PingTimeout> seconds of inactivity the server will send a
# PING to the peer to test whether it is alive or not.
2002-03-29 23:41:23 +00:00
;PingTimeout = 120
2003-03-10 00:23:34 +00:00
# If a client fails to answer a PING with a PONG within <PongTimeout>
# seconds, it will be disconnected by the server.
2002-03-29 23:41:23 +00:00
;PongTimeout = 20
2003-03-10 00:23:34 +00:00
# The server tries every <ConnectRetry> seconds to establish a link
# to not yet (or no longer) connected servers.
2002-03-29 23:41:23 +00:00
;ConnectRetry = 60
2003-03-10 00:23:34 +00:00
# Should IRC Operators be allowed to use the MODE command even if
# they are not(!) channel-operators?
2002-09-16 10:33:09 +00:00
;OperCanUseMode = no
2005-03-15 16:58:01 +00:00
# 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
# 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):
2002-12-14 13:32:30 +00:00
;MaxJoins = 10
[Operator]
2003-03-10 00:23:34 +00:00
# [Operator] sections are used to define IRC Operators. There may be
# more than one [Operator] block, one for each local operator.
2003-03-10 00:23:34 +00:00
# ID of the operator (may be different of the nick name)
;Name = TheOper
2003-03-10 00:23:34 +00:00
# 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]
2003-03-10 00:23:34 +00:00
# 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.
#
2003-03-10 00:23:34 +00:00
# Server Groups:
# The ngIRCd allows "server groups": You can assign an "ID" to every
# server with which you want this ngIRCd to link. If a server of a
# 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.
2003-03-10 00:23:34 +00:00
# IRC name of the server
;Name = irc2.the.net
2003-03-10 00:23:34 +00:00
# Internet host name of the peer
2002-12-18 12:19:07 +00:00
;Host = connect-to-host.the.net
2003-03-10 00:23:34 +00:00
# Port of the server to which the ngIRCd should connect. If you
# assign no port the ngIRCd waits for incoming connections.
;Port = 6666
# Own password for the connection. This password has to be configured
# as "PeerPassword" on the other server.
;MyPassword = MySecret
# Foreign password for this connection. This password has to be
# configured as "MyPassword" on the other server.
;PeerPassword = PeerSecret
2003-03-10 00:23:34 +00:00
# Group of this server (optional)
;Group = 123
[Server]
# More [Server] sections, if you like ...
2002-05-21 00:09:53 +00:00
[Channel]
2003-03-10 00:23:34 +00:00
# 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.
# Name of the channel
2002-05-21 00:09:53 +00:00
;Name = #TheName
2003-03-10 00:23:34 +00:00
# Topic for this channel
;Topic = a great topic
2003-03-10 00:23:34 +00:00
# Initial channel modes
2002-05-21 00:09:53 +00:00
;Modes = tn
[Channel]
# More [Channel] sections, if you like ...
# -eof-