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.
172 # free: When this is enabled the listener will be created regardless of
173 # whether the interface that provides the bind address is available. This
174 # is useful for if you are starting InspIRCd on boot when the server may
175 # not have brought the network interfaces up yet.
179 <bind address="" port="6660-6669" type="clients">
181 # Listener accepting HTML5 WebSocket connections.
182 # Requires the websocket module and SHA-1 hashing support (provided by the sha1
184 #<bind address="" port="7002" type="clients" hook="websocket">
186 # When linking servers, the OpenSSL and GnuTLS implementations are completely
187 # link-compatible and can be used alongside each other
188 # on each end of the link without any significant issues.
189 # Supported SSL types are: "openssl" and "gnutls".
190 # You must load the ssl_openssl module for OpenSSL or ssl_gnutls for GnuTLS.
192 <bind address="" port="7000,7001" type="servers">
193 <bind address="1.2.3.4" port="7005" type="servers" ssl="openssl">
196 #-#-#-#-#-#-#-#-#-#- CONNECTIONS CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
198 # This is where you can configure which connections are allowed #
199 # and denied access onto your server. The password is optional. #
200 # You may have as many of these as you require. To allow/deny all #
201 # connections, use a '*' or 0.0.0.0/0. #
203 # -- It is important to note that connect tags are read from the -- #
204 # TOP DOWN. This means that you should have more specific deny #
205 # and allow tags at the top, progressively more general, followed #
206 # by a <connect allow="*" (should you wish to have one). #
208 # Connect blocks are searched twice for each user - once when the TCP #
209 # connection is accepted, and once when the user completes their #
210 # registration. Most of the information (hostname, ident response, #
211 # password, SSL when using STARTTLS, etc) is only available during #
212 # the second search, so if you are trying to make a closed server, #
213 # you will probably need a connect block just for user registration. #
214 # This can be done by using <connect registered="no"> #
217 # deny: Will not let people connect if they have specified host/IP.
220 # connect:reason is the message that users will see if they match a deny block
221 <connect deny="3ffe::0/32" reason="The 6bone address space is deprecated">
224 # name: Name to use for this connect block. Mainly used for
225 # connect class inheriting.
228 # parent: This setting is to specify if this connect class
229 # inherits settings from any other. Put the other class's name
230 # in here to use its settings as a template - for example, if
231 # you only want to adjust sendq and a password
234 # allow: What IP addresses/hosts to allow for this block.
237 # hash: the hash function this password is hashed with. Requires the
238 # module for the selected function (bcrypt, md5, sha1, sha256, or
239 # ripemd160) and the password hashing module (password_hash) to be
241 # You may also use any of the above other than bcrypt prefixed with
242 # either "hmac-" or "pbkdf2-hmac-" (requires the pbkdf2 module).
243 # Create hashed passwords with: /mkpasswd <hash> <password>
246 # password: Password to use for this block/user(s)
249 # maxchans: Maximum number of channels a user in this class
253 # timeout: How long (in seconds) the server will wait before
254 # disconnecting a user if they do not do anything on connect.
255 # (Note, this is a client-side thing, if the client does not
256 # send /nick, /user or /pass)
259 # localmax: Maximum local connections per IP (or CIDR mask, see below).
262 # globalmax: Maximum global (network-wide) connections per IP (or CIDR mask, see below).
265 # maxconnwarn: Enable warnings when localmax or globalmax are reached (defaults to on)
268 # resolvehostnames: If disabled, no DNS lookups will be performed on connecting users
269 # in this class. This can save a lot of resources on very busy servers.
270 resolvehostnames="yes"
272 # usednsbl: Defines whether or not users in this class are subject to DNSBL. Default is yes.
273 # This setting only has effect when the dnsbl module is loaded.
276 # useident: Defines if users in this class MUST respond to a ident query or not.
279 # limit: How many users are allowed in this class
282 # modes: Usermodes that are set on users in this block on connect.
283 # Enabling this option requires that the conn_umodes module be loaded.
284 # This entry is highly recommended to use for/with IP Cloaking/masking.
285 # For the example to work, this also requires that the "cloaking"
286 # module be loaded as well.
289 # requireident, requiressl, requireaccount: require that users of this
290 # block have a valid ident response, use SSL, or have authenticated.
291 # Requires ident, sslinfo, or the services_account module, respectively.
293 # NOTE: For requireaccount, you must complete the signon prior to full
294 # connection. Currently, this is only possible by using SASL
295 # authentication; passforward and PRIVMSG NickServ happen after
296 # your final connect block has been found.
298 # Alternate MOTD file for this connect class. The contents of this file are
299 # specified using <files secretmotd="filename"> or <execfiles ...>
302 # Allow color codes to be processed in the message of the day file.
303 # the following characters are valid color code escapes:
305 # \037 or \u = Underline
306 # \003 or \c = Color (with a code postfixed to this char)
307 # \017 or \x = Stop all color sequences
308 allowmotdcolors="false"
310 # port: What port this user is allowed to connect on. (optional)
311 # The port MUST be set to listen in the bind blocks above.
315 # name: Name to use for this connect block. Mainly used for
316 # connect class inheriting.
319 # allow: What IP addresses/hosts to allow for this block.
322 # maxchans: Maximum number of channels a user in this class
326 # timeout: How long (in seconds) the server will wait before
327 # disconnecting a user if they do not do anything on connect.
328 # (Note, this is a client-side thing, if the client does not
329 # send /nick, /user or /pass)
332 # pingfreq: How often (in seconds) the server tries to ping connecting clients.
335 # hardsendq: maximum amount of data allowed in a client's send queue
336 # before they are dropped. Keep this value higher than the length of
337 # your network's /LIST or /WHO output, or you will have lots of
338 # disconnects from sendq overruns!
339 # Setting this to "1M" is equivalent to "1048576", "8K" is 8192, etc.
342 # softsendq: amount of data in a client's send queue before the server
343 # begins delaying their commands in order to allow the sendq to drain
346 # recvq: amount of data allowed in a client's queue before they are dropped.
347 # Entering "8K" is equivalent to "8192", see above.
350 # threshold: This specifies the amount of command penalty a user is allowed to have
351 # before being quit or fakelagged due to flood. Normal commands have a penalty of 1,
352 # ones such as /OPER have penalties up to 10.
354 # If you are not using fakelag, this should be at least 20 to avoid excess flood kills
355 # from processing some commands.
358 # commandrate: This specifies the maximum rate that commands can be processed.
359 # If commands are sent more rapidly, the user's penalty will increase and they will
360 # either be fakelagged or killed when they reach the threshold
362 # Units are millicommands per second, so 1000 means one line per second.
365 # fakelag: Use fakelag instead of killing users for excessive flood
367 # Fake lag stops command processing for a user when a flood is detected rather than
368 # immediately killing them; their commands are held in the recvq and processed later
369 # as the user's command penalty drops. Note that if this is enabled, flooders will
370 # quit with "RecvQ exceeded" rather than "Excess Flood".
373 # localmax: Maximum local connections per IP.
376 # globalmax: Maximum global (network-wide) connections per IP.
379 # resolvehostnames: If disabled, no DNS lookups will be performed on connecting users
380 # in this class. This can save a lot of resources on very busy servers.
381 resolvehostnames="yes"
383 # useident: Defines if users in this class must respond to a ident query or not.
386 # limit: How many users are allowed in this class
389 # modes: Usermodes that are set on users in this block on connect.
390 # Enabling this option requires that the conn_umodes module be loaded.
391 # This entry is highly recommended to use for/with IP Cloaking/masking.
392 # For the example to work, this also requires that the cloaking
393 # module be loaded as well.
397 #-#-#-#-#-#-#-#-#-#-#-#- CIDR CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-
399 # CIDR configuration allows detection of clones and applying of #
400 # throttle limits across a CIDR range. (A CIDR range is a group of #
401 # IPs, for example, the CIDR range 192.168.1.0-192.168.1.255 may be #
402 # represented as 192.168.1.0/24). This means that abuse across an ISP #
403 # is detected and curtailed much easier. Here is a good chart that #
404 # shows how many IPs the different CIDRs correspond to: #
405 # http://en.wikipedia.org/wiki/CIDR#Prefix_aggregation #
409 # ipv4clone: specifies how many bits of an IP address should be
410 # looked at for clones. The default only looks for clones on a
411 # single IP address of a user. You do not want to set this
412 # extremely low. (Values are 0-32).
415 # ipv6clone: specifies how many bits of an IP address should be
416 # looked at for clones. The default only looks for clones on a
417 # single IP address of a user. You do not want to set this
418 # extremely low. (Values are 0-128).
421 # This file has all the information about oper classes, types and o:lines.
422 # You *MUST* edit it.
423 <include file="examples/opers.conf.example">
425 # This file has all the information about server links and ulined servers.
426 # You *MUST* edit it if you intend to link servers.
427 <include file="examples/links.conf.example">
429 #-#-#-#-#-#-#-#-#-#- MISCELLANEOUS CONFIGURATION -#-#-#-#-#-#-#-#-#-#
432 # Files block - contains files whose contents are used by the ircd
434 # motd - displayed on connect and when a user executes /MOTD
435 # Modules can also define their own files
436 <files motd="examples/motd.txt.example">
438 # Example of an executable file include. Note this will be read on rehash,
439 # not when the command is run.
440 #<execfiles motd="wget -O - http://www.example.com/motd.txt">
442 #-#-#-#-#-#-#-#-#-#-#-#-#-#-# DNS SERVER -#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
443 # If these values are not defined, InspIRCd uses the default DNS resolver
447 # server: DNS server to use to attempt to resolve IP's to hostnames.
448 # in most cases, you won't need to change this, as inspircd will
449 # automatically detect the nameserver depending on /etc/resolv.conf
450 # (or, on Windows, your set nameservers in the registry.)
451 # Note that this must be an IP address and not a hostname, because
452 # there is no resolver to resolve the name until this is defined!
456 # timeout: seconds to wait to try to resolve DNS/hostname.
459 # An example of using an IPv6 nameserver
460 #<dns server="::1" timeout="5">
462 #-#-#-#-#-#-#-#-#-#-#-#-#-#-# PID FILE -#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
464 # Define the path to the PID file here. The PID file can be used to #
465 # rehash the ircd from the shell or to terminate the ircd from the #
466 # shell using shell scripts, perl scripts, etc... and to monitor the #
467 # ircd's state via cron jobs. If this is a relative path, it will be #
468 # relative to the configuration directory, and if it is not defined, #
469 # the default of 'inspircd.pid' is used. #
472 #<pid file="/path/to/inspircd.pid">
474 #-#-#-#-#-#-#-#-#-#-#-#-#- BANLIST LIMITS #-#-#-#-#-#-#-#-#-#-#-#-#-#-#
476 # Use these tags to customise the ban limits on a per channel basis. #
477 # The tags are read from top to bottom, and any tag found which #
478 # matches the channels name applies the banlimit to that channel. #
479 # It is advisable to put an entry with the channel as '*' at the #
480 # bottom of the list. If none are specified or no maxbans tag is #
481 # matched, the banlist size defaults to 64 entries. #
484 <banlist chan="#largechan" limit="128">
485 <banlist chan="*" limit="69">
487 #-#-#-#-#-#-#-#-#-#-#- DISABLED FEATURES -#-#-#-#-#-#-#-#-#-#-#-#-#-#
489 # This tag is optional, and specifies one or more features which are #
490 # not available to non-operators. #
492 # For example you may wish to disable NICK and prevent non-opers from #
493 # changing their nicknames. #
494 # Note that any disabled commands take effect only after the user has #
495 # 'registered' (e.g. after the initial USER/NICK/PASS on connection) #
496 # so for example disabling NICK will not cripple your network. #
498 # You can also define if you want to disable any channelmodes #
499 # or usermodes from your users. #
501 # `fakenonexistant' will make the ircd pretend that nonexistant #
502 # commands simply don't exist to non-opers ("no such command"). #
504 #<disabled commands="TOPIC MODE" usermodes="" chanmodes="" fakenonexistant="yes">
507 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#- RTFM LINE -#-#-#-#-#-#-#-#-#-#-#-#-#-#
509 # Just remove this... Its here to make you read ALL of the config #
512 <die value="You should probably edit your config *PROPERLY* and try again.">
516 #-#-#-#-#-#-#-#-#-#-#-#-#- SERVER OPTIONS -#-#-#-#-#-#-#-#-#-#-#-#-#
518 # Settings to define which features are usable on your server. #
522 # prefixquit: What (if anything) users' quit messages
523 # should be prefixed with.
526 # suffixquit: What (if anything) users' quit messages
527 # should be suffixed with.
530 # prefixpart: What (if anything) users' part messages
531 # should be prefixed with.
533 # NOTE: Use "\"" instead of """ if not using <config format="xml">
535 # suffixpart: What (if anything) users' part message
536 # should be suffixed with.
539 # fixedquit: Set all users' quit messages to this value.
542 # fixedpart: Set all users' part messages in all channels
546 # syntaxhints: If enabled, if a user fails to send the correct parameters
547 # for a command, the ircd will give back some help text of what
548 # the correct parameters are.
551 # cyclehostsfromuser: If enabled, the source of the mode change for
552 # cyclehosts will be the user who cycled. This can look nicer, but
553 # triggers anti-takeover mechanisms of some obsolete bots.
554 cyclehostsfromuser="no"
556 # announcets: If set to yes, when the timestamp on a channel changes, all users
557 # in the channel will be sent a NOTICE about it.
560 # allowmismatch: Setting this option to yes will allow servers to link even
561 # if they don't have the same "optionally common" modules loaded. Setting this to
562 # yes may introduce some desyncs and unwanted behaviour.
565 # defaultbind: Sets the default for <bind> tags without an address. Choices are
566 # ipv4 or ipv6; if not specified, IPv6 will be used if your system has support,
567 # falling back to IPv4 otherwise.
570 # hostintopic: If enabled, channels will show the host of the topic setter
571 # in the topic. If set to no, it will only show the nick of the topic setter.
574 # pingwarning: If a server does not respond to a ping within x seconds,
575 # it will send a notice to opers with snomask +l informing that the server
576 # is about to ping timeout.
579 # serverpingfreq: How often pings are sent between servers (in seconds).
582 # defaultmodes: What modes are set on a empty channel when a user
583 # joins it and it is unregistered.
586 # xlinemessage: This is the text that is sent to a user when they are
587 # banned from the server.
588 xlinemessage="You're banned! Email irc@example.com with the ERROR line below for help."
590 # exemptchanops: exemptions for channel access restrictions based on prefix.
591 exemptchanops="nonick:v flood:o"
593 # invitebypassmodes: This allows /invite to bypass other channel modes.
594 # (Such as +k, +j, +l, etc.)
595 invitebypassmodes="yes"
597 # nosnoticestack: This prevents snotices from 'stacking' and giving you
598 # the message saying '(last message repeated X times)'. Defaults to no.
602 #-#-#-#-#-#-#-#-#-#-#-# PERFORMANCE CONFIGURATION #-#-#-#-#-#-#-#-#-#-#
606 # netbuffersize: Size of the buffer used to receive data from clients.
607 # The ircd may only read this amount of text in 1 go at any time.
608 netbuffersize="10240"
610 # somaxconn: The maximum number of connections that may be waiting
611 # in the accept queue. This is *NOT* the total maximum number of
612 # connections per server. Some systems may only allow this to be up
613 # to 5, while others (such as Linux and *BSD) default to 128.
614 # Setting this above the limit imposed by your OS can have undesired
618 # softlimit: This optional feature allows a defined softlimit for
619 # connections. If defined, it sets a soft max connections value.
622 # clonesonconnect: If this is set to false, we won't check for clones
623 # on initial connection, but only after the DNS check is done.
624 # This can be useful where your main class is more restrictive
625 # than some other class a user can be assigned after DNS lookup is complete.
626 # Turning this option off will make the server spend more time on users we may
627 # potentially not want. Normally this should be neglible, though.
628 # Default value is true
629 clonesonconnect="true"
631 # quietbursts: When syncing or splitting from a network, a server
632 # can generate a lot of connect and quit messages to opers with
633 # +C and +Q snomasks. Setting this to yes squelches those messages,
634 # which makes it easier for opers, but degrades the functionality of
635 # bots like BOPM during netsplits.
638 #-#-#-#-#-#-#-#-#-#-#-# SECURITY CONFIGURATION #-#-#-#-#-#-#-#-#-#-#-#
642 # allowcoreunload: If this value is set to yes, Opers will be able to
643 # unload core modules (e.g. cmd_privmsg.so).
646 # announceinvites: This option controls which members of the channel
647 # receive an announcement when someone is INVITEd. Available values:
648 # 'none' - don't send invite announcements
649 # 'all' - send invite announcements to all members
650 # 'ops' - send invite announcements to ops and higher ranked users
651 # 'dynamic' - send invite announcements to halfops (if available) and
652 # higher ranked users. This is the recommended setting.
653 announceinvites="dynamic"
655 # hideulines: If this value is set to yes, U-lined servers will
656 # be hidden from non-opers in /links and /map.
659 # flatlinks: If this value is set to yes, /map and /links will
660 # be flattened when shown to non-opers.
663 # hidewhois: When defined, the given text will be used in place
664 # of the server a user is on when whoised by a non-oper. Most
665 # networks will want to set this to something like "*.netname.net"
666 # to conceal the actual server a user is on.
667 # Note that enabling this will cause users' idle times to only be
668 # shown when the format /WHOIS <nick> <nick> is used.
671 # hidebans: If this value is set to yes, when a user is banned ([gkz]lined)
672 # only opers will see the ban message when the user is removed
676 # hidekills: If defined, replaces who set a /kill with a custom string.
679 # hideulinekills: Hide kills from clients of ulined servers from server notices.
682 # hidesplits: If enabled, non-opers will not be able to see which
683 # servers split in a netsplit, they will only be able to see that one
684 # occurred (If their client has netsplit detection).
687 # maxtargets: Maximum number of targets per command.
688 # (Commands like /notice, /privmsg, /kick, etc)
691 # customversion: A custom message to be displayed in the comments field
692 # of the VERSION command response. This does not hide the InspIRCd version.
695 # operspywhois: show opers (users/auspex) the +s channels a user is in. Values:
696 # splitmsg Split with an explanatory message
697 # yes Split with no explanatory message
701 # runasuser: If this is set, InspIRCd will attempt to switch
702 # to run as this user, which allows binding of ports under 1024.
703 # You should NOT set this unless you are starting as root.
704 # NOT SUPPORTED/NEEDED UNDER WINDOWS.
707 # runasgroup: If this is set, InspIRCd will attempt to switch
708 # to run as this group, which allows binding of ports under 1024.
709 # You should NOT set this unless you are starting as root.
710 # NOT SUPPORTED/NEEDED UNDER WINDOWS.
713 # restrictbannedusers: If this is set to yes, InspIRCd will not allow users
714 # banned on a channel to change nickname or message channels they are
716 restrictbannedusers="yes"
718 # genericoper: Setting this value to yes makes all opers on this server
719 # appear as 'is an IRC operator' in their WHOIS, regardless of their
720 # oper type, however oper types are still used internally. This only
721 # affects the display in WHOIS.
724 # userstats: /stats commands that users can run (opers can run all).
727 #-#-#-#-#-#-#-#-#-#-#-#-# LIMITS CONFIGURATION #-#-#-#-#-#-#-#-#-#-#-#
729 # This configuration tag defines the maximum sizes of various types #
730 # on IRC, such as the maximum length of a channel name, and the #
731 # maximum length of a channel. Note that with the exception of the #
732 # identmax value all values given here are the exact values you would #
733 # expect to see on IRC. This contrasts with the older InspIRCd #
734 # releases where these values would be one character shorter than #
735 # defined to account for a null terminator on the end of the text. #
737 # These values should match network-wide otherwise issues will occur. #
739 # The highest safe value you can set any of these options to is 500, #
740 # but it is recommended that you keep them somewhat #
741 # near their defaults (or lower). #
744 # maxnick: Maximum length of a nickname.
747 # maxchan: Maximum length of a channel name.
750 # maxmodes: Maximum number of mode changes per line.
753 # maxident: Maximum length of a ident/username.
756 # maxhost: Maximum length of a hostname.
759 # maxquit: Maximum length of a quit message.
762 # maxtopic: Maximum length of a channel topic.
765 # maxkick: Maximum length of a kick message.
768 # maxgecos: Maximum length of a GECOS (realname).
771 # maxaway: Maximum length of an away message.
774 #-#-#-#-#-#-#-#-#-#-#-#-# PATHS CONFIGURATION #-#-#-#-#-#-#-#-#-#-#-#-#
776 # This configuration tag defines the location that InspIRCd stores #
777 # various types of files such as configuration files, log files and #
778 # modules. You will probably not need to change these from the values #
779 # set when InspIRCd was built unless you are using a binary package #
780 # where you do not have the ability to set build time configuration. #
781 #<path configdir="conf" datadir="data" logdir="logs" moduledir="modules">
783 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
787 # Logging is covered with the <log> tag, which you may use to change
788 # the behaviour of the logging of the IRCd.
790 # In InspIRCd as of 1.2, logging is pluggable and very extensible.
791 # Different files can log the same thing, different 'types' of log can
792 # go to different places, and modules can even extend the log tag
793 # to do what they want.
795 # An example log tag would be:
796 # <log method="file" type="OPER" level="default" target="opers.log">
797 # which would log all information on /oper (failed and successful) to
798 # a file called opers.log.
800 # There are many different types which may be used, and modules may
801 # generate their own. A list of useful types:
802 # - USERS - information relating to user connection and disconnection
803 # - OPER - succesful and failed oper attempts
804 # - KILL - kill related messages
805 # - snomask - server notices (*all* snomasks will be logged)
806 # - FILTER - messages related to filter matches (filter module)
807 # - CONFIG - configuration related messages
808 # - COMMAND - die and restart messages, and messages related to unknown user types
809 # - SOCKET - socket engine informational/error messages
810 # - MODULE - module related messages
811 # - STARTUP - messages related to starting up the server
813 # You may also log *everything* by using a type of *, and subtract things out
814 # of that by using -TYPE - for example "* -USERINPUT -USEROUTPUT".
817 # - default (general messages, including errors)
818 # - sparse (misc error messages)
819 # - debug (debug messages)
821 # Some types only produce output in the debug level, those are:
822 # - BANCACHE - ban cache debug messages
823 # - CHANNELS - information relating to joining/creating channels
824 # - CULLLIST - debug messages related to issues with removing users
825 # - RESOLVER - DNS related debug messages
826 # - CONNECTCLASS - Connection class debug messages
830 # The following log tag is highly default and uncustomised. It is recommended you
831 # sort out your own log tags. This is just here so you get some output.
833 <log method="file" type="* -USERINPUT -USEROUTPUT" level="default" target="ircd.log">
835 #-#-#-#-#-#-#-#-#-#-#-#-#- WHOWAS OPTIONS -#-#-#-#-#-#-#-#-#-#-#-#-#
837 # This tag lets you define the behaviour of the /whowas command of #
842 # groupsize: Maximum entries per nick shown when performing
846 # maxgroups: Maximum number of nickgroups that can be added to
847 # the list so that /whowas does not use a lot of resources on
851 # maxkeep: Maximum time a nick is kept in the whowas list
852 # before being pruned. Time may be specified in seconds,
853 # or in the following format: 1y2w3d4h5m6s. Minimum is
857 #-#-#-#-#-#-#-#-#-#-#-#-#-#- BAN OPTIONS -#-#-#-#-#-#-#-#-#-#-#-#-#-#
859 # The ban tags define nick masks, host masks and ip ranges which are #
860 # banned from your server. All details in these tags are local to #
865 # ipmask: IP range to ban. Wildcards and CIDR can be used.
868 # reason: Reason to display when user is disconnected.
869 reason="No porn here thanks.">
872 # nick: Nick to disallow. Wildcards are supported.
875 # reason: Reason to display on /nick.
876 reason="Reserved For Services">
878 <badnick nick="NickServ" reason="Reserved For Services">
879 <badnick nick="OperServ" reason="Reserved For Services">
880 <badnick nick="MemoServ" reason="Reserved For Services">
883 # host: ident@hostname to ban.
884 # Wildcards and CIDR (if you specify an IP) can be used.
885 host="*@banneduser.example.net"
887 # reason: Reason to display when user is disconnected
888 reason="Evading Bans">
890 <badhost host="root@*" reason="Don't IRC as root!">
891 <badhost host="*@198.51.100.0/24" reason="This subnet is bad.">
893 # exception: Hosts that are exempt from [kgz]lines.
895 # host: ident@hostname to exempt.
896 # Wildcards and CIDR (if you specify an IP) can be used.
897 host="*@ircop.example.com"
899 # reason: Reason for exception. Only shown in /stats e
900 reason="Oper's hostname">
902 #-#-#-#-#-#-#-#-#-#-#- INSANE BAN OPTIONS -#-#-#-#-#-#-#-#-#-#-#-#-#-#
904 # This optional tag allows you to specify how wide a gline, eline, #
905 # kline, zline or qline can be before it is forbidden from being #
906 # set. By setting hostmasks="yes", you can allow all G, K, E lines, #
907 # no matter how many users the ban would cover. This is not #
908 # recommended! By setting ipmasks="yes", you can allow all Z lines, #
909 # no matter how many users these cover too. Needless to say we #
910 # don't recommend you do this, or, set nickmasks="yes", which will #
915 # hostmasks: Allow bans with insane hostmasks. (over-reaching bans)
918 # ipmasks: Allow bans with insane ipmasks. (over-reaching bans)
921 # nickmasks: Allow bans with insane nickmasks. (over-reaching bans)
924 # trigger: What percentage of users on the network to trigger
925 # specifying an insane ban as. The default is 95.5%, which means
926 # if you have a 1000 user network, a ban will not be allowed if it
927 # will be banning 955 or more users.
931 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#- YAWN -#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
933 # You should already know what to do here :) #
935 <die value="User error. You didn't edit your config properly. Go back and try again.">
937 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# MODULES #-#-#-#-#-#-#-#-#-#-#-#-#-#-#
938 # ____ _ _____ _ _ ____ _ _ _ #
939 # | _ \ ___ __ _ __| | |_ _| |__ (_)___ | __ )(_) |_| | #
940 # | |_) / _ \/ _` |/ _` | | | | '_ \| / __| | _ \| | __| | #
941 # | _ < __/ (_| | (_| | | | | | | | \__ \ | |_) | | |_|_| #
942 # |_| \_\___|\__,_|\__,_| |_| |_| |_|_|___/ |____/|_|\__(_) #
944 # Well done, you've reached the end of the basic configuration, your #
945 # ircd should now start if you want to try it out! (./inspircd start) #
947 # We now suggest you read and edit modules.conf, as modules are what #
948 # provide almost all the features of InspIRCd. :) #
950 # The default does nothing -- we include it for simplicity for you. #
951 <include file="examples/modules.conf.example">
953 # Here are some pre-built modules.conf files that closely match the
954 # default configurations of some popular IRCd's. You still may want to
955 # look over them and make sure if everything is correct for you and setup
956 # the proper SSL information.
958 # *NOTE*: These files have no comments for what the modules do. If you
959 # are interested in that, please read the modules.conf.example. It is also
960 # recommended that you make your own modules file based on modules.conf.example.
962 # Settings similar to UnrealIRCd defaults.
963 #<include file="examples/modules/unrealircd.conf.example">
965 # Settings similar to Charybdis IRCd defaults.
966 #<include file="examples/modules/charybdis.conf.example">
969 #########################################################################
971 # - InspIRCd Development Team - #
972 # http://www.inspircd.org #
974 #########################################################################