Browse Source

Update ngircd config from upstream version 18

Christoph Biedl 12 years ago
parent
commit
08db84c4d7
1 changed files with 133 additions and 90 deletions
  1. 133 90
      debian/ngircd.conf

+ 133 - 90
debian/ngircd.conf

@@ -12,7 +12,8 @@
 # Use "ngircd --configtest" (see manual page ngircd(8)) to validate that the
 # server interprets the configuration file as expected!
 #
-# Please see ngircd.conf(5) for a complete list of configuration options.
+# Please see ngircd.conf(5) for a complete list of configuration options
+# and their descriptions.
 #
 # The original can be found at:
 # /usr/share/doc/ngircd/examples/sample-ngircd.conf.gz
@@ -21,62 +22,29 @@
 	# 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.
+	# These settings depend on your personal preferences, so you should
+	# make sure that they correspond to your installation and setup!
 
 	# Server name in the IRC network, must contain at least one dot
 	# (".") and be unique in the IRC network. Required!
 	Name = irc.example.net
 
-	# Info text of the server. This will be shown by WHOIS and
-	# LINKS requests for example.
-	Info = Yet another IRC Server running on Debian GNU/Linux
-
-	# Global password for all users needed to connect to the server
-	# (Default: not set)
-	;Password = wealllikedebian
-
-	# Password required for using the WEBIRC command used by some
-	# Web-to-IRC gateways. If not set/empty, the WEBIRC command can't
-	# be used. (Default: not set)
-	;WebircPassword = xyz
-
 	# Information about the server and the administrator, used by the
 	# ADMIN command. Not required by server but by RFC!
 	AdminInfo1 = Debian User
 	AdminInfo2 = Debian City
-	AdminEMail = root@localhost
-
-	# Ports on which the server should listen. There may be more than
-	# one port, separated with ",". (Default: 6667)
-	;Ports = 6667, 6668, 6669
-
-	# Additional Listen Ports that expect SSL/TLS encrypted connections
-	;SSLPorts = 6697, 9999
-
-	# SSL Server Key
-        ;SSLKeyFile = /etc/ssl/private/server.key
-
-	# password to decrypt SSLKeyFile (OpenSSL only)
-	;SSLKeyFilePassword = secret
+	AdminEMail = irc@irc.example.com
 
-	# SSL Server Key Certificate
-	;SSLCertFile = /etc/ssl/certs/server.crt
-
-	# Diffie-Hellman parameters
-	;SSLDHFile = /etc/ngircd/dhparams.pem
+	# Info text of the server. This will be shown by WHOIS and
+	# LINKS requests for example.
+	Info = Yet another IRC Server running on Debian GNU/Linux
 
-	# comma separated list of IP addresses on which the server should
+	# Comma separated list of IP addresses on which the server should
 	# listen. Default values are:
 	# "0.0.0.0" or (if compiled with IPv6 support) "::,0.0.0.0"
 	# so the server listens on all IP addresses of the system by default.
 	;Listen = 127.0.0.1,192.168.0.1
 
-	# Syslog "facility" to which ngIRCd should send log messages.
-	# Possible values are system dependant, but most probably auth, daemon,
-	# user and local1 through local7 are possible values; see syslog(3).
-	# Default is "local5" for historical reasons, you probably want to
-	# change this to "daemon", for example.
-	SyslogFacility = local1
-
 	# Text file with the "message of the day" (MOTD). This message will
 	# be shown to all users connecting to the server:
 	MotdFile = /etc/ngircd/ngircd.motd
@@ -84,6 +52,27 @@
 	# A simple Phrase (<256 chars) if you don't want to use a motd file.
 	;MotdPhrase = "Hello. This is the Debian default MOTD sentence"
 
+	# Global password for all users needed to connect to the server.
+	# (Default: not set)
+	;Password = wealllikedebian
+
+	# This tells ngIRCd to write its current process ID to a file.
+	# Note that the pidfile is written AFTER chroot and switching the
+	# user ID, e.g. the directory the pidfile resides in must be
+	# writeable by the ngIRCd user and exist in the chroot directory.
+	# Keep this setting in sync with PIDFILE in /etc/init.d/ngircd
+	PidFile = /var/run/ngircd/ngircd.pid
+
+	# Ports on which the server should listen. There may be more than
+	# one port, separated with ",". (Default: 6667)
+	;Ports = 6667, 6668, 6669
+
+	# 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!
+	# Keep this setting in sync with DAEMONUSER in /etc/init.d/ngircd
+	ServerGID = irc
+
 	# 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,
@@ -92,24 +81,29 @@
 	# Keep this setting in sync with DAEMONUSER in /etc/init.d/ngircd
 	ServerUID = irc
 
-	# 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 = irc
+[Limits]
+	# Define some limits and timeouts for this ngIRCd instance. Default
+	# values should be safe, but it is wise to double-check :-)
 
-	# 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
+	# The server tries every <ConnectRetry> seconds to establish a link
+	# to not yet (or no longer) connected servers.
+	ConnectRetry = 60
 
-	# 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.
-	# Keep this setting in sync with PIDFILE in /etc/init.d/ngircd
-	PidFile = /var/run/ngircd/ngircd.pid
+	# Maximum number of simultaneous in- and outbound connections the
+	# server is allowed to accept (0: unlimited):
+	MaxConnections = 500
+
+	# Maximum number of simultaneous connections from a single IP address
+	# the server will accept (0: unlimited):
+	MaxConnectionsIP = 10
+
+	# Maximum number of channels a user can be member of (0: no limit):
+	MaxJoins = 10
+
+	# Maximum length of an user nick name (Default: 9, as in RFC 2812).
+	# Please note that all servers in an IRC network MUST use the same
+	# maximum nick name length!
+	;MaxNickLength = 9
 
 	# After <PingTimeout> seconds of inactivity the server will send a
 	# PING to the peer to test whether it is alive or not.
@@ -119,55 +113,104 @@
 	# seconds, it will be disconnected by the server.
 	PongTimeout = 20
 
-	# The server tries every <ConnectRetry> seconds to establish a link
-	# to not yet (or no longer) connected servers.
-	ConnectRetry = 60
+[Options]
+	# Optional features and configuration options to further tweak the
+	# behavior of ngIRCd. If you want to get started quickly, you most
+	# probably don't have to make changes here -- they are all optional.
+
+	# Are remote IRC operators allowed to control this server, e.g.
+	# use commands like CONNECT, SQUIT, DIE, ...?
+	;AllowRemoteOper = no
+
+	# 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
+
+	# Set this hostname for every client instead of the real one.
+	# Please note: don't use the percentage sign ("%"), it is reserved for
+	# future extensions!
+	;CloakHost = irc.example.net
+
+	# Set every clients' user name to their nick name
+	;CloakUserToNick = yes
+
+	# Try to connect to other irc servers using ipv4 and ipv6, if possible
+	;ConnectIPv6 = yes
+	;ConnectIPv4 = yes
+
+	# Don do any DNS lookups when a client connects to the server.
+	;DNS = yes
+
+	# Do IDENT lookups, if ngIRCd has been compiled with support for it.
+	;Ident = yes
+
+	# Enhance user privacy slightly (useful for IRC server on TOR or I2P)
+	# by censoring some information like idle time, logon time, etc.
+	;MorePrivacy = no
+
+	# Normally ngIRCd doesn't send any messages to a client until it is
+	# registered. Enable this option to let the daemon send "NOTICE AUTH"
+	# messages to clients while connecting.
+	;NoticeAuth = no
 
 	# Should IRC Operators be allowed to use the MODE command even if
 	# they are not(!) channel-operators?
 	OperCanUseMode = yes
 
-	# Are remote IRC operators allowed to control this server, e. g.
-	# use commands like CONNECT, SQUIT, DIE, ...?
-	;AllowRemoteOper = 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
+
+	# Use PAM if ngIRCd has been compiled with support for it.
+	PAM = no
 
 	# Allow Pre-Defined Channels only (see Section [Channels])
 	;PredefChannelsOnly = no
 
-	# Don't do any DNS lookups when a client connects to the server.
-	;NoDNS = no
+	# Let ngIRCd send an "authentication PING" when a new client connects,
+	# and register this client only after receiving the corresponding
+	# "PONG" reply.
+	;RequireAuthPing = no
 
-	# Don't do any IDENT lookups, even if ngIRCd has been compiled
-	# with support for it.
-	;NoIdent = no
+	# Silently drop all incoming CTCP requests.
+	;ScrubCTCP = no
 
-	# Don't use PAM, even if ngIRCd has been compiled with support for it.
-	NoPAM = no
+	# Syslog "facility" to which ngIRCd should send log messages.
+	# Possible values are system dependent, but most probably auth, daemon,
+	# user and local1 through local7 are possible values; see syslog(3).
+	# Default is "local5" for historical reasons, you probably want to
+	# change this to "daemon", for example.
+	SyslogFacility = local1
 
-	# Don't use ZeroConf service registration, even if ngIRCd has been
-	# compiled with support for it (e.g. Howl, Avahi, Mac OS X).
-	# Note: This Debian package was compiled without ZeroConf support
-	;NoZeroConf = no
+	# Password required for using the WEBIRC command used by some
+	# Web-to-IRC gateways. If not set/empty, the WEBIRC command can't
+	# be used. (Default: not set)
+	;WebircPassword = xyz
 
-	# try to connect to other irc servers using ipv4 and ipv6, if possible
-	;ConnectIPv6 = yes
-	;ConnectIPv4 = yes
+;[SSL]
+	# SSL-related configuration options. Please note that this section
+	# is only available when ngIRCd is compiled with support for SSL!
+	# So don't forget to remove the ";" above if this is the case ...
 
-	# Maximum number of simultaneous in- and outbound connections the
-	# server is allowed to accept (0: unlimited):
-	MaxConnections = 500
+	# SSL Server Key Certificate
+	;CertFile = /etc/ssl/certs/server.crt
 
-	# Maximum number of simultaneous connections from a single IP address
-	# the server will accept (0: unlimited):
-	MaxConnectionsIP = 10
+	# Diffie-Hellman parameters
+	;DHFile = /etc/ngircd/dhparams.pem
 
-	# Maximum number of channels a user can be member of (0: no limit):
-	MaxJoins = 10
+	# SSL Server Key
+	;KeyFile = /etc/ssl/private/server.key
 
-	# Maximum length of an user nick name (Default: 9, as in RFC 2812).
-	# Please note that all servers in an IRC network MUST use the same
-	# maximum nick name length!
-	;MaxNickLength = 9
+	# password to decrypt SSLKeyFile (OpenSSL only)
+	# Note that this Debian package was linked against GnuTLS so this
+	# option has no effect.
+	;KeyFilePassword = secret
+
+	# Additional Listen Ports that expect SSL/TLS encrypted connections
+	;Ports = 6697, 9999
 
 [Operator]
 	# [Operator] sections are used to define IRC Operators. There may be
@@ -205,7 +248,7 @@
 
 	# Internet host name or IP address of the peer (only required when
 	# this server should establish the connection).
-	;Host = connect-to-host.the.net
+	;Host = connect-to-host.example.net
 
 	# IP address to use as _source_ address for the connection. if
 	# unspecified, ngircd will let the operating system pick an address.