1 ########################################################################
3 # ___ ___ ____ ____ _ #
4 # |_ _|_ __ ___ _ __|_ _| _ \ / ___|__| | #
5 # | || '_ \/ __| '_ \| || |_) | | / _` | #
6 # | || | | \__ \ |_) | || _ <| |__| (_| | #
7 # |___|_| |_|___/ .__/___|_| \_\\____\__,_| #
10 # / ___|___ _ __ / _(_) __ _ _ _ _ __ __ _| |_(_) ___ _ __ #
11 # | | / _ \| '_ \| |_| |/ _` | | | | '__/ _` | __| |/ _ \| '_ \ #
12 # | |__| (_) | | | | _| | (_| | |_| | | | (_| | |_| | (_) | | | | #
13 # \____\___/|_| |_|_| |_|\__, |\__,_|_| \__,_|\__|_|\___/|_| |_| #
16 ##################################||####################################
18 ##################################||####################################
20 # This is an example of the config file for InspIRCd. #
21 # Change the options to suit your network #
24 # ____ _ _____ _ _ ____ _ _ _ #
25 # | _ \ ___ __ _ __| | |_ _| |__ (_)___ | __ )(_) |_| | #
26 # | |_) / _ \/ _` |/ _` | | | | '_ \| / __| | _ \| | __| | #
27 # | _ < __/ (_| | (_| | | | | | | | \__ \ | |_) | | |_|_| #
28 # |_| \_\___|\__,_|\__,_| |_| |_| |_|_|___/ |____/|_|\__(_) #
30 # Lines prefixed with READ THIS BIT, as shown above, are IMPORTANT #
31 # lines, and you REALLY SHOULD READ THEM. Yes, THIS MEANS YOU. Even #
32 # if you've configured InspIRCd before, these probably indicate #
33 # something new or different to this version and you SHOULD READ IT. #
35 ########################################################################
37 # Unalphabeticalise the modules list at your own risk #
39 ########################################################################
41 #-#-#-#-#-#-#-#-#-# INCLUDE CONFIGURATION #-#-#-#-#-#-#-#-#-#-#-#-#-#
43 # This optional tag allows you to include another config file #
44 # allowing you to keep your configuration tidy. The configuration #
45 # file you include will be treated as part of the configuration file #
46 # which includes it, in simple terms the inclusion is transparent. #
48 # All paths to config files are relative to the directory that the #
51 # You may also include an executable file, in which case if you do so #
52 # the output of the executable on the standard output will be added #
53 # to your config at the point of the include tag. #
55 # Syntax is as follows: #
56 #<include file="file.conf"> #
57 #<include executable="/path/to/executable parameters"> #
59 # Executable Include Example: #
60 #<include executable="/usr/bin/wget -q -O - http://mynet.net/inspircd.conf">
64 #-#-#-#-#-#-#-#-#-#-#-# VARIABLE DEFINITIONS -#-#-#-#-#-#-#-#-#-#-#-#
66 # You can define variables that will be substituted later in the #
67 # configuration file. This can be useful to allow settings to be #
68 # easily changed, or to parameterize a remote includes. #
70 # Variables may be redefined and may reference other variables. #
71 # Value expansion happens at the time the tag is read. #
73 # Using variable definitions REQUIRES that the config format be #
74 # changed to "xml" from the default "compat" that uses escape #
75 # sequences such as "\"" and "\n", and does not support <define> #
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.org.za"
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 # m_spanningtree.so module! Please see the modules list below for #
136 # information on how to load this module! If you do not load this #
137 # module, server ports will NOT be bound! #
139 # PLEASE NOTE: If you have build InspIRCd with IPv6 support, you MUST #
140 # specify a bind address if you want the IRCd to bind to a IPv4 IP. #
143 # address: IP address to bind to if the box that you are hosting
144 # on has more than one IP, else the ircd will try to bind to all
145 # IP's on the box if this is not defined.
148 # port: Port for users or servers to be able to connect to.
149 # you can select multiple ports by separating them
150 # with a - character like the example below.
153 # type: Type of bind block this is. It can either be clients or
154 # servers. Whichever you select will be the only type able to connect
155 # to this bind section.
158 # ssl: If you want this bind section to use SSL, define either
159 # gnutls or openssl here. The appropriate SSL modules must be loaded
160 # for ssl to work. If you do not want this bind section to support ssl,
161 # just remove or comment out this option.
165 <bind address="" port="6660-6669" type="clients">
167 # When linking servers, the openssl and gnutls implementations are completely
168 # link-compatible and can be used alongside each other
169 # on each end of the link without any significant issues.
170 # Supported ssl types are: "openssl" and "gnutls".
171 # You must load, m_ssl_openssl for openssl
172 # or m_ssl_gnutls for gnutls.
174 <bind address="" port="7000,7001" type="servers">
175 <bind address="1.2.3.4" port="7005" type="servers" ssl="openssl">
178 #-#-#-#-#-#-#-#-#-#- DIE/RESTART CONFIGURATION -#-#-#-#-#-#-#-#-#-#-
180 # You can configure the passwords here which you wish to use for #
181 # the die and restart commands. Only trusted IRCop's who will #
182 # need this ability should know the die and restart password. #
186 # hash: what hash these passwords are hashed with. requires the module
187 # for selected hash (m_md5.so, m_sha256.so or m_ripemd160.so) be
188 # loaded and the password hashing module (m_password_hash.so)
189 # loaded. Options here are: "md5", "sha256" and "ripemd160".
190 # Optional, but recommended. Create hashed password with:
191 # /mkpasswd <hash> <password>
194 # diepass: Password for opers to use if they need to shutdown (die)
198 # restartpass: Password for opers to use if they need to restart
203 #-#-#-#-#-#-#-#-#-#- CONNECTIONS CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
205 # This is where you can configure which connections are allowed #
206 # and denied access onto your server. The password is optional. #
207 # You may have as many of these as you require. To allow/deny all #
208 # connections, use a '*' or 0.0.0.0/0. #
210 # -- It is important to note that connect tags are read from the -- #
211 # TOP DOWN. This means that you should have more specific deny #
212 # and allow tags at the top, progressively more general, followed #
213 # by a <connect allow="*" (should you wish to have one). #
215 # Connect blocks are searched twice for each user - once when the TCP #
216 # connection is accepted, and once when the user completes their #
217 # registration. Most of the information (hostname, ident response, #
218 # password, SSL when using STARTTLS, etc) is only available during #
219 # the second search, so if you are trying to make a closed server, #
220 # you will probably need a connect block just for user registration. #
221 # This can be done by using <connect registered="no"> #
224 # deny: Will not let people connect if they have specified host/IP.
227 # connect:reason is the message that users will see if they match a deny block
228 <connect deny="3ffe::0/32" reason="The 6bone address space is deprecated">
231 # name: Name to use for this connect block. Mainly used for
232 # connect class inheriting.
235 # parent: This setting is to specify if this connect class
236 # inherits settings from any other. Put the other class's name
237 # in here to use its settings as a template - for example, if
238 # you only want to adjust sendq and a password
241 # allow: What IP addresses/hosts to allow for this block.
244 # hash: what hash this password is hashed with. requires the module
245 # for selected hash (m_md5.so, m_sha256.so or m_ripemd160.so) be
246 # loaded and the password hashing module (m_password_hash.so)
247 # loaded. Options here are: "md5", "sha256" and "ripemd160".
248 # Optional, but recommended. Create hashed password with:
249 # /mkpasswd <hash> <password>
252 # password: Password to use for this block/user(s)
255 # maxchans: Maximum number of channels a user in this class
256 # be in at one time. This overrides every other maxchans setting.
259 # timeout: How long (in seconds) the server will wait before
260 # disconnecting a user if they do not do anything on connect.
261 # (Note, this is a client-side thing, if the client does not
262 # send /nick, /user or /pass)
265 # localmax: Maximum local connections per IP (or CIDR mask, see below).
268 # globalmax: Maximum global (network-wide) connections per IP (or CIDR mask, see below).
271 # maxconnwarn: Enable warnings when localmax or globalmax is hit (defaults to on)
274 # usednsbl: Defines whether or not users in this class are subject to DNSBL. Default is yes.
275 # This setting only has effect when m_dnsbl is loaded.
278 # useident: Defines if users in this class MUST respond to a ident query or not.
281 # limit: How many users are allowed in this class
284 # modes: Usermodes that are set on users in this block on connect.
285 # Enabling this option requires that the m_conn_umodes module be loaded.
286 # This entry is highly recommended to use for/with IP Cloaking/masking.
287 # For the example to work, this also requires that the m_cloaking
288 # module be loaded as well.
291 # requireident, requiressl, requireaccount: require that users of this
292 # block have a valid ident response, use SSL, or have authenticated.
293 # Requires m_ident, m_sslinfo, or m_services_account respectively.
295 # NOTE: For requireaccount, you must complete the signon prior to full
296 # connection. Currently, this is only possible by using SASL
297 # authentication; passforward and PRIVMSG NickServ happen after
298 # your final connect block has been found.
300 # Alternate MOTD file for this connect class. The contents of this file are
301 # specified using <files secretmotd="filename"> or <execfiles ...>
304 # Allow color codes to be processed in the message of the day file.
305 # the following characters are valid color code escapes:
307 # \037 or \u = Underline
308 # \003 or \c = Color (with a code postfixed to this char)
309 # \017 or \x = Stop all color sequences
310 allowmotdcolors="false"
312 # port: What port this user is allowed to connect on. (optional)
313 # The port MUST be set to listen in the bind blocks above.
317 # name: Name to use for this connect block. Mainly used for
318 # connect class inheriting.
321 # allow: What IP addresses/hosts to allow for this block.
324 # maxchans: Maximum number of channels a user in this class
325 # be in at one time. This overrides every other maxchans setting.
328 # timeout: How long (in seconds) the server will wait before
329 # disconnecting a user if they do not do anything on connect.
330 # (Note, this is a client-side thing, if the client does not
331 # send /nick, /user or /pass)
334 # pingfreq: How often (in seconds) the server tries to ping connecting clients.
337 # hardsendq: maximum amount of data allowed in a client's send queue
338 # before they are dropped. Keep this value higher than the length of
339 # your network's /LIST or /WHO output, or you will have lots of
340 # disconnects from sendq overruns!
343 # softsendq: amount of data in a client's send queue before the server
344 # begins delaying their commands in order to allow the sendq to drain
347 # recvq: amount of data allowed in a client's queue before they are dropped.
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 # useident: Defines if users in this class must respond to a ident query or not.
382 # limit: How many users are allowed in this class
385 # modes: Usermodes that are set on users in this block on connect.
386 # Enabling this option requires that the m_conn_umodes module be loaded.
387 # This entry is highly recommended to use for/with IP Cloaking/masking.
388 # For the example to work, this also requires that the m_cloaking
389 # module be loaded as well.
393 #-#-#-#-#-#-#-#-#-#-#-#- CIDR CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-
395 # CIDR configuration allows detection of clones and applying of #
396 # throttle limits across a CIDR range. (A CIDR range is a group of #
397 # IPs, for example, the CIDR range 192.168.1.0-192.168.1.255 may be #
398 # represented as 192.168.1.0/24). This means that abuse across an ISP #
399 # is detected and curtailed much easier. Here is a good chart that #
400 # shows how many IPs the different CIDRs correspond to: #
401 # http://en.wikipedia.org/wiki/CIDR#Prefix_aggregation #
405 # ipv4clone: specifies how many bits of an IP address should be
406 # looked at for clones. The default only looks for clones on a
407 # single IP address of a user. You do not want to set this
408 # extremely low. (Values are 0-32).
411 # ipv6clone: specifies how many bits of an IP address should be
412 # looked at for clones. The default only looks for clones on a
413 # single IP address of a user. You do not want to set this
414 # extremely low. (Values are 0-128).
417 # This file has all the information about oper classes, types and o:lines.
418 # You *MUST* edit it.
419 <include file="conf/examples/opers.conf.example">
421 # This file has all the information about server links and ulined servers.
422 # You *MUST* edit it if you intend to link servers.
423 <include file="conf/examples/links.conf.example">
425 #-#-#-#-#-#-#-#-#-#- MISCELLANEOUS CONFIGURATION -#-#-#-#-#-#-#-#-#-#
428 # Files block - contains files whose contents are used by the ircd
430 # motd - displayed on connect and when a user executes /MOTD
431 # rules - displayed when the user executes /RULES
432 # Modules can also define their own files
433 <files motd="conf/examples/motd.txt.example" rules="conf/examples/rules.txt.example">
435 # Example of an executable file include. Note this will be read on rehash,
436 # not when the command is run.
437 #<execfiles rules="wget -O - http://www.example.com/rules.txt">
439 #-#-#-#-#-#-#-#-#-#-#-# MAXIMUM CHANNELS -#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
443 # users: Maximum number of channels a user can be in at once.
446 # opers: Maximum number of channels a oper can be in at once.
449 #-#-#-#-#-#-#-#-#-#-#-#-#-#-# DNS SERVER -#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
450 # If these values are not defined, InspIRCd uses the default DNS resolver
454 # server: DNS server to use to attempt to resolve IP's to hostnames.
455 # in most cases, you won't need to change this, as inspircd will
456 # automatically detect the nameserver depending on /etc/resolv.conf
457 # (or, on windows, your set nameservers in the registry.)
458 # Note that this must be an IP address and not a hostname, because
459 # there is no resolver to resolve the name until this is defined!
463 # timeout: seconds to wait to try to resolve DNS/hostname.
466 # An example of using an IPv6 nameserver
467 #<dns server="::1" timeout="5">
469 #-#-#-#-#-#-#-#-#-#-#-#-#-#-# PID FILE -#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
471 # Define the path to the PID file here. The PID file can be used to #
472 # rehash the ircd from the shell or to terminate the ircd from the #
473 # shell using shell scripts, perl scripts, etc... and to monitor the #
474 # ircd's state via cron jobs. If this is a relative path, it will be #
475 # relative to the configuration directory, and if it is not defined, #
476 # the default of 'inspircd.pid' is used. #
479 #<pid file="/path/to/inspircd.pid">
481 #-#-#-#-#-#-#-#-#-#-#-#-#- BANLIST LIMITS #-#-#-#-#-#-#-#-#-#-#-#-#-#-#
483 # Use these tags to customise the ban limits on a per channel basis. #
484 # The tags are read from top to bottom, and any tag found which #
485 # matches the channels name applies the banlimit to that channel. #
486 # It is advisable to put an entry with the channel as '*' at the #
487 # bottom of the list. If none are specified or no maxbans tag is #
488 # matched, the banlist size defaults to 64 entries. #
491 <banlist chan="#morons" limit="128">
492 <banlist chan="*" limit="69">
494 #-#-#-#-#-#-#-#-#-#-#- DISABLED FEATURES -#-#-#-#-#-#-#-#-#-#-#-#-#-#
496 # This tag is optional, and specifies one or more features which are #
497 # not available to non-operators. #
499 # For example you may wish to disable NICK and prevent non-opers from #
500 # changing their nicknames. #
501 # Note that any disabled commands take effect only after the user has #
502 # 'registered' (e.g. after the initial USER/NICK/PASS on connection) #
503 # so for example disabling NICK will not cripple your network. #
505 # You can also define if you want to disable any channelmodes #
506 # or usermodes from your users. #
508 # `fakenonexistant' will make the ircd pretend that nonexistant #
509 # commands simply don't exist to non-opers ("no such command"). #
511 #<disabled commands="TOPIC MODE" usermodes="" chanmodes="" fakenonexistant="yes">
514 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#- RTFM LINE -#-#-#-#-#-#-#-#-#-#-#-#-#-#
516 # Just remove this... Its here to make you read ALL of the config #
519 <die value="You should probably edit your config *PROPERLY* and try again.">
523 #-#-#-#-#-#-#-#-#-#-#-#-#- SERVER OPTIONS -#-#-#-#-#-#-#-#-#-#-#-#-#
525 # Settings to define which features are usable on your server. #
529 # prefixquit: What (if anything) a users' quit message
530 # should be prefixed with.
533 # suffixquit: What (if anything) a users' quit message
534 # should be suffixed with.
537 # prefixpart: What (if anything) a users' part message
538 # should be prefixed with.
540 # NOTE: Use "\"" instead of """ if not using <config format="xml">
542 # suffixpart: What (if anything) a users' part message
543 # should be suffixed with.
546 # fixedquit: Set all users' quit messages to this value.
549 # fixedpart: Set all users' part messages in all channels
553 # syntaxhints: If enabled, if a user fails to send the correct parameters
554 # for a command, the ircd will give back some help text of what
555 # the correct parameters are.
558 # cyclehosts: If enabled, when a user gets a host set, it will cycle
559 # them in all their channels. If not, it will simply change their host
560 # without cycling them.
563 # cyclehostsfromuser: If enabled, the source of the mode change for
564 # cyclehosts will be the user who cycled. This can look nicer, but
565 # triggers anti-takeover mechanisms of some obsolete bots.
566 cyclehostsfromuser="no"
568 # ircumsgprefix: Use undernet-style message prefixing for NOTICE and
569 # PRIVMSG. If enabled, it will add users' prefix to the line, if not,
570 # it will just message the user normally.
573 # announcets: If set to yes, when the TimeStamp on a channel changes, all users
574 # in channel will be sent a NOTICE about it.
577 # allowmismatch: Setting this option to yes will allow servers to link even
578 # if they don't have the same VF_OPTCOMMON modules loaded. Setting this to
579 # yes may introduce some desyncs and weirdness.
582 # defaultbind: Sets the default for <bind> tags without an address. Choices are
583 # ipv4 or ipv6; if not specified, IPv6 will be used if your system has support,
584 # falling back to IPv4 otherwise.
587 # hostintopic: If enabled, channels will show the host of the topicsetter
588 # in the topic. If set to no, it will only show the nick of the topicsetter.
591 # pingwarning: If a server does not respond to a ping within x seconds,
592 # it will send a notice to opers with snomask +l informing that the server
593 # is about to ping timeout.
596 # serverpingfreq: How often pings are sent between servers (in seconds).
599 # defaultmodes: What modes are set on a empty channel when a user
600 # joins it and it is unregistered. This is similar to Asuka's
604 # moronbanner: This is the text that is sent to a user when they are
605 # banned from the server.
606 moronbanner="You're banned! Email haha@abuse.com with the ERROR line below for help."
608 # exemptchanops: exemptions for channel access restrictions based on prefix.
609 exemptchanops="nonick:v flood:o"
611 # invitebypassmodes: This allows /invite to bypass other channel modes.
612 # (Such as +k, +j, +l, etc)
613 invitebypassmodes="yes"
615 # nosnoticestack: This prevents snotices from 'stacking' and giving you
616 # the message saying '(last message repeated X times)'. Defaults to no.
620 #-#-#-#-#-#-#-#-#-#-#-# PERFORMANCE CONFIGURATION #-#-#-#-#-#-#-#-#-#-#
624 # netbuffersize: Size of the buffer used to recieve data from clients.
625 # The ircd may only read this amount of text in 1 go at any time.
626 netbuffersize="10240"
628 # maxwho: Maximum number of results to show in a /who query.
631 # somaxconn: The maximum number of connections that may be waiting
632 # in the accept queue. This is *NOT* the total maximum number of
633 # connections per server. Some systems may only allow this to be up
634 # to 5, while others (such as linux and *BSD) default to 128.
637 # softlimit: This optional feature allows a defined softlimit for
638 # connections. If defined, it sets a soft max connections value.
641 # quietbursts: When syncing or splitting from a network, a server
642 # can generate a lot of connect and quit messages to opers with
643 # +C and +Q snomasks. Setting this to yes squelches those messages,
644 # which makes it easier for opers, but degrades the functionality of
645 # bots like BOPM during netsplits.
648 # nouserdns: If enabled, no DNS lookups will be performed on
649 # connecting users. This can save a lot of resources on very busy servers.
652 #-#-#-#-#-#-#-#-#-#-#-# SECURITY CONFIGURATION #-#-#-#-#-#-#-#-#-#-#-#
657 # announceinvites: This option controls which members of the channel
658 # receive an announcement when someone is INVITEd. Available values:
659 # 'none' - don't send invite announcements
660 # 'all' - send invite announcements to all members
661 # 'ops' - send invite announcements to ops and higher ranked users
662 # 'dynamic' - send invite announcements to halfops (if available) and
663 # higher ranked users. This is the recommended setting.
664 announceinvites="dynamic"
666 # hidemodes: If enabled, then the listmodes given will be hidden
667 # from users below halfop. This is not recommended to be set on +b
668 # as it may break some functionality in popular clients such as mIRC.
671 # hideulines: If this value is set to yes, U-lined servers will
672 # be hidden from non-opers in /links and /map.
675 # flatlinks: If this value is set to yes, /map and /links will
676 # be flattened when shown to non-opers.
679 # hidewhois: When defined, the given text will be used in place
680 # of the server a user is on when whoised by a non-oper. Most
681 # networks will want to set this to something like "*.netname.net"
682 # to conceal the actual server a user is on.
683 # Note that enabling this will cause users' idle times to only be
684 # shown when the format /WHOIS <nick> <nick> is used.
687 # hidebans: If this value is set to yes, when a user is banned ([gkz]lined)
688 # only opers will see the ban message when the user is removed
692 # hidekills: If defined, replaces who set a /kill with a custom string.
695 # hidesplits: If enabled, non-opers will not be able to see which
696 # servers split in a netsplit, they will only be able to see that one
697 # occurred (If their client has netsplit detection).
700 # maxtargets: Maximum number of targets per command.
701 # (Commands like /notice, /privmsg, /kick, etc)
704 # customversion: Displays a custom string when a user /version's
705 # the ircd. This may be set for security reasons or vanity reasons.
708 # operspywhois: show opers (users/auspex) the +s channels a user is in. Values:
709 # splitmsg Split with an explanatory message
710 # yes Split with no explanatory message
714 # runasuser: If this is set, InspIRCd will attempt to setuid
715 # to run as this user- allows binding of ports under 1024.
716 # NOT SUPPORTED/NEEDED UNDER WINDOWS.
719 # runasgroup: If this is set, InspIRCd will attempt to set group
720 # to run under this group, which allows binding of ports under 1024
721 # NOT SUPPORTED/NEEDED UNDER WINDOWS.
724 # restrictbannedusers: If this is set to yes, InspIRCd will not allow users
725 # banned on a channel to change nickname or message channels they are
727 restrictbannedusers="yes"
729 # genericoper: Setting this value to yes makes all opers on this server
730 # appear as 'is an IRC operator' in their WHOIS, regardless of their
731 # oper type, however oper types are still used internally. This only
732 # affects the display in WHOIS.
735 # userstats: /stats commands that users can run (opers can run all).
738 #-#-#-#-#-#-#-#-#-#-#-#-# LIMITS CONFIGURATION #-#-#-#-#-#-#-#-#-#-#-#
740 # This configuration tag defines the maximum sizes of various types #
741 # on IRC, such as the maximum length of a channel name, and the #
742 # maximum length of a channel. Note that with the exception of the #
743 # identmax value all values given here are the exact values you would #
744 # expect to see on IRC. This contrasts with the older InspIRCd #
745 # releases where these values would be one character shorter than #
746 # defined to account for a null terminator on the end of the text. #
748 # These values should match network-wide otherwise issues will occur. #
750 # The highest safe value you can set any of these options to is 500, #
751 # but it is recommended that you keep them somewhat #
752 # near their defaults (or lower). #
755 # maxnick: Maximum length of a nickname.
758 # maxchan: Maximum length of a channel name.
761 # maxmodes: Maximum number of mode changes per line.
764 # maxident: Maximum length of a ident/username.
767 # maxquit: Maximum length of a quit message.
770 # maxtopic: Maximum length of a channel topic.
773 # maxkick: Maximum length of a kick message.
776 # maxgecos: Maximum length of a GECOS (realname).
779 # maxaway: Maximum length of an away message.
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 (m_filter)
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="*@hundredz.n.hundredz.o.1337.kiddies.com"
887 # reason: Reason to display when user is disconnected
888 reason="Too many 1337 kiddiots">
890 <badhost host="root@*" reason="Don't irc as root!">
891 <badhost host="*@172.32.0.0/16" 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.host.com"
899 # reason: Reason for exception. Only shown in /stats e
900 reason="Opers 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. Insert new user and press any key. (you didn't edit your config properly.)">
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="conf/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="conf/examples/modules/unrealircd.conf.example">
965 # Settings similar to Charybdis IRCd defaults.
966 #<include file="conf/examples/modules/charybdis.conf.example">
969 #########################################################################
971 # - InspIRCd Development Team - #
972 # http://www.inspircd.org #
974 #########################################################################