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 # Listener accepting HTML5 WebSocket connections.
176 # Requires the websocket module and SHA-1 hashing support (provided by the sha1
178 #<bind address="" port="7002" type="clients" hook="websocket">
180 # When linking servers, the OpenSSL and GnuTLS implementations are completely
181 # link-compatible and can be used alongside each other
182 # on each end of the link without any significant issues.
183 # Supported SSL types are: "openssl" and "gnutls".
184 # You must load the ssl_openssl module for OpenSSL or ssl_gnutls for GnuTLS.
186 <bind address="" port="7000,7001" type="servers">
187 <bind address="1.2.3.4" port="7005" type="servers" ssl="openssl">
190 #-#-#-#-#-#-#-#-#-#- CONNECTIONS CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
192 # This is where you can configure which connections are allowed #
193 # and denied access onto your server. The password is optional. #
194 # You may have as many of these as you require. To allow/deny all #
195 # connections, use a '*' or 0.0.0.0/0. #
197 # -- It is important to note that connect tags are read from the -- #
198 # TOP DOWN. This means that you should have more specific deny #
199 # and allow tags at the top, progressively more general, followed #
200 # by a <connect allow="*" (should you wish to have one). #
202 # Connect blocks are searched twice for each user - once when the TCP #
203 # connection is accepted, and once when the user completes their #
204 # registration. Most of the information (hostname, ident response, #
205 # password, SSL when using STARTTLS, etc) is only available during #
206 # the second search, so if you are trying to make a closed server, #
207 # you will probably need a connect block just for user registration. #
208 # This can be done by using <connect registered="no"> #
211 # deny: Will not let people connect if they have specified host/IP.
214 # connect:reason is the message that users will see if they match a deny block
215 <connect deny="3ffe::0/32" reason="The 6bone address space is deprecated">
218 # name: Name to use for this connect block. Mainly used for
219 # connect class inheriting.
222 # parent: This setting is to specify if this connect class
223 # inherits settings from any other. Put the other class's name
224 # in here to use its settings as a template - for example, if
225 # you only want to adjust sendq and a password
228 # allow: What IP addresses/hosts to allow for this block.
231 # hash: what hash this password is hashed with. requires the module
232 # for selected hash (md5, sha256 or ripemd160) be loaded and the
233 # password hashing module (password_hash) loaded.
234 # Optional, but recommended. Create hashed passwords with:
235 # /mkpasswd <hash> <password>
238 # password: Password to use for this block/user(s)
241 # maxchans: Maximum number of channels a user in this class
245 # timeout: How long (in seconds) the server will wait before
246 # disconnecting a user if they do not do anything on connect.
247 # (Note, this is a client-side thing, if the client does not
248 # send /nick, /user or /pass)
251 # localmax: Maximum local connections per IP (or CIDR mask, see below).
254 # globalmax: Maximum global (network-wide) connections per IP (or CIDR mask, see below).
257 # maxconnwarn: Enable warnings when localmax or globalmax are reached (defaults to on)
260 # resolvehostnames: If disabled, no DNS lookups will be performed on connecting users
261 # in this class. This can save a lot of resources on very busy servers.
262 resolvehostnames="yes"
264 # usednsbl: Defines whether or not users in this class are subject to DNSBL. Default is yes.
265 # This setting only has effect when the dnsbl module is loaded.
268 # useident: Defines if users in this class MUST respond to a ident query or not.
271 # limit: How many users are allowed in this class
274 # modes: Usermodes that are set on users in this block on connect.
275 # Enabling this option requires that the conn_umodes module be loaded.
276 # This entry is highly recommended to use for/with IP Cloaking/masking.
277 # For the example to work, this also requires that the "cloaking"
278 # module be loaded as well.
281 # requireident, requiressl, requireaccount: require that users of this
282 # block have a valid ident response, use SSL, or have authenticated.
283 # Requires ident, sslinfo, or the services_account module, respectively.
285 # NOTE: For requireaccount, you must complete the signon prior to full
286 # connection. Currently, this is only possible by using SASL
287 # authentication; passforward and PRIVMSG NickServ happen after
288 # your final connect block has been found.
290 # Alternate MOTD file for this connect class. The contents of this file are
291 # specified using <files secretmotd="filename"> or <execfiles ...>
294 # Allow color codes to be processed in the message of the day file.
295 # the following characters are valid color code escapes:
297 # \037 or \u = Underline
298 # \003 or \c = Color (with a code postfixed to this char)
299 # \017 or \x = Stop all color sequences
300 allowmotdcolors="false"
302 # port: What port this user is allowed to connect on. (optional)
303 # The port MUST be set to listen in the bind blocks above.
307 # name: Name to use for this connect block. Mainly used for
308 # connect class inheriting.
311 # allow: What IP addresses/hosts to allow for this block.
314 # maxchans: Maximum number of channels a user in this class
318 # timeout: How long (in seconds) the server will wait before
319 # disconnecting a user if they do not do anything on connect.
320 # (Note, this is a client-side thing, if the client does not
321 # send /nick, /user or /pass)
324 # pingfreq: How often (in seconds) the server tries to ping connecting clients.
327 # hardsendq: maximum amount of data allowed in a client's send queue
328 # before they are dropped. Keep this value higher than the length of
329 # your network's /LIST or /WHO output, or you will have lots of
330 # disconnects from sendq overruns!
331 # Setting this to "1M" is equivalent to "1048576", "8K" is 8192, etc.
334 # softsendq: amount of data in a client's send queue before the server
335 # begins delaying their commands in order to allow the sendq to drain
338 # recvq: amount of data allowed in a client's queue before they are dropped.
339 # Entering "8K" is equivalent to "8192", see above.
342 # threshold: This specifies the amount of command penalty a user is allowed to have
343 # before being quit or fakelagged due to flood. Normal commands have a penalty of 1,
344 # ones such as /OPER have penalties up to 10.
346 # If you are not using fakelag, this should be at least 20 to avoid excess flood kills
347 # from processing some commands.
350 # commandrate: This specifies the maximum rate that commands can be processed.
351 # If commands are sent more rapidly, the user's penalty will increase and they will
352 # either be fakelagged or killed when they reach the threshold
354 # Units are millicommands per second, so 1000 means one line per second.
357 # fakelag: Use fakelag instead of killing users for excessive flood
359 # Fake lag stops command processing for a user when a flood is detected rather than
360 # immediately killing them; their commands are held in the recvq and processed later
361 # as the user's command penalty drops. Note that if this is enabled, flooders will
362 # quit with "RecvQ exceeded" rather than "Excess Flood".
365 # localmax: Maximum local connections per IP.
368 # globalmax: Maximum global (network-wide) connections per IP.
371 # resolvehostnames: If disabled, no DNS lookups will be performed on connecting users
372 # in this class. This can save a lot of resources on very busy servers.
373 resolvehostnames="yes"
375 # useident: Defines if users in this class must respond to a ident query or not.
378 # limit: How many users are allowed in this class
381 # modes: Usermodes that are set on users in this block on connect.
382 # Enabling this option requires that the conn_umodes module be loaded.
383 # This entry is highly recommended to use for/with IP Cloaking/masking.
384 # For the example to work, this also requires that the cloaking
385 # module be loaded as well.
389 #-#-#-#-#-#-#-#-#-#-#-#- CIDR CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-
391 # CIDR configuration allows detection of clones and applying of #
392 # throttle limits across a CIDR range. (A CIDR range is a group of #
393 # IPs, for example, the CIDR range 192.168.1.0-192.168.1.255 may be #
394 # represented as 192.168.1.0/24). This means that abuse across an ISP #
395 # is detected and curtailed much easier. Here is a good chart that #
396 # shows how many IPs the different CIDRs correspond to: #
397 # http://en.wikipedia.org/wiki/CIDR#Prefix_aggregation #
401 # ipv4clone: specifies how many bits of an IP address should be
402 # looked at for clones. The default only looks for clones on a
403 # single IP address of a user. You do not want to set this
404 # extremely low. (Values are 0-32).
407 # ipv6clone: specifies how many bits of an IP address should be
408 # looked at for clones. The default only looks for clones on a
409 # single IP address of a user. You do not want to set this
410 # extremely low. (Values are 0-128).
413 # This file has all the information about oper classes, types and o:lines.
414 # You *MUST* edit it.
415 <include file="examples/opers.conf.example">
417 # This file has all the information about server links and ulined servers.
418 # You *MUST* edit it if you intend to link servers.
419 <include file="examples/links.conf.example">
421 #-#-#-#-#-#-#-#-#-#- MISCELLANEOUS CONFIGURATION -#-#-#-#-#-#-#-#-#-#
424 # Files block - contains files whose contents are used by the ircd
426 # motd - displayed on connect and when a user executes /MOTD
427 # Modules can also define their own files
428 <files motd="examples/motd.txt.example">
430 # Example of an executable file include. Note this will be read on rehash,
431 # not when the command is run.
432 #<execfiles motd="wget -O - http://www.example.com/motd.txt">
434 #-#-#-#-#-#-#-#-#-#-#-#-#-#-# DNS SERVER -#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
435 # If these values are not defined, InspIRCd uses the default DNS resolver
439 # server: DNS server to use to attempt to resolve IP's to hostnames.
440 # in most cases, you won't need to change this, as inspircd will
441 # automatically detect the nameserver depending on /etc/resolv.conf
442 # (or, on Windows, your set nameservers in the registry.)
443 # Note that this must be an IP address and not a hostname, because
444 # there is no resolver to resolve the name until this is defined!
448 # timeout: seconds to wait to try to resolve DNS/hostname.
451 # An example of using an IPv6 nameserver
452 #<dns server="::1" timeout="5">
454 #-#-#-#-#-#-#-#-#-#-#-#-#-#-# PID FILE -#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
456 # Define the path to the PID file here. The PID file can be used to #
457 # rehash the ircd from the shell or to terminate the ircd from the #
458 # shell using shell scripts, perl scripts, etc... and to monitor the #
459 # ircd's state via cron jobs. If this is a relative path, it will be #
460 # relative to the configuration directory, and if it is not defined, #
461 # the default of 'inspircd.pid' is used. #
464 #<pid file="/path/to/inspircd.pid">
466 #-#-#-#-#-#-#-#-#-#-#-#-#- BANLIST LIMITS #-#-#-#-#-#-#-#-#-#-#-#-#-#-#
468 # Use these tags to customise the ban limits on a per channel basis. #
469 # The tags are read from top to bottom, and any tag found which #
470 # matches the channels name applies the banlimit to that channel. #
471 # It is advisable to put an entry with the channel as '*' at the #
472 # bottom of the list. If none are specified or no maxbans tag is #
473 # matched, the banlist size defaults to 64 entries. #
476 <banlist chan="#largechan" limit="128">
477 <banlist chan="*" limit="69">
479 #-#-#-#-#-#-#-#-#-#-#- DISABLED FEATURES -#-#-#-#-#-#-#-#-#-#-#-#-#-#
481 # This tag is optional, and specifies one or more features which are #
482 # not available to non-operators. #
484 # For example you may wish to disable NICK and prevent non-opers from #
485 # changing their nicknames. #
486 # Note that any disabled commands take effect only after the user has #
487 # 'registered' (e.g. after the initial USER/NICK/PASS on connection) #
488 # so for example disabling NICK will not cripple your network. #
490 # You can also define if you want to disable any channelmodes #
491 # or usermodes from your users. #
493 # `fakenonexistant' will make the ircd pretend that nonexistant #
494 # commands simply don't exist to non-opers ("no such command"). #
496 #<disabled commands="TOPIC MODE" usermodes="" chanmodes="" fakenonexistant="yes">
499 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#- RTFM LINE -#-#-#-#-#-#-#-#-#-#-#-#-#-#
501 # Just remove this... Its here to make you read ALL of the config #
504 <die value="You should probably edit your config *PROPERLY* and try again.">
508 #-#-#-#-#-#-#-#-#-#-#-#-#- SERVER OPTIONS -#-#-#-#-#-#-#-#-#-#-#-#-#
510 # Settings to define which features are usable on your server. #
514 # prefixquit: What (if anything) users' quit messages
515 # should be prefixed with.
518 # suffixquit: What (if anything) users' quit messages
519 # should be suffixed with.
522 # prefixpart: What (if anything) users' part messages
523 # should be prefixed with.
525 # NOTE: Use "\"" instead of """ if not using <config format="xml">
527 # suffixpart: What (if anything) users' part message
528 # should be suffixed with.
531 # fixedquit: Set all users' quit messages to this value.
534 # fixedpart: Set all users' part messages in all channels
538 # syntaxhints: If enabled, if a user fails to send the correct parameters
539 # for a command, the ircd will give back some help text of what
540 # the correct parameters are.
543 # cyclehostsfromuser: If enabled, the source of the mode change for
544 # cyclehosts will be the user who cycled. This can look nicer, but
545 # triggers anti-takeover mechanisms of some obsolete bots.
546 cyclehostsfromuser="no"
548 # announcets: If set to yes, when the timestamp on a channel changes, all users
549 # in the channel will be sent a NOTICE about it.
552 # allowmismatch: Setting this option to yes will allow servers to link even
553 # if they don't have the same "optionally common" modules loaded. Setting this to
554 # yes may introduce some desyncs and unwanted behaviour.
557 # defaultbind: Sets the default for <bind> tags without an address. Choices are
558 # ipv4 or ipv6; if not specified, IPv6 will be used if your system has support,
559 # falling back to IPv4 otherwise.
562 # hostintopic: If enabled, channels will show the host of the topic setter
563 # in the topic. If set to no, it will only show the nick of the topic setter.
566 # pingwarning: If a server does not respond to a ping within x seconds,
567 # it will send a notice to opers with snomask +l informing that the server
568 # is about to ping timeout.
571 # serverpingfreq: How often pings are sent between servers (in seconds).
574 # defaultmodes: What modes are set on a empty channel when a user
575 # joins it and it is unregistered.
578 # xlinemessage: This is the text that is sent to a user when they are
579 # banned from the server.
580 xlinemessage="You're banned! Email irc@example.com with the ERROR line below for help."
582 # exemptchanops: exemptions for channel access restrictions based on prefix.
583 exemptchanops="nonick:v flood:o"
585 # invitebypassmodes: This allows /invite to bypass other channel modes.
586 # (Such as +k, +j, +l, etc.)
587 invitebypassmodes="yes"
589 # nosnoticestack: This prevents snotices from 'stacking' and giving you
590 # the message saying '(last message repeated X times)'. Defaults to no.
594 #-#-#-#-#-#-#-#-#-#-#-# PERFORMANCE CONFIGURATION #-#-#-#-#-#-#-#-#-#-#
598 # netbuffersize: Size of the buffer used to receive data from clients.
599 # The ircd may only read this amount of text in 1 go at any time.
600 netbuffersize="10240"
602 # somaxconn: The maximum number of connections that may be waiting
603 # in the accept queue. This is *NOT* the total maximum number of
604 # connections per server. Some systems may only allow this to be up
605 # to 5, while others (such as Linux and *BSD) default to 128.
606 # Setting this above the limit imposed by your OS can have undesired
610 # softlimit: This optional feature allows a defined softlimit for
611 # connections. If defined, it sets a soft max connections value.
614 # clonesonconnect: If this is set to false, we won't check for clones
615 # on initial connection, but only after the DNS check is done.
616 # This can be useful where your main class is more restrictive
617 # than some other class a user can be assigned after DNS lookup is complete.
618 # Turning this option off will make the server spend more time on users we may
619 # potentially not want. Normally this should be neglible, though.
620 # Default value is true
621 clonesonconnect="true"
623 # quietbursts: When syncing or splitting from a network, a server
624 # can generate a lot of connect and quit messages to opers with
625 # +C and +Q snomasks. Setting this to yes squelches those messages,
626 # which makes it easier for opers, but degrades the functionality of
627 # bots like BOPM during netsplits.
630 #-#-#-#-#-#-#-#-#-#-#-# SECURITY CONFIGURATION #-#-#-#-#-#-#-#-#-#-#-#
634 # allowcoreunload: If this value is set to yes, Opers will be able to
635 # unload core modules (e.g. cmd_privmsg.so).
638 # announceinvites: This option controls which members of the channel
639 # receive an announcement when someone is INVITEd. Available values:
640 # 'none' - don't send invite announcements
641 # 'all' - send invite announcements to all members
642 # 'ops' - send invite announcements to ops and higher ranked users
643 # 'dynamic' - send invite announcements to halfops (if available) and
644 # higher ranked users. This is the recommended setting.
645 announceinvites="dynamic"
647 # hideulines: If this value is set to yes, U-lined servers will
648 # be hidden from non-opers in /links and /map.
651 # flatlinks: If this value is set to yes, /map and /links will
652 # be flattened when shown to non-opers.
655 # hidewhois: When defined, the given text will be used in place
656 # of the server a user is on when whoised by a non-oper. Most
657 # networks will want to set this to something like "*.netname.net"
658 # to conceal the actual server a user is on.
659 # Note that enabling this will cause users' idle times to only be
660 # shown when the format /WHOIS <nick> <nick> is used.
663 # hidebans: If this value is set to yes, when a user is banned ([gkz]lined)
664 # only opers will see the ban message when the user is removed
668 # hidekills: If defined, replaces who set a /kill with a custom string.
671 # hideulinekills: Hide kills from clients of ulined servers from server notices.
674 # hidesplits: If enabled, non-opers will not be able to see which
675 # servers split in a netsplit, they will only be able to see that one
676 # occurred (If their client has netsplit detection).
679 # maxtargets: Maximum number of targets per command.
680 # (Commands like /notice, /privmsg, /kick, etc)
683 # customversion: A custom message to be displayed in the comments field
684 # of the VERSION command response. This does not hide the InspIRCd version.
687 # operspywhois: show opers (users/auspex) the +s channels a user is in. Values:
688 # splitmsg Split with an explanatory message
689 # yes Split with no explanatory message
693 # runasuser: If this is set, InspIRCd will attempt to switch
694 # to run as this user, which allows binding of ports under 1024.
695 # You should NOT set this unless you are starting as root.
696 # NOT SUPPORTED/NEEDED UNDER WINDOWS.
699 # runasgroup: If this is set, InspIRCd will attempt to switch
700 # to run as this group, which allows binding of ports under 1024.
701 # You should NOT set this unless you are starting as root.
702 # NOT SUPPORTED/NEEDED UNDER WINDOWS.
705 # restrictbannedusers: If this is set to yes, InspIRCd will not allow users
706 # banned on a channel to change nickname or message channels they are
708 restrictbannedusers="yes"
710 # genericoper: Setting this value to yes makes all opers on this server
711 # appear as 'is an IRC operator' in their WHOIS, regardless of their
712 # oper type, however oper types are still used internally. This only
713 # affects the display in WHOIS.
716 # userstats: /stats commands that users can run (opers can run all).
719 #-#-#-#-#-#-#-#-#-#-#-#-# LIMITS CONFIGURATION #-#-#-#-#-#-#-#-#-#-#-#
721 # This configuration tag defines the maximum sizes of various types #
722 # on IRC, such as the maximum length of a channel name, and the #
723 # maximum length of a channel. Note that with the exception of the #
724 # identmax value all values given here are the exact values you would #
725 # expect to see on IRC. This contrasts with the older InspIRCd #
726 # releases where these values would be one character shorter than #
727 # defined to account for a null terminator on the end of the text. #
729 # These values should match network-wide otherwise issues will occur. #
731 # The highest safe value you can set any of these options to is 500, #
732 # but it is recommended that you keep them somewhat #
733 # near their defaults (or lower). #
736 # maxnick: Maximum length of a nickname.
739 # maxchan: Maximum length of a channel name.
742 # maxmodes: Maximum number of mode changes per line.
745 # maxident: Maximum length of a ident/username.
748 # maxhost: Maximum length of a hostname.
751 # maxquit: Maximum length of a quit message.
754 # maxtopic: Maximum length of a channel topic.
757 # maxkick: Maximum length of a kick message.
760 # maxgecos: Maximum length of a GECOS (realname).
763 # maxaway: Maximum length of an away message.
766 #-#-#-#-#-#-#-#-#-#-#-#-# PATHS CONFIGURATION #-#-#-#-#-#-#-#-#-#-#-#-#
768 # This configuration tag defines the location that InspIRCd stores #
769 # various types of files such as configuration files, log files and #
770 # modules. You will probably not need to change these from the values #
771 # set when InspIRCd was built unless you are using a binary package #
772 # where you do not have the ability to set build time configuration. #
773 #<path configdir="conf" datadir="data" logdir="logs" moduledir="modules">
775 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
779 # Logging is covered with the <log> tag, which you may use to change
780 # the behaviour of the logging of the IRCd.
782 # In InspIRCd as of 1.2, logging is pluggable and very extensible.
783 # Different files can log the same thing, different 'types' of log can
784 # go to different places, and modules can even extend the log tag
785 # to do what they want.
787 # An example log tag would be:
788 # <log method="file" type="OPER" level="default" target="opers.log">
789 # which would log all information on /oper (failed and successful) to
790 # a file called opers.log.
792 # There are many different types which may be used, and modules may
793 # generate their own. A list of useful types:
794 # - USERS - information relating to user connection and disconnection
795 # - OPER - succesful and failed oper attempts
796 # - KILL - kill related messages
797 # - snomask - server notices (*all* snomasks will be logged)
798 # - FILTER - messages related to filter matches (filter module)
799 # - CONFIG - configuration related messages
800 # - COMMAND - die and restart messages, and messages related to unknown user types
801 # - SOCKET - socket engine informational/error messages
802 # - MODULE - module related messages
803 # - STARTUP - messages related to starting up the server
805 # You may also log *everything* by using a type of *, and subtract things out
806 # of that by using -TYPE - for example "* -USERINPUT -USEROUTPUT".
809 # - default (general messages, including errors)
810 # - sparse (misc error messages)
811 # - debug (debug messages)
813 # Some types only produce output in the debug level, those are:
814 # - BANCACHE - ban cache debug messages
815 # - CHANNELS - information relating to joining/creating channels
816 # - CULLLIST - debug messages related to issues with removing users
817 # - RESOLVER - DNS related debug messages
818 # - CONNECTCLASS - Connection class debug messages
822 # The following log tag is highly default and uncustomised. It is recommended you
823 # sort out your own log tags. This is just here so you get some output.
825 <log method="file" type="* -USERINPUT -USEROUTPUT" level="default" target="ircd.log">
827 #-#-#-#-#-#-#-#-#-#-#-#-#- WHOWAS OPTIONS -#-#-#-#-#-#-#-#-#-#-#-#-#
829 # This tag lets you define the behaviour of the /whowas command of #
834 # groupsize: Maximum entries per nick shown when performing
838 # maxgroups: Maximum number of nickgroups that can be added to
839 # the list so that /whowas does not use a lot of resources on
843 # maxkeep: Maximum time a nick is kept in the whowas list
844 # before being pruned. Time may be specified in seconds,
845 # or in the following format: 1y2w3d4h5m6s. Minimum is
849 #-#-#-#-#-#-#-#-#-#-#-#-#-#- BAN OPTIONS -#-#-#-#-#-#-#-#-#-#-#-#-#-#
851 # The ban tags define nick masks, host masks and ip ranges which are #
852 # banned from your server. All details in these tags are local to #
857 # ipmask: IP range to ban. Wildcards and CIDR can be used.
860 # reason: Reason to display when user is disconnected.
861 reason="No porn here thanks.">
864 # nick: Nick to disallow. Wildcards are supported.
867 # reason: Reason to display on /nick.
868 reason="Reserved For Services">
870 <badnick nick="NickServ" reason="Reserved For Services">
871 <badnick nick="OperServ" reason="Reserved For Services">
872 <badnick nick="MemoServ" reason="Reserved For Services">
875 # host: ident@hostname to ban.
876 # Wildcards and CIDR (if you specify an IP) can be used.
877 host="*@banneduser.example.net"
879 # reason: Reason to display when user is disconnected
880 reason="Evading Bans">
882 <badhost host="root@*" reason="Don't IRC as root!">
883 <badhost host="*@198.51.100.0/24" reason="This subnet is bad.">
885 # exception: Hosts that are exempt from [kgz]lines.
887 # host: ident@hostname to exempt.
888 # Wildcards and CIDR (if you specify an IP) can be used.
889 host="*@ircop.example.com"
891 # reason: Reason for exception. Only shown in /stats e
892 reason="Oper's hostname">
894 #-#-#-#-#-#-#-#-#-#-#- INSANE BAN OPTIONS -#-#-#-#-#-#-#-#-#-#-#-#-#-#
896 # This optional tag allows you to specify how wide a gline, eline, #
897 # kline, zline or qline can be before it is forbidden from being #
898 # set. By setting hostmasks="yes", you can allow all G, K, E lines, #
899 # no matter how many users the ban would cover. This is not #
900 # recommended! By setting ipmasks="yes", you can allow all Z lines, #
901 # no matter how many users these cover too. Needless to say we #
902 # don't recommend you do this, or, set nickmasks="yes", which will #
907 # hostmasks: Allow bans with insane hostmasks. (over-reaching bans)
910 # ipmasks: Allow bans with insane ipmasks. (over-reaching bans)
913 # nickmasks: Allow bans with insane nickmasks. (over-reaching bans)
916 # trigger: What percentage of users on the network to trigger
917 # specifying an insane ban as. The default is 95.5%, which means
918 # if you have a 1000 user network, a ban will not be allowed if it
919 # will be banning 955 or more users.
923 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#- YAWN -#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
925 # You should already know what to do here :) #
927 <die value="User error. You didn't edit your config properly. Go back and try again.">
929 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# MODULES #-#-#-#-#-#-#-#-#-#-#-#-#-#-#
930 # ____ _ _____ _ _ ____ _ _ _ #
931 # | _ \ ___ __ _ __| | |_ _| |__ (_)___ | __ )(_) |_| | #
932 # | |_) / _ \/ _` |/ _` | | | | '_ \| / __| | _ \| | __| | #
933 # | _ < __/ (_| | (_| | | | | | | | \__ \ | |_) | | |_|_| #
934 # |_| \_\___|\__,_|\__,_| |_| |_| |_|_|___/ |____/|_|\__(_) #
936 # Well done, you've reached the end of the basic configuration, your #
937 # ircd should now start if you want to try it out! (./inspircd start) #
939 # We now suggest you read and edit modules.conf, as modules are what #
940 # provide almost all the features of InspIRCd. :) #
942 # The default does nothing -- we include it for simplicity for you. #
943 <include file="examples/modules.conf.example">
945 # Here are some pre-built modules.conf files that closely match the
946 # default configurations of some popular IRCd's. You still may want to
947 # look over them and make sure if everything is correct for you and setup
948 # the proper SSL information.
950 # *NOTE*: These files have no comments for what the modules do. If you
951 # are interested in that, please read the modules.conf.example. It is also
952 # recommended that you make your own modules file based on modules.conf.example.
954 # Settings similar to UnrealIRCd defaults.
955 #<include file="examples/modules/unrealircd.conf.example">
957 # Settings similar to Charybdis IRCd defaults.
958 #<include file="examples/modules/charybdis.conf.example">
961 #########################################################################
963 # - InspIRCd Development Team - #
964 # http://www.inspircd.org #
966 #########################################################################