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 #-#-#-#-#-#-#-#-#-# INCLUDE CONFIGURATION #-#-#-#-#-#-#-#-#-#-#-#-#-#
39 # This optional tag allows you to include another config file #
40 # allowing you to keep your configuration tidy. The configuration #
41 # file you include will be treated as part of the configuration file #
42 # which includes it, in simple terms the inclusion is transparent. #
44 # All paths to config files are relative to the directory that the #
47 # You may also include an executable file, in which case if you do so #
48 # the output of the executable on the standard output will be added #
49 # to your config at the point of the include tag. #
51 # Syntax is as follows: #
52 #<include file="file.conf"> #
53 #<include executable="/path/to/executable parameters"> #
55 # Executable include example: #
56 #<include executable="/usr/bin/wget -q -O - http://example.com/inspircd.conf">
60 #-#-#-#-#-#-#-#-#-#-#-# VARIABLE DEFINITIONS -#-#-#-#-#-#-#-#-#-#-#-#
62 # You can define variables that will be substituted later in the #
63 # configuration file. This can be useful to allow settings to be #
64 # easily changed, or to parameterize a remote includes. #
66 # Variables may be redefined and may reference other variables. #
67 # Value expansion happens at the time the tag is read. #
69 # Using variable definitions REQUIRES that the config format be #
70 # changed to "xml" from the default "compat" that uses escape #
71 # sequences such as "\"" and "\n", and does not support <define> #
73 <define name="bindip" value="1.2.2.3">
74 <define name="localips" value="&bindip;/24">
76 #-#-#-#-#-#-#-#-#-#-#-#- SERVER DESCRIPTION -#-#-#-#-#-#-#-#-#-#-#-#-
78 # Here is where you enter the information about your server. #
82 # name: Hostname of your server. Does not need to resolve, but
83 # does need to be correct syntax (something.somethingelse.tld).
84 name="penguin.omega.example.org"
86 # description: Server description. Spaces are allowed.
87 description="Waddle World"
89 # id: The SID to use for this server. This should not be uncommented
90 # unless there is a SID conflict. This must be three characters long.
91 # The first character must be a digit [0-9], the remaining two chars
92 # may be letters [A-Z] or digits.
95 # network: Network name given on connect to clients.
96 # Should be the same on all servers on the network and
101 #-#-#-#-#-#-#-#-#-#-#-#- ADMIN INFORMATION -#-#-#-#-#-#-#-#-#-#-#-#
103 # Describes the Server Administrator's real name (optionally), #
104 # nick, and email address. #
109 name="Johnny English"
111 # nick: Nickname (preferably what you use on the network)
114 # email: email address. Does not have to be valid
115 # but should be for the users to be able to contact you.
116 email="MI5@the.best.secret.agent">
119 #-#-#-#-#-#-#-#-#-#-#-#- PORT CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-
121 # Enter the port and address bindings here. #
124 # ____ _ _____ _ _ ____ _ _ _ #
125 # | _ \ ___ __ _ __| | |_ _| |__ (_)___ | __ )(_) |_| | #
126 # | |_) / _ \/ _` |/ _` | | | | '_ \| / __| | _ \| | __| | #
127 # | _ < __/ (_| | (_| | | | | | | | \__ \ | |_) | | |_|_| #
128 # |_| \_\___|\__,_|\__,_| |_| |_| |_|_|___/ |____/|_|\__(_) #
130 # If you want to link servers to InspIRCd you must load the #
131 # m_spanningtree.so module! Please see the modules list for #
132 # information on how to load this module! If you do not load this #
133 # module, server ports will NOT work! #
136 # address: IP address to bind to if the box that you are hosting
137 # on has more than one IP, else the ircd will try to bind to all
138 # IP's on the box if this is not defined.
141 # port: Port for users or servers to be able to connect to.
142 # you can select multiple ports by separating them
143 # with a - character like the example below.
146 # type: Type of bind block this is. It can either be clients or
147 # servers. Whichever you select will be the only type able to connect
148 # to this bind section.
151 # ssl: If you want the port(s) in this bind tag to use SSL, set this
152 # to either "gnutls" or "openssl". The appropriate SSL module must be
153 # loaded for SSL to work. If you do not want the port(s) in this bind
154 # tag to support SSL, just remove or comment out this option.
158 <bind address="" port="6660-6669" type="clients">
160 # When linking servers, the OpenSSL and GnuTLS implementations are completely
161 # link-compatible and can be used alongside each other
162 # on each end of the link without any significant issues.
163 # Supported SSL types are: "openssl" and "gnutls".
164 # You must load m_ssl_openssl for OpenSSL or m_ssl_gnutls for GnuTLS.
166 <bind address="" port="7000,7001" type="servers">
167 <bind address="1.2.3.4" port="7005" type="servers" ssl="openssl">
170 #-#-#-#-#-#-#-#-#-#- DIE/RESTART CONFIGURATION -#-#-#-#-#-#-#-#-#-#-
172 # You can configure the passwords here which you wish to use for #
173 # the /DIE and /RESTART commands. Only trusted ircops who will #
174 # need this ability should know the die and restart password. #
178 # hash: what hash these passwords are hashed with.
179 # Requires the module for selected hash (m_md5.so, m_sha256.so
180 # or m_ripemd160.so) be loaded and the password hashing module
181 # (m_password_hash.so) loaded.
182 # Options here are: "md5", "sha256" and "ripemd160", or one of
183 # these prefixed with "hmac-", e.g.: "hmac-sha256".
184 # Optional, but recommended. Create hashed passwords with:
185 # /mkpasswd <hash> <password>
188 # diepass: Password for opers to use if they need to shutdown (die)
191 # IMPORTANT: leaving this field empty does not disable the use of
192 # the DIE command. In order to prevent the use of this command you
193 # should remove it from the command privileges of your opers.
196 # restartpass: Password for opers to use if they need to restart
199 # IMPORTANT: leaving this field empty does not disable the use of
200 # the RESTART command. In order to prevent the use of this command
201 # you should remove it from the command privileges of your opers.
205 #-#-#-#-#-#-#-#-#-#- CONNECTIONS CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
207 # This is where you can configure which connections are allowed #
208 # and denied access onto your server. The password is optional. #
209 # You may have as many of these as you require. To allow/deny all #
210 # connections, use a '*' or 0.0.0.0/0. #
212 # -- It is important to note that connect tags are read from the -- #
213 # TOP DOWN. This means that you should have more specific deny #
214 # and allow tags at the top, progressively more general, followed #
215 # by a <connect allow="*" (should you wish to have one). #
217 # Connect blocks are searched twice for each user - once when the TCP #
218 # connection is accepted, and once when the user completes their #
219 # registration. Most of the information (hostname, ident response, #
220 # password, SSL when using STARTTLS, etc) is only available during #
221 # the second search, so if you are trying to make a closed server, #
222 # you will probably need a connect block just for user registration. #
223 # This can be done by using <connect registered="no"> #
226 # deny: Will not let people connect if they have specified host/IP.
229 # connect:reason is the message that users will see if they match a deny block
230 <connect deny="3ffe::0/32" reason="The 6bone address space is deprecated">
233 # name: Name to use for this connect block. Mainly used for
234 # connect class inheriting.
237 # parent: This setting is to specify if this connect class
238 # inherits settings from any other. Put the other class's name
239 # in here to use its settings as a template - for example, if
240 # you only want to adjust sendq and a password
243 # allow: What IP addresses/hosts to allow for this block.
246 # hash: what hash this password is hashed with. requires the module
247 # for selected hash (m_md5.so, m_sha256.so or m_ripemd160.so) be
248 # loaded and the password hashing module (m_password_hash.so)
249 # loaded. Options here are: "md5", "sha256" and "ripemd160".
250 # Optional, but recommended. Create hashed passwords with:
251 # /mkpasswd <hash> <password>
254 # password: Password to use for this block/user(s)
257 # maxchans: Maximum number of channels a user in this class
258 # be in at one time. This overrides every other maxchans setting.
261 # timeout: How long (in seconds) the server will wait before
262 # disconnecting a user if they do not do anything on connect.
263 # (Note, this is a client-side thing, if the client does not
264 # send /nick, /user or /pass)
267 # localmax: Maximum local connections per IP (or CIDR mask, see below).
270 # globalmax: Maximum global (network-wide) connections per IP (or CIDR mask, see below).
273 # maxconnwarn: Enable warnings when localmax or globalmax are reached (defaults to on)
276 # usednsbl: Defines whether or not users in this class are subject to DNSBL. Default is yes.
277 # This setting only has effect when m_dnsbl is loaded.
280 # useident: Defines if users in this class MUST respond to a ident query or not.
283 # limit: How many users are allowed in this class
286 # modes: Usermodes that are set on users in this block on connect.
287 # Enabling this option requires that the m_conn_umodes module be loaded.
288 # This entry is highly recommended to use for/with IP Cloaking/masking.
289 # For the example to work, this also requires that the m_cloaking
290 # module be loaded as well.
293 # requireident, requiressl, requireaccount: require that users of this
294 # block have a valid ident response, use SSL, or have authenticated.
295 # Requires m_ident, m_sslinfo, or m_services_account respectively.
297 # NOTE: For requireaccount, you must complete the signon prior to full
298 # connection. Currently, this is only possible by using SASL
299 # authentication; passforward and PRIVMSG NickServ happen after
300 # your final connect block has been found.
302 # Alternate MOTD file for this connect class. The contents of this file are
303 # specified using <files secretmotd="filename"> or <execfiles ...>
306 # Allow color codes to be processed in the message of the day file.
307 # the following characters are valid color code escapes:
309 # \037 or \u = Underline
310 # \003 or \c = Color (with a code postfixed to this char)
311 # \017 or \x = Stop all color sequences
312 allowmotdcolors="false"
314 # port: What port this user is allowed to connect on. (optional)
315 # The port MUST be set to listen in the bind blocks above.
319 # name: Name to use for this connect block. Mainly used for
320 # connect class inheriting.
323 # allow: What IP addresses/hosts to allow for this block.
326 # maxchans: Maximum number of channels a user in this class
327 # be in at one time. This overrides every other maxchans setting.
330 # timeout: How long (in seconds) the server will wait before
331 # disconnecting a user if they do not do anything on connect.
332 # (Note, this is a client-side thing, if the client does not
333 # send /nick, /user or /pass)
336 # pingfreq: How often (in seconds) the server tries to ping connecting clients.
339 # hardsendq: maximum amount of data allowed in a client's send queue
340 # before they are dropped. Keep this value higher than the length of
341 # your network's /LIST or /WHO output, or you will have lots of
342 # disconnects from sendq overruns!
343 # Setting this to "1M" is equivalent to "1048576", "8K" is 8192, etc.
346 # softsendq: amount of data in a client's send queue before the server
347 # begins delaying their commands in order to allow the sendq to drain
350 # recvq: amount of data allowed in a client's queue before they are dropped.
351 # Entering "8K" is equivalent to "8192", see above.
354 # threshold: This specifies the amount of command penalty a user is allowed to have
355 # before being quit or fakelagged due to flood. Normal commands have a penalty of 1,
356 # ones such as /OPER have penalties up to 10.
358 # If you are not using fakelag, this should be at least 20 to avoid excess flood kills
359 # from processing some commands.
362 # commandrate: This specifies the maximum rate that commands can be processed.
363 # If commands are sent more rapidly, the user's penalty will increase and they will
364 # either be fakelagged or killed when they reach the threshold
366 # Units are millicommands per second, so 1000 means one line per second.
369 # fakelag: Use fakelag instead of killing users for excessive flood
371 # Fake lag stops command processing for a user when a flood is detected rather than
372 # immediately killing them; their commands are held in the recvq and processed later
373 # as the user's command penalty drops. Note that if this is enabled, flooders will
374 # quit with "RecvQ exceeded" rather than "Excess Flood".
377 # localmax: Maximum local connections per IP.
380 # globalmax: Maximum global (network-wide) connections per IP.
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 m_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 m_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 # https://en.wikipedia.org/wiki/IPv4_subnetting_reference #
406 # https://en.wikipedia.org/wiki/IPv6_subnetting_reference #
410 # ipv4clone: specifies how many bits of an IP address should be
411 # looked at for clones. The default only looks for clones on a
412 # single IP address of a user. You do not want to set this
413 # extremely low. (Values are 0-32).
416 # ipv6clone: specifies how many bits of an IP address should be
417 # looked at for clones. The default only looks for clones on a
418 # single IP address of a user. You do not want to set this
419 # extremely low. (Values are 0-128).
422 # This file has all the information about oper classes, types and o:lines.
423 # You *MUST* edit it.
424 <include file="conf/examples/opers.conf.example">
426 # This file has all the information about server links and ulined servers.
427 # You *MUST* edit it if you intend to link servers.
428 <include file="conf/examples/links.conf.example">
430 #-#-#-#-#-#-#-#-#-#- MISCELLANEOUS CONFIGURATION -#-#-#-#-#-#-#-#-#-#
433 # Files block - contains files whose contents are used by the ircd
435 # motd - displayed on connect and when a user executes /MOTD
436 # rules - displayed when the user executes /RULES
437 # Modules can also define their own files
438 <files motd="conf/examples/motd.txt.example" rules="conf/examples/rules.txt.example">
440 # Example of an executable file include. Note this will be read on rehash,
441 # not when the command is run.
442 #<execfiles rules="wget -O - http://www.example.com/rules.txt">
444 #-#-#-#-#-#-#-#-#-#-#-# MAXIMUM CHANNELS -#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
448 # users: Maximum number of channels a user can be in at once.
451 # opers: Maximum number of channels an oper can be in at once.
454 #-#-#-#-#-#-#-#-#-#-#-#-#-#-# DNS SERVER -#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
455 # If these values are not defined, InspIRCd uses the default DNS resolver
459 # server: DNS server to use to attempt to resolve IP's to hostnames.
460 # in most cases, you won't need to change this, as inspircd will
461 # automatically detect the nameserver depending on /etc/resolv.conf
462 # (or, on Windows, your set nameservers in the registry.)
463 # Note that this must be an IP address and not a hostname, because
464 # there is no resolver to resolve the name until this is defined!
468 # timeout: seconds to wait to try to resolve DNS/hostname.
471 # An example of using an IPv6 nameserver
472 #<dns server="::1" timeout="5">
474 #-#-#-#-#-#-#-#-#-#-#-#-#-#-# PID FILE -#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
476 # Define the path to the PID file here. The PID file can be used to #
477 # rehash the ircd from the shell or to terminate the ircd from the #
478 # shell using shell scripts, perl scripts, etc... and to monitor the #
479 # ircd's state via cron jobs. If this is a relative path, it will be #
480 # relative to the configuration directory, and if it is not defined, #
481 # the default of 'inspircd.pid' is used. #
484 #<pid file="/path/to/inspircd.pid">
486 #-#-#-#-#-#-#-#-#-#-#-#-#- BANLIST LIMITS #-#-#-#-#-#-#-#-#-#-#-#-#-#-#
488 # Use these tags to customise the ban limits on a per channel basis. #
489 # The tags are read from top to bottom, and any tag found which #
490 # matches the channels name applies the banlimit to that channel. #
491 # It is advisable to put an entry with the channel as '*' at the #
492 # bottom of the list. If none are specified or no maxbans tag is #
493 # matched, the banlist size defaults to 64 entries. #
496 <banlist chan="#largechan" limit="128">
497 <banlist chan="*" limit="69">
499 #-#-#-#-#-#-#-#-#-#-#- DISABLED FEATURES -#-#-#-#-#-#-#-#-#-#-#-#-#-#
501 # This tag is optional, and specifies one or more features which are #
502 # not available to non-operators. #
504 # For example you may wish to disable NICK and prevent non-opers from #
505 # changing their nicknames. #
506 # Note that any disabled commands take effect only after the user has #
507 # 'registered' (e.g. after the initial USER/NICK/PASS on connection) #
508 # so for example disabling NICK will not cripple your network. #
510 # You can also define if you want to disable any channelmodes #
511 # or usermodes from your users. #
513 # `fakenonexistant' will make the ircd pretend that nonexistant #
514 # commands simply don't exist to non-opers ("no such command"). #
516 #<disabled commands="TOPIC MODE" usermodes="" chanmodes="" fakenonexistant="yes">
519 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#- RTFM LINE -#-#-#-#-#-#-#-#-#-#-#-#-#-#
521 # Just remove this... Its here to make you read ALL of the config #
524 <die value="You should probably edit your config *PROPERLY* and try again.">
528 #-#-#-#-#-#-#-#-#-#-#-#-#- SERVER OPTIONS -#-#-#-#-#-#-#-#-#-#-#-#-#
530 # Settings to define which features are usable on your server. #
534 # prefixquit: What (if anything) users' quit messages
535 # should be prefixed with.
538 # suffixquit: What (if anything) users' quit messages
539 # should be suffixed with.
542 # prefixpart: What (if anything) users' part messages
543 # should be prefixed with.
545 # NOTE: Use "\"" instead of """ if not using <config format="xml">
547 # suffixpart: What (if anything) users' part message
548 # should be suffixed with.
551 # fixedquit: Set all users' quit messages to this value.
554 # fixedpart: Set all users' part messages in all channels
558 # syntaxhints: If enabled, if a user fails to send the correct parameters
559 # for a command, the ircd will give back some help text of what
560 # the correct parameters are.
563 # cyclehosts: If enabled, when a user gets a host set, it will cycle
564 # them in all their channels. If not, it will simply change their host
565 # without cycling them.
568 # cyclehostsfromuser: If enabled, the source of the mode change for
569 # cyclehosts will be the user who cycled. This can look nicer, but
570 # triggers anti-takeover mechanisms of some obsolete bots.
571 cyclehostsfromuser="no"
573 # ircumsgprefix: Use undernet-style message prefixing for NOTICE and
574 # PRIVMSG. If enabled, it will add users' prefix to the line, if not,
575 # it will just message the user normally.
578 # announcets: If set to yes, when the timestamp on a channel changes, all users
579 # in the channel will be sent a NOTICE about it.
582 # allowmismatch: Setting this option to yes will allow servers to link even
583 # if they don't have the same "optionally common" modules loaded. Setting this to
584 # yes may introduce some desyncs and unwanted behaviour.
587 # defaultbind: Sets the default for <bind> tags without an address. Choices are
588 # ipv4 or ipv6; if not specified, IPv6 will be used if your system has support,
589 # falling back to IPv4 otherwise.
592 # hostintopic: If enabled, channels will show the host of the topic setter
593 # in the topic. If set to no, it will only show the nick of the topic setter.
596 # pingwarning: If a server does not respond to a ping within x seconds,
597 # it will send a notice to opers with snomask +l informing that the server
598 # is about to ping timeout.
601 # serverpingfreq: How often pings are sent between servers (in seconds).
604 # defaultmodes: What modes are set on a empty channel when a user
605 # joins it and it is unregistered.
608 # moronbanner: This is the text that is sent to a user when they are
609 # banned from the server.
610 moronbanner="You're banned! Email abuse@example.com with the ERROR line below for help."
612 # exemptchanops: exemptions for channel access restrictions based on prefix.
613 exemptchanops="nonick:v flood:o"
615 # invitebypassmodes: This allows /invite to bypass other channel modes.
616 # (Such as +k, +j, +l, etc.)
617 invitebypassmodes="yes"
619 # nosnoticestack: This prevents snotices from 'stacking' and giving you
620 # the message saying '(last message repeated X times)'. Defaults to no.
623 # welcomenotice: When turned on, this sends a NOTICE to connecting users
624 # with the text Welcome to <networkname>! after successful registration.
629 #-#-#-#-#-#-#-#-#-#-#-# PERFORMANCE CONFIGURATION #-#-#-#-#-#-#-#-#-#-#
633 # netbuffersize: Size of the buffer used to receive data from clients.
634 # The ircd may only read this amount of text in 1 go at any time.
635 netbuffersize="10240"
637 # somaxconn: The maximum number of connections that may be waiting
638 # in the accept queue. This is *NOT* the total maximum number of
639 # connections per server. Some systems may only allow this to be up
640 # to 5, while others (such as Linux and *BSD) default to 128.
643 # limitsomaxconn: By default, somaxconn (see above) is limited to a
644 # safe maximum value in the 2.0 branch for compatibility reasons.
645 # This setting can be used to disable this limit, forcing InspIRCd
646 # to use the value specified above.
647 limitsomaxconn="true"
649 # softlimit: This optional feature allows a defined softlimit for
650 # connections. If defined, it sets a soft max connections value.
653 # quietbursts: When syncing or splitting from a network, a server
654 # can generate a lot of connect and quit messages to opers with
655 # +C and +Q snomasks. Setting this to yes squelches those messages,
656 # which makes it easier for opers, but degrades the functionality of
657 # bots like BOPM during netsplits.
660 # nouserdns: If enabled, no DNS lookups will be performed on
661 # connecting users. This can save a lot of resources on very busy servers.
664 #-#-#-#-#-#-#-#-#-#-#-# SECURITY CONFIGURATION #-#-#-#-#-#-#-#-#-#-#-#
669 # announceinvites: This option controls which members of the channel
670 # receive an announcement when someone is INVITEd. Available values:
671 # 'none' - don't send invite announcements
672 # 'all' - send invite announcements to all members
673 # 'ops' - send invite announcements to ops and higher ranked users
674 # 'dynamic' - send invite announcements to halfops (if available) and
675 # higher ranked users. This is the recommended setting.
676 announceinvites="dynamic"
678 # hidemodes: If enabled, then the listmodes given will be hidden
679 # from users below halfop. This is not recommended to be set on +b
680 # as it may break some functionality in popular clients such as mIRC.
683 # hideulines: If this value is set to yes, U-lined servers will
684 # be hidden from non-opers in /links and /map.
687 # flatlinks: If this value is set to yes, /map and /links will
688 # be flattened when shown to non-opers.
691 # hidewhois: When defined, the given text will be used in place
692 # of the server a user is on when whoised by a non-oper. Most
693 # networks will want to set this to something like "*.netname.net"
694 # to conceal the actual server a user is on.
695 # Note that enabling this will cause users' idle times to only be
696 # shown when the format /WHOIS <nick> <nick> is used.
699 # hidebans: If this value is set to yes, when a user is banned ([gkz]lined)
700 # only opers will see the ban message when the user is removed
704 # hidekills: If defined, replaces who set a /kill with a custom string.
707 # hideulinekills: Hide kills from clients of ulined servers from server notices.
710 # hidesplits: If enabled, non-opers will not be able to see which
711 # servers split in a netsplit, they will only be able to see that one
712 # occurred (If their client has netsplit detection).
715 # maxtargets: Maximum number of targets per command.
716 # (Commands like /notice, /privmsg, /kick, etc)
719 # customversion: Displays a custom string when a user /version's
720 # the ircd. This may be set for security reasons or vanity reasons.
723 # operspywhois: show opers (users/auspex) the +s channels a user is in. Values:
724 # splitmsg Split with an explanatory message
725 # yes Split with no explanatory message
729 # runasuser: If this is set, InspIRCd will attempt to switch
730 # to run as this user, which allows binding of ports under 1024.
731 # You should NOT set this unless you are starting as root.
732 # NOT SUPPORTED/NEEDED UNDER WINDOWS.
735 # runasgroup: If this is set, InspIRCd will attempt to switch
736 # to run as this group, which allows binding of ports under 1024.
737 # You should NOT set this unless you are starting as root.
738 # NOT SUPPORTED/NEEDED UNDER WINDOWS.
741 # restrictbannedusers: If this is set to yes, InspIRCd will not allow users
742 # banned on a channel to change nickname or message channels they are
744 restrictbannedusers="yes"
746 # genericoper: Setting this value to yes makes all opers on this server
747 # appear as 'is an IRC operator' in their WHOIS, regardless of their
748 # oper type, however oper types are still used internally. This only
749 # affects the display in WHOIS.
752 # userstats: /stats commands that users can run (opers can run all).
755 #-#-#-#-#-#-#-#-#-#-#-#-# LIMITS CONFIGURATION #-#-#-#-#-#-#-#-#-#-#-#
757 # This configuration tag defines the maximum sizes of various types #
758 # on IRC, such as the maximum length of a channel name, and the #
759 # maximum length of a channel. Note that with the exception of the #
760 # identmax value all values given here are the exact values you would #
761 # expect to see on IRC. This contrasts with the older InspIRCd #
762 # releases where these values would be one character shorter than #
763 # defined to account for a null terminator on the end of the text. #
765 # These values should match network-wide otherwise issues will occur. #
767 # The highest safe value you can set any of these options to is 500, #
768 # but it is recommended that you keep them somewhat #
769 # near their defaults (or lower). #
772 # maxnick: Maximum length of a nickname.
775 # maxchan: Maximum length of a channel name.
778 # maxmodes: Maximum number of mode changes per line.
781 # maxident: Maximum length of a ident/username.
784 # maxquit: Maximum length of a quit message.
787 # maxtopic: Maximum length of a channel topic.
790 # maxkick: Maximum length of a kick message.
793 # maxgecos: Maximum length of a GECOS (realname).
796 # maxaway: Maximum length of an away message.
800 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
804 # Logging is covered with the <log> tag, which you may use to change
805 # the behaviour of the logging of the IRCd.
807 # An example log tag would be:
808 # <log method="file" type="OPER" level="default" target="logs/opers.log">
809 # which would log all information on /oper (failed and successful) to
810 # a file called opers.log.
812 # There are many different types which may be used, and modules may
813 # generate their own. A list of useful types:
814 # - USERS - information relating to user connection and disconnection
815 # - OPER - succesful and failed oper attempts
816 # - KILL - kill related messages
817 # - snomask - server notices (*all* snomasks will be logged)
818 # - FILTER - messages related to filter matches (m_filter)
819 # - CONFIG - configuration related messages
820 # - COMMAND - die and restart messages, and messages related to unknown user types
821 # - SOCKET - socket engine informational/error messages
822 # - MODULE - module related messages
823 # - STARTUP - messages related to starting up the server
825 # You may also log *everything* by using a type of *, and subtract things out
826 # of that by using -TYPE - for example "* -USERINPUT -USEROUTPUT".
829 # - default (general messages, including errors)
830 # - sparse (misc error messages)
831 # - debug (debug messages)
833 # Some types only produce output in the debug level, those are:
834 # - BANCACHE - ban cache debug messages
835 # - CHANNELS - information relating to joining/creating channels
836 # - CULLLIST - debug messages related to issues with removing users
837 # - RESOLVER - DNS related debug messages
838 # - CONNECTCLASS - Connection class debug messages
842 # The following log tag is highly default and uncustomised. It is recommended you
843 # sort out your own log tags. This is just here so you get some output.
845 <log method="file" type="* -USERINPUT -USEROUTPUT" level="default" target="logs/ircd.log">
847 #-#-#-#-#-#-#-#-#-#-#-#-#- WHOWAS OPTIONS -#-#-#-#-#-#-#-#-#-#-#-#-#
849 # This tag lets you define the behaviour of the /whowas command of #
854 # groupsize: Maximum entries per nick shown when performing
858 # maxgroups: Maximum number of nickgroups that can be added to
859 # the list so that /whowas does not use a lot of resources on
863 # maxkeep: Maximum time a nick is kept in the whowas list
864 # before being pruned. Time may be specified in seconds,
865 # or in the following format: 1y2w3d4h5m6s. Minimum is
869 #-#-#-#-#-#-#-#-#-#-#-#-#-#- BAN OPTIONS -#-#-#-#-#-#-#-#-#-#-#-#-#-#
871 # The ban tags define nick masks, host masks and ip ranges which are #
872 # banned from your server. All details in these tags are local to #
877 # ipmask: IP range to ban. Wildcards and CIDR can be used.
880 # reason: Reason to display when user is disconnected.
881 reason="No porn here thanks.">
884 # nick: Nick to disallow. Wildcards are supported.
887 # reason: Reason to display on /nick.
888 reason="Reserved For Services">
890 <badnick nick="NickServ" reason="Reserved For Services">
891 <badnick nick="OperServ" reason="Reserved For Services">
892 <badnick nick="MemoServ" reason="Reserved For Services">
895 # host: ident@hostname to ban.
896 # Wildcards and CIDR (if you specify an IP) can be used.
897 host="*@banneduser.example.net"
899 # reason: Reason to display when user is disconnected
900 reason="Evading Bans">
902 <badhost host="root@*" reason="Don't IRC as root!">
903 <badhost host="*@198.51.100.0/24" reason="This subnet is bad.">
905 # exception: Hosts that are exempt from [kgz]lines.
907 # host: ident@hostname to exempt.
908 # Wildcards and CIDR (if you specify an IP) can be used.
909 host="*@ircop.example.com"
911 # reason: Reason for exception. Only shown in /stats e
912 reason="Oper's hostname">
914 #-#-#-#-#-#-#-#-#-#-#- INSANE BAN OPTIONS -#-#-#-#-#-#-#-#-#-#-#-#-#-#
916 # This optional tag allows you to specify how wide a gline, eline, #
917 # kline, zline or qline can be before it is forbidden from being #
918 # set. By setting hostmasks="yes", you can allow all G, K, E lines, #
919 # no matter how many users the ban would cover. This is not #
920 # recommended! By setting ipmasks="yes", you can allow all Z lines, #
921 # no matter how many users these cover too. Needless to say we #
922 # don't recommend you do this, or, set nickmasks="yes", which will #
927 # hostmasks: Allow bans with insane hostmasks. (over-reaching bans)
930 # ipmasks: Allow bans with insane ipmasks. (over-reaching bans)
933 # nickmasks: Allow bans with insane nickmasks. (over-reaching bans)
936 # trigger: What percentage of users on the network to trigger
937 # specifying an insane ban as. The default is 95.5%, which means
938 # if you have a 1000 user network, a ban will not be allowed if it
939 # will be banning 955 or more users.
943 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#- YAWN -#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
945 # You should already know what to do here :) #
947 <die value="User error. You didn't edit your config properly. Go back and try again.">
949 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# MODULES #-#-#-#-#-#-#-#-#-#-#-#-#-#-#
950 # ____ _ _____ _ _ ____ _ _ _ #
951 # | _ \ ___ __ _ __| | |_ _| |__ (_)___ | __ )(_) |_| | #
952 # | |_) / _ \/ _` |/ _` | | | | '_ \| / __| | _ \| | __| | #
953 # | _ < __/ (_| | (_| | | | | | | | \__ \ | |_) | | |_|_| #
954 # |_| \_\___|\__,_|\__,_| |_| |_| |_|_|___/ |____/|_|\__(_) #
956 # Well done, you've reached the end of the basic configuration, your #
957 # ircd should now start if you want to try it out! (./inspircd start) #
959 # We now suggest you read and edit modules.conf, as modules are what #
960 # provide almost all the features of InspIRCd. :) #
962 # The default does nothing -- we include it for simplicity for you. #
963 <include file="conf/examples/modules.conf.example">
965 # Here are some pre-built modules.conf files that closely match the
966 # default configurations of some popular IRCd's. You still may want to
967 # look over them and make sure if everything is correct for you and setup
968 # the proper SSL information.
970 # *NOTE*: These files have no comments for what the modules do. If you
971 # are interested in that, please read the modules.conf.example. It is also
972 # recommended that you make your own modules file based on modules.conf.example.
974 # Settings similar to UnrealIRCd defaults.
975 #<include file="conf/examples/modules/unrealircd.conf.example">
977 # Settings similar to Charybdis IRCd defaults.
978 #<include file="conf/examples/modules/charybdis.conf.example">
981 #########################################################################
983 # - InspIRCd Development Team - #
984 # https://www.inspircd.org #
986 #########################################################################