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
156 # to either "gnutls" or "openssl". The appropriate SSL module must be
157 # loaded for SSL to work. If you do not want the port(s) in this bind
158 # tag to support SSL, just remove or comment out this option.
161 # defer: When this is non-zero, connections will not be handed over to
162 # the daemon from the operating system before data is ready.
163 # In Linux, the value indicates the number of seconds we'll wait for a
164 # connection to come up with data. Don't set it too low!
165 # In BSD the value is ignored; only zero and non-zero is possible.
166 # Windows ignores this parameter completely.
167 # Note: This does not take effect on rehash.
168 # To change it on a running bind, you'll have to comment it out,
169 # rehash, comment it in and rehash again.
173 <bind address="" port="6660-6669" type="clients">
175 # When linking servers, the OpenSSL and GnuTLS implementations are completely
176 # link-compatible and can be used alongside each other
177 # on each end of the link without any significant issues.
178 # Supported SSL types are: "openssl" and "gnutls".
179 # You must load the ssl_openssl module for OpenSSL or ssl_gnutls for GnuTLS.
181 <bind address="" port="7000,7001" type="servers">
182 <bind address="1.2.3.4" port="7005" type="servers" ssl="openssl">
185 #-#-#-#-#-#-#-#-#-#- DIE/RESTART CONFIGURATION -#-#-#-#-#-#-#-#-#-#-
187 # You can configure the passwords here which you wish to use for #
188 # the /DIE and /RESTART commands. Only trusted ircops who will #
189 # need this ability should know the die and restart password. #
193 # hash: what hash these passwords are hashed with.
194 # Requires the module for selected hash (md5, sha256, or
195 # ripemd160) be loaded and the password hashing module
196 # (password_hash) loaded.
197 # Options here are: "md5", "sha256" and "ripemd160", or one of
198 # these prefixed with "hmac-", e.g.: "hmac-sha256".
199 # Optional, but recommended. Create hashed passwords with:
200 # /mkpasswd <hash> <password>
203 # diepass: Password for opers to use if they need to shutdown (die)
207 # restartpass: Password for opers to use if they need to restart
212 #-#-#-#-#-#-#-#-#-#- CONNECTIONS CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
214 # This is where you can configure which connections are allowed #
215 # and denied access onto your server. The password is optional. #
216 # You may have as many of these as you require. To allow/deny all #
217 # connections, use a '*' or 0.0.0.0/0. #
219 # -- It is important to note that connect tags are read from the -- #
220 # TOP DOWN. This means that you should have more specific deny #
221 # and allow tags at the top, progressively more general, followed #
222 # by a <connect allow="*" (should you wish to have one). #
224 # Connect blocks are searched twice for each user - once when the TCP #
225 # connection is accepted, and once when the user completes their #
226 # registration. Most of the information (hostname, ident response, #
227 # password, SSL when using STARTTLS, etc) is only available during #
228 # the second search, so if you are trying to make a closed server, #
229 # you will probably need a connect block just for user registration. #
230 # This can be done by using <connect registered="no"> #
233 # deny: Will not let people connect if they have specified host/IP.
236 # connect:reason is the message that users will see if they match a deny block
237 <connect deny="3ffe::0/32" reason="The 6bone address space is deprecated">
240 # name: Name to use for this connect block. Mainly used for
241 # connect class inheriting.
244 # parent: This setting is to specify if this connect class
245 # inherits settings from any other. Put the other class's name
246 # in here to use its settings as a template - for example, if
247 # you only want to adjust sendq and a password
250 # allow: What IP addresses/hosts to allow for this block.
253 # hash: what hash this password is hashed with. requires the module
254 # for selected hash (md5, sha256 or ripemd160) be loaded and the
255 # password hashing module (password_hash) loaded.
256 # Optional, but recommended. Create hashed passwords with:
257 # /mkpasswd <hash> <password>
260 # password: Password to use for this block/user(s)
263 # maxchans: Maximum number of channels a user in this class
267 # timeout: How long (in seconds) the server will wait before
268 # disconnecting a user if they do not do anything on connect.
269 # (Note, this is a client-side thing, if the client does not
270 # send /nick, /user or /pass)
273 # localmax: Maximum local connections per IP (or CIDR mask, see below).
276 # globalmax: Maximum global (network-wide) connections per IP (or CIDR mask, see below).
279 # maxconnwarn: Enable warnings when localmax or globalmax are reached (defaults to on)
282 # resolvehostnames: If disabled, no DNS lookups will be performed on connecting users
283 # in this class. This can save a lot of resources on very busy servers.
284 resolvehostnames="yes"
286 # usednsbl: Defines whether or not users in this class are subject to DNSBL. Default is yes.
287 # This setting only has effect when the dnsbl module is loaded.
290 # useident: Defines if users in this class MUST respond to a ident query or not.
293 # limit: How many users are allowed in this class
296 # modes: Usermodes that are set on users in this block on connect.
297 # Enabling this option requires that the conn_umodes module be loaded.
298 # This entry is highly recommended to use for/with IP Cloaking/masking.
299 # For the example to work, this also requires that the "cloaking"
300 # module be loaded as well.
303 # requireident, requiressl, requireaccount: require that users of this
304 # block have a valid ident response, use SSL, or have authenticated.
305 # Requires ident, sslinfo, or the services_account module, respectively.
307 # NOTE: For requireaccount, you must complete the signon prior to full
308 # connection. Currently, this is only possible by using SASL
309 # authentication; passforward and PRIVMSG NickServ happen after
310 # your final connect block has been found.
312 # Alternate MOTD file for this connect class. The contents of this file are
313 # specified using <files secretmotd="filename"> or <execfiles ...>
316 # Allow color codes to be processed in the message of the day file.
317 # the following characters are valid color code escapes:
319 # \037 or \u = Underline
320 # \003 or \c = Color (with a code postfixed to this char)
321 # \017 or \x = Stop all color sequences
322 allowmotdcolors="false"
324 # port: What port this user is allowed to connect on. (optional)
325 # The port MUST be set to listen in the bind blocks above.
329 # name: Name to use for this connect block. Mainly used for
330 # connect class inheriting.
333 # allow: What IP addresses/hosts to allow for this block.
336 # maxchans: Maximum number of channels a user in this class
340 # timeout: How long (in seconds) the server will wait before
341 # disconnecting a user if they do not do anything on connect.
342 # (Note, this is a client-side thing, if the client does not
343 # send /nick, /user or /pass)
346 # pingfreq: How often (in seconds) the server tries to ping connecting clients.
349 # hardsendq: maximum amount of data allowed in a client's send queue
350 # before they are dropped. Keep this value higher than the length of
351 # your network's /LIST or /WHO output, or you will have lots of
352 # disconnects from sendq overruns!
353 # Setting this to "1M" is equivalent to "1048576", "8K" is 8192, etc.
356 # softsendq: amount of data in a client's send queue before the server
357 # begins delaying their commands in order to allow the sendq to drain
360 # recvq: amount of data allowed in a client's queue before they are dropped.
361 # Entering "8K" is equivalent to "8192", see above.
364 # threshold: This specifies the amount of command penalty a user is allowed to have
365 # before being quit or fakelagged due to flood. Normal commands have a penalty of 1,
366 # ones such as /OPER have penalties up to 10.
368 # If you are not using fakelag, this should be at least 20 to avoid excess flood kills
369 # from processing some commands.
372 # commandrate: This specifies the maximum rate that commands can be processed.
373 # If commands are sent more rapidly, the user's penalty will increase and they will
374 # either be fakelagged or killed when they reach the threshold
376 # Units are millicommands per second, so 1000 means one line per second.
379 # fakelag: Use fakelag instead of killing users for excessive flood
381 # Fake lag stops command processing for a user when a flood is detected rather than
382 # immediately killing them; their commands are held in the recvq and processed later
383 # as the user's command penalty drops. Note that if this is enabled, flooders will
384 # quit with "RecvQ exceeded" rather than "Excess Flood".
387 # localmax: Maximum local connections per IP.
390 # globalmax: Maximum global (network-wide) connections per IP.
393 # resolvehostnames: If disabled, no DNS lookups will be performed on connecting users
394 # in this class. This can save a lot of resources on very busy servers.
395 resolvehostnames="yes"
397 # useident: Defines if users in this class must respond to a ident query or not.
400 # limit: How many users are allowed in this class
403 # modes: Usermodes that are set on users in this block on connect.
404 # Enabling this option requires that the conn_umodes module be loaded.
405 # This entry is highly recommended to use for/with IP Cloaking/masking.
406 # For the example to work, this also requires that the cloaking
407 # module be loaded as well.
411 #-#-#-#-#-#-#-#-#-#-#-#- CIDR CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-
413 # CIDR configuration allows detection of clones and applying of #
414 # throttle limits across a CIDR range. (A CIDR range is a group of #
415 # IPs, for example, the CIDR range 192.168.1.0-192.168.1.255 may be #
416 # represented as 192.168.1.0/24). This means that abuse across an ISP #
417 # is detected and curtailed much easier. Here is a good chart that #
418 # shows how many IPs the different CIDRs correspond to: #
419 # http://en.wikipedia.org/wiki/CIDR#Prefix_aggregation #
423 # ipv4clone: 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-32).
429 # ipv6clone: specifies how many bits of an IP address should be
430 # looked at for clones. The default only looks for clones on a
431 # single IP address of a user. You do not want to set this
432 # extremely low. (Values are 0-128).
435 # This file has all the information about oper classes, types and o:lines.
436 # You *MUST* edit it.
437 <include file="examples/opers.conf.example">
439 # This file has all the information about server links and ulined servers.
440 # You *MUST* edit it if you intend to link servers.
441 <include file="examples/links.conf.example">
443 #-#-#-#-#-#-#-#-#-#- MISCELLANEOUS CONFIGURATION -#-#-#-#-#-#-#-#-#-#
446 # Files block - contains files whose contents are used by the ircd
448 # motd - displayed on connect and when a user executes /MOTD
449 # Modules can also define their own files
450 <files motd="examples/motd.txt.example">
452 # Example of an executable file include. Note this will be read on rehash,
453 # not when the command is run.
454 #<execfiles motd="wget -O - http://www.example.com/motd.txt">
456 #-#-#-#-#-#-#-#-#-#-#-#-#-#-# DNS SERVER -#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
457 # If these values are not defined, InspIRCd uses the default DNS resolver
461 # server: DNS server to use to attempt to resolve IP's to hostnames.
462 # in most cases, you won't need to change this, as inspircd will
463 # automatically detect the nameserver depending on /etc/resolv.conf
464 # (or, on Windows, your set nameservers in the registry.)
465 # Note that this must be an IP address and not a hostname, because
466 # there is no resolver to resolve the name until this is defined!
470 # timeout: seconds to wait to try to resolve DNS/hostname.
473 # An example of using an IPv6 nameserver
474 #<dns server="::1" timeout="5">
476 #-#-#-#-#-#-#-#-#-#-#-#-#-#-# PID FILE -#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
478 # Define the path to the PID file here. The PID file can be used to #
479 # rehash the ircd from the shell or to terminate the ircd from the #
480 # shell using shell scripts, perl scripts, etc... and to monitor the #
481 # ircd's state via cron jobs. If this is a relative path, it will be #
482 # relative to the configuration directory, and if it is not defined, #
483 # the default of 'inspircd.pid' is used. #
486 #<pid file="/path/to/inspircd.pid">
488 #-#-#-#-#-#-#-#-#-#-#-#-#- BANLIST LIMITS #-#-#-#-#-#-#-#-#-#-#-#-#-#-#
490 # Use these tags to customise the ban limits on a per channel basis. #
491 # The tags are read from top to bottom, and any tag found which #
492 # matches the channels name applies the banlimit to that channel. #
493 # It is advisable to put an entry with the channel as '*' at the #
494 # bottom of the list. If none are specified or no maxbans tag is #
495 # matched, the banlist size defaults to 64 entries. #
498 <banlist chan="#largechan" limit="128">
499 <banlist chan="*" limit="69">
501 #-#-#-#-#-#-#-#-#-#-#- DISABLED FEATURES -#-#-#-#-#-#-#-#-#-#-#-#-#-#
503 # This tag is optional, and specifies one or more features which are #
504 # not available to non-operators. #
506 # For example you may wish to disable NICK and prevent non-opers from #
507 # changing their nicknames. #
508 # Note that any disabled commands take effect only after the user has #
509 # 'registered' (e.g. after the initial USER/NICK/PASS on connection) #
510 # so for example disabling NICK will not cripple your network. #
512 # You can also define if you want to disable any channelmodes #
513 # or usermodes from your users. #
515 # `fakenonexistant' will make the ircd pretend that nonexistant #
516 # commands simply don't exist to non-opers ("no such command"). #
518 #<disabled commands="TOPIC MODE" usermodes="" chanmodes="" fakenonexistant="yes">
521 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#- RTFM LINE -#-#-#-#-#-#-#-#-#-#-#-#-#-#
523 # Just remove this... Its here to make you read ALL of the config #
526 <die value="You should probably edit your config *PROPERLY* and try again.">
530 #-#-#-#-#-#-#-#-#-#-#-#-#- SERVER OPTIONS -#-#-#-#-#-#-#-#-#-#-#-#-#
532 # Settings to define which features are usable on your server. #
536 # prefixquit: What (if anything) users' quit messages
537 # should be prefixed with.
540 # suffixquit: What (if anything) users' quit messages
541 # should be suffixed with.
544 # prefixpart: What (if anything) users' part messages
545 # should be prefixed with.
547 # NOTE: Use "\"" instead of """ if not using <config format="xml">
549 # suffixpart: What (if anything) users' part message
550 # should be suffixed with.
553 # fixedquit: Set all users' quit messages to this value.
556 # fixedpart: Set all users' part messages in all channels
560 # syntaxhints: If enabled, if a user fails to send the correct parameters
561 # for a command, the ircd will give back some help text of what
562 # the correct parameters are.
565 # cyclehostsfromuser: If enabled, the source of the mode change for
566 # cyclehosts will be the user who cycled. This can look nicer, but
567 # triggers anti-takeover mechanisms of some obsolete bots.
568 cyclehostsfromuser="no"
570 # ircumsgprefix: Use undernet-style message prefixing for NOTICE and
571 # PRIVMSG. If enabled, it will add users' prefix to the line, if not,
572 # it will just message the user normally.
575 # announcets: If set to yes, when the timestamp on a channel changes, all users
576 # in the channel will be sent a NOTICE about it.
579 # allowmismatch: Setting this option to yes will allow servers to link even
580 # if they don't have the same "optionally common" modules loaded. Setting this to
581 # yes may introduce some desyncs and unwanted behaviour.
584 # defaultbind: Sets the default for <bind> tags without an address. Choices are
585 # ipv4 or ipv6; if not specified, IPv6 will be used if your system has support,
586 # falling back to IPv4 otherwise.
589 # hostintopic: If enabled, channels will show the host of the topic setter
590 # in the topic. If set to no, it will only show the nick of the topic setter.
593 # pingwarning: If a server does not respond to a ping within x seconds,
594 # it will send a notice to opers with snomask +l informing that the server
595 # is about to ping timeout.
598 # serverpingfreq: How often pings are sent between servers (in seconds).
601 # defaultmodes: What modes are set on a empty channel when a user
602 # joins it and it is unregistered.
605 # xlinemessage: This is the text that is sent to a user when they are
606 # banned from the server.
607 xlinemessage="You're banned! Email irc@example.com with the ERROR line below for help."
609 # exemptchanops: exemptions for channel access restrictions based on prefix.
610 exemptchanops="nonick:v flood:o"
612 # invitebypassmodes: This allows /invite to bypass other channel modes.
613 # (Such as +k, +j, +l, etc.)
614 invitebypassmodes="yes"
616 # nosnoticestack: This prevents snotices from 'stacking' and giving you
617 # the message saying '(last message repeated X times)'. Defaults to no.
621 #-#-#-#-#-#-#-#-#-#-#-# PERFORMANCE CONFIGURATION #-#-#-#-#-#-#-#-#-#-#
625 # netbuffersize: Size of the buffer used to receive data from clients.
626 # The ircd may only read this amount of text in 1 go at any time.
627 netbuffersize="10240"
629 # somaxconn: The maximum number of connections that may be waiting
630 # in the accept queue. This is *NOT* the total maximum number of
631 # connections per server. Some systems may only allow this to be up
632 # to 5, while others (such as Linux and *BSD) default to 128.
633 # Setting this above the limit imposed by your OS can have undesired
637 # softlimit: This optional feature allows a defined softlimit for
638 # connections. If defined, it sets a soft max connections value.
641 # clonesonconnect: If this is set to false, we won't check for clones
642 # on initial connection, but only after the DNS check is done.
643 # This can be useful where your main class is more restrictive
644 # than some other class a user can be assigned after DNS lookup is complete.
645 # Turning this option off will make the server spend more time on users we may
646 # potentially not want. Normally this should be neglible, though.
647 # Default value is true
648 clonesonconnect="true"
650 # quietbursts: When syncing or splitting from a network, a server
651 # can generate a lot of connect and quit messages to opers with
652 # +C and +Q snomasks. Setting this to yes squelches those messages,
653 # which makes it easier for opers, but degrades the functionality of
654 # bots like BOPM during netsplits.
657 #-#-#-#-#-#-#-#-#-#-#-# SECURITY CONFIGURATION #-#-#-#-#-#-#-#-#-#-#-#
661 # allowcoreunload: If this value is set to yes, Opers will be able to
662 # unload core modules (e.g. cmd_privmsg.so).
665 # announceinvites: This option controls which members of the channel
666 # receive an announcement when someone is INVITEd. Available values:
667 # 'none' - don't send invite announcements
668 # 'all' - send invite announcements to all members
669 # 'ops' - send invite announcements to ops and higher ranked users
670 # 'dynamic' - send invite announcements to halfops (if available) and
671 # higher ranked users. This is the recommended setting.
672 announceinvites="dynamic"
674 # hideulines: If this value is set to yes, U-lined servers will
675 # be hidden from non-opers in /links and /map.
678 # flatlinks: If this value is set to yes, /map and /links will
679 # be flattened when shown to non-opers.
682 # hidewhois: When defined, the given text will be used in place
683 # of the server a user is on when whoised by a non-oper. Most
684 # networks will want to set this to something like "*.netname.net"
685 # to conceal the actual server a user is on.
686 # Note that enabling this will cause users' idle times to only be
687 # shown when the format /WHOIS <nick> <nick> is used.
690 # hidebans: If this value is set to yes, when a user is banned ([gkz]lined)
691 # only opers will see the ban message when the user is removed
695 # hidekills: If defined, replaces who set a /kill with a custom string.
698 # hidesplits: If enabled, non-opers will not be able to see which
699 # servers split in a netsplit, they will only be able to see that one
700 # occurred (If their client has netsplit detection).
703 # maxtargets: Maximum number of targets per command.
704 # (Commands like /notice, /privmsg, /kick, etc)
707 # customversion: A custom message to be displayed in the comments field
708 # of the VERSION command response. This does not hide the InspIRCd version.
711 # operspywhois: show opers (users/auspex) the +s channels a user is in. Values:
712 # splitmsg Split with an explanatory message
713 # yes Split with no explanatory message
717 # runasuser: If this is set, InspIRCd will attempt to switch
718 # to run as this user, which allows binding of ports under 1024.
719 # You should NOT set this unless you are starting as root.
720 # NOT SUPPORTED/NEEDED UNDER WINDOWS.
723 # runasgroup: If this is set, InspIRCd will attempt to switch
724 # to run as this group, which allows binding of ports under 1024.
725 # You should NOT set this unless you are starting as root.
726 # NOT SUPPORTED/NEEDED UNDER WINDOWS.
729 # restrictbannedusers: If this is set to yes, InspIRCd will not allow users
730 # banned on a channel to change nickname or message channels they are
732 restrictbannedusers="yes"
734 # genericoper: Setting this value to yes makes all opers on this server
735 # appear as 'is an IRC operator' in their WHOIS, regardless of their
736 # oper type, however oper types are still used internally. This only
737 # affects the display in WHOIS.
740 # userstats: /stats commands that users can run (opers can run all).
743 #-#-#-#-#-#-#-#-#-#-#-#-# LIMITS CONFIGURATION #-#-#-#-#-#-#-#-#-#-#-#
745 # This configuration tag defines the maximum sizes of various types #
746 # on IRC, such as the maximum length of a channel name, and the #
747 # maximum length of a channel. Note that with the exception of the #
748 # identmax value all values given here are the exact values you would #
749 # expect to see on IRC. This contrasts with the older InspIRCd #
750 # releases where these values would be one character shorter than #
751 # defined to account for a null terminator on the end of the text. #
753 # These values should match network-wide otherwise issues will occur. #
755 # The highest safe value you can set any of these options to is 500, #
756 # but it is recommended that you keep them somewhat #
757 # near their defaults (or lower). #
760 # maxnick: Maximum length of a nickname.
763 # maxchan: Maximum length of a channel name.
766 # maxmodes: Maximum number of mode changes per line.
769 # maxident: Maximum length of a ident/username.
772 # maxhost: Maximum length of a hostname.
775 # maxquit: Maximum length of a quit message.
778 # maxtopic: Maximum length of a channel topic.
781 # maxkick: Maximum length of a kick message.
784 # maxgecos: Maximum length of a GECOS (realname).
787 # maxaway: Maximum length of an away message.
790 #-#-#-#-#-#-#-#-#-#-#-#-# PATHS CONFIGURATION #-#-#-#-#-#-#-#-#-#-#-#-#
792 # This configuration tag defines the location that InspIRCd stores #
793 # various types of files such as configuration files, log files and #
794 # modules. You will probably not need to change these from the values #
795 # set when InspIRCd was built unless you are using a binary package #
796 # where you do not have the ability to set build time configuration. #
797 #<path configdir="conf" datadir="data" logdir="logs" moduledir="modules">
799 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
803 # Logging is covered with the <log> tag, which you may use to change
804 # the behaviour of the logging of the IRCd.
806 # In InspIRCd as of 1.2, logging is pluggable and very extensible.
807 # Different files can log the same thing, different 'types' of log can
808 # go to different places, and modules can even extend the log tag
809 # to do what they want.
811 # An example log tag would be:
812 # <log method="file" type="OPER" level="default" target="opers.log">
813 # which would log all information on /oper (failed and successful) to
814 # a file called opers.log.
816 # There are many different types which may be used, and modules may
817 # generate their own. A list of useful types:
818 # - USERS - information relating to user connection and disconnection
819 # - OPER - succesful and failed oper attempts
820 # - KILL - kill related messages
821 # - snomask - server notices (*all* snomasks will be logged)
822 # - FILTER - messages related to filter matches (filter module)
823 # - CONFIG - configuration related messages
824 # - COMMAND - die and restart messages, and messages related to unknown user types
825 # - SOCKET - socket engine informational/error messages
826 # - MODULE - module related messages
827 # - STARTUP - messages related to starting up the server
829 # You may also log *everything* by using a type of *, and subtract things out
830 # of that by using -TYPE - for example "* -USERINPUT -USEROUTPUT".
833 # - default (general messages, including errors)
834 # - sparse (misc error messages)
835 # - debug (debug messages)
837 # Some types only produce output in the debug level, those are:
838 # - BANCACHE - ban cache debug messages
839 # - CHANNELS - information relating to joining/creating channels
840 # - CULLLIST - debug messages related to issues with removing users
841 # - RESOLVER - DNS related debug messages
842 # - CONNECTCLASS - Connection class debug messages
846 # The following log tag is highly default and uncustomised. It is recommended you
847 # sort out your own log tags. This is just here so you get some output.
849 <log method="file" type="* -USERINPUT -USEROUTPUT" level="default" target="ircd.log">
851 #-#-#-#-#-#-#-#-#-#-#-#-#- WHOWAS OPTIONS -#-#-#-#-#-#-#-#-#-#-#-#-#
853 # This tag lets you define the behaviour of the /whowas command of #
858 # groupsize: Maximum entries per nick shown when performing
862 # maxgroups: Maximum number of nickgroups that can be added to
863 # the list so that /whowas does not use a lot of resources on
867 # maxkeep: Maximum time a nick is kept in the whowas list
868 # before being pruned. Time may be specified in seconds,
869 # or in the following format: 1y2w3d4h5m6s. Minimum is
873 #-#-#-#-#-#-#-#-#-#-#-#-#-#- BAN OPTIONS -#-#-#-#-#-#-#-#-#-#-#-#-#-#
875 # The ban tags define nick masks, host masks and ip ranges which are #
876 # banned from your server. All details in these tags are local to #
881 # ipmask: IP range to ban. Wildcards and CIDR can be used.
884 # reason: Reason to display when user is disconnected.
885 reason="No porn here thanks.">
888 # nick: Nick to disallow. Wildcards are supported.
891 # reason: Reason to display on /nick.
892 reason="Reserved For Services">
894 <badnick nick="NickServ" reason="Reserved For Services">
895 <badnick nick="OperServ" reason="Reserved For Services">
896 <badnick nick="MemoServ" reason="Reserved For Services">
899 # host: ident@hostname to ban.
900 # Wildcards and CIDR (if you specify an IP) can be used.
901 host="*@banneduser.example.net"
903 # reason: Reason to display when user is disconnected
904 reason="Evading Bans">
906 <badhost host="root@*" reason="Don't IRC as root!">
907 <badhost host="*@198.51.100.0/24" reason="This subnet is bad.">
909 # exception: Hosts that are exempt from [kgz]lines.
911 # host: ident@hostname to exempt.
912 # Wildcards and CIDR (if you specify an IP) can be used.
913 host="*@ircop.example.com"
915 # reason: Reason for exception. Only shown in /stats e
916 reason="Oper's hostname">
918 #-#-#-#-#-#-#-#-#-#-#- INSANE BAN OPTIONS -#-#-#-#-#-#-#-#-#-#-#-#-#-#
920 # This optional tag allows you to specify how wide a gline, eline, #
921 # kline, zline or qline can be before it is forbidden from being #
922 # set. By setting hostmasks="yes", you can allow all G, K, E lines, #
923 # no matter how many users the ban would cover. This is not #
924 # recommended! By setting ipmasks="yes", you can allow all Z lines, #
925 # no matter how many users these cover too. Needless to say we #
926 # don't recommend you do this, or, set nickmasks="yes", which will #
931 # hostmasks: Allow bans with insane hostmasks. (over-reaching bans)
934 # ipmasks: Allow bans with insane ipmasks. (over-reaching bans)
937 # nickmasks: Allow bans with insane nickmasks. (over-reaching bans)
940 # trigger: What percentage of users on the network to trigger
941 # specifying an insane ban as. The default is 95.5%, which means
942 # if you have a 1000 user network, a ban will not be allowed if it
943 # will be banning 955 or more users.
947 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#- YAWN -#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
949 # You should already know what to do here :) #
951 <die value="User error. You didn't edit your config properly. Go back and try again.">
953 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# MODULES #-#-#-#-#-#-#-#-#-#-#-#-#-#-#
954 # ____ _ _____ _ _ ____ _ _ _ #
955 # | _ \ ___ __ _ __| | |_ _| |__ (_)___ | __ )(_) |_| | #
956 # | |_) / _ \/ _` |/ _` | | | | '_ \| / __| | _ \| | __| | #
957 # | _ < __/ (_| | (_| | | | | | | | \__ \ | |_) | | |_|_| #
958 # |_| \_\___|\__,_|\__,_| |_| |_| |_|_|___/ |____/|_|\__(_) #
960 # Well done, you've reached the end of the basic configuration, your #
961 # ircd should now start if you want to try it out! (./inspircd start) #
963 # We now suggest you read and edit modules.conf, as modules are what #
964 # provide almost all the features of InspIRCd. :) #
966 # The default does nothing -- we include it for simplicity for you. #
967 <include file="examples/modules.conf.example">
969 # Here are some pre-built modules.conf files that closely match the
970 # default configurations of some popular IRCd's. You still may want to
971 # look over them and make sure if everything is correct for you and setup
972 # the proper SSL information.
974 # *NOTE*: These files have no comments for what the modules do. If you
975 # are interested in that, please read the modules.conf.example. It is also
976 # recommended that you make your own modules file based on modules.conf.example.
978 # Settings similar to UnrealIRCd defaults.
979 #<include file="examples/modules/unrealircd.conf.example">
981 # Settings similar to Charybdis IRCd defaults.
982 #<include file="examples/modules/charybdis.conf.example">
985 #########################################################################
987 # - InspIRCd Development Team - #
988 # http://www.inspircd.org #
990 #########################################################################