kevin pushed to ngircd (f21). "Sync ngircd.conf with sample template version. Fixes bug #1149012"

[notifications at fedoraproject.org]

>From 4159265779326dfad5227edbc7b32d3842328c23 Mon Sep 17 00:00:00 2001
From: Kevin Fenzi <kevin at scrye.com>
Date: Fri, 3 Oct 2014 16:07:04 -0600
Subject: Sync ngircd.conf with sample template version. Fixes bug #1149012


diff --git a/ngircd.conf b/ngircd.conf
index 6310468..0775060 100644
--- a/ngircd.conf
+++ b/ngircd.conf
@@ -1,34 +1,31 @@
-# $Id$
-
 #
-# This is a sample configuration file for the ngIRCd, which must be adepted
-# to the local preferences and needs.
+# This is a sample configuration file for the ngIRCd IRC daemon, which must
+# be customized to the local preferences and needs.
 #
 # Comments are started with "#" or ";".
 #
 # A lot of configuration options in this file start with a ";". You have
 # to remove the ";" in front of each variable to actually set a value!
-# The disabled variables are shown with example values for completeness.
+# The disabled variables are shown with example values for completeness only
+# and the daemon is using compiled-in default settings.
 #
 # 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
+# and their descriptions.
+#
 
 [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.
+	# 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.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
+	Name = irc.example.net
 
 	# Information about the server and the administrator, used by the
 	# ADMIN command. Not required by server but by RFC!
@@ -36,11 +33,15 @@
 	;AdminInfo2 = Location
 	;AdminEMail = admin at irc.server
 
-	# Ports on which the server should listen. There may be more than
-	# one port, separated with ",". (Default: 6667)
-	;Ports = 6667, 6668, 6669
+	# Text file which contains the ngIRCd help text. This file is required
+	# to display help texts when using the "HELP <cmd>" command.
+	;HelpFile = :DOCDIR:/Commands.txt
+
+	# Info text of the server. This will be shown by WHOIS and
+	# LINKS requests for example.
+	Info = Server Info Text
 
-	# comma seperated 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.
@@ -48,12 +49,30 @@
 
 	# Text file with the "message of the day" (MOTD). This message will
 	# be shown to all users connecting to the server:
-	;MotdFile = /etc/ngircd.motd
+	;MotdFile = :ETCDIR:/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!"
 
+	# Global password for all users needed to connect to the server.
+	# (Default: not set)
+	;Password = abc
+
+	# 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
+	# writable by the ngIRCd user and exist in the chroot directory.
+	;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!
+	ServerGID = ngircd
+
 	# 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,
@@ -61,23 +80,40 @@
 	# otherwise RESTART and REHASH won't work!
 	ServerUID = ngircd
 
-	# 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 = ngircd
+[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
+
+	# Number of seconds after which the whole daemon should shutdown when
+	# no connections are left active after handling at least one client
+	# (0: never, which is the default).
+	# This can be useful for testing or when ngIRCd is started using
+	# "socket activation" with systemd(8), for example.
+	;IdleTimeout = 0
 
-	# 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
+	# Maximum number of simultaneous in- and outbound connections the
+	# server is allowed to accept (0: unlimited):
+	;MaxConnections = 0
+
+	# 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
+
+	# Maximum length of an user nickname (Default: 9, as in RFC 2812).
+	# Please note that all servers in an IRC network MUST use the same
+	# maximum nickname length!
+	;MaxNickLength = 9
+
+	# Maximum number of channels returned in response to a /list
+	# command (0: unlimited):
+	;MaxListSize = 100
 
 	# After <PingTimeout> seconds of inactivity the server will send a
 	# PING to the peer to test whether it is alive or not.
@@ -87,49 +123,157 @@
 	# 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.
 
-	# Should IRC Operators be allowed to use the MODE command even if
-	# they are not(!) channel-operators?
-	;OperCanUseMode = no
+	# List of allowed channel types (channel prefixes) for newly created
+	# channels on the local server. By default, all supported channel
+	# types are allowed. Set this variable to the empty string to disallow
+	# creation of new channels by local clients at all.
+	;AllowedChannelTypes = #&+
 
-	# Mask IRC Operator mode requests as if they were coming from the
-	# server? (This is a compatibility hack for ircd-irc2 servers)
-	;OperServerMode = no
+	# Are remote IRC operators allowed to control this server, e.g.
+	# use commands like CONNECT, SQUIT, DIE, ...?
+	;AllowRemoteOper = no
 
-	# Allow Pre-Defined Channels only (see Section [Channels])
-	;PredefChannelsOnly = 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.
+	# Use %x to add the hashed value of the original hostname.
+	;CloakHost = cloaked.host
+
+	# Use this hostname for hostname cloaking on clients that have the
+	# user mode "+x" set, instead of the name of the server.
+	# Use %x to add the hashed value of the original hostname.
+	;CloakHostModeX = cloaked.user
 
-	# Don't do any DNS lookups when a client connects to the server.
-	;NoDNS = no
+	# The Salt for cloaked hostname hashing. When undefined a random
+	# hash is generated after each server start.
+	;CloakHostSalt = abcdefghijklmnopqrstuvwxyz
 
-	# try to connect to other irc servers using ipv4 and ipv6, if possible
+	# Set every clients' user name to their nickname
+	;CloakUserToNick = yes
+
+	# Try to connect to other IRC servers using IPv4 and IPv6, if possible.
 	;ConnectIPv6 = yes
 	;ConnectIPv4 = yes
 
-	# Maximum number of simultaneous connection the server is allowed
-	# to accept (0: unlimited):
-	;MaxConnections = 0
+	# Default user mode(s) to set on new local clients. Please note that
+	# only modes can be set that the client could set on itself, you can't
+	# set "a" (away) or "o" (IRC Op), for example! Default: none.
+	;DefaultUserModes = i
 
-	# Maximum number of simultaneous connections from a single IP address
-	# the server will accept (0: unlimited):
-	;MaxConnectionsIP = 5
+	# Do DNS lookups when a client connects to the server.
+	;DNS = yes
 
-	# Maximum number of channels a user can be member of (0: no limit):
-	;MaxJoins = 10
+	# Do IDENT lookups if ngIRCd has been compiled with support for it.
+	# Users identified using IDENT are registered without the "~" character
+	# prepended to their user name.
+	;Ident = yes
 
-	# 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
+	# Directory containing configuration snippets (*.conf), that should
+	# be read in after parsing this configuration file.
+	;IncludeDir = :ETCDIR:/conf.d
+
+	# 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 = no
+
+	# Should IRC Operators get AutoOp (+o) in persistent (+P) channels?
+	;OperChanPAutoOp = yes
+
+	# 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.
+	# Users identified using PAM are registered without the "~" character
+	# prepended to their user name.
+	;PAM = yes
+
+	# When PAM is enabled, all clients are required to be authenticated
+	# using PAM; connecting to the server without successful PAM
+	# authentication isn't possible.
+	# If this option is set, clients not sending a password are still
+	# allowed to connect: they won't become "identified" and keep the "~"
+	# character prepended to their supplied user name.
+	# Please note: To make some use of this behavior, it most probably
+	# isn't useful to enable "Ident", "PAM" and "PAMIsOptional" at the
+	# same time, because you wouldn't be able to distinguish between
+	# Ident'ified and PAM-authenticated users: both don't have a "~"
+	# character prepended to their respective user names!
+	;PAMIsOptional = 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
+
+	# Silently drop all incoming CTCP requests.
+	;ScrubCTCP = 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
+
+	# 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
+
+;[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 ...
+
+	# SSL Server Key Certificate
+	;CertFile = :ETCDIR:/ssl/server-cert.pem
+
+	# Select cipher suites allowed for SSL/TLS connections. This defaults
+	# to HIGH:!aNULL:@STRENGTH (OpenSSL) or SECURE128 (GnuTLS).
+	# See 'man 1ssl ciphers' (OpenSSL) or 'man 3 gnutls_priority_init'
+	# (GnuTLS) for details.
+	# For OpenSSL:
+	;CipherList = HIGH:!aNULL:@STRENGTH
+	# For GnuTLS:
+	;CipherList = SECURE128
+
+	# Diffie-Hellman parameters
+	;DHFile = :ETCDIR:/ssl/dhparams.pem
+
+	# SSL Server Key
+	;KeyFile = :ETCDIR:/ssl/server-key.pem
+
+	# password to decrypt SSLKeyFile (OpenSSL only)
+	;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
 	# more than one [Operator] block, one for each local operator.
 
-	# ID of the operator (may be different of the nick name)
+	# ID of the operator (may be different of the nickname)
 	;Name = TheOper
 
 	# Password of the IRC operator
@@ -157,14 +301,14 @@
 
 	# 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
-  
+	;Name = irc2.example.net
+
 	# 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.
+	# IP address to use as _source_ address for the connection. if
+	# unspecified, ngircd will let the operating system pick an address.
 	;Bind = 10.0.0.1
 
 	# Port of the server to which the ngIRCd should connect. If you
@@ -184,11 +328,25 @@
 
 	# Set the "Passive" option to "yes" if you don't want this ngIRCd to
 	# connect to the configured peer (same as leaving the "Port" variable
-	# empty). The advantage of this option is that you can actually configure
-	# a port an use the IRC command CONNECT more easily to manually connect
-	# this specific server later.
+	# empty). The advantage of this option is that you can actually
+	# configure a port an use the IRC command CONNECT more easily to
+	# manually connect this specific server later.
 	;Passive = no
 
+	# Connect to the remote server using TLS/SSL (Default: false)
+	;SSLConnect = yes
+
+	# Define a (case insensitive) list of masks matching nicknames that
+	# should be treated as IRC services when introduced via this remote
+	# server, separated by commas (",").
+	# REGULAR SERVERS DON'T NEED this parameter, so leave it empty
+	# (which is the default).
+	# When you are connecting IRC services which mask as a IRC server
+	# and which use "virtual users" to communicate with, for example
+	# "NickServ" and "ChanServ", you should set this parameter to
+	# something like "*Serv" or "NickServ,ChanServ,XyzServ".
+	;ServiceMask = *Serv,Global
+
 [Server]
 	# More [Server] sections, if you like ...
 
@@ -212,6 +370,10 @@
 	# initial channel password (mode k)
 	;Key = Secret
 
+	# Key file, syntax for each line: "<user>:<nick>:<key>".
+	# Default: none.
+	;KeyFile = :ETCDIR:/#chan.key
+
 	# maximum users per channel (mode l)
 	;MaxUsers = 23
 
diff --git a/ngircd.spec b/ngircd.spec
index 8e2a896..4a290b2 100644
--- a/ngircd.spec
+++ b/ngircd.spec
@@ -1,6 +1,6 @@
 Name:           ngircd
 Version:        21.1
-Release:        5%{?dist}
+Release:        6%{?dist}
 Summary:        Next Generation IRC Daemon
 Group:          System Environment/Daemons
 License:        GPLv2+
@@ -124,6 +124,9 @@ fi
 %dir %attr(775, root, ngircd) %{_localstatedir}/run/ngircd/
 
 %changelog
+* Fri Oct 03 2014 Kevin Fenzi <kevin at scrye.com> 21.1-6
+- Sync ngircd.conf with sample template version. Fixes bug #1149012
+
 * Sun Aug 17 2014 Fedora Release Engineering <rel-eng at lists.fedoraproject.org> - 21.1-5
 - Rebuilt for https://fedoraproject.org/wiki/Fedora_21_22_Mass_Rebuild
 
-- 
cgit v0.10.2


	http://pkgs.fedoraproject.org/cgit/ngircd.git/commit/?h=f21&id=4159265779326dfad5227edbc7b32d3842328c23