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 : 04/09/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 (optionally), #
65 # nick, 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 address ports bind to. Leaving this #
83 # field blank binds the port to all IPs available. #
85 # port - The port number to bind to. You may specify a port #
86 # range here, e.g. "6667-6669,7000,7001". If you do #
87 # this, the server will count each port within your #
88 # range as a seperate binding, making the above #
89 # example equivalent to five seperate bind tags. #
90 # A failure on one port in the range does not prevent #
91 # the entire range from being bound, just that one #
94 # type - can be 'clients' or 'servers'. The clients type is #
95 # a standard tcp based socket, the servers type is a #
96 # also a TCP based connection but of a different #
97 # format. SSL support is provided by modules, to #
98 # enable SSL support, please read the module section #
99 # of this configuration file. #
101 # ssl - When using m_ssl_gnutls.so or m_ssl_openssl.so #
102 # modules, you must define this value to use ssl on #
103 # that port. valid values are 'gnutls' or 'openssl' #
104 # respectively. If the module is not loaded, this #
105 # setting is ignored. #
107 # transport - If you have m_spanningtree.so loaded, along with #
108 # either of the SSL modules (m_ssl_gnutls or #
109 # m_ssl_openssl) or m_ziplinks.so, then you may make #
110 # use of this value. #
111 # setting it to 'openssl' or 'gnutls' or 'zip' #
112 # indicates that the port should accept connections #
113 # using the given transport name. Transports are #
114 # layers which sit on top of a socket and change the #
115 # way data is sent and received, e.g. encryption, #
116 # compression, and other such things. Because this #
117 # may not be limited in use to just encryption, #
118 # the 'ssl' value used for client ports does not #
119 # exist for servers, and this value is used instead. #
120 # ____ _ _____ _ _ ____ _ _ _ #
121 # | _ \ ___ __ _ __| | |_ _| |__ (_)___ | __ )(_) |_| | #
122 # | |_) / _ \/ _` |/ _` | | | | '_ \| / __| | _ \| | __| | #
123 # | _ < __/ (_| | (_| | | | | | | | \__ \ | |_) | | |_|_| #
124 # |_| \_\___|\__,_|\__,_| |_| |_| |_|_|___/ |____/|_|\__(_) #
126 # If you want to link servers to InspIRCd you must load the #
127 # m_spanningtree module! Please see the modules list below for #
128 # information on how to load this module! If you do not load this #
129 # module, server ports will NOT be bound! #
131 # Leaving address empty binds to all available interfaces #
133 # Syntax is as follows: #
135 # <bind address="ip address" port="port" type="clients"> #
136 # <bind address="ip address" port="port" type="servers"> #
138 # If InspIRCd is built for IPV6, and you wish to accept IPV4 clients, #
139 # then you must specify your IPV6 clients in the following form: #
140 # ::ffff:1.2.3.4, where 1.2.3.4 is the IPV4 address to bind the #
141 # port on. If InspIRCd is built for IPV4 connections (this is the #
142 # default) then you do not need to prefix your addresses like this. #
145 <bind address="" port="6000" type="clients">
146 <bind address="" port="6660-6669" type="clients" ssl="gnutls">
148 # When linking servers, the openssl and gnutls transports are largely
149 # link-compatible and can be used alongside each other or either/or
150 # on each end of the link without any significant issues.
152 <bind address="" port="7000,7001" type="servers">
153 <bind address="1.2.3.4" port="7005" type="servers" transport="openssl">
156 #-#-#-#-#-#-#-#-#-#- DIE/RESTART CONFIGURATION -#-#-#-#-#-#-#-#-#-#-
158 # You can configure the passwords here which you wish to use for #
159 # the die and restart commands. Only trusted ircops who will #
160 # need this ability should know the die and restart password. #
162 # Syntax is as follows: #
163 # <power diepass="die password" restartpass="restart password" #
164 # pause="secs before dying"> #
167 <power diepass="diepass" restartpass="restartpass" pause="2">
170 #-#-#-#-#-#-#-#-#-# INCLUDE CONFIGURATION #-#-#-#-#-#-#-#-#-#-#-#-#-#
172 # This optional tag allows you to include another config file #
173 # allowing you to keep your configuration tidy. The configuration #
174 # file you include will be treated as part of the configuration file #
175 # which includes it, in simple terms the inclusion is transparent. #
177 # All paths to config files are relative to the directory of the main #
178 # config file inspircd.conf, unless the filename starts with a forward#
179 # slash (/) in which case it is treated as an absolute path. #
181 # Syntax is as follows: #
182 #<include file="file.conf"> #
185 #-#-#-#-#-#-#-#-#-#- CONNECTIONS CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
187 # This is where you can configure which connections are allowed #
188 # and denied access onto your server. #
189 # The password is optional. #
190 # You may have as many of these as you require. #
191 # To allow/deny all connections use a * #
193 # Syntax is as follows: #
195 # <connect allow="ip mask"> #
196 # <connect allow="ip mask" password="blahblah"> #
197 # <connect allow="ip mask" password="blah" timeout="10"> #
198 # <connect allow="ip mask" timeout="blah" flood="5"> #
199 # <connect allow="ip mask" threshold="8" pingfreq="120"> #
200 # <connect allow="ip mask" sendq="99999" revcq="696969"> #
201 # <connect allow="ip mask" localmax="3" globalmax="3"> #
202 # <connect deny="ip mask"> #
204 # IP masks may be specified in CIDR format or wildcard format, #
205 # for IPV4 and IPV6. #
207 # You may optionally include timeout="x" on any allow line, which #
208 # specifies the amount of time given before an unknown connection #
209 # is closed if USER/NICK/PASS are not given. This value is in secs #
211 # You should also include a flood="x" line which indicates #
212 # the number of lines a user may place into their buffer at once #
213 # before they are disconnected for excess flood. This feature can #
214 # not be disabled, however it can be set to extremely high values, #
215 # rendering it effectively disabled. A recommended value is 10. #
216 # A counter is maintained for each user which is reset every #
217 # 'threshold' seconds and specifying this threshold value with #
218 # threshold="X" indicates how often the counter is reset. For #
219 # example, with flood="5" and threshold="8", the user may not send #
220 # more than 5 lines in 8 secs. #
222 # You may optionally specify the sendq size and ping frequency of #
223 # each connect:allow line using the pingfreq="X" and sendq="X" #
224 # settings as shown in the full example below. #
225 # The ping frequency is specified in seconds, and the sendq size #
226 # in bytes. It is recommended, although not enforced, that you #
227 # should never set your sendq size to less than 8k. Send Queues are #
228 # dynamically allocated and can grow as needed up to the maximum #
231 # The optional recvq value is the maximum size which users in this #
232 # group may grow their receive queue to. This is recommended to be #
233 # kept pretty low compared to the sendq, as users will always #
234 # receive more than they send in normal circumstances. The default #
235 # if not specified is 4096. #
237 # IMPORTANT NOTE, CALL THE CONFUSION POLICE! #
238 # The sendq is the data waiting to be sent TO THE USER. #
239 # The recvq is the data being received FROM THE USER. #
240 # The names sendq and recvq are from the SERVER'S PERSPECTIVE not #
241 # that of the user... Just to clear up any confusion or complaints #
242 # that these are backwards :p #
244 # The localmax and globalmax values can be used to enforce local #
245 # and global session limits on connections. The session limits are #
246 # counted against all users, but applied only to users within the #
247 # class. For example, if you had a class 'A' which has a session #
248 # limit of 3, and a class 'B' which has a session limit of 5, and #
249 # somehow, two users managed to get into class B which also match #
250 # class A, there is only one connection left for this IP now in A, #
251 # but if they can connect again to B, there are three. You get the #
255 <connect allow="196.12.*" password="secret">
256 <connect allow="*" timeout="60" flood="20" threshold="1" pingfreq="120" sendq="262144" recvq="8192" localmax="3" globalmax="3">
258 <connect deny="69.254.*">
259 <connect deny="3ffe::0/32">
262 #-#-#-#-#-#-#-#-#-#-#-#- CLASS CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-
264 # Classes are a group of commands which are grouped together #
265 # and given a unique name. They used to define which commands #
266 # are available to certain types of Operators. #
268 # Syntax is as follows: #
270 # <class name="name" commands="oper commands"> #
272 # ____ _ _____ _ _ ____ _ _ _ #
273 # | _ \ ___ __ _ __| | |_ _| |__ (_)___ | __ )(_) |_| | #
274 # | |_) / _ \/ _` |/ _` | | | | '_ \| / __| | _ \| | __| | #
275 # | _ < __/ (_| | (_| | | | | | | | \__ \ | |_) | | |_|_| #
276 # |_| \_\___|\__,_|\__,_| |_| |_| |_|_|___/ |____/|_|\__(_) #
278 # You are not forced to give these classes the names given below. #
279 # You can create your own named classes, if you want, in fact that #
280 # is the whole idea of this system! #
282 # Note: It is possible to make a class which covers all available #
283 # commands. To do this, specify commands="*". This is not really #
284 # recommended, as it negates the whole purpose of the class system, #
285 # however it is provided for fast configuration (e.g. in test nets) #
288 <class name="Shutdown" commands="DIE RESTART REHASH LOADMODULE UNLOADMODULE RELOAD">
289 <class name="ServerLink" commands="CONNECT SQUIT RCONNECT MKPASSWD MKSHA256">
290 <class name="BanControl" commands="KILL GLINE KLINE ZLINE QLINE ELINE">
291 <class name="OperChat" commands="WALLOPS GLOBOPS SETIDLE SPYLIST SPYNAMES">
292 <class name="HostCloak" commands="SETHOST SETIDENT SETNAME CHGHOST CHGIDENT">
295 #-#-#-#-#-#-#-#-#-#-#-#- OPERATOR COMPOSITION -#-#-#-#-#-#-#-#-#-#-#
297 # This is where you specify which types of operators you have on #
298 # your server, as well as the commands they are allowed to use. #
299 # This works alongside with the classes specified above. #
301 # type name - a name for the combined class types #
302 # a type name cannot contain spaces, however if you #
303 # put an _ symbol in the name, it will be translated #
304 # to a space when displayed in a WHOIS. #
306 # classes - specified above, used for flexibility for the #
307 # server admin to decide on which operators get #
308 # what commands. Class names are case sensitive, #
309 # seperate multiple class names with spaces. #
311 # host - optional hostmask operators will receive on oper-up. #
313 # Syntax is as follows: #
315 # <type name="name" classes="class names" host="oper hostmask"> #
317 # ____ _ _____ _ _ ____ _ _ _ #
318 # | _ \ ___ __ _ __| | |_ _| |__ (_)___ | __ )(_) |_| | #
319 # | |_) / _ \/ _` |/ _` | | | | '_ \| / __| | _ \| | __| | #
320 # | _ < __/ (_| | (_| | | | | | | | \__ \ | |_) | | |_|_| #
321 # |_| \_\___|\__,_|\__,_| |_| |_| |_|_|___/ |____/|_|\__(_) #
323 # You are not forced to give these types the names given below. #
324 # You can create your own named types, if you want, in fact that #
325 # is the whole idea of this system! #
328 <type name="NetAdmin" classes="OperChat BanControl HostCloak Shutdown ServerLink" host="netadmin.omega.org.za">
329 <type name="GlobalOp" classes="OperChat BanControl HostCloak ServerLink" host="ircop.omega.org.za">
330 <type name="Helper" classes="HostCloak" host="helper.omega.org.za">
333 #-#-#-#-#-#-#-#-#-#-#- OPERATOR CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
335 # Opers are defined here. This is a very important section. #
336 # Remember to only make operators out of truthworthy people. #
338 # name - oper name, This is case sensitive, so it is best to #
341 # password - password to oper-up, also case sensitive. #
342 # encryption is supported via modules. You may load #
343 # modules for MD5 or SHA256 encryption, and if you do, #
344 # this value will be a hash value, otherwise put a #
345 # plaintext password in this value. #
347 # host - hosts of client allowed to oper-up. #
348 # wildcards accepted, seperate multiple hosts with a #
349 # space. You may also specify CIDR ip addresses. #
351 # fingerprint - When using the m_ssl_oper_cert.so module, you may #
352 # specify a key fingerprint here. This can be obtained #
353 # using the /fingerprint command whilst the module is #
354 # loaded, or from the notice given to you when you #
355 # connect to the ircd using a client certificate, #
356 # and will lock this oper block to only the user who #
357 # has that specific key/certificate pair. #
358 # This enhances security a great deal, however it #
359 # requires that opers use clients which can send ssl #
360 # client certificates, if this is configured for that #
361 # oper. Note that if the m_ssl_oper.so module is not #
362 # loaded, and/or one of m_ssl_openssl or m_ssl_gnutls #
363 # is not loaded, this configuration option has no #
364 # effect and will be ignored. #
366 # type - Defines the kind of operator. This must match a type #
367 # tag you defined above, and is case sensitive. #
369 # Syntax is as follows: #
370 # <oper name="login" #
372 # host="hostmask@of.oper" #
373 # fingerprint="hexsequence" #
374 # type="oper type"> #
377 <oper name="katsklaw"
379 host="ident@dialup15.isp.com *@localhost *@server.com *@3ffe::0/16"
380 fingerprint="a41d730937a53b79f788c0ab13e9e1d5"
384 #-#-#-#-#-#-#-#-#-#-#- SERVER LINK CONFIGURATION -#-#-#-#-#-#-#-#-#-#
386 # Defines which servers can link to this one, and which servers this #
387 # server may create outbound links to. #
389 # name - The name is the canocial name of the server, does #
390 # not have to resolve - but it is expected to be set #
391 # in the remote servers connection info. #
393 # ipaddr - Valid host or ip address for remote server. These #
394 # hosts are resolved on rehash, and cached, if you #
395 # specify a hostname, so if you find that your server #
396 # is still trying to connect to an old IP after you #
397 # have updated your dns, try rehashing and then #
398 # attempting the connect again. #
400 # port - The TCP port for the remote server. #
402 # sendpass - Password to send to create an outbound connection #
405 # recvpass - Password to receive to accept an inbound connection #
406 # from this server. #
408 # autoconnect - Sets the server to autoconnect. Where x is the num. #
409 # (optional) of seconds between attempts. e.g. 300 = 5 minutes. #
411 # transport - If defined, this is a transport name implemented by #
412 # another module. Transports are layers on top of #
413 # plaintext connections, which alter them in certain #
414 # ways. Currently the three supported transports are #
415 # 'openssl' and 'gnutls' which are types of SSL #
416 # encryption, and 'zip' which is for compression. #
417 # If you define a transport, both ends of the #
418 # connection must use a compatible transport for the #
419 # link to succeed. OpenSSL and GnuTLS are link- #
420 # compatible with each other. #
422 # hidden - When using m_spanningtree.so for linking. you may #
423 # set this to 'yes', and if you do, the IP address/ #
424 # hostname of this connection will NEVER be shown to #
425 # any opers on the network. In /STATS c its address #
426 # will show as *@<hidden>, and during CONNECT and #
427 # inbound connections, its IP will show as <hidden> #
428 # UNLESS the connection fails (e.g. due to a bad #
429 # password or servername) #
431 # allowmask - When this is defined, it indicates a range of IP #
432 # addresses to allow for this link (You may use CIDR #
433 # or wildcard form for this address). #
434 # e.g. if your server is going to connect to you from #
435 # the range 1.2.3.1 through 1.2.3.255, put 1.2.3.0/24 #
436 # into this value. If it is not defined, then only #
437 # the ipaddr field of the server shall be allowed. #
439 # failover - If you define this option, it must be the name of a #
440 # different link tag in your configuration. This #
441 # option causes the ircd to attempt a connection to #
442 # the failover link in the event that the connection #
443 # to this server fails. For example, you could define #
444 # two hub uplinks to a leaf server, and set an #
445 # american server to autoconnect, with a european #
446 # hub as its failover. In this situation, your ircd #
447 # will only try the link to the european hub if the #
448 # american hub is unreachable. NOTE that for the #
449 # intents and purposes of this option, an unreachable #
450 # server is one which DOES NOT ANSWER THE CONNECTION. #
451 # If the server answers the connection with accept(), #
452 # EVEN IF THE CREDENTIALS ARE INVALID, the failover #
453 # link will not be tried! Failover settings will also #
454 # apply to autoconnected servers as well as manually #
457 # timeout - If this is defined, then outbound connections will #
458 # time out if they are not connected within this many #
459 # seconds. If this is not defined, the default of ten #
462 # to u:line a server (give it extra privilages required for running #
463 # services, Q, etc) you must include the <uline server> tag as shown #
464 # in the example below. You can have as many of these as you like. #
466 # WARNING: Unlike other ircds, u:lining a server allows ALL users on #
467 # that server to operoverride modes. This should only be used for #
468 # services and protected oper servers! #
470 # NOTE: If you have built InspIRCd with IPV6 support, and you want #
471 # to link to an IPV4 server, you must specify the IP address in the #
472 # form '::ffff:1.2.3.4' where 1.2.3.4 is the IP address of the target #
473 # server. If you have built InspIRCd for IPV4 (this is the default) #
474 # you should not prefix your IP addresses in this fashion. #
476 # ____ _ _____ _ _ ____ _ _ _ #
477 # | _ \ ___ __ _ __| | |_ _| |__ (_)___ | __ )(_) |_| | #
478 # | |_) / _ \/ _` |/ _` | | | | '_ \| / __| | _ \| | __| | #
479 # | _ < __/ (_| | (_| | | | | | | | \__ \ | |_) | | |_|_| #
480 # |_| \_\___|\__,_|\__,_| |_| |_| |_|_|___/ |____/|_|\__(_) #
482 # If you want to link servers to InspIRCd you must load the #
483 # m_spanningtree module! Please see the modules list below for #
484 # information on how to load this module! If you do not load this #
485 # module, server links will NOT work! #
487 # Also, if you define any transports, you must load the modules for #
488 # these transports BEFORE you load m_spanningtree, e.g. place them #
489 # above it in the configuration file. Currently this means the three #
490 # modules m_ssl_gnutls, m_ziplinks and m_ssl_openssl, depending on #
491 # which you choose to use. #
494 <link name="hub.penguin.org"
495 ipaddr="penguin.box.com"
497 allowmask="69.58.44.0/24"
499 failover="hub.other.net"
502 sendpass="outgoing!password"
503 recvpass="incoming!password">
505 <link name="services.antarctic.com"
508 allowmask="127.0.0.0/8"
510 recvpass="polarbears">
512 <uline server="services.antarctic.com">
515 #-#-#-#-#-#-#-#-#-#- MISCELLANEOUS CONFIGURATION -#-#-#-#-#-#-#-#-#-#
517 # These options let you define the path to your motd and rules #
518 # files. If these are relative paths, they are relative to the #
519 # configurtion directory. #
522 <files motd="inspircd.motd"
523 rules="inspircd.rules">
525 #-#-#-#-#-#-#-#-#-#-#-#-#-#-# DNS SERVER -#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
527 # Define your DNS server address here. InspIRCd has its own resolver. #
528 # If you do not define this value, the first dns server from your #
529 # /etc/resolv.conf file is read. If no entries are found in this file #
530 # or the file cannot be opened, the default value '127.0.0.1' is used #
531 # instead. The timeout value is in seconds. #
533 # ____ _ _____ _ _ ____ _ _ _ #
534 # | _ \ ___ __ _ __| | |_ _| |__ (_)___ | __ )(_) |_| | #
535 # | |_) / _ \/ _` |/ _` | | | | '_ \| / __| | _ \| | __| | #
536 # | _ < __/ (_| | (_| | | | | | | | \__ \ | |_) | | |_|_| #
537 # |_| \_\___|\__,_|\__,_| |_| |_| |_|_|___/ |____/|_|\__(_) #
539 # When choosing a server, be sure to choose one which will do a #
540 # RECURSIVE LOOKUP. InspIRCd's resolver does not currently do these #
541 # recursive lookups itself, to save time and resources. The dns #
542 # server recommended by the InspIRCd team is bind, available from the #
543 # ISC website. If your DNS server does not do a recursive lookup, you #
544 # will be able to notice this by the fact that none of your users are #
545 # resolving even though the DNS server appears to be up! Most ISP and #
546 # hosting provider DNS servers support recursive lookups. #
548 # NOTE: If you have built InspIRCd with IPV6 support, and you want #
549 # to use an IPV4 nameserver, you must specify the IP address in the #
550 # form '::ffff:1.2.3.4' where 1.2.3.4 is the IP address of the target #
551 # server. If you have built InspIRCd for IPV4 (this is the default) #
552 # you should not prefix your IP addresses in this fashion. #
554 # IF YOUR RESOLV.CONF CONTAINS ONLY IPV4 ADDRESSES, AND YOU ARE USING #
555 # IPV6, YOU MUST DEFINE THE <DNS SERVER> TAG, AND USE THE ::FFFF #
556 # PREFIX NOTATION. IF YOU DO NOT, HOSTS WILL *NOT* RESOLVE. #
559 <dns server="127.0.0.1" timeout="5">
561 # An example of using IPV4 nameservers over IPV6
562 #<dns server="::ffff:127.0.0.1" timeout="5">
564 #-#-#-#-#-#-#-#-#-#-#-#-#-#-# PID FILE -#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
566 # Define the path to the PID file here. The PID file can be used to #
567 # rehash the ircd from the shell or to terminate the ircd from the #
568 # shell using shell scripts, perl scripts etc, and to monitor the #
569 # ircd's state via cron jobs. If this is a relative path, it will be #
570 # relative to the configuration directory, and if it is not defined, #
571 # the default of 'inspircd.pid' is used. #
574 #<pid file="/path/to/inspircd.pid">
576 #-#-#-#-#-#-#-#-#-#-#-#-#- BANLIST LIMITS #-#-#-#-#-#-#-#-#-#-#-#-#-#-#
578 # Use these tags to customise the ban limits on a per channel basis. #
579 # the tags are read from top to bottom, and any tag found which #
580 # matches the channels name applies the banlimit to that channel. #
581 # It is advisable to put an entry with the channel as '*' at the #
582 # bottom of the list. If none are specified or no maxbans tag is #
583 # matched, the banlist size defaults to 64 entries. #
586 <banlist chan="#morons" limit="128">
587 <banlist chan="*" limit="69">
589 #-#-#-#-#-#-#-#-#-#-#- DISABLED COMMANDS -#-#-#-#-#-#-#-#-#-#-#-#-#-#
591 # This tag is optional, and specifies one or more commands which are #
592 # not available to non-operators. For example you may wish to disable #
593 # NICK and prevent non-opers from changing their nicknames. #
594 # Note that any disabled commands take effect only after the user has #
595 # 'registered' (e.g. after the initial USER/NICK/PASS on connection) #
596 # so for example disabling NICK will not cripple your network. #
599 #<disabled commands="TOPIC MODE">
602 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#- RTFM LINE -#-#-#-#-#-#-#-#-#-#-#-#-#-#
604 # Just remove this... Its here to make you read ALL of the config #
607 <die value="You should probably edit your config *PROPERLY* and try again.">
611 #-#-#-#-#-#-#-#-#-#-#-#-#- SERVER OPTIONS -#-#-#-#-#-#-#-#-#-#-#-#-#
613 # Settings to define which features are useable on your server. #
615 # prefixquit - a prefix for a client's quit message #
617 # loglevel - specifies what detail of messages to log in the #
618 # log file. You may select from debug, verbose, #
619 # default, sparse and none. #
621 # allowhalfop - allows the +h channel mode #
623 # noservices - If noservices is true, yes, or 1, then the first #
624 # user into a channel gets founder status. This is #
625 # only useful on networks running the m_chanprotect #
626 # module without services. #
628 # qaprefixes - If qaprefixes is true, yes, or 1, then users #
629 # with +q or +a will get the ~ or & prefixes #
630 # used in unreal. This is only useful on networks #
631 # running the m_chanprotect module #
633 # deprotectself - If this value is set to yes, true, or 1, then any #
634 # user with +q or +a may remove the +q or +a from #
635 # themselves. The default setting is to not enable #
636 # this feature, which stops even the founder taking #
637 # away their founder status without using services. #
639 # cyclehosts - If this is set to true, yes or 1, then when a #
640 # user's hostname changes, they will appear to quit #
641 # and then rejoin with their new host. This prevents #
642 # clients from being confused by host changes, #
643 # especially in the case of bots, and it is #
644 # recommended that this option is enabled. #
646 # netbuffersize - size of the buffer used to receive data from #
647 # clients. The ircd may only read() this amount #
648 # of text in one go at any time. (OPTIONAL) #
650 # maxwho - The maximum number of results returned by a /WHO #
651 # query. This is to prevent /WHO being used as a #
652 # spam vector or means of flooding an ircd. The #
653 # default is 128, it is not recommended to raise it #
654 # above 1024. Values up to 65535 are permitted. #
656 # somaxconn - The maximum number of sockets that may be waiting #
657 # in the accept queue. This usually allows the ircd #
658 # to soak up more connections in a shorter space of #
659 # time when increased but please be aware there is a #
660 # system defined maximum value to this, the same way #
661 # there is a system defined maximum number of file #
662 # descriptors. Some systems may only allow this to #
663 # be up to 5 (ugh) while others such as FreeBSD will #
664 # default to a much nicer 128. #
666 # moduledir - This optional value indicates a runtime change of #
667 # the location where modules are to be found. This #
668 # does not add a supplementary directory. There can #
669 # only be one module path. #
671 # softlimit - This optional feature allows a defined softlimit. #
672 # if defined sets a soft maxconnections value, has #
673 # to be less than the ./configure maxclients #
675 # userstats - The userstats field is optional and specifies #
676 # which stats characters in /STATS may be requested #
677 # by non-operators. Stats characters in this field #
678 # are case sensitive and are allowed to users #
679 # independent of if they are in a module or the core #
681 # operspywhois - If this is set then when an IRC operator uses #
682 # /WHOIS on a user they will see all channels, even #
683 # ones if channels are secret (+s), private (+p) or #
684 # if the target user is invisible +i. #
686 # customversion - If you specify this configuration item, and it is #
687 # not set to an empty value, then when a user does #
688 # a /VERSION command on the ircd, this string will #
689 # be displayed as the second portion of the output, #
690 # replacing the system 'uname', compile flags and #
691 # socket engine/dns engine names. You may use this #
692 # to enhance security, or simply for vanity. #
694 # maxtargets - The maxtargets field is optional, and if not #
695 # defined, defaults to 20. It indicates the maximum #
696 # number of targets which may be given to commands #
697 # such as PRIVMSG, KICK etc. #
699 # hidesplits - When set to 'yes', will hide split server names #
700 # from non-opers. Non-opers will see '*.net *.split' #
701 # instead of the server names in the quit message, #
702 # identical to the way IRCu displays them. #
704 # hidebans - When set to 'yes', will hide gline, kline, zline #
705 # and qline quit messages from non-opers. For #
706 # example, user A who is not an oper will just see #
707 # (G-Lined) while user B who is an oper will see the #
708 # text (G-Lined: Reason here) instead. #
710 # hidewhois - When defined with a non-empty value, the given #
711 # text will be used in place of the user's server #
712 # in WHOIS, when a user is WHOISed by a non-oper. #
713 # For example, most nets will want to set this to #
714 # something like '*.netname.net' to conceal the #
715 # actual server the user is on. #
717 # flatlinks - When you are using m_spanningtree.so, and this #
718 # value is set to true, yes or 1, /MAP and /LINKS #
719 # will be flattened when shown to a non-oper. #
721 # hideulines - When you are using m_spanningtree.so, and this #
722 # value is set to true, yes or 1, then U-lined #
723 # servers will be hidden in /LINKS and /MAP. For non #
724 # opers. Please be aware that this will also hide #
725 # any leaf servers of a U-lined server, e.g. jupes. #
727 # nouserdns - If set to 'yes', 'true' or '1', no user dns #
728 # lookups will be performed for connecting users. #
729 # this can save a lot of resources on very busy irc #
732 # syntaxhints - If set to 'yes', 'true' or '1', when a user does #
733 # not give enough parameters for a command, a syntax #
734 # hint will be given (using the RPL_TEXT numeric) #
735 # as well as the standard ERR_NEEDMOREPARAMS. #
737 # announcets - If this value is defined to 'yes', 'true' or '1', #
738 # then if a channel's timestamp is updated the users #
739 # on the channel will be informed of the change via #
740 # a server notice to the channel with the old and #
741 # new TS values in the timestamp. If you think this #
742 # is just pointless noise, define the value to 0. #
744 # ircumsgprefix - Use undernet style message prefix for channel #
745 # NOTICE and PRIVMSG adding the prefix to the line #
746 # of text sent out. Eg. NOTICE @#test :@ testing #
747 # vs off: NOTICE @#test :testing #
749 # notimesync - If this value is 'yes', 'true', or '1', time #
750 # synchronization is disabled on this server. This #
751 # means any servers you are linked to will not #
752 # automatically synchronize time with you, and in #
753 # most cases will just result in more bounced modes #
754 # on netsplits. This option should be the same on #
758 <options prefixquit="Quit: "
760 netbuffersize="10240"
784 #-#-#-#-#-#-#-#-#-#-#-#-#- WHOWAS OPTIONS -#-#-#-#-#-#-#-#-#-#-#-#-#
786 # This tag lets you define the behaviour of the /whowas command of #
789 # groupsize - Controls the maximum entries per nick shown when #
790 # performing a /whowas nick. Setting this to 0 dis- #
791 # ables whowas completely. #
793 # maxgroups - The maximum number of nickgroups that can be added #
794 # to the list. If max is reached, oldest group will #
795 # be deleted first like a FIFO. A groupsize of 3 and #
796 # a maxgroups of 5000 will allow for 5000 nicks to #
797 # be stored with a history of 3, thus giving a total #
798 # of 3 * 5000 = 15000 entries. A setting of 0 dis- #
799 # ables whowas completely. #
801 # maxkeep - The maximum time a nick is kept in the whowas list #
802 # before being pruned. Time may be specified in #
803 # seconds, or in the following format: 1y2w3d4h5m6s #
804 # meaning one year, two weeks, three days, 4 hours, #
805 # 5 minutes and 6 seconds. All fields in this format #
806 # are optional. Minimum is 1 hour, if less InspIRCd #
807 # will default back to 1 hour. #
809 #<whowas groupsize="10" #
810 # maxgroups="100000" #
814 #-#-#-#-#-#-#-#-#-#-#-#-#- MODULE OPTIONS -#-#-#-#-#-#-#-#-#-#-#-#-#
816 # These tags define which modules will be loaded on startup by your #
817 # server. Add modules without any paths. When you make your ircd #
818 # using the 'make' command, all compiled modules will be moved into #
819 # the folder you specified when you ran ./configure. The module tag #
820 # automatically looks for modules in this location. #
821 # If you attempt to load a module outside of this location, either #
822 # in the config, or via /LOADMODULE, you will receive an error. #
824 # By default, ALL modules are commented out. You must uncomment them #
825 # or add lines to your config to load modules. Please refer to #
826 # http://www.inspircd.org/wiki/Modules_List for a list of modules and#
827 # each modules link for any additional conf tags they require. #
829 # You may use wildcards in a <module> tag to load all modules which #
830 # match a glob pattern (e.g. m_sa????.so would load m_sajoin, #
831 # m_sapart, m_saquit and m_sanick) #
833 # ____ _ _____ _ _ ____ _ _ _ #
834 # | _ \ ___ __ _ __| | |_ _| |__ (_)___ | __ )(_) |_| | #
835 # | |_) / _ \/ _` |/ _` | | | | '_ \| / __| | _ \| | __| | #
836 # | _ < __/ (_| | (_| | | | | | | | \__ \ | |_) | | |_|_| #
837 # |_| \_\___|\__,_|\__,_| |_| |_| |_|_|___/ |____/|_|\__(_) #
839 # To link servers to InspIRCd, you MUST load the m_spanningtree #
840 # module, as shown below. If you DO NOT do this, server links will #
841 # NOT work at all. ie. The ports will NOT bind, and /connect will not #
842 # work properly. This is by design, to allow for the implementation #
843 # of other linking protocols in modules in the future. #
845 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
846 # Spanning Tree module - allows linking of servers using the spanning
847 # tree protocol (see the READ THIS BIT section above).
849 #<module name="m_spanningtree.so">
852 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
853 # MD5 Module - Allows other modules to generate MD5 hashes, usually for
854 # cryptographic uses and security.
857 # Other modules such as m_cloaking.so and m_opermd5.so may rely on
858 # this module being loaded to function.
860 #<module name="m_md5.so">
862 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
863 # SHA256 Module - Allows other modules to generate SHA256 hashes,
864 # usually for cryptographic uses and security.
867 # Other modules such as m_opermd5.so may rely on this module being
868 # loaded to function.
870 #<module name="m_sha256.so">
872 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
873 # Alias module: Allows you to define server-side command aliases
874 #<module name="m_alias.so">
876 #-#-#-#-#-#-#-#-#-#-#- ALIAS DEFINITIONS -#-#-#-#-#-#-#-#-#-#-#-#-#-#
878 # If you have the m_alias.so module loaded, you may also define #
879 # aliases as shown below. They are commonly used to provide shortcut #
880 # commands to services, however they are not limited to just this use.#
881 # An alias tag requires the following values to be defined in it: #
883 # text - The text to detect as the actual command line, #
884 # Cant contain spaces, but case insensitive. #
885 # You may have multiple aliases with the same #
886 # command name (text="" value), however the first #
887 # found will be executed if its format value is #
888 # matched, or it has no format value. Aliases are #
889 # read from the top of the file to the bottom. #
891 # format - If this is defined, the parameters of the alias #
892 # must match this glob pattern. For example if you #
893 # want the first parameter to start with a # for #
894 # the alias to be executed, set format="#*" in the #
895 # alias definition. Note that the :'s which are #
896 # part of IRC formatted lines will be preserved #
897 # for matching of this text. This value is #
900 # replace - The text to replace 'text' with. Usually this #
901 # will be "PRIVMSG ServiceName :$2-" or similar. #
902 # You may use the variables $1 through $9 in the #
903 # replace string, which refer to the first through #
904 # ninth word in the original string typed by the #
905 # user. You may also use $1- through $9- which #
906 # refer to the first word onwards, through to the #
907 # ninth word onwards, e.g. if the user types the #
908 # command "foo bar baz qux quz" then $3- will hold #
909 # "baz qux quz" and $2 will contain "bar". You may #
910 # also use the special variables: $nick, $ident, #
911 # $host and $vhost, and you may seperate multiple #
912 # commands with \n. If you wish to use the ACTUAL #
913 # characters \ and n together in a line, you must #
914 # use the sequence "\\n". #
916 # requires - If you provide a value for 'requires' this means #
917 # the given nickname MUST be online for the alias #
918 # to successfully trigger. If they are not, then #
919 # the user receives a 'no such nick' 401 numeric. #
921 # uline - Defining this value with 'yes', 'true' or '1' #
922 # will ensure that the user given in 'requires' #
923 # must also be on a u-lined server, as well as #
924 # actually being on the network. If the user is #
925 # online, but not on a u-lined server, then an #
926 # oper-alert is sent out as this is possibly signs #
927 # of a user trying to impersonate a service. #
929 # operonly - Defining this value, with a value of 'yes', '1' #
930 # or true will make the alias oper only. If a non- #
931 # oper attempts to use the alias, it will appear #
934 #<alias text="NICKSERV" replace="PRIVMSG NickServ :$2-" requires="NickServ" uline="yes">
935 #<alias text="CHANSERV" replace="PRIVMSG ChanServ :$2-" requires="ChanServ" uline="yes">
936 #<alias text="OPERSERV" replace="PRIVMSG OperServ :$2-" requires="OperServ" uline="yes" operonly="yes">
937 #<alias text="NS" replace="PRIVMSG NickServ :$2-" requires="NickServ" uline="yes">
938 #<alias text="CS" replace="PRIVMSG ChanServ :$2-" requires="ChanServ" uline="yes">
939 #<alias text="OS" replace="PRIVMSG OperServ :$2-" requires="OperServ" uline="yes" operonly="yes">
941 # An example of using the format value to create an alias with two
942 # different behaviours depending on the format of the parameters.
944 #<alias text="ID" format="#*" replace="PRIVMSG ChanServ :IDENTIFY $2 $3"
945 # requires="ChanServ" uline="yes">
947 #<alias text="ID" replace="PRIVMSG NickServ :IDENTIFY $2"
948 # requires="NickServ" uline="yes">
951 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
952 # Alltime module: Shows time on all connected servers at once
953 #<module name="m_alltime.so">
955 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
956 # Antibear security module: Prevents 'bear.txt' based trojans from
957 # connecting to your network by sending them a numeric they can't handle.
958 #<module name="m_antibear.so">
960 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
961 # Antibottler module: Labels bottler leech bots
962 #<module name="m_antibottler.so">
964 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
965 # Ban except module: Adds support for channel ban exceptions (+e)
966 #<module name="m_banexception.so">
968 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
969 # Block amsg module: Attempt to block all usage of /amsg and /ame
970 #<module name="m_blockamsg.so">
972 #-#-#-#-#-#-#-#-#-#-#- BLOCKAMSG CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
974 # If you have the m_blockamsg.so module loaded, you can configure it #
975 # with the <blockamsg> tag: #
977 # delay - How many seconds between two messages to force #
978 # them to be recognised as unrelated. #
979 # action - Any of 'notice', 'noticeopers', 'silent', 'kill' #
980 # or 'killopers'. Define how to take action when #
981 # a user uses /amsg or /ame. #
983 #<blockamsg delay="3" action="killopers">
985 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
986 # Block CAPS module: Blocking all-CAPS messages with cmode +P
987 #<module name="m_blockcaps.so">
989 #-#-#-#-#-#-#-#-#-#-#- BLOCKCAPS CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
991 # percent - How many percent of text must be caps before text #
994 # minlen - The minimum length a line must be for the block #
995 # percent to have any effect. #
997 #<blockcaps percent="95" minlen="5">
999 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1000 # Block colour module: Blocking colour-coded messages with cmode +c
1001 #<module name="m_blockcolor.so">
1003 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1004 # Botmode module: Adds the user mode +B
1005 #<module name="m_botmode.so">
1007 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1008 # CBAN module: Lets you disallow channels from being used at runtime.
1009 #<module name="m_cban.so">
1011 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1012 # Censor module: Adds the channel mode +G
1013 #<module name="m_censor.so">
1015 #-#-#-#-#-#-#-#-#-#-#- CENSOR CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#
1017 # Optional - If you specify to use the m_censor module, then you must #
1018 # specify some censor tags. See also: #
1019 # http://www.inspircd.org/wiki/Censor_Module #
1021 #<include file="censor.conf">
1023 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1024 # Channel filter module: Allows channel-op defined message
1025 # filtering using simple string matches (channel mode +g)
1026 #<module name="m_chanfilter.so">
1028 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1029 # Chanprotect module: gives +q and +a channel modes
1030 #<module name="m_chanprotect.so">
1032 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1033 # CHGHOST module: Adds the /CHGHOST command
1034 #<module name="m_chghost.so">
1036 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1037 # CHGIDENT module: Adds the /CHGIDENT command
1038 #<module name="m_chgident.so">
1040 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1041 # Cloaking module: Adds usermode +x and cloaking support.
1042 # Relies on the module m_md5.so being loaded before m_cloaking.so in
1043 # the configuration file.
1044 #<module name="m_cloaking.so">
1046 #-#-#-#-#-#-#-#-#-#-#- CLOAKING CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#
1048 # Optional - If you specify the m_cloaking.so module as above, you #
1049 # must define cloak keys, and optionally a cloak prefix as shown #
1050 # below. When using cloaking, the cloak keys are MANDITORY and must #
1051 # be included. However, if prefix is not included, it will default #
1052 # to your networks name from the <server> tag. #
1054 # <cloak key1="0x2AF39F40" #
1055 # key2="0x78E10B32" #
1056 # key3="0x4F2D2E82" #
1057 # key4="0x043A4C81" #
1060 # Please note that the key values will accept any number, and should #
1061 # be large numbers. Using small numbers such as "7" or "1924" will #
1062 # seriously weaken the security of your cloak. It is recommended you #
1063 # use hexdecimal numbers prefixed by "0x", as shown in this example, #
1064 # with each key eight hex digits long. #
1066 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1067 # Conn-Lusers: Shows the LUSERS output on connect
1068 #<module name="m_conn_lusers.so">
1070 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1071 # Conn-Usermodes: Set modes on users when they connect
1072 # When this module is loaded <connect:allow> tags may have an optional
1073 # modes="" value, which contains modes to add or remove from users
1074 # when they connect to the server.
1075 #<module name="m_conn_umodes.so">
1077 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1078 # Conn-Wait-for-Pong: Don't let a user connect until they PONG
1079 #<module name="m_conn_waitpong.so">
1081 #-#-#-#-#-#-#-#-#-#-#- WAITPONG CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
1083 # If you have the m_conn_waitpong.so module loaded, configure it with #
1084 # the <waitpong> tag: #
1086 # sendsnotice - Whether to send a snotice on connect, like other #
1089 # killonbadreply - Whether to kill the user if they send the wrong #
1092 #<waitpong sendsnotice="yes" killonbadreply="yes">
1094 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1095 # Connection throttle module. Configuration:
1096 #<module name="m_connflood.so">
1098 #-#-#-#-#-#-#-#-#-#-#- CONTHROTTLE CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
1099 # seconds, maxconns - Amount of connections per <seconds>.
1101 # timeout - Time to wait after the throttle was activated
1102 # before deactivating it. Be aware that the time
1103 # is seconds + timeout.
1105 # quitmsg - The message that users get if they attempt to
1106 # connect while the throttle is active.
1108 # bootwait - Amount of time to wait before enforcing the
1109 # throttling when the server just booted.
1111 #<connflood seconds="30" maxconns="3" timeout="30"
1112 # quitmsg="Throttled" bootwait="10">
1114 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1115 # DCCALLOW module: Adds the /DCCALLOW command
1116 #<module name="m_dccallow.so">
1118 #-#-#-#-#-#-#-#-#-#-#- DCCALLOW CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
1119 # blockchat - Whether to block DCC CHAT as well as DCC SEND
1120 # length - Default duration of entries in DCCALLOW list
1121 # action - Default action to take if no action is specified
1122 # can be 'block' or 'allow'
1124 # File configuration:
1125 # pattern - The glob pattern to match against
1126 # action - Action to take if a user attempts to send a file
1127 # that matches this pattern, can be 'block' or 'allow'
1129 #<dccallow blockchat="yes" length="5m" action="block">
1130 #<banfile pattern="*.exe" action="block">
1131 #<banfile pattern="*.txt" action="allow">
1133 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1135 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1136 # Deaf module: adds support for ircu style usermode +d - deaf to
1137 # channel messages and channel notices.
1138 #<module name="m_deaf.so">
1140 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1141 # Deny Channels: Deny Channels from being used by users
1142 #<module name="m_denychans.so">
1144 #-#-#-#-#-#-#-#-#-#-#- DENYCHAN DEFINITIONS -#-#-#-#-#-#-#-#-#-#-#-#
1146 # If you have the m_denychans.so module loaded, you need to specify #
1147 # the channels to deny: #
1149 # name - The channel name to deny. #
1151 # allowopers - If operators are allowed to override the deny. #
1153 # reason - Reason given for the deny. #
1155 #<badchan name="#gods" allowopers="yes" reason="Tortoises!">
1157 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1158 # Devoice Module: Let users devoice themselves.
1159 #<module name="m_devoice.so">
1161 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1162 # DNS Blacklist Module: Provides support for looking up IPs on one or #
1163 # more blacklists. #
1164 #<module name="m_dnsbl.so"> #
1166 # For configuration options please see the wiki page for m_dnsbl at #
1167 # http://inspircd.org/wiki/DNS_Blacklist_Module #
1169 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1170 # Filter module: Provides glob-based message filtering
1171 #<module name="m_filter.so">
1173 # PCRE filter module: Filters messages using regular expressions
1174 #<module name="m_filter_pcre.so">
1176 # You may only use one or the other with these modules, network-wide.
1178 #-#-#-#-#-#-#-#-#-#-#- FILTER CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#
1180 # Optional - If you specify to use the m_filter or m_filter_pcre #
1181 # modules, then specfiy below the path to the filter.conf file, #
1182 # or define some <filter> tags. #
1184 #<include file="filter.conf">
1186 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1187 # Foobar module: does nothing - historical relic
1188 #<module name="m_foobar.so">
1190 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1191 # Globops module: gives /GLOBOPS and usermode +g
1192 #<module name="m_globops.so">
1194 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1195 # Global load module: Allows loading and unloading of modules network-
1196 # wide (USE WITH EXTREME CAUTION!)
1197 #<module name="m_globalload.so">
1199 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1200 # HELPOP module: Provides the /HELPOP command
1201 #<module name="m_helpop.so">
1203 #-#-#-#-#-#-#-#-#-#-#-#- HELPOP CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
1205 # Optional - If you specify to use the m_helpop.so module, then #
1206 # specify below the path to the helpop.conf file, or if you like to #
1207 # make a mess, define your helpop tags in this conf. #
1209 #<include file="helpop.conf">
1211 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1212 # HIDECHANS module: Allows opers to hide their channels list from non-
1213 # opers by setting user mode +I on themselves.
1214 # <module name="m_hidechans.so">
1216 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1217 # HIDEOPER module: Allows opers to hide their oper status from non-
1218 # opers by setting user mode +H on themselves.
1219 # <module name="m_hideoper.so">
1221 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1222 # Hostchange module: Allows a different style of cloaking
1223 #<module name="m_hostchange.so">
1225 #-#-#-#-#-#-#-#-#-#-#- HOSTCHANGE CONFIGURATION -#-#-#-#-#-#-#-#-#-#
1227 # Optional - If you choose to use the m_hostchange.so module. #
1228 # Config Help - See http://www.inspircd.org/wiki/Host_Changer_Module #
1230 #<host suffix="polarbears.org">
1231 #<hostchange mask="*@fbi.gov" action="addnick">
1232 #<hostchange mask="*r00t@*" action="suffix">
1233 #<hostchange mask="a@b.com" action="set" value="blah.blah.blah">
1235 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1236 # httpd module: Provides http server support for InspIRCd
1237 #<module name="m_httpd.so">
1239 #-#-#-#-#-#-#-#-#-#-#-#- HTTPD CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
1241 # Optional - If you choose to use the m_httpd.so module, then you must
1242 # specify the port number and other details of your http server:
1244 #<http ip="192.168.1.10" host="brainwave" port="32006"
1245 # index="/home/brain/inspircd/http/index.html">
1247 # You may have as many of these tags as you wish, each with a different
1248 # IP, port, host or index file. Each one will act as an independent
1252 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1253 # http stats module: Provides basic stats pages over HTTP
1254 # Requires m_httpd.so to be loaded for it to function.
1255 #<module name="m_httpd_stats.so">
1257 #-#-#-#-#-#-#-#-#-#-#-#- HTTPD STATS CONFIGURATION -#-#-#-#-#-#-#-#-#-#
1259 #<httpstats stylesheet="http://remote.style/sheet.css">
1262 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1263 # Ident: Provides RFC 1413 ident lookup support
1264 #<module name="m_ident.so">
1266 #-#-#-#-#-#-#-#-#-#-#-#- IDENT CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
1268 # Optional - If you are using the m_ident.so module, then you can #
1269 # specify the timeout for ident lookups here. If not defined, it will #
1270 # default to one second. This is a non-blocking timeout which holds #
1271 # the user in a 'connecting' state until the lookup is complete. #
1273 #<ident timeout="5">
1275 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1276 # Invite except module: Adds support for channel invite exceptions (+I)
1277 #<module name="m_inviteexception.so">
1279 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1280 # Join flood module: Adds support for join flood protection (+j)
1281 #<module name="m_joinflood.so">
1283 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1284 # Anti-Auto-Rejoin: Adds support for prevention of auto-rejoin (+J)
1285 #<module name="m_kicknorejoin.so">
1287 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1288 # Knock module: adds the /KNOCK command and +K channel mode
1289 #<module name="m_knock.so">
1291 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1292 # Lock server module: Adds /LOCKSERV and /UNLOCKSERV commands that is #
1293 # used to temporarily close/open for new connections to the server. #
1294 # These commands require OPER status and that the LOCKSERV UNLOCKSERV #
1295 # are specified in a <class> tag that the oper is part of. This is so #
1296 # you can control who has access to this possible dangerous command. #
1297 # If your server is locked and you got disconnected, do a REHASH from #
1298 # shell to open up again.
1299 #<module name="m_lockserv.so">
1301 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1302 # Msg flood module: Adds message/notice flood protection (+f)
1303 #<module name="m_messageflood.so">
1305 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1306 # MySQL module: Allows other SQL modules to access MySQL databases
1307 # through a unified API. You must copy the source for this module
1308 # from the directory src/modules/extra, plus the file m_sqlv2.h
1309 #<module name="m_mysql.so">
1311 #-#-#-#-#-#-#-#-#-#-#-#- SQL CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#-#
1313 # m_mysql.so is more complex than described here, see the wiki for #
1314 # more: http://www.inspircd.org/wiki/SQL_Service_Provider_Module #
1316 #<database name="mydb" username="myuser" password="mypass" hostname="localhost" id="my_database2">
1318 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1319 # NAMESX module: Provides support for the NAMESX extension which allows
1320 # clients to see all the prefixes set on a user without getting confused.
1321 # This is supported by mIRC, x-chat, klient, and maybe more.
1322 #<module name="m_namesx.so">
1324 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1325 # Nicklock module: Let opers change a user's nick and then stop that
1326 # user from changing their nick again.
1327 #<module name="m_nicklock.so">
1329 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1330 # No ctcp module: Adds the channel mode +C to block CTCPs
1331 #<module name="m_noctcp.so">
1333 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1334 # Noinvite module: Gives channel mode +V
1335 #<module name="m_noinvite.so">
1337 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1338 # No kicks module: Adds the +Q channel mode
1339 #<module name="m_nokicks.so">
1341 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1342 # No nicks module: Adds the +N channel mode
1343 #<module name="m_nonicks.so">
1345 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1346 # No Notice module: adds the channel mode +T
1347 #<module name="m_nonotice.so">
1349 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1350 # Oper channels mode: Adds the +O channel mode
1351 #<module name="m_operchans.so">
1353 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1354 # Oper hash module: Allows hashed oper passwords
1355 # Relies on the module m_md5.so and/or m_sha256.so being loaded before
1356 # m_oper_hash.so in the configuration file.
1357 #<module name="m_oper_hash.so">
1359 #-#-#-#-#-#-#-#-#-#-# OPER HASH CONFIGURATION #-#-#-#-#-#-#-#-#-#-#-#-#
1361 # To use this module, you must define a hash type for each oper's
1362 # password you want to hash. For example:
1364 # <oper name="katsklaw"
1365 # host="ident@dialup15.isp.com"
1367 # password="a41d730937a53b79f788c0ab13e9e1d5"
1370 # The types of hashing available vary depending on which hashing modules
1371 # you load, but usually if you load m_sha256.so and m_md5.so, both md5
1372 # and sha256 type hashing will be available (the most secure of which
1375 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1376 # Oper Join module: Forces opers to join a channel on oper-up
1377 #<module name="m_operjoin.so">
1379 #-#-#-#-#-#-#-#-#-#-# OPERJOIN CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
1381 # If you are using the m_operjoin.so module, specify the channel here #
1383 #<operjoin channel="#channel">
1385 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1386 # Oper MOTD module: Provides support for seperate message of the day
1388 #<module name="m_opermotd.so">
1390 #-#-#-#-#-#-#-#-#-#-# OPERMOTD CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
1392 # If you are using the m_opermotd.so module, specify the motd here #
1394 #<opermotd file="oper.motd">
1396 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1397 # Override module: Adds support for oper override
1398 #<module name="m_override.so">
1400 #-#-#-#-#-#-#-#-#-#-# OVERRIDE CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
1402 # m_override.so is too complex it describe here, see the wiki: #
1403 # http://www.inspircd.org/wiki/Oper_Override_Module #
1405 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1406 # Oper levels module: Gives each oper a level and prevents
1407 # actions being taken against higher level opers
1408 # Specify the level as the 'level' parameter of the <type> tag
1409 #<module name="m_operlevels.so">
1411 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1412 # Oper modes module: Allows you to specify modes to add/remove on oper
1413 # Specify the modes as the 'modes' parameter of the <type> tag
1414 #<module name="m_opermodes.so">
1416 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1417 # PostgreSQL module: Allows other SQL modules to access PgSQL databases
1418 # through a unified API. You must copy the source for this module
1419 # from the directory src/modules/extra, plus the file m_sqlv2.h
1420 #<module name="m_pgsql.so">
1422 #-#-#-#-#-#-#-#-#-#-#-#- SQL CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#-#
1424 # m_pgsql.so is more complex than described here, see the wiki for #
1425 # more: http://www.inspircd.org/wiki/SQL_Service_Provider_Module #
1427 #<database name="mydb" username="myuser" password="mypass" hostname="localhost" id="my_database" ssl="no">
1429 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1430 # Random Quote module: provides a random quote on connect.
1431 # NOTE: Some of these may mimic fatal errors and confuse users and
1432 # opers alike! - BEWARE!
1433 #<module name="m_randquote.so">
1435 #-#-#-#-#-#-#-#-#-#- RANDOMQUOTES CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
1437 # Optional - If you specify to use the m_randquote.so module, then #
1438 # specify below the path to the randquotes.conf file. #
1440 #<randquote file="randquotes.conf">
1442 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1443 # Redirect module: Adds channel redirection (mode +L)
1444 #<module name="m_redirect.so">
1446 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1447 # Remove module: Adds the /REMOVE command which is a peaceful
1448 # alternative to /KICK
1449 #<module name="m_remove.so">
1451 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1452 # Restrict banned users module:
1453 # Disallows banned users on a channel from messaging the channel,
1454 # changing nick, or changing the topic, if loaded.
1455 #<module name="m_restrictbanned.so">
1457 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1458 # Restricted channels module: Allows only opers to create channels
1459 #<module name="m_restrictchans.so">
1461 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1462 # Restrict message module: Allows users to only message opers
1463 #<module name="m_restrictmsg.so">
1465 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1466 # Provide /LIST throttling (to prevent flooding) and /LIST safety to
1467 # prevent excess flood when the list is large.
1468 #<module name="m_safelist.so">
1470 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1471 # SAJOIN module: Adds the /SAJOIN command
1472 #<module name="m_sajoin.so">
1474 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1475 # SAMODE module: Adds the oper /SAMODE command
1476 #<module name="m_samode.so">
1478 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1479 # SANICK module: Allows opers to change user's nicks
1480 #<module name="m_sanick.so">
1482 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1483 # SAPART module: Adds the oper /SAPART command
1484 #<module name="m_sapart.so">
1486 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1487 # SAQUIT module: Adds the oper /SAQUIT command (abusable!!!)
1488 #<module name="m_saquit.so">
1490 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-
1491 # Secure list module: Prevent /LIST in the first minute of connection,
1492 # crippling most spambots and trojan spreader bots.
1493 #<module name="m_securelist.so">
1495 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1496 # Set Idle module: Adds a command for opers to change their
1497 # idle time (mainly a toy)
1498 #<module name="m_setidle.so">
1500 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1501 # Services support module: Adds several usermodes such as +R and +M
1502 # this module implements the 'identified' state via user mode +r, which
1503 # is similar to the DALnet and dreamforge systems.
1504 #<module name="m_services.so">
1506 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1507 # Services support module: Adds several usermodes such as +R and +M
1508 # this module implements the 'identified' state via account names (AC)
1509 # and is similar in operation to the way asuka and ircu handle services.
1510 # it cannot be used at the same time as m_services, above.
1511 #<module name="m_services_account.so">
1513 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1514 # Sethost module: Adds the /SETHOST command
1515 #<module name="m_sethost.so">
1517 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1518 # Setident module: Adds the /SETIDENT command
1519 #<module name="m_setident.so">
1521 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1522 # SETNAME module: Adds the /SETNAME command
1523 #<module name="m_setname.so">
1525 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1526 # Show Whois module: Adds the +W usermode which allows opers
1527 # to see when they are whois'ed (can be annoying).
1528 #<module name="m_showwhois.so">
1530 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1531 # Spy module: Adds the commands SPYLIST and SPYNAMES that let opers
1532 # see who is in a +s channel, and list +s channels, show keys of keyed
1533 # channels the oper is not a member of etc. (standard 'abusive' features
1534 # of many other ircds, modulized here in InspIRCd).
1535 #<module name="m_spy.so">
1537 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1538 # SSL channel mode module: Adds support for SSL-only channels (+z).
1539 # does not do anything useful without a working SSL module (see below)
1540 #<module name="m_sslmodes.so">
1542 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1543 # Dummy ssl module: If you have other servers on your network which
1544 # have SSL, but your server does not have ssl enabled, you should load
1545 # this module, which will handle SSL metadata (e.g. the "Is using ssl"
1546 # field in the WHOIS information).
1547 #<module name="m_ssl_dummy.so">
1549 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1550 # GnuTLS ssl module: Adds support for client-server SSL using GnuTLS,
1551 # if enabled. You must copy the source for this module from the directory
1552 # src/modules/extra, or answer 'yes' in ./configure when asked if you
1553 # want to enable this, or it will not load.
1554 #<module name="m_ssl_gnutls.so">
1556 #-#-#-#-#-#-#-#-#-#-#- GNUTLS CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#
1558 # m_ssl_gnutls.so is too complex it describe here, see the wiki: #
1559 # http://www.inspircd.org/wiki/GnuTLS_SSL_Module #
1561 # NOTE: If you want to use this module to encrypt and sign your #
1562 # server to server traffic, you MUST load it before m_spanningtree in #
1563 # your configuration file! #
1565 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1566 # SSL Info module: Allows users to retrieve information about other
1567 # user's peer SSL certificates and keys. This can be used by client
1568 # scripts to validate users. For this to work, one of m_ssl_gnutls.so
1569 # or m_ssl_openssl.so must be loaded. You must symlink the source for
1570 # this module from the directory src/modules/extra.
1571 #<module name="m_sslinfo.so">
1573 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1574 # OpenSSL ssl module: Adds support for client-server SSL using OpenSSL,
1575 # if enabled. You must copy the source for this module from the directory
1576 # src/modules/extra, or answer 'yes' in ./configure when asked if you
1577 # want to enable this, or it will not load.
1578 #<module name="m_ssl_openssl.so">
1580 #-#-#-#-#-#-#-#-#-#-#- OPENSSL CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#
1582 # m_ssl_openssl.so is too complex it describe here, see the wiki: #
1583 # http://www.inspircd.org/wiki/OpenSSL_SSL_Module #
1585 # NOTE: If you want to use this module to encrypt and sign your #
1586 # server to server traffic, you MUST load it before m_spanningtree in #
1587 # your configuration file! #
1589 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1590 # SSL Cert Oper module: Allows opers to oper up using the key fingerprint
1591 # stored within their SSL certificate and key pair.
1592 # When using this module, one of m_ssl_gnutls.so or m_ssl_openssl.so must
1593 # be loaded. An extra value should be added to enabled opers, which
1594 # is in the following format: fingerprint="<hash>". For more information,
1595 # see the example in the oper blocks.
1596 #<module name="m_ssl_oper_cert.so">
1598 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1599 # Strip colour module: Adds the channel mode +S
1600 #<module name="m_stripcolor.so">
1602 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1603 # SILENCE module: Adds support for /SILENCE
1604 #<module name="m_silence.so">
1606 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1607 # Extended SILENCE module: Adds support for /SILENCE with additional
1608 # features to silence based on invites, channel messages, etc.
1609 #<module name="m_silence_ext.so">
1611 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1612 # SQLite3 module: Allows other SQL modules to access SQLite3 #
1613 # databases through a unified API. You must link the source for this #
1614 # module from the directory src/modules/extra to src/modules, plus #
1615 # the file m_sqlv2.h #
1616 #<module name="m_sqlite3.so">
1618 #-#-#-#-#-#-#-#-#-#-#-#- SQL CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#-#
1620 # m_sqlite.so is more complex than described here, see the wiki for #
1621 # more: http://www.inspircd.org/wiki/SQLite3_Service_Provider_Module #
1623 #<database hostname="/full/path/to/database.db" id="anytext">
1625 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1626 # SQLutils module: Provides some utilities to SQL client modules, such
1627 # as mapping queries to users and channels. You must copy the source
1628 # for this module from the directory src/modules/extra/m_sqlutils.cpp
1629 # and src/modules/extra/m_sqlutils.h into /src/modules
1630 # Needed for, and loaded before: SQLauth and SQLoper
1631 #<module name="m_sqlutils.so">
1633 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1634 # SQL authentication module: Allows IRCd connections to be tied into
1635 # a database table (for example a forum). You must copy the source for
1636 # this module from the directory src/modules/extra
1637 # Depends on the SQLutils module being loaded first.
1638 #<module name="m_sqlauth.so">
1640 #-#-#-#-#-#-#-#-#-#-#- SQLAUTH CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#
1642 # m_sqlauth.so is too complex it describe here, see the wiki: #
1643 # http://www.inspircd.org/wiki/SQL_Authentication_Module #
1645 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1646 # SQL logging module: Allows you to log network-wide data for your
1647 # network in a fully normalized set of SQL tables. You must copy the
1648 # source for this module from the directory src/modules/extra
1649 #<module name="m_sqllog.so">
1651 #-#-#-#-#-#-#-#-#-#-#- SQLLOG CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#
1653 # dbid - Database ID to use (see m_sql) #
1655 # See also: http://www.inspircd.org/wiki/SQL_Logging_Module #
1659 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1660 # SQL oper module: Allows you to store oper credentials in an SQL table
1661 # You must copy the source for this module from the directory src/modules/extra
1662 # Depends on the SQLutils module being loaded first.
1663 #<module name="m_sqloper.so">
1665 #-#-#-#-#-#-#-#-#-#-#- SQLOPER CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#
1667 # dbid - Database ID to use (see m_sql) #
1669 # See also: http://www.inspircd.org/wiki/SQL_Oper_Storage_Module #
1673 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1674 # SWHOIS module: Allows you to add arbitary lines to user WHOIS.
1675 #<module name="m_swhois.so">
1677 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1678 # Test command module: Does nothing significant. Read: pointless.
1679 #<module name="m_testcommand.so">
1681 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1682 # Timed bans module: Adds timed bans and the /TBAN command
1683 #<module name="m_timedbans.so">
1685 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1686 # Test line module: Adds the /TLINE command, used to test how many
1687 # users a /GLINE or /ZLINE etc would match.
1688 #<module name="m_tline.so">
1690 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1691 # Uninvite module: Adds the /UNINVITE command which lets users remove
1692 # pending invites from channels without waiting for the user to join.
1693 #<module name="m_uninvite.so">
1695 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1696 # Userip module: Adds the /USERIP command
1697 #<module name="m_userip.so">
1699 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1700 # Vhost module: Adds the VHOST command which allows for adding virtual
1701 # hosts which are accessible using a username and password in the config.
1702 #<module name="m_vhost.so">
1704 #-#-#-#-#-#-#-#-#-#-#- VHOST CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#-#
1706 # user - Username for the vhost. #
1708 # pass - Password for the vhost. #
1710 # host - Vhost to set. #
1712 #<vhost user="some_username" pass="some_password" host="some.host">
1714 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1715 # Watch module: Adds the WATCH command, which is used by clients to
1716 # maintain notify lists.
1717 #<module name="m_watch.so">
1719 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1720 # ZipLinks module: Adds support for zlib deflate on server to server
1721 # connections. Both ends of the connection must load this module.
1723 #<module name="m_ziplink.so">
1725 # To use this module, you must enable it as a transport type in your
1726 # <link> tags or <bind> tags using the transport name 'zip'.
1727 # See the documentation of <link> and <bind>, respectively.
1730 #-#-#-#-#-#-#-#-#-#-#-#-#-#- BAN OPTIONS -#-#-#-#-#-#-#-#-#-#-#-#-#-#
1732 # The ban tags define nick masks, host masks and ip ranges which are #
1733 # banned from your server. All details in these tags are local to #
1737 # badip lines ban an ip range (same as a zline) #
1739 # ipmask - The ip range to ban (wildcards possible) #
1740 # CIDR is supported in the IP mask. #
1741 # reason - Reason to display when disconnected #
1743 # badnick lines ban a nick mask (same as a qline) #
1745 # nick - Nick mask to ban (wildcards possible) #
1746 # reason - Reason to display on /NICK #
1748 # badhost lines ban a user@host mask (same as a kline) #
1750 # host - ident@hostname (wildcards possible) #
1751 # If you specify an IP, CIDR is supported. #
1752 # reason - Reason to display on disconnection #
1754 # exception lines define a hostmask that is excempt from [kzg]lines #
1756 # host - ident@hostname (wildcards possible) #
1757 # If you specify an IP, CIDR is supported. #
1758 # reason - Reason, shown only in /stats e #
1761 <badip ipmask="69.69.69.69" reason="No porn here thanks.">
1763 <badnick nick="ChanServ" reason="Reserved For Services">
1764 <badnick nick="NickServ" reason="Reserved For Services">
1765 <badnick nick="OperServ" reason="Reserved For Services">
1766 <badnick nick="MemoServ" reason="Reserved For Services">
1768 <badhost host="*@hundredz.n.hundredz.o.1337.kiddies.com" reason="Too many 1337 kiddiots">
1769 <badhost host="*@localhost" reason="No irc from localhost!">
1770 <badhost host="*@172.32.0.0/16" reason="This subnet is bad.">
1772 <exception host="*@ircop.host.com" reason="Opers hostname">
1774 #-#-#-#-#-#-#-#-#-#-#- INSANE BAN OPTIONS -#-#-#-#-#-#-#-#-#-#-#-#-#-#
1776 # This optional tag allows you to specify how wide a gline, eline, #
1777 # kline, zline or qline can be before it is forbidden from being #
1778 # set. By setting hostmasks="yes", you can allow all G, K, E lines, #
1779 # no matter how many users the ban would cover. This is not #
1780 # recommended! By setting ipmasks="yes", you can allow all Z lines, #
1781 # no matter how many users these cover too. Needless to say we #
1782 # don't recommend you do this, or, set nickmasks="yes", which will #
1783 # allow any qline. #
1785 # The trigger value indicates how wide any mask will be before it is #
1786 # prevented from being set. The default value is 95.5% if this tag is #
1787 # not defined in your configuration file, meaning that if your #
1788 # network has 1000 users, a gline matching over 955 of them will be #
1789 # prevented from being added. #
1791 # Please note that remote servers (and services) are exempt from #
1792 # these restrictions and expected to enforce their own policies #
1796 <insane hostmasks="no" ipmasks="no" nickmasks="no" trigger="95.5">
1798 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#- YAWN -#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1800 # You should already know what to do here :) #
1802 <die value="No, i wasnt joking. You should probably edit your config *PROPERLY* and try again.">
1805 #########################################################################
1807 # - InspIRCd Development Team - #
1808 # http://www.inspircd.org #
1810 #########################################################################