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
16 # and their descriptions.
20 # The [Global] section of this file is used to define the main
21 # configuration of the server, like the server name and the ports
22 # on which the server should be listening.
23 # These settings depend on your personal preferences, so you should
24 # make sure that they correspond to your installation and setup!
26 # Server name in the IRC network, must contain at least one dot
27 # (".") and be unique in the IRC network. When not set, ngIRCd tries
28 # to deduce a valid IRC server name from the local host name.
29 ;Name = irc.example.net
31 # Information about the server and the administrator, used by the
32 # ADMIN command. Not required by server but by RFC!
33 ;AdminInfo1 = Description
34 ;AdminInfo2 = Location
35 ;AdminEMail = admin@irc.server
37 # Text file which contains the ngIRCd help text. This file is required
38 # to display help texts when using the "HELP <cmd>" command.
39 ;HelpFile = :DOCDIR:/Commands.txt
41 # Info text of the server. This will be shown by WHOIS and
42 # LINKS requests for example.
43 Info = Server Info Text
45 # Comma separated list of IP addresses on which the server should
46 # listen. Default values are:
47 # "0.0.0.0" or (if compiled with IPv6 support) "::,0.0.0.0"
48 # so the server listens on all IP addresses of the system by default.
49 ;Listen = 127.0.0.1,192.168.0.1
51 # Text file with the "message of the day" (MOTD). This message will
52 # be shown to all users connecting to the server:
53 ;MotdFile = :ETCDIR:/ngircd.motd
55 # A simple Phrase (<127 chars) if you don't want to use a motd file.
56 ;MotdPhrase = "Hello world!"
58 # The name of the IRC network to which this server belongs. This name
59 # is optional, should only contain ASCII characters, and can't contain
60 # spaces. It is only used to inform clients. The default is empty,
61 # so no network name is announced to clients.
62 ;Network = aIRCnetwork
64 # Global password for all users needed to connect to the server.
68 # This tells ngIRCd to write its current process ID to a file.
69 # Note that the pidfile is written AFTER chroot and switching the
70 # user ID, e.g. the directory the pidfile resides in must be
71 # writable by the ngIRCd user and exist in the chroot directory.
72 ;PidFile = /var/run/ngircd/ngircd.pid
74 # Ports on which the server should listen. There may be more than
75 # one port, separated with ",". (Default: 6667)
76 ;Ports = 6667, 6668, 6669
78 # Group ID under which the ngIRCd should run; you can use the name
79 # of the group or the numerical ID. ATTENTION: For this to work the
80 # server must have been started with root privileges!
83 # User ID under which the server should run; you can use the name
84 # of the user or the numerical ID. ATTENTION: For this to work the
85 # server must have been started with root privileges! In addition,
86 # the configuration and MOTD files must be readable by this user,
87 # otherwise RESTART and REHASH won't work!
91 # Define some limits and timeouts for this ngIRCd instance. Default
92 # values should be safe, but it is wise to double-check :-)
94 # The server tries every <ConnectRetry> seconds to establish a link
95 # to not yet (or no longer) connected servers.
98 # Number of seconds after which the whole daemon should shutdown when
99 # no connections are left active after handling at least one client
100 # (0: never, which is the default).
101 # This can be useful for testing or when ngIRCd is started using
102 # "socket activation" with systemd(8), for example.
105 # Maximum number of simultaneous in- and outbound connections the
106 # server is allowed to accept (0: unlimited):
109 # Maximum number of simultaneous connections from a single IP address
110 # the server will accept (0: unlimited):
111 ;MaxConnectionsIP = 5
113 # Maximum number of channels a user can be member of (0: no limit):
116 # Maximum length of an user nickname (Default: 9, as in RFC 2812).
117 # Please note that all servers in an IRC network MUST use the same
118 # maximum nickname length!
121 # Maximum penalty time increase in seconds, per penalty event. Set to -1
122 # for no limit (the default), 0 to disable penalties altogether. The
123 # daemon doesn't use penalty increases higher than 2 seconds during
124 # normal operation, so values greater than 1 rarely make sense.
127 # Maximum number of channels returned in response to a /list
128 # command (0: unlimited):
131 # After <PingTimeout> seconds of inactivity the server will send a
132 # PING to the peer to test whether it is alive or not.
135 # If a client fails to answer a PING with a PONG within <PongTimeout>
136 # seconds, it will be disconnected by the server.
140 # Optional features and configuration options to further tweak the
141 # behavior of ngIRCd. If you want to get started quickly, you most
142 # probably don't have to make changes here -- they are all optional.
144 # List of allowed channel types (channel prefixes) for newly created
145 # channels on the local server. By default, all supported channel
146 # types are allowed. Set this variable to the empty string to disallow
147 # creation of new channels by local clients at all.
148 ;AllowedChannelTypes = #&+
150 # Are remote IRC operators allowed to control this server, e.g.
151 # use commands like CONNECT, SQUIT, DIE, ...?
152 ;AllowRemoteOper = no
154 # A directory to chroot in when everything is initialized. It
155 # doesn't need to be populated if ngIRCd is compiled as a static
156 # binary. By default ngIRCd won't use the chroot() feature.
157 # ATTENTION: For this to work the server must have been started
158 # with root privileges!
159 ;ChrootDir = /var/empty
161 # Set this hostname for every client instead of the real one.
162 # Use %x to add the hashed value of the original hostname.
163 ;CloakHost = cloaked.host
165 # Use this hostname for hostname cloaking on clients that have the
166 # user mode "+x" set, instead of the name of the server.
167 # Use %x to add the hashed value of the original hostname.
168 ;CloakHostModeX = cloaked.user
170 # The Salt for cloaked hostname hashing. When undefined a random
171 # hash is generated after each server start.
172 ;CloakHostSalt = abcdefghijklmnopqrstuvwxyz
174 # Set every clients' user name to their nickname
175 ;CloakUserToNick = yes
177 # Try to connect to other IRC servers using IPv4 and IPv6, if possible.
181 # Default user mode(s) to set on new local clients. Please note that
182 # only modes can be set that the client could set using regular MODE
183 # commands, you can't set "a" (away) for example! Default: none.
184 ;DefaultUserModes = i
186 # Do DNS lookups when a client connects to the server.
189 # Do IDENT lookups if ngIRCd has been compiled with support for it.
190 # Users identified using IDENT are registered without the "~" character
191 # prepended to their user name.
194 # Directory containing configuration snippets (*.conf), that should
195 # be read in after parsing this configuration file.
196 ;IncludeDir = :ETCDIR:/conf.d
198 # Enhance user privacy slightly (useful for IRC server on TOR or I2P)
199 # by censoring some information like idle time, logon time, etc.
202 # Normally ngIRCd doesn't send any messages to a client until it is
203 # registered. Enable this option to let the daemon send "NOTICE *"
204 # messages to clients while connecting.
205 ;NoticeBeforeRegistration = no
207 # Should IRC Operators be allowed to use the MODE command even if
208 # they are not(!) channel-operators?
211 # Should IRC Operators get AutoOp (+o) in persistent (+P) channels?
212 ;OperChanPAutoOp = yes
214 # Mask IRC Operator mode requests as if they were coming from the
215 # server? (This is a compatibility hack for ircd-irc2 servers)
218 # Use PAM if ngIRCd has been compiled with support for it.
219 # Users identified using PAM are registered without the "~" character
220 # prepended to their user name.
223 # When PAM is enabled, all clients are required to be authenticated
224 # using PAM; connecting to the server without successful PAM
225 # authentication isn't possible.
226 # If this option is set, clients not sending a password are still
227 # allowed to connect: they won't become "identified" and keep the "~"
228 # character prepended to their supplied user name.
229 # Please note: To make some use of this behavior, it most probably
230 # isn't useful to enable "Ident", "PAM" and "PAMIsOptional" at the
231 # same time, because you wouldn't be able to distinguish between
232 # Ident'ified and PAM-authenticated users: both don't have a "~"
233 # character prepended to their respective user names!
236 # When PAM is enabled, this value determines the used PAM
238 # This setting allows to run multiple ngIRCd instances with
239 # different PAM configurations on each instance.
240 # If you set it to "ngircd-foo", PAM will use
241 # /etc/pam.d/ngircd-foo instead of the default
243 ;PAMServiceName = ngircd
245 # Let ngIRCd send an "authentication PING" when a new client connects,
246 # and register this client only after receiving the corresponding
248 ;RequireAuthPing = no
250 # Silently drop all incoming CTCP requests.
253 # Syslog "facility" to which ngIRCd should send log messages.
254 # Possible values are system dependent, but most probably auth, daemon,
255 # user and local1 through local7 are possible values; see syslog(3).
256 # Default is "local5" for historical reasons, you probably want to
257 # change this to "daemon", for example.
258 ;SyslogFacility = local1
260 # Password required for using the WEBIRC command used by some
261 # Web-to-IRC gateways. If not set/empty, the WEBIRC command can't
262 # be used. (Default: not set)
263 ;WebircPassword = xyz
266 # SSL-related configuration options. Please note that this section
267 # is only available when ngIRCd is compiled with support for SSL!
268 # So don't forget to remove the ";" above if this is the case ...
270 # SSL Server Key Certificate
271 ;CertFile = :ETCDIR:/ssl/server-cert.pem
273 # Select cipher suites allowed for SSL/TLS connections. This defaults
274 # to HIGH:!aNULL:@STRENGTH (OpenSSL) or SECURE128 (GnuTLS).
275 # See 'man 1ssl ciphers' (OpenSSL) or 'man 3 gnutls_priority_init'
276 # (GnuTLS) for details.
278 ;CipherList = HIGH:!aNULL:@STRENGTH:!SSLv3
280 ;CipherList = SECURE128:-VERS-SSL3.0
282 # Diffie-Hellman parameters
283 ;DHFile = :ETCDIR:/ssl/dhparams.pem
286 ;KeyFile = :ETCDIR:/ssl/server-key.pem
288 # password to decrypt SSLKeyFile (OpenSSL only)
289 ;KeyFilePassword = secret
291 # Additional Listen Ports that expect SSL/TLS encrypted connections
295 # [Operator] sections are used to define IRC Operators. There may be
296 # more than one [Operator] block, one for each local operator.
298 # ID of the operator (may be different of the nickname)
301 # Password of the IRC operator
304 # Optional Mask from which /OPER will be accepted
305 ;Mask = *!ident@somewhere.example.com
308 # More [Operator] sections, if you like ...
311 # Other servers are configured in [Server] sections. If you
312 # configure a port for the connection, then this ngircd tries to
313 # connect to the other server on the given port; if not it waits
314 # for the other server to connect.
315 # There may be more than one server block, one for each server.
318 # The ngIRCd allows "server groups": You can assign an "ID" to every
319 # server with which you want this ngIRCd to link. If a server of a
320 # group won't answer, the ngIRCd tries to connect to the next server
321 # in the given group. But the ngircd never tries to connect to two
322 # servers with the same group ID.
324 # IRC name of the remote server, must match the "Name" variable in
325 # the [Global] section of the other server (when using ngIRCd).
326 ;Name = irc2.example.net
328 # Internet host name or IP address of the peer (only required when
329 # this server should establish the connection).
330 ;Host = connect-to-host.example.net
332 # IP address to use as _source_ address for the connection. if
333 # unspecified, ngircd will let the operating system pick an address.
336 # Port of the server to which the ngIRCd should connect. If you
337 # assign no port the ngIRCd waits for incoming connections.
340 # Own password for the connection. This password has to be configured
341 # as "PeerPassword" on the other server.
342 ;MyPassword = MySecret
344 # Foreign password for this connection. This password has to be
345 # configured as "MyPassword" on the other server.
346 ;PeerPassword = PeerSecret
348 # Group of this server (optional)
351 # Set the "Passive" option to "yes" if you don't want this ngIRCd to
352 # connect to the configured peer (same as leaving the "Port" variable
353 # empty). The advantage of this option is that you can actually
354 # configure a port an use the IRC command CONNECT more easily to
355 # manually connect this specific server later.
358 # Connect to the remote server using TLS/SSL (Default: false)
361 # Define a (case insensitive) list of masks matching nicknames that
362 # should be treated as IRC services when introduced via this remote
363 # server, separated by commas (",").
364 # REGULAR SERVERS DON'T NEED this parameter, so leave it empty
365 # (which is the default).
366 # When you are connecting IRC services which mask as a IRC server
367 # and which use "virtual users" to communicate with, for example
368 # "NickServ" and "ChanServ", you should set this parameter to
369 # something like "*Serv" or "NickServ,ChanServ,XyzServ".
370 ;ServiceMask = *Serv,Global
373 # More [Server] sections, if you like ...
376 # Pre-defined channels can be configured in [Channel] sections.
377 # Such channels are created by the server when starting up and even
378 # persist when there are no more members left.
379 # Persistent channels are marked with the mode 'P', which can be set
380 # and unset by IRC operators like other modes on the fly.
381 # There may be more than one [Channel] block, one for each channel.
383 # Name of the channel
386 # Topic for this channel
387 ;Topic = a great topic
389 # Initial channel modes, as used in "MODE" commands. Modifying lists
390 # (ban list, invite list, exception list) is supported.
391 # This option can be specified multiple times, evaluated top to bottom.
392 ;Modes = +tnk mykey +l 5
393 ;Modes = +b nick!~user@bad.host.example.com
395 # Should ngIRCd automatically join ("autojoin") all users to this
396 # channel on connect? Note: The users must have permissions to access
397 # the channel, otherwise joining them will fail!
400 # Key file, syntax for each line: "<user>:<nick>:<key>".
402 ;KeyFile = :ETCDIR:/#chan.key
405 # More [Channel] sections, if you like ...