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. Required!
28 Name = irc.example.net
30 # Information about the server and the administrator, used by the
31 # ADMIN command. Not required by server but by RFC!
32 ;AdminInfo1 = Description
33 ;AdminInfo2 = Location
34 ;AdminEMail = admin@irc.server
36 # Text file which contains the ngIRCd help text. This file is required
37 # to display help texts when using the "HELP <cmd>" command.
38 ;HelpFile = :DOCDIR:/Commands.txt
40 # Info text of the server. This will be shown by WHOIS and
41 # LINKS requests for example.
42 Info = Server Info Text
44 # Comma separated list of IP addresses on which the server should
45 # listen. Default values are:
46 # "0.0.0.0" or (if compiled with IPv6 support) "::,0.0.0.0"
47 # so the server listens on all IP addresses of the system by default.
48 ;Listen = 127.0.0.1,192.168.0.1
50 # Text file with the "message of the day" (MOTD). This message will
51 # be shown to all users connecting to the server:
52 ;MotdFile = :ETCDIR:/ngircd.motd
54 # A simple Phrase (<256 chars) if you don't want to use a motd file.
55 ;MotdPhrase = "Hello world!"
57 # Global password for all users needed to connect to the server.
61 # This tells ngIRCd to write its current process ID to a file.
62 # Note that the pidfile is written AFTER chroot and switching the
63 # user ID, e.g. the directory the pidfile resides in must be
64 # writable by the ngIRCd user and exist in the chroot directory.
65 ;PidFile = /var/run/ngircd/ngircd.pid
67 # Ports on which the server should listen. There may be more than
68 # one port, separated with ",". (Default: 6667)
69 ;Ports = 6667, 6668, 6669
71 # Group ID under which the ngIRCd should run; you can use the name
72 # of the group or the numerical ID. ATTENTION: For this to work the
73 # server must have been started with root privileges!
76 # User ID under which the server should run; you can use the name
77 # of the user or the numerical ID. ATTENTION: For this to work the
78 # server must have been started with root privileges! In addition,
79 # the configuration and MOTD files must be readable by this user,
80 # otherwise RESTART and REHASH won't work!
84 # Define some limits and timeouts for this ngIRCd instance. Default
85 # values should be safe, but it is wise to double-check :-)
87 # The server tries every <ConnectRetry> seconds to establish a link
88 # to not yet (or no longer) connected servers.
91 # Number of seconds after which the whole daemon should shutdown when
92 # no connections are left active after handling at least one client
93 # (0: never, which is the default).
94 # This can be useful for testing or when ngIRCd is started using
95 # "socket activation" with systemd(8), for example.
98 # Maximum number of simultaneous in- and outbound connections the
99 # server is allowed to accept (0: unlimited):
102 # Maximum number of simultaneous connections from a single IP address
103 # the server will accept (0: unlimited):
104 ;MaxConnectionsIP = 5
106 # Maximum number of channels a user can be member of (0: no limit):
109 # Maximum length of an user nickname (Default: 9, as in RFC 2812).
110 # Please note that all servers in an IRC network MUST use the same
111 # maximum nickname length!
114 # Maximum number of channels returned in response to a /list
115 # command (0: unlimited):
118 # After <PingTimeout> seconds of inactivity the server will send a
119 # PING to the peer to test whether it is alive or not.
122 # If a client fails to answer a PING with a PONG within <PongTimeout>
123 # seconds, it will be disconnected by the server.
127 # Optional features and configuration options to further tweak the
128 # behavior of ngIRCd. If you want to get started quickly, you most
129 # probably don't have to make changes here -- they are all optional.
131 # Are remote IRC operators allowed to control this server, e.g.
132 # use commands like CONNECT, SQUIT, DIE, ...?
133 ;AllowRemoteOper = no
135 # A directory to chroot in when everything is initialized. It
136 # doesn't need to be populated if ngIRCd is compiled as a static
137 # binary. By default ngIRCd won't use the chroot() feature.
138 # ATTENTION: For this to work the server must have been started
139 # with root privileges!
140 ;ChrootDir = /var/empty
142 # Set this hostname for every client instead of the real one.
143 # Use %x to add the hashed value of the original hostname.
144 ;CloakHost = cloaked.host
146 # Use this hostname for hostname cloaking on clients that have the
147 # user mode "+x" set, instead of the name of the server.
148 # Use %x to add the hashed value of the original hostname.
149 ;CloakHostModeX = cloaked.user
151 # The Salt for cloaked hostname hashing. When undefined a random
152 # hash is generated after each server start.
153 ;CloakHostSalt = abcdefghijklmnopqrstuvwxyz
155 # Set every clients' user name to their nickname
156 ;CloakUserToNick = yes
158 # Try to connect to other IRC servers using IPv4 and IPv6, if possible.
162 # Do any DNS lookups when a client connects to the server.
165 # Do IDENT lookups if ngIRCd has been compiled with support for it.
166 # Users identified using IDENT are registered without the "~" character
167 # prepended to their user name.
170 # Directory containing configuration snippets (*.conf), that should
171 # be read in after parsing this configuration file.
172 ;IncludeDir = :ETCDIR:/conf.d
174 # Enhance user privacy slightly (useful for IRC server on TOR or I2P)
175 # by censoring some information like idle time, logon time, etc.
178 # Normally ngIRCd doesn't send any messages to a client until it is
179 # registered. Enable this option to let the daemon send "NOTICE AUTH"
180 # messages to clients while connecting.
183 # Should IRC Operators be allowed to use the MODE command even if
184 # they are not(!) channel-operators?
187 # Should IRC Operators get AutoOp (+o) in persistent (+P) channels?
188 ;OperChanPAutoOp = yes
190 # Mask IRC Operator mode requests as if they were coming from the
191 # server? (This is a compatibility hack for ircd-irc2 servers)
194 # Use PAM if ngIRCd has been compiled with support for it.
195 # Users identified using PAM are registered without the "~" character
196 # prepended to their user name.
199 # When PAM is enabled, all clients are required to be authenticated
200 # using PAM; connecting to the server without successful PAM
201 # authentication isn't possible.
202 # If this option is set, clients not sending a password are still
203 # allowed to connect: they won't become "identified" and keep the "~"
204 # character prepended to their supplied user name.
205 # Please note: To make some use of this behavior, it most probably
206 # isn't useful to enable "Ident", "PAM" and "PAMIsOptional" at the
207 # same time, because you wouldn't be able to distinguish between
208 # Ident'ified and PAM-authenticated users: both don't have a "~"
209 # character prepended to their respective user names!
212 # Allow Pre-Defined Channels only (see Section [Channels])
213 ;PredefChannelsOnly = no
215 # Let ngIRCd send an "authentication PING" when a new client connects,
216 # and register this client only after receiving the corresponding
218 ;RequireAuthPing = no
220 # Silently drop all incoming CTCP requests.
223 # Syslog "facility" to which ngIRCd should send log messages.
224 # Possible values are system dependent, but most probably auth, daemon,
225 # user and local1 through local7 are possible values; see syslog(3).
226 # Default is "local5" for historical reasons, you probably want to
227 # change this to "daemon", for example.
228 ;SyslogFacility = local1
230 # Password required for using the WEBIRC command used by some
231 # Web-to-IRC gateways. If not set/empty, the WEBIRC command can't
232 # be used. (Default: not set)
233 ;WebircPassword = xyz
236 # SSL-related configuration options. Please note that this section
237 # is only available when ngIRCd is compiled with support for SSL!
238 # So don't forget to remove the ";" above if this is the case ...
240 # SSL Server Key Certificate
241 ;CertFile = :ETCDIR:/ssl/server-cert.pem
243 # Diffie-Hellman parameters
244 ;DHFile = :ETCDIR:/ssl/dhparams.pem
247 ;KeyFile = :ETCDIR:/ssl/server-key.pem
249 # password to decrypt SSLKeyFile (OpenSSL only)
250 ;KeyFilePassword = secret
252 # Additional Listen Ports that expect SSL/TLS encrypted connections
256 # [Operator] sections are used to define IRC Operators. There may be
257 # more than one [Operator] block, one for each local operator.
259 # ID of the operator (may be different of the nickname)
262 # Password of the IRC operator
265 # Optional Mask from which /OPER will be accepted
266 ;Mask = *!ident@somewhere.example.com
269 # More [Operator] sections, if you like ...
272 # Other servers are configured in [Server] sections. If you
273 # configure a port for the connection, then this ngircd tries to
274 # connect to to the other server on the given port; if not it waits
275 # for the other server to connect.
276 # There may be more than one server block, one for each server.
279 # The ngIRCd allows "server groups": You can assign an "ID" to every
280 # server with which you want this ngIRCd to link. If a server of a
281 # group won't answer, the ngIRCd tries to connect to the next server
282 # in the given group. But the ngircd never tries to connect to two
283 # servers with the same group ID.
285 # IRC name of the remote server, must match the "Name" variable in
286 # the [Global] section of the other server (when using ngIRCd).
287 ;Name = irc2.example.net
289 # Internet host name or IP address of the peer (only required when
290 # this server should establish the connection).
291 ;Host = connect-to-host.example.net
293 # IP address to use as _source_ address for the connection. if
294 # unspecified, ngircd will let the operating system pick an address.
297 # Port of the server to which the ngIRCd should connect. If you
298 # assign no port the ngIRCd waits for incoming connections.
301 # Own password for the connection. This password has to be configured
302 # as "PeerPassword" on the other server.
303 ;MyPassword = MySecret
305 # Foreign password for this connection. This password has to be
306 # configured as "MyPassword" on the other server.
307 ;PeerPassword = PeerSecret
309 # Group of this server (optional)
312 # Set the "Passive" option to "yes" if you don't want this ngIRCd to
313 # connect to the configured peer (same as leaving the "Port" variable
314 # empty). The advantage of this option is that you can actually
315 # configure a port an use the IRC command CONNECT more easily to
316 # manually connect this specific server later.
319 # Connect to the remote server using TLS/SSL (Default: false)
322 # Define a (case insensitive) list of masks matching nicknames that
323 # should be treated as IRC services when introduced via this remote
324 # server, separated by commas (",").
325 # REGULAR SERVERS DON'T NEED this parameter, so leave it empty
326 # (which is the default).
327 # When you are connecting IRC services which mask as a IRC server
328 # and which use "virtual users" to communicate with, for example
329 # "NickServ" and "ChanServ", you should set this parameter to
330 # something like "*Serv" or "NickServ,ChanServ,XyzServ".
331 ;ServiceMask = *Serv,Global
334 # More [Server] sections, if you like ...
337 # Pre-defined channels can be configured in [Channel] sections.
338 # Such channels are created by the server when starting up and even
339 # persist when there are no more members left.
340 # Persistent channels are marked with the mode 'P', which can be set
341 # and unset by IRC operators like other modes on the fly.
342 # There may be more than one [Channel] block, one for each channel.
344 # Name of the channel
347 # Topic for this channel
348 ;Topic = a great topic
350 # Initial channel modes
353 # initial channel password (mode k)
356 # Key file, syntax for each line: "<user>:<nick>:<key>".
358 ;KeyFile = :ETCDIR:/#chan.key
360 # maximum users per channel (mode l)
364 # More [Channel] sections, if you like ...