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 # Unalphabeticalise the modules list at your own risk #
39 ########################################################################
41 #-#-#-#-#-#-#-#-#-# CONFIGURATION FORMAT #-#-#-#-#-#-#-#-#-#-#-#-#-#-
43 # In order to maintain compatibility with older configuration files, #
44 # you can change the configuration parser to parse as it did in #
45 # previous releases. When using the "compat" format, you need to use #
46 # C++ escape sequences (e.g. \n) instead of XML ones (e.g. &nl;) and #
47 # can not use <define> to create macros. #
48 #<config format="compat">
50 #-#-#-#-#-#-#-#-#-# INCLUDE CONFIGURATION #-#-#-#-#-#-#-#-#-#-#-#-#-#
52 # This optional tag allows you to include another config file #
53 # allowing you to keep your configuration tidy. The configuration #
54 # file you include will be treated as part of the configuration file #
55 # which includes it, in simple terms the inclusion is transparent. #
57 # All paths to config files are relative to the directory that the #
60 # You may also include an executable file, in which case if you do so #
61 # the output of the executable on the standard output will be added #
62 # to your config at the point of the include tag. #
64 # Syntax is as follows: #
65 #<include file="file.conf"> #
66 #<include executable="/path/to/executable parameters"> #
68 # Executable Include Example: #
69 #<include executable="/usr/bin/wget -q -O - http://mynet.net/inspircd.conf">
73 #-#-#-#-#-#-#-#-#-#-#-# VARIABLE DEFINITIONS -#-#-#-#-#-#-#-#-#-#-#-#
75 # You can define variables that will be substituted later in the #
76 # configuration file. This can be useful to allow settings to be #
77 # easily changed, or to parameterize a remote includes. #
79 # Variables may be redefined and may reference other variables. #
80 # Value expansion happens at the time the tag is read. #
81 <define name="bindip" value="1.2.2.3">
82 <define name="localips" value="&bindip;/24">
84 #-#-#-#-#-#-#-#-#-#-#-#- SERVER DESCRIPTION -#-#-#-#-#-#-#-#-#-#-#-#-
86 # Here is where you enter the information about your server. #
90 # name: Hostname of your server. Does not need to resolve, but
91 # does need to be correct syntax (something.somethingelse.tld).
92 name="penguin.omega.org.za"
94 # description: Server description. Spaces are allowed.
95 description="Waddle World"
97 # id: The SID to use for this server. This should not be uncommented
98 # unless there is a SID conflict. This must be three characters long.
99 # The first character must be a digit [0-9], the remaining two chars
100 # may be letters [A-Z] or digits.
103 # network: Network name given on connect to clients.
104 # Should be the same on all servers on the network and
105 # not contain spaces.
109 #-#-#-#-#-#-#-#-#-#-#-#- ADMIN INFORMATION -#-#-#-#-#-#-#-#-#-#-#-#
111 # Describes the Server Administrator's real name (optionally), #
112 # nick, and email address. #
117 name="Johnny English"
119 # nick: Nickname (preferably what you use on the network)
122 # email: email address. Does not have to be valid
123 # but should be for the users to be able to contact you.
124 email="MI5@the.best.secret.agent">
127 #-#-#-#-#-#-#-#-#-#-#-#- PORT CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-
129 # Enter the port and address bindings here. #
132 # ____ _ _____ _ _ ____ _ _ _ #
133 # | _ \ ___ __ _ __| | |_ _| |__ (_)___ | __ )(_) |_| | #
134 # | |_) / _ \/ _` |/ _` | | | | '_ \| / __| | _ \| | __| | #
135 # | _ < __/ (_| | (_| | | | | | | | \__ \ | |_) | | |_|_| #
136 # |_| \_\___|\__,_|\__,_| |_| |_| |_|_|___/ |____/|_|\__(_) #
138 # If you want to link servers to InspIRCd you must load the #
139 # m_spanningtree.so module! Please see the modules list below for #
140 # information on how to load this module! If you do not load this #
141 # module, server ports will NOT be bound! #
143 # PLEASE NOTE: If you have build InspIRCd with IPv6 support, you MUST #
144 # specify a bind address if you want the IRCd to bind to a IPv4 IP. #
147 # address: IP address to bind to if the box that you are hosting
148 # on has more than one IP, else the ircd will try to bind to all
149 # IP's on the box if this is not defined.
152 # port: Port for users or servers to be able to connect to.
153 # you can select multiple ports by separating them
154 # with a - character like the example below.
157 # type: Type of bind block this is. It can either be clients or
158 # servers. Whichever you select will be the only type able to connect
159 # to this bind section.
162 # ssl: If you want this bind section to use SSL, define either
163 # gnutls or openssl here. The appropriate SSL modules must be loaded
164 # for ssl to work. If you do not want this bind section to support ssl,
165 # just remove or comment out this option.
169 <bind address="" port="6660-6669" type="clients">
171 # When linking servers, the openssl and gnutls implementations are completely
172 # link-compatible and can be used alongside each other
173 # on each end of the link without any significant issues.
174 # Supported ssl types are: "openssl" and "gnutls".
175 # You must load, m_ssl_openssl for openssl
176 # or m_ssl_gnutls for gnutls.
178 <bind address="" port="7000,7001" type="servers">
179 <bind address="1.2.3.4" port="7005" type="servers" ssl="openssl">
182 #-#-#-#-#-#-#-#-#-#- DIE/RESTART CONFIGURATION -#-#-#-#-#-#-#-#-#-#-
184 # You can configure the passwords here which you wish to use for #
185 # the die and restart commands. Only trusted IRCop's who will #
186 # need this ability should know the die and restart password. #
190 # hash: what hash these passwords are hashed with. requires the module
191 # for selected hash (m_md5.so, m_sha256.so or m_ripemd160.so) be
192 # loaded and the password hashing module (m_password_hash.so)
193 # loaded. Options here are: "md5", "sha256" and "ripemd160".
194 # Optional, but recommended. Create hashed password with:
195 # /mkpasswd <hash> <password>
198 # diepass: Password for opers to use if they need to shutdown (die)
202 # restartpass: Password for opers to use if they need to restart
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: what hash this password is hashed with. requires the module
249 # for selected hash (m_md5.so, m_sha256.so or m_ripemd160.so) be
250 # loaded and the password hashing module (m_password_hash.so)
251 # loaded. Options here are: "md5", "sha256" and "ripemd160".
252 # Optional, but recommended. Create hashed password with:
253 # /mkpasswd <hash> <password>
256 # password: Password to use for this block/user(s)
259 # maxchans: Maximum number of channels a user in this class
260 # be in at one time. This overrides every other maxchans setting.
263 # timeout: How long (in seconds) the server will wait before
264 # disconnecting a user if they do not do anything on connect.
265 # (Note, this is a client-side thing, if the client does not
266 # send /nick, /user or /pass)
269 # localmax: Maximum local connections per IP (or CIDR mask, see below).
272 # globalmax: Maximum global (network-wide) connections per IP (or CIDR mask, see below).
275 # maxconnwarn: Enable warnings when localmax or globalmax is hit (defaults to on)
278 # nouserdns: If enabled, no DNS lookups will be performed on connecting users
279 # in this class. This can save a lot of resources on very busy servers.
282 # usednsbl: Defines whether or not users in this class are subject to DNSBL. Default is yes.
283 # This setting only has effect when m_dnsbl is loaded.
286 # useident: Defines if users in this class MUST respond to a ident query or not.
289 # limit: How many users are allowed in this class
292 # modes: Usermodes that are set on users in this block on connect.
293 # Enabling this option requires that the m_conn_umodes module be loaded.
294 # This entry is highly recommended to use for/with IP Cloaking/masking.
295 # For the example to work, this also requires that the m_cloaking
296 # module be loaded as well.
299 # requireident, requiressl, requireaccount: require that users of this
300 # block have a valid ident response, use SSL, or have authenticated.
301 # Requires m_ident, m_sslinfo, or m_services_account respectively.
303 # NOTE: For requireaccount, you must complete the signon prior to full
304 # connection. Currently, this is only possible by using SASL
305 # authentication; passforward and PRIVMSG NickServ happen after
306 # your final connect block has been found.
308 # Alternate MOTD file for this connect class. The contents of this file are
309 # specified using <files secretmotd="filename"> or <execfiles ...>
312 # Allow color codes to be processed in the message of the day file.
313 # the following characters are valid color code escapes:
315 # \037 or \u = Underline
316 # \003 or \c = Color (with a code postfixed to this char)
317 # \017 or \x = Stop all color sequences
318 allowmotdcolors="false"
320 # port: What port this user is allowed to connect on. (optional)
321 # The port MUST be set to listen in the bind blocks above.
325 # name: Name to use for this connect block. Mainly used for
326 # connect class inheriting.
329 # allow: What IP addresses/hosts to allow for this block.
332 # maxchans: Maximum number of channels a user in this class
333 # be in at one time. This overrides every other maxchans setting.
336 # timeout: How long (in seconds) the server will wait before
337 # disconnecting a user if they do not do anything on connect.
338 # (Note, this is a client-side thing, if the client does not
339 # send /nick, /user or /pass)
342 # pingfreq: How often (in seconds) the server tries to ping connecting clients.
345 # hardsendq: maximum amount of data allowed in a client's send queue
346 # before they are dropped. Keep this value higher than the length of
347 # your network's /LIST or /WHO output, or you will have lots of
348 # disconnects from sendq overruns!
351 # softsendq: amount of data in a client's send queue before the server
352 # begins delaying their commands in order to allow the sendq to drain
355 # recvq: amount of data allowed in a client's queue before they are dropped.
358 # threshold: This specifies the amount of command penalty a user is allowed to have
359 # before being quit or fakelagged due to flood. Normal commands have a penalty of 1,
360 # ones such as /OPER have penalties up to 10.
362 # If you are not using fakelag, this should be at least 20 to avoid excess flood kills
363 # from processing some commands.
366 # commandrate: This specifies the maximum rate that commands can be processed.
367 # If commands are sent more rapidly, the user's penalty will increase and they will
368 # either be fakelagged or killed when they reach the threshold
370 # Units are millicommands per second, so 1000 means one line per second.
373 # fakelag: Use fakelag instead of killing users for excessive flood
375 # Fake lag stops command processing for a user when a flood is detected rather than
376 # immediately killing them; their commands are held in the recvq and processed later
377 # as the user's command penalty drops. Note that if this is enabled, flooders will
378 # quit with "RecvQ exceeded" rather than "Excess Flood".
381 # localmax: Maximum local connections per IP.
384 # globalmax: Maximum global (network-wide) connections per IP.
387 # nouserdns: If enabled, no DNS lookups will be performed on connecting users
388 # in this class. This can save a lot of resources on very busy servers.
391 # useident: Defines if users in this class must respond to a ident query or not.
394 # limit: How many users are allowed in this class
397 # modes: Usermodes that are set on users in this block on connect.
398 # Enabling this option requires that the m_conn_umodes module be loaded.
399 # This entry is highly recommended to use for/with IP Cloaking/masking.
400 # For the example to work, this also requires that the m_cloaking
401 # module be loaded as well.
405 #-#-#-#-#-#-#-#-#-#-#-#- CIDR CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-
407 # CIDR configuration allows detection of clones and applying of #
408 # throttle limits across a CIDR range. (A CIDR range is a group of #
409 # IPs, for example, the CIDR range 192.168.1.0-192.168.1.255 may be #
410 # represented as 192.168.1.0/24). This means that abuse across an ISP #
411 # is detected and curtailed much easier. Here is a good chart that #
412 # shows how many IPs the different CIDRs correspond to: #
413 # http://en.wikipedia.org/wiki/CIDR#Prefix_aggregation #
417 # ipv4clone: specifies how many bits of an IP address should be
418 # looked at for clones. The default only looks for clones on a
419 # single IP address of a user. You do not want to set this
420 # extremely low. (Values are 0-32).
423 # ipv6clone: specifies how many bits of an IP address should be
424 # looked at for clones. The default only looks for clones on a
425 # single IP address of a user. You do not want to set this
426 # extremely low. (Values are 0-128).
429 # This file has all the information about oper classes, types and o:lines.
430 # You *MUST* edit it.
431 <include file="conf/examples/opers.conf.example">
433 # This file has all the information about server links and ulined servers.
434 # You *MUST* edit it if you intend to link servers.
435 <include file="conf/examples/links.conf.example">
437 #-#-#-#-#-#-#-#-#-#- MISCELLANEOUS CONFIGURATION -#-#-#-#-#-#-#-#-#-#
440 # Files block - contains files whose contents are used by the ircd
442 # motd - displayed on connect and when a user executes /MOTD
443 # rules - displayed when the user executes /RULES
444 # Modules can also define their own files
445 <files motd="conf/examples/motd.txt.example" rules="conf/examples/rules.txt.example">
447 # Example of an executable file include. Note this will be read on rehash,
448 # not when the command is run.
449 #<execfiles rules="wget -O - http://www.example.com/rules.txt">
451 #-#-#-#-#-#-#-#-#-#-#-# MAXIMUM CHANNELS -#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
455 # users: Maximum number of channels a user can be in at once.
458 # opers: Maximum number of channels a oper can be in at once.
461 #-#-#-#-#-#-#-#-#-#-#-#-#-#-# DNS SERVER -#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
462 # If these values are not defined, InspIRCd uses the default DNS resolver
466 # server: DNS server to use to attempt to resolve IP's to hostnames.
467 # in most cases, you won't need to change this, as inspircd will
468 # automatically detect the nameserver depending on /etc/resolv.conf
469 # (or, on windows, your set nameservers in the registry.)
470 # Note that this must be an IP address and not a hostname, because
471 # there is no resolver to resolve the name until this is defined!
475 # timeout: seconds to wait to try to resolve DNS/hostname.
478 # An example of using an IPv6 nameserver
479 #<dns server="::1" timeout="5">
481 #-#-#-#-#-#-#-#-#-#-#-#-#-#-# PID FILE -#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
483 # Define the path to the PID file here. The PID file can be used to #
484 # rehash the ircd from the shell or to terminate the ircd from the #
485 # shell using shell scripts, perl scripts, etc... and to monitor the #
486 # ircd's state via cron jobs. If this is a relative path, it will be #
487 # relative to the configuration directory, and if it is not defined, #
488 # the default of 'inspircd.pid' is used. #
491 #<pid file="/path/to/inspircd.pid">
493 #-#-#-#-#-#-#-#-#-#-#-#-#- BANLIST LIMITS #-#-#-#-#-#-#-#-#-#-#-#-#-#-#
495 # Use these tags to customise the ban limits on a per channel basis. #
496 # The tags are read from top to bottom, and any tag found which #
497 # matches the channels name applies the banlimit to that channel. #
498 # It is advisable to put an entry with the channel as '*' at the #
499 # bottom of the list. If none are specified or no maxbans tag is #
500 # matched, the banlist size defaults to 64 entries. #
503 <banlist chan="#morons" limit="128">
504 <banlist chan="*" limit="69">
506 #-#-#-#-#-#-#-#-#-#-#- DISABLED FEATURES -#-#-#-#-#-#-#-#-#-#-#-#-#-#
508 # This tag is optional, and specifies one or more features which are #
509 # not available to non-operators. #
511 # For example you may wish to disable NICK and prevent non-opers from #
512 # changing their nicknames. #
513 # Note that any disabled commands take effect only after the user has #
514 # 'registered' (e.g. after the initial USER/NICK/PASS on connection) #
515 # so for example disabling NICK will not cripple your network. #
517 # You can also define if you want to disable any channelmodes #
518 # or usermodes from your users. #
520 # `fakenonexistant' will make the ircd pretend that nonexistant #
521 # commands simply don't exist to non-opers ("no such command"). #
523 #<disabled commands="TOPIC MODE" usermodes="" chanmodes="" fakenonexistant="yes">
526 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#- RTFM LINE -#-#-#-#-#-#-#-#-#-#-#-#-#-#
528 # Just remove this... Its here to make you read ALL of the config #
531 <die value="You should probably edit your config *PROPERLY* and try again.">
535 #-#-#-#-#-#-#-#-#-#-#-#-#- SERVER OPTIONS -#-#-#-#-#-#-#-#-#-#-#-#-#
537 # Settings to define which features are usable on your server. #
541 # prefixquit: What (if anything) a users' quit message
542 # should be prefixed with.
545 # suffixquit: What (if anything) a users' quit message
546 # should be suffixed with.
549 # prefixpart: What (if anything) a users' part message
550 # should be prefixed with.
552 # NOTE: Use "\"" instead of """ if not using <config format="xml">
554 # suffixpart: What (if anything) a users' part message
555 # should be suffixed with.
558 # fixedquit: Set all users' quit messages to this value.
561 # fixedpart: Set all users' part messages in all channels
565 # syntaxhints: If enabled, if a user fails to send the correct parameters
566 # for a command, the ircd will give back some help text of what
567 # the correct parameters are.
570 # cyclehosts: If enabled, when a user gets a host set, it will cycle
571 # them in all their channels. If not, it will simply change their host
572 # without cycling them.
575 # cyclehostsfromuser: If enabled, the source of the mode change for
576 # cyclehosts will be the user who cycled. This can look nicer, but
577 # triggers anti-takeover mechanisms of some obsolete bots.
578 cyclehostsfromuser="no"
580 # ircumsgprefix: Use undernet-style message prefixing for NOTICE and
581 # PRIVMSG. If enabled, it will add users' prefix to the line, if not,
582 # it will just message the user normally.
585 # announcets: If set to yes, when the TimeStamp on a channel changes, all users
586 # in channel will be sent a NOTICE about it.
589 # allowmismatch: Setting this option to yes will allow servers to link even
590 # if they don't have the same VF_OPTCOMMON modules loaded. Setting this to
591 # yes may introduce some desyncs and weirdness.
594 # defaultbind: Sets the default for <bind> tags without an address. Choices are
595 # ipv4 or ipv6; if not specified, IPv6 will be used if your system has support,
596 # falling back to IPv4 otherwise.
599 # hostintopic: If enabled, channels will show the host of the topicsetter
600 # in the topic. If set to no, it will only show the nick of the topicsetter.
603 # pingwarning: If a server does not respond to a ping within x seconds,
604 # it will send a notice to opers with snomask +l informing that the server
605 # is about to ping timeout.
608 # serverpingfreq: How often pings are sent between servers (in seconds).
611 # defaultmodes: What modes are set on a empty channel when a user
612 # joins it and it is unregistered. This is similar to Asuka's
616 # moronbanner: This is the text that is sent to a user when they are
617 # banned from the server.
618 moronbanner="You're banned! Email haha@abuse.com with the ERROR line below for help."
620 # exemptchanops: exemptions for channel access restrictions based on prefix.
621 exemptchanops="nonick:v flood:o"
623 # invitebypassmodes: This allows /invite to bypass other channel modes.
624 # (Such as +k, +j, +l, etc)
625 invitebypassmodes="yes"
627 # nosnoticestack: This prevents snotices from 'stacking' and giving you
628 # the message saying '(last message repeated X times)'. Defaults to no.
632 #-#-#-#-#-#-#-#-#-#-#-# PERFORMANCE CONFIGURATION #-#-#-#-#-#-#-#-#-#-#
636 # netbuffersize: Size of the buffer used to recieve data from clients.
637 # The ircd may only read this amount of text in 1 go at any time.
638 netbuffersize="10240"
640 # maxwho: Maximum number of results to show in a /who query.
643 # somaxconn: The maximum number of connections that may be waiting
644 # in the accept queue. This is *NOT* the total maximum number of
645 # connections per server. Some systems may only allow this to be up
646 # to 5, while others (such as linux and *BSD) default to 128.
649 # limitsomaxconn: By default, somaxconn (see above) is limited to a
650 # safe maximum value in the 2.0 branch for compatibility reasons.
651 # This setting can be used to disable this limit, forcing InspIRCd
652 # to use the value specifed above.
653 limitsomaxconn="true"
655 # softlimit: This optional feature allows a defined softlimit for
656 # connections. If defined, it sets a soft max connections value.
659 # quietbursts: When syncing or splitting from a network, a server
660 # can generate a lot of connect and quit messages to opers with
661 # +C and +Q snomasks. Setting this to yes squelches those messages,
662 # which makes it easier for opers, but degrades the functionality of
663 # bots like BOPM during netsplits.
666 #-#-#-#-#-#-#-#-#-#-#-# SECURITY CONFIGURATION #-#-#-#-#-#-#-#-#-#-#-#
670 # allowcoreunload: If this value is set to yes, Opers will be able to
671 # unload core modules (e.g. cmd_privmsg.so).
674 # announceinvites: This option controls which members of the channel
675 # receive an announcement when someone is INVITEd. Available values:
676 # 'none' - don't send invite announcements
677 # 'all' - send invite announcements to all members
678 # 'ops' - send invite announcements to ops and higher ranked users
679 # 'dynamic' - send invite announcements to halfops (if available) and
680 # higher ranked users. This is the recommended setting.
681 announceinvites="dynamic"
683 # hidemodes: If enabled, then the listmodes given will be hidden
684 # from users below halfop. This is not recommended to be set on +b
685 # as it may break some functionality in popular clients such as mIRC.
688 # hideulines: If this value is set to yes, U-lined servers will
689 # be hidden from non-opers in /links and /map.
692 # flatlinks: If this value is set to yes, /map and /links will
693 # be flattened when shown to non-opers.
696 # hidewhois: When defined, the given text will be used in place
697 # of the server a user is on when whoised by a non-oper. Most
698 # networks will want to set this to something like "*.netname.net"
699 # to conceal the actual server a user is on.
700 # Note that enabling this will cause users' idle times to only be
701 # shown when the format /WHOIS <nick> <nick> is used.
704 # hidebans: If this value is set to yes, when a user is banned ([gkz]lined)
705 # only opers will see the ban message when the user is removed
709 # hidekills: If defined, replaces who set a /kill with a custom string.
712 # hidesplits: If enabled, non-opers will not be able to see which
713 # servers split in a netsplit, they will only be able to see that one
714 # occurred (If their client has netsplit detection).
717 # maxtargets: Maximum number of targets per command.
718 # (Commands like /notice, /privmsg, /kick, etc)
721 # customversion: Displays a custom string when a user /version's
722 # the ircd. This may be set for security reasons or vanity reasons.
725 # operspywhois: show opers (users/auspex) the +s channels a user is in. Values:
726 # splitmsg Split with an explanatory message
727 # yes Split with no explanatory message
731 # runasuser: If this is set, InspIRCd will attempt to setuid
732 # to run as this user- allows binding of ports under 1024.
733 # NOT SUPPORTED/NEEDED UNDER WINDOWS.
736 # runasgroup: If this is set, InspIRCd will attempt to set group
737 # to run under this group, which allows binding of ports under 1024
738 # NOT SUPPORTED/NEEDED UNDER WINDOWS.
741 # restrictbannedusers: If this is set to yes, InspIRCd will not allow users
742 # banned on a channel to change nickname or message channels they are
744 restrictbannedusers="yes"
746 # genericoper: Setting this value to yes makes all opers on this server
747 # appear as 'is an IRC operator' in their WHOIS, regardless of their
748 # oper type, however oper types are still used internally. This only
749 # affects the display in WHOIS.
752 # userstats: /stats commands that users can run (opers can run all).
755 #-#-#-#-#-#-#-#-#-#-#-#-# LIMITS CONFIGURATION #-#-#-#-#-#-#-#-#-#-#-#
757 # This configuration tag defines the maximum sizes of various types #
758 # on IRC, such as the maximum length of a channel name, and the #
759 # maximum length of a channel. Note that with the exception of the #
760 # identmax value all values given here are the exact values you would #
761 # expect to see on IRC. This contrasts with the older InspIRCd #
762 # releases where these values would be one character shorter than #
763 # defined to account for a null terminator on the end of the text. #
765 # These values should match network-wide otherwise issues will occur. #
767 # The highest safe value you can set any of these options to is 500, #
768 # but it is recommended that you keep them somewhat #
769 # near their defaults (or lower). #
772 # maxnick: Maximum length of a nickname.
775 # maxchan: Maximum length of a channel name.
778 # maxmodes: Maximum number of mode changes per line.
781 # maxident: Maximum length of a ident/username.
784 # maxquit: Maximum length of a quit message.
787 # maxtopic: Maximum length of a channel topic.
790 # maxkick: Maximum length of a kick message.
793 # maxgecos: Maximum length of a GECOS (realname).
796 # maxaway: Maximum length of an away message.
800 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
804 # Logging is covered with the <log> tag, which you may use to change
805 # the behaviour of the logging of the IRCd.
807 # In InspIRCd as of 1.2, logging is pluggable and very extensible.
808 # Different files can log the same thing, different 'types' of log can
809 # go to different places, and modules can even extend the log tag
810 # to do what they want.
812 # An example log tag would be:
813 # <log method="file" type="OPER" level="default" target="opers.log">
814 # which would log all information on /oper (failed and successful) to
815 # a file called opers.log.
817 # There are many different types which may be used, and modules may
818 # generate their own. A list of useful types:
819 # - USERS - information relating to user connection and disconnection
820 # - OPER - succesful and failed oper attempts
821 # - KILL - kill related messages
822 # - snomask - server notices (*all* snomasks will be logged)
823 # - FILTER - messages related to filter matches (m_filter)
824 # - CONFIG - configuration related messages
825 # - COMMAND - die and restart messages, and messages related to unknown user types
826 # - SOCKET - socket engine informational/error messages
827 # - MODULE - module related messages
828 # - STARTUP - messages related to starting up the server
830 # You may also log *everything* by using a type of *, and subtract things out
831 # of that by using -TYPE - for example "* -USERINPUT -USEROUTPUT".
834 # - default (general messages, including errors)
835 # - sparse (misc error messages)
836 # - debug (debug messages)
838 # Some types only produce output in the debug level, those are:
839 # - BANCACHE - ban cache debug messages
840 # - CHANNELS - information relating to joining/creating channels
841 # - CULLLIST - debug messages related to issues with removing users
842 # - RESOLVER - DNS related debug messages
843 # - CONNECTCLASS - Connection class debug messages
847 # The following log tag is highly default and uncustomised. It is recommended you
848 # sort out your own log tags. This is just here so you get some output.
850 <log method="file" type="* -USERINPUT -USEROUTPUT" level="default" target="ircd.log">
852 #-#-#-#-#-#-#-#-#-#-#-#-#- WHOWAS OPTIONS -#-#-#-#-#-#-#-#-#-#-#-#-#
854 # This tag lets you define the behaviour of the /whowas command of #
859 # groupsize: Maximum entries per nick shown when performing
863 # maxgroups: Maximum number of nickgroups that can be added to
864 # the list so that /whowas does not use a lot of resources on
868 # maxkeep: Maximum time a nick is kept in the whowas list
869 # before being pruned. Time may be specified in seconds,
870 # or in the following format: 1y2w3d4h5m6s. Minimum is
874 #-#-#-#-#-#-#-#-#-#-#-#-#-#- BAN OPTIONS -#-#-#-#-#-#-#-#-#-#-#-#-#-#
876 # The ban tags define nick masks, host masks and ip ranges which are #
877 # banned from your server. All details in these tags are local to #
882 # ipmask: IP range to ban. Wildcards and CIDR can be used.
885 # reason: Reason to display when user is disconnected.
886 reason="No porn here thanks.">
889 # nick: Nick to disallow. Wildcards are supported.
892 # reason: Reason to display on /nick.
893 reason="Reserved For Services">
895 <badnick nick="NickServ" reason="Reserved For Services">
896 <badnick nick="OperServ" reason="Reserved For Services">
897 <badnick nick="MemoServ" reason="Reserved For Services">
900 # host: ident@hostname to ban.
901 # Wildcards and CIDR (if you specify an IP) can be used.
902 host="*@hundredz.n.hundredz.o.1337.kiddies.com"
904 # reason: Reason to display when user is disconnected
905 reason="Too many 1337 kiddiots">
907 <badhost host="root@*" reason="Don't irc as root!">
908 <badhost host="*@172.32.0.0/16" reason="This subnet is bad.">
910 # exception: Hosts that are exempt from [kgz]lines.
912 # host: ident@hostname to exempt.
913 # Wildcards and CIDR (if you specify an IP) can be used.
914 host="*@ircop.host.com"
916 # reason: Reason for exception. Only shown in /stats e
917 reason="Opers hostname">
919 #-#-#-#-#-#-#-#-#-#-#- INSANE BAN OPTIONS -#-#-#-#-#-#-#-#-#-#-#-#-#-#
921 # This optional tag allows you to specify how wide a gline, eline, #
922 # kline, zline or qline can be before it is forbidden from being #
923 # set. By setting hostmasks="yes", you can allow all G, K, E lines, #
924 # no matter how many users the ban would cover. This is not #
925 # recommended! By setting ipmasks="yes", you can allow all Z lines, #
926 # no matter how many users these cover too. Needless to say we #
927 # don't recommend you do this, or, set nickmasks="yes", which will #
932 # hostmasks: Allow bans with insane hostmasks. (over-reaching bans)
935 # ipmasks: Allow bans with insane ipmasks. (over-reaching bans)
938 # nickmasks: Allow bans with insane nickmasks. (over-reaching bans)
941 # trigger: What percentage of users on the network to trigger
942 # specifying an insane ban as. The default is 95.5%, which means
943 # if you have a 1000 user network, a ban will not be allowed if it
944 # will be banning 955 or more users.
948 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#- YAWN -#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
950 # You should already know what to do here :) #
952 <die value="User error. Insert new user and press any key. (you didn't edit your config properly.)">
954 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# MODULES #-#-#-#-#-#-#-#-#-#-#-#-#-#-#
955 # ____ _ _____ _ _ ____ _ _ _ #
956 # | _ \ ___ __ _ __| | |_ _| |__ (_)___ | __ )(_) |_| | #
957 # | |_) / _ \/ _` |/ _` | | | | '_ \| / __| | _ \| | __| | #
958 # | _ < __/ (_| | (_| | | | | | | | \__ \ | |_) | | |_|_| #
959 # |_| \_\___|\__,_|\__,_| |_| |_| |_|_|___/ |____/|_|\__(_) #
961 # Well done, you've reached the end of the basic configuration, your #
962 # ircd should now start if you want to try it out! (./inspircd start) #
964 # We now suggest you read and edit modules.conf, as modules are what #
965 # provide almost all the features of InspIRCd. :) #
967 # The default does nothing -- we include it for simplicity for you. #
968 <include file="conf/examples/modules.conf.example">
970 # Here are some pre-built modules.conf files that closely match the
971 # default configurations of some popular IRCd's. You still may want to
972 # look over them and make sure if everything is correct for you and setup
973 # the proper SSL information.
975 # *NOTE*: These files have no comments for what the modules do. If you
976 # are interested in that, please read the modules.conf.example. It is also
977 # recommended that you make your own modules file based on modules.conf.example.
979 # Settings similar to UnrealIRCd defaults.
980 #<include file="conf/examples/modules/unrealircd.conf.example">
982 # Settings similar to Charybdis IRCd defaults.
983 #<include file="conf/examples/modules/charybdis.conf.example">
986 #########################################################################
988 # - InspIRCd Development Team - #
989 # http://www.inspircd.org #
991 #########################################################################