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 to
145 # the name of a custom <sslprofile> tag that you have defined or one
146 # of "openssl", "gnutls", "mbedtls" if you have not defined any. See the
147 # docs page for the TLS (SSL) module you are using for more details.
149 # You will need to load the ssl_openssl module for OpenSSL, ssl_gnutls
150 # for GnuTLS and ssl_mbedtls for mbedTLS.
153 # defer: When this is non-zero, connections will not be handed over to
154 # the daemon from the operating system before data is ready.
155 # In Linux, the value indicates the time period we'll wait for a
156 # connection to come up with data. Don't set it too low!
157 # In BSD the value is ignored; only zero and non-zero is possible.
158 # Windows ignores this parameter completely.
159 # Note: This does not take effect on rehash.
160 # To change it on a running bind, you'll have to comment it out,
161 # rehash, comment it in and rehash again.
164 # free: When this is enabled the listener will be created regardless of
165 # whether the interface that provides the bind address is available. This
166 # is useful for if you are starting InspIRCd on boot when the server may
167 # not have brought the network interfaces up yet.
170 # Plaintext listener that binds on a TCP/IP endpoint:
171 <bind address="" port="6667" type="clients">
174 # Listener that binds on a UNIX endpoint (not supported on Windows):
177 # path: The location to store the UNIX socket
178 #path="/tmp/inspircd.sock"
180 # type: Type of bind block this is. It can either be clients or
181 # servers. Whichever you select will be the only type able to connect
182 # to this bind section.
185 # permissions: The octal permissions to set on the UNIX socket after it has
186 # been created. If you are not familiar with octal permissions you should
187 # not define this or refer to http://permissions-calculator.org for help.
188 # Note: This does not take effect on rehash.
189 # To change it on a running bind, you'll have to comment it out,
190 # rehash, comment it in and rehash again.
193 # replace: if the UNIX socket path already exists then remove it before
194 # attempting to create the new one. This is strongly recommended as it
195 # allows InspIRCd to create sockets in cases where it previously did not
196 # shut down cleanly and left a zombie socket behind.
200 # Listener accepting HTML5 WebSocket connections.
201 # Requires the websocket module and SHA-1 hashing support (provided by the sha1
203 #<bind address="" port="7002" type="clients" hook="websocket">
206 # You can define a custom <sslprofile> tag which defines the TLS (SSL) configuration
207 # for these listeners. See the docs page for the TLS (SSL) module you are using for
210 # Alternatively, you can use one of the default TLS (SSL) profiles which are created
211 # when you have not defined any:
212 # "openssl" (requires the ssl_openssl module)
213 # "gnutls" (requires the ssl_gnutls module)
214 # "mbedtls" (requires the ssl_mbedtls module)
216 # When linking servers, the OpenSSL, GnuTLS, and mbedTLS implementations are
217 # completely link-compatible and can be used alongside each other on each end
218 # of the link without any significant issues.
221 #-#-#-#-#-#-#-#-#-#- CONNECTIONS CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
223 # This is where you can configure which connections are allowed #
224 # and denied access onto your server. The password is optional. #
225 # You may have as many of these as you require. To allow/deny all #
226 # connections, use a '*' or 0.0.0.0/0. #
228 # -- It is important to note that connect tags are read from the -- #
229 # TOP DOWN. This means that you should have more specific deny #
230 # and allow tags at the top, progressively more general, followed #
231 # by a <connect allow="*"> (should you wish to have one). #
233 # Connect blocks are searched twice for each user - once when the TCP #
234 # connection is accepted, and once when the user completes their #
235 # registration. Most of the information (hostname, ident response, #
236 # password, TLS (SSL) when using STARTTLS, etc) is only available #
237 # during the second search. If you are trying to make a closed server #
238 # you will probably need a connect block just for user registration. #
239 # This can be done by using <connect registered="no"> #
241 # To enable IRCCloud on your network uncomment this:
242 #<include file="examples/providers/irccloud.conf.example">
244 # A connect class with <connect:deny> set denies connections from the specified host/IP range.
246 # deny: Will not let people connect if they have specified host/IP.
249 # reason: The message that users will see if they match a deny block.
250 reason="The 6bone address space is deprecated">
252 # A connect class with <connect:allow> set allows c from the specified host/IP range.
254 # name: Name to use for this connect block. Mainly used for
255 # connect class inheriting.
258 # parent: This setting is to specify if this connect class
259 # inherits settings from any other. Put the other class's name
260 # in here to use its settings as a template - for example, if
261 # you only want to adjust sendq and a password
264 # allow: The IP address or hostname of clients that can use this
265 # class. You can specify either an exact match, a glob match, or
269 # hash: the hash function this password is hashed with. Requires the
270 # module for the selected function (bcrypt, md5, sha1, or sha256) and
271 # the password hashing module (password_hash) to be loaded.
273 # You may also use any of the above other than bcrypt prefixed with
274 # either "hmac-" or "pbkdf2-hmac-" (requires the pbkdf2 module).
275 # Create hashed passwords with: /MKPASSWD <hashtype> <plaintext>
278 # password: Password to use for this block/user(s)
281 # maxchans: Maximum number of channels a user in this class
282 # can be in at one time.
285 # timeout: How long the server will wait before disconnecting
286 # a user if they do not do anything on connect.
287 # (Note, this is a client-side thing, if the client does not
288 # send /NICK, /USER or /PASS)
291 # localmax: Maximum local connections per IP (or CIDR mask, see below).
294 # globalmax: Maximum global (network-wide) connections per IP (or CIDR mask, see below).
297 # maxconnwarn: Enable warnings when localmax or globalmax are reached (defaults to yes)
300 # resolvehostnames: If disabled, no DNS lookups will be performed on connecting users
301 # in this class. This can save a lot of resources on very busy servers.
302 resolvehostnames="yes"
304 # usednsbl: Defines whether or not users in this class are subject to DNSBL. Default is yes.
305 # This setting only has effect when the dnsbl module is loaded.
308 # useident: Defines if users in this class MUST respond to a ident query or not.
311 # usests: Whether a STS policy should be advertised to users in this class.
312 # This setting only has effect when the ircv3_sts module is loaded.
315 # webirc: Restricts usage of this class to the specified WebIRC gateway.
316 # This setting only has effect when the cgiirc module is loaded.
319 # limit: How many users are allowed in this class
322 # modes: User modes that are set on users in this block on connect.
323 # Enabling this option requires that the conn_umodes module be loaded.
324 # This entry is highly recommended to use for/with IP cloaking/masking.
325 # For the example to work, this also requires that the cloaking
326 # module be loaded as well.
329 # requireident: Require that users of this block have a valid ident response.
330 # Requires the ident module to be loaded.
333 # requiressl: Require that users of this block use a TLS (SSL) connection.
334 # This can also be set to "trusted", as to only accept client certificates
335 # issued by a certificate authority that you can configure in the
336 # settings of the TLS (SSL) module that you're using.
337 # Requires the sslinfo module to be loaded.
340 # requireaccount: Require that users of this block have authenticated to a
342 # NOTE: You must complete the signon prior to full connection. Currently,
343 # this is only possible by using SASL authentication; passforward
344 # and PRIVMSG NickServ happen after your final connect block has been found.
345 # Requires the services_account module to be loaded.
346 #requireaccount="yes"
348 # Alternate MOTD file for this connect class. The contents of this file are
349 # specified using <files secretmotd="filename"> or <execfiles ...>
351 # NOTE: the following escape sequences for IRC formatting characters can be
354 # Color: \c<fg>[,<bg>]
356 # Monospace: \m (not widely supported)
359 # Strikethrough: \s (not widely supported)
361 # See https://defs.ircdocs.horse/info/formatting.html for more information
362 # on client support for formatting characters.
365 # port: What port range this user is allowed to connect on. (optional)
366 # The ports MUST be set to listen in the bind blocks above.
370 # name: Name to use for this connect block. Mainly used for
371 # connect class inheriting.
374 # allow: The IP address or hostname of clients that can use this
375 # class. You can specify either an exact match, a glob match, or
379 # maxchans: Maximum number of channels a user in this class
380 # can be in at one time.
383 # timeout: How long the server will wait before disconnecting
384 # a user if they do not do anything on connect.
385 # (Note, this is a client-side thing, if the client does not
386 # send /NICK, /USER or /PASS)
389 # pingfreq: How often the server tries to ping connecting clients.
392 # hardsendq: maximum amount of data allowed in a client's send queue
393 # before they are dropped. Keep this value higher than the length of
394 # your network's /LIST or /WHO output, or you will have lots of
395 # disconnects from sendq overruns!
396 # Setting this to "1M" is equivalent to "1048576", "8K" is 8192, etc.
399 # softsendq: amount of data in a client's send queue before the server
400 # begins delaying their commands in order to allow the sendq to drain
403 # recvq: amount of data allowed in a client's queue before they are dropped.
404 # Entering "10K" is equivalent to "10240", see above.
407 # threshold: This specifies the amount of command penalty a user is allowed to have
408 # before being quit or fakelagged due to flood. Normal commands have a penalty of 1,
409 # ones such as /OPER have penalties up to 10.
411 # If you are not using fakelag, this should be at least 20 to avoid excess flood kills
412 # from processing some commands.
415 # commandrate: This specifies the maximum rate that commands can be processed.
416 # If commands are sent more rapidly, the user's penalty will increase and they will
417 # either be fakelagged or killed when they reach the threshold
419 # Units are millicommands per second, so 1000 means one line per second.
422 # fakelag: Use fakelag instead of killing users for excessive flood
424 # Fake lag stops command processing for a user when a flood is detected rather than
425 # immediately killing them; their commands are held in the recvq and processed later
426 # as the user's command penalty drops. Note that if this is enabled, flooders will
427 # quit with "RecvQ exceeded" rather than "Excess Flood".
430 # localmax: Maximum local connections per IP.
433 # globalmax: Maximum global (network-wide) connections per IP.
436 # resolvehostnames: If disabled, no DNS lookups will be performed on connecting users
437 # in this class. This can save a lot of resources on very busy servers.
438 resolvehostnames="yes"
440 # useident: Defines if users in this class must respond to a ident query or not.
443 # usests: Whether a STS policy should be advertised to users in this class.
444 # This setting only has effect when the ircv3_sts module is loaded.
447 # limit: How many users are allowed in this class
450 # modes: User modes that are set on users in this block on connect.
451 # Enabling this option requires that the conn_umodes module be loaded.
452 # This entry is highly recommended to use for/with IP cloaking/masking.
453 # For the example to work, this also requires that the cloaking
454 # module be loaded as well.
459 #-#-#-#-#-#-#-#-#-#-#-#- CIDR CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-
461 # CIDR configuration allows detection of clones and applying of #
462 # throttle limits across a CIDR range. (A CIDR range is a group of #
463 # IPs, for example, the CIDR range 192.168.1.0-192.168.1.255 may be #
464 # represented as 192.168.1.0/24). This means that abuse across an ISP #
465 # is detected and curtailed much easier. Here is a good chart that #
466 # shows how many IPs the different CIDRs correspond to: #
467 # https://en.wikipedia.org/wiki/IPv4_subnetting_reference #
468 # https://en.wikipedia.org/wiki/IPv6_subnetting_reference #
472 # ipv4clone: specifies how many bits of an IP address should be
473 # looked at for clones. The default only looks for clones on a
474 # single IP address of a user. You do not want to set this
475 # extremely low. (Values are 0-32).
478 # ipv6clone: specifies how many bits of an IP address should be
479 # looked at for clones. The default only looks for clones on a
480 # single IP address of a user. You do not want to set this
481 # extremely low. (Values are 0-128).
484 # This file has all the information about oper classes, types and o:lines.
485 # You *MUST* edit it.
486 #<include file="examples/opers.conf.example">
488 # This file has all the information about server links and ulined servers.
489 # You *MUST* edit it if you intend to link servers.
490 #<include file="examples/links.conf.example">
492 #-#-#-#-#-#-#-#-#-#- MISCELLANEOUS CONFIGURATION -#-#-#-#-#-#-#-#-#-#
495 # Files block - contains files whose contents are used by the ircd
497 # motd - displayed on connect and when a user executes /MOTD
498 # Modules can also define their own files
499 <files motd="examples/motd.txt.example">
501 # Example of an executable file include. Note this will be read on rehash,
502 # not when the command is run.
503 #<execfiles motd="wget -O - https://www.example.com/motd.txt">
505 #-#-#-#-#-#-#-#-#-#-#-#-#-#-# DNS SERVER -#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
506 # If these values are not defined, InspIRCd uses the default DNS resolver
510 # server: DNS server to use to attempt to resolve IP's to hostnames.
511 # in most cases, you won't need to change this, as inspircd will
512 # automatically detect the nameserver depending on /etc/resolv.conf
513 # (or, on Windows, your set nameservers in the registry.)
514 # Note that this must be an IP address and not a hostname, because
515 # there is no resolver to resolve the name until this is defined!
519 # timeout: time to wait to try to resolve DNS/hostname.
522 # An example of using an IPv6 nameserver
523 #<dns server="::1" timeout="5">
525 #-#-#-#-#-#-#-#-#-#-#-#-#-#-# PID FILE -#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
527 # Define the path to the PID file here. The PID file can be used to #
528 # rehash the ircd from the shell or to terminate the ircd from the #
529 # shell using shell scripts, perl scripts, etc... and to monitor the #
530 # ircd's state via cron jobs. If this is a relative path, it will be #
531 # relative to the configuration directory, and if it is not defined, #
532 # the default of 'inspircd.pid' is used. #
535 #<pid file="/path/to/inspircd.pid">
537 #-#-#-#-#-#-#-#-#-#-#-#-#- LIST MODE LIMITS #-#-#-#-#-#-#-#-#-#-#-#-#-#
539 # The <maxlist> tag is used customise the maximum number of each list #
540 # mode that can be set on a channel. #
541 # The tags are read from top to bottom and the list mode limit from #
542 # the first tag found which matches the channel name and mode type is #
543 # applied to that channel. #
544 # It is advisable to put an entry with the channel as '*' at the #
545 # bottom of the list. If none are specified or no maxlist tag is #
546 # matched, the banlist size defaults to 100 entries. #
549 # Allows #largechan to have up to 200 ban entries.
550 #<maxlist mode="ban" chan="#largechan" limit="200">
552 # Allows #largechan to have up to 200 ban exception entries.
553 #<maxlist mode="e" chan="#largechan" limit="200">
555 # Allows all channels and list modes not previously matched to have
557 <maxlist chan="*" limit="100">
559 #-#-#-#-#-#-#-#-#-#-#-#-#- SERVER OPTIONS -#-#-#-#-#-#-#-#-#-#-#-#-#
561 # Settings to define which features are usable on your server. #
565 # prefixquit: What (if anything) users' quit messages
566 # should be prefixed with.
569 # suffixquit: What (if anything) users' quit messages
570 # should be suffixed with.
573 # prefixpart: What (if anything) users' part messages
574 # should be prefixed with.
576 # NOTE: Use "\"" instead of """ if not using <config format="xml">
578 # suffixpart: What (if anything) users' part message
579 # should be suffixed with.
582 # fixedquit: Set all users' quit messages to this value.
585 # fixedpart: Set all users' part messages in all channels
589 # syntaxhints: If enabled, if a user fails to send the correct parameters
590 # for a command, the ircd will give back some help text of what
591 # the correct parameters are.
594 # casemapping: This sets the case mapping method to be used by the
595 # server. This MUST be the same on all servers. Possible values are:
596 # "ascii" (recommended)
597 # "rfc1459" (default, required for linking to 2.0 servers)
598 # NOTE: if you are using the nationalchars module this setting will be
599 # ignored. You should use <nationalchars:casemapping> instead.
602 # cyclehostsfromuser: If enabled, the source of the mode change for
603 # cyclehosts will be the user who cycled. This can look nicer, but
604 # triggers anti-takeover mechanisms of some obsolete bots.
605 cyclehostsfromuser="no"
607 # announcets: If set to yes, when the timestamp on a channel changes, all users
608 # in the channel will be sent a NOTICE about it.
611 # allowmismatch: Setting this option to yes will allow servers to link even
612 # if they don't have the same "optionally common" modules loaded. Setting this to
613 # yes may introduce some desyncs and unwanted behaviour.
616 # defaultbind: Sets the default for <bind> tags without an address. Choices are
617 # ipv4 or ipv6; if not specified, IPv6 will be used if your system has support,
618 # falling back to IPv4 otherwise.
621 # hostintopic: If enabled, channels will show the host of the topic setter
622 # in the topic. If set to no, it will only show the nick of the topic setter.
625 # pingwarning: If a server does not respond to a ping within this period,
626 # it will send a notice to opers with snomask +l informing that the server
627 # is about to ping timeout.
630 # serverpingfreq: How often pings are sent between servers.
633 # splitwhois: Whether to split private/secret channels from normal channels
634 # in WHOIS responses. Possible values for this are:
635 # 'no' - list all channels together in the WHOIS response regardless of type.
636 # 'split' - split private/secret channels to a separate WHOIS response numeric.
637 # 'splitmsg' - the same as split but also send a message explaining the split.
640 # defaultmodes: What modes are set on a empty channel when a user
641 # joins it and it is unregistered.
644 # xlinemessage: This is the text that is sent to a user when they are
645 # banned from the server.
646 xlinemessage="You're banned! Email irc@example.com with the ERROR line below for help."
648 # allowzerolimit: If enabled then allow a limit of 0 to be set on channels.
649 # This is non-standard behaviour and should only be enabled if you need to
650 # link with servers running 2.0. Defaults to yes.
653 # modesinlist: If enabled then the current channel modes will be shown
654 # in the /LIST response. Defaults to yes.
657 # exemptchanops: Allows users with with a status mode to be exempt
658 # from various channel restrictions. Possible restrictions are:
659 # - anticaps Channel mode +B - blocks messages with too many capital
660 # letters (requires the anticaps module).
661 # - auditorium-see Permission required to see the full user list of
662 # a +u channel (requires the auditorium module).
663 # - auditorium-vis Permission required to be visible in a +u channel
664 # (requires the auditorium module).
665 # - blockcaps Channel mode +B - blocks messages with too many capital
666 # letters (requires the blockcaps module).
667 # - blockcolor Channel mode +c - blocks messages with formatting codes
668 # (requires the blockcolor module).
669 # - censor Channel mode +G - censors messages based on the network
670 # configuration (requires the censor module).
671 # - filter Channel mode +g - blocks messages containing the given
672 # glob mask (requires the chanfilter module).
673 # - flood Channel mode +f - kicks (and bans) on text flood of a
674 # specified rate (requires the messageflood module).
675 # - nickflood Channel mode +F - blocks nick changes after a specified
676 # rate (requires the nickflood module).
677 # - noctcp Channel mode +C - blocks any CTCPs to the channel
678 # (requires the noctcp module).
679 # - nonick Channel mode +N - prevents users on the channel from
680 # changing nicks (requires the nonicks module).
681 # - nonotice Channel mode +T - blocks /NOTICEs to the channel
682 # (requires the nonotice module).
683 # - regmoderated Channel mode +M - blocks unregistered users from
684 # speaking (requires the services account module).
685 # - stripcolor Channel mode +S - strips formatting codes from
686 # messages (requires the stripcolor module).
687 # - topiclock Channel mode +t - limits changing the topic to (half)ops
688 # You can also configure this on a per-channel basis with a channel mode and
689 # even negate the configured exemptions below.
690 # See exemptchanops in modules.conf.example for more details.
691 exemptchanops="censor:o filter:o nickflood:o nonick:v regmoderated:o"
693 # invitebypassmodes: This allows /INVITE to bypass other channel modes.
694 # (Such as +k, +j, +l, etc.)
695 invitebypassmodes="yes"
697 # nosnoticestack: This prevents snotices from 'stacking' and giving you
698 # the message saying '(last message repeated X times)'. Defaults to no.
702 #-#-#-#-#-#-#-#-#-#-#-# PERFORMANCE CONFIGURATION #-#-#-#-#-#-#-#-#-#-#
706 # netbuffersize: Size of the buffer used to receive data from clients.
707 # The ircd may only read this amount of text in 1 go at any time.
708 netbuffersize="10240"
710 # somaxconn: The maximum number of connections that may be waiting
711 # in the accept queue. This is *NOT* the total maximum number of
712 # connections per server. Some systems may only allow this to be up
713 # to 5, while others (such as Linux and *BSD) default to 128.
714 # Setting this above the limit imposed by your OS can have undesired
718 # softlimit: This optional feature allows a defined softlimit for
719 # connections. If defined, it sets a soft max connections value.
722 # clonesonconnect: If this is set to no, we won't check for clones
723 # on initial connection, but only after the DNS check is done.
724 # This can be useful where your main class is more restrictive
725 # than some other class a user can be assigned after DNS lookup is complete.
726 # Turning this option off will make the server spend more time on users we may
727 # potentially not want. Normally this should be negligible, though.
728 # Default value is yes
729 clonesonconnect="yes"
731 # timeskipwarn: The time period that a server clock can jump by before
732 # operators will be warned that the server is having performance issues.
735 # quietbursts: When syncing or splitting from a network, a server
736 # can generate a lot of connect and quit messages to opers with
737 # +C and +Q snomasks. Setting this to yes squelches those messages,
738 # which makes it easier for opers, but degrades the functionality of
739 # bots like BOPM during netsplits.
742 #-#-#-#-#-#-#-#-#-#-#-# SECURITY CONFIGURATION #-#-#-#-#-#-#-#-#-#-#-#
746 # allowcoreunload: If this value is set to yes, Opers will be able to
747 # unload core modules (e.g. core_privmsg).
750 # announceinvites: This option controls which members of the channel
751 # receive an announcement when someone is INVITEd. Available values:
752 # 'none' - don't send invite announcements
753 # 'all' - send invite announcements to all members
754 # 'ops' - send invite announcements to ops and higher ranked users
755 # 'dynamic' - send invite announcements to halfops (if available) and
756 # higher ranked users. This is the recommended setting.
757 announceinvites="dynamic"
759 # hideulines: If this value is set to yes, U-lined servers will
760 # be hidden from non-opers in /LINKS and /MAP.
763 # flatlinks: If this value is set to yes, /MAP and /LINKS will
764 # be flattened when shown to non-opers.
767 # hideserver: When defined, the given text will be used in place
768 # of the server name in public messages. As with <server:name> this
769 # does not need to resolve but does need to be a valid hostname.
771 # NOTE: enabling this will cause users' idle times to only be shown
772 # when a remote whois (/WHOIS <nick> <nick>) is used.
773 #hideserver="*.example.com"
775 # hidebans: If this value is set to yes, when a user is banned ([KGZ]-lined)
776 # only opers will see the ban message when the user is removed
780 # hidekills: If defined, replaces who executed a /KILL with a custom string.
783 # hideulinekills: Hide kills from clients of ulined servers from server notices.
786 # hidesplits: If enabled, non-opers will not be able to see which
787 # servers split in a netsplit, they will only be able to see that one
788 # occurred (If their client has netsplit detection).
791 # maxtargets: Maximum number of targets per command.
792 # (Commands like /NOTICE, /PRIVMSG, /KICK, etc)
795 # customversion: A custom message to be displayed in the comments field
796 # of the VERSION command response. This does not hide the InspIRCd version.
799 # runasuser: If this is set, InspIRCd will attempt to switch
800 # to run as this user, which allows binding of ports under 1024.
801 # You should NOT set this unless you are starting as root.
802 # NOT SUPPORTED/NEEDED UNDER WINDOWS.
805 # runasgroup: If this is set, InspIRCd will attempt to switch
806 # to run as this group, which allows binding of ports under 1024.
807 # You should NOT set this unless you are starting as root.
808 # NOT SUPPORTED/NEEDED UNDER WINDOWS.
811 # restrictbannedusers: If this is set to yes, InspIRCd will not allow users
812 # banned on a channel to change nickname or message channels they are
813 # banned on. This can also be set to silent to restrict the user but not
815 restrictbannedusers="yes"
817 # genericoper: Setting this value to yes makes all opers on this server
818 # appear as 'is a server operator' in their WHOIS, regardless of their
819 # oper type, however oper types are still used internally. This only
820 # affects the display in WHOIS.
823 # userstats: /STATS commands that users can run (opers can run all).
826 #-#-#-#-#-#-#-#-#-#-#-#-# LIMITS CONFIGURATION #-#-#-#-#-#-#-#-#-#-#-#
828 # This configuration tag defines the maximum sizes of various types #
829 # on IRC, such as the maximum length of a channel name, and the #
830 # maximum length of a channel. These values should match network-wide #
831 # otherwise issues will occur. #
833 # The highest safe value you can set any of these options to is 500, #
834 # but it is recommended that you keep them somewhat #
835 # near their defaults (or lower). #
838 # maxnick: Maximum length of a nickname.
841 # maxchan: Maximum length of a channel name.
844 # maxmodes: Maximum number of mode changes per line.
847 # maxident: Maximum length of a ident/username.
850 # maxhost: Maximum length of a hostname.
853 # maxquit: Maximum length of a quit message.
856 # maxtopic: Maximum length of a channel topic.
859 # maxkick: Maximum length of a kick message.
862 # maxreal: Maximum length of a real name.
865 # maxaway: Maximum length of an away message.
868 #-#-#-#-#-#-#-#-#-#-#-#-# PATHS CONFIGURATION #-#-#-#-#-#-#-#-#-#-#-#-#
870 # This configuration tag defines the location that InspIRCd stores #
871 # various types of files such as configuration files, log files and #
872 # modules. You will probably not need to change these from the values #
873 # set when InspIRCd was built unless you are using a binary package #
874 # where you do not have the ability to set build time configuration. #
875 #<path configdir="conf" datadir="data" logdir="logs" moduledir="modules">
877 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
881 # Logging is covered with the <log> tag, which you may use to change
882 # the behaviour of the logging of the IRCd.
884 # An example log tag would be:
885 # <log method="file" type="OPER" level="default" target="opers.log">
886 # which would log all information on /OPER (failed and successful) to
887 # a file called opers.log.
889 # There are many different types which may be used, and modules may
890 # generate their own. A list of useful types:
891 # - USERS - information relating to user connection and disconnection
892 # - OPER - successful and failed oper attempts
893 # - KILL - kill related messages
894 # - FILTER - messages related to filter matches (filter module)
895 # - CONFIG - configuration related messages
896 # - COMMAND - die and restart messages, and messages related to unknown user types
897 # - SOCKET - socket engine informational/error messages
898 # - MODULE - module related messages
899 # - STARTUP - messages related to starting up the server
901 # You may also log *everything* by using a type of *, and subtract things out
902 # of that by using -TYPE - for example "* -USERINPUT -USEROUTPUT".
905 # - default (general messages, including errors)
906 # - sparse (misc error messages)
907 # - debug (debug messages)
909 # Some types only produce output in the debug level, those are:
910 # - BANCACHE - ban cache debug messages
911 # - CHANNELS - information relating to joining/creating channels
912 # - CULLLIST - debug messages related to issues with removing users
913 # - RESOLVER - DNS related debug messages
914 # - CONNECTCLASS - Connection class debug messages
918 # If your server is producing a high levels of log messages you can also set the
919 # flush="[positive number]" attribute to specify how many log messages should be
920 # buffered before flushing to disk. You should probably not specify this unless
921 # you are having problems.
923 # The following log tag is highly default and uncustomised. It is recommended you
924 # sort out your own log tags. This is just here so you get some output.
926 <log method="file" type="* -USERINPUT -USEROUTPUT" level="default" target="ircd.log">
928 #-#-#-#-#-#-#-#-#-#-#-#-#- WHOWAS OPTIONS -#-#-#-#-#-#-#-#-#-#-#-#-#
930 # This tag lets you define the behaviour of the /WHOWAS command of #
935 # groupsize: Maximum entries per nick shown when performing
939 # maxgroups: Maximum number of nickgroups that can be added to
940 # the list so that /WHOWAS does not use a lot of resources on
944 # maxkeep: Maximum time a nick is kept in the whowas list
945 # before being pruned. Time may be specified in seconds,
946 # or in the following format: 1y2w3d4h5m6s. Minimum is
950 #-#-#-#-#-#-#-#-#-#-#-#-#-#- BAN OPTIONS -#-#-#-#-#-#-#-#-#-#-#-#-#-#
952 # The ban tags define nick masks, host masks and ip ranges which are #
953 # banned from your server. All details in these tags are local to #
958 # ipmask: IP range to ban. Wildcards and CIDR can be used.
961 # reason: Reason to display when user is disconnected.
962 reason="No porn here thanks.">
965 # nick: Nick to disallow. Wildcards are supported.
968 # reason: Reason to display on /NICK.
969 reason="Don't use this nick.">
972 # host: ident@hostname to ban.
973 # Wildcards and CIDR (if you specify an IP) can be used.
974 host="*@banneduser.example.net"
976 # reason: Reason to display when user is disconnected
977 reason="Evading Bans">
979 <badhost host="root@*" reason="Don't IRC as root!">
980 <badhost host="*@198.51.100.0/24" reason="This subnet is bad.">
982 # exception: Hosts that are exempt from [KGZ]-lines.
984 # host: ident@hostname to exempt.
985 # Wildcards and CIDR (if you specify an IP) can be used.
986 host="*@serverop.example.com"
988 # reason: Reason for exception. Only shown in /STATS e.
989 reason="Oper's hostname">
991 #-#-#-#-#-#-#-#-#-#-#- INSANE BAN OPTIONS -#-#-#-#-#-#-#-#-#-#-#-#-#-#
993 # This optional tag allows you to specify how wide a G-line, E-line, #
994 # K-line, Z-line or Q-line can be before it is forbidden from being #
995 # set. By setting hostmasks="yes", you can allow all G-, K-, E-lines, #
996 # no matter how many users the ban would cover. This is not #
997 # recommended! By setting ipmasks="yes", you can allow all Z-lines, #
998 # no matter how many users these cover too. Needless to say we #
999 # don't recommend you do this, or, set nickmasks="yes", which will #
1000 # allow any Q-line. #
1004 # hostmasks: Allow bans with insane hostmasks. (over-reaching bans)
1007 # ipmasks: Allow bans with insane ipmasks. (over-reaching bans)
1010 # nickmasks: Allow bans with insane nickmasks. (over-reaching bans)
1013 # trigger: What percentage of users on the network to trigger
1014 # specifying an insane ban as. The default is 95.5%, which means
1015 # if you have a 1000 user network, a ban will not be allowed if it
1016 # will be banning 955 or more users.
1019 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# MODULES #-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1020 # ____ _ _____ _ _ ____ _ _ _ #
1021 # | _ \ ___ __ _ __| | |_ _| |__ (_)___ | __ )(_) |_| | #
1022 # | |_) / _ \/ _` |/ _` | | | | '_ \| / __| | _ \| | __| | #
1023 # | _ < __/ (_| | (_| | | | | | | | \__ \ | |_) | | |_|_| #
1024 # |_| \_\___|\__,_|\__,_| |_| |_| |_|_|___/ |____/|_|\__(_) #
1026 # Well done, you've reached the end of the basic configuration, your #
1027 # ircd should now start if you want to try it out! (./inspircd start) #
1029 # We now suggest you read and edit modules.conf, as modules are what #
1030 # provide almost all the features of InspIRCd. :) #
1032 # The default does nothing -- we include it for simplicity for you. #
1033 #<include file="examples/modules.conf.example">
1035 #-#-#-#-#-#-#-#-#-#-#-# SERVICES CONFIGURATION #-#-#-#-#-#-#-#-#-#-#-#
1037 # If you use services you will probably want to include one of the #
1038 # following files which set up aliases, nick reservations and filter #
1039 # exemptions for services pseudoclients: #
1041 # Anope users should uncomment this:
1042 #<include file="examples/services/anope.conf.example">
1044 # Atheme users should uncomment this:
1045 #<include file="examples/services/atheme.conf.example">
1047 # Users of other services should uncomment this:
1048 #<include file="examples/services/generic.conf.example">
1050 #########################################################################
1052 # - InspIRCd Development Team - #
1053 # https://www.inspircd.org #
1055 #########################################################################