2 # This is a sample configuration file for the ngIRCd IRC daemon, which must
3 # be customized to the local preferences and needs.
5 # Comments are started with "#" or ";".
7 # A lot of configuration options in this file start with a ";". You have
8 # to remove the ";" in front of each variable to actually set a value!
9 # The disabled variables are shown with example values for completeness only
10 # and the daemon is using compiled-in default settings.
12 # Use "ngircd --configtest" (see manual page ngircd(8)) to validate that the
13 # server interprets the configuration file as expected!
15 # Please see ngircd.conf(5) for a complete list of configuration options.
19 # The [Global] section of this file is used to define the main
20 # configuration of the server, like the server name and the ports
21 # on which the server should be listening.
23 # Server name in the IRC network, must contain at least one dot
24 # (".") and be unique in the IRC network. Required!
27 # Set this hostname for every client instead of the real one
28 ;ClientHost = irc.the.net
30 # Set every clients' user name to their nick name
33 # Info text of the server. This will be shown by WHOIS and
34 # LINKS requests for example.
35 Info = Server Info Text
37 # Global password for all users needed to connect to the server.
41 # Password required for using the WEBIRC command used by some
42 # Web-to-IRC gateways. If not set/empty, the WEBIRC command can't
43 # be used. (Default: not set)
46 # Information about the server and the administrator, used by the
47 # ADMIN command. Not required by server but by RFC!
48 ;AdminInfo1 = Description
49 ;AdminInfo2 = Location
50 ;AdminEMail = admin@irc.server
52 # Ports on which the server should listen. There may be more than
53 # one port, separated with ",". (Default: 6667)
54 ;Ports = 6667, 6668, 6669
56 # Additional Listen Ports that expect SSL/TLS encrypted connections
57 ;SSLPorts = 6697, 9999
60 ;SSLKeyFile = :ETCDIR:/ssl/server-key.pem
62 # password to decrypt SSLKeyFile (OpenSSL only)
63 ;SSLKeyFilePassword = secret
65 # SSL Server Key Certificate
66 ;SSLCertFile = :ETCDIR:/ssl/server-cert.pem
68 # Diffie-Hellman parameters
69 ;SSLDHFile = :ETCDIR:/ssl/dhparams.pem
71 # comma separated list of IP addresses on which the server should
72 # listen. Default values are:
73 # "0.0.0.0" or (if compiled with IPv6 support) "::,0.0.0.0"
74 # so the server listens on all IP addresses of the system by default.
75 ;Listen = 127.0.0.1,192.168.0.1
77 # Syslog "facility" to which ngIRCd should send log messages.
78 # Possible values are system dependant, but most probably auth, daemon,
79 # user and local1 through local7 are possible values; see syslog(3).
80 # Default is "local5" for historical reasons, you probably want to
81 # change this to "daemon", for example.
82 SyslogFacility = local1
84 # Text file with the "message of the day" (MOTD). This message will
85 # be shown to all users connecting to the server:
86 ;MotdFile = :ETCDIR:/ngircd.motd
88 # A simple Phrase (<256 chars) if you don't want to use a motd file.
89 ;MotdPhrase = "Hello world!"
91 # User ID under which the server should run; you can use the name
92 # of the user or the numerical ID. ATTENTION: For this to work the
93 # server must have been started with root privileges! In addition,
94 # the configuration and MOTD files must be readable by this user,
95 # otherwise RESTART and REHASH won't work!
98 # Group ID under which the ngircd should run; you can use the name
99 # of the group or the numerical ID. ATTENTION: For this to work the
100 # server must have been started with root privileges!
103 # A directory to chroot in when everything is initialized. It
104 # doesn't need to be populated if ngIRCd is compiled as a static
105 # binary. By default ngIRCd won't use the chroot() feature.
106 # ATTENTION: For this to work the server must have been started
107 # with root privileges!
108 ;ChrootDir = /var/empty
110 # This tells ngircd to write its current process id to a file.
111 # Note that the pidfile is written AFTER chroot and switching uid,
112 # i. e. the Directory the pidfile resides in must be writeable by
113 # the ngircd user and exist in the chroot directory.
114 ;PidFile = /var/run/ngircd/ngircd.pid
116 # After <PingTimeout> seconds of inactivity the server will send a
117 # PING to the peer to test whether it is alive or not.
120 # If a client fails to answer a PING with a PONG within <PongTimeout>
121 # seconds, it will be disconnected by the server.
124 # The server tries every <ConnectRetry> seconds to establish a link
125 # to not yet (or no longer) connected servers.
128 # Should IRC Operators be allowed to use the MODE command even if
129 # they are not(!) channel-operators?
132 # Mask IRC Operator mode requests as if they were coming from the
133 # server? (This is a compatibility hack for ircd-irc2 servers)
136 # Are remote IRC operators allowed to control this server, e. g.
137 # use commands like CONNECT, SQUIT, DIE, ...?
138 ;AllowRemoteOper = no
140 # Allow Pre-Defined Channels only (see Section [Channels])
141 ;PredefChannelsOnly = no
143 # try to connect to other irc servers using ipv4 and ipv6, if possible
147 # Maximum number of simultaneous in- and outbound connections the
148 # server is allowed to accept (0: unlimited):
151 # Maximum number of simultaneous connections from a single IP address
152 # the server will accept (0: unlimited):
153 ;MaxConnectionsIP = 5
155 # Maximum number of channels a user can be member of (0: no limit):
158 # Maximum length of an user nick name (Default: 9, as in RFC 2812).
159 # Please note that all servers in an IRC network MUST use the same
160 # maximum nick name length!
164 # Do any DNS lookups when a client connects to the server.
167 # Do any IDENT lookups if ngIRCd has been compiled with support for it.
170 # Use PAM if ngIRCd has been compiled with support for it.
174 # [Operator] sections are used to define IRC Operators. There may be
175 # more than one [Operator] block, one for each local operator.
177 # ID of the operator (may be different of the nick name)
180 # Password of the IRC operator
183 # Optional Mask from which /OPER will be accepted
184 ;Mask = *!ident@somewhere.example.com
187 # More [Operator] sections, if you like ...
190 # Other servers are configured in [Server] sections. If you
191 # configure a port for the connection, then this ngircd tries to
192 # connect to to the other server on the given port; if not it waits
193 # for the other server to connect.
194 # There may be more than one server block, one for each server.
197 # The ngIRCd allows "server groups": You can assign an "ID" to every
198 # server with which you want this ngIRCd to link. If a server of a
199 # group won't answer, the ngIRCd tries to connect to the next server
200 # in the given group. But the ngircd never tries to connect to two
201 # servers with the same group ID.
203 # IRC name of the remote server, must match the "Name" variable in
204 # the [Global] section of the other server (when using ngIRCd).
207 # Internet host name or IP address of the peer (only required when
208 # this server should establish the connection).
209 ;Host = connect-to-host.the.net
211 # IP address to use as _source_ address for the connection. if
212 # unspecified, ngircd will let the operating system pick an address.
215 # Port of the server to which the ngIRCd should connect. If you
216 # assign no port the ngIRCd waits for incoming connections.
219 # Own password for the connection. This password has to be configured
220 # as "PeerPassword" on the other server.
221 ;MyPassword = MySecret
223 # Foreign password for this connection. This password has to be
224 # configured as "MyPassword" on the other server.
225 ;PeerPassword = PeerSecret
227 # Group of this server (optional)
230 # Set the "Passive" option to "yes" if you don't want this ngIRCd to
231 # connect to the configured peer (same as leaving the "Port" variable
232 # empty). The advantage of this option is that you can actually
233 # configure a port an use the IRC command CONNECT more easily to
234 # manually connect this specific server later.
237 # Connect to the remote server using TLS/SSL (Default: false)
240 # Define a (case insensitive) mask matching nick names that should be
241 # treated as IRC services when introduced via this remote server.
242 # REGULAR SERVERS DON'T NEED this parameter, so leave it empty
243 # (which is the default).
244 # When you are connecting IRC services which mask as a IRC server
245 # and which use "virtual users" to communicate with, for example
246 # "NickServ" and "ChanServ", you should set this parameter to
247 # something like "*Serv".
251 # More [Server] sections, if you like ...
254 # Pre-defined channels can be configured in [Channel] sections.
255 # Such channels are created by the server when starting up and even
256 # persist when there are no more members left.
257 # Persistent channels are marked with the mode 'P', which can be set
258 # and unset by IRC operators like other modes on the fly.
259 # There may be more than one [Channel] block, one for each channel.
261 # Name of the channel
264 # Topic for this channel
265 ;Topic = a great topic
267 # Initial channel modes
270 # initial channel password (mode k)
273 # Key file, syntax for each line: "<user>:<nick>:<key>".
275 ;KeyFile = :ETCDIR:/#chan.key
277 # maximum users per channel (mode l)
281 # More [Channel] sections, if you like ...