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 #-#-#-#-#-#-#-#-#-# CONFIGURATION FORMAT #-#-#-#-#-#-#-#-#-#-#-#-#-#-
39 # In order to maintain compatibility with older configuration files, #
40 # you can change the configuration parser to parse as it did in #
41 # previous releases. When using the "compat" format, you need to use #
42 # C++ escape sequences (e.g. \n) instead of XML ones (e.g. &nl;) and #
43 # can not use <define> to create macros. #
44 #<config format="compat">
46 #-#-#-#-#-#-#-#-#-# INCLUDE CONFIGURATION #-#-#-#-#-#-#-#-#-#-#-#-#-#
48 # This optional tag allows you to include another config file #
49 # allowing you to keep your configuration tidy. The configuration #
50 # file you include will be treated as part of the configuration file #
51 # which includes it, in simple terms the inclusion is transparent. #
53 # All paths to config files are relative to the config directory. #
55 # You may also include an executable file, in which case if you do so #
56 # the output of the executable on the standard output will be added #
57 # to your config at the point of the include tag. #
59 # Syntax is as follows: #
60 #<include file="file.conf"> #
61 #<include directory="modules"> #
62 #<include executable="/path/to/executable parameters"> #
64 # Executable include example: #
65 #<include executable="/usr/bin/wget -q -O - https://example.com/inspircd.conf">
69 #-#-#-#-#-#-#-#-#-#-#-# VARIABLE DEFINITIONS -#-#-#-#-#-#-#-#-#-#-#-#
71 # You can define variables that will be substituted later in the #
72 # configuration file. This can be useful to allow settings to be #
73 # easily changed, or to parameterize a remote includes. #
75 # Variables may be redefined and may reference other variables. #
76 # Value expansion happens at the time the tag is read. #
77 <define name="bindip" value="1.2.2.3">
78 <define name="localips" value="&bindip;/24">
80 #-#-#-#-#-#-#-#-#-#-#-#- SERVER DESCRIPTION -#-#-#-#-#-#-#-#-#-#-#-#-
82 # Here is where you enter the information about your server. #
86 # name: Hostname of your server. Does not need to resolve, but
87 # does need to be correct syntax (something.somethingelse.tld).
88 name="penguin.omega.example.org"
90 # description: Server description. Spaces are allowed.
91 description="Waddle World"
93 # id: The SID to use for this server. This should not be uncommented
94 # unless there is a SID conflict. This must be three characters long.
95 # The first character must be a digit [0-9], the remaining two chars
96 # may be letters [A-Z] or digits.
99 # network: Network name given on connect to clients.
100 # Should be the same on all servers on the network.
104 #-#-#-#-#-#-#-#-#-#-#-#- ADMIN INFORMATION -#-#-#-#-#-#-#-#-#-#-#-#
106 # Describes the Server Administrator's real name (optionally), #
107 # nick, and email address. #
112 name="Johnny English"
114 # nick: Nickname (preferably what you use on the network)
117 # email: email address. Does not have to be valid
118 # but should be for the users to be able to contact you.
119 email="MI5@the.best.secret.agent">
122 #-#-#-#-#-#-#-#-#-#-#-#- PORT CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-
124 # Configure the port and address bindings here. #
127 # TLS (SSL) listener that binds on a TCP/IP endpoint:
129 # address: IP address to bind to if the box that you are hosting
130 # on has more than one IP, else the ircd will try to bind to all
131 # IP's on the box if this is not defined.
134 # port: Port for users or servers to be able to connect to.
135 # you can select multiple ports by separating them
136 # with a - character like the example below.
139 # type: Type of bind block this is. It can either be clients or
140 # servers. Whichever you select will be the only type able to connect
141 # to this bind section.
144 # ssl: If you want the port(s) in this bind tag to use TLS (SSL), set this
145 # to the name of a custom <sslprofile> tag that you have defined. See the
146 # docs page for the TLS (SSL) module you are using for more details:
148 # GnuTLS: https://docs.inspircd.org/3/modules/ssl_gnutls#sslprofile
149 # mbedTLS: https://docs.inspircd.org/3/modules/ssl_mbedtls#sslprofile
150 # OpenSSL: https://docs.inspircd.org/3/modules/ssl_openssl#sslprofile
152 # You will need to load the ssl_openssl module for OpenSSL, ssl_gnutls
153 # for GnuTLS and ssl_mbedtls for mbedTLS.
156 # defer: When this is non-zero, connections will not be handed over to
157 # the daemon from the operating system before data is ready.
158 # In Linux, the value indicates the time period we'll wait for a
159 # connection to come up with data. Don't set it too low!
160 # In BSD the value is ignored; only zero and non-zero is possible.
161 # Windows ignores this parameter completely.
162 # Note: This does not take effect on rehash.
163 # To change it on a running bind, you'll have to comment it out,
164 # rehash, comment it in and rehash again.
167 # free: When this is enabled the listener will be created regardless of
168 # whether the interface that provides the bind address is available. This
169 # is useful for if you are starting InspIRCd on boot when the server may
170 # not have brought the network interfaces up yet.
173 # Plaintext listener that binds on a TCP/IP endpoint:
174 <bind address="" port="6667" type="clients">
177 # Listener that binds on a UNIX endpoint (not supported on Windows):
180 # path: The location to store the UNIX socket
181 #path="/tmp/inspircd.sock"
183 # type: Type of bind block this is. It can either be clients or
184 # servers. Whichever you select will be the only type able to connect
185 # to this bind section.
188 # permissions: The octal permissions to set on the UNIX socket after it has
189 # been created. If you are not familiar with octal permissions you should
190 # not define this or refer to http://permissions-calculator.org for help.
191 # Note: This does not take effect on rehash.
192 # To change it on a running bind, you'll have to comment it out,
193 # rehash, comment it in and rehash again.
196 # replace: if the UNIX socket path already exists then remove it before
197 # attempting to create the new one. This is strongly recommended as it
198 # allows InspIRCd to create sockets in cases where it previously did not
199 # shut down cleanly and left a zombie socket behind.
203 # Listener accepting HTML5 WebSocket connections.
204 # Requires the websocket module and SHA-1 hashing support (provided by the sha1
206 #<bind address="" port="7002" type="clients" hook="websocket">
209 # You can define a custom <sslprofile> tag which defines the TLS (SSL) configuration
210 # for these listeners. See the docs page for the TLS (SSL) module you are using for
213 # Alternatively, you can use one of the default TLS (SSL) profiles which are created
214 # when you have not defined any:
215 # "openssl" (requires the ssl_openssl module)
216 # "gnutls" (requires the ssl_gnutls module)
217 # "mbedtls" (requires the ssl_mbedtls module)
219 # When linking servers, the OpenSSL, GnuTLS, and mbedTLS implementations are
220 # completely link-compatible and can be used alongside each other on each end
221 # of the link without any significant issues.
224 #-#-#-#-#-#-#-#-#-#- CONNECTIONS CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
226 # This is where you can configure which connections are allowed #
227 # and denied access onto your server. The password is optional. #
228 # You may have as many of these as you require. To allow/deny all #
229 # connections, use a '*' or 0.0.0.0/0. #
231 # -- It is important to note that connect tags are read from the -- #
232 # TOP DOWN. This means that you should have more specific deny #
233 # and allow tags at the top, progressively more general, followed #
234 # by a <connect allow="*"> (should you wish to have one). #
236 # Connect blocks are searched twice for each user - once when the TCP #
237 # connection is accepted, and once when the user completes their #
238 # registration. Most of the information (hostname, ident response, #
239 # password, TLS (SSL) when using STARTTLS, etc) is only available #
240 # during the second search. If you are trying to make a closed server #
241 # you will probably need a connect block just for user registration. #
242 # This can be done by using <connect registered="no"> #
244 # To enable IRCCloud on your network uncomment this:
245 #<include file="examples/providers/irccloud.conf.example">
247 # A connect class with <connect:deny> set denies connections from the specified host/IP range.
249 # deny: Will not let people connect if they have specified host/IP.
252 # reason: The message that users will see if they match a deny block.
253 reason="The 6bone address space is deprecated">
255 # A connect class with <connect:allow> set allows c from the specified host/IP range.
257 # name: Name to use for this connect block. Mainly used for
258 # connect class inheriting.
261 # parent: This setting is to specify if this connect class
262 # inherits settings from any other. Put the other class's name
263 # in here to use its settings as a template - for example, if
264 # you only want to adjust sendq and a password
267 # allow: The IP address or hostname of clients that can use this
268 # class. You can specify either an exact match, a glob match, or
272 # hash: the hash function this password is hashed with. Requires the
273 # module for the selected function (bcrypt, md5, sha1, or sha256) and
274 # the password hashing module (password_hash) to be loaded.
276 # You may also use any of the above other than bcrypt prefixed with
277 # either "hmac-" or "pbkdf2-hmac-" (requires the pbkdf2 module).
278 # Create hashed passwords with: /MKPASSWD <hashtype> <plaintext>
281 # password: Password to use for this block/user(s)
284 # maxchans: Maximum number of channels a user in this class
285 # can be in at one time.
288 # timeout: How long the server will wait before disconnecting
289 # a user if they do not do anything on connect.
290 # (Note, this is a client-side thing, if the client does not
291 # send /NICK, /USER or /PASS)
294 # localmax: Maximum local connections per IP (or CIDR mask, see below).
297 # globalmax: Maximum global (network-wide) connections per IP (or CIDR mask, see below).
300 # maxconnwarn: Enable warnings when localmax or globalmax are reached (defaults to yes)
303 # resolvehostnames: If disabled, no DNS lookups will be performed on connecting users
304 # in this class. This can save a lot of resources on very busy servers.
305 resolvehostnames="yes"
307 # usednsbl: Defines whether or not users in this class are subject to DNSBL. Default is yes.
308 # This setting only has effect when the dnsbl module is loaded.
311 # useident: Defines if users in this class MUST respond to a ident query or not.
314 # usests: Whether a STS policy should be advertised to users in this class.
315 # This setting only has effect when the ircv3_sts module is loaded.
318 # webirc: Restricts usage of this class to the specified WebIRC gateway.
319 # This setting only has effect when the cgiirc module is loaded.
322 # limit: How many users are allowed in this class
325 # modes: User modes that are set on users in this block on connect.
326 # Enabling this option requires that the conn_umodes module be loaded.
327 # This entry is highly recommended to use for/with IP cloaking/masking.
328 # For the example to work, this also requires that the cloaking
329 # module be loaded as well.
332 # requireident: Require that users of this block have a valid ident response.
333 # Requires the ident module to be loaded.
336 # requiressl: Require that users of this block use a TLS (SSL) connection.
337 # This can also be set to "trusted", as to only accept client certificates
338 # issued by a certificate authority that you can configure in the
339 # settings of the TLS (SSL) module that you're using.
340 # Requires the sslinfo module to be loaded.
343 # requireaccount: Require that users of this block have authenticated to a
345 # NOTE: You must complete the signon prior to full connection. Currently,
346 # this is only possible by using SASL authentication; passforward
347 # and PRIVMSG NickServ happen after your final connect block has been found.
348 # Requires the services_account module to be loaded.
349 #requireaccount="yes"
351 # Alternate MOTD file for this connect class. The contents of this file are
352 # specified using <files secretmotd="filename"> or <execfiles ...>
354 # NOTE: the following escape sequences for IRC formatting characters can be
357 # Color: \c<fg>[,<bg>]
359 # Monospace: \m (not widely supported)
362 # Strikethrough: \s (not widely supported)
364 # See https://defs.ircdocs.horse/info/formatting.html for more information
365 # on client support for formatting characters.
368 # port: What port range this user is allowed to connect on. (optional)
369 # The ports MUST be set to listen in the bind blocks above.
373 # name: Name to use for this connect block. Mainly used for
374 # connect class inheriting.
377 # allow: The IP address or hostname of clients that can use this
378 # class. You can specify either an exact match, a glob match, or
382 # maxchans: Maximum number of channels a user in this class
383 # can be in at one time.
386 # timeout: How long the server will wait before disconnecting
387 # a user if they do not do anything on connect.
388 # (Note, this is a client-side thing, if the client does not
389 # send /NICK, /USER or /PASS)
392 # pingfreq: How often the server tries to ping connecting clients.
395 # hardsendq: maximum amount of data allowed in a client's send queue
396 # before they are dropped. Keep this value higher than the length of
397 # your network's /LIST or /WHO output, or you will have lots of
398 # disconnects from sendq overruns!
399 # Setting this to "1M" is equivalent to "1048576", "8K" is 8192, etc.
402 # softsendq: amount of data in a client's send queue before the server
403 # begins delaying their commands in order to allow the sendq to drain
406 # recvq: amount of data allowed in a client's queue before they are dropped.
407 # Entering "10K" is equivalent to "10240", see above.
410 # threshold: This specifies the amount of command penalty a user is allowed to have
411 # before being quit or fakelagged due to flood. Normal commands have a penalty of 1,
412 # ones such as /OPER have penalties up to 10.
414 # If you are not using fakelag, this should be at least 20 to avoid excess flood kills
415 # from processing some commands.
418 # commandrate: This specifies the maximum rate that commands can be processed.
419 # If commands are sent more rapidly, the user's penalty will increase and they will
420 # either be fakelagged or killed when they reach the threshold
422 # Units are millicommands per second, so 1000 means one line per second.
425 # fakelag: Use fakelag instead of killing users for excessive flood
427 # Fake lag stops command processing for a user when a flood is detected rather than
428 # immediately killing them; their commands are held in the recvq and processed later
429 # as the user's command penalty drops. Note that if this is enabled, flooders will
430 # quit with "RecvQ exceeded" rather than "Excess Flood".
433 # localmax: Maximum local connections per IP.
436 # globalmax: Maximum global (network-wide) connections per IP.
439 # resolvehostnames: If disabled, no DNS lookups will be performed on connecting users
440 # in this class. This can save a lot of resources on very busy servers.
441 resolvehostnames="yes"
443 # useident: Defines if users in this class must respond to a ident query or not.
446 # usests: Whether a STS policy should be advertised to users in this class.
447 # This setting only has effect when the ircv3_sts module is loaded.
450 # limit: How many users are allowed in this class
453 # modes: User modes that are set on users in this block on connect.
454 # Enabling this option requires that the conn_umodes module be loaded.
455 # This entry is highly recommended to use for/with IP cloaking/masking.
456 # For the example to work, this also requires that the cloaking
457 # module be loaded as well.
462 #-#-#-#-#-#-#-#-#-#-#-#- CIDR CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-
464 # CIDR configuration allows detection of clones and applying of #
465 # throttle limits across a CIDR range. (A CIDR range is a group of #
466 # IPs, for example, the CIDR range 192.168.1.0-192.168.1.255 may be #
467 # represented as 192.168.1.0/24). This means that abuse across an ISP #
468 # is detected and curtailed much easier. Here is a good chart that #
469 # shows how many IPs the different CIDRs correspond to: #
470 # https://en.wikipedia.org/wiki/IPv4_subnetting_reference #
471 # https://en.wikipedia.org/wiki/IPv6_subnetting_reference #
475 # ipv4clone: specifies how many bits of an IP address should be
476 # looked at for clones. The default only looks for clones on a
477 # single IP address of a user. You do not want to set this
478 # extremely low. (Values are 0-32).
481 # ipv6clone: specifies how many bits of an IP address should be
482 # looked at for clones. The default only looks for clones on a
483 # single IP address of a user. You do not want to set this
484 # extremely low. (Values are 0-128).
487 # This file has all the information about oper classes, types and o:lines.
488 # You *MUST* edit it.
489 #<include file="examples/opers.conf.example">
491 # This file has all the information about server links and ulined servers.
492 # You *MUST* edit it if you intend to link servers.
493 #<include file="examples/links.conf.example">
495 #-#-#-#-#-#-#-#-#-#- MISCELLANEOUS CONFIGURATION -#-#-#-#-#-#-#-#-#-#
498 # Files block - contains files whose contents are used by the ircd
500 # motd - displayed on connect and when a user executes /MOTD
501 # Modules can also define their own files
502 <files motd="examples/motd.txt.example">
504 # Example of an executable file include. Note this will be read on rehash,
505 # not when the command is run.
506 #<execfiles motd="wget -O - https://www.example.com/motd.txt">
508 #-#-#-#-#-#-#-#-#-#-#-#-#-#-# DNS SERVER -#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
509 # If these values are not defined, InspIRCd uses the default DNS resolver
513 # server: DNS server to use to attempt to resolve IP's to hostnames.
514 # in most cases, you won't need to change this, as inspircd will
515 # automatically detect the nameserver depending on /etc/resolv.conf
516 # (or, on Windows, your set nameservers in the registry.)
517 # Note that this must be an IP address and not a hostname, because
518 # there is no resolver to resolve the name until this is defined!
522 # timeout: time to wait to try to resolve DNS/hostname.
525 # An example of using an IPv6 nameserver
526 #<dns server="::1" timeout="5">
528 #-#-#-#-#-#-#-#-#-#-#-#-#-#-# PID FILE -#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
530 # Define the path to the PID file here. The PID file can be used to #
531 # rehash the ircd from the shell or to terminate the ircd from the #
532 # shell using shell scripts, perl scripts, etc... and to monitor the #
533 # ircd's state via cron jobs. If this is a relative path, it will be #
534 # relative to the configuration directory, and if it is not defined, #
535 # the default of 'inspircd.pid' is used. #
538 #<pid file="/path/to/inspircd.pid">
540 #-#-#-#-#-#-#-#-#-#-#-#-#- LIST MODE LIMITS #-#-#-#-#-#-#-#-#-#-#-#-#-#
542 # The <maxlist> tag is used customise the maximum number of each list #
543 # mode that can be set on a channel. #
544 # The tags are read from top to bottom and the list mode limit from #
545 # the first tag found which matches the channel name and mode type is #
546 # applied to that channel. #
547 # It is advisable to put an entry with the channel as '*' at the #
548 # bottom of the list. If none are specified or no maxlist tag is #
549 # matched, the banlist size defaults to 100 entries. #
552 # Allows #largechan to have up to 200 ban entries.
553 #<maxlist mode="ban" chan="#largechan" limit="200">
555 # Allows #largechan to have up to 200 ban exception entries.
556 #<maxlist mode="e" chan="#largechan" limit="200">
558 # Allows all channels and list modes not previously matched to have
560 <maxlist chan="*" limit="100">
562 #-#-#-#-#-#-#-#-#-#-#-#-#- SERVER OPTIONS -#-#-#-#-#-#-#-#-#-#-#-#-#
564 # Settings to define which features are usable on your server. #
568 # prefixquit: What (if anything) users' quit messages
569 # should be prefixed with.
572 # suffixquit: What (if anything) users' quit messages
573 # should be suffixed with.
576 # prefixpart: What (if anything) users' part messages
577 # should be prefixed with.
579 # NOTE: Use "\"" instead of """ if not using <config format="xml">
581 # suffixpart: What (if anything) users' part message
582 # should be suffixed with.
585 # fixedquit: Set all users' quit messages to this value.
588 # fixedpart: Set all users' part messages in all channels
592 # syntaxhints: If enabled, if a user fails to send the correct parameters
593 # for a command, the ircd will give back some help text of what
594 # the correct parameters are.
597 # casemapping: This sets the case mapping method to be used by the
598 # server. This MUST be the same on all servers. Possible values are:
599 # "ascii" (recommended)
600 # "rfc1459" (default, required for linking to 2.0 servers)
601 # NOTE: if you are using the nationalchars module this setting will be
602 # ignored. You should use <nationalchars:casemapping> instead.
605 # cyclehostsfromuser: If enabled, the source of the mode change for
606 # cyclehosts will be the user who cycled. This can look nicer, but
607 # triggers anti-takeover mechanisms of some obsolete bots.
608 cyclehostsfromuser="no"
610 # announcets: If set to yes, when the timestamp on a channel changes, all users
611 # in the channel will be sent a NOTICE about it.
614 # allowmismatch: Setting this option to yes will allow servers to link even
615 # if they don't have the same "optionally common" modules loaded. Setting this to
616 # yes may introduce some desyncs and unwanted behaviour.
619 # defaultbind: Sets the default for <bind> tags without an address. Choices are
620 # ipv4 or ipv6; if not specified, IPv6 will be used if your system has support,
621 # falling back to IPv4 otherwise.
624 # hostintopic: If enabled, channels will show the host of the topic setter
625 # in the topic. If set to no, it will only show the nick of the topic setter.
628 # pingwarning: If a server does not respond to a ping within this period,
629 # it will send a notice to opers with snomask +l informing that the server
630 # is about to ping timeout.
633 # serverpingfreq: How often pings are sent between servers.
636 # splitwhois: Whether to split private/secret channels from normal channels
637 # in WHOIS responses. Possible values for this are:
638 # 'no' - list all channels together in the WHOIS response regardless of type.
639 # 'split' - split private/secret channels to a separate WHOIS response numeric.
640 # 'splitmsg' - the same as split but also send a message explaining the split.
643 # defaultmodes: What modes are set on a empty channel when a user
644 # joins it and it is unregistered.
647 # xlinemessage: This is the text that is sent to a user when they are
648 # banned from the server.
649 xlinemessage="You're banned! Email irc@example.com with the ERROR line below for help."
651 # allowzerolimit: If enabled then allow a limit of 0 to be set on channels.
652 # This is non-standard behaviour and should only be enabled if you need to
653 # link with servers running 2.0. Defaults to yes.
656 # modesinlist: If enabled then the current channel modes will be shown
657 # in the /LIST response. Defaults to yes.
660 # exemptchanops: Allows users with with a status mode to be exempt
661 # from various channel restrictions. Possible restrictions are:
662 # - anticaps Channel mode +B - blocks messages with too many capital
663 # letters (requires the anticaps module).
664 # - auditorium-see Permission required to see the full user list of
665 # a +u channel (requires the auditorium module).
666 # - auditorium-vis Permission required to be visible in a +u channel
667 # (requires the auditorium module).
668 # - blockcaps Channel mode +B - blocks messages with too many capital
669 # letters (requires the blockcaps module).
670 # - blockcolor Channel mode +c - blocks messages with formatting codes
671 # (requires the blockcolor module).
672 # - censor Channel mode +G - censors messages based on the network
673 # configuration (requires the censor module).
674 # - filter Channel mode +g - blocks messages containing the given
675 # glob mask (requires the chanfilter module).
676 # - flood Channel mode +f - kicks (and bans) on text flood of a
677 # specified rate (requires the messageflood module).
678 # - nickflood Channel mode +F - blocks nick changes after a specified
679 # rate (requires the nickflood module).
680 # - noctcp Channel mode +C - blocks any CTCPs to the channel
681 # (requires the noctcp module).
682 # - nonick Channel mode +N - prevents users on the channel from
683 # changing nicks (requires the nonicks module).
684 # - nonotice Channel mode +T - blocks /NOTICEs to the channel
685 # (requires the nonotice module).
686 # - regmoderated Channel mode +M - blocks unregistered users from
687 # speaking (requires the services account module).
688 # - stripcolor Channel mode +S - strips formatting codes from
689 # messages (requires the stripcolor module).
690 # - topiclock Channel mode +t - limits changing the topic to (half)ops
691 # You can also configure this on a per-channel basis with a channel mode and
692 # even negate the configured exemptions below.
693 # See exemptchanops in modules.conf.example for more details.
694 exemptchanops="censor:o filter:o nickflood:o nonick:v regmoderated:o"
696 # invitebypassmodes: This allows /INVITE to bypass other channel modes.
697 # (Such as +k, +j, +l, etc.)
698 invitebypassmodes="yes"
700 # nosnoticestack: This prevents snotices from 'stacking' and giving you
701 # the message saying '(last message repeated X times)'. Defaults to no.
705 #-#-#-#-#-#-#-#-#-#-#-# PERFORMANCE CONFIGURATION #-#-#-#-#-#-#-#-#-#-#
709 # netbuffersize: Size of the buffer used to receive data from clients.
710 # The ircd may only read this amount of text in 1 go at any time.
711 netbuffersize="10240"
713 # somaxconn: The maximum number of connections that may be waiting
714 # in the accept queue. This is *NOT* the total maximum number of
715 # connections per server. Some systems may only allow this to be up
716 # to 5, while others (such as Linux and *BSD) default to 128.
717 # Setting this above the limit imposed by your OS can have undesired
721 # softlimit: This optional feature allows a defined softlimit for
722 # connections. If defined, it sets a soft max connections value.
725 # clonesonconnect: If this is set to no, we won't check for clones
726 # on initial connection, but only after the DNS check is done.
727 # This can be useful where your main class is more restrictive
728 # than some other class a user can be assigned after DNS lookup is complete.
729 # Turning this option off will make the server spend more time on users we may
730 # potentially not want. Normally this should be negligible, though.
731 # Default value is yes
732 clonesonconnect="yes"
734 # timeskipwarn: The time period that a server clock can jump by before
735 # operators will be warned that the server is having performance issues.
738 # quietbursts: When syncing or splitting from a network, a server
739 # can generate a lot of connect and quit messages to opers with
740 # +C and +Q snomasks. Setting this to yes squelches those messages,
741 # which makes it easier for opers, but degrades the functionality of
742 # bots like BOPM during netsplits.
745 #-#-#-#-#-#-#-#-#-#-#-# SECURITY CONFIGURATION #-#-#-#-#-#-#-#-#-#-#-#
749 # allowcoreunload: If this value is set to yes, Opers will be able to
750 # unload core modules (e.g. core_privmsg).
753 # announceinvites: This option controls which members of the channel
754 # receive an announcement when someone is INVITEd. Available values:
755 # 'none' - don't send invite announcements
756 # 'all' - send invite announcements to all members
757 # 'ops' - send invite announcements to ops and higher ranked users
758 # 'dynamic' - send invite announcements to halfops (if available) and
759 # higher ranked users. This is the recommended setting.
760 announceinvites="dynamic"
762 # hideulines: If this value is set to yes, U-lined servers will
763 # be hidden from non-opers in /LINKS and /MAP.
766 # flatlinks: If this value is set to yes, /MAP and /LINKS will
767 # be flattened when shown to non-opers.
770 # hideserver: When defined, the given text will be used in place
771 # of the server name in public messages. As with <server:name> this
772 # does not need to resolve but does need to be a valid hostname.
774 # NOTE: enabling this will cause users' idle times to only be shown
775 # when a remote whois (/WHOIS <nick> <nick>) is used.
776 #hideserver="*.example.com"
778 # hidebans: If this value is set to yes, when a user is banned ([KGZ]-lined)
779 # only opers will see the ban message when the user is removed
783 # hidekills: If defined, replaces who executed a /KILL with a custom string.
786 # hideulinekills: Hide kills from clients of ulined servers from server notices.
789 # hidesplits: If enabled, non-opers will not be able to see which
790 # servers split in a netsplit, they will only be able to see that one
791 # occurred (If their client has netsplit detection).
794 # maxtargets: Maximum number of targets per command.
795 # (Commands like /NOTICE, /PRIVMSG, /KICK, etc)
798 # customversion: A custom message to be displayed in the comments field
799 # of the VERSION command response. This does not hide the InspIRCd version.
802 # runasuser: If this is set, InspIRCd will attempt to switch
803 # to run as this user, which allows binding of ports under 1024.
804 # You should NOT set this unless you are starting as root.
805 # NOT SUPPORTED/NEEDED UNDER WINDOWS.
808 # runasgroup: If this is set, InspIRCd will attempt to switch
809 # to run as this group, which allows binding of ports under 1024.
810 # You should NOT set this unless you are starting as root.
811 # NOT SUPPORTED/NEEDED UNDER WINDOWS.
814 # restrictbannedusers: If this is set to yes, InspIRCd will not allow users
815 # banned on a channel to change nickname or message channels they are
816 # banned on. This can also be set to silent to restrict the user but not
818 restrictbannedusers="yes"
820 # genericoper: Setting this value to yes makes all opers on this server
821 # appear as 'is a server operator' in their WHOIS, regardless of their
822 # oper type, however oper types are still used internally. This only
823 # affects the display in WHOIS.
826 # userstats: /STATS commands that users can run (opers can run all).
829 #-#-#-#-#-#-#-#-#-#-#-#-# LIMITS CONFIGURATION #-#-#-#-#-#-#-#-#-#-#-#
831 # This configuration tag defines the maximum sizes of various types #
832 # on IRC, such as the maximum length of a channel name, and the #
833 # maximum length of a channel. These values should match network-wide #
834 # otherwise issues will occur. #
836 # The highest safe value you can set any of these options to is 500, #
837 # but it is recommended that you keep them somewhat #
838 # near their defaults (or lower). #
841 # maxnick: Maximum length of a nickname.
844 # maxchan: Maximum length of a channel name.
847 # maxmodes: Maximum number of mode changes per line.
850 # maxident: Maximum length of a ident/username.
853 # maxhost: Maximum length of a hostname.
856 # maxquit: Maximum length of a quit message.
859 # maxtopic: Maximum length of a channel topic.
862 # maxkick: Maximum length of a kick message.
865 # maxreal: Maximum length of a real name.
868 # maxaway: Maximum length of an away message.
871 #-#-#-#-#-#-#-#-#-#-#-#-# PATHS CONFIGURATION #-#-#-#-#-#-#-#-#-#-#-#-#
873 # This configuration tag defines the location that InspIRCd stores #
874 # various types of files such as configuration files, log files and #
875 # modules. You will probably not need to change these from the values #
876 # set when InspIRCd was built unless you are using a binary package #
877 # where you do not have the ability to set build time configuration. #
878 #<path configdir="conf" datadir="data" logdir="logs" moduledir="modules">
880 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
884 # Logging is covered with the <log> tag, which you may use to change
885 # the behaviour of the logging of the IRCd.
887 # An example log tag would be:
888 # <log method="file" type="OPER" level="default" target="opers.log">
889 # which would log all information on /OPER (failed and successful) to
890 # a file called opers.log.
892 # There are many different types which may be used, and modules may
893 # generate their own. A list of useful types:
894 # - USERS - information relating to user connection and disconnection
895 # - OPER - successful and failed oper attempts
896 # - KILL - kill related messages
897 # - FILTER - messages related to filter matches (filter module)
898 # - CONFIG - configuration related messages
899 # - COMMAND - die and restart messages, and messages related to unknown user types
900 # - SOCKET - socket engine informational/error messages
901 # - MODULE - module related messages
902 # - STARTUP - messages related to starting up the server
904 # You may also log *everything* by using a type of *, and subtract things out
905 # of that by using -TYPE - for example "* -USERINPUT -USEROUTPUT".
908 # - default (general messages, including errors)
909 # - sparse (misc error messages)
910 # - debug (debug messages)
912 # Some types only produce output in the debug level, those are:
913 # - BANCACHE - ban cache debug messages
914 # - CHANNELS - information relating to joining/creating channels
915 # - CULLLIST - debug messages related to issues with removing users
916 # - RESOLVER - DNS related debug messages
917 # - CONNECTCLASS - Connection class debug messages
921 # If your server is producing a high levels of log messages you can also set the
922 # flush="[positive number]" attribute to specify how many log messages should be
923 # buffered before flushing to disk. You should probably not specify this unless
924 # you are having problems.
926 # The following log tag is highly default and uncustomised. It is recommended you
927 # sort out your own log tags. This is just here so you get some output.
929 <log method="file" type="* -USERINPUT -USEROUTPUT" level="default" target="ircd.log">
931 #-#-#-#-#-#-#-#-#-#-#-#-#- WHOWAS OPTIONS -#-#-#-#-#-#-#-#-#-#-#-#-#
933 # This tag lets you define the behaviour of the /WHOWAS command of #
938 # groupsize: Maximum entries per nick shown when performing
942 # maxgroups: Maximum number of nickgroups that can be added to
943 # the list so that /WHOWAS does not use a lot of resources on
947 # maxkeep: Maximum time a nick is kept in the whowas list
948 # before being pruned. Time may be specified in seconds,
949 # or in the following format: 1y2w3d4h5m6s. Minimum is
953 #-#-#-#-#-#-#-#-#-#-#-#-#-#- BAN OPTIONS -#-#-#-#-#-#-#-#-#-#-#-#-#-#
955 # The ban tags define nick masks, host masks and ip ranges which are #
956 # banned from your server. All details in these tags are local to #
961 # ipmask: IP range to ban. Wildcards and CIDR can be used.
964 # reason: Reason to display when user is disconnected.
965 reason="No porn here thanks.">
968 # nick: Nick to disallow. Wildcards are supported.
971 # reason: Reason to display on /NICK.
972 reason="Don't use this nick.">
975 # host: ident@hostname to ban.
976 # Wildcards and CIDR (if you specify an IP) can be used.
977 host="*@banneduser.example.net"
979 # reason: Reason to display when user is disconnected
980 reason="Evading Bans">
982 <badhost host="root@*" reason="Don't IRC as root!">
983 <badhost host="*@198.51.100.0/24" reason="This subnet is bad.">
985 # exception: Hosts that are exempt from [KGZ]-lines.
987 # host: ident@hostname to exempt.
988 # Wildcards and CIDR (if you specify an IP) can be used.
989 host="*@serverop.example.com"
991 # reason: Reason for exception. Only shown in /STATS e.
992 reason="Oper's hostname">
994 #-#-#-#-#-#-#-#-#-#-#- INSANE BAN OPTIONS -#-#-#-#-#-#-#-#-#-#-#-#-#-#
996 # This optional tag allows you to specify how wide a G-line, E-line, #
997 # K-line, Z-line or Q-line can be before it is forbidden from being #
998 # set. By setting hostmasks="yes", you can allow all G-, K-, E-lines, #
999 # no matter how many users the ban would cover. This is not #
1000 # recommended! By setting ipmasks="yes", you can allow all Z-lines, #
1001 # no matter how many users these cover too. Needless to say we #
1002 # don't recommend you do this, or, set nickmasks="yes", which will #
1003 # allow any Q-line. #
1007 # hostmasks: Allow bans with insane hostmasks. (over-reaching bans)
1010 # ipmasks: Allow bans with insane ipmasks. (over-reaching bans)
1013 # nickmasks: Allow bans with insane nickmasks. (over-reaching bans)
1016 # trigger: What percentage of users on the network to trigger
1017 # specifying an insane ban as. The default is 95.5%, which means
1018 # if you have a 1000 user network, a ban will not be allowed if it
1019 # will be banning 955 or more users.
1022 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# MODULES #-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1023 # ____ _ _____ _ _ ____ _ _ _ #
1024 # | _ \ ___ __ _ __| | |_ _| |__ (_)___ | __ )(_) |_| | #
1025 # | |_) / _ \/ _` |/ _` | | | | '_ \| / __| | _ \| | __| | #
1026 # | _ < __/ (_| | (_| | | | | | | | \__ \ | |_) | | |_|_| #
1027 # |_| \_\___|\__,_|\__,_| |_| |_| |_|_|___/ |____/|_|\__(_) #
1029 # Well done, you've reached the end of the basic configuration, your #
1030 # ircd should now start if you want to try it out! (./inspircd start) #
1032 # We now suggest you read and edit modules.conf, as modules are what #
1033 # provide almost all the features of InspIRCd. :) #
1035 # The default does nothing -- we include it for simplicity for you. #
1036 #<include file="examples/modules.conf.example">
1038 #-#-#-#-#-#-#-#-#-#-#-# SERVICES CONFIGURATION #-#-#-#-#-#-#-#-#-#-#-#
1040 # If you use services you will probably want to include one of the #
1041 # following files which set up aliases, nick reservations and filter #
1042 # exemptions for services pseudoclients: #
1044 # Anope users should uncomment this:
1045 #<include file="examples/services/anope.conf.example">
1047 # Atheme users should uncomment this:
1048 #<include file="examples/services/atheme.conf.example">
1050 # Users of other services should uncomment this:
1051 #<include file="examples/services/generic.conf.example">
1053 #########################################################################
1055 # - InspIRCd Development Team - #
1056 # https://www.inspircd.org #
1058 #########################################################################