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 - http://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 and
101 # not contain spaces.
105 #-#-#-#-#-#-#-#-#-#-#-#- ADMIN INFORMATION -#-#-#-#-#-#-#-#-#-#-#-#
107 # Describes the Server Administrator's real name (optionally), #
108 # nick, and email address. #
113 name="Johnny English"
115 # nick: Nickname (preferably what you use on the network)
118 # email: email address. Does not have to be valid
119 # but should be for the users to be able to contact you.
120 email="MI5@the.best.secret.agent">
123 #-#-#-#-#-#-#-#-#-#-#-#- PORT CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-
125 # Enter the port and address bindings here. #
128 # ____ _ _____ _ _ ____ _ _ _ #
129 # | _ \ ___ __ _ __| | |_ _| |__ (_)___ | __ )(_) |_| | #
130 # | |_) / _ \/ _` |/ _` | | | | '_ \| / __| | _ \| | __| | #
131 # | _ < __/ (_| | (_| | | | | | | | \__ \ | |_) | | |_|_| #
132 # |_| \_\___|\__,_|\__,_| |_| |_| |_|_|___/ |____/|_|\__(_) #
134 # If you want to link servers to InspIRCd you must load the #
135 # spanningtree module! Please see the modules list for #
136 # information on how to load this module! If you do not load this #
137 # module, server ports will NOT work! #
140 # address: IP address to bind to if the box that you are hosting
141 # on has more than one IP, else the ircd will try to bind to all
142 # IP's on the box if this is not defined.
145 # port: Port for users or servers to be able to connect to.
146 # you can select multiple ports by separating them
147 # with a - character like the example below.
150 # type: Type of bind block this is. It can either be clients or
151 # servers. Whichever you select will be the only type able to connect
152 # to this bind section.
155 # ssl: If you want the port(s) in this bind tag to use SSL, set this to
156 # the name of a custom <sslprofile> tag that you have defined or one
157 # of "openssl", "gnutls", "mbedtls" if you have not defined any. See the
158 # wiki page for the SSL module you are using for more details.
160 # You will need to load the ssl_openssl module for OpenSSL, ssl_gnutls
161 # for GnuTLS and ssl_mbedtls for mbedTLS.
164 # defer: When this is non-zero, connections will not be handed over to
165 # the daemon from the operating system before data is ready.
166 # In Linux, the value indicates the time period we'll wait for a
167 # connection to come up with data. Don't set it too low!
168 # In BSD the value is ignored; only zero and non-zero is possible.
169 # Windows ignores this parameter completely.
170 # Note: This does not take effect on rehash.
171 # To change it on a running bind, you'll have to comment it out,
172 # rehash, comment it in and rehash again.
175 # free: When this is enabled the listener will be created regardless of
176 # whether the interface that provides the bind address is available. This
177 # is useful for if you are starting InspIRCd on boot when the server may
178 # not have brought the network interfaces up yet.
182 <bind address="" port="6660-6669" type="clients">
184 # Listener accepting HTML5 WebSocket connections.
185 # Requires the websocket module and SHA-1 hashing support (provided by the sha1
187 #<bind address="" port="7002" type="clients" hook="websocket">
189 # You can define a custom <sslprofile> tag which defines the SSL configuration
190 # for this listener. See the wiki page for the SSL module you are using for
193 # Alternatively, you can use one of the default SSL profiles which are created
194 # when you have not defined any:
195 # "openssl" (requires the ssl_openssl module)
196 # "gnutls" (requires the ssl_gnutls module)
197 # "mbedtls" (requires the ssl_mbedtls module)
199 # When linking servers, the OpenSSL, GnuTLS, and mbedTLS implementations are
200 # completely link-compatible and can be used alongside each other on each end
201 # of the link without any significant issues.
203 <bind address="" port="7000,7001" type="servers">
204 <bind address="1.2.3.4" port="7005" type="servers" ssl="openssl">
207 #-#-#-#-#-#-#-#-#-#- CONNECTIONS CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
209 # This is where you can configure which connections are allowed #
210 # and denied access onto your server. The password is optional. #
211 # You may have as many of these as you require. To allow/deny all #
212 # connections, use a '*' or 0.0.0.0/0. #
214 # -- It is important to note that connect tags are read from the -- #
215 # TOP DOWN. This means that you should have more specific deny #
216 # and allow tags at the top, progressively more general, followed #
217 # by a <connect allow="*" (should you wish to have one). #
219 # Connect blocks are searched twice for each user - once when the TCP #
220 # connection is accepted, and once when the user completes their #
221 # registration. Most of the information (hostname, ident response, #
222 # password, SSL when using STARTTLS, etc) is only available during #
223 # the second search, so if you are trying to make a closed server, #
224 # you will probably need a connect block just for user registration. #
225 # This can be done by using <connect registered="no"> #
228 # deny: Will not let people connect if they have specified host/IP.
231 # connect:reason is the message that users will see if they match a deny block
232 <connect deny="3ffe::0/32" reason="The 6bone address space is deprecated">
235 # name: Name to use for this connect block. Mainly used for
236 # connect class inheriting.
239 # parent: This setting is to specify if this connect class
240 # inherits settings from any other. Put the other class's name
241 # in here to use its settings as a template - for example, if
242 # you only want to adjust sendq and a password
245 # allow: What IP addresses/hosts to allow for this block.
248 # hash: the hash function this password is hashed with. Requires the
249 # module for the selected function (bcrypt, md5, sha1, sha256, or
250 # ripemd160) and the password hashing module (password_hash) to be
252 # You may also use any of the above other than bcrypt prefixed with
253 # either "hmac-" or "pbkdf2-hmac-" (requires the pbkdf2 module).
254 # Create hashed passwords with: /mkpasswd <hash> <password>
257 # password: Password to use for this block/user(s)
260 # maxchans: Maximum number of channels a user in this class
264 # timeout: How long the server will wait before disconnecting
265 # a user if they do not do anything on connect.
266 # (Note, this is a client-side thing, if the client does not
267 # send /nick, /user or /pass)
270 # localmax: Maximum local connections per IP (or CIDR mask, see below).
273 # globalmax: Maximum global (network-wide) connections per IP (or CIDR mask, see below).
276 # maxconnwarn: Enable warnings when localmax or globalmax are reached (defaults to on)
279 # resolvehostnames: If disabled, no DNS lookups will be performed on connecting users
280 # in this class. This can save a lot of resources on very busy servers.
281 resolvehostnames="yes"
283 # usednsbl: Defines whether or not users in this class are subject to DNSBL. Default is yes.
284 # This setting only has effect when the dnsbl module is loaded.
287 # useident: Defines if users in this class MUST respond to a ident query or not.
290 # webirc: Restricts usage of this class to the specified WebIRC gateway.
291 # This setting only has effect when the cgiirc module is loaded.
294 # limit: How many users are allowed in this class
297 # modes: Usermodes that are set on users in this block on connect.
298 # Enabling this option requires that the conn_umodes module be loaded.
299 # This entry is highly recommended to use for/with IP Cloaking/masking.
300 # For the example to work, this also requires that the "cloaking"
301 # module be loaded as well.
304 # requireident, requiressl, requireaccount: require that users of this
305 # block have a valid ident response, use SSL, or have authenticated.
306 # Requires ident, sslinfo, or the services_account module, respectively.
308 # NOTE: For requireaccount, you must complete the signon prior to full
309 # connection. Currently, this is only possible by using SASL
310 # authentication; passforward and PRIVMSG NickServ happen after
311 # your final connect block has been found.
313 # Alternate MOTD file for this connect class. The contents of this file are
314 # specified using <files secretmotd="filename"> or <execfiles ...>
317 # Allow color codes to be processed in the message of the day file.
318 # the following characters are valid color code escapes:
320 # \037 or \u = Underline
321 # \003 or \c = Color (with a code postfixed to this char)
322 # \017 or \x = Stop all color sequences
323 allowmotdcolors="false"
325 # port: What port range this user is allowed to connect on. (optional)
326 # The ports MUST be set to listen in the bind blocks above.
330 # name: Name to use for this connect block. Mainly used for
331 # connect class inheriting.
334 # allow: What IP addresses/hosts to allow for this block.
337 # maxchans: Maximum number of channels a user in this class
341 # timeout: How long the server will wait before disconnecting
342 # a user if they do not do anything on connect.
343 # (Note, this is a client-side thing, if the client does not
344 # send /nick, /user or /pass)
347 # pingfreq: How often the server tries to ping connecting clients.
350 # hardsendq: maximum amount of data allowed in a client's send queue
351 # before they are dropped. Keep this value higher than the length of
352 # your network's /LIST or /WHO output, or you will have lots of
353 # disconnects from sendq overruns!
354 # Setting this to "1M" is equivalent to "1048576", "8K" is 8192, etc.
357 # softsendq: amount of data in a client's send queue before the server
358 # begins delaying their commands in order to allow the sendq to drain
361 # recvq: amount of data allowed in a client's queue before they are dropped.
362 # Entering "8K" is equivalent to "8192", see above.
365 # threshold: This specifies the amount of command penalty a user is allowed to have
366 # before being quit or fakelagged due to flood. Normal commands have a penalty of 1,
367 # ones such as /OPER have penalties up to 10.
369 # If you are not using fakelag, this should be at least 20 to avoid excess flood kills
370 # from processing some commands.
373 # commandrate: This specifies the maximum rate that commands can be processed.
374 # If commands are sent more rapidly, the user's penalty will increase and they will
375 # either be fakelagged or killed when they reach the threshold
377 # Units are millicommands per second, so 1000 means one line per second.
380 # fakelag: Use fakelag instead of killing users for excessive flood
382 # Fake lag stops command processing for a user when a flood is detected rather than
383 # immediately killing them; their commands are held in the recvq and processed later
384 # as the user's command penalty drops. Note that if this is enabled, flooders will
385 # quit with "RecvQ exceeded" rather than "Excess Flood".
388 # localmax: Maximum local connections per IP.
391 # globalmax: Maximum global (network-wide) connections per IP.
394 # resolvehostnames: If disabled, no DNS lookups will be performed on connecting users
395 # in this class. This can save a lot of resources on very busy servers.
396 resolvehostnames="yes"
398 # useident: Defines if users in this class must respond to a ident query or not.
401 # limit: How many users are allowed in this class
404 # modes: Usermodes that are set on users in this block on connect.
405 # Enabling this option requires that the conn_umodes module be loaded.
406 # This entry is highly recommended to use for/with IP Cloaking/masking.
407 # For the example to work, this also requires that the cloaking
408 # module be loaded as well.
412 #-#-#-#-#-#-#-#-#-#-#-#- CIDR CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-
414 # CIDR configuration allows detection of clones and applying of #
415 # throttle limits across a CIDR range. (A CIDR range is a group of #
416 # IPs, for example, the CIDR range 192.168.1.0-192.168.1.255 may be #
417 # represented as 192.168.1.0/24). This means that abuse across an ISP #
418 # is detected and curtailed much easier. Here is a good chart that #
419 # shows how many IPs the different CIDRs correspond to: #
420 # http://en.wikipedia.org/wiki/CIDR#Prefix_aggregation #
424 # ipv4clone: specifies how many bits of an IP address should be
425 # looked at for clones. The default only looks for clones on a
426 # single IP address of a user. You do not want to set this
427 # extremely low. (Values are 0-32).
430 # ipv6clone: specifies how many bits of an IP address should be
431 # looked at for clones. The default only looks for clones on a
432 # single IP address of a user. You do not want to set this
433 # extremely low. (Values are 0-128).
436 # This file has all the information about oper classes, types and o:lines.
437 # You *MUST* edit it.
438 <include file="examples/opers.conf.example">
440 # This file has all the information about server links and ulined servers.
441 # You *MUST* edit it if you intend to link servers.
442 <include file="examples/links.conf.example">
444 #-#-#-#-#-#-#-#-#-#- MISCELLANEOUS CONFIGURATION -#-#-#-#-#-#-#-#-#-#
447 # Files block - contains files whose contents are used by the ircd
449 # motd - displayed on connect and when a user executes /MOTD
450 # Modules can also define their own files
451 <files motd="examples/motd.txt.example">
453 # Example of an executable file include. Note this will be read on rehash,
454 # not when the command is run.
455 #<execfiles motd="wget -O - http://www.example.com/motd.txt">
457 #-#-#-#-#-#-#-#-#-#-#-#-#-#-# DNS SERVER -#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
458 # If these values are not defined, InspIRCd uses the default DNS resolver
462 # server: DNS server to use to attempt to resolve IP's to hostnames.
463 # in most cases, you won't need to change this, as inspircd will
464 # automatically detect the nameserver depending on /etc/resolv.conf
465 # (or, on Windows, your set nameservers in the registry.)
466 # Note that this must be an IP address and not a hostname, because
467 # there is no resolver to resolve the name until this is defined!
471 # timeout: time to wait to try to resolve DNS/hostname.
474 # An example of using an IPv6 nameserver
475 #<dns server="::1" timeout="5">
477 #-#-#-#-#-#-#-#-#-#-#-#-#-#-# PID FILE -#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
479 # Define the path to the PID file here. The PID file can be used to #
480 # rehash the ircd from the shell or to terminate the ircd from the #
481 # shell using shell scripts, perl scripts, etc... and to monitor the #
482 # ircd's state via cron jobs. If this is a relative path, it will be #
483 # relative to the configuration directory, and if it is not defined, #
484 # the default of 'inspircd.pid' is used. #
487 #<pid file="/path/to/inspircd.pid">
489 #-#-#-#-#-#-#-#-#-#-#-#-#- BANLIST LIMITS #-#-#-#-#-#-#-#-#-#-#-#-#-#-#
491 # Use these tags to customise the ban limits on a per channel basis. #
492 # The tags are read from top to bottom, and any tag found which #
493 # matches the channels name applies the banlimit to that channel. #
494 # It is advisable to put an entry with the channel as '*' at the #
495 # bottom of the list. If none are specified or no maxbans tag is #
496 # matched, the banlist size defaults to 100 entries. #
499 <banlist chan="#largechan" limit="200">
500 <banlist chan="*" limit="100">
502 #-#-#-#-#-#-#-#-#-#-#- DISABLED FEATURES -#-#-#-#-#-#-#-#-#-#-#-#-#-#
504 # This tag is optional, and specifies one or more features which are #
505 # not available to non-operators. #
507 # For example you may wish to disable NICK and prevent non-opers from #
508 # changing their nicknames. #
509 # Note that any disabled commands take effect only after the user has #
510 # 'registered' (e.g. after the initial USER/NICK/PASS on connection) #
511 # so for example disabling NICK will not cripple your network. #
513 # You can also define if you want to disable any channelmodes #
514 # or usermodes from your users. #
516 # `fakenonexistant' will make the ircd pretend that nonexistant #
517 # commands simply don't exist to non-opers ("no such command"). #
519 #<disabled commands="TOPIC MODE" usermodes="" chanmodes="" fakenonexistant="yes">
522 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#- RTFM LINE -#-#-#-#-#-#-#-#-#-#-#-#-#-#
524 # Just remove this... Its here to make you read ALL of the config #
527 <die value="You should probably edit your config *PROPERLY* and try again.">
531 #-#-#-#-#-#-#-#-#-#-#-#-#- SERVER OPTIONS -#-#-#-#-#-#-#-#-#-#-#-#-#
533 # Settings to define which features are usable on your server. #
537 # prefixquit: What (if anything) users' quit messages
538 # should be prefixed with.
541 # suffixquit: What (if anything) users' quit messages
542 # should be suffixed with.
545 # prefixpart: What (if anything) users' part messages
546 # should be prefixed with.
548 # NOTE: Use "\"" instead of """ if not using <config format="xml">
550 # suffixpart: What (if anything) users' part message
551 # should be suffixed with.
554 # fixedquit: Set all users' quit messages to this value.
557 # fixedpart: Set all users' part messages in all channels
561 # syntaxhints: If enabled, if a user fails to send the correct parameters
562 # for a command, the ircd will give back some help text of what
563 # the correct parameters are.
566 # casemapping: This sets the case mapping method to be used by the
567 # server. This MUST be the same on all servers. Possible values are:
568 # "ascii" (recommended)
569 # "rfc1459" (default, required for linking to 2.0 servers)
570 # NOTE: if you are using the nationalchars module this setting will be
571 # ignored. You should use <nationalchars:casemapping> instead.
574 # cyclehostsfromuser: If enabled, the source of the mode change for
575 # cyclehosts will be the user who cycled. This can look nicer, but
576 # triggers anti-takeover mechanisms of some obsolete bots.
577 cyclehostsfromuser="no"
579 # announcets: If set to yes, when the timestamp on a channel changes, all users
580 # in the channel will be sent a NOTICE about it.
583 # allowmismatch: Setting this option to yes will allow servers to link even
584 # if they don't have the same "optionally common" modules loaded. Setting this to
585 # yes may introduce some desyncs and unwanted behaviour.
588 # defaultbind: Sets the default for <bind> tags without an address. Choices are
589 # ipv4 or ipv6; if not specified, IPv6 will be used if your system has support,
590 # falling back to IPv4 otherwise.
593 # hostintopic: If enabled, channels will show the host of the topic setter
594 # in the topic. If set to no, it will only show the nick of the topic setter.
597 # pingwarning: If a server does not respond to a ping within this period,
598 # it will send a notice to opers with snomask +l informing that the server
599 # is about to ping timeout.
602 # serverpingfreq: How often pings are sent between servers.
605 # defaultmodes: What modes are set on a empty channel when a user
606 # joins it and it is unregistered.
609 # xlinemessage: This is the text that is sent to a user when they are
610 # banned from the server.
611 xlinemessage="You're banned! Email irc@example.com with the ERROR line below for help."
613 # exemptchanops: exemptions for channel access restrictions based on prefix.
614 exemptchanops="nonick:v flood:o"
616 # invitebypassmodes: This allows /invite to bypass other channel modes.
617 # (Such as +k, +j, +l, etc.)
618 invitebypassmodes="yes"
620 # nosnoticestack: This prevents snotices from 'stacking' and giving you
621 # the message saying '(last message repeated X times)'. Defaults to no.
625 #-#-#-#-#-#-#-#-#-#-#-# PERFORMANCE CONFIGURATION #-#-#-#-#-#-#-#-#-#-#
629 # netbuffersize: Size of the buffer used to receive data from clients.
630 # The ircd may only read this amount of text in 1 go at any time.
631 netbuffersize="10240"
633 # somaxconn: The maximum number of connections that may be waiting
634 # in the accept queue. This is *NOT* the total maximum number of
635 # connections per server. Some systems may only allow this to be up
636 # to 5, while others (such as Linux and *BSD) default to 128.
637 # Setting this above the limit imposed by your OS can have undesired
641 # softlimit: This optional feature allows a defined softlimit for
642 # connections. If defined, it sets a soft max connections value.
645 # clonesonconnect: If this is set to false, we won't check for clones
646 # on initial connection, but only after the DNS check is done.
647 # This can be useful where your main class is more restrictive
648 # than some other class a user can be assigned after DNS lookup is complete.
649 # Turning this option off will make the server spend more time on users we may
650 # potentially not want. Normally this should be neglible, though.
651 # Default value is true
652 clonesonconnect="true"
654 # quietbursts: When syncing or splitting from a network, a server
655 # can generate a lot of connect and quit messages to opers with
656 # +C and +Q snomasks. Setting this to yes squelches those messages,
657 # which makes it easier for opers, but degrades the functionality of
658 # bots like BOPM during netsplits.
661 #-#-#-#-#-#-#-#-#-#-#-# SECURITY CONFIGURATION #-#-#-#-#-#-#-#-#-#-#-#
665 # allowcoreunload: If this value is set to yes, Opers will be able to
666 # unload core modules (e.g. core_privmsg).
669 # announceinvites: This option controls which members of the channel
670 # receive an announcement when someone is INVITEd. Available values:
671 # 'none' - don't send invite announcements
672 # 'all' - send invite announcements to all members
673 # 'ops' - send invite announcements to ops and higher ranked users
674 # 'dynamic' - send invite announcements to halfops (if available) and
675 # higher ranked users. This is the recommended setting.
676 announceinvites="dynamic"
678 # hideulines: If this value is set to yes, U-lined servers will
679 # be hidden from non-opers in /links and /map.
682 # flatlinks: If this value is set to yes, /map and /links will
683 # be flattened when shown to non-opers.
686 # hidewhois: When defined, the given text will be used in place
687 # of the server a user is on when whoised by a non-oper. Most
688 # networks will want to set this to something like "*.netname.net"
689 # to conceal the actual server a user is on.
690 # Note that enabling this will cause users' idle times to only be
691 # shown when the format /WHOIS <nick> <nick> is used.
694 # hidebans: If this value is set to yes, when a user is banned ([gkz]lined)
695 # only opers will see the ban message when the user is removed
699 # hidekills: If defined, replaces who set a /kill with a custom string.
702 # hideulinekills: Hide kills from clients of ulined servers from server notices.
705 # hidesplits: If enabled, non-opers will not be able to see which
706 # servers split in a netsplit, they will only be able to see that one
707 # occurred (If their client has netsplit detection).
710 # maxtargets: Maximum number of targets per command.
711 # (Commands like /notice, /privmsg, /kick, etc)
714 # customversion: A custom message to be displayed in the comments field
715 # of the VERSION command response. This does not hide the InspIRCd version.
718 # operspywhois: show opers (users/auspex) the +s channels a user is in. Values:
719 # splitmsg Split with an explanatory message
720 # yes Split with no explanatory message
724 # runasuser: If this is set, InspIRCd will attempt to switch
725 # to run as this user, which allows binding of ports under 1024.
726 # You should NOT set this unless you are starting as root.
727 # NOT SUPPORTED/NEEDED UNDER WINDOWS.
730 # runasgroup: If this is set, InspIRCd will attempt to switch
731 # to run as this group, which allows binding of ports under 1024.
732 # You should NOT set this unless you are starting as root.
733 # NOT SUPPORTED/NEEDED UNDER WINDOWS.
736 # restrictbannedusers: If this is set to yes, InspIRCd will not allow users
737 # banned on a channel to change nickname or message channels they are
739 restrictbannedusers="yes"
741 # genericoper: Setting this value to yes makes all opers on this server
742 # appear as 'is an IRC operator' in their WHOIS, regardless of their
743 # oper type, however oper types are still used internally. This only
744 # affects the display in WHOIS.
747 # userstats: /stats commands that users can run (opers can run all).
750 #-#-#-#-#-#-#-#-#-#-#-#-# LIMITS CONFIGURATION #-#-#-#-#-#-#-#-#-#-#-#
752 # This configuration tag defines the maximum sizes of various types #
753 # on IRC, such as the maximum length of a channel name, and the #
754 # maximum length of a channel. Note that with the exception of the #
755 # identmax value all values given here are the exact values you would #
756 # expect to see on IRC. This contrasts with the older InspIRCd #
757 # releases where these values would be one character shorter than #
758 # defined to account for a null terminator on the end of the text. #
760 # These values should match network-wide otherwise issues will occur. #
762 # The highest safe value you can set any of these options to is 500, #
763 # but it is recommended that you keep them somewhat #
764 # near their defaults (or lower). #
767 # maxnick: Maximum length of a nickname.
770 # maxchan: Maximum length of a channel name.
773 # maxmodes: Maximum number of mode changes per line.
776 # maxident: Maximum length of a ident/username.
779 # maxhost: Maximum length of a hostname.
782 # maxquit: Maximum length of a quit message.
785 # maxtopic: Maximum length of a channel topic.
788 # maxkick: Maximum length of a kick message.
791 # maxgecos: Maximum length of a GECOS (realname).
794 # maxaway: Maximum length of an away message.
797 #-#-#-#-#-#-#-#-#-#-#-#-# PATHS CONFIGURATION #-#-#-#-#-#-#-#-#-#-#-#-#
799 # This configuration tag defines the location that InspIRCd stores #
800 # various types of files such as configuration files, log files and #
801 # modules. You will probably not need to change these from the values #
802 # set when InspIRCd was built unless you are using a binary package #
803 # where you do not have the ability to set build time configuration. #
804 #<path configdir="conf" datadir="data" logdir="logs" moduledir="modules">
806 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
810 # Logging is covered with the <log> tag, which you may use to change
811 # the behaviour of the logging of the IRCd.
813 # In InspIRCd as of 1.2, logging is pluggable and very extensible.
814 # Different files can log the same thing, different 'types' of log can
815 # go to different places, and modules can even extend the log tag
816 # to do what they want.
818 # An example log tag would be:
819 # <log method="file" type="OPER" level="default" target="opers.log">
820 # which would log all information on /oper (failed and successful) to
821 # a file called opers.log.
823 # There are many different types which may be used, and modules may
824 # generate their own. A list of useful types:
825 # - USERS - information relating to user connection and disconnection
826 # - OPER - succesful and failed oper attempts
827 # - KILL - kill related messages
828 # - snomask - server notices (*all* snomasks will be logged)
829 # - FILTER - messages related to filter matches (filter module)
830 # - CONFIG - configuration related messages
831 # - COMMAND - die and restart messages, and messages related to unknown user types
832 # - SOCKET - socket engine informational/error messages
833 # - MODULE - module related messages
834 # - STARTUP - messages related to starting up the server
836 # You may also log *everything* by using a type of *, and subtract things out
837 # of that by using -TYPE - for example "* -USERINPUT -USEROUTPUT".
840 # - default (general messages, including errors)
841 # - sparse (misc error messages)
842 # - debug (debug messages)
844 # Some types only produce output in the debug level, those are:
845 # - BANCACHE - ban cache debug messages
846 # - CHANNELS - information relating to joining/creating channels
847 # - CULLLIST - debug messages related to issues with removing users
848 # - RESOLVER - DNS related debug messages
849 # - CONNECTCLASS - Connection class debug messages
853 # If your server is producing a high levels of log messages you can also set the
854 # flush="[positive number]" attribute to specify how many log messages should be
855 # buffered before flushing to disk. You should probably not specify this unless
856 # you are having problems.
858 # The following log tag is highly default and uncustomised. It is recommended you
859 # sort out your own log tags. This is just here so you get some output.
861 <log method="file" type="* -USERINPUT -USEROUTPUT" level="default" target="ircd.log">
863 #-#-#-#-#-#-#-#-#-#-#-#-#- WHOWAS OPTIONS -#-#-#-#-#-#-#-#-#-#-#-#-#
865 # This tag lets you define the behaviour of the /whowas command of #
870 # groupsize: Maximum entries per nick shown when performing
874 # maxgroups: Maximum number of nickgroups that can be added to
875 # the list so that /whowas does not use a lot of resources on
879 # maxkeep: Maximum time a nick is kept in the whowas list
880 # before being pruned. Time may be specified in seconds,
881 # or in the following format: 1y2w3d4h5m6s. Minimum is
885 #-#-#-#-#-#-#-#-#-#-#-#-#-#- BAN OPTIONS -#-#-#-#-#-#-#-#-#-#-#-#-#-#
887 # The ban tags define nick masks, host masks and ip ranges which are #
888 # banned from your server. All details in these tags are local to #
893 # ipmask: IP range to ban. Wildcards and CIDR can be used.
896 # reason: Reason to display when user is disconnected.
897 reason="No porn here thanks.">
900 # nick: Nick to disallow. Wildcards are supported.
903 # reason: Reason to display on /nick.
904 reason="Reserved for a network service">
907 # host: ident@hostname to ban.
908 # Wildcards and CIDR (if you specify an IP) can be used.
909 host="*@banneduser.example.net"
911 # reason: Reason to display when user is disconnected
912 reason="Evading Bans">
914 <badhost host="root@*" reason="Don't IRC as root!">
915 <badhost host="*@198.51.100.0/24" reason="This subnet is bad.">
917 # exception: Hosts that are exempt from [kgz]lines.
919 # host: ident@hostname to exempt.
920 # Wildcards and CIDR (if you specify an IP) can be used.
921 host="*@ircop.example.com"
923 # reason: Reason for exception. Only shown in /stats e
924 reason="Oper's hostname">
926 #-#-#-#-#-#-#-#-#-#-#- INSANE BAN OPTIONS -#-#-#-#-#-#-#-#-#-#-#-#-#-#
928 # This optional tag allows you to specify how wide a gline, eline, #
929 # kline, zline or qline can be before it is forbidden from being #
930 # set. By setting hostmasks="yes", you can allow all G, K, E lines, #
931 # no matter how many users the ban would cover. This is not #
932 # recommended! By setting ipmasks="yes", you can allow all Z lines, #
933 # no matter how many users these cover too. Needless to say we #
934 # don't recommend you do this, or, set nickmasks="yes", which will #
939 # hostmasks: Allow bans with insane hostmasks. (over-reaching bans)
942 # ipmasks: Allow bans with insane ipmasks. (over-reaching bans)
945 # nickmasks: Allow bans with insane nickmasks. (over-reaching bans)
948 # trigger: What percentage of users on the network to trigger
949 # specifying an insane ban as. The default is 95.5%, which means
950 # if you have a 1000 user network, a ban will not be allowed if it
951 # will be banning 955 or more users.
955 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#- YAWN -#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
957 # You should already know what to do here :) #
959 <die value="User error. You didn't edit your config properly. Go back and try again.">
961 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# MODULES #-#-#-#-#-#-#-#-#-#-#-#-#-#-#
962 # ____ _ _____ _ _ ____ _ _ _ #
963 # | _ \ ___ __ _ __| | |_ _| |__ (_)___ | __ )(_) |_| | #
964 # | |_) / _ \/ _` |/ _` | | | | '_ \| / __| | _ \| | __| | #
965 # | _ < __/ (_| | (_| | | | | | | | \__ \ | |_) | | |_|_| #
966 # |_| \_\___|\__,_|\__,_| |_| |_| |_|_|___/ |____/|_|\__(_) #
968 # Well done, you've reached the end of the basic configuration, your #
969 # ircd should now start if you want to try it out! (./inspircd start) #
971 # We now suggest you read and edit modules.conf, as modules are what #
972 # provide almost all the features of InspIRCd. :) #
974 # The default does nothing -- we include it for simplicity for you. #
975 <include file="examples/modules.conf.example">
977 # Here are some pre-built modules.conf files that closely match the
978 # default configurations of some popular IRCd's. You still may want to
979 # look over them and make sure if everything is correct for you and setup
980 # the proper SSL information.
982 # *NOTE*: These files have no comments for what the modules do. If you
983 # are interested in that, please read the modules.conf.example. It is also
984 # recommended that you make your own modules file based on modules.conf.example.
986 # Settings similar to UnrealIRCd defaults.
987 #<include file="examples/modules/unrealircd.conf.example">
989 # Settings similar to Charybdis IRCd defaults.
990 #<include file="examples/modules/charybdis.conf.example">
992 #-#-#-#-#-#-#-#-#-#-#-# SERVICES CONFIGURATION #-#-#-#-#-#-#-#-#-#-#-#
994 # If you use services you will probably want to include one of the #
995 # following files which set up aliases, nick reservations and filter #
996 # exemptions for services pseudoclients: #
998 # Anope users should uncomment this:
999 #<include file="examples/services/anope.conf.example">
1001 # Atheme users should uncomment this:
1002 #<include file="examples/services/atheme.conf.example">
1004 # Users of other services should uncomment this:
1005 #<include file="examples/services/generic.conf.example">
1007 #########################################################################
1009 # - InspIRCd Development Team - #
1010 # http://www.inspircd.org #
1012 #########################################################################