1 ########################################################################
3 # ___ ___ ____ ____ _ #
4 # |_ _|_ __ ___ _ __|_ _| _ \ / ___|__| | #
5 # | || '_ \/ __| '_ \| || |_) | | / _` | #
6 # | || | | \__ \ |_) | || _ <| |__| (_| | #
7 # |___|_| |_|___/ .__/___|_| \_\\____\__,_| #
10 # / ___|___ _ __ / _(_) __ _ _ _ _ __ __ _| |_(_) ___ _ __ #
11 # | | / _ \| '_ \| |_| |/ _` | | | | '__/ _` | __| |/ _ \| '_ \ #
12 # | |__| (_) | | | | _| | (_| | |_| | | | (_| | |_| | (_) | | | | #
13 # \____\___/|_| |_|_| |_|\__, |\__,_|_| \__,_|\__|_|\___/|_| |_| #
16 ##################################||####################################
18 ##################################||####################################
20 # This is an example of the config file for InspIRCd. #
21 # Change the options to suit your network. #
24 # ____ _ _____ _ _ ____ _ _ _ #
25 # | _ \ ___ __ _ __| | |_ _| |__ (_)___ | __ )(_) |_| | #
26 # | |_) / _ \/ _` |/ _` | | | | '_ \| / __| | _ \| | __| | #
27 # | _ < __/ (_| | (_| | | | | | | | \__ \ | |_) | | |_|_| #
28 # |_| \_\___|\__,_|\__,_| |_| |_| |_|_|___/ |____/|_|\__(_) #
30 # Lines prefixed with READ THIS BIT, as shown above, are IMPORTANT #
31 # lines, and you REALLY SHOULD READ THEM. Yes, THIS MEANS YOU. Even #
32 # if you've configured InspIRCd before, these probably indicate #
33 # something new or different to this version and you SHOULD READ IT. #
35 ########################################################################
37 #-#-#-#-#-#-#-#-#-# INCLUDE CONFIGURATION #-#-#-#-#-#-#-#-#-#-#-#-#-#
39 # This optional tag allows you to include another config file #
40 # allowing you to keep your configuration tidy. The configuration #
41 # file you include will be treated as part of the configuration file #
42 # which includes it, in simple terms the inclusion is transparent. #
44 # All paths to config files are relative to the directory that the #
47 # You may also include an executable file, in which case if you do so #
48 # the output of the executable on the standard output will be added #
49 # to your config at the point of the include tag. #
51 # Syntax is as follows: #
52 #<include file="file.conf"> #
53 #<include executable="/path/to/executable parameters"> #
55 # Executable include example: #
56 #<include executable="/usr/bin/wget -q -O - https://example.com/inspircd.conf">
60 #-#-#-#-#-#-#-#-#-#-#-# VARIABLE DEFINITIONS -#-#-#-#-#-#-#-#-#-#-#-#
62 # You can define variables that will be substituted later in the #
63 # configuration file. This can be useful to allow settings to be #
64 # easily changed, or to parameterize a remote includes. #
66 # Variables may be redefined and may reference other variables. #
67 # Value expansion happens at the time the tag is read. #
69 # Using variable definitions REQUIRES that the config format be #
70 # changed to "xml" from the default "compat" that uses escape #
71 # sequences such as "\"" and "\n", and does not support <define> #
73 <define name="bindip" value="1.2.2.3">
74 <define name="localips" value="&bindip;/24">
76 #-#-#-#-#-#-#-#-#-#-#-#- SERVER DESCRIPTION -#-#-#-#-#-#-#-#-#-#-#-#-
78 # Here is where you enter the information about your server. #
82 # name: Hostname of your server. Does not need to resolve, but
83 # does need to be correct syntax (something.somethingelse.tld).
84 name="penguin.omega.example.org"
86 # description: Server description. Spaces are allowed.
87 description="Waddle World"
89 # id: The SID to use for this server. This should not be uncommented
90 # unless there is a SID conflict. This must be three characters long.
91 # The first character must be a digit [0-9], the remaining two chars
92 # may be letters [A-Z] or digits.
95 # network: Network name given on connect to clients.
96 # Should be the same on all servers on the network and
101 #-#-#-#-#-#-#-#-#-#-#-#- ADMIN INFORMATION -#-#-#-#-#-#-#-#-#-#-#-#
103 # Describes the Server Administrator's real name (optionally), #
104 # nick, and email address. #
109 name="Johnny English"
111 # nick: Nickname (preferably what you use on the network)
114 # email: email address. Does not have to be valid
115 # but should be for the users to be able to contact you.
116 email="MI5@the.best.secret.agent">
119 #-#-#-#-#-#-#-#-#-#-#-#- PORT CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-
121 # Enter the port and address bindings here. #
124 # ____ _ _____ _ _ ____ _ _ _ #
125 # | _ \ ___ __ _ __| | |_ _| |__ (_)___ | __ )(_) |_| | #
126 # | |_) / _ \/ _` |/ _` | | | | '_ \| / __| | _ \| | __| | #
127 # | _ < __/ (_| | (_| | | | | | | | \__ \ | |_) | | |_|_| #
128 # |_| \_\___|\__,_|\__,_| |_| |_| |_|_|___/ |____/|_|\__(_) #
130 # If you want to link servers to InspIRCd you must load the #
131 # m_spanningtree.so module! Please see the modules list for #
132 # information on how to load this module! If you do not load this #
133 # module, server ports will NOT work! #
136 # address: IP address to bind to if the box that you are hosting
137 # on has more than one IP, else the ircd will try to bind to all
138 # IP's on the box if this is not defined.
141 # port: Port for users or servers to be able to connect to.
142 # you can select multiple ports by separating them
143 # with a - character like the example below.
146 # type: Type of bind block this is. It can either be clients or
147 # servers. Whichever you select will be the only type able to connect
148 # to this bind section.
151 # ssl: If you want the port(s) in this bind tag to use SSL, set this
152 # to either "gnutls" or "openssl". The appropriate SSL module must be
153 # loaded for SSL to work. If you do not want the port(s) in this bind
154 # tag to support SSL, just remove or comment out this option.
158 <bind address="" port="6660-6669" type="clients">
160 # When linking servers, the OpenSSL and GnuTLS implementations are completely
161 # link-compatible and can be used alongside each other
162 # on each end of the link without any significant issues.
163 # Supported SSL types are: "openssl" and "gnutls".
164 # You must load m_ssl_openssl for OpenSSL or m_ssl_gnutls for GnuTLS.
166 <bind address="" port="7000,7001" type="servers">
167 <bind address="1.2.3.4" port="7005" type="servers" ssl="openssl">
170 #-#-#-#-#-#-#-#-#-#- DIE/RESTART CONFIGURATION -#-#-#-#-#-#-#-#-#-#-
172 # You can configure the passwords here which you wish to use for #
173 # the /DIE and /RESTART commands. Only trusted ircops who will #
174 # need this ability should know the die and restart password. #
178 # hash: what hash these passwords are hashed with.
179 # Requires the module for selected hash (m_md5.so, m_sha256.so
180 # or m_ripemd160.so) be loaded and the password hashing module
181 # (m_password_hash.so) loaded.
182 # Options here are: "md5", "sha256" and "ripemd160", or one of
183 # these prefixed with "hmac-", e.g.: "hmac-sha256".
184 # Optional, but recommended. Create hashed passwords with:
185 # /mkpasswd <hash> <password>
188 # diepass: Password for opers to use if they need to shutdown (die)
191 # IMPORTANT: leaving this field empty does not disable the use of
192 # the DIE command. In order to prevent the use of this command you
193 # should remove it from the command privileges of your opers.
196 # restartpass: Password for opers to use if they need to restart
199 # IMPORTANT: leaving this field empty does not disable the use of
200 # the RESTART command. In order to prevent the use of this command
201 # you should remove it from the command privileges of your opers.
205 #-#-#-#-#-#-#-#-#-#- CONNECTIONS CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
207 # This is where you can configure which connections are allowed #
208 # and denied access onto your server. The password is optional. #
209 # You may have as many of these as you require. To allow/deny all #
210 # connections, use a '*' or 0.0.0.0/0. #
212 # -- It is important to note that connect tags are read from the -- #
213 # TOP DOWN. This means that you should have more specific deny #
214 # and allow tags at the top, progressively more general, followed #
215 # by a <connect allow="*" (should you wish to have one). #
217 # Connect blocks are searched twice for each user - once when the TCP #
218 # connection is accepted, and once when the user completes their #
219 # registration. Most of the information (hostname, ident response, #
220 # password, SSL when using STARTTLS, etc) is only available during #
221 # the second search, so if you are trying to make a closed server, #
222 # you will probably need a connect block just for user registration. #
223 # This can be done by using <connect registered="no"> #
226 # deny: Will not let people connect if they have specified host/IP.
229 # connect:reason is the message that users will see if they match a deny block
230 <connect deny="3ffe::0/32" reason="The 6bone address space is deprecated">
233 # name: Name to use for this connect block. Mainly used for
234 # connect class inheriting.
237 # parent: This setting is to specify if this connect class
238 # inherits settings from any other. Put the other class's name
239 # in here to use its settings as a template - for example, if
240 # you only want to adjust sendq and a password
243 # allow: The IP address or hostname of clients that can use this
244 # class. You can specify either an exact match, a glob match, or
248 # hash: what hash this password is hashed with. requires the module
249 # for selected hash (m_md5.so, m_sha256.so or m_ripemd160.so) be
250 # loaded and the password hashing module (m_password_hash.so)
251 # loaded. Options here are: "md5", "sha256" and "ripemd160".
252 # Optional, but recommended. Create hashed passwords with:
253 # /mkpasswd <hash> <password>
256 # password: Password to use for this block/user(s)
259 # maxchans: Maximum number of channels a user in this class
260 # be in at one time. This overrides every other maxchans setting.
263 # timeout: How long (in seconds) the server will wait before
264 # disconnecting a user if they do not do anything on connect.
265 # (Note, this is a client-side thing, if the client does not
266 # send /nick, /user or /pass)
269 # localmax: Maximum local connections per IP (or CIDR mask, see below).
272 # globalmax: Maximum global (network-wide) connections per IP (or CIDR mask, see below).
275 # maxconnwarn: Enable warnings when localmax or globalmax are reached (defaults to on)
278 # usednsbl: Defines whether or not users in this class are subject to DNSBL. Default is yes.
279 # This setting only has effect when m_dnsbl is loaded.
282 # useident: Defines if users in this class MUST respond to a ident query or not.
285 # limit: How many users are allowed in this class
288 # modes: Usermodes that are set on users in this block on connect.
289 # Enabling this option requires that the m_conn_umodes module be loaded.
290 # This entry is highly recommended to use for/with IP Cloaking/masking.
291 # For the example to work, this also requires that the m_cloaking
292 # module be loaded as well.
295 # requireident, requiressl, requireaccount: require that users of this
296 # block have a valid ident response, use SSL, or have authenticated.
297 # Requires m_ident, m_sslinfo, or m_services_account respectively.
299 # NOTE: For requireaccount, you must complete the signon prior to full
300 # connection. Currently, this is only possible by using SASL
301 # authentication; passforward and PRIVMSG NickServ happen after
302 # your final connect block has been found.
304 # Alternate MOTD file for this connect class. The contents of this file are
305 # specified using <files secretmotd="filename"> or <execfiles ...>
308 # Allow color codes to be processed in the message of the day file.
309 # the following characters are valid color code escapes:
311 # \037 or \u = Underline
312 # \003 or \c = Color (with a code postfixed to this char)
313 # \017 or \x = Stop all color sequences
314 allowmotdcolors="false"
316 # port: What port this user is allowed to connect on. (optional)
317 # The port MUST be set to listen in the bind blocks above.
321 # name: Name to use for this connect block. Mainly used for
322 # connect class inheriting.
325 # allow: The IP address or hostname of clients that can use this
326 # class. You can specify either an exact match, a glob match, or
330 # maxchans: Maximum number of channels a user in this class
331 # be in at one time. This overrides every other maxchans setting.
334 # timeout: How long (in seconds) the server will wait before
335 # disconnecting a user if they do not do anything on connect.
336 # (Note, this is a client-side thing, if the client does not
337 # send /nick, /user or /pass)
340 # pingfreq: How often (in seconds) the server tries to ping connecting clients.
343 # hardsendq: maximum amount of data allowed in a client's send queue
344 # before they are dropped. Keep this value higher than the length of
345 # your network's /LIST or /WHO output, or you will have lots of
346 # disconnects from sendq overruns!
347 # Setting this to "1M" is equivalent to "1048576", "8K" is 8192, etc.
350 # softsendq: amount of data in a client's send queue before the server
351 # begins delaying their commands in order to allow the sendq to drain
354 # recvq: amount of data allowed in a client's queue before they are dropped.
355 # Entering "8K" is equivalent to "8192", see above.
358 # threshold: This specifies the amount of command penalty a user is allowed to have
359 # before being quit or fakelagged due to flood. Normal commands have a penalty of 1,
360 # ones such as /OPER have penalties up to 10.
362 # If you are not using fakelag, this should be at least 20 to avoid excess flood kills
363 # from processing some commands.
366 # commandrate: This specifies the maximum rate that commands can be processed.
367 # If commands are sent more rapidly, the user's penalty will increase and they will
368 # either be fakelagged or killed when they reach the threshold
370 # Units are millicommands per second, so 1000 means one line per second.
373 # fakelag: Use fakelag instead of killing users for excessive flood
375 # Fake lag stops command processing for a user when a flood is detected rather than
376 # immediately killing them; their commands are held in the recvq and processed later
377 # as the user's command penalty drops. Note that if this is enabled, flooders will
378 # quit with "RecvQ exceeded" rather than "Excess Flood".
381 # localmax: Maximum local connections per IP.
384 # globalmax: Maximum global (network-wide) connections per IP.
387 # useident: Defines if users in this class must respond to a ident query or not.
390 # limit: How many users are allowed in this class
393 # modes: Usermodes that are set on users in this block on connect.
394 # Enabling this option requires that the m_conn_umodes module be loaded.
395 # This entry is highly recommended to use for/with IP Cloaking/masking.
396 # For the example to work, this also requires that the m_cloaking
397 # module be loaded as well.
401 #-#-#-#-#-#-#-#-#-#-#-#- CIDR CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-
403 # CIDR configuration allows detection of clones and applying of #
404 # throttle limits across a CIDR range. (A CIDR range is a group of #
405 # IPs, for example, the CIDR range 192.168.1.0-192.168.1.255 may be #
406 # represented as 192.168.1.0/24). This means that abuse across an ISP #
407 # is detected and curtailed much easier. Here is a good chart that #
408 # shows how many IPs the different CIDRs correspond to: #
409 # https://en.wikipedia.org/wiki/IPv4_subnetting_reference #
410 # https://en.wikipedia.org/wiki/IPv6_subnetting_reference #
414 # ipv4clone: specifies how many bits of an IP address should be
415 # looked at for clones. The default only looks for clones on a
416 # single IP address of a user. You do not want to set this
417 # extremely low. (Values are 0-32).
420 # ipv6clone: specifies how many bits of an IP address should be
421 # looked at for clones. The default only looks for clones on a
422 # single IP address of a user. You do not want to set this
423 # extremely low. (Values are 0-128).
426 # This file has all the information about oper classes, types and o:lines.
427 # You *MUST* edit it.
428 <include file="conf/examples/opers.conf.example">
430 # This file has all the information about server links and ulined servers.
431 # You *MUST* edit it if you intend to link servers.
432 <include file="conf/examples/links.conf.example">
434 #-#-#-#-#-#-#-#-#-#- MISCELLANEOUS CONFIGURATION -#-#-#-#-#-#-#-#-#-#
437 # Files block - contains files whose contents are used by the ircd
439 # motd - displayed on connect and when a user executes /MOTD
440 # rules - displayed when the user executes /RULES
441 # Modules can also define their own files
442 <files motd="conf/examples/motd.txt.example" rules="conf/examples/rules.txt.example">
444 # Example of an executable file include. Note this will be read on rehash,
445 # not when the command is run.
446 #<execfiles rules="wget -O - https://www.example.com/rules.txt">
448 #-#-#-#-#-#-#-#-#-#-#-# MAXIMUM CHANNELS -#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
452 # users: Maximum number of channels a user can be in at once.
455 # opers: Maximum number of channels an oper can be in at once.
458 #-#-#-#-#-#-#-#-#-#-#-#-#-#-# DNS SERVER -#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
459 # If these values are not defined, InspIRCd uses the default DNS resolver
463 # server: DNS server to use to attempt to resolve IP's to hostnames.
464 # in most cases, you won't need to change this, as inspircd will
465 # automatically detect the nameserver depending on /etc/resolv.conf
466 # (or, on Windows, your set nameservers in the registry.)
467 # Note that this must be an IP address and not a hostname, because
468 # there is no resolver to resolve the name until this is defined!
472 # timeout: seconds to wait to try to resolve DNS/hostname.
475 # An example of using an IPv6 nameserver
476 #<dns server="::1" timeout="5">
478 #-#-#-#-#-#-#-#-#-#-#-#-#-#-# PID FILE -#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
480 # Define the path to the PID file here. The PID file can be used to #
481 # rehash the ircd from the shell or to terminate the ircd from the #
482 # shell using shell scripts, perl scripts, etc... and to monitor the #
483 # ircd's state via cron jobs. If this is a relative path, it will be #
484 # relative to the configuration directory, and if it is not defined, #
485 # the default of 'inspircd.pid' is used. #
488 #<pid file="/path/to/inspircd.pid">
490 #-#-#-#-#-#-#-#-#-#-#-#-#- BANLIST LIMITS #-#-#-#-#-#-#-#-#-#-#-#-#-#-#
492 # Use these tags to customise the ban limits on a per channel basis. #
493 # The tags are read from top to bottom, and any tag found which #
494 # matches the channels name applies the banlimit to that channel. #
495 # It is advisable to put an entry with the channel as '*' at the #
496 # bottom of the list. If none are specified or no maxbans tag is #
497 # matched, the banlist size defaults to 64 entries. #
500 <banlist chan="#largechan" limit="128">
501 <banlist chan="*" limit="69">
503 #-#-#-#-#-#-#-#-#-#-#- DISABLED FEATURES -#-#-#-#-#-#-#-#-#-#-#-#-#-#
505 # This tag is optional, and specifies one or more features which are #
506 # not available to non-operators. #
508 # For example you may wish to disable NICK and prevent non-opers from #
509 # changing their nicknames. #
510 # Note that any disabled commands take effect only after the user has #
511 # 'registered' (e.g. after the initial USER/NICK/PASS on connection) #
512 # so for example disabling NICK will not cripple your network. #
514 # You can also define if you want to disable any channelmodes #
515 # or usermodes from your users. #
517 # `fakenonexistant' will make the ircd pretend that nonexistant #
518 # commands simply don't exist to non-opers ("no such command"). #
520 #<disabled commands="TOPIC MODE" usermodes="" chanmodes="" fakenonexistant="yes">
523 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#- RTFM LINE -#-#-#-#-#-#-#-#-#-#-#-#-#-#
525 # Just remove this... Its here to make you read ALL of the config #
528 <die value="You should probably edit your config *PROPERLY* and try again.">
532 #-#-#-#-#-#-#-#-#-#-#-#-#- SERVER OPTIONS -#-#-#-#-#-#-#-#-#-#-#-#-#
534 # Settings to define which features are usable on your server. #
538 # prefixquit: What (if anything) users' quit messages
539 # should be prefixed with.
542 # suffixquit: What (if anything) users' quit messages
543 # should be suffixed with.
546 # prefixpart: What (if anything) users' part messages
547 # should be prefixed with.
549 # NOTE: Use "\"" instead of """ if not using <config format="xml">
551 # suffixpart: What (if anything) users' part message
552 # should be suffixed with.
555 # fixedquit: Set all users' quit messages to this value.
558 # fixedpart: Set all users' part messages in all channels
562 # syntaxhints: If enabled, if a user fails to send the correct parameters
563 # for a command, the ircd will give back some help text of what
564 # the correct parameters are.
567 # cyclehosts: If enabled, when a user gets a host set, it will cycle
568 # them in all their channels. If not, it will simply change their host
569 # without cycling them.
572 # cyclehostsfromuser: If enabled, the source of the mode change for
573 # cyclehosts will be the user who cycled. This can look nicer, but
574 # triggers anti-takeover mechanisms of some obsolete bots.
575 cyclehostsfromuser="no"
577 # ircumsgprefix: Use undernet-style message prefixing for NOTICE and
578 # PRIVMSG. If enabled, it will add users' prefix to the line, if not,
579 # it will just message the user normally.
582 # announcets: If set to yes, when the timestamp on a channel changes, all users
583 # in the channel will be sent a NOTICE about it.
586 # allowmismatch: Setting this option to yes will allow servers to link even
587 # if they don't have the same "optionally common" modules loaded. Setting this to
588 # yes may introduce some desyncs and unwanted behaviour.
591 # defaultbind: Sets the default for <bind> tags without an address. Choices are
592 # ipv4 or ipv6; if not specified, IPv6 will be used if your system has support,
593 # falling back to IPv4 otherwise.
596 # hostintopic: If enabled, channels will show the host of the topic setter
597 # in the topic. If set to no, it will only show the nick of the topic setter.
600 # pingwarning: If a server does not respond to a ping within x seconds,
601 # it will send a notice to opers with snomask +l informing that the server
602 # is about to ping timeout.
605 # serverpingfreq: How often pings are sent between servers (in seconds).
608 # defaultmodes: What modes are set on a empty channel when a user
609 # joins it and it is unregistered.
612 # moronbanner: This is the text that is sent to a user when they are
613 # banned from the server.
614 moronbanner="You're banned! Email abuse@example.com with the ERROR line below for help."
616 # exemptchanops: exemptions for channel access restrictions based on prefix.
617 exemptchanops="nonick:v flood:o"
619 # invitebypassmodes: This allows /invite to bypass other channel modes.
620 # (Such as +k, +j, +l, etc.)
621 invitebypassmodes="yes"
623 # nosnoticestack: This prevents snotices from 'stacking' and giving you
624 # the message saying '(last message repeated X times)'. Defaults to no.
627 # welcomenotice: When turned on, this sends a NOTICE to connecting users
628 # with the text Welcome to <networkname>! after successful registration.
633 #-#-#-#-#-#-#-#-#-#-#-# PERFORMANCE CONFIGURATION #-#-#-#-#-#-#-#-#-#-#
637 # netbuffersize: Size of the buffer used to receive data from clients.
638 # The ircd may only read this amount of text in 1 go at any time.
639 netbuffersize="10240"
641 # somaxconn: The maximum number of connections that may be waiting
642 # in the accept queue. This is *NOT* the total maximum number of
643 # connections per server. Some systems may only allow this to be up
644 # to 5, while others (such as Linux and *BSD) default to 128.
647 # limitsomaxconn: By default, somaxconn (see above) is limited to a
648 # safe maximum value in the 2.0 branch for compatibility reasons.
649 # This setting can be used to disable this limit, forcing InspIRCd
650 # to use the value specified above.
651 limitsomaxconn="true"
653 # softlimit: This optional feature allows a defined softlimit for
654 # connections. If defined, it sets a soft max connections value.
657 # quietbursts: When syncing or splitting from a network, a server
658 # can generate a lot of connect and quit messages to opers with
659 # +C and +Q snomasks. Setting this to yes squelches those messages,
660 # which makes it easier for opers, but degrades the functionality of
661 # bots like BOPM during netsplits.
664 # nouserdns: If enabled, no DNS lookups will be performed on
665 # connecting users. This can save a lot of resources on very busy servers.
668 #-#-#-#-#-#-#-#-#-#-#-# SECURITY CONFIGURATION #-#-#-#-#-#-#-#-#-#-#-#
673 # announceinvites: This option controls which members of the channel
674 # receive an announcement when someone is INVITEd. Available values:
675 # 'none' - don't send invite announcements
676 # 'all' - send invite announcements to all members
677 # 'ops' - send invite announcements to ops and higher ranked users
678 # 'dynamic' - send invite announcements to halfops (if available) and
679 # higher ranked users. This is the recommended setting.
680 announceinvites="dynamic"
682 # hidemodes: If enabled, then the listmodes given will be hidden
683 # from users below halfop. This is not recommended to be set on +b
684 # as it may break some functionality in popular clients such as mIRC.
687 # hideulines: If this value is set to yes, U-lined servers will
688 # be hidden from non-opers in /links and /map.
691 # flatlinks: If this value is set to yes, /map and /links will
692 # be flattened when shown to non-opers.
695 # hidewhois: When defined, the given text will be used in place
696 # of the server a user is on when whoised by a non-oper. Most
697 # networks will want to set this to something like "*.netname.net"
698 # to conceal the actual server a user is on.
699 # Note that enabling this will cause users' idle times to only be
700 # shown when the format /WHOIS <nick> <nick> is used.
703 # hidebans: If this value is set to yes, when a user is banned ([gkz]lined)
704 # only opers will see the ban message when the user is removed
708 # hidekills: If defined, replaces who set a /kill with a custom string.
711 # hideulinekills: Hide kills from clients of ulined servers from server notices.
714 # hidesplits: If enabled, non-opers will not be able to see which
715 # servers split in a netsplit, they will only be able to see that one
716 # occurred (If their client has netsplit detection).
719 # maxtargets: Maximum number of targets per command.
720 # (Commands like /notice, /privmsg, /kick, etc)
723 # customversion: Displays a custom string when a user /version's
724 # the ircd. This may be set for security reasons or vanity reasons.
727 # operspywhois: show opers (users/auspex) the +s and +p channels a user is in. Values:
728 # splitmsg Split secret/private from public channels with an explanatory message
729 # yes Show secret/private channels
730 # no Do not show secret/private channels
733 # runasuser: If this is set, InspIRCd will attempt to switch
734 # to run as this user, which allows binding of ports under 1024.
735 # You should NOT set this unless you are starting as root.
736 # NOT SUPPORTED/NEEDED UNDER WINDOWS.
739 # runasgroup: If this is set, InspIRCd will attempt to switch
740 # to run as this group, which allows binding of ports under 1024.
741 # You should NOT set this unless you are starting as root.
742 # NOT SUPPORTED/NEEDED UNDER WINDOWS.
745 # restrictbannedusers: If this is set to yes, InspIRCd will not allow users
746 # banned on a channel to change nickname or message channels they are
748 restrictbannedusers="yes"
750 # genericoper: Setting this value to yes makes all opers on this server
751 # appear as 'is an IRC operator' in their WHOIS, regardless of their
752 # oper type, however oper types are still used internally. This only
753 # affects the display in WHOIS.
756 # userstats: /stats commands that users can run (opers can run all).
759 #-#-#-#-#-#-#-#-#-#-#-#-# LIMITS CONFIGURATION #-#-#-#-#-#-#-#-#-#-#-#
761 # This configuration tag defines the maximum sizes of various types #
762 # on IRC, such as the maximum length of a channel name, and the #
763 # maximum length of a channel. Note that with the exception of the #
764 # identmax value all values given here are the exact values you would #
765 # expect to see on IRC. This contrasts with the older InspIRCd #
766 # releases where these values would be one character shorter than #
767 # defined to account for a null terminator on the end of the text. #
769 # These values should match network-wide otherwise issues will occur. #
771 # The highest safe value you can set any of these options to is 500, #
772 # but it is recommended that you keep them somewhat #
773 # near their defaults (or lower). #
776 # maxnick: Maximum length of a nickname.
779 # maxchan: Maximum length of a channel name.
782 # maxmodes: Maximum number of mode changes per line.
785 # maxident: Maximum length of a ident/username.
788 # maxquit: Maximum length of a quit message.
791 # maxtopic: Maximum length of a channel topic.
794 # maxkick: Maximum length of a kick message.
797 # maxgecos: Maximum length of a GECOS (realname).
800 # maxaway: Maximum length of an away message.
804 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
808 # Logging is covered with the <log> tag, which you may use to change
809 # the behaviour of the logging of the IRCd.
811 # An example log tag would be:
812 # <log method="file" type="OPER" level="default" target="logs/opers.log">
813 # which would log all information on /oper (failed and successful) to
814 # a file called opers.log.
816 # There are many different types which may be used, and modules may
817 # generate their own. A list of useful types:
818 # - USERS - information relating to user connection and disconnection
819 # - OPER - succesful and failed oper attempts
820 # - KILL - kill related messages
821 # - snomask - server notices (*all* snomasks will be logged)
822 # - FILTER - messages related to filter matches (m_filter)
823 # - CONFIG - configuration related messages
824 # - COMMAND - die and restart messages, and messages related to unknown user types
825 # - SOCKET - socket engine informational/error messages
826 # - MODULE - module related messages
827 # - STARTUP - messages related to starting up the server
829 # You may also log *everything* by using a type of *, and subtract things out
830 # of that by using -TYPE - for example "* -USERINPUT -USEROUTPUT".
833 # - default (general messages, including errors)
834 # - sparse (misc error messages)
835 # - debug (debug messages)
837 # Some types only produce output in the debug level, those are:
838 # - BANCACHE - ban cache debug messages
839 # - CHANNELS - information relating to joining/creating channels
840 # - CULLLIST - debug messages related to issues with removing users
841 # - RESOLVER - DNS related debug messages
842 # - CONNECTCLASS - Connection class debug messages
846 # The following log tag is highly default and uncustomised. It is recommended you
847 # sort out your own log tags. This is just here so you get some output.
849 <log method="file" type="* -USERINPUT -USEROUTPUT" level="default" target="logs/ircd.log">
851 #-#-#-#-#-#-#-#-#-#-#-#-#- WHOWAS OPTIONS -#-#-#-#-#-#-#-#-#-#-#-#-#
853 # This tag lets you define the behaviour of the /whowas command of #
858 # groupsize: Maximum entries per nick shown when performing
862 # maxgroups: Maximum number of nickgroups that can be added to
863 # the list so that /whowas does not use a lot of resources on
867 # maxkeep: Maximum time a nick is kept in the whowas list
868 # before being pruned. Time may be specified in seconds,
869 # or in the following format: 1y2w3d4h5m6s. Minimum is
873 #-#-#-#-#-#-#-#-#-#-#-#-#-#- BAN OPTIONS -#-#-#-#-#-#-#-#-#-#-#-#-#-#
875 # The ban tags define nick masks, host masks and ip ranges which are #
876 # banned from your server. All details in these tags are local to #
881 # ipmask: IP range to ban. Wildcards and CIDR can be used.
884 # reason: Reason to display when user is disconnected.
885 reason="No porn here thanks.">
888 # nick: Nick to disallow. Wildcards are supported.
891 # reason: Reason to display on /nick.
892 reason="Reserved For Services">
894 <badnick nick="NickServ" reason="Reserved For Services">
895 <badnick nick="OperServ" reason="Reserved For Services">
896 <badnick nick="MemoServ" reason="Reserved For Services">
899 # host: ident@hostname to ban.
900 # Wildcards and CIDR (if you specify an IP) can be used.
901 host="*@banneduser.example.net"
903 # reason: Reason to display when user is disconnected
904 reason="Evading Bans">
906 <badhost host="root@*" reason="Don't IRC as root!">
907 <badhost host="*@198.51.100.0/24" reason="This subnet is bad.">
909 # exception: Hosts that are exempt from [kgz]lines.
911 # host: ident@hostname to exempt.
912 # Wildcards and CIDR (if you specify an IP) can be used.
913 host="*@ircop.example.com"
915 # reason: Reason for exception. Only shown in /stats e
916 reason="Oper's hostname">
918 #-#-#-#-#-#-#-#-#-#-#- INSANE BAN OPTIONS -#-#-#-#-#-#-#-#-#-#-#-#-#-#
920 # This optional tag allows you to specify how wide a gline, eline, #
921 # kline, zline or qline can be before it is forbidden from being #
922 # set. By setting hostmasks="yes", you can allow all G, K, E lines, #
923 # no matter how many users the ban would cover. This is not #
924 # recommended! By setting ipmasks="yes", you can allow all Z lines, #
925 # no matter how many users these cover too. Needless to say we #
926 # don't recommend you do this, or, set nickmasks="yes", which will #
931 # hostmasks: Allow bans with insane hostmasks. (over-reaching bans)
934 # ipmasks: Allow bans with insane ipmasks. (over-reaching bans)
937 # nickmasks: Allow bans with insane nickmasks. (over-reaching bans)
940 # trigger: What percentage of users on the network to trigger
941 # specifying an insane ban as. The default is 95.5%, which means
942 # if you have a 1000 user network, a ban will not be allowed if it
943 # will be banning 955 or more users.
947 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#- YAWN -#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
949 # You should already know what to do here :) #
951 <die value="User error. You didn't edit your config properly. Go back and try again.">
953 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# MODULES #-#-#-#-#-#-#-#-#-#-#-#-#-#-#
954 # ____ _ _____ _ _ ____ _ _ _ #
955 # | _ \ ___ __ _ __| | |_ _| |__ (_)___ | __ )(_) |_| | #
956 # | |_) / _ \/ _` |/ _` | | | | '_ \| / __| | _ \| | __| | #
957 # | _ < __/ (_| | (_| | | | | | | | \__ \ | |_) | | |_|_| #
958 # |_| \_\___|\__,_|\__,_| |_| |_| |_|_|___/ |____/|_|\__(_) #
960 # Well done, you've reached the end of the basic configuration, your #
961 # ircd should now start if you want to try it out! (./inspircd start) #
963 # We now suggest you read and edit modules.conf, as modules are what #
964 # provide almost all the features of InspIRCd. :) #
966 # The default does nothing -- we include it for simplicity for you. #
967 <include file="conf/examples/modules.conf.example">
969 # Here are some pre-built modules.conf files that closely match the
970 # default configurations of some popular IRCd's. You still may want to
971 # look over them and make sure if everything is correct for you and setup
972 # the proper SSL information.
974 # *NOTE*: These files have no comments for what the modules do. If you
975 # are interested in that, please read the modules.conf.example. It is also
976 # recommended that you make your own modules file based on modules.conf.example.
978 # Settings similar to UnrealIRCd defaults.
979 #<include file="conf/examples/modules/unrealircd.conf.example">
981 # Settings similar to Charybdis IRCd defaults.
982 #<include file="conf/examples/modules/charybdis.conf.example">
985 #########################################################################
987 # - InspIRCd Development Team - #
988 # https://www.inspircd.org #
990 #########################################################################