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 : 03 Feb 2007 #
25 # ____ _ _____ _ _ ____ _ _ _ #
26 # | _ \ ___ __ _ __| | |_ _| |__ (_)___ | __ )(_) |_| | #
27 # | |_) / _ \/ _` |/ _` | | | | '_ \| / __| | _ \| | __| | #
28 # | _ < __/ (_| | (_| | | | | | | | \__ \ | |_) | | |_|_| #
29 # |_| \_\___|\__,_|\__,_| |_| |_| |_|_|___/ |____/|_|\__(_) #
31 # Lines prefixed with READ THIS BIT, as shown above, are IMPORTANT #
32 # lines, and you REALLY SHOULD READ THEM. Yes, THIS MEANS YOU. Even #
33 # if you've configured InspIRCd before, these probably indicate #
34 # something new or different to this version and you SHOULD READ IT. #
36 ########################################################################
38 # Unalphabeticalise the modules list at your own risk #
40 ########################################################################
43 #-#-#-#-#-#-#-#-#-#-#-#- SERVER DESCRIPTION -#-#-#-#-#-#-#-#-#-#-#-#-
45 # Here is where you enter the information about your server. #
47 # Syntax is as follows: #
49 # <server name="server.name" #
50 # description="Server Description" #
51 # network="MyNetwork"> #
54 <server name="penguin.omega.org.za"
55 description="Waddle World"
59 #-#-#-#-#-#-#-#-#-#-#-#- ADMIN INFORMATION -#-#-#-#-#-#-#-#-#-#-#-#
61 # Describes the Server Administrator's real name (optionally), #
62 # nick, and email address. #
64 # Syntax is as follows: #
65 # <admin name="real name" #
67 # email="email@address.com"> #
70 <admin name="Johnny English"
72 email="MI5@the.best.secret.agent">
75 #-#-#-#-#-#-#-#-#-#-#-#- PORT CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-
77 # Enter the port and address bindings here. #
79 # bind address - specifies which address ports bind to. Leaving this #
80 # field blank binds the port to all IPs available. #
82 # port - The port number to bind to. You may specify a port #
83 # range here, e.g. "6667-6669,7000,7001". If you do #
84 # this, the server will count each port within your #
85 # range as a seperate binding, making the above #
86 # example equivalent to five seperate bind tags. #
87 # A failure on one port in the range does not prevent #
88 # the entire range from being bound, just that one #
91 # type - can be 'clients' or 'servers'. The clients type is #
92 # a standard tcp based socket, the servers type is a #
93 # also a TCP based connection but of a different #
94 # format. SSL support is provided by modules, to #
95 # enable SSL support, please read the module section #
96 # of this configuration file. #
98 # ssl - When using m_ssl_gnutls.so or m_ssl_openssl.so #
99 # modules, you must define this value to use ssl on #
100 # that port. valid values are 'gnutls' or 'openssl' #
101 # respectively. If the module is not loaded, this #
102 # setting is ignored. #
104 # transport - If you have m_spanningtree.so loaded, along with #
105 # either of the SSL modules (m_ssl_gnutls or #
106 # m_ssl_openssl) or m_ziplinks.so, then you may make #
107 # use of this value. #
108 # setting it to 'openssl' or 'gnutls' or 'zip' #
109 # indicates that the port should accept connections #
110 # using the given transport name. Transports are #
111 # layers which sit on top of a socket and change the #
112 # way data is sent and received, e.g. encryption, #
113 # compression, and other such things. Because this #
114 # may not be limited in use to just encryption, #
115 # the 'ssl' value used for client ports does not #
116 # exist for servers, and this value is used instead. #
117 # ____ _ _____ _ _ ____ _ _ _ #
118 # | _ \ ___ __ _ __| | |_ _| |__ (_)___ | __ )(_) |_| | #
119 # | |_) / _ \/ _` |/ _` | | | | '_ \| / __| | _ \| | __| | #
120 # | _ < __/ (_| | (_| | | | | | | | \__ \ | |_) | | |_|_| #
121 # |_| \_\___|\__,_|\__,_| |_| |_| |_|_|___/ |____/|_|\__(_) #
123 # If you want to link servers to InspIRCd you must load the #
124 # m_spanningtree module! Please see the modules list below for #
125 # information on how to load this module! If you do not load this #
126 # module, server ports will NOT be bound! #
128 # Leaving address empty binds to all available interfaces #
130 # Syntax is as follows: #
132 # <bind address="ip address" port="port" type="clients"> #
133 # <bind address="ip address" port="port" type="servers"> #
135 # If InspIRCd is built for IPV6, and you wish to accept IPV4 clients, #
136 # then you can specify IPV4 ip addresses here to bind. You may also #
137 # use the 4in6 notation, ::ffff:1.2.3.4, where 1.2.3.4 is the IPV4 #
138 # address to bind the port, but as of InspIRCd 1.1.1, this is not #
141 # ------------------------------------------------------------------- #
143 # PLEASE NOTE: If you have build InspIRCd as an ipv6 server, and you #
144 # specify an empty bind address, the binding will be bound to ALL THE #
145 # IPV6 IP ADDRESSES, and not the ipv4 addresses. If you are using an #
146 # ipv6 enabled InspIRCd and want to bind to multiple IPV4 addresses #
147 # in this way, you must specify them by hand. If you have built the #
148 # server for ipv4 connections only, then specifying an empty bind #
149 # address binds the port to all ipv4 IP addresses, as expected. #
152 <bind address="" port="6000" type="clients">
153 <bind address="" port="6660-6669" type="clients" ssl="gnutls">
155 # When linking servers, the openssl and gnutls transports are largely
156 # link-compatible and can be used alongside each other or either/or
157 # on each end of the link without any significant issues.
159 <bind address="" port="7000,7001" type="servers">
160 <bind address="1.2.3.4" port="7005" type="servers" transport="openssl">
163 #-#-#-#-#-#-#-#-#-#- DIE/RESTART CONFIGURATION -#-#-#-#-#-#-#-#-#-#-
165 # You can configure the passwords here which you wish to use for #
166 # the die and restart commands. Only trusted ircops who will #
167 # need this ability should know the die and restart password. #
169 # Syntax is as follows: #
170 # <power diepass="die password" restartpass="restart password" #
171 # pause="secs before dying"> #
174 <power diepass="diepass" restartpass="restartpass" pause="2">
177 #-#-#-#-#-#-#-#-#-# INCLUDE CONFIGURATION #-#-#-#-#-#-#-#-#-#-#-#-#-#
179 # This optional tag allows you to include another config file #
180 # allowing you to keep your configuration tidy. The configuration #
181 # file you include will be treated as part of the configuration file #
182 # which includes it, in simple terms the inclusion is transparent. #
184 # All paths to config files are relative to the directory of the main #
185 # config file inspircd.conf, unless the filename starts with a forward#
186 # slash (/) in which case it is treated as an absolute path. #
188 # Syntax is as follows: #
189 #<include file="file.conf"> #
192 #-#-#-#-#-#-#-#-#-#- CONNECTIONS CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
194 # This is where you can configure which connections are allowed #
195 # and denied access onto your server. #
196 # The password is optional. #
197 # You may have as many of these as you require. #
198 # To allow/deny all connections use a * #
200 # Syntax is as follows: #
202 # <connect allow="ip mask"> #
203 # <connect allow="ip mask" password="blahblah"> #
204 # <connect allow="ip mask" password="blah" timeout="10"> #
205 # <connect allow="ip mask" timeout="blah" flood="5"> #
206 # <connect allow="ip mask" threshold="8" pingfreq="120"> #
207 # <connect allow="ip mask" sendq="99999" revcq="696969"> #
208 # <connect allow="ip mask" localmax="3" globalmax="3"> #
209 # <connect deny="ip mask"> #
211 # IP masks may be specified in CIDR format or wildcard format, #
212 # for IPV4 and IPV6. #
214 # You may optionally include timeout="x" on any allow line, which #
215 # specifies the amount of time given before an unknown connection #
216 # is closed if USER/NICK/PASS are not given. This value is in secs #
218 # You should also include a flood="x" line which indicates #
219 # the number of lines a user may place into their buffer at once #
220 # before they are disconnected for excess flood. This feature can #
221 # not be disabled, however it can be set to extremely high values, #
222 # rendering it effectively disabled. A recommended value is 10. #
223 # A counter is maintained for each user which is reset every #
224 # 'threshold' seconds and specifying this threshold value with #
225 # threshold="X" indicates how often the counter is reset. For #
226 # example, with flood="5" and threshold="8", the user may not send #
227 # more than 5 lines in 8 secs. #
229 # You may optionally specify the sendq size and ping frequency of #
230 # each connect:allow line using the pingfreq="X" and sendq="X" #
231 # settings as shown in the full example below. #
232 # The ping frequency is specified in seconds, and the sendq size #
233 # in bytes. It is recommended, although not enforced, that you #
234 # should never set your sendq size to less than 8k. Send Queues are #
235 # dynamically allocated and can grow as needed up to the maximum #
238 # The optional recvq value is the maximum size which users in this #
239 # group may grow their receive queue to. This is recommended to be #
240 # kept pretty low compared to the sendq, as users will always #
241 # receive more than they send in normal circumstances. The default #
242 # if not specified is 4096. #
244 # IMPORTANT NOTE, CALL THE CONFUSION POLICE! #
245 # The sendq is the data waiting to be sent TO THE USER. #
246 # The recvq is the data being received FROM THE USER. #
247 # The names sendq and recvq are from the SERVER'S PERSPECTIVE not #
248 # that of the user... Just to clear up any confusion or complaints #
249 # that these are backwards :p #
251 # The localmax and globalmax values can be used to enforce local #
252 # and global session limits on connections. The session limits are #
253 # counted against all users, but applied only to users within the #
254 # class. For example, if you had a class 'A' which has a session #
255 # limit of 3, and a class 'B' which has a session limit of 5, and #
256 # somehow, two users managed to get into class B which also match #
257 # class A, there is only one connection left for this IP now in A, #
258 # but if they can connect again to B, there are three. You get the #
262 <connect allow="196.12.*" password="secret">
263 <connect allow="*" timeout="60" flood="20" threshold="1" pingfreq="120" sendq="262144" recvq="8192" localmax="3" globalmax="3">
265 <connect deny="69.254.*">
266 <connect deny="3ffe::0/32">
269 #-#-#-#-#-#-#-#-#-#-#-#- CLASS CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-
271 # Classes are a group of commands which are grouped together #
272 # and given a unique name. They used to define which commands #
273 # are available to certain types of Operators. #
275 # Syntax is as follows: #
277 # <class name="name" commands="oper commands"> #
279 # ____ _ _____ _ _ ____ _ _ _ #
280 # | _ \ ___ __ _ __| | |_ _| |__ (_)___ | __ )(_) |_| | #
281 # | |_) / _ \/ _` |/ _` | | | | '_ \| / __| | _ \| | __| | #
282 # | _ < __/ (_| | (_| | | | | | | | \__ \ | |_) | | |_|_| #
283 # |_| \_\___|\__,_|\__,_| |_| |_| |_|_|___/ |____/|_|\__(_) #
285 # You are not forced to give these classes the names given below. #
286 # You can create your own named classes, if you want, in fact that #
287 # is the whole idea of this system! #
289 # Note: It is possible to make a class which covers all available #
290 # commands. To do this, specify commands="*". This is not really #
291 # recommended, as it negates the whole purpose of the class system, #
292 # however it is provided for fast configuration (e.g. in test nets) #
295 <class name="Shutdown" commands="DIE RESTART REHASH LOADMODULE UNLOADMODULE RELOAD">
296 <class name="ServerLink" commands="CONNECT SQUIT RCONNECT MKPASSWD MKSHA256">
297 <class name="BanControl" commands="KILL GLINE KLINE ZLINE QLINE ELINE">
298 <class name="OperChat" commands="WALLOPS GLOBOPS SETIDLE SPYLIST SPYNAMES">
299 <class name="HostCloak" commands="SETHOST SETIDENT SETNAME CHGHOST CHGIDENT">
302 #-#-#-#-#-#-#-#-#-#-#-#- OPERATOR COMPOSITION -#-#-#-#-#-#-#-#-#-#-#
304 # This is where you specify which types of operators you have on #
305 # your server, as well as the commands they are allowed to use. #
306 # This works alongside with the classes specified above. #
308 # type name - a name for the combined class types #
309 # a type name cannot contain spaces, however if you #
310 # put an _ symbol in the name, it will be translated #
311 # to a space when displayed in a WHOIS. #
313 # classes - specified above, used for flexibility for the #
314 # server admin to decide on which operators get #
315 # what commands. Class names are case sensitive, #
316 # seperate multiple class names with spaces. #
318 # host - optional hostmask operators will receive on oper-up. #
320 # Syntax is as follows: #
322 # <type name="name" classes="class names" host="oper hostmask"> #
324 # ____ _ _____ _ _ ____ _ _ _ #
325 # | _ \ ___ __ _ __| | |_ _| |__ (_)___ | __ )(_) |_| | #
326 # | |_) / _ \/ _` |/ _` | | | | '_ \| / __| | _ \| | __| | #
327 # | _ < __/ (_| | (_| | | | | | | | \__ \ | |_) | | |_|_| #
328 # |_| \_\___|\__,_|\__,_| |_| |_| |_|_|___/ |____/|_|\__(_) #
330 # You are not forced to give these types the names given below. #
331 # You can create your own named types, if you want, in fact that #
332 # is the whole idea of this system! #
335 <type name="NetAdmin" classes="OperChat BanControl HostCloak Shutdown ServerLink" host="netadmin.omega.org.za">
336 <type name="GlobalOp" classes="OperChat BanControl HostCloak ServerLink" host="ircop.omega.org.za">
337 <type name="Helper" classes="HostCloak" host="helper.omega.org.za">
340 #-#-#-#-#-#-#-#-#-#-#- OPERATOR CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
342 # Opers are defined here. This is a very important section. #
343 # Remember to only make operators out of truthworthy people. #
345 # name - oper name, This is case sensitive, so it is best to #
348 # password - password to oper-up, also case sensitive. #
349 # encryption is supported via modules. You may load #
350 # modules for MD5 or SHA256 encryption, and if you do, #
351 # this value will be a hash value, otherwise put a #
352 # plaintext password in this value. #
354 # host - hosts of client allowed to oper-up. #
355 # wildcards accepted, seperate multiple hosts with a #
356 # space. You may also specify CIDR ip addresses. #
358 # fingerprint - When using the m_ssl_oper_cert.so module, you may #
359 # specify a key fingerprint here. This can be obtained #
360 # using the /fingerprint command whilst the module is #
361 # loaded, or from the notice given to you when you #
362 # connect to the ircd using a client certificate, #
363 # and will lock this oper block to only the user who #
364 # has that specific key/certificate pair. #
365 # This enhances security a great deal, however it #
366 # requires that opers use clients which can send ssl #
367 # client certificates, if this is configured for that #
368 # oper. Note that if the m_ssl_oper.so module is not #
369 # loaded, and/or one of m_ssl_openssl or m_ssl_gnutls #
370 # is not loaded, this configuration option has no #
371 # effect and will be ignored. #
373 # type - Defines the kind of operator. This must match a type #
374 # tag you defined above, and is case sensitive. #
376 # Syntax is as follows: #
377 # <oper name="login" #
379 # host="hostmask@of.oper" #
380 # fingerprint="hexsequence" #
381 # type="oper type"> #
386 host="ident@dialup15.isp.com *@localhost *@server.com *@3ffe::0/16"
390 #-#-#-#-#-#-#-#-#-#-#- SERVER LINK CONFIGURATION -#-#-#-#-#-#-#-#-#-#
392 # Defines which servers can link to this one, and which servers this #
393 # server may create outbound links to. #
395 # name - The name is the canocial name of the server, does #
396 # not have to resolve - but it is expected to be set #
397 # in the remote servers connection info. #
399 # ipaddr - Valid host or ip address for remote server. These #
400 # hosts are resolved on rehash, and cached, if you #
401 # specify a hostname, so if you find that your server #
402 # is still trying to connect to an old IP after you #
403 # have updated your dns, try rehashing and then #
404 # attempting the connect again. #
406 # port - The TCP port for the remote server. #
408 # sendpass - Password to send to create an outbound connection #
411 # recvpass - Password to receive to accept an inbound connection #
412 # from this server. #
414 # autoconnect - Sets the server to autoconnect. Where x is the num. #
415 # (optional) of seconds between attempts. e.g. 300 = 5 minutes. #
417 # transport - If defined, this is a transport name implemented by #
418 # another module. Transports are layers on top of #
419 # plaintext connections, which alter them in certain #
420 # ways. Currently the three supported transports are #
421 # 'openssl' and 'gnutls' which are types of SSL #
422 # encryption, and 'zip' which is for compression. #
423 # If you define a transport, both ends of the #
424 # connection must use a compatible transport for the #
425 # link to succeed. OpenSSL and GnuTLS are link- #
426 # compatible with each other. #
428 # hidden - When using m_spanningtree.so for linking. you may #
429 # set this to 'yes', and if you do, the IP address/ #
430 # hostname of this connection will NEVER be shown to #
431 # any opers on the network. In /STATS c its address #
432 # will show as *@<hidden>, and during CONNECT and #
433 # inbound connections, its IP will show as <hidden> #
434 # UNLESS the connection fails (e.g. due to a bad #
435 # password or servername) #
437 # allowmask - When this is defined, it indicates a range of IP #
438 # addresses to allow for this link (You may use CIDR #
439 # or wildcard form for this address). #
440 # e.g. if your server is going to connect to you from #
441 # the range 1.2.3.1 through 1.2.3.255, put 1.2.3.0/24 #
442 # into this value. If it is not defined, then only #
443 # the ipaddr field of the server shall be allowed. #
445 # failover - If you define this option, it must be the name of a #
446 # different link tag in your configuration. This #
447 # option causes the ircd to attempt a connection to #
448 # the failover link in the event that the connection #
449 # to this server fails. For example, you could define #
450 # two hub uplinks to a leaf server, and set an #
451 # american server to autoconnect, with a european #
452 # hub as its failover. In this situation, your ircd #
453 # will only try the link to the european hub if the #
454 # american hub is unreachable. NOTE that for the #
455 # intents and purposes of this option, an unreachable #
456 # server is one which DOES NOT ANSWER THE CONNECTION. #
457 # If the server answers the connection with accept(), #
458 # EVEN IF THE CREDENTIALS ARE INVALID, the failover #
459 # link will not be tried! Failover settings will also #
460 # apply to autoconnected servers as well as manually #
463 # timeout - If this is defined, then outbound connections will #
464 # time out if they are not connected within this many #
465 # seconds. If this is not defined, the default of ten #
468 # bind - If you specify this value, then when creating an #
469 # outbound connection to the given server, the IP you #
470 # place here will be bound to. This is for multi- #
471 # homed servers which may have multiple IP addresses. #
472 # If you do not define this value, the first IP that #
473 # is not empty or localhost from your <bind> tags #
474 # will be bound to. This is usually acceptable, #
475 # however if your server has multiple network cards #
476 # then you may have to manually specify the bind #
477 # value instead of leaving it to automatic binding. #
478 # You can usually tell if you need to set this by #
479 # looking for the error 'Could not assign requested #
480 # address' in your log when connecting to servers. #
482 # to u:line a server (give it extra privilages required for running #
483 # services, Q, etc) you must include the <uline server> tag as shown #
484 # in the example below. You can have as many of these as you like. #
486 # WARNING: Unlike other ircds, u:lining a server allows ALL users on #
487 # that server to operoverride modes. This should only be used for #
488 # services and protected oper servers! #
490 # ------------------------------------------------------------------- #
492 # NOTE: If you have built your server as an ipv6 server, then when a #
493 # DNS lookup of a server's host occurs, AAAA records (ipv6) are #
494 # priorotized over A records (ipv4). Therefore, if the server you are #
495 # connecting to has both an IPV6 ip address and an IPV4 ip address in #
496 # its DNS entry, the IPV6 address will *always* be selected. To #
497 # change this behaviour simply specify the IPV4 IP address rather #
498 # than the hostname of the server. #
500 # ------------------------------------------------------------------- #
502 # ____ _ _____ _ _ ____ _ _ _ #
503 # | _ \ ___ __ _ __| | |_ _| |__ (_)___ | __ )(_) |_| | #
504 # | |_) / _ \/ _` |/ _` | | | | '_ \| / __| | _ \| | __| | #
505 # | _ < __/ (_| | (_| | | | | | | | \__ \ | |_) | | |_|_| #
506 # |_| \_\___|\__,_|\__,_| |_| |_| |_|_|___/ |____/|_|\__(_) #
508 # If you want to link servers to InspIRCd you must load the #
509 # m_spanningtree module! Please see the modules list below for #
510 # information on how to load this module! If you do not load this #
511 # module, server links will NOT work! #
513 # Also, if you define any transports, you must load the modules for #
514 # these transports BEFORE you load m_spanningtree, e.g. place them #
515 # above it in the configuration file. Currently this means the three #
516 # modules m_ssl_gnutls, m_ziplinks and m_ssl_openssl, depending on #
517 # which you choose to use. #
520 <link name="hub.penguin.org"
521 ipaddr="penguin.box.com"
523 allowmask="69.58.44.0/24"
525 failover="hub.other.net"
529 sendpass="outgoing!password"
530 recvpass="incoming!password">
532 <link name="services.antarctic.com"
535 allowmask="127.0.0.0/8"
537 recvpass="polarbears">
539 <uline server="services.antarctic.com">
542 #-#-#-#-#-#-#-#-#-#- MISCELLANEOUS CONFIGURATION -#-#-#-#-#-#-#-#-#-#
544 # These options let you define the path to your motd and rules #
545 # files. If these are relative paths, they are relative to the #
546 # configurtion directory. #
549 <files motd="inspircd.motd"
550 rules="inspircd.rules">
552 #-#-#-#-#-#-#-#-#-#-#-# MAXIMUM CHANNELS -#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
554 # This optional configuration tag lets you define the maximum number #
555 # of channels that both opers and users may be on at any one time. #
556 # the default is 20 for user and 60 for opers if this tag is not #
557 # defined. Remote users are not restricted in any manner. #
563 #-#-#-#-#-#-#-#-#-#-#-#-#-#-# DNS SERVER -#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
565 # Define your DNS server address here. InspIRCd has its own resolver. #
566 # If you do not define this value, the first dns server from your #
567 # /etc/resolv.conf file is read. If no entries are found in this file #
568 # or the file cannot be opened, the default value '127.0.0.1' is used #
569 # instead. The timeout value is in seconds. #
571 # ____ _ _____ _ _ ____ _ _ _ #
572 # | _ \ ___ __ _ __| | |_ _| |__ (_)___ | __ )(_) |_| | #
573 # | |_) / _ \/ _` |/ _` | | | | '_ \| / __| | _ \| | __| | #
574 # | _ < __/ (_| | (_| | | | | | | | \__ \ | |_) | | |_|_| #
575 # |_| \_\___|\__,_|\__,_| |_| |_| |_|_|___/ |____/|_|\__(_) #
577 # When choosing a server, be sure to choose one which will do a #
578 # RECURSIVE LOOKUP. InspIRCd's resolver does not currently do these #
579 # recursive lookups itself, to save time and resources. The dns #
580 # server recommended by the InspIRCd team is bind, available from the #
581 # ISC website. If your DNS server does not do a recursive lookup, you #
582 # will be able to notice this by the fact that none of your users are #
583 # resolving even though the DNS server appears to be up! Most ISP and #
584 # hosting provider DNS servers support recursive lookups. #
586 # ------------------------------------------------------------------- #
588 # NOTE: if you have built InspIRCd with IPV6 support, then both #
589 # ipv6 and ipv4 addresses are allowed here, and also in the system #
590 # resolv.conf file. Remember that an ipv4 dns server can still #
591 # resolve ipv6 addresses, and vice versa. #
594 <dns server="127.0.0.1" timeout="5">
596 # An example of using an IPV6 nameserver
597 #<dns server="::1" timeout="5">
599 #-#-#-#-#-#-#-#-#-#-#-#-#-#-# PID FILE -#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
601 # Define the path to the PID file here. The PID file can be used to #
602 # rehash the ircd from the shell or to terminate the ircd from the #
603 # shell using shell scripts, perl scripts etc, and to monitor the #
604 # ircd's state via cron jobs. If this is a relative path, it will be #
605 # relative to the configuration directory, and if it is not defined, #
606 # the default of 'inspircd.pid' is used. #
609 #<pid file="/path/to/inspircd.pid">
611 #-#-#-#-#-#-#-#-#-#-#-#-#- BANLIST LIMITS #-#-#-#-#-#-#-#-#-#-#-#-#-#-#
613 # Use these tags to customise the ban limits on a per channel basis. #
614 # the tags are read from top to bottom, and any tag found which #
615 # matches the channels name applies the banlimit to that channel. #
616 # It is advisable to put an entry with the channel as '*' at the #
617 # bottom of the list. If none are specified or no maxbans tag is #
618 # matched, the banlist size defaults to 64 entries. #
621 <banlist chan="#morons" limit="128">
622 <banlist chan="*" limit="69">
624 #-#-#-#-#-#-#-#-#-#-#- DISABLED COMMANDS -#-#-#-#-#-#-#-#-#-#-#-#-#-#
626 # This tag is optional, and specifies one or more commands which are #
627 # not available to non-operators. For example you may wish to disable #
628 # NICK and prevent non-opers from changing their nicknames. #
629 # Note that any disabled commands take effect only after the user has #
630 # 'registered' (e.g. after the initial USER/NICK/PASS on connection) #
631 # so for example disabling NICK will not cripple your network. #
634 #<disabled commands="TOPIC MODE">
637 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#- RTFM LINE -#-#-#-#-#-#-#-#-#-#-#-#-#-#
639 # Just remove this... Its here to make you read ALL of the config #
642 <die value="You should probably edit your config *PROPERLY* and try again.">
646 #-#-#-#-#-#-#-#-#-#-#-#-#- SERVER OPTIONS -#-#-#-#-#-#-#-#-#-#-#-#-#
648 # Settings to define which features are useable on your server. #
650 # prefixquit - a prefix for a client's quit message #
652 # loglevel - specifies what detail of messages to log in the #
653 # log file. You may select from debug, verbose, #
654 # default, sparse and none. #
656 # allowhalfop - allows the +h channel mode #
658 # noservices - If noservices is true, yes, or 1, then the first #
659 # user into a channel gets founder status. This is #
660 # only useful on networks running the m_chanprotect #
661 # module without services. #
663 # qaprefixes - If qaprefixes is true, yes, or 1, then users #
664 # with +q or +a will get the ~ or & prefixes #
665 # used in unreal. This is only useful on networks #
666 # running the m_chanprotect module #
668 # deprotectself - If this value is set to yes, true, or 1, then any #
669 # user with +q or +a may remove the +q or +a from #
670 # themselves. The default setting is to not enable #
671 # this feature, which stops even the founder taking #
672 # away their founder status without using services. #
674 # cyclehosts - If this is set to true, yes or 1, then when a #
675 # user's hostname changes, they will appear to quit #
676 # and then rejoin with their new host. This prevents #
677 # clients from being confused by host changes, #
678 # especially in the case of bots, and it is #
679 # recommended that this option is enabled. #
681 # netbuffersize - size of the buffer used to receive data from #
682 # clients. The ircd may only read() this amount #
683 # of text in one go at any time. (OPTIONAL) #
685 # maxwho - The maximum number of results returned by a /WHO #
686 # query. This is to prevent /WHO being used as a #
687 # spam vector or means of flooding an ircd. The #
688 # default is 128, it is not recommended to raise it #
689 # above 1024. Values up to 65535 are permitted. #
691 # somaxconn - The maximum number of sockets that may be waiting #
692 # in the accept queue. This usually allows the ircd #
693 # to soak up more connections in a shorter space of #
694 # time when increased but please be aware there is a #
695 # system defined maximum value to this, the same way #
696 # there is a system defined maximum number of file #
697 # descriptors. Some systems may only allow this to #
698 # be up to 5 (ugh) while others such as FreeBSD will #
699 # default to a much nicer 128. #
701 # moduledir - This optional value indicates a runtime change of #
702 # the location where modules are to be found. This #
703 # does not add a supplementary directory. There can #
704 # only be one module path. #
706 # softlimit - This optional feature allows a defined softlimit. #
707 # if defined sets a soft maxconnections value, has #
708 # to be less than the ./configure maxclients #
710 # userstats - The userstats field is optional and specifies #
711 # which stats characters in /STATS may be requested #
712 # by non-operators. Stats characters in this field #
713 # are case sensitive and are allowed to users #
714 # independent of if they are in a module or the core #
716 # operspywhois - If this is set then when an IRC operator uses #
717 # /WHOIS on a user they will see all channels, even #
718 # ones if channels are secret (+s), private (+p) or #
719 # if the target user is invisible +i. #
721 # customversion - If you specify this configuration item, and it is #
722 # not set to an empty value, then when a user does #
723 # a /VERSION command on the ircd, this string will #
724 # be displayed as the second portion of the output, #
725 # replacing the system 'uname', compile flags and #
726 # socket engine/dns engine names. You may use this #
727 # to enhance security, or simply for vanity. #
729 # maxtargets - The maxtargets field is optional, and if not #
730 # defined, defaults to 20. It indicates the maximum #
731 # number of targets which may be given to commands #
732 # such as PRIVMSG, KICK etc. #
734 # hidesplits - When set to 'yes', will hide split server names #
735 # from non-opers. Non-opers will see '*.net *.split' #
736 # instead of the server names in the quit message, #
737 # identical to the way IRCu displays them. #
739 # hidebans - When set to 'yes', will hide gline, kline, zline #
740 # and qline quit messages from non-opers. For #
741 # example, user A who is not an oper will just see #
742 # (G-Lined) while user B who is an oper will see the #
743 # text (G-Lined: Reason here) instead. #
745 # hidewhois - When defined with a non-empty value, the given #
746 # text will be used in place of the user's server #
747 # in WHOIS, when a user is WHOISed by a non-oper. #
748 # For example, most nets will want to set this to #
749 # something like '*.netname.net' to conceal the #
750 # actual server the user is on. #
752 # flatlinks - When you are using m_spanningtree.so, and this #
753 # value is set to true, yes or 1, /MAP and /LINKS #
754 # will be flattened when shown to a non-oper. #
756 # hideulines - When you are using m_spanningtree.so, and this #
757 # value is set to true, yes or 1, then U-lined #
758 # servers will be hidden in /LINKS and /MAP. For non #
759 # opers. Please be aware that this will also hide #
760 # any leaf servers of a U-lined server, e.g. jupes. #
762 # nouserdns - If set to 'yes', 'true' or '1', no user dns #
763 # lookups will be performed for connecting users. #
764 # this can save a lot of resources on very busy irc #
767 # syntaxhints - If set to 'yes', 'true' or '1', when a user does #
768 # not give enough parameters for a command, a syntax #
769 # hint will be given (using the RPL_TEXT numeric) #
770 # as well as the standard ERR_NEEDMOREPARAMS. #
772 # announcets - If this value is defined to 'yes', 'true' or '1', #
773 # then if a channel's timestamp is updated the users #
774 # on the channel will be informed of the change via #
775 # a server notice to the channel with the old and #
776 # new TS values in the timestamp. If you think this #
777 # is just pointless noise, define the value to 0. #
779 # ircumsgprefix - Use undernet style message prefix for channel #
780 # NOTICE and PRIVMSG adding the prefix to the line #
781 # of text sent out. Eg. NOTICE @#test :@ testing #
782 # vs. the off setting: NOTICE @#test :testing #
784 # hostintopic - If this is set to yes (the default) then the full #
785 # nick!user@host is shown for who set a TOPIC last. #
786 # if set to no, then only the nickname is shown. #
788 #announceinvites - If this option is set to yes (the default), then #
789 # invites are announced to the channel when a user #
790 # invites annother user. If you consider this to be #
791 # unnecessary noise, explicitly set this to no. #
794 <options prefixquit="Quit: "
796 netbuffersize="10240"
820 #-#-#-#-#-#-#-#-#-#-#-#-#-#- TIME SYNC OPTIONS -#-#-#-#-#-#-#-#-#-#-#-#
821 # Time sychronization options for m_spanningtree linking. #
823 # Because IRC is very time and clock dependent, InspIRCd provides its #
824 # own methods for syncronization of time between servers as shown #
825 # in the example below, for servers that don't have ntpd running. #
827 # enable - If this value is 'yes', 'true', or '1', time #
828 # synchronization is enabled on this server. This #
829 # means any servers you are linked to will #
830 # automatically synchronize time, however you should #
831 # use ntpd instead where possible, NOT this option. #
833 # master - If this value is set to yes, then this server will #
834 # act as the authoritative time source for the whole #
835 # network. All other servers will respect its time #
836 # without question, and match their times to it. #
837 # only one server should have the master value set #
840 <timesync enable="no" master="no">
842 #-#-#-#-#-#-#-#-#-#-#-#-#- WHOWAS OPTIONS -#-#-#-#-#-#-#-#-#-#-#-#-#
844 # This tag lets you define the behaviour of the /whowas command of #
847 # groupsize - Controls the maximum entries per nick shown when #
848 # performing a /whowas nick. Setting this to 0 dis- #
849 # ables whowas completely. #
851 # maxgroups - The maximum number of nickgroups that can be added #
852 # to the list. If max is reached, oldest group will #
853 # be deleted first like a FIFO. A groupsize of 3 and #
854 # a maxgroups of 5000 will allow for 5000 nicks to #
855 # be stored with a history of 3, thus giving a total #
856 # of 3 * 5000 = 15000 entries. A setting of 0 dis- #
857 # ables whowas completely. #
859 # maxkeep - The maximum time a nick is kept in the whowas list #
860 # before being pruned. Time may be specified in #
861 # seconds, or in the following format: 1y2w3d4h5m6s #
862 # meaning one year, two weeks, three days, 4 hours, #
863 # 5 minutes and 6 seconds. All fields in this format #
864 # are optional. Minimum is 1 hour, if less InspIRCd #
865 # will default back to 1 hour. #
867 #<whowas groupsize="10" #
868 # maxgroups="100000" #
872 #-#-#-#-#-#-#-#-#-#-#-#-#- MODULE OPTIONS -#-#-#-#-#-#-#-#-#-#-#-#-#
874 # These tags define which modules will be loaded on startup by your #
875 # server. Add modules without any paths. When you make your ircd #
876 # using the 'make' command, all compiled modules will be moved into #
877 # the folder you specified when you ran ./configure. The module tag #
878 # automatically looks for modules in this location. #
879 # If you attempt to load a module outside of this location, either #
880 # in the config, or via /LOADMODULE, you will receive an error. #
882 # By default, ALL modules are commented out. You must uncomment them #
883 # or add lines to your config to load modules. Please refer to #
884 # http://www.inspircd.org/wiki/Modules_List for a list of modules and#
885 # each modules link for any additional conf tags they require. #
887 # You may use wildcards in a <module> tag to load all modules which #
888 # match a glob pattern (e.g. m_sa????.so would load m_sajoin, #
889 # m_sapart, m_saquit and m_sanick) #
891 # ____ _ _____ _ _ ____ _ _ _ #
892 # | _ \ ___ __ _ __| | |_ _| |__ (_)___ | __ )(_) |_| | #
893 # | |_) / _ \/ _` |/ _` | | | | '_ \| / __| | _ \| | __| | #
894 # | _ < __/ (_| | (_| | | | | | | | \__ \ | |_) | | |_|_| #
895 # |_| \_\___|\__,_|\__,_| |_| |_| |_|_|___/ |____/|_|\__(_) #
897 # To link servers to InspIRCd, you MUST load the m_spanningtree #
898 # module, as shown below. If you DO NOT do this, server links will #
899 # NOT work at all. ie. The ports will NOT bind, and /connect will not #
900 # work properly. This is by design, to allow for the implementation #
901 # of other linking protocols in modules in the future. #
903 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
904 # Spanning Tree module - allows linking of servers using the spanning
905 # tree protocol (see the READ THIS BIT section above).
907 #<module name="m_spanningtree.so">
910 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
911 # MD5 Module - Allows other modules to generate MD5 hashes, usually for
912 # cryptographic uses and security.
915 # Other modules such as m_cloaking.so and m_opermd5.so may rely on
916 # this module being loaded to function.
918 #<module name="m_md5.so">
920 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
921 # SHA256 Module - Allows other modules to generate SHA256 hashes,
922 # usually for cryptographic uses and security.
925 # Other modules such as m_opermd5.so may rely on this module being
926 # loaded to function.
928 #<module name="m_sha256.so">
930 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
931 # Alias module: Allows you to define server-side command aliases
932 #<module name="m_alias.so">
934 #-#-#-#-#-#-#-#-#-#-#- ALIAS DEFINITIONS -#-#-#-#-#-#-#-#-#-#-#-#-#-#
936 # If you have the m_alias.so module loaded, you may also define #
937 # aliases as shown below. They are commonly used to provide shortcut #
938 # commands to services, however they are not limited to just this use.#
939 # An alias tag requires the following values to be defined in it: #
941 # text - The text to detect as the actual command line, #
942 # Cant contain spaces, but case insensitive. #
943 # You may have multiple aliases with the same #
944 # command name (text="" value), however the first #
945 # found will be executed if its format value is #
946 # matched, or it has no format value. Aliases are #
947 # read from the top of the file to the bottom. #
949 # format - If this is defined, the parameters of the alias #
950 # must match this glob pattern. For example if you #
951 # want the first parameter to start with a # for #
952 # the alias to be executed, set format="#*" in the #
953 # alias definition. Note that the :'s which are #
954 # part of IRC formatted lines will be preserved #
955 # for matching of this text. This value is #
958 # replace - The text to replace 'text' with. Usually this #
959 # will be "PRIVMSG ServiceName :$2-" or similar. #
960 # You may use the variables $1 through $9 in the #
961 # replace string, which refer to the first through #
962 # ninth word in the original string typed by the #
963 # user. You may also use $1- through $9- which #
964 # refer to the first word onwards, through to the #
965 # ninth word onwards, e.g. if the user types the #
966 # command "foo bar baz qux quz" then $3- will hold #
967 # "baz qux quz" and $2 will contain "bar". You may #
968 # also use the special variables: $nick, $ident, #
969 # $host and $vhost, and you may seperate multiple #
970 # commands with \n. If you wish to use the ACTUAL #
971 # characters \ and n together in a line, you must #
972 # use the sequence "\\n". #
974 # requires - If you provide a value for 'requires' this means #
975 # the given nickname MUST be online for the alias #
976 # to successfully trigger. If they are not, then #
977 # the user receives a 'no such nick' 401 numeric. #
979 # uline - Defining this value with 'yes', 'true' or '1' #
980 # will ensure that the user given in 'requires' #
981 # must also be on a u-lined server, as well as #
982 # actually being on the network. If the user is #
983 # online, but not on a u-lined server, then an #
984 # oper-alert is sent out as this is possibly signs #
985 # of a user trying to impersonate a service. #
987 # operonly - Defining this value, with a value of 'yes', '1' #
988 # or true will make the alias oper only. If a non- #
989 # oper attempts to use the alias, it will appear #
992 #<alias text="NICKSERV" replace="PRIVMSG NickServ :$2-" requires="NickServ" uline="yes">
993 #<alias text="CHANSERV" replace="PRIVMSG ChanServ :$2-" requires="ChanServ" uline="yes">
994 #<alias text="OPERSERV" replace="PRIVMSG OperServ :$2-" requires="OperServ" uline="yes" operonly="yes">
995 #<alias text="NS" replace="PRIVMSG NickServ :$2-" requires="NickServ" uline="yes">
996 #<alias text="CS" replace="PRIVMSG ChanServ :$2-" requires="ChanServ" uline="yes">
997 #<alias text="OS" replace="PRIVMSG OperServ :$2-" requires="OperServ" uline="yes" operonly="yes">
999 # An example of using the format value to create an alias with two
1000 # different behaviours depending on the format of the parameters.
1002 #<alias text="ID" format="#*" replace="PRIVMSG ChanServ :IDENTIFY $2 $3"
1003 # requires="ChanServ" uline="yes">
1005 #<alias text="ID" replace="PRIVMSG NickServ :IDENTIFY $2"
1006 # requires="NickServ" uline="yes">
1008 # This alias fixes a glitch in xchat 2.6.x and above and the way it
1009 # assumes IDENTIFY must be prefixed by a colon (:) character. It should
1010 # be placed ABOVE the default NICKSERV alias (the first example) listed
1013 #<alias text="NICKSERV" format=":IDENTIFY *" replace="PRIVMSG NickServ :IDENTIFY $3-"
1014 # requires="NickServ" uline="yes">
1016 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1017 # Alltime module: Shows time on all connected servers at once
1018 #<module name="m_alltime.so">
1020 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1021 # Antibear security module: Prevents 'bear.txt' based trojans from
1022 # connecting to your network by sending them a numeric they can't handle.
1023 #<module name="m_antibear.so">
1025 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1026 # Antibottler module: Labels bottler leech bots
1027 #<module name="m_antibottler.so">
1029 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1030 # Ban except module: Adds support for channel ban exceptions (+e)
1031 #<module name="m_banexception.so">
1033 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1034 # Ban redirection module: Allows bans which redirect to a specified
1035 # channel. e.g. +b nick!ident@host#channelbanneduserissentto
1036 #<module name="m_banredirect.so">
1038 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1039 # Block amsg module: Attempt to block all usage of /amsg and /ame
1040 #<module name="m_blockamsg.so">
1042 #-#-#-#-#-#-#-#-#-#-#- BLOCKAMSG CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
1044 # If you have the m_blockamsg.so module loaded, you can configure it #
1045 # with the <blockamsg> tag: #
1047 # delay - How many seconds between two messages to force #
1048 # them to be recognised as unrelated. #
1049 # action - Any of 'notice', 'noticeopers', 'silent', 'kill' #
1050 # or 'killopers'. Define how to take action when #
1051 # a user uses /amsg or /ame. #
1053 #<blockamsg delay="3" action="killopers">
1055 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1056 # Block CAPS module: Blocking all-CAPS messages with cmode +P
1057 #<module name="m_blockcaps.so">
1059 #-#-#-#-#-#-#-#-#-#-#- BLOCKCAPS CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
1061 # percent - How many percent of text must be caps before text #
1062 # will be blocked. #
1064 # minlen - The minimum length a line must be for the block #
1065 # percent to have any effect. #
1067 # capsmap - A list of chars to be considered CAPS, this was #
1068 # you can add CAPS for your language. Also you can #
1069 # add things like ! and space to further lock down #
1071 #<blockcaps percent="50"
1073 # capsmap="ABCDEFGHIJKLMNOPQRSTUVWXYZ! ">
1075 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1076 # Block colour module: Blocking colour-coded messages with cmode +c
1077 #<module name="m_blockcolor.so">
1079 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1080 # Botmode module: Adds the user mode +B
1081 #<module name="m_botmode.so">
1083 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1084 # CBAN module: Lets you disallow channels from being used at runtime.
1085 #<module name="m_cban.so">
1087 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1088 # Censor module: Adds the channel mode +G
1089 #<module name="m_censor.so">
1091 #-#-#-#-#-#-#-#-#-#-#- CENSOR CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#
1093 # Optional - If you specify to use the m_censor module, then you must #
1094 # specify some censor tags. See also: #
1095 # http://www.inspircd.org/wiki/Censor_Module #
1097 #<include file="censor.conf">
1099 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1100 # CGI:IRC module: Adds support for automatic host changing in CGI:IRC
1101 # (http://cgiirc.sourceforge.net).
1102 #<module name="m_cgiirc.so">
1104 #-#-#-#-#-#-#-#-#-#-#-# CGIIRC CONFIGURATION #-#-#-#-#-#-#-#-#-#-#-#-#
1106 # Optional - If you specify to use m_cgiirc, then you must specify one
1107 # or more cgihost tags which indicate authorized CGI:IRC servers which
1108 # will be connecting to your network, and an optional cgiirc tag.
1109 # For more information see: http://www.inspircd.org/wiki/CGI-IRC_Module
1111 # Set to yes if you want to notice opers when CGI clients connect
1112 # <cgiirc opernotice="no">
1114 # The type field indicates where the module should get the real
1115 # client's IP address from, for further information, please see the
1116 # CGI:IRC documentation.
1118 # <cgihost type="pass" mask="www.mysite.com"> # Get IP from PASS
1119 # <cgihost type="webirc" mask="somebox.mysite.com"> # Get IP from WEBIRC
1120 # <cgihost type="ident" mask="otherbox.mysite.com"> # Get IP from ident
1121 # <cgihost type="passfirst" mask="www.mysite.com"> # See the docs
1123 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1124 # Channel filter module: Allows channel-op defined message
1125 # filtering using simple string matches (channel mode +g)
1126 #<module name="m_chanfilter.so">
1128 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1129 # Chanprotect module: gives +q and +a channel modes
1130 #<module name="m_chanprotect.so">
1132 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1133 # CHGHOST module: Adds the /CHGHOST command
1134 #<module name="m_chghost.so">
1136 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1137 # CHGIDENT module: Adds the /CHGIDENT command
1138 #<module name="m_chgident.so">
1140 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1141 # Cloaking module: Adds usermode +x and cloaking support.
1142 # Relies on the module m_md5.so being loaded before m_cloaking.so in
1143 # the configuration file.
1144 #<module name="m_cloaking.so">
1146 #-#-#-#-#-#-#-#-#-#-#- CLOAKING CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#
1148 # Optional - If you specify the m_cloaking.so module as above, you #
1149 # must define cloak keys, and optionally a cloak prefix as shown #
1150 # below. When using cloaking, the cloak keys are MANDITORY and must #
1151 # be included. However, if prefix is not included, it will default #
1152 # to your networks name from the <server> tag. #
1154 # <cloak key1="0x2AF39F40" #
1155 # key2="0x78E10B32" #
1156 # key3="0x4F2D2E82" #
1157 # key4="0x043A4C81" #
1160 # Please note that the key values will accept any number, and should #
1161 # be large numbers. Using small numbers such as "7" or "1924" will #
1162 # seriously weaken the security of your cloak. It is recommended you #
1163 # use hexdecimal numbers prefixed by "0x", as shown in this example, #
1164 # with each key eight hex digits long. #
1166 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1167 # Conn-Join: Allows you to force users to join one or more channels
1168 # automatically upon connecting to the server.
1169 #<module name="m_conn_join.so">
1171 #-#-#-#-#-#-#-#-#-#-#-#- CONNJOIN CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
1173 # If you have m_conn_join.so loaded, you can configure it using the
1176 #<autojoin channel="#one,#two,#three">
1178 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1179 # Conn-Lusers: Shows the LUSERS output on connect
1180 #<module name="m_conn_lusers.so">
1182 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1183 # Conn-Usermodes: Set modes on users when they connect
1184 # When this module is loaded <connect:allow> tags may have an optional
1185 # modes="" value, which contains modes to add or remove from users
1186 # when they connect to the server.
1187 #<module name="m_conn_umodes.so">
1189 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1190 # Conn-Wait-for-Pong: Don't let a user connect until they PONG
1191 #<module name="m_conn_waitpong.so">
1193 #-#-#-#-#-#-#-#-#-#-#- WAITPONG CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
1195 # If you have the m_conn_waitpong.so module loaded, configure it with #
1196 # the <waitpong> tag: #
1198 # sendsnotice - Whether to send a snotice on connect, like other #
1201 # killonbadreply - Whether to kill the user if they send the wrong #
1204 #<waitpong sendsnotice="yes" killonbadreply="yes">
1206 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1207 # Connection throttle module. Configuration:
1208 #<module name="m_connflood.so">
1210 #-#-#-#-#-#-#-#-#-#-#- CONTHROTTLE CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
1211 # seconds, maxconns - Amount of connections per <seconds>.
1213 # timeout - Time to wait after the throttle was activated
1214 # before deactivating it. Be aware that the time
1215 # is seconds + timeout.
1217 # quitmsg - The message that users get if they attempt to
1218 # connect while the throttle is active.
1220 # bootwait - Amount of time to wait before enforcing the
1221 # throttling when the server just booted.
1223 #<connflood seconds="30" maxconns="3" timeout="30"
1224 # quitmsg="Throttled" bootwait="10">
1226 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1227 # DCCALLOW module: Adds the /DCCALLOW command
1228 #<module name="m_dccallow.so">
1230 #-#-#-#-#-#-#-#-#-#-#- DCCALLOW CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
1231 # blockchat - Whether to block DCC CHAT as well as DCC SEND
1232 # length - Default duration of entries in DCCALLOW list
1233 # action - Default action to take if no action is specified
1234 # can be 'block' or 'allow'
1236 # File configuration:
1237 # pattern - The glob pattern to match against
1238 # action - Action to take if a user attempts to send a file
1239 # that matches this pattern, can be 'block' or 'allow'
1241 #<dccallow blockchat="yes" length="5m" action="block">
1242 #<banfile pattern="*.exe" action="block">
1243 #<banfile pattern="*.txt" action="allow">
1245 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1247 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1248 # Deaf module: adds support for ircu style usermode +d - deaf to
1249 # channel messages and channel notices.
1250 #<module name="m_deaf.so">
1252 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1253 # Deny Channels: Deny Channels from being used by users
1254 #<module name="m_denychans.so">
1256 #-#-#-#-#-#-#-#-#-#-#- DENYCHAN DEFINITIONS -#-#-#-#-#-#-#-#-#-#-#-#
1258 # If you have the m_denychans.so module loaded, you need to specify #
1259 # the channels to deny: #
1261 # name - The channel name to deny. #
1263 # allowopers - If operators are allowed to override the deny. #
1265 # reason - Reason given for the deny. #
1267 #<badchan name="#gods" allowopers="yes" reason="Tortoises!">
1269 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1270 # Devoice Module: Let users devoice themselves.
1271 #<module name="m_devoice.so">
1273 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1274 # DNS Blacklist Module: Provides support for looking up IPs on one or #
1275 # more blacklists. #
1276 #<module name="m_dnsbl.so"> #
1278 # For configuration options please see the wiki page for m_dnsbl at #
1279 # http://inspircd.org/wiki/DNS_Blacklist_Module #
1281 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1282 # Filter module: Provides glob-based message filtering
1283 #<module name="m_filter.so">
1285 # PCRE filter module: Filters messages using regular expressions
1286 #<module name="m_filter_pcre.so">
1288 # You may only use one or the other with these modules, network-wide.
1290 #-#-#-#-#-#-#-#-#-#-#- FILTER CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#
1292 # Optional - If you specify to use the m_filter or m_filter_pcre #
1293 # modules, then specfiy below the path to the filter.conf file, #
1294 # or define some <filter> tags. #
1296 #<include file="filter.conf">
1298 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1299 # Foobar module: does nothing - historical relic
1300 #<module name="m_foobar.so">
1302 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1303 # Globops module: gives /GLOBOPS and usermode +g
1304 #<module name="m_globops.so">
1306 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1307 # Global load module: Allows loading and unloading of modules network-
1308 # wide (USE WITH EXTREME CAUTION!)
1309 #<module name="m_globalload.so">
1311 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1312 # HELPOP module: Provides the /HELPOP command
1313 #<module name="m_helpop.so">
1315 #-#-#-#-#-#-#-#-#-#-#-#- HELPOP CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
1317 # Optional - If you specify to use the m_helpop.so module, then #
1318 # specify below the path to the helpop.conf file, or if you like to #
1319 # make a mess, define your helpop tags in this conf. #
1321 #<include file="helpop.conf">
1323 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1324 # HIDECHANS module: Allows opers to hide their channels list from non-
1325 # opers by setting user mode +I on themselves.
1326 # <module name="m_hidechans.so">
1328 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1329 # HIDEOPER module: Allows opers to hide their oper status from non-
1330 # opers by setting user mode +H on themselves.
1331 # <module name="m_hideoper.so">
1333 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1334 # Hostchange module: Allows a different style of cloaking
1335 #<module name="m_hostchange.so">
1337 #-#-#-#-#-#-#-#-#-#-#- HOSTCHANGE CONFIGURATION -#-#-#-#-#-#-#-#-#-#
1339 # Optional - If you choose to use the m_hostchange.so module. #
1340 # Config Help - See http://www.inspircd.org/wiki/Host_Changer_Module #
1342 #<host suffix="polarbears.org">
1343 #<hostchange mask="*@fbi.gov" action="addnick">
1344 #<hostchange mask="*r00t@*" action="suffix">
1345 #<hostchange mask="a@b.com" action="set" value="blah.blah.blah">
1347 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1348 # httpd module: Provides http server support for InspIRCd
1349 #<module name="m_httpd.so">
1351 #-#-#-#-#-#-#-#-#-#-#-#- HTTPD CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
1353 # Optional - If you choose to use the m_httpd.so module, then you must
1354 # specify the port number and other details of your http server:
1356 #<http ip="192.168.1.10" host="brainwave" port="32006"
1357 # index="/home/brain/inspircd/http/index.html">
1359 # You may have as many of these tags as you wish, each with a different
1360 # IP, port, host or index file. Each one will act as an independent
1364 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1365 # http stats module: Provides basic stats pages over HTTP
1366 # Requires m_httpd.so to be loaded for it to function.
1367 #<module name="m_httpd_stats.so">
1369 #-#-#-#-#-#-#-#-#-#-#-#- HTTPD STATS CONFIGURATION -#-#-#-#-#-#-#-#-#-#
1371 #<httpstats stylesheet="http://remote.style/sheet.css">
1374 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1375 # Ident: Provides RFC 1413 ident lookup support
1376 #<module name="m_ident.so">
1378 #-#-#-#-#-#-#-#-#-#-#-#- IDENT CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
1380 # Optional - If you are using the m_ident.so module, then you can #
1381 # specify the timeout for ident lookups here. If not defined, it will #
1382 # default to one second. This is a non-blocking timeout which holds #
1383 # the user in a 'connecting' state until the lookup is complete. #
1385 #<ident timeout="5">
1387 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1388 # Invite except module: Adds support for channel invite exceptions (+I)
1389 #<module name="m_inviteexception.so">
1391 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1392 # Join flood module: Adds support for join flood protection (+j)
1393 #<module name="m_joinflood.so">
1395 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1396 # Anti-Auto-Rejoin: Adds support for prevention of auto-rejoin (+J)
1397 #<module name="m_kicknorejoin.so">
1399 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1400 # Knock module: adds the /KNOCK command and +K channel mode
1401 #<module name="m_knock.so">
1403 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1404 # Lock server module: Adds /LOCKSERV and /UNLOCKSERV commands that is #
1405 # used to temporarily close/open for new connections to the server. #
1406 # These commands require OPER status and that the LOCKSERV UNLOCKSERV #
1407 # are specified in a <class> tag that the oper is part of. This is so #
1408 # you can control who has access to this possible dangerous command. #
1409 # If your server is locked and you got disconnected, do a REHASH from #
1410 # shell to open up again.
1411 #<module name="m_lockserv.so">
1413 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1414 # Msg flood module: Adds message/notice flood protection (+f)
1415 #<module name="m_messageflood.so">
1417 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1418 # MySQL module: Allows other SQL modules to access MySQL databases
1419 # through a unified API. You must copy the source for this module
1420 # from the directory src/modules/extra, plus the file m_sqlv2.h
1421 #<module name="m_mysql.so">
1423 #-#-#-#-#-#-#-#-#-#-#-#- SQL CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#-#
1425 # m_mysql.so is more complex than described here, see the wiki for #
1426 # more: http://www.inspircd.org/wiki/SQL_Service_Provider_Module #
1428 #<database name="mydb" username="myuser" password="mypass" hostname="localhost" id="my_database2">
1430 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1431 # NAMESX module: Provides support for the NAMESX extension which allows
1432 # clients to see all the prefixes set on a user without getting confused.
1433 # This is supported by mIRC, x-chat, klient, and maybe more.
1434 #<module name="m_namesx.so">
1436 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1437 # Nicklock module: Let opers change a user's nick and then stop that
1438 # user from changing their nick again.
1439 #<module name="m_nicklock.so">
1441 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1442 # No ctcp module: Adds the channel mode +C to block CTCPs
1443 #<module name="m_noctcp.so">
1445 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1446 # Noinvite module: Gives channel mode +V
1447 #<module name="m_noinvite.so">
1449 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1450 # No kicks module: Adds the +Q channel mode
1451 #<module name="m_nokicks.so">
1453 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1454 # No nicks module: Adds the +N channel mode
1455 #<module name="m_nonicks.so">
1457 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1458 # No Notice module: adds the channel mode +T
1459 #<module name="m_nonotice.so">
1461 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1462 # Oper channels mode: Adds the +O channel mode
1463 #<module name="m_operchans.so">
1465 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1466 # Oper hash module: Allows hashed oper passwords
1467 # Relies on the module m_md5.so and/or m_sha256.so being loaded before
1468 # m_oper_hash.so in the configuration file.
1469 #<module name="m_oper_hash.so">
1471 #-#-#-#-#-#-#-#-#-#-# OPER HASH CONFIGURATION #-#-#-#-#-#-#-#-#-#-#-#-#
1473 # To use this module, you must define a hash type for each oper's
1474 # password you want to hash. For example:
1476 # <oper name="Brain"
1477 # host="ident@dialup15.isp.com"
1479 # password="a41d730937a53b79f788c0ab13e9e1d5"
1482 # The types of hashing available vary depending on which hashing modules
1483 # you load, but usually if you load m_sha256.so and m_md5.so, both md5
1484 # and sha256 type hashing will be available (the most secure of which
1487 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1488 # Oper Join module: Forces opers to join a channel on oper-up
1489 #<module name="m_operjoin.so">
1491 #-#-#-#-#-#-#-#-#-#-# OPERJOIN CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
1493 # If you are using the m_operjoin.so module, specify the channel here #
1495 #<operjoin channel="#channel">
1497 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1498 # Oper MOTD module: Provides support for seperate message of the day
1500 #<module name="m_opermotd.so">
1502 #-#-#-#-#-#-#-#-#-#-# OPERMOTD CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
1504 # If you are using the m_opermotd.so module, specify the motd here #
1506 #<opermotd file="oper.motd">
1508 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1509 # Override module: Adds support for oper override
1510 #<module name="m_override.so">
1512 #-#-#-#-#-#-#-#-#-#-# OVERRIDE CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
1514 # m_override.so is too complex it describe here, see the wiki: #
1515 # http://www.inspircd.org/wiki/Oper_Override_Module #
1517 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1518 # Oper levels module: Gives each oper a level and prevents
1519 # actions being taken against higher level opers
1520 # Specify the level as the 'level' parameter of the <type> tag
1521 #<module name="m_operlevels.so">
1523 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1524 # Oper modes module: Allows you to specify modes to add/remove on oper
1525 # Specify the modes as the 'modes' parameter of the <type> tag
1526 #<module name="m_opermodes.so">
1528 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1529 # PostgreSQL module: Allows other SQL modules to access PgSQL databases
1530 # through a unified API. You must copy the source for this module
1531 # from the directory src/modules/extra, plus the file m_sqlv2.h
1532 #<module name="m_pgsql.so">
1534 #-#-#-#-#-#-#-#-#-#-#-#- SQL CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#-#
1536 # m_pgsql.so is more complex than described here, see the wiki for #
1537 # more: http://www.inspircd.org/wiki/SQL_Service_Provider_Module #
1539 #<database name="mydb" username="myuser" password="mypass" hostname="localhost" id="my_database" ssl="no">
1541 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1542 # Random Quote module: provides a random quote on connect.
1543 # NOTE: Some of these may mimic fatal errors and confuse users and
1544 # opers alike! - BEWARE!
1545 #<module name="m_randquote.so">
1547 #-#-#-#-#-#-#-#-#-#- RANDOMQUOTES CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
1549 # Optional - If you specify to use the m_randquote.so module, then #
1550 # specify below the path to the randquotes.conf file. #
1552 #<randquote file="randquotes.conf">
1554 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1555 # Redirect module: Adds channel redirection (mode +L)
1556 #<module name="m_redirect.so">
1558 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1559 # Remove module: Adds the /REMOVE command which is a peaceful
1560 # alternative to /KICK
1561 #<module name="m_remove.so">
1563 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1564 # Restrict banned users module:
1565 # Disallows banned users on a channel from messaging the channel,
1566 # changing nick, or changing the topic, if loaded.
1567 #<module name="m_restrictbanned.so">
1569 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1570 # Restricted channels module: Allows only opers to create channels
1571 #<module name="m_restrictchans.so">
1573 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1574 # Restrict message module: Allows users to only message opers
1575 #<module name="m_restrictmsg.so">
1577 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1578 # Provide /LIST throttling (to prevent flooding) and /LIST safety to
1579 # prevent excess flood when the list is large.
1580 #<module name="m_safelist.so">
1582 #-#-#-#-#-#-#-#-#-#-# SAFELIST CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#-#
1584 # When using Safelist, you may set the following values;
1586 # The first value, 'throttle', sets the amount of time in seconds a user
1587 # must wait between LIST commands. For example, if this is set to 60
1588 # (the default) then the user may not /LIST more than once a minute.
1589 # If not defined, the default value is 60 seconds.
1591 # The second value, 'maxlisters', indicates the maximum number of users
1592 # which may be retrieving a LIST at once. It is not recommended you raise
1593 # this value, as increasing it too high can make your network vulnerable
1594 # to floodbots which waste your bandwidth and CPU time with LIST requests.
1596 #<safelist throttle="60" maxlisters="50">
1598 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1599 # SAJOIN module: Adds the /SAJOIN command
1600 #<module name="m_sajoin.so">
1602 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1603 # SAMODE module: Adds the oper /SAMODE command
1604 #<module name="m_samode.so">
1606 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1607 # SANICK module: Allows opers to change user's nicks
1608 #<module name="m_sanick.so">
1610 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1611 # SAPART module: Adds the oper /SAPART command
1612 #<module name="m_sapart.so">
1614 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1615 # SAQUIT module: Adds the oper /SAQUIT command (abusable!!!)
1616 #<module name="m_saquit.so">
1618 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1619 # Secure list module: Prevent /LIST in the first minute of connection,
1620 # crippling most spambots and trojan spreader bots.
1621 #<module name="m_securelist.so">
1623 #-#-#-#-#-#-#-#-#-# SECURELIST CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#-#
1625 # Securelist can be harmful to some irc search engines such as #
1626 # netsplit.de and searchirc.com. To prevent securelist blocking these #
1627 # sites from listing, define exception tags as shown below: #
1628 <securelist exception="*@*.searchirc.org">
1629 <securelist exception="*@*.netsplit.de">
1630 <securelist exception="*@echo940.server4you.de">
1632 # Define the following variable to change how long a user must wait #
1633 # before issuing a LIST. If not defined, defaults to 60 seconds. #
1635 #<securelist waittime="60"> #
1637 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1638 # Set Idle module: Adds a command for opers to change their
1639 # idle time (mainly a toy)
1640 #<module name="m_setidle.so">
1642 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1643 # Services support module: Adds several usermodes such as +R and +M
1644 # this module implements the 'identified' state via user mode +r, which
1645 # is similar to the DALnet and dreamforge systems.
1646 #<module name="m_services.so">
1648 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1649 # Services support module: Adds several usermodes such as +R and +M
1650 # this module implements the 'identified' state via account names (AC)
1651 # and is similar in operation to the way asuka and ircu handle services.
1652 # it cannot be used at the same time as m_services, above.
1653 #<module name="m_services_account.so">
1655 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1656 # Sethost module: Adds the /SETHOST command
1657 #<module name="m_sethost.so">
1659 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1660 # Setident module: Adds the /SETIDENT command
1661 #<module name="m_setident.so">
1663 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1664 # SETNAME module: Adds the /SETNAME command
1665 #<module name="m_setname.so">
1667 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1668 # Show Whois module: Adds the +W usermode which allows opers
1669 # to see when they are whois'ed (can be annoying).
1670 #<module name="m_showwhois.so">
1672 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1673 # Spy module: Adds the commands SPYLIST and SPYNAMES that let opers
1674 # see who is in a +s channel, and list +s channels, show keys of keyed
1675 # channels the oper is not a member of etc. (standard 'abusive' features
1676 # of many other ircds, modulized here in InspIRCd).
1677 #<module name="m_spy.so">
1679 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1680 # SSL channel mode module: Adds support for SSL-only channels (+z).
1681 # does not do anything useful without a working SSL module (see below)
1682 #<module name="m_sslmodes.so">
1684 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1685 # Dummy ssl module: If you have other servers on your network which
1686 # have SSL, but your server does not have ssl enabled, you should load
1687 # this module, which will handle SSL metadata (e.g. the "Is using ssl"
1688 # field in the WHOIS information).
1689 #<module name="m_ssl_dummy.so">
1691 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1692 # GnuTLS ssl module: Adds support for client-server SSL using GnuTLS,
1693 # if enabled. You must copy the source for this module from the directory
1694 # src/modules/extra, or answer 'yes' in ./configure when asked if you
1695 # want to enable this, or it will not load.
1696 #<module name="m_ssl_gnutls.so">
1698 #-#-#-#-#-#-#-#-#-#-#- GNUTLS CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#
1700 # m_ssl_gnutls.so is too complex it describe here, see the wiki: #
1701 # http://www.inspircd.org/wiki/GnuTLS_SSL_Module #
1703 # NOTE: If you want to use this module to encrypt and sign your #
1704 # server to server traffic, you MUST load it before m_spanningtree in #
1705 # your configuration file! #
1707 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1708 # SSL Info module: Allows users to retrieve information about other
1709 # user's peer SSL certificates and keys. This can be used by client
1710 # scripts to validate users. For this to work, one of m_ssl_gnutls.so
1711 # or m_ssl_openssl.so must be loaded. You must symlink the source for
1712 # this module from the directory src/modules/extra.
1713 #<module name="m_sslinfo.so">
1715 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1716 # OpenSSL ssl module: Adds support for client-server SSL using OpenSSL,
1717 # if enabled. You must copy the source for this module from the directory
1718 # src/modules/extra, or answer 'yes' in ./configure when asked if you
1719 # want to enable this, or it will not load.
1720 #<module name="m_ssl_openssl.so">
1722 #-#-#-#-#-#-#-#-#-#-#- OPENSSL CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#
1724 # m_ssl_openssl.so is too complex it describe here, see the wiki: #
1725 # http://www.inspircd.org/wiki/OpenSSL_SSL_Module #
1727 # NOTE: If you want to use this module to encrypt and sign your #
1728 # server to server traffic, you MUST load it before m_spanningtree in #
1729 # your configuration file! #
1731 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1732 # SSL Cert Oper module: Allows opers to oper up using the key fingerprint
1733 # stored within their SSL certificate and key pair.
1734 # When using this module, one of m_ssl_gnutls.so or m_ssl_openssl.so must
1735 # be loaded. An extra value should be added to enabled opers, which
1736 # is in the following format: fingerprint="<hash>". For more information,
1737 # see the example in the oper blocks.
1738 #<module name="m_ssl_oper_cert.so">
1740 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1741 # Strip colour module: Adds the channel mode +S
1742 #<module name="m_stripcolor.so">
1744 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1745 # SILENCE module: Adds support for /SILENCE
1746 #<module name="m_silence.so">
1748 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1749 # Extended SILENCE module: Adds support for /SILENCE with additional
1750 # features to silence based on invites, channel messages, etc.
1751 #<module name="m_silence_ext.so">
1753 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1754 # SQLite3 module: Allows other SQL modules to access SQLite3 #
1755 # databases through a unified API. You must link the source for this #
1756 # module from the directory src/modules/extra to src/modules, plus #
1757 # the file m_sqlv2.h #
1758 #<module name="m_sqlite3.so">
1760 #-#-#-#-#-#-#-#-#-#-#-#- SQL CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#-#
1762 # m_sqlite.so is more complex than described here, see the wiki for #
1763 # more: http://www.inspircd.org/wiki/SQLite3_Service_Provider_Module #
1765 #<database hostname="/full/path/to/database.db" id="anytext">
1767 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1768 # SQLutils module: Provides some utilities to SQL client modules, such
1769 # as mapping queries to users and channels. You must copy the source
1770 # for this module from the directory src/modules/extra/m_sqlutils.cpp
1771 # and src/modules/extra/m_sqlutils.h into /src/modules
1772 # Needed for, and loaded before: SQLauth and SQLoper
1773 #<module name="m_sqlutils.so">
1775 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1776 # SQL authentication module: Allows IRCd connections to be tied into
1777 # a database table (for example a forum). You must copy the source for
1778 # this module from the directory src/modules/extra
1779 # Depends on the SQLutils module being loaded first.
1780 #<module name="m_sqlauth.so">
1782 #-#-#-#-#-#-#-#-#-#-#- SQLAUTH CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#
1784 # m_sqlauth.so is too complex it describe here, see the wiki: #
1785 # http://www.inspircd.org/wiki/SQL_Authentication_Module #
1787 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1788 # SQL logging module: Allows you to log network-wide data for your
1789 # network in a fully normalized set of SQL tables. You must copy the
1790 # source for this module from the directory src/modules/extra
1791 #<module name="m_sqllog.so">
1793 #-#-#-#-#-#-#-#-#-#-#- SQLLOG CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#
1795 # dbid - Database ID to use (see m_sql) #
1797 # See also: http://www.inspircd.org/wiki/SQL_Logging_Module #
1801 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1802 # SQL oper module: Allows you to store oper credentials in an SQL table
1803 # You must copy the source for this module from the directory src/modules/extra
1804 # Depends on the SQLutils module being loaded first.
1805 #<module name="m_sqloper.so">
1807 #-#-#-#-#-#-#-#-#-#-#- SQLOPER CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#
1809 # dbid - Database ID to use (see m_sql) #
1811 # See also: http://www.inspircd.org/wiki/SQL_Oper_Storage_Module #
1815 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1816 # SVSHold module: Implements SVSHOLD. Like Q:Lines, but can only be #
1817 # added/removed by Services. #
1818 #<module name="m_svshold.so">
1821 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1822 # SWHOIS module: Allows you to add arbitary lines to user WHOIS.
1823 #<module name="m_swhois.so">
1825 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1826 # Test command module: Does nothing significant. Read: pointless.
1827 #<module name="m_testcommand.so">
1829 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1830 # Timed bans module: Adds timed bans and the /TBAN command
1831 #<module name="m_timedbans.so">
1833 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1834 # Test line module: Adds the /TLINE command, used to test how many
1835 # users a /GLINE or /ZLINE etc would match.
1836 #<module name="m_tline.so">
1838 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1839 # Uninvite module: Adds the /UNINVITE command which lets users remove
1840 # pending invites from channels without waiting for the user to join.
1841 #<module name="m_uninvite.so">
1843 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1844 # Userip module: Adds the /USERIP command
1845 #<module name="m_userip.so">
1847 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1848 # Vhost module: Adds the VHOST command which allows for adding virtual
1849 # hosts which are accessible using a username and password in the config.
1850 #<module name="m_vhost.so">
1852 #-#-#-#-#-#-#-#-#-#-#- VHOST CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#-#
1854 # user - Username for the vhost. #
1856 # pass - Password for the vhost. #
1858 # host - Vhost to set. #
1860 #<vhost user="some_username" pass="some_password" host="some.host">
1862 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1863 # Watch module: Adds the WATCH command, which is used by clients to
1864 # maintain notify lists.
1865 #<module name="m_watch.so">
1867 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1868 # ZipLinks module: Adds support for zlib deflate on server to server
1869 # connections. Both ends of the connection must load this module.
1871 #<module name="m_ziplink.so">
1873 # To use this module, you must enable it as a transport type in your
1874 # <link> tags or <bind> tags using the transport name 'zip'.
1875 # See the documentation of <link> and <bind>, respectively.
1878 #-#-#-#-#-#-#-#-#-#-#-#-#-#- BAN OPTIONS -#-#-#-#-#-#-#-#-#-#-#-#-#-#
1880 # The ban tags define nick masks, host masks and ip ranges which are #
1881 # banned from your server. All details in these tags are local to #
1885 # badip lines ban an ip range (same as a zline) #
1887 # ipmask - The ip range to ban (wildcards possible) #
1888 # CIDR is supported in the IP mask. #
1889 # reason - Reason to display when disconnected #
1891 # badnick lines ban a nick mask (same as a qline) #
1893 # nick - Nick mask to ban (wildcards possible) #
1894 # reason - Reason to display on /NICK #
1896 # badhost lines ban a user@host mask (same as a kline) #
1898 # host - ident@hostname (wildcards possible) #
1899 # If you specify an IP, CIDR is supported. #
1900 # reason - Reason to display on disconnection #
1902 # exception lines define a hostmask that is excempt from [kzg]lines #
1904 # host - ident@hostname (wildcards possible) #
1905 # If you specify an IP, CIDR is supported. #
1906 # reason - Reason, shown only in /stats e #
1909 <badip ipmask="69.69.69.69" reason="No porn here thanks.">
1911 <badnick nick="ChanServ" reason="Reserved For Services">
1912 <badnick nick="NickServ" reason="Reserved For Services">
1913 <badnick nick="OperServ" reason="Reserved For Services">
1914 <badnick nick="MemoServ" reason="Reserved For Services">
1916 <badhost host="*@hundredz.n.hundredz.o.1337.kiddies.com" reason="Too many 1337 kiddiots">
1917 <badhost host="*@localhost" reason="No irc from localhost!">
1918 <badhost host="*@172.32.0.0/16" reason="This subnet is bad.">
1920 <exception host="*@ircop.host.com" reason="Opers hostname">
1922 #-#-#-#-#-#-#-#-#-#-#- INSANE BAN OPTIONS -#-#-#-#-#-#-#-#-#-#-#-#-#-#
1924 # This optional tag allows you to specify how wide a gline, eline, #
1925 # kline, zline or qline can be before it is forbidden from being #
1926 # set. By setting hostmasks="yes", you can allow all G, K, E lines, #
1927 # no matter how many users the ban would cover. This is not #
1928 # recommended! By setting ipmasks="yes", you can allow all Z lines, #
1929 # no matter how many users these cover too. Needless to say we #
1930 # don't recommend you do this, or, set nickmasks="yes", which will #
1931 # allow any qline. #
1933 # The trigger value indicates how wide any mask will be before it is #
1934 # prevented from being set. The default value is 95.5% if this tag is #
1935 # not defined in your configuration file, meaning that if your #
1936 # network has 1000 users, a gline matching over 955 of them will be #
1937 # prevented from being added. #
1939 # Please note that remote servers (and services) are exempt from #
1940 # these restrictions and expected to enforce their own policies #
1944 <insane hostmasks="no" ipmasks="no" nickmasks="no" trigger="95.5">
1946 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#- YAWN -#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1948 # You should already know what to do here :) #
1950 <die value="No, i wasnt joking. You should probably edit your config *PROPERLY* and try again.">
1953 #########################################################################
1955 # - InspIRCd Development Team - #
1956 # http://www.inspircd.org #
1958 #########################################################################