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 #
23 # Last updated on : 09/01/2006 #
24 # Written by : CC (cc@backchat.co.za) #
25 # Updated by : katsklaw (katsklaw@gmail.com) #
26 # Updated by : brain (brain@inspircd.org) #
28 # ____ _ _____ _ _ ____ _ _ _ #
29 # | _ \ ___ __ _ __| | |_ _| |__ (_)___ | __ )(_) |_| | #
30 # | |_) / _ \/ _` |/ _` | | | | '_ \| / __| | _ \| | __| | #
31 # | _ < __/ (_| | (_| | | | | | | | \__ \ | |_) | | |_|_| #
32 # |_| \_\___|\__,_|\__,_| |_| |_| |_|_|___/ |____/|_|\__(_) #
34 # Lines prefixed with READ THIS BIT, as shown above, are IMPORTANT #
35 # lines, and you REALLY SHOULD READ THEM. Yes, THIS MEANS YOU. Even #
36 # if you've configured InspIRCd before, these probably indicate #
37 # something new or different to this version and you SHOULD READ IT. #
39 ########################################################################
41 # Unalphabeticalise the modules list at your own risk #
43 ########################################################################
46 #-#-#-#-#-#-#-#-#-#-#-#- SERVER DESCRIPTION -#-#-#-#-#-#-#-#-#-#-#-#-
48 # Here is where you enter the information about your server. #
50 # Syntax is as follows: #
52 # <server name="server.name" #
53 # description="Server Description" #
54 # network="MyNetwork"> #
57 <server name="penguin.omega.org.za"
58 description="Waddle World"
62 #-#-#-#-#-#-#-#-#-#-#-#- ADMIN INFORMATION -#-#-#-#-#-#-#-#-#-#-#-#
64 # Describes the Server Administrator's real name, nick #
65 # and email address. #
67 # Syntax is as follows: #
68 # <admin name="real name" #
70 # email="email@address.com"> #
73 <admin name="Johnny English"
75 email="MI5@the.best.secret.agent">
78 #-#-#-#-#-#-#-#-#-#-#-#- PORT CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-
80 # Enter the port and address bindings here. #
82 # bind address - specifies which the address which ports bind. #
83 # may be a hostname or an IP address. Resolution of #
84 # hostnames may block for up to one second per IP #
85 # as port binding occurs before the socket engine is #
86 # initialized and therefore nonblocking DNS is not #
87 # available at this point until startup is complete. #
88 # port - The port number to bind to #
89 # type - can be 'clients' or 'servers'. The clients type is #
90 # a standard tcp based socket, the servers type is a #
91 # also a TCP based connection but of a different #
93 # ____ _ _____ _ _ ____ _ _ _ #
94 # | _ \ ___ __ _ __| | |_ _| |__ (_)___ | __ )(_) |_| | #
95 # | |_) / _ \/ _` |/ _` | | | | '_ \| / __| | _ \| | __| | #
96 # | _ < __/ (_| | (_| | | | | | | | \__ \ | |_) | | |_|_| #
97 # |_| \_\___|\__,_|\__,_| |_| |_| |_|_|___/ |____/|_|\__(_) #
99 # If you want to link servers to InspIRCd you must load the #
100 # m_spanningtree module! Please see the modules list below for #
101 # information on how to load this module! If you do not load this #
102 # module, server ports will NOT be bound! #
104 # Leaving address empty binds to all available interfaces #
106 # Syntax is as follows: #
108 # <bind address="ip or host" port="port" type="clients"> #
109 # <bind address="ip or host" port="port" type="servers"> #
111 # If InspIRCd is built for IPV6, and you wish to accept IPV4 clients, #
112 # then you must specify your IPV6 clients in the following form: #
113 # ::ffff:1.2.3.4, where 1.2.3.4 is the IPV4 address to bind the #
114 # port on. If InspIRCd is built for IPV4 connections (this is the #
115 # default) then you do not need to prefix your addresses like this. #
118 <bind address="" port="6660" type="clients">
119 <bind address="" port="7000" type="servers">
120 <bind address="" port="7001" type="servers">
123 #-#-#-#-#-#-#-#-#-#- DIE/RESTART CONFIGURATION -#-#-#-#-#-#-#-#-#-#-
125 # You can configure the passwords here which you wish to use for #
126 # the die and restart commands. Only trusted ircops who will #
127 # need this ability should know the die and restart password. #
129 # Syntax is as follows: #
130 # <power diepass="die password" restartpass="restart password" #
131 # pause="secs before dying"> #
134 <power diepass="diepass" restartpass="restartpass" pause="2">
137 #-#-#-#-#-#-#-#-#-# INCLUDE CONFIGURATION #-#-#-#-#-#-#-#-#-#-#-#-#-#
139 # This optional tag allows you to include another config file #
140 # allowing you to keep your configuration tidy. The configuration #
141 # file you include will be treated as part of the configuration file #
142 # which includes it, in simple terms the inclusion is transparent. #
144 # All paths to config files are relative to the directory of the main #
145 # config file inspircd.conf, unless the filename starts with a forward#
146 # slash (/) in which case it is treated as an absolute path. #
148 # Syntax is as follows: #
149 # <include file="file.conf"> #
152 #-#-#-#-#-#-#-#-#-#- CONNECTIONS CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
154 # This is where you can configure which connections are allowed #
155 # and denied access onto your server. #
156 # The password is optional. #
157 # You may have as many of these as you require. #
158 # To allow/deny all connections use a * #
160 # Syntax is as follows: #
162 # <connect allow="ip mask"> #
163 # <connect allow="ip mask" password="blahblah"> #
164 # <connect allow="ip mask" password="blah" timeout="10"> #
165 # <connect allow="ip mask" timeout="blah" flood="5"> #
166 # <connect allow="ip mask" threshold="8" pingfreq="120"> #
167 # <connect allow="ip mask" sendq="99999" revcq="696969"> #
168 # <connect allow="ip mask" localmax="3" globalmax="3"> #
169 # <connect deny="ip mask"> #
171 # IP masks may be specified in CIDR format for IPV4 and IPV6. #
173 # You may optionally include timeout="x" on any allow line, which #
174 # specifies the amount of time given before an unknown connection #
175 # is closed if USER/NICK/PASS are not given. This value is in secs #
177 # You should also include a flood="x" line which indicates #
178 # the number of lines a user may place into their buffer at once #
179 # before they are disconnected for excess flood. This feature can #
180 # not be disabled, however it can be set to exremely high values, #
181 # rendering it effectively disabled. A recommended value is 10. #
182 # A counter is maintained for each user which is reset every #
183 # 'threshold' seconds and specifying this threshold value with #
184 # threshold="X" indicates how often the counter is reset. For #
185 # example, with flood="5" and threshold="8", the user may not send #
186 # more than 5 lines in 8 secs. #
188 # You may optionally specify the sendq size and ping frequency of #
189 # each connect:allow line using the pingfreq="X" and sendq="X" #
190 # settings as shown in the full example below. #
191 # The ping frequency is specified in seconds, and the sendq size #
192 # in bytes. It is recommended, although not enforced, that you #
193 # should never set your sendq size to less than 8k. Send Queues are #
194 # dynamically allocated and can grow as needed up to the maximum #
197 # The optional recvq value is the maximum size which users in this #
198 # group may grow their receive queue to. This is recommended to be #
199 # kept pretty low compared to the sendq, as users will always #
200 # recieve more than they send in normal circumstances. The default #
201 # if not specified is 4096. #
203 # IMPORTANT NOTE, CALL THE CONFUSION POLICE! #
204 # The sendq is the data waiting to be sent TO THE USER. #
205 # The recvq is the data being received FROM THE USER. #
206 # The names sendq and recvq are from the SERVER'S PERSPECTIVE not #
207 # that of the user... Just to clear up any confusion or complaints #
208 # that these are backwards :p #
210 # The localmax and globalmax values can be used to enforce local #
211 # and global session limits on connections. The session limits are #
212 # counted against all users, but applied only to users within the #
213 # class. For example, if you had a class 'A' which has a session #
214 # limit of 3, and a class 'B' which has a session limit of 5, and #
215 # somehow, two users managed to get into class B which also match #
216 # class A, there is only one connection left for this IP now in A, #
217 # but if they can connect again to B, there are three. You get the #
221 <connect allow="196.12.*" password="secret">
222 <connect allow="*" timeout="60" flood="10" threshold="60" pingfreq="120" sendq="262144" recvq="4096" localmax="3" globalmax="3">
224 <connect deny="69.254.*">
225 <connect deny="3ffe::0/32">
228 #-#-#-#-#-#-#-#-#-#-#-#- CLASS CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-
230 # Classes are a group of commands which are grouped together #
231 # and given a unique name. They used to define which commands #
232 # are available to certain types of Operators. #
234 # Syntax is as follows: #
236 # <class name="name" commands="oper commands"> #
238 # ____ _ _____ _ _ ____ _ _ _ #
239 # | _ \ ___ __ _ __| | |_ _| |__ (_)___ | __ )(_) |_| | #
240 # | |_) / _ \/ _` |/ _` | | | | '_ \| / __| | _ \| | __| | #
241 # | _ < __/ (_| | (_| | | | | | | | \__ \ | |_) | | |_|_| #
242 # |_| \_\___|\__,_|\__,_| |_| |_| |_|_|___/ |____/|_|\__(_) #
244 # You are not forced to give these classes the names given below. #
245 # You can create your own named classes, if you want, in fact that #
246 # is the whole idea of this system! #
249 <class name="Shutdown" commands="DIE RESTART REHASH">
250 <class name="ServerLink" commands="CONNECT SQUIT">
251 <class name="BanControl" commands="KILL GLINE KLINE ZLINE QLINE ELINE">
252 <class name="OperChat" commands="WALLOPS GLOBOPS">
253 <class name="HostCloak" commands="SETHOST SETIDENT SETNAME">
256 #-#-#-#-#-#-#-#-#-#-#-#- OPERATOR COMPOSITION -#-#-#-#-#-#-#-#-#-#-#
258 # This is where you specify which types of operators you have on #
259 # your server, as well as the commands they are allowed to use. #
260 # This works alongside with the classes specified above. #
262 # type name - a name for the combined class types #
263 # a type name cannot contain spaces, however if you #
264 # put an _ symbol in the name, it will be translated #
265 # to a space when displayed in a WHOIS. #
267 # classes - specified above, used for flexibility for the #
268 # server admin to decide on which operators get #
271 # host - optional hostmask operators will recieve on oper-up. #
273 # Syntax is as follows: #
275 # <type name="name" classes="class name" host="oper hostmask"> #
277 # ____ _ _____ _ _ ____ _ _ _ #
278 # | _ \ ___ __ _ __| | |_ _| |__ (_)___ | __ )(_) |_| | #
279 # | |_) / _ \/ _` |/ _` | | | | '_ \| / __| | _ \| | __| | #
280 # | _ < __/ (_| | (_| | | | | | | | \__ \ | |_) | | |_|_| #
281 # |_| \_\___|\__,_|\__,_| |_| |_| |_|_|___/ |____/|_|\__(_) #
283 # You are not forced to give these types the names given below. #
284 # You can create your own named types, if you want, in fact that #
285 # is the whole idea of this system! #
288 <type name="NetAdmin" classes="OperChat BanControl HostCloak Shutdown ServerLink" host="netadmin.omega.org.za">
289 <type name="GlobalOp" classes="OperChat BanControl HostCloak ServerLink" host="ircop.omega.org.za">
290 <type name="Helper" classes="HostCloak" host="helper.omega.org.za">
293 #-#-#-#-#-#-#-#-#-#-#- OPERATOR CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
295 # Opers are defined here. This is a very important section. #
296 # Remember to only make operators out of truthworthy people. #
298 # name - oper name, best to use lower-case #
300 # password - password to oper-up, #
301 # encryption not supported by inspircd. However, there #
302 # are modules that allow for oper password encryption. #
304 # host - host of client allowed to oper-up. #
305 # wildcards accepted, seperate multiple hosts with space #
306 # You may also specify CIDR ip addresses. #
308 # type - specified above, defines the kind of operator #
310 # Syntax is as follows: #
311 # <oper name="login" #
313 # host="hostmask@of.oper" #
314 # type="oper type"> #
317 <oper name="katsklaw"
319 host="ident@dialup15.isp.com *@localhost *@server.com *@3ffe::0/16"
323 #-#-#-#-#-#-#-#-#-#-#- SERVER LINK CONFIGURATION -#-#-#-#-#-#-#-#-#-#
325 # Defines which servers can link to this one, and which servers this #
326 # server may create outbound links to. #
328 # name - The name is the canocial name of the server, does #
329 # not have to resolve - but it is expected to be sent #
330 # in the remote servers connection info. #
331 # ipaddr - Valid host or ip address for remote server. * #
333 # port - The TCP port for the remote server. #
335 # sendpass - Password to send to create an outbound connection #
338 # recvpass - Password to receive to accept an inbound connection #
339 # from this server. #
341 # autoconnect - Sets the server to autoconnect. Where x is the num. #
342 # (optional) of seconds between attempts. e.g. 300 = 5 minutes. #
344 # encryptionkey - Encryption key to be used for AES encryption, where #
345 # supported. Links using the spanning tree protocol #
346 # support AES. The encryption key must be EXACTLY 8, #
347 # 16 or 32 characters in length for a 64, 128 or 256 #
348 # bit key, respectively. #
350 # hidden - When using m_spanningtree.so for linking. you may #
351 # set this to 'yes', and if you do, the IP address/ #
352 # hostname of this connection will NEVER be shown to #
353 # any opers on the network. In /STATS c its address #
354 # will show as *@<hidden>, and during CONNECT and #
355 # inbound connections, its IP will show as <hidden> #
356 # UNLESS the connection fails (e.g. due to a bad #
357 # password or servername) #
359 # allowmask - When this is defined, it indicates a range of IP #
360 # addresses to allow for this link (in CIDR form). #
361 # e.g. if your server is going to connect to you from #
362 # the range 1.2.3.1 through 1.2.3.255, put 1.2.3.0/24 #
363 # into this value. If it is not defined, then only #
364 # the ipaddr field of the server shall be allowed. #
366 # to u:line a server (give it extra privilages required for running #
367 # services, Q, etc) you must include the <uline server> tag as shown #
368 # in the example below. You can have as many of these as you like. #
370 # WARNING: Unlike other ircds, u:lining a server allows ALL users on #
371 # that server to operoverride modes. This should only be used for #
372 # services and protected oper servers! #
374 # NOTE: If you have built InspIRCd with IPV6 support, and you want #
375 # to link to an IPV4 server, you must specify the IP address in the #
376 # form '::ffff:1.2.3.4' where 1.2.3.4 is the IP address of the target #
377 # server. If you have built InspIRCd for IPV4 (this is the default) #
378 # you should not prefix your IP addresses in this fashion. #
380 # ____ _ _____ _ _ ____ _ _ _ #
381 # | _ \ ___ __ _ __| | |_ _| |__ (_)___ | __ )(_) |_| | #
382 # | |_) / _ \/ _` |/ _` | | | | '_ \| / __| | _ \| | __| | #
383 # | _ < __/ (_| | (_| | | | | | | | \__ \ | |_) | | |_|_| #
384 # |_| \_\___|\__,_|\__,_| |_| |_| |_|_|___/ |____/|_|\__(_) #
386 # If you want to link servers to InspIRCd you must load the #
387 # m_spanningtree module! Please see the modules list below for #
388 # information on how to load this module! If you do not load this #
389 # module, server links will NOT work! #
392 <link name="hub.penguin.org"
393 ipaddr="penguin.box.com"
395 allowmask="69.58.44.0/24"
397 sendpass="outgoing!password"
398 recvpass="incoming!password">
400 <link name="services.antarctic.com"
403 allowmask="127.0.0.0/8"
405 recvpass="polarbears">
407 <uline server="services.antarctic.com">
410 #-#-#-#-#-#-#-#-#-#- MISCELLANEOUS CONFIGURATION -#-#-#-#-#-#-#-#-#-#
412 # These options let you define the path to your motd and rules #
416 <files motd="/home/cc/inspircd/conf/inspircd.motd"
417 rules="/home/cc/inspircd/conf/inspircd.rules">
419 #-#-#-#-#-#-#-#-#-#-#-#-#-#-# DNS SERVER -#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
421 # Define your DNS server address here. InspIRCd has its own resolver. #
422 # If you do not define this value, the first dns server from your #
423 # /etc/resolv.conf file is read. If no entries are found in this file #
424 # or the file cannot be opened, the default value '127.0.0.1' is used #
425 # instead. The timeout value is in seconds. #
427 # ____ _ _____ _ _ ____ _ _ _ #
428 # | _ \ ___ __ _ __| | |_ _| |__ (_)___ | __ )(_) |_| | #
429 # | |_) / _ \/ _` |/ _` | | | | '_ \| / __| | _ \| | __| | #
430 # | _ < __/ (_| | (_| | | | | | | | \__ \ | |_) | | |_|_| #
431 # |_| \_\___|\__,_|\__,_| |_| |_| |_|_|___/ |____/|_|\__(_) #
433 # When choosing a server, be sure to choose one which will do a #
434 # RECURSIVE LOOKUP. InspIRCd's resolver does not currently do these #
435 # recursive lookups itself, to save time and resources. The dns #
436 # server recommended by the InspIRCd team is bind, available from the #
437 # ISC website. If your DNS server does not do a recursive lookup, you #
438 # will be able to notice this by the fact that none of your users are #
439 # resolving even though the DNS server appears to be up! Most ISP and #
440 # hosting provider DNS servers support recursive lookups. #
442 # NOTE: If you have built InspIRCd with IPV6 support, and you want #
443 # to use an IPV4 nameserver, you must specify the IP address in the #
444 # form '::ffff:1.2.3.4' where 1.2.3.4 is the IP address of the target #
445 # server. If you have built InspIRCd for IPV4 (this is the default) #
446 # you should not prefix your IP addresses in this fashion. #
448 # IF YOUR RESOLV.CONF CONTAINS ONLY IPV4 ADDRESSES, AND YOU ARE USING #
449 # IPV6, YOU MUST DEFINE THE <DNS SERVER> TAG, AND USE THE ::FFFF #
450 # PREFIX NOTATION. IF YOU DO NOT, HOSTS WILL *NOT* RESOLVE. #
453 <dns server="127.0.0.1" timeout="5">
455 # An example of using IPV4 nameservers over IPV6
456 #<dns server="::ffff:127.0.0.1" timeout="5">
458 #-#-#-#-#-#-#-#-#-#-#-#-#-#-# PID FILE -#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
460 # Define the path to the PID file here. The PID file can be used to #
461 # rehash the ircd from the shell or to terminate the ircd from the #
462 # shell using shell scripts, perl scripts etc, and to monitor the #
463 # ircd's state via cron jobs. #
466 <pid file="/path/to/inspircd.pid">
468 #-#-#-#-#-#-#-#-#-#-#-#-#- BANLIST LIMITS #-#-#-#-#-#-#-#-#-#-#-#-#-#-#
470 # Use these tags to customise the ban limits on a per channel basis. #
471 # the tags are read from top to bottom, and any tag found which #
472 # matches the channels name applies the banlimit to that channel. #
473 # It is advisable to put an entry with the channel as '*' at the #
474 # bottom of the list. If none are specified or no maxbans tag is #
475 # matched, the banlist size defaults to 64 entries. #
478 <banlist chan="#morons" limit="128">
479 <banlist chan="*" limit="69">
481 #-#-#-#-#-#-#-#-#-#-#- DISABLED COMMANDS -#-#-#-#-#-#-#-#-#-#-#-#-#-#
483 # This tag is optional, and specifies one or more commands which are #
484 # not available to non-operators. For example you may wish to disable #
485 # NICK and prevent non-opers from changing their nicknames. #
486 # Note that any disabled commands take effect only after the user has #
487 # 'registered' (e.g. after the initial USER/NICK/PASS on connection) #
488 # so for example disabling NICK will not cripple your network. #
491 #<disabled commands="TOPIC MODE">
494 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#- RTFM LINE -#-#-#-#-#-#-#-#-#-#-#-#-#-#
496 # Just remove this... Its here to make you read ALL of the config #
499 <die value="You should probably edit your config *PROPERLY* and try again.">
503 #-#-#-#-#-#-#-#-#-#-#-#-#- SERVER OPTIONS -#-#-#-#-#-#-#-#-#-#-#-#-#
505 # Settings to define which features are useable on your server. #
507 # prefixquit - a prefix for a client's quit message #
509 # loglevel - specifies what detail of messages to log in the #
510 # log file. You may select from debug, verbose, #
511 # default, sparse and none. #
513 # allowhalfop - allows the +h channel mode #
515 # noservices - If noservices is true, yes, or 1, then the first #
516 # user into a channel gets founder status. This is #
517 # only useful on networks running the m_chanprotect #
518 # module without services. #
520 # netbuffersize - size of the buffer used to receive data from #
521 # clients. The ircd may only read() this amount #
522 # of text in one go at any time. (OPTIONAL) #
524 # maxwho - The maximum number of results returned by a /WHO #
525 # query. This is to prevent /WHO being used as a #
526 # spam vector or means of flooding an ircd. The #
527 # default is 128, it is not recommended to raise it #
528 # above 1024. Values up to 65535 are permitted. #
530 # somaxconn - The maximum number of sockets that may be waiting #
531 # in the accept queue. This usually allows the ircd #
532 # to soak up more connections in a shorter space of #
533 # time when increased but please be aware there is a #
534 # system defined maximum value to this, the same way #
535 # there is a system defined maximum number of file #
536 # descriptors. Some systems may only allow this to #
537 # be up to 5 (ugh) while others such as FreeBSD will #
538 # default to a much nicer 128. #
540 # moduledir - This optional value indicates a runtime change of #
541 # the location where modules are to be found. This #
542 # does not add a supplementary directory. There can #
543 # only be one module path. #
545 # softlimit - This optional feature allows a defined softlimit. #
546 # if defined sets a soft maxconnections value, has #
547 # to be less than the ./configure maxclients #
549 # operonlystats - The operonlystats field is optional and specifies #
550 # which stats characters in /STATS may only be #
551 # requested by an IRC operator. Stats characters in #
552 # this field are case sensitive and enforced as #
553 # oper-only independent of if they are in a module #
556 # operspywhois - If this is set then when an IRC operator uses #
557 # /WHOIS on a user they will see all channels, even #
558 # ones if channels are secret (+s), private (+p) or #
559 # if the target user is invisible +i. #
561 # customversion - If you specify this configuration item, and it is #
562 # not set to an empty value, then when a user does #
563 # a /VERSION command on the ircd, this string will #
564 # be displayed as the second portion of the output, #
565 # replacing the system 'uname', compile flags and #
566 # socket engine/dns engine names. You may use this #
567 # to enhance security, or simply for vanity. #
569 # maxtargets - The maxtargets field is optional, and if not #
570 # defined, defaults to 20. It indicates the maximum #
571 # number of targets which may be given to commands #
572 # such as PRIVMSG, KICK etc. #
574 # hidesplits - When set to 'yes', will hide split server names #
575 # from non-opers. Non-opers will see '*.net *.split' #
576 # instead of the server names in the quit message, #
577 # identical to the way IRCu displays them. #
579 # hidebans - When set to 'yes', will hide gline, kline, zline #
580 # and qline quit messages from non-opers. For #
581 # example, user A who is not an oper will just see #
582 # (G-Lined) while user B who is an oper will see the #
583 # text (G-Lined: Reason here) instead. #
585 # hidewhois - When defined with a non-empty value, the given #
586 # text will be used in place of the user's server #
587 # in WHOIS, when a user is WHOISed by a non-oper. #
588 # For example, most nets will want to set this to #
589 # something like '*.netname.net' to conceal the #
590 # actual server the user is on. #
592 # flatlinks - When you are using m_spanningtree.so, and this #
593 # value is set to true, yes or 1, /MAP and /LINKS #
594 # will be flattened when shown to a non-oper. #
596 # hideulines - When you are using m_spanningtree.so, and this #
597 # value is set to true, yes or 1, then U-lined #
598 # servers will be hidden in /LINKS and /MAP. For non #
599 # opers. Please be aware that this will also hide #
600 # any leaf servers of a U-lined server, e.g. jupes. #
602 # tempdir - If defined, indicates a path where modules will be #
603 # temporarily copied before loading. If not defined, #
604 # defaults to /tmp. #
606 # nouserdns - If set to 'yes', 'true' or '1', no user dns #
607 # lookups will be performed for connecting users. #
608 # this can save a lot of resources on very busy irc #
611 # syntaxhints - If et to 'yes', 'true' or '1', when a user does #
612 # not give enough parameters for a command, a syntax #
613 # hint will be given (using the RPL_TEXT numeric) #
614 # as well as the standard ERR_NEEDMOREPARAMS. #
617 <options prefixquit="Quit: "
619 netbuffersize="10240"
624 operonlystats="oclgkz"
639 #-#-#-#-#-#-#-#-#-#-#-#-#- MODULE OPTIONS -#-#-#-#-#-#-#-#-#-#-#-#-#
641 # These tags define which modules will be loaded on startup by your #
642 # server. Add modules without any paths. When you make your ircd #
643 # using the 'make' command, all compiled modules will be moved into #
644 # the folder you specified when you ran ./configure. The module tag #
645 # automatically looks for modules in this location. #
646 # If you attempt to load a module outside of this location, either #
647 # in the config, or via /LOADMODULE, you will receive an error. #
649 # By default, ALL modules are commented out. You must uncomment them #
650 # or add lines to your config to load modules. Please refer to #
651 # http://www.inspircd.org/wiki/Modules_List for a list of modules and#
652 # each modules link for any additional conf tags they require. #
654 # WINDOWS USERS PLEASE NOTE: You can still load these modules! They #
655 # are incorporated into the executable and can be loaded and removed #
656 # similarly to if they were in a ramdisk. #
657 # ____ _ _____ _ _ ____ _ _ _ #
658 # | _ \ ___ __ _ __| | |_ _| |__ (_)___ | __ )(_) |_| | #
659 # | |_) / _ \/ _` |/ _` | | | | '_ \| / __| | _ \| | __| | #
660 # | _ < __/ (_| | (_| | | | | | | | \__ \ | |_) | | |_|_| #
661 # |_| \_\___|\__,_|\__,_| |_| |_| |_|_|___/ |____/|_|\__(_) #
663 # To link servers to InspIRCd, you MUST load the m_spanningtree #
664 # module, as shown below. If you DO NOT do this, server links will #
665 # NOT work at all. ie. The ports will NOT bind, and /connect will not #
666 # work properly. This is by design, to allow for the implementation #
667 # of other linking protocols in modules in the future. #
669 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
670 # Spanning Tree module - allows linking of servers using the spanning
671 # tree protocol (see the READ THIS BIT section above).
673 #<module name="m_spanningtree.so">
675 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
676 # Alias module: Allows you to define server-side command aliases
677 #<module name="m_alias.so">
679 #-#-#-#-#-#-#-#-#-#-#- ALIAS DEFINITIONS -#-#-#-#-#-#-#-#-#-#-#-#-#-#
681 # If you have the m_alias.so module loaded, you may also define #
682 # aliases as shown below. They are commonly used to provide shortcut #
683 # commands to services, however they are not limited to jsut this use.#
684 # An alias tag requires the following values to be defined in it: #
686 # text - The text to detect at the start of the line, #
687 # must be at the start of the line to trigger the #
688 # alias. Cant contain spaces, but case insensitive #
689 # replace - The text to replace 'text' with. Usually this #
690 # will be "PRIVMSG ServiceName" or similar. #
691 # requires - If you provide a value for 'requires' this means #
692 # the given nickname MUST be online for the alias #
693 # to successfully trigger. If they are not, then #
694 # the user receives a 'no such nick' 401 numeric. #
695 # uline - Defining this value with 'yes', 'true' or '1' #
696 # will ensure that the user given in 'requires' #
697 # must also be on a u-lined server, as well as #
698 # actually being on the network. If the user is #
699 # online, but not on a u-lined server, then an #
700 # oper-alert is sent out as this is possibly signs #
701 # of a user trying to impersonate a service. #
703 #<alias text="NICKSERV" replace="PRIVMSG NickServ" requires="NickServ" uline="yes">
704 #<alias text="CHANSERV" replace="PRIVMSG ChanServ" requires="ChanServ" uline="yes">
705 #<alias text="NS" replace="PRIVMSG NickServ" requires="NickServ" uline="yes">
706 #<alias text="CS" replace="PRIVMSG ChanServ" requires="ChanServ" uline="yes">
708 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
709 # Antibear security module: Prevents 'bear.txt' based trojans from
710 # connecting to your network by sending them a numeric they can't handle.
711 #<module name="m_antibear.so">
713 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
714 # Antibottler module: Labels bottler leech bots
715 #<module name="m_antibottler.so">
717 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
718 # Ban except module: Adds support for channel ban exceptions (+e)
719 #<module name="m_banexception.so">
721 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
722 # Block amsg module: Attempt to block all usage of /amsg and /ame
723 #<module name="m_blockamsg.so">
725 #-#-#-#-#-#-#-#-#-#-#- BLOCKAMSG CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
727 # If you have the m_blockamsg.so module loaded, you can configure it #
728 # with the <blockamsg> tag: #
730 # delay - How many seconds between two messages to force #
731 # them to be recognised as unrelated. #
732 # action - Any of 'notice', 'noticeopers', 'silent', 'kill' #
733 # or 'killopers'. Define how to take action when #
734 # a user uses /amsg or /ame. #
736 #<blockamsg delay="3" action="killopers">
738 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
739 # Block CAPS module: Blocking all-CAPS messages with cmode +P
740 #<module name="m_blockcaps.so">
742 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
743 # Block colour module: Blocking colour-coded messages with cmode +c
744 #<module name="m_blockcolor.so">
746 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
747 # Botmode module: Adds the user mode +B
748 #<module name="m_botmode.so">
750 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
751 # CBAN module: Lets you disallow channels from being used at runtime.
752 #<module name="m_cban.so">
754 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
755 # Censor module: Adds the channel mode +G
756 #<module name="m_censor.so">
758 #-#-#-#-#-#-#-#-#-#-#- CENSOR CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#
760 # Optional - If you specify to use the m_censor module, then specfiy #
761 # below the path to the censor.conf file. See also: #
762 # Censor file, see http://www.inspircd.org/wiki/Censor_Module #
764 #<censor file="/path/to/censor.conf">
766 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
767 # Channel filter module: Allows channel-op defined message
768 # filtering using simple string matches (channel mode +g)
769 #<module name="m_chanfilter.so">
771 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
772 # Chanprotect module: gives +q and +a channel modes
773 #<module name="m_chanprotect.so">
775 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
776 # CHGHOST module: Adds the /CHGHOST command
777 #<module name="m_chghost.so">
779 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
780 # CHGIDENT module: Adds the /CHGIDENT command
781 #<module name="m_chgident.so">
783 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
784 # Cloaking module: Adds usermode +x and cloaking support
785 #<module name="m_cloaking.so">
787 #-#-#-#-#-#-#-#-#-#-#- CLOAKING CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#
789 # Optional - If ypu specify the m_cloaking.so module as above, you #
790 # must define cloak keys, and optionally a cloak prefix as shown #
791 # below. When using cloaking, the cloak keys are MANDITORY and must #
792 # be included. However, if prefix is not included, it will default #
793 # to your networks name from the <server> tag. #
795 # <cloak key1="-543241423" #
796 # key2="5378410432" #
797 # key3="1143242382" #
798 # key4="9504324581" #
801 # Please note that the key values will accept any number, positive #
802 # or negative, and should be large numbers. Using small numbers such #
803 # as "7" or "1924" will seriously weaken the security of your cloak. #
805 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
806 # Conn-Lusers: Shows the LUSERS output on connect
807 #<module name="m_conn_lusers.so">
809 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
810 # Conn-Wait-for-Pong: Don't let a user connect until they PONG
811 #<module name="m_conn_waitpong.so">
813 #-#-#-#-#-#-#-#-#-#-#- WAITPONG CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
815 # If you have the m_conn_waitpong.so module loaded, configure it with #
816 # the <waitpong> tag: #
818 # sendsnotice - Whether to send a snotice on connect, like Unreal#
819 # killonbadreply - Whether to kill the user if they send the wrong #
822 #<waitpong sendsnotice="yes" killonbadreply="yes">
824 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
825 # Connection throttle module. Configuration:
826 #<module name="m_connflood.so">
828 #-#-#-#-#-#-#-#-#-#-#- CONTHROTTLE CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
829 # seconds, maxconns - Amount of connections per <seconds>.
830 # timeout - Time to wait after the throttle was activated
831 # before deactivating it. Be aware that the time
832 # is seconds + timeout.
833 # quitmsg - The message that users get if they attempt to
834 # connect while the throttle is active.
835 # bootwait - Amount of time to wait before enforcing the
836 # throttling when the server just booted.
838 #<connflood seconds="30" maxconns="3" timeout="30"
839 # quitmsg="Throttled" bootwait="10">
841 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
842 # Deny Channels: Deny Channels from being used by users
843 #<module name="m_denychans.so">
845 #-#-#-#-#-#-#-#-#-#-#- DENYCHAN DEFINITIONS -#-#-#-#-#-#-#-#-#-#-#-#
847 # If you have the m_denychans.so module loaded, you need to specify #
848 # the channels to deny:
850 # name - The channel name to deny. #
851 # allowopers - If operators are allowed to override the deny. #
852 # reason - Reason given for the deny. #
854 #<badchan name="#gods" allowopers="yes" reason="Tortoises!">
856 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
857 # Devoice Module: Let users devoice themselves.
858 #<module name="m_devoice.so">
860 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
861 # Filter module: Provides glob-based message filtering
862 #<module name="m_filter.so">
864 # PCRE filter module: Filters messages using regular expressions
865 #<module name="m_filter_pcre.so">
867 #-#-#-#-#-#-#-#-#-#-#- FILTER CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#
869 # Optional - If you specify to use the m_filter or m_filter_pcre #
870 # modules, then specfiy below the path to the filter.conf file. #
872 #<filter file="/path/to/inspircd/filter.conf">
874 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
875 # Foobar module - does nothing - historical relic
876 #<module name="m_foobar.so">
878 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
879 # Globops module: gives /GLOBOPS and usermode +g
880 #<module name="m_globops.so">
882 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
883 # Global load module: Allows loading and unloading of modules network-
884 # wide (USE WITH EXTREME CAUTION!)
885 #<module name="m_globalload.so">
887 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
888 # HELPOP module: Provides the /HELPOP command
889 #<module name="m_helpop.so">
891 #-#-#-#-#-#-#-#-#-#-#-#- HELPOP CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
893 # Optional - If you specify to use the m_helpop.so module, then #
894 # specify below the path to the helpop.conf file. #
896 #<helpop file="/path/to/inspircd/helpop.conf">
898 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
899 # Hostchange module: Allows a different style of cloaking
900 #<module name="m_hostchange.so">
902 #-#-#-#-#-#-#-#-#-#-#- HOSTCHANGE CONFIGURATION -#-#-#-#-#-#-#-#-#-#
904 # Optional - If you choose to use the m_hostchange.so module. #
905 # Config Help - See http://www.inspircd.org/wiki/Host_Changer_Module #
907 #<host suffix="polarbears.org">
908 #<hostchange mask="*@fbi.gov" action="addnick">
909 #<hostchange mask="*r00t@*" action="suffix">
910 #<hostchange mask="a@b.com" action="set" value="blah.blah.blah">
912 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
913 # httpd module: Provides http server support for InspIRCd
914 #<module name="m_httpd.so">
916 #-#-#-#-#-#-#-#-#-#-#-#- HTTPD CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
918 # Optional - If you choose to use the m_httpd.so module, then you must
919 # specify the port number and other details of your http server:
921 #<http ip="192.168.1.10" host="brainwave" port="32006"
922 # index="/home/brain/inspircd/http/index.html">
925 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
926 # http stats module: Provides basic stats pages over HTTP
927 # Required m_httpd.so
928 #<module name="m_http_stats.so">
930 #-#-#-#-#-#-#-#-#-#-#-#- HTTPD STATS CONFIGURATION -#-#-#-#-#-#-#-#-#-#
932 # No extra configuration yet.
935 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
936 # Ident: Provides RFC 1413 ident lookup support
937 #<module name="m_ident.so">
939 #-#-#-#-#-#-#-#-#-#-#-#- IDENT CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
941 # Optional - If you are using the m_ident.so module, then you can #
942 # specify the timeout for ident lookups here. If not defined, it will #
943 # default to one second. This is a non-blocking timeout which holds #
944 # the user in a 'connecting' state until the lookup is complete. #
948 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
949 # Invite except module: Adds support for channel invite exceptions (+I)
950 #<module name="m_inviteexception.so">
952 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
953 # Join flood module: Adds support for join flood protection (+j)
954 #<module name="m_joinflood.so">
956 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
957 # Anti-Auto-Rejoin: Adds support for prevention of auto-rejoin (+J)
958 #<module name="m_kicknorejoin.so">
960 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
961 # Knock module: adds the /KNOCK command and +K channel mode
962 #<module name="m_knock.so">
964 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
965 # Msg flood module: Adds message/notice flood protection (+f)
966 #<module name="m_messageflood.so">
968 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
969 # MySQL module: Allows other SQL modules to access MySQL databases
970 # through a unified API. You must copy the source for this module
971 # from the directory src/modules/extra, plus the file m_sqlv2.h
972 #<module name="m_mysql.so">
974 #-#-#-#-#-#-#-#-#-#-#-#- SQL CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#-#
976 # m_mysql.so is more complex than described here, see the wiki for #
977 # more: http://www.inspircd.org/wiki/SQL_Service_Provider_Module #
979 #<database name="mydb" username="myuser" password="mypass" hostname="localhost" id="my_database2">
981 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
982 # Nicklock module: Let opers change a user's nick and then stop that
983 # user from changing their nick again. /NICKLOCK and /NICKUNLOCK
984 #<module name="m_nicklock.so">
986 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
987 # No ctcp module: Adds the channel mode +C to block CTCPs
988 #<module name="m_noctcp.so">
990 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
991 # Noinvite module: Gives channel mode +V
992 #<module name="m_noinvite.so">
994 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
995 # No kicks module: Adds the +Q channel mode
996 #<module name="m_nokicks.so">
998 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
999 # No nicks module: Adds the +N channel mode
1000 #<module name="m_nonicks.so">
1002 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1003 # No Notice module: adds the channel mode +T
1004 #<module name="m_nonotice.so">
1006 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1007 # Oper channels mode: Adds the +O channel mode
1008 #<module name="m_operchans.so">
1010 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1011 # Oper Join module: Forces opers to join a channel on oper-up
1012 #<module name="m_operjoin.so">
1014 #-#-#-#-#-#-#-#-#-#-# OPERJOIN CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
1016 # If you are using the m_operjoin.so module, specify the channel here #
1018 #<operjoin channel="#channel">
1020 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1021 # Oper MOTD module: Provides support for seperate message of the day
1023 #<module name="m_opermotd.so">
1025 #-#-#-#-#-#-#-#-#-#-# OPERMOTD CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
1027 # If you are using the m_opermotd.so module, specify the motd here #
1029 #<opermotd file="/path/to/oper.motd">
1031 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1032 # Override module: Adds support for oper override
1033 #<module name="m_override.so">
1035 #-#-#-#-#-#-#-#-#-#-# OVERRIDE CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
1037 # m_override.so is too complex it describe here, see the wiki: #
1038 # http://www.inspircd.org/wiki/Oper_Override_Module #
1040 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1041 # Oper levels module: Gives each oper a level and prevents
1042 # actions being taken against higher level opers
1043 # Specify the level as the 'level' parameter of the <type> tag
1044 #<module name="m_operlevels.so">
1046 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1047 # Oper MD5 module: Allows MD5 hashed oper passwords
1048 #<module name="m_opermd5.so">
1050 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1051 # Oper SHA256 module: Allows SHA256 hashed oper passwords
1052 # This module is in src/modules/extra
1053 #<module name="m_opersha256.so">
1055 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1056 # Oper modes module: Allows you to specify modes to add/remove on oper
1057 # Specify the modes as the 'modes' parameter of the <type> tag
1058 #<module name="m_opermodes.so">
1060 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1061 # Parking module: Adds parking support and /PARK and /UNPARK
1062 #<module name="m_park.so">
1064 #-#-#-#-#-#-#-#-#-#-#-# PARK CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#
1066 # m_park.so is too complex it describe here, see the wiki: #
1067 # http://www.inspircd.org/wiki/User_Parking_Module #
1069 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1070 # PostgreSQL module: Allows other SQL modules to access PgSQL databases
1071 # through a unified API. You must copy the source for this module
1072 # from the directory src/modules/extra, plus the file m_sqlv2.h
1073 #<module name="m_pgsql.so">
1075 #-#-#-#-#-#-#-#-#-#-#-#- SQL CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#-#
1077 # m_pgsql.so is more complex than described here, see the wiki for #
1078 # more: http://www.inspircd.org/wiki/SQL_Service_Provider_Module #
1080 #<database name="mydb" username="myuser" password="mypass" hostname="localhost" id="my_database" ssl="no">
1082 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1083 # Random Quote module: provides a random quote on connect
1084 #<module name="m_randquote.so">
1086 #-#-#-#-#-#-#-#-#-#- RANDOMQUOTES CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
1088 # Optional - If you specify to use the m_randquote.so module, then #
1089 # specify below the path to the randquotes.conf file. #
1091 #<randquote file="/path/to/inspircd/randquotes.conf">
1093 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1094 # Redirect module: Adds channel redirection (mode +L)
1095 #<module name="m_redirect.so">
1097 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1098 # Remove module: Adds the /REMOVE command which is a peaceful
1099 # alternative to /KICK
1100 #<module name="m_remove.so">
1102 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1103 # Restricted channels module: Allows only opers to create channels
1104 #<module name="m_restrictchans.so">
1106 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1107 # Restrict message module: Allows users to only message opers
1108 #<module name="m_restrictmsg.so">
1110 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1111 # Provide /LIST throttling (to prevent flooding) and /LIST safety to
1112 # prevent excess flood when the list is large.
1113 #<module name="m_safelist.so">
1115 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1116 # SAJOIN module: Adds the /SAJOIN command
1117 #<module name="m_sajoin.so">
1119 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1120 # SAMODE module: Adds the oper /SAMODE command
1121 #<module name="m_samode.so">
1123 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1124 # SANICK module: Allows opers to change user's nicks
1125 #<module name="m_sanick.so">
1127 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1128 # SAPART module: Adds the oper /SAPART command
1129 #<module name="m_sapart.so">
1131 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1132 # SAQUIT module: Adds the oper /SAQUIT command (abusable!!!)
1133 #<module name="m_saquit.so">
1135 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-
1136 # Secure list module: Prevent /LIST in the first minute of connection,
1137 # crippling most spambots and trojan spreader bots.
1138 #<module name="m_securelist.so">
1140 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1141 # Set Idle module: Adds a command for opers to change their
1142 # idle time (mainly a toy)
1143 #<module name="m_setidle.so">
1145 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1146 # Services support module: Adds several usermodes such as +R and +M
1147 # this module implements the 'identified' state via user mode +r, which
1148 # is similar to the DALnet and dreamforge systems.
1149 #<module name="m_services.so">
1151 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1152 # Services support module: Adds several usermodes such as +R and +M
1153 # this module implements the 'identified' state via account names (AC)
1154 # and is similar in operation to the way asuka and ircu handle services.
1155 # it cannot be used at the same time as m_services, above.
1156 #<module name="m_services_account.so">
1158 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1159 # Sethost module: Adds the /SETHOST command
1160 #<module name="m_sethost.so">
1162 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1163 # Setident module: Adds the /SETIDENT command
1164 #<module name="m_setident.so">
1166 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1167 # SETNAME module: Adds the /SETNAME command
1168 #<module name="m_setname.so">
1170 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1171 # Show Whois module: Adds the +W usermode which allows opers
1172 # to see when they are whois'ed
1173 #<module name="m_showwhois.so">
1175 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1176 # Spy module: Adds the commands SPYLIST and SPYNAMES that let opers
1177 # see who is in a +s channel, and list +s channels, show keys of keyed
1178 # channels the oper is not a member of etc. (standard 'abusive' features
1179 # of unrealircd, modulized here in InspIRCd).
1180 #<module name="m_spy.so">
1182 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1183 # SSL channel mode module: Adds support for SSL-only channels (+z).
1184 # does not do anything useful without a working SSL module (see below)
1185 #<module name="m_sslmodes.so">
1187 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1188 # Dummy ssl module: If you have other servers on your network which
1189 # have SSL, but your server does not have ssl enabled, you should load
1190 # this module, which will handle SSL metadata (e.g. the "Is using ssl"
1191 # field in the WHOIS information).
1192 #<module name="m_ssl_dummy.so">
1194 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1195 # GnuTLS ssl module: Adds support for client-server SSL using GnuTLS,
1196 # if enabled. You must copy the source for this module from the directory
1197 # src/modules/extra, or answer 'yes' in ./configure when asked if you
1198 # want to enable this, or it will not load.
1199 #<module name="m_ssl_gnutls.so">
1201 #-#-#-#-#-#-#-#-#-#-#- GNUTLS CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#
1203 # m_ssl_gnutls.so is too complex it describe here, see the wiki: #
1204 # http://www.inspircd.org/wiki/GnuTLS_SSL_Module #
1206 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1207 # OpenSSL ssl module: Adds support for client-server SSL using OpenSSL,
1208 # if enabled. You must copy the source for this module from the directory
1209 # src/modules/extra, or answer 'yes' in ./configure when asked if you
1210 # want to enable this, or it will not load.
1211 #<module name="m_ssl_openssl.so">
1213 #-#-#-#-#-#-#-#-#-#-#- OPENSSL CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#
1215 # m_ssl_openssl.so is too complex it describe here, see the wiki: #
1216 # http://www.inspircd.org/wiki/OpenSSL_SSL_Module #
1218 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1219 # Strip colour module: Adds the channel mode +S
1220 #<module name="m_stripcolor.so">
1222 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1223 # SILENCE module: Adds support for /SILENCE
1224 #<module name="m_silence.so">
1226 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1227 # SQL authentication module: Allows IRCd connections to be tied into
1228 # a database table (for example a forum). You must copy the source for
1229 # this module from the directory src/modules/extra
1230 #<module name="m_sqlauth.so">
1232 #-#-#-#-#-#-#-#-#-#-#- SQLAUTH CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#
1234 # m_sqlauth.so is too complex it describe here, see the wiki: #
1235 # http://www.inspircd.org/wiki/SQL_Authentication_Module #
1237 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1238 # SQL logging module: Allows you to log network-wide data for your
1239 # network in a fully normalized set of SQL tables. You must copy the
1240 # source for this module from the directory src/modules/extra
1241 #<module name="m_sqllog.so">
1243 #-#-#-#-#-#-#-#-#-#-#- SQLLOG CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#
1245 # dbid - Database ID to use (see m_sql) #
1247 # See also: http://www.inspircd.org/wiki/SQL_Logging_Module #
1251 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1252 # SQL oper module: Allows you to store oper credentials in an SQL table
1253 # You must copy the source for this module from the directory src/modules/extra
1254 #<module name="m_sqloper.so">
1256 #-#-#-#-#-#-#-#-#-#-#- SQLOPER CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#
1258 # dbid - Database ID to use (see m_sql) #
1260 # See also: http://www.inspircd.org/wiki/SQL_Oper_Storage_Module #
1264 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1265 # SWHOIS module: Allows you to add arbitary lines to user WHOIS.
1266 #<module name="m_swhois.so">
1268 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1269 # Test command module: Does nothing significant. Read: pointless.
1270 #<module name="m_testcommand.so">
1272 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1273 # Timed bans module: Adds timed bans and the /TBAN command
1274 #<module name="m_timedbans.so">
1276 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1277 # Uninvite module: Adds the /UNINVITE command which lets users remove
1278 # pending invites from channels without waiting for the user to join.
1279 #<module name="m_uninvite.so">
1281 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1282 # Userip module: Adds the /USERIP command
1283 #<module name="m_userip.so">
1285 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1286 # Vhost module: Adds the VHOST command which allows for adding virtual
1287 # hosts which are accessible using a username and password in the config.
1288 #<module name="m_vhost.so">
1290 #-#-#-#-#-#-#-#-#-#-#- VHOST CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#-#
1292 # user - Username for the vhost. #
1294 # pass - Password for the vhost. #
1296 # host - Vhost to set. #
1298 #<vhost user="some_username" pass="some_password" host="some.host">
1300 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1301 # Watch module: Adds the WATCH command, which is used by clients to
1302 # maintain notify lists.
1303 #<module name="m_watch.so">
1305 #-#-#-#-#-#-#-#-#-#-#-#-#-#- BAN OPTIONS -#-#-#-#-#-#-#-#-#-#-#-#-#-#
1307 # The ban tags define nick masks, host masks and ip ranges which are #
1308 # banned from your server. All details in these tags are local to #
1312 # badip lines ban an ip range (same as a zline) #
1314 # ipmask - The ip range to ban (wildcards possible) #
1315 # CIDR is supported in <badip> and zline only #
1316 # reason - Reason to display when disconnected #
1318 # badnick lines ban a nick mask (same as a qline) #
1320 # nick - Nick mask to ban (wildcards possible) #
1321 # reason - Reason to display on /NICK #
1323 # badhost lines ban a user@host mask (same as a kline) #
1325 # host - ident@hostname (wildcards possible) #
1326 # reason - Reason to display on disconnection #
1328 # exception lines define a hostmask that is excempt from [kzg]lines #
1330 # host - ident@hostname (wildcards possible) #
1331 # reason - Reason, shown only in /stats e #
1334 <badip ipmask="69.69.69.69" reason="No porn here thanks.">
1336 <badnick nick="ChanServ" reason="Reserved For Services">
1337 <badnick nick="NickServ" reason="Reserved For Services">
1338 <badnick nick="OperServ" reason="Reserved For Services">
1339 <badnick nick="MemoServ" reason="Reserved For Services">
1341 <badhost host="*@hundredz.n.hundredz.o.1337.kiddies.com" reason="Too many 1337 kiddiots">
1342 <badhost host="*@localhost" reason="No irc from localhost!">
1344 <exception host="*@ircop.host.com" reason="Opers hostname">
1346 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#- YAWN -#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1348 # You should already know what to do here :) #
1350 <die value="You should probably edit your config *PROPERLY* and try again.">
1353 #########################################################################
1355 # - InspIRCd Development Team - #
1356 # http://www.inspircd.org #
1358 #########################################################################