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 #
25 # ____ _ _____ _ _ ____ _ _ _ #
26 # | _ \ ___ __ _ __| | |_ _| |__ (_)___ | __ )(_) |_| | #
27 # | |_) / _ \/ _` |/ _` | | | | '_ \| / __| | _ \| | __| | #
28 # | _ < __/ (_| | (_| | | | | | | | \__ \ | |_) | | |_|_| #
29 # |_| \_\___|\__,_|\__,_| |_| |_| |_|_|___/ |____/|_|\__(_) #
31 # Lines prefixed with READ THIS BIT, as shown above, are IMPORTANT #
32 # lines, and you REALLY SHOULD READ THEM. Yes, THIS MEANS YOU. Even #
33 # if you've configured InspIRCd before, these probably indicate #
34 # something new or different to this version and you SHOULD READ IT. #
36 ########################################################################
38 # Unalphabeticalise the modules list at your own risk #
40 ########################################################################
42 #-#-#-#-#-#-#-#-#-# INCLUDE CONFIGURATION #-#-#-#-#-#-#-#-#-#-#-#-#-#
44 # This optional tag allows you to include another config file #
45 # allowing you to keep your configuration tidy. The configuration #
46 # file you include will be treated as part of the configuration file #
47 # which includes it, in simple terms the inclusion is transparent. #
49 # All paths to config files are relative to the directory of the main #
50 # config file inspircd.conf, unless the filename starts with a forward#
51 # slash (/) in which case it is treated as an absolute path. #
53 # You may also include an executable file, in which case if you do so #
54 # the output of the executable on the standard output will be added #
55 # to your config at the point of the include tag. #
57 # Syntax is as follows: #
58 #<include file="file.conf"> #
59 #<include executable="/path/to/executable parameters"> #
63 #-#-#-#-#-#-#-#-#-#-#-#- SERVER DESCRIPTION -#-#-#-#-#-#-#-#-#-#-#-#-
65 # Here is where you enter the information about your server. #
69 # name: Hostname of your server. Does not need to be valid.
70 name="penguin.omega.org.za"
72 # description: Server description. Spaces are allowed.
73 description="Waddle World"
75 # network: Network name given on connect to clients.
76 # Should be the same on all servers on the network and
81 #-#-#-#-#-#-#-#-#-#-#-#- ADMIN INFORMATION -#-#-#-#-#-#-#-#-#-#-#-#
83 # Describes the Server Administrator's real name (optionally), #
84 # nick, and email address. #
86 # Syntax is as follows: #
87 # <admin name="real name" #
89 # email="email@address.com"> #
92 <admin name="Johnny English"
94 email="MI5@the.best.secret.agent">
97 #-#-#-#-#-#-#-#-#-#-#-#- PORT CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-
99 # Enter the port and address bindings here. #
101 # bind address - Specifies which address ports bind to. Leaving this #
102 # field blank binds the port to all IP's available. #
104 # port - The port number to bind to. You may specify a port #
105 # range here, e.g. "6667-6669,7000,7001". If you do #
106 # this, the server will count each port within your #
107 # range as a separate binding, making the above #
108 # example equivalent to five separate bind tags. #
109 # A failure on one port in the range does not prevent #
110 # the entire range from being bound, just that one #
113 # type - Can be 'clients' or 'servers'. The clients type is #
114 # a standard TCP based socket, the servers type is a #
115 # also a TCP based connection but of a different #
116 # format. SSL support is provided by modules, to #
117 # enable SSL support, please read the module section #
118 # of this configuration file. #
120 # ssl - When using m_ssl_gnutls.so or m_ssl_openssl.so #
121 # modules, you must define this value to use ssl on #
122 # that port. Valid values are 'gnutls' or 'openssl' #
123 # respectively. If the module is not loaded, this #
124 # setting is ignored. #
126 # transport - If you have m_spanningtree.so loaded, along with #
127 # either one of the SSL modules (m_ssl_gnutls or #
128 # m_ssl_openssl) or m_ziplinks.so, then you may make #
129 # use of this value. #
130 # Setting it to 'openssl' or 'gnutls' or 'zip' #
131 # indicates that the port should accept connections #
132 # using the given transport name. Transports are #
133 # layers which sit on top of a socket and change the #
134 # way data is sent and received, e.g. encryption, #
135 # compression, and other such things. Because this #
136 # may not be limited in use to just encryption, #
137 # the 'ssl' value used for client ports does not #
138 # exist for servers, and this value is used instead. #
139 # ____ _ _____ _ _ ____ _ _ _ #
140 # | _ \ ___ __ _ __| | |_ _| |__ (_)___ | __ )(_) |_| | #
141 # | |_) / _ \/ _` |/ _` | | | | '_ \| / __| | _ \| | __| | #
142 # | _ < __/ (_| | (_| | | | | | | | \__ \ | |_) | | |_|_| #
143 # |_| \_\___|\__,_|\__,_| |_| |_| |_|_|___/ |____/|_|\__(_) #
145 # If you want to link servers to InspIRCd you must load the #
146 # m_spanningtree.so module! Please see the modules list below for #
147 # information on how to load this module! If you do not load this #
148 # module, server ports will NOT be bound! #
150 # Leaving address empty binds to all available interfaces #
152 # Syntax is as follows: #
154 # <bind address="ip address" port="port" type="clients"> #
155 # <bind address="ip address" port="port" type="servers"> #
157 # If InspIRCd is built for IPv6, and you wish to accept IPv4 clients, #
158 # then you can specify IPv4 ip addresses here to bind. You may also #
159 # use the 4in6 notation, ::ffff:1.2.3.4, where 1.2.3.4 is the IPv4 #
160 # address to bind the port, but as of InspIRCd 1.1.1, this is not #
163 # ------------------------------------------------------------------- #
165 # PLEASE NOTE: If you have build InspIRCd as an IPv6 server, and you #
166 # specify an empty bind address, the binding will be bound to ALL THE #
167 # IPv6 IP ADDRESSES, and not the IPv4 addresses. If you are using an #
168 # IPv6 enabled InspIRCd and want to bind to multiple IPv4 addresses #
169 # in this way, you must specify them by hand. If you have built the #
170 # server for IPv4 connections only, then specifying an empty bind #
171 # address binds the port to all IPv4 IP addresses, as expected. #
174 <bind address="" port="6000" type="clients">
175 <bind address="" port="6660-6669" type="clients" ssl="gnutls">
177 # When linking servers, the openssl and gnutls transports are largely
178 # link-compatible and can be used alongside each other or either/or
179 # on each end of the link without any significant issues.
181 <bind address="" port="7000,7001" type="servers">
182 <bind address="1.2.3.4" port="7005" type="servers" transport="openssl">
185 #-#-#-#-#-#-#-#-#-#- DIE/RESTART CONFIGURATION -#-#-#-#-#-#-#-#-#-#-
187 # You can configure the passwords here which you wish to use for #
188 # the die and restart commands. Only trusted IRCop's who will #
189 # need this ability should know the die and restart password. #
191 # Syntax is as follows: #
192 # <power diepass="die password" restartpass="restart password" #
193 # pause="secs before dying"> #
196 <power diepass="" restartpass="" pause="2">
199 #-#-#-#-#-#-#-#-#-#- CONNECTIONS CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
201 # This is where you can configure which connections are allowed #
202 # and denied access onto your server. The password is optional. #
203 # You may have as many of these as you require. To allow/deny all #
204 # connections, use a '*' or 0.0.0.0/0. #
206 # Syntax is as follows: #
208 # <connect name="myallow" allow="1.2.3.0/24" limit="5" #
209 # password="blahblah" timeout="10" timeout="blah" #
210 # flood="5" threshold="8" pingfreq="120" sendq="99999" #
211 # revcq="696969" localmax="3" globalmax="3" #
212 # port="6660" maxchans="50" limit="999"> #
214 # <connect name="blocked" deny="127.0.0.1" port="6667"> #
216 # <connect name="something" parent="myallow" pingfreq="60"> #
218 # IP masks may be specified in CIDR format or wildcard format, #
219 # for IPv4 and IPv6. You *cannot* use hostnames in the allow or #
220 # deny field, as the state is applied before the user's DNS has #
223 # You can optionally name your connect allow/deny tags. If you do #
224 # this, you may reference this connect tag as the parent of another #
225 # connect tag with the <connect:parent> option as shown above. If #
226 # you do this, any options not explicitly specified in the tag will #
227 # be copied from the parent. #
229 # If the value maxchans is included, this overrides all other max #
230 # channels related settings, including the separate oper maximum. #
231 # You may set this to any (sane) value you wish and it applies to #
232 # all users within this connect tag. #
234 # You may optionally include timeout="x" on any allow line, which #
235 # specifies the amount of time given before an unknown connection #
236 # is closed if USER/NICK/PASS are not given. This value is in secs. #
238 # You may optionally limit the number of clients that are matched #
239 # by a single <connect> tag by specifying the maximum in the limit #
240 # parameter. If set to 0, there is no limit, which is the default. #
242 # You should also include a flood="x" line which indicates #
243 # the number of lines a user may place into their buffer at once #
244 # before they are disconnected for excess flood. This feature can #
245 # not be disabled, however it can be set to extremely high values, #
246 # rendering it effectively disabled. A recommended value is 10. #
247 # A counter is maintained for each user which is reset every #
248 # 'threshold' seconds and specifying this threshold value with #
249 # threshold="X" indicates how often the counter is reset. For #
250 # example, with flood="5" and threshold="8", the user may not send #
251 # more than 5 lines in 8 secs. #
253 # You may optionally specify the sendq size and ping frequency of #
254 # each connect:allow line using the pingfreq="X" and sendq="X" #
255 # settings as shown in the full example below. #
256 # The ping frequency is specified in seconds, and the sendq size #
257 # in bytes. It is recommended, although not enforced, that you #
258 # should never set your sendq size to less than 8K. Send Queues are #
259 # dynamically allocated and can grow as needed up to the maximum #
262 # The optional recvq value is the maximum size which users in this #
263 # group may grow their receive queue to. This is recommended to be #
264 # kept pretty low compared to the sendq, as users will always #
265 # receive more than they send in normal circumstances. The default #
266 # if not specified is 4096. #
268 # The sendq is the data waiting to be sent TO THE USER. #
269 # The recvq is the data being received FROM THE USER. #
270 # The names sendq and recvq are from the SERVER'S PERSPECTIVE not #
271 # that of the user... Just to clear up any confusion or complaints #
272 # that these are backwards :p #
274 # The localmax and globalmax values can be used to enforce local #
275 # and global session limits on connections. The session limits are #
276 # counted against all users, but applied only to users within the #
277 # class. For example, if you had a class 'A' which has a session #
278 # limit of 3, and a class 'B' which has a session limit of 5, and #
279 # somehow, two users managed to get into class B which also match #
280 # class A, there is only one connection left for this IP now in A, #
281 # but if they can connect again to B, there are three. You get the #
284 # NOTE NOTE NOTE NOTE NOTE NOTE! #
285 # The maximum limits by default apply to individual IP addresses #
286 # This *MAY* be changed by modifying the <cidr> block, in order #
287 # to detect cloning across an ISP. #
289 # The optional port value determines which port the connect tag is #
290 # handling. If left out the connect tag covers all bound ports else #
291 # only incoming connections on the specified port will match. Port #
292 # tags may be used on connect allow and connect deny tags. #
294 # The limit value determines the maximum number of users which may #
295 # be in this class. Combine this with CIDR masks for various ISP #
296 # subnets to limit the number of users which may connect at any one #
297 # time from a certain ISP. Omit this value to not limit the tag. #
300 <connect allow="196.12.*" password="secret" port="6667">
313 <connect deny="69.254.*">
314 <connect deny="3ffe::0/32">
316 #-#-#-#-#-#-#-#-#-#-#-#- CIDR CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-
318 # CIDR configuration allows detection of clones and applying of #
319 # throttle limits across a CIDR range. (A CIDR range is a group of #
320 # IPs, for example, the CIDR range 192.168.1.0-192.168.1.255 may be #
321 # represented as 192.168.1.0/24). This means that abuse across an ISP #
322 # is detected and curtailed much easier. #
325 # This specifies how many bits of an IP address should be checked #
326 # against cloning in the <connect> tags, for example, if <connect> #
327 # tags specified a limit of 2 (low!), and three users attempted to #
328 # connect in the IP range 192.168.1.0-192.168.1.255, and ipv4clone #
329 # was set to '24', the third connection would be disconnected. #
331 # Valid values are 0-32, but you *don't* want 0. Using values which #
332 # are not multiples of 8 can give confusing behaviour. #
333 # For more info, see: http://www.inspircd.org/wiki/CIDR_Tutorial #
335 # ipv6clone works in the same way, except for ipv6 addresses. Valid #
336 # range is 0-128, but you *don't* want anything too small. #
338 # Setting these to their maximum value (32, 128) will result in #
339 # no actual CIDR checking being done, and clone checking will only be #
340 # done across individual IPs. This is the default behaviour. #
346 # This file has all the information about oper classes, types and o:lines.
347 # You *MUST* edit it.
348 <include file="opers.conf.example">
350 # This file has all the information about server links and ulined servers.
351 # You *MUST* edit it if you intend to link servers.
352 <include file="links.conf.example">
354 #-#-#-#-#-#-#-#-#-#- MISCELLANEOUS CONFIGURATION -#-#-#-#-#-#-#-#-#-#
356 # These options let you define the path to your motd and rules #
357 # files. If these are relative paths, they are relative to the #
358 # configuration directory. #
361 <files motd="inspircd.motd.example"
362 rules="inspircd.rules.example">
364 #-#-#-#-#-#-#-#-#-#-#-# MAXIMUM CHANNELS -#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
366 # This optional configuration tag lets you define the maximum number #
367 # of channels that both opers and users may be on at any one time. #
368 # The default is 20 for users and 60 for opers if this tag is not #
369 # defined. Remote users are not restricted in any manner. #
375 #-#-#-#-#-#-#-#-#-#-#-#-#-#-# DNS SERVER -#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
377 # Define your DNS server address here. InspIRCd has its own resolver. #
378 # If you do not define this value, then InspIRCd will attempt to #
379 # determine your DNS server from your operating system. On POSIX #
380 # platforms, InspIRCd will read /etc/resolv.conf, and populate this #
381 # value with the first DNS server address found. On Windows platforms #
382 # InspIRCd will check the registry, and use the DNS server of the #
383 # first active network interface, if one exists. #
384 # If a DNS server cannot be determined from these checks, the default #
385 # value '127.0.0.1' is used instead. The timeout value is in seconds. #
387 # ____ _ _____ _ _ ____ _ _ _ #
388 # | _ \ ___ __ _ __| | |_ _| |__ (_)___ | __ )(_) |_| | #
389 # | |_) / _ \/ _` |/ _` | | | | '_ \| / __| | _ \| | __| | #
390 # | _ < __/ (_| | (_| | | | | | | | \__ \ | |_) | | |_|_| #
391 # |_| \_\___|\__,_|\__,_| |_| |_| |_|_|___/ |____/|_|\__(_) #
393 # When choosing a server, be sure to choose one which will do a #
394 # RECURSIVE LOOKUP. InspIRCd's resolver does not currently do these #
395 # recursive lookups itself, to save time and resources. The DNS #
396 # server recommended by the InspIRCd team is bind, available from the #
397 # ISC website. If your DNS server does not do a recursive lookup, you #
398 # will be able to notice this by the fact that none of your users are #
399 # resolving even though the DNS server appears to be up! Most ISP and #
400 # hosting provider DNS servers support recursive lookups. #
402 # ------------------------------------------------------------------- #
404 # NOTE: If you have built InspIRCd with IPv6 support, then both #
405 # IPv6 and IPv4 addresses are allowed here, and also in the system #
406 # resolv.conf file. Remember that an IPv4 DNS server can still #
407 # resolve IPv6 addresses, and vice versa. #
410 <dns server="127.0.0.1" timeout="5">
412 # An example of using an IPv6 nameserver
413 #<dns server="::1" timeout="5">
415 #-#-#-#-#-#-#-#-#-#-#-#-#-#-# PID FILE -#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
417 # Define the path to the PID file here. The PID file can be used to #
418 # rehash the ircd from the shell or to terminate the ircd from the #
419 # shell using shell scripts, perl scripts, etc... and to monitor the #
420 # ircd's state via cron jobs. If this is a relative path, it will be #
421 # relative to the configuration directory, and if it is not defined, #
422 # the default of 'inspircd.pid' is used. #
425 #<pid file="/path/to/inspircd.pid">
427 #-#-#-#-#-#-#-#-#-#-#-#-#- BANLIST LIMITS #-#-#-#-#-#-#-#-#-#-#-#-#-#-#
429 # Use these tags to customise the ban limits on a per channel basis. #
430 # The tags are read from top to bottom, and any tag found which #
431 # matches the channels name applies the banlimit to that channel. #
432 # It is advisable to put an entry with the channel as '*' at the #
433 # bottom of the list. If none are specified or no maxbans tag is #
434 # matched, the banlist size defaults to 64 entries. #
437 <banlist chan="#morons" limit="128">
438 <banlist chan="*" limit="69">
440 #-#-#-#-#-#-#-#-#-#-#- DISABLED FEATURES -#-#-#-#-#-#-#-#-#-#-#-#-#-#
442 # This tag is optional, and specifies one or more features which are #
443 # not available to non-operators. #
445 # For example you may wish to disable NICK and prevent non-opers from #
446 # changing their nicknames. #
447 # Note that any disabled commands take effect only after the user has #
448 # 'registered' (e.g. after the initial USER/NICK/PASS on connection) #
449 # so for example disabling NICK will not cripple your network. #
451 # `fakenonexistant' will make the ircd pretend that nonexistant #
452 # commands simply don't exist to non-opers ("no such command"). #
454 #<disabled commands="TOPIC MODE" usermodes="" chanmodes="" fakenonexistant="yes">
457 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#- RTFM LINE -#-#-#-#-#-#-#-#-#-#-#-#-#-#
459 # Just remove this... Its here to make you read ALL of the config #
462 <die value="You should probably edit your config *PROPERLY* and try again.">
466 #-#-#-#-#-#-#-#-#-#-#-#-#- SERVER OPTIONS -#-#-#-#-#-#-#-#-#-#-#-#-#
468 # Settings to define which features are usable on your server. #
470 # prefixquit - A prefix to be placed on the start of a client's #
473 # suffixquit - A suffix to be placed on the end of a client's #
476 # fixedquit - A fixed quit message to display for all client #
477 # QUITS. If specified, overrides both prefixquit #
478 # and suffixquit options. #
480 # prefixpart - A prefix to be placed on the start of a client's #
483 # suffixpart - A suffix to be placed on the end of a client's #
486 # fixedpart - A fixed part message to display for all client #
487 # parts. If specified, overrides both prefixpart #
488 # and suffixpart options. #
490 # allowhalfop - Allows the +h channel mode #
492 # noservices - If noservices is true, yes, or 1, then the first #
493 # user into a channel gets founder status. This is #
494 # only useful on networks running the m_chanprotect #
495 # module without services. #
497 # qprefix - qprefix is used by the chanprotect module to give #
498 # a visible prefix to users set +q (founder) in chan #
499 # It should be set to something sensible like ~ or ! #
500 # If not set, no prefix is applied to users with +q #
502 # aprefix - aprefix is the same as qprefix, except it is for #
503 # giving users with mode +a (protected) a prefix #
505 # deprotectself - If this value is set to yes, true, or 1, then any #
506 # user with +q or +a may remove the +q or +a from #
507 # themselves. The default setting is to not enable #
508 # this feature, which stops even the founder taking #
509 # away their founder status without using services. #
511 # deprotectothers-If this value is set to yes, true, or 1, then any #
512 # user with +q or +a may remove the +q or +a from #
513 # other users. The default setting is to not enable #
514 # this feature, so that only +q may remove +a, and #
515 # nothing but services may remove +q. #
517 # cyclehosts - If this is set to true, yes or 1, then when a #
518 # user's hostname changes, they will appear to quit #
519 # and then rejoin with their new host. This prevents #
520 # clients from being confused by host changes, #
521 # especially in the case of bots, and it is #
522 # recommended that this option is enabled. #
524 # moduledir - This optional value indicates a runtime change of #
525 # the location where modules are to be found. This #
526 # does not add a supplementary directory. There can #
527 # only be one module path. #
529 # syntaxhints - If set to yes, true or 1, when a user does not #
530 # give enough parameters for a command, a syntax #
531 # hint will be given (using the RPL_TEXT numeric) #
532 # as well as the standard ERR_NEEDMOREPARAMS. #
534 # announcets - If this value is defined to yes, true, or 1, then #
535 # a channels' timestamp is updated, the users on #
536 # the channel will be informed of the change via #
537 # a server notice to the channel with the old and #
538 # new TS values in the timestamp. If you think this #
539 # is just pointless noise, define the value to 0. #
541 # ircumsgprefix - Use undernet style message prefix for channel #
542 # NOTICE and PRIVMSG adding the prefix to the line #
543 # of text sent out. Eg. NOTICE @#test :@ testing #
544 # vs. the off setting: NOTICE @#test :testing #
546 # hostintopic - If this is set to yes (the default) then the full #
547 # nick!user@host is shown for who set a TOPIC last. #
548 # if set to no, then only the nickname is shown. #
550 # serverpingfreq- This value, when set, allows you to change the #
551 # frequency of server to server PING messages. This #
552 # can help if you are having certain network issues. #
554 # pingwarning - This should be set to a number between 1 and 59 if #
555 # defined, and if it is defined will cause the server#
556 # to send out a warning via snomask +l if a server #
557 # does not answer to PING after this many seconds. #
558 # This can be useful for finding servers which are #
559 # at risk of pinging out due to network issues. #
561 # defaultmodes - The default modes to be given to each channel on #
562 # creation. Defaults to 'nt'. There should be no + #
563 # or - symbols in this sequence, if you add them #
564 # they will be ignored. You may add parameters for #
565 # modes which take them. #
567 # moronbanner - The NOTICE to show to users who are glined, zlined #
568 # klined or qlined when they are disconnected. This #
569 # is totally freeform, you may place any text here #
572 # exemptchanops - This option allows channel operators to be exempted#
573 # from certain channel modes. #
574 # Supported modes are +SfFgNc. Defaults to off. #
576 # invitebypassmodes - This option allows /invite to bypass modes #
581 <options prefixquit="Quit: "
599 moronbanner="You're banned! Email haha@abuse.com with the ERROR line below for help."
601 invitebypassmodes="yes">
604 #-#-#-#-#-#-#-#-#-#-#-# PERFORMANCE CONFIGURATION #-#-#-#-#-#-#-#-#-#-#
606 # maxwho - The maximum number of results returned by a /WHO #
607 # query. This is to prevent /WHO being used as a #
608 # spam vector or means of flooding an ircd. The #
609 # default is 128, it is not recommended to raise it #
610 # above 1024. Values up to 65535 are permitted. If #
611 # this value is omitted, any size WHO is allowed by #
614 # somaxconn - The maximum number of sockets that may be waiting #
615 # in the accept queue. This usually allows the ircd #
616 # to soak up more connections in a shorter space of #
617 # time when increased but please be aware there is a #
618 # system defined maximum value to this, the same way #
619 # there is a system defined maximum number of file #
620 # descriptors. Some systems may only allow this to #
621 # be up to 5 (ugh) while others such as FreeBSD will #
622 # default to a much nicer 128. #
624 # softlimit - This optional feature allows a defined softlimit. #
625 # if defined sets a soft maxconnections value, has #
626 # to be less than the ./configure maxclients #
628 # nouserdns - If set to yes, true or 1, no user DNS lookups #
629 # will be performed for connecting users. This can #
630 # save a lot of resources on very busy IRC servers. #
632 # quietbursts - When synching or splitting from the network, a #
633 # server can generate a lot of connect and quit #
634 # snotices to the +C and +Q snomasks. Setting this #
635 # value to yes squelches those messages, which can #
636 # make them more useful for opers, however it will #
637 # degrade their use by certain third party programs #
638 # such as BOPM which rely on them to scan users when #
639 # a split heals in certain configurations. #
641 # netbuffersize - Size of the buffer used to receive data from #
642 # clients. The ircd may only read() this amount #
643 # of text in one go at any time. (OPTIONAL) #
646 <performance netbuffersize="10240"
653 #-#-#-#-#-#-#-#-#-#-#-# SECURITY CONFIGURATION #-#-#-#-#-#-#-#-#-#-#-#
656 # - If this option is set, then invites are announced #
657 # to the channel when a user invites another user. #
658 # If you consider this to be unnecessary noise, #
659 # set this to 'none'. To announce to all ops, set #
660 # this to 'ops' and to announce to all users set the #
663 # The value 'dynamic' varies between 'ops' and 'all' #
664 # settings depending on if the channel is +i or not. #
665 # When the channel is +i, messages go only to ops, #
666 # and when the channel is not +i, messages go to #
667 # everyone. In short, the messages will go to every #
668 # user who has power of INVITE on the channel. This #
669 # is the recommended setting. #
671 # disablehmac - If you are linking your InspIRCd to older versions #
672 # then you can specify this option and set it to #
673 # yes. 1.1.6 and above support HMAC and challenge- #
674 # response for password authentication. These can #
675 # greatly enhance security of your server to server #
676 # connections when you are not using SSL (as is the #
677 # case with a lot of larger networks). Linking to #
678 # older versions of InspIRCd should not *usually* be #
679 # a problem, but if you have problems with HMAC #
680 # authentication, this option can be used to turn it #
683 # hidemodes - If this option is enabled, then the listmodes #
684 # given (e.g. +eI), will be hidden from users below #
685 # halfop. This is not recommended to be set on mode #
686 # +b, as it may break some features in popular #
687 # clients such as mIRC. #
689 # hidesplits - When set to 'yes', will hide split server names #
690 # from non-opers. Non-opers will see '*.net *.split' #
691 # instead of the server names in the quit message, #
692 # identical to the way IRCu displays them. #
694 # hidebans - When set to 'yes', will hide gline, kline, zline #
695 # and qline quit messages from non-opers. For #
696 # example, user A who is not an oper will just see #
697 # (G-Lined) while user B who is an oper will see the #
698 # text (G-Lined: Reason here) instead. #
700 # hidewhois - When defined with a non-empty value, the given #
701 # text will be used in place of the user's server #
702 # in WHOIS, when a user is WHOISed by a non-oper. #
703 # For example, most nets will want to set this to #
704 # something like '*.netname.net' to conceal the #
705 # actual server the user is on. #
707 # flatlinks - When you are using m_spanningtree.so, and this #
708 # value is set to yes, true or 1, /MAP and /LINKS #
709 # will be flattened when shown to a non-opers. #
711 # hideulines - When you are using m_spanningtree.so, and this #
712 # value is set to yes, true or 1, then U-lined #
713 # servers will be hidden in /LINKS and /MAP for non #
714 # opers. Please be aware that this will also hide #
715 # any leaf servers of a U-lined server, e.g. jupes. #
717 # userstats - The userstats field is optional and specifies #
718 # which stats characters in /STATS may be requested #
719 # by non-operators. Stats characters in this field #
720 # are case sensitive and are allowed to users #
721 # independent of if they are in a module or the core #
723 # operspywhois - If this is set then when an IRC operator uses #
724 # /WHOIS on a user they will see all channels, even #
725 # ones if channels are secret (+s), private (+p) or #
726 # if the target user is invisible +i. #
728 # customversion - If you specify this configuration item, and it is #
729 # not set to an empty value, then when a user does #
730 # a /VERSION command on the ircd, this string will #
731 # be displayed as the second portion of the output, #
732 # replacing the system 'uname', compile flags and #
733 # socket engine/dns engine names. You may use this #
734 # to enhance security, or simply for vanity. #
736 # maxtargets - The maxtargets field is optional, and if not #
737 # defined, defaults to 20. It indicates the maximum #
738 # number of targets which may be given to commands #
739 # such as PRIVMSG, KICK etc. #
741 # hidekills - The hidekills value, if set, replaces the source #
742 # of all oper-generated kills to be the given text #
743 # to provide anonimity to your opers. #
746 <security announceinvites="dynamic"
760 #-#-#-#-#-#-#-#-#-#-#-#-# LIMITS CONFIGURATION #-#-#-#-#-#-#-#-#-#-#-#
762 # This configuration tag defines the maximum sizes of various types #
763 # on IRC, such as the maximum length of a channel name, and the #
764 # maximum length of a channel. Note that with the exception of the #
765 # identmax value all values given here are the exact values you would #
766 # expect to see on IRC. This contrasts with the older InspIRCd #
767 # releases where these values would be one character shorter than #
768 # defined to account for a null terminator on the end of the text. #
770 # The identmax value has special meaning, as it may grow one #
771 # character longer than you specify, to accomodate for a ~ character #
772 # when m_ident is loaded. #
774 # These values should match network-wide, otherwise you may end up #
775 # with desyncs, and confusing your users by being able to use a nick #
776 # of a certain length on one server but not on another. Servers will #
777 # link with mismatched values, but this is NOT recommended as a long #
780 # Values here should be self explanitory: #
782 # maxnick - The maximum length of a nickname #
783 # maxchan - The maximum length of a channel name #
784 # maxmodes - The maximum number of parameterized mode changes #
786 # maxident - The maximum length of an ident/username value #
787 # maxquit - The maximum length of a quit message #
788 # maxtopic - The maximum length of a channel topic #
789 # maxkick - The maximum length of a kick message #
790 # maxgecos - The maximum length of a GECOS (real name) #
791 # maxaway - The maximum length of an away message #
805 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
809 # Logging is covered with the <log> tag, which you may use to change
810 # the behaviour of the logging of the IRCd.
812 # In InspIRCd as of 1.2, logging is pluggable and very extensible.
813 # Different files can log the same thing, different 'types' of log can
814 # go to different places, and modules can even extend the log tag
815 # to do what they want.
817 # An example log tag would be:
818 # <log method="file" type="OPER" level="default" target="opers.log">
819 # which would log all information on /oper (failed and successful) to
820 # a file called opers.log.
822 # There are many different types which may be used, and modules may
823 # generate their own. A list of useful types:
824 # - USERS - information relating to user connection and disconnection
825 # - CHANNELS - information relating to joining and parting of channels.
826 # XXX someone doc more on this
828 # You may also log *everything* by using a type of *, and subtract things out
829 # of that by using -TYPE - for example "* -USERINPUT -USEROUTPUT".
831 # The following log tag is highly default and uncustomised. It is recommended you
832 # sort out your own log tags. This is just here so you get some output.
833 <log method="file" type="* -USERINPUT -USEROUTPUT -m_spanningtree" level="default" target="ircd.log">
835 #-#-#-#-#-#-#-#-#-#-#-#-#- WHOWAS OPTIONS -#-#-#-#-#-#-#-#-#-#-#-#-#
837 # This tag lets you define the behaviour of the /whowas command of #
840 # groupsize - Controls the maximum entries per nick shown when #
841 # performing a /whowas nick. Setting this to 0 dis- #
842 # ables whowas completely. #
844 # maxgroups - The maximum number of nickgroups that can be added #
845 # to the list. If max is reached, oldest group will #
846 # be deleted first like a FIFO. A groupsize of 3 and #
847 # a maxgroups of 5000 will allow for 5000 nicks to #
848 # be stored with a history of 3, thus giving a total #
849 # of 3 * 5000 = 15000 entries. A setting of 0 dis- #
850 # ables whowas completely. #
852 # maxkeep - The maximum time a nick is kept in the whowas list #
853 # before being pruned. Time may be specified in #
854 # seconds, or in the following format: 1y2w3d4h5m6s #
855 # meaning one year, two weeks, three days, 4 hours, #
856 # 5 minutes and 6 seconds. All fields in this format #
857 # are optional. Minimum is 1 hour, if less InspIRCd #
858 # will default back to 1 hour. #
860 #<whowas groupsize="10" #
861 # maxgroups="100000" #
864 #-#-#-#-#-#-#-#-#-#-#-#-#-#- BAN OPTIONS -#-#-#-#-#-#-#-#-#-#-#-#-#-#
866 # The ban tags define nick masks, host masks and ip ranges which are #
867 # banned from your server. All details in these tags are local to #
871 # badip lines ban an ip range (same as a zline) #
873 # ipmask - The ip range to ban (wildcards possible) #
874 # CIDR is supported in the IP mask. #
875 # reason - Reason to display when disconnected #
877 # badnick lines ban a nick mask (same as a qline) #
879 # nick - Nick mask to ban (wildcards possible) #
880 # reason - Reason to display on /NICK #
882 # badhost lines ban a user@host mask (same as a kline) #
884 # host - ident@hostname (wildcards possible) #
885 # If you specify an IP, CIDR is supported. #
886 # reason - Reason to display on disconnection #
888 # exception lines define a hostmask that is excempt from [kzg]lines #
890 # host - ident@hostname (wildcards possible) #
891 # If you specify an IP, CIDR is supported. #
892 # reason - Reason, shown only in /stats e #
895 <badip ipmask="69.69.69.69" reason="No porn here thanks.">
897 <badnick nick="ChanServ" reason="Reserved For Services">
898 <badnick nick="NickServ" reason="Reserved For Services">
899 <badnick nick="OperServ" reason="Reserved For Services">
900 <badnick nick="MemoServ" reason="Reserved For Services">
902 <badhost host="*@hundredz.n.hundredz.o.1337.kiddies.com" reason="Too many 1337 kiddiots">
903 <badhost host="*@localhost" reason="No irc from localhost!">
904 <badhost host="*@172.32.0.0/16" reason="This subnet is bad.">
906 <exception host="*@ircop.host.com" reason="Opers hostname">
908 #-#-#-#-#-#-#-#-#-#-#- INSANE BAN OPTIONS -#-#-#-#-#-#-#-#-#-#-#-#-#-#
910 # This optional tag allows you to specify how wide a gline, eline, #
911 # kline, zline or qline can be before it is forbidden from being #
912 # set. By setting hostmasks="yes", you can allow all G, K, E lines, #
913 # no matter how many users the ban would cover. This is not #
914 # recommended! By setting ipmasks="yes", you can allow all Z lines, #
915 # no matter how many users these cover too. Needless to say we #
916 # don't recommend you do this, or, set nickmasks="yes", which will #
919 # The trigger value indicates how wide any mask will be before it is #
920 # prevented from being set. The default value is 95.5% if this tag is #
921 # not defined in your configuration file, meaning that if your #
922 # network has 1000 users, a gline matching over 955 of them will be #
923 # prevented from being added. #
925 # Please note that remote servers (and services) are exempt from #
926 # these restrictions and expected to enforce their own policies #
930 <insane hostmasks="no" ipmasks="no" nickmasks="no" trigger="95.5">
933 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#- YAWN -#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
935 # You should already know what to do here :) #
937 <die value="User error. Insert new user and press any key. (you didn't edit your config properly.)">
939 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# MODULES #-#-#-#-#-#-#-#-#-#-#-#-#-#-#
940 # ____ _ _____ _ _ ____ _ _ _ #
941 # | _ \ ___ __ _ __| | |_ _| |__ (_)___ | __ )(_) |_| | #
942 # | |_) / _ \/ _` |/ _` | | | | '_ \| / __| | _ \| | __| | #
943 # | _ < __/ (_| | (_| | | | | | | | \__ \ | |_) | | |_|_| #
944 # |_| \_\___|\__,_|\__,_| |_| |_| |_|_|___/ |____/|_|\__(_) #
946 # Well done, you've reached the end of the basic configuration, your #
947 # ircd should now start if you want to try it out! (./inspircd start) #
949 # We now suggest you read and edit modules.conf, as modules are what #
950 # provide almost all the features of InspIRCd. :) #
952 # The default does nothing -- we include it for simplicity for you. #
953 <include file="modules.conf">
956 #########################################################################
958 # - InspIRCd Development Team - #
959 # http://www.inspircd.org #
961 #########################################################################
projects / user / henk / code / inspircd.git / blob