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 directory that the #
56 # You may also include an executable file, in which case if you do so #
57 # the output of the executable on the standard output will be added #
58 # to your config at the point of the include tag. #
60 # Syntax is as follows: #
61 #<include file="file.conf"> #
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 # Enter the port and address bindings here. #
127 # ____ _ _____ _ _ ____ _ _ _ #
128 # | _ \ ___ __ _ __| | |_ _| |__ (_)___ | __ )(_) |_| | #
129 # | |_) / _ \/ _` |/ _` | | | | '_ \| / __| | _ \| | __| | #
130 # | _ < __/ (_| | (_| | | | | | | | \__ \ | |_) | | |_|_| #
131 # |_| \_\___|\__,_|\__,_| |_| |_| |_|_|___/ |____/|_|\__(_) #
133 # If you want to link servers to InspIRCd you must load the #
134 # spanningtree module! Please see the modules list for #
135 # information on how to load this module! If you do not load this #
136 # module, server ports will NOT work! #
139 # address: IP address to bind to if the box that you are hosting
140 # on has more than one IP, else the ircd will try to bind to all
141 # IP's on the box if this is not defined.
144 # port: Port for users or servers to be able to connect to.
145 # you can select multiple ports by separating them
146 # with a - character like the example below.
149 # type: Type of bind block this is. It can either be clients or
150 # servers. Whichever you select will be the only type able to connect
151 # to this bind section.
154 # ssl: If you want the port(s) in this bind tag to use SSL, set this to
155 # the name of a custom <sslprofile> tag that you have defined or one
156 # of "openssl", "gnutls", "mbedtls" if you have not defined any. See the
157 # wiki page for the SSL module you are using for more details.
159 # You will need to load the ssl_openssl module for OpenSSL, ssl_gnutls
160 # for GnuTLS and ssl_mbedtls for mbedTLS.
163 # defer: When this is non-zero, connections will not be handed over to
164 # the daemon from the operating system before data is ready.
165 # In Linux, the value indicates the time period we'll wait for a
166 # connection to come up with data. Don't set it too low!
167 # In BSD the value is ignored; only zero and non-zero is possible.
168 # Windows ignores this parameter completely.
169 # Note: This does not take effect on rehash.
170 # To change it on a running bind, you'll have to comment it out,
171 # rehash, comment it in and rehash again.
174 # free: When this is enabled the listener will be created regardless of
175 # whether the interface that provides the bind address is available. This
176 # is useful for if you are starting InspIRCd on boot when the server may
177 # not have brought the network interfaces up yet.
181 <bind address="" port="6660-6669" type="clients">
183 # Listener accepting HTML5 WebSocket connections.
184 # Requires the websocket module and SHA-1 hashing support (provided by the sha1
186 #<bind address="" port="7002" type="clients" hook="websocket">
188 # EXPERIMENTAL: Listener that binds on a UNIX endpoint instead of a TCP/IP endpoint:
189 #<bind path="/tmp/inspircd.sock" type="clients">
191 # You can define a custom <sslprofile> tag which defines the SSL configuration
192 # for this listener. See the wiki page for the SSL module you are using for
195 # Alternatively, you can use one of the default SSL profiles which are created
196 # when you have not defined any:
197 # "openssl" (requires the ssl_openssl module)
198 # "gnutls" (requires the ssl_gnutls module)
199 # "mbedtls" (requires the ssl_mbedtls module)
201 # When linking servers, the OpenSSL, GnuTLS, and mbedTLS implementations are
202 # completely link-compatible and can be used alongside each other on each end
203 # of the link without any significant issues.
205 <bind address="" port="7000,7001" type="servers">
206 <bind address="1.2.3.4" port="7005" type="servers" ssl="openssl">
209 #-#-#-#-#-#-#-#-#-#- CONNECTIONS CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
211 # This is where you can configure which connections are allowed #
212 # and denied access onto your server. The password is optional. #
213 # You may have as many of these as you require. To allow/deny all #
214 # connections, use a '*' or 0.0.0.0/0. #
216 # -- It is important to note that connect tags are read from the -- #
217 # TOP DOWN. This means that you should have more specific deny #
218 # and allow tags at the top, progressively more general, followed #
219 # by a <connect allow="*" (should you wish to have one). #
221 # Connect blocks are searched twice for each user - once when the TCP #
222 # connection is accepted, and once when the user completes their #
223 # registration. Most of the information (hostname, ident response, #
224 # password, SSL when using STARTTLS, etc) is only available during #
225 # the second search, so if you are trying to make a closed server, #
226 # you will probably need a connect block just for user registration. #
227 # This can be done by using <connect registered="no"> #
230 # deny: Will not let people connect if they have specified host/IP.
233 # connect:reason is the message that users will see if they match a deny block
234 <connect deny="3ffe::0/32" reason="The 6bone address space is deprecated">
237 # name: Name to use for this connect block. Mainly used for
238 # connect class inheriting.
241 # parent: This setting is to specify if this connect class
242 # inherits settings from any other. Put the other class's name
243 # in here to use its settings as a template - for example, if
244 # you only want to adjust sendq and a password
247 # allow: The IP address or hostname of clients that can use this
248 # class. You can specify either an exact match, a glob match, or
252 # hash: the hash function this password is hashed with. Requires the
253 # module for the selected function (bcrypt, md5, sha1, or sha256) and
254 # the password hashing module (password_hash) to be loaded.
256 # You may also use any of the above other than bcrypt prefixed with
257 # either "hmac-" or "pbkdf2-hmac-" (requires the pbkdf2 module).
258 # Create hashed passwords with: /mkpasswd <hash> <password>
261 # password: Password to use for this block/user(s)
264 # maxchans: Maximum number of channels a user in this class
268 # timeout: How long the server will wait before disconnecting
269 # a user if they do not do anything on connect.
270 # (Note, this is a client-side thing, if the client does not
271 # send /nick, /user or /pass)
274 # localmax: Maximum local connections per IP (or CIDR mask, see below).
277 # globalmax: Maximum global (network-wide) connections per IP (or CIDR mask, see below).
280 # maxconnwarn: Enable warnings when localmax or globalmax are reached (defaults to on)
283 # resolvehostnames: If disabled, no DNS lookups will be performed on connecting users
284 # in this class. This can save a lot of resources on very busy servers.
285 resolvehostnames="yes"
287 # usednsbl: Defines whether or not users in this class are subject to DNSBL. Default is yes.
288 # This setting only has effect when the dnsbl module is loaded.
291 # useident: Defines if users in this class MUST respond to a ident query or not.
294 # webirc: Restricts usage of this class to the specified WebIRC gateway.
295 # This setting only has effect when the cgiirc module is loaded.
298 # limit: How many users are allowed in this class
301 # modes: Usermodes that are set on users in this block on connect.
302 # Enabling this option requires that the conn_umodes module be loaded.
303 # This entry is highly recommended to use for/with IP Cloaking/masking.
304 # For the example to work, this also requires that the "cloaking"
305 # module be loaded as well.
308 # requireident, requiressl, requireaccount: require that users of this
309 # block have a valid ident response, use SSL, or have authenticated.
310 # Requires ident, sslinfo, or the services_account module, respectively.
312 # NOTE: For requireaccount, you must complete the signon prior to full
313 # connection. Currently, this is only possible by using SASL
314 # authentication; passforward and PRIVMSG NickServ happen after
315 # your final connect block has been found.
317 # Alternate MOTD file for this connect class. The contents of this file are
318 # specified using <files secretmotd="filename"> or <execfiles ...>
320 # NOTE: the following escape sequences for IRC formatting characters can be
323 # Color: \c<fg>[,<bg>]
325 # Monospace: \m (not widely supported)
328 # Strikethrough: \s (not widely supported)
330 # See https://defs.ircdocs.horse/info/formatting.html for more information
331 # on client support for formatting characters.
334 # port: What port range this user is allowed to connect on. (optional)
335 # The ports MUST be set to listen in the bind blocks above.
339 # name: Name to use for this connect block. Mainly used for
340 # connect class inheriting.
343 # allow: The IP address or hostname of clients that can use this
344 # class. You can specify either an exact match, a glob match, or
348 # maxchans: Maximum number of channels a user in this class
352 # timeout: How long the server will wait before disconnecting
353 # a user if they do not do anything on connect.
354 # (Note, this is a client-side thing, if the client does not
355 # send /nick, /user or /pass)
358 # pingfreq: How often the server tries to ping connecting clients.
361 # hardsendq: maximum amount of data allowed in a client's send queue
362 # before they are dropped. Keep this value higher than the length of
363 # your network's /LIST or /WHO output, or you will have lots of
364 # disconnects from sendq overruns!
365 # Setting this to "1M" is equivalent to "1048576", "8K" is 8192, etc.
368 # softsendq: amount of data in a client's send queue before the server
369 # begins delaying their commands in order to allow the sendq to drain
372 # recvq: amount of data allowed in a client's queue before they are dropped.
373 # Entering "8K" is equivalent to "8192", see above.
376 # threshold: This specifies the amount of command penalty a user is allowed to have
377 # before being quit or fakelagged due to flood. Normal commands have a penalty of 1,
378 # ones such as /OPER have penalties up to 10.
380 # If you are not using fakelag, this should be at least 20 to avoid excess flood kills
381 # from processing some commands.
384 # commandrate: This specifies the maximum rate that commands can be processed.
385 # If commands are sent more rapidly, the user's penalty will increase and they will
386 # either be fakelagged or killed when they reach the threshold
388 # Units are millicommands per second, so 1000 means one line per second.
391 # fakelag: Use fakelag instead of killing users for excessive flood
393 # Fake lag stops command processing for a user when a flood is detected rather than
394 # immediately killing them; their commands are held in the recvq and processed later
395 # as the user's command penalty drops. Note that if this is enabled, flooders will
396 # quit with "RecvQ exceeded" rather than "Excess Flood".
399 # localmax: Maximum local connections per IP.
402 # globalmax: Maximum global (network-wide) connections per IP.
405 # resolvehostnames: If disabled, no DNS lookups will be performed on connecting users
406 # in this class. This can save a lot of resources on very busy servers.
407 resolvehostnames="yes"
409 # useident: Defines if users in this class must respond to a ident query or not.
412 # limit: How many users are allowed in this class
415 # modes: Usermodes that are set on users in this block on connect.
416 # Enabling this option requires that the conn_umodes module be loaded.
417 # This entry is highly recommended to use for/with IP Cloaking/masking.
418 # For the example to work, this also requires that the cloaking
419 # module be loaded as well.
423 #-#-#-#-#-#-#-#-#-#-#-#- CIDR CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-
425 # CIDR configuration allows detection of clones and applying of #
426 # throttle limits across a CIDR range. (A CIDR range is a group of #
427 # IPs, for example, the CIDR range 192.168.1.0-192.168.1.255 may be #
428 # represented as 192.168.1.0/24). This means that abuse across an ISP #
429 # is detected and curtailed much easier. Here is a good chart that #
430 # shows how many IPs the different CIDRs correspond to: #
431 # https://en.wikipedia.org/wiki/IPv4_subnetting_reference #
432 # https://en.wikipedia.org/wiki/IPv6_subnetting_reference #
436 # ipv4clone: specifies how many bits of an IP address should be
437 # looked at for clones. The default only looks for clones on a
438 # single IP address of a user. You do not want to set this
439 # extremely low. (Values are 0-32).
442 # ipv6clone: specifies how many bits of an IP address should be
443 # looked at for clones. The default only looks for clones on a
444 # single IP address of a user. You do not want to set this
445 # extremely low. (Values are 0-128).
448 # This file has all the information about oper classes, types and o:lines.
449 # You *MUST* edit it.
450 <include file="examples/opers.conf.example">
452 # This file has all the information about server links and ulined servers.
453 # You *MUST* edit it if you intend to link servers.
454 <include file="examples/links.conf.example">
456 #-#-#-#-#-#-#-#-#-#- MISCELLANEOUS CONFIGURATION -#-#-#-#-#-#-#-#-#-#
459 # Files block - contains files whose contents are used by the ircd
461 # motd - displayed on connect and when a user executes /MOTD
462 # Modules can also define their own files
463 <files motd="examples/motd.txt.example">
465 # Example of an executable file include. Note this will be read on rehash,
466 # not when the command is run.
467 #<execfiles motd="wget -O - https://www.example.com/motd.txt">
469 #-#-#-#-#-#-#-#-#-#-#-#-#-#-# DNS SERVER -#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
470 # If these values are not defined, InspIRCd uses the default DNS resolver
474 # server: DNS server to use to attempt to resolve IP's to hostnames.
475 # in most cases, you won't need to change this, as inspircd will
476 # automatically detect the nameserver depending on /etc/resolv.conf
477 # (or, on Windows, your set nameservers in the registry.)
478 # Note that this must be an IP address and not a hostname, because
479 # there is no resolver to resolve the name until this is defined!
483 # timeout: time to wait to try to resolve DNS/hostname.
486 # An example of using an IPv6 nameserver
487 #<dns server="::1" timeout="5">
489 #-#-#-#-#-#-#-#-#-#-#-#-#-#-# PID FILE -#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
491 # Define the path to the PID file here. The PID file can be used to #
492 # rehash the ircd from the shell or to terminate the ircd from the #
493 # shell using shell scripts, perl scripts, etc... and to monitor the #
494 # ircd's state via cron jobs. If this is a relative path, it will be #
495 # relative to the configuration directory, and if it is not defined, #
496 # the default of 'inspircd.pid' is used. #
499 #<pid file="/path/to/inspircd.pid">
501 #-#-#-#-#-#-#-#-#-#-#-#-#- BANLIST LIMITS #-#-#-#-#-#-#-#-#-#-#-#-#-#-#
503 # Use these tags to customise the ban limits on a per channel basis. #
504 # The tags are read from top to bottom, and any tag found which #
505 # matches the channels name applies the banlimit to that channel. #
506 # It is advisable to put an entry with the channel as '*' at the #
507 # bottom of the list. If none are specified or no maxbans tag is #
508 # matched, the banlist size defaults to 100 entries. #
511 <banlist chan="#largechan" limit="200">
512 <banlist chan="*" limit="100">
514 #-#-#-#-#-#-#-#-#-#-#- DISABLED FEATURES -#-#-#-#-#-#-#-#-#-#-#-#-#-#
516 # This tag is optional, and specifies one or more features which are #
517 # not available to non-operators. #
519 # For example you may wish to disable NICK and prevent non-opers from #
520 # changing their nicknames. #
521 # Note that any disabled commands take effect only after the user has #
522 # 'registered' (e.g. after the initial USER/NICK/PASS on connection) #
523 # so for example disabling NICK will not cripple your network. #
525 # You can also define if you want to disable any channelmodes #
526 # or usermodes from your users. #
528 # `fakenonexistant' will make the ircd pretend that nonexistant #
529 # commands simply don't exist to non-opers ("no such command"). #
531 #<disabled commands="TOPIC MODE" usermodes="" chanmodes="" fakenonexistant="yes">
533 #-#-#-#-#-#-#-#-#-#-#-#-#- SERVER OPTIONS -#-#-#-#-#-#-#-#-#-#-#-#-#
535 # Settings to define which features are usable on your server. #
539 # prefixquit: What (if anything) users' quit messages
540 # should be prefixed with.
543 # suffixquit: What (if anything) users' quit messages
544 # should be suffixed with.
547 # prefixpart: What (if anything) users' part messages
548 # should be prefixed with.
550 # NOTE: Use "\"" instead of """ if not using <config format="xml">
552 # suffixpart: What (if anything) users' part message
553 # should be suffixed with.
556 # fixedquit: Set all users' quit messages to this value.
559 # fixedpart: Set all users' part messages in all channels
563 # syntaxhints: If enabled, if a user fails to send the correct parameters
564 # for a command, the ircd will give back some help text of what
565 # the correct parameters are.
568 # casemapping: This sets the case mapping method to be used by the
569 # server. This MUST be the same on all servers. Possible values are:
570 # "ascii" (recommended)
571 # "rfc1459" (default, required for linking to 2.0 servers)
572 # NOTE: if you are using the nationalchars module this setting will be
573 # ignored. You should use <nationalchars:casemapping> instead.
576 # cyclehostsfromuser: If enabled, the source of the mode change for
577 # cyclehosts will be the user who cycled. This can look nicer, but
578 # triggers anti-takeover mechanisms of some obsolete bots.
579 cyclehostsfromuser="no"
581 # announcets: If set to yes, when the timestamp on a channel changes, all users
582 # in the channel will be sent a NOTICE about it.
585 # allowmismatch: Setting this option to yes will allow servers to link even
586 # if they don't have the same "optionally common" modules loaded. Setting this to
587 # yes may introduce some desyncs and unwanted behaviour.
590 # defaultbind: Sets the default for <bind> tags without an address. Choices are
591 # ipv4 or ipv6; if not specified, IPv6 will be used if your system has support,
592 # falling back to IPv4 otherwise.
595 # hostintopic: If enabled, channels will show the host of the topic setter
596 # in the topic. If set to no, it will only show the nick of the topic setter.
599 # pingwarning: If a server does not respond to a ping within this period,
600 # it will send a notice to opers with snomask +l informing that the server
601 # is about to ping timeout.
604 # serverpingfreq: How often pings are sent between servers.
607 # splitwhois: Whether to split private/secret channels from normal channels
608 # in WHOIS responses. Possible values for this are:
609 # 'no' - list all channels together in the WHOIS response regardless of type.
610 # 'split' - split private/secret channels to a separate WHOIS response numeric.
611 # 'splitmsg' - the same as split but also send a message explaining the split.
614 # defaultmodes: What modes are set on a empty channel when a user
615 # joins it and it is unregistered.
618 # xlinemessage: This is the text that is sent to a user when they are
619 # banned from the server.
620 xlinemessage="You're banned! Email irc@example.com with the ERROR line below for help."
622 # allowzerolimit: If enabled then allow a limit of 0 to be set on channels.
623 # This is non-standard behaviour and should only be enabled if you need to
624 # link with servers running 2.0. Defaults to yes.
627 # exemptchanops: Allows users with with a status mode to be exempt
628 # from various channel restrictions. Possible restrictions are:
629 # - auditorium-see Permission required to see the full user list of
630 # a +u channel (requires the auditorium module).
631 # - auditorium-vis Permission required to be visible in a +u channel
632 # (requires the auditorium module).
633 # - blockcaps Channel mode +B - blocks messages with too many capital
634 # letters (requires the blockcaps module).
635 # - blockcolor Channel mode +c - blocks messages with formatting codes
636 # (requires the blockcolor module).
637 # - censor Channel mode +G - censors messages based on the network
638 # configuration (requires the censor module).
639 # - filter Channel mode +g - blocks messages containing the given
640 # glob mask (requires the chanfilter module).
641 # - flood Channel mode +f - kicks (and bans) on text flood of a
642 # specified rate (requires the messageflood module).
643 # - nickflood Channel mode +F - blocks nick changes after a specified
644 # rate (requires the nickflood module).
645 # - noctcp Channel mode +C - blocks any CTCPs to the channel
646 # (requires the noctcp module).
647 # - nonick Channel mode +N - prevents users on the channel from
648 # changing nicks (requires the nonicks module).
649 # - nonotice Channel mode +T - blocks /NOTICEs to the channel
650 # (requires the nonotice module).
651 # - regmoderated Channel mode +M - blocks unregistered users from
652 # speaking (requires the services account module).
653 # - stripcolor Channel mode +S - strips formatting codes from
654 # messages (requires the stripcolor module).
655 # - topiclock Channel mode +t - limits changing the topic to (half)ops
656 # You can also configure this on a per-channel basis with a channel mode.
657 # See m_exemptchanops in modules.conf.example for more details.
658 exemptchanops="censor:o filter:o nickflood:o nonick:v regmoderated:o"
660 # invitebypassmodes: This allows /invite to bypass other channel modes.
661 # (Such as +k, +j, +l, etc.)
662 invitebypassmodes="yes"
664 # nosnoticestack: This prevents snotices from 'stacking' and giving you
665 # the message saying '(last message repeated X times)'. Defaults to no.
669 #-#-#-#-#-#-#-#-#-#-#-# PERFORMANCE CONFIGURATION #-#-#-#-#-#-#-#-#-#-#
673 # netbuffersize: Size of the buffer used to receive data from clients.
674 # The ircd may only read this amount of text in 1 go at any time.
675 netbuffersize="10240"
677 # somaxconn: The maximum number of connections that may be waiting
678 # in the accept queue. This is *NOT* the total maximum number of
679 # connections per server. Some systems may only allow this to be up
680 # to 5, while others (such as Linux and *BSD) default to 128.
681 # Setting this above the limit imposed by your OS can have undesired
685 # softlimit: This optional feature allows a defined softlimit for
686 # connections. If defined, it sets a soft max connections value.
689 # clonesonconnect: If this is set to false, we won't check for clones
690 # on initial connection, but only after the DNS check is done.
691 # This can be useful where your main class is more restrictive
692 # than some other class a user can be assigned after DNS lookup is complete.
693 # Turning this option off will make the server spend more time on users we may
694 # potentially not want. Normally this should be neglible, though.
695 # Default value is true
696 clonesonconnect="true"
698 # timeskipwarn: The time period that a server clock can jump by before
699 # operators will be warned that the server is having performance issues.
702 # quietbursts: When syncing or splitting from a network, a server
703 # can generate a lot of connect and quit messages to opers with
704 # +C and +Q snomasks. Setting this to yes squelches those messages,
705 # which makes it easier for opers, but degrades the functionality of
706 # bots like BOPM during netsplits.
709 #-#-#-#-#-#-#-#-#-#-#-# SECURITY CONFIGURATION #-#-#-#-#-#-#-#-#-#-#-#
713 # allowcoreunload: If this value is set to yes, Opers will be able to
714 # unload core modules (e.g. core_privmsg).
717 # announceinvites: This option controls which members of the channel
718 # receive an announcement when someone is INVITEd. Available values:
719 # 'none' - don't send invite announcements
720 # 'all' - send invite announcements to all members
721 # 'ops' - send invite announcements to ops and higher ranked users
722 # 'dynamic' - send invite announcements to halfops (if available) and
723 # higher ranked users. This is the recommended setting.
724 announceinvites="dynamic"
726 # hideulines: If this value is set to yes, U-lined servers will
727 # be hidden from non-opers in /links and /map.
730 # flatlinks: If this value is set to yes, /map and /links will
731 # be flattened when shown to non-opers.
734 # hideserver: When defined, the given text will be used in place
735 # of the server name in public messages. As with <server:name> this
736 # does not need to resolve but does need to be a valid hostname.
738 # NOTE: enabling this will cause users' idle times to only be shown
739 # when a remote whois (/WHOIS <nick> <nick>) is used.
740 #hideserver="*.example.com"
742 # hidebans: If this value is set to yes, when a user is banned ([gkz]lined)
743 # only opers will see the ban message when the user is removed
747 # hidekills: If defined, replaces who set a /kill with a custom string.
750 # hideulinekills: Hide kills from clients of ulined servers from server notices.
753 # hidesplits: If enabled, non-opers will not be able to see which
754 # servers split in a netsplit, they will only be able to see that one
755 # occurred (If their client has netsplit detection).
758 # maxtargets: Maximum number of targets per command.
759 # (Commands like /notice, /privmsg, /kick, etc)
762 # customversion: A custom message to be displayed in the comments field
763 # of the VERSION command response. This does not hide the InspIRCd version.
766 # runasuser: If this is set, InspIRCd will attempt to switch
767 # to run as this user, which allows binding of ports under 1024.
768 # You should NOT set this unless you are starting as root.
769 # NOT SUPPORTED/NEEDED UNDER WINDOWS.
772 # runasgroup: If this is set, InspIRCd will attempt to switch
773 # to run as this group, which allows binding of ports under 1024.
774 # You should NOT set this unless you are starting as root.
775 # NOT SUPPORTED/NEEDED UNDER WINDOWS.
778 # restrictbannedusers: If this is set to yes, InspIRCd will not allow users
779 # banned on a channel to change nickname or message channels they are
780 # banned on. This can also be set to silent to restrict the user but not
782 restrictbannedusers="yes"
784 # genericoper: Setting this value to yes makes all opers on this server
785 # appear as 'is an IRC operator' in their WHOIS, regardless of their
786 # oper type, however oper types are still used internally. This only
787 # affects the display in WHOIS.
790 # userstats: /stats commands that users can run (opers can run all).
793 #-#-#-#-#-#-#-#-#-#-#-#-# LIMITS CONFIGURATION #-#-#-#-#-#-#-#-#-#-#-#
795 # This configuration tag defines the maximum sizes of various types #
796 # on IRC, such as the maximum length of a channel name, and the #
797 # maximum length of a channel. Note that with the exception of the #
798 # identmax value all values given here are the exact values you would #
799 # expect to see on IRC. This contrasts with the older InspIRCd #
800 # releases where these values would be one character shorter than #
801 # defined to account for a null terminator on the end of the text. #
803 # These values should match network-wide otherwise issues will occur. #
805 # The highest safe value you can set any of these options to is 500, #
806 # but it is recommended that you keep them somewhat #
807 # near their defaults (or lower). #
810 # maxnick: Maximum length of a nickname.
813 # maxchan: Maximum length of a channel name.
816 # maxmodes: Maximum number of mode changes per line.
819 # maxident: Maximum length of a ident/username.
822 # maxhost: Maximum length of a hostname.
825 # maxquit: Maximum length of a quit message.
828 # maxtopic: Maximum length of a channel topic.
831 # maxkick: Maximum length of a kick message.
834 # maxreal: Maximum length of a real name.
837 # maxaway: Maximum length of an away message.
840 #-#-#-#-#-#-#-#-#-#-#-#-# PATHS CONFIGURATION #-#-#-#-#-#-#-#-#-#-#-#-#
842 # This configuration tag defines the location that InspIRCd stores #
843 # various types of files such as configuration files, log files and #
844 # modules. You will probably not need to change these from the values #
845 # set when InspIRCd was built unless you are using a binary package #
846 # where you do not have the ability to set build time configuration. #
847 #<path configdir="conf" datadir="data" logdir="logs" moduledir="modules">
849 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
853 # Logging is covered with the <log> tag, which you may use to change
854 # the behaviour of the logging of the IRCd.
856 # An example log tag would be:
857 # <log method="file" type="OPER" level="default" target="opers.log">
858 # which would log all information on /oper (failed and successful) to
859 # a file called opers.log.
861 # There are many different types which may be used, and modules may
862 # generate their own. A list of useful types:
863 # - USERS - information relating to user connection and disconnection
864 # - OPER - succesful and failed oper attempts
865 # - KILL - kill related messages
866 # - FILTER - messages related to filter matches (filter module)
867 # - CONFIG - configuration related messages
868 # - COMMAND - die and restart messages, and messages related to unknown user types
869 # - SOCKET - socket engine informational/error messages
870 # - MODULE - module related messages
871 # - STARTUP - messages related to starting up the server
873 # You may also log *everything* by using a type of *, and subtract things out
874 # of that by using -TYPE - for example "* -USERINPUT -USEROUTPUT".
877 # - default (general messages, including errors)
878 # - sparse (misc error messages)
879 # - debug (debug messages)
881 # Some types only produce output in the debug level, those are:
882 # - BANCACHE - ban cache debug messages
883 # - CHANNELS - information relating to joining/creating channels
884 # - CULLLIST - debug messages related to issues with removing users
885 # - RESOLVER - DNS related debug messages
886 # - CONNECTCLASS - Connection class debug messages
890 # If your server is producing a high levels of log messages you can also set the
891 # flush="[positive number]" attribute to specify how many log messages should be
892 # buffered before flushing to disk. You should probably not specify this unless
893 # you are having problems.
895 # The following log tag is highly default and uncustomised. It is recommended you
896 # sort out your own log tags. This is just here so you get some output.
898 <log method="file" type="* -USERINPUT -USEROUTPUT" level="default" target="ircd.log">
900 #-#-#-#-#-#-#-#-#-#-#-#-#- WHOWAS OPTIONS -#-#-#-#-#-#-#-#-#-#-#-#-#
902 # This tag lets you define the behaviour of the /whowas command of #
907 # groupsize: Maximum entries per nick shown when performing
911 # maxgroups: Maximum number of nickgroups that can be added to
912 # the list so that /whowas does not use a lot of resources on
916 # maxkeep: Maximum time a nick is kept in the whowas list
917 # before being pruned. Time may be specified in seconds,
918 # or in the following format: 1y2w3d4h5m6s. Minimum is
922 #-#-#-#-#-#-#-#-#-#-#-#-#-#- BAN OPTIONS -#-#-#-#-#-#-#-#-#-#-#-#-#-#
924 # The ban tags define nick masks, host masks and ip ranges which are #
925 # banned from your server. All details in these tags are local to #
930 # ipmask: IP range to ban. Wildcards and CIDR can be used.
933 # reason: Reason to display when user is disconnected.
934 reason="No porn here thanks.">
937 # nick: Nick to disallow. Wildcards are supported.
940 # reason: Reason to display on /nick.
941 reason="Reserved for a network service">
944 # host: ident@hostname to ban.
945 # Wildcards and CIDR (if you specify an IP) can be used.
946 host="*@banneduser.example.net"
948 # reason: Reason to display when user is disconnected
949 reason="Evading Bans">
951 <badhost host="root@*" reason="Don't IRC as root!">
952 <badhost host="*@198.51.100.0/24" reason="This subnet is bad.">
954 # exception: Hosts that are exempt from [kgz]lines.
956 # host: ident@hostname to exempt.
957 # Wildcards and CIDR (if you specify an IP) can be used.
958 host="*@ircop.example.com"
960 # reason: Reason for exception. Only shown in /stats e
961 reason="Oper's hostname">
963 #-#-#-#-#-#-#-#-#-#-#- INSANE BAN OPTIONS -#-#-#-#-#-#-#-#-#-#-#-#-#-#
965 # This optional tag allows you to specify how wide a gline, eline, #
966 # kline, zline or qline can be before it is forbidden from being #
967 # set. By setting hostmasks="yes", you can allow all G, K, E lines, #
968 # no matter how many users the ban would cover. This is not #
969 # recommended! By setting ipmasks="yes", you can allow all Z lines, #
970 # no matter how many users these cover too. Needless to say we #
971 # don't recommend you do this, or, set nickmasks="yes", which will #
976 # hostmasks: Allow bans with insane hostmasks. (over-reaching bans)
979 # ipmasks: Allow bans with insane ipmasks. (over-reaching bans)
982 # nickmasks: Allow bans with insane nickmasks. (over-reaching bans)
985 # trigger: What percentage of users on the network to trigger
986 # specifying an insane ban as. The default is 95.5%, which means
987 # if you have a 1000 user network, a ban will not be allowed if it
988 # will be banning 955 or more users.
991 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# MODULES #-#-#-#-#-#-#-#-#-#-#-#-#-#-#
992 # ____ _ _____ _ _ ____ _ _ _ #
993 # | _ \ ___ __ _ __| | |_ _| |__ (_)___ | __ )(_) |_| | #
994 # | |_) / _ \/ _` |/ _` | | | | '_ \| / __| | _ \| | __| | #
995 # | _ < __/ (_| | (_| | | | | | | | \__ \ | |_) | | |_|_| #
996 # |_| \_\___|\__,_|\__,_| |_| |_| |_|_|___/ |____/|_|\__(_) #
998 # Well done, you've reached the end of the basic configuration, your #
999 # ircd should now start if you want to try it out! (./inspircd start) #
1001 # We now suggest you read and edit modules.conf, as modules are what #
1002 # provide almost all the features of InspIRCd. :) #
1004 # The default does nothing -- we include it for simplicity for you. #
1005 <include file="examples/modules.conf.example">
1007 #-#-#-#-#-#-#-#-#-#-#-# SERVICES CONFIGURATION #-#-#-#-#-#-#-#-#-#-#-#
1009 # If you use services you will probably want to include one of the #
1010 # following files which set up aliases, nick reservations and filter #
1011 # exemptions for services pseudoclients: #
1013 # Anope users should uncomment this:
1014 #<include file="examples/services/anope.conf.example">
1016 # Atheme users should uncomment this:
1017 #<include file="examples/services/atheme.conf.example">
1019 # Users of other services should uncomment this:
1020 #<include file="examples/services/generic.conf.example">
1022 #########################################################################
1024 # - InspIRCd Development Team - #
1025 # https://www.inspircd.org #
1027 #########################################################################