1 #-#-#-#-#-#-#-#-#-#-#-#-#- MODULE OPTIONS -#-#-#-#-#-#-#-#-#-#-#-#-#
3 # These tags define which modules will be loaded on startup by your #
4 # server. Add modules without any paths. When you make your ircd #
5 # using the 'make' command, all compiled modules will be moved into #
6 # the folder you specified when you ran ./configure. The module tag #
7 # automatically looks for modules in this location. #
8 # If you attempt to load a module outside of this location, either #
9 # in the config, or via /LOADMODULE, you will receive an error. #
11 # By default, ALL modules are commented out. You must uncomment them #
12 # or add lines to your config to load modules. Please refer to #
13 # http://www.inspircd.org/wiki/Modules_List for a list of modules and#
14 # each modules link for any additional conf tags they require. #
16 # You may use wildcards in a <module> tag to load all modules which #
17 # match a glob pattern (e.g. m_sa????.so would load m_sajoin, #
18 # m_sapart, m_saquit and m_sanick) #
20 # ____ _ _____ _ _ ____ _ _ _ #
21 # | _ \ ___ __ _ __| | |_ _| |__ (_)___ | __ )(_) |_| | #
22 # | |_) / _ \/ _` |/ _` | | | | '_ \| / __| | _ \| | __| | #
23 # | _ < __/ (_| | (_| | | | | | | | \__ \ | |_) | | |_|_| #
24 # |_| \_\___|\__,_|\__,_| |_| |_| |_|_|___/ |____/|_|\__(_) #
26 # To link servers to InspIRCd, you MUST load the m_spanningtree #
27 # module, as shown below. If you DO NOT do this, server links will #
28 # NOT work at all. ie. The ports will NOT bind, and /connect will not #
29 # work properly. This is by design, to allow for the implementation #
30 # of other linking protocols in modules in the future. #
32 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
33 # Spanning Tree module - allows linking of servers using the spanning
34 # tree protocol (see the READ THIS BIT section above).
36 #<module name="m_spanningtree.so">
39 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
40 # MD5 Module - Allows other modules to generate MD5 hashes, usually for
41 # cryptographic uses and security.
44 # Other modules such as m_cloaking.so and m_password_hash.so may rely on
45 # this module being loaded to function.
47 #<module name="m_md5.so">
49 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
50 # SHA256 Module - Allows other modules to generate SHA256 hashes,
51 # usually for cryptographic uses and security.
54 # Other modules such as m_password_hash.so may rely on this module being
55 # loaded to function. Certain modules such as m_spanningtree.so will
56 # function without this module but when it is loaded their features will
57 # be enhanced (for example the addition of HMAC authentication).
59 #<module name="m_sha256.so">
60 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
61 # RIPEMD160 Module - Allows other modules to generate RIPEMD160 hashes,
62 # usually for cryptographic uses and security.
65 # Other modules may rely on this module being loaded to function.
66 #<module name="m_ripemd160.so">
68 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
69 # Abbreviation module: Provides the ability to abbreviate commands a-la
71 #<module name="m_abbreviation.so">
73 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
74 # Alias module: Allows you to define server-side command aliases
75 #<module name="m_alias.so">
77 #-#-#-#-#-#-#-#-#-#-#- ALIAS DEFINITIONS -#-#-#-#-#-#-#-#-#-#-#-#-#-#
79 # If you have the m_alias.so module loaded, you may also define #
80 # aliases as shown below. They are commonly used to provide shortcut #
81 # commands to services, however they are not limited to just this use.#
82 # An alias tag requires the following values to be defined in it: #
84 # text - The text to detect as the actual command line, #
85 # Cant contain spaces, but case insensitive. #
86 # You may have multiple aliases with the same #
87 # command name (text="" value), however the first #
88 # found will be executed if its format value is #
89 # matched, or it has no format value. Aliases are #
90 # read from the top of the file to the bottom. #
92 # format - If this is defined, the parameters of the alias #
93 # must match this glob pattern. For example if you #
94 # want the first parameter to start with a # for #
95 # the alias to be executed, set format="#*" in the #
96 # alias definition. Note that the :'s which are #
97 # part of IRC formatted lines will be preserved #
98 # for matching of this text. This value is #
101 # replace - The text to replace 'text' with. Usually this #
102 # will be "PRIVMSG ServiceName :$2-" or similar. #
103 # You may use the variables $1 through $9 in the #
104 # replace string, which refer to the first through #
105 # ninth word in the original string typed by the #
106 # user. You may also use $1- through $9- which #
107 # refer to the first word onwards, through to the #
108 # ninth word onwards, e.g. if the user types the #
109 # command "foo bar baz qux quz" then $3- will hold #
110 # "baz qux quz" and $2 will contain "bar". You may #
111 # also use the special variables: $nick, $ident, #
112 # $host and $vhost, and you may separate multiple #
113 # commands with \n. If you wish to use the ACTUAL #
114 # characters \ and n together in a line, you must #
115 # use the sequence "\\n". #
117 # requires - If you provide a value for 'requires' this means #
118 # the given nickname MUST be online for the alias #
119 # to successfully trigger. If they are not, then #
120 # the user receives a 'no such nick' 401 numeric. #
122 # uline - Defining this value with 'yes', 'true' or '1' #
123 # will ensure that the user given in 'requires' #
124 # must also be on a u-lined server, as well as #
125 # actually being on the network. If the user is #
126 # online, but not on a u-lined server, then an #
127 # oper-alert is sent out as this is possibly signs #
128 # of a user trying to impersonate a service. #
130 # operonly - Defining this value, with a value of 'yes', '1' #
131 # or true will make the alias oper only. If a non- #
132 # oper attempts to use the alias, it will appear #
135 #<alias text="NICKSERV" replace="PRIVMSG NickServ :$2-" requires="NickServ" uline="yes">
136 #<alias text="CHANSERV" replace="PRIVMSG ChanServ :$2-" requires="ChanServ" uline="yes">
137 #<alias text="OPERSERV" replace="PRIVMSG OperServ :$2-" requires="OperServ" uline="yes" operonly="yes">
138 #<alias text="NS" replace="PRIVMSG NickServ :$2-" requires="NickServ" uline="yes">
139 #<alias text="CS" replace="PRIVMSG ChanServ :$2-" requires="ChanServ" uline="yes">
140 #<alias text="OS" replace="PRIVMSG OperServ :$2-" requires="OperServ" uline="yes" operonly="yes">
142 # An example of using the format value to create an alias with two
143 # different behaviours depending on the format of the parameters.
145 #<alias text="ID" format="#*" replace="PRIVMSG ChanServ :IDENTIFY $2 $3"
146 # requires="ChanServ" uline="yes">
148 #<alias text="ID" replace="PRIVMSG NickServ :IDENTIFY $2"
149 # requires="NickServ" uline="yes">
151 # This alias fixes a glitch in xchat 2.6.x and above and the way it
152 # assumes IDENTIFY must be prefixed by a colon (:) character. It should
153 # be placed ABOVE the default NICKSERV alias (the first example) listed
156 #<alias text="NICKSERV" format=":IDENTIFY *" replace="PRIVMSG NickServ :IDENTIFY $3-"
157 # requires="NickServ" uline="yes">
159 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
160 # Allowinvite module: Gives channel mode +A to allow all users to use
161 # /invite, and extban A to deny invite from specific masks
162 #<module name="m_allowinvite.so">
164 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
165 # Alltime module: Shows time on all connected servers at once
166 #<module name="m_alltime.so">
168 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
169 # Antibear security module: Prevents 'bear.txt' based trojans from
170 # connecting to your network by sending them a numeric they can't handle.
171 #<module name="m_antibear.so">
173 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
174 # Antibottler module: Labels bottler leech bots
175 #<module name="m_antibottler.so">
177 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
178 # Auditorium module: Adds channel mode +u which makes everyone else
179 # except you in the channel invisible, used for large meetings etc.
180 #<module name="m_auditorium.so">
182 # Auditorium settings:
184 #<auditorium showops="no" operoverride="no">
187 # Setting this value to yes makes m_auditorium behave like unrealircd
188 # +u channel mode, e.g. ops see users joining, parting, etc, and users
189 # joining the channel see the ops. Without this flag, the mode acts
190 # like ircnet's +a (anonymous channels), showing only the user in the
191 # names list, and not even showing the ops in the list, or showing the
192 # ops that the user has joined.
194 # Setting this value to yes makes m_auditorium affect the userlist for
195 # regular users only. Opers will view all users in the channel normally.
197 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
198 # Ban except module: Adds support for channel ban exceptions (+e)
199 #<module name="m_banexception.so">
201 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
202 # Ban redirection module: Allows bans which redirect to a specified
203 # channel. e.g. +b nick!ident@host#channelbanneduserissentto
204 #<module name="m_banredirect.so">
206 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
207 # Block amsg module: Attempt to block all usage of /amsg and /ame
208 #<module name="m_blockamsg.so">
210 #-#-#-#-#-#-#-#-#-#-#- BLOCKAMSG CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
212 # If you have the m_blockamsg.so module loaded, you can configure it #
213 # with the <blockamsg> tag: #
215 # delay - How many seconds between two messages to force #
216 # them to be recognised as unrelated. #
217 # action - Any of 'notice', 'noticeopers', 'silent', 'kill' #
218 # or 'killopers'. Define how to take action when #
219 # a user uses /amsg or /ame. #
221 #<blockamsg delay="3" action="killopers">
223 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
224 # Block CAPS module: Blocking all-CAPS messages with cmode +B
225 #<module name="m_blockcaps.so">
227 #-#-#-#-#-#-#-#-#-#-#- BLOCKCAPS CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
229 # percent - How many percent of text must be caps before text #
232 # minlen - The minimum length a line must be for the block #
233 # percent to have any effect. #
235 # capsmap - A list of chars to be considered CAPS, this was #
236 # you can add CAPS for your language. Also you can #
237 # add things like ! and space to further lock down #
239 #<blockcaps percent="50"
241 # capsmap="ABCDEFGHIJKLMNOPQRSTUVWXYZ! ">
243 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
244 # Block colour module: Blocking colour-coded messages with cmode +c
245 #<module name="m_blockcolor.so">
247 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
248 # Botmode module: Adds the user mode +B
249 #<module name="m_botmode.so">
251 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
252 # CallerID module: Adds usermode +g which activates hybrid-style
253 # callerid (== block all private messages unless you /accept first)
254 #<module name="m_callerid.so">
256 #-#-#-#-#-#-#-#-#-#-#- CALLERID CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#
257 # maxaccepts - Maximum number of entires a user can add to his #
258 # /accept list. Default is 16 entries. #
259 # operoverride - Can opers (note: ALL opers) ignore callerid mode? #
261 # tracknick - Preserve /accept entries when a user changes nick? #
262 # If no (the default), the user is removed from #
263 # everyone's accept list if he changes nickname. #
264 # cooldown - Amount of time (in seconds) that must pass since #
265 # the last notification sent to a user before he can #
266 # be sent another. Default is 60 (1 minute). #
267 #<callerid maxaccepts="16"
272 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
273 # CAP module: Provides the CAP negotiation mechanism seen in
274 # ratbox-derived ircds
275 #<module name="m_cap.so">
277 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
278 # CBAN module: Lets you disallow channels from being used at runtime.
279 #<module name="m_cban.so">
281 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
282 # Censor module: Adds the channel mode +G
283 #<module name="m_censor.so">
285 #-#-#-#-#-#-#-#-#-#-#- CENSOR CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#
287 # Optional - If you specify to use the m_censor module, then you must #
288 # specify some censor tags. See also: #
289 # http://www.inspircd.org/wiki/Censor_Module #
291 #<include file="censor.conf">
293 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
294 # CGI:IRC module: Adds support for automatic host changing in CGI:IRC
295 # (http://cgiirc.sourceforge.net).
296 #<module name="m_cgiirc.so">
298 #-#-#-#-#-#-#-#-#-#-#-# CGIIRC CONFIGURATION #-#-#-#-#-#-#-#-#-#-#-#-#
300 # Optional - If you specify to use m_cgiirc, then you must specify one
301 # or more cgihost tags which indicate authorised CGI:IRC servers which
302 # will be connecting to your network, and an optional cgiirc tag.
303 # For more information see: http://www.inspircd.org/wiki/CGI-IRC_Module
305 # Set to yes if you want to notice opers when CGI clients connect
306 # <cgiirc opernotice="no">
308 # The type field indicates where the module should get the real
309 # client's IP address from, for further information, please see the
310 # CGI:IRC documentation.
313 # <cgihost type="pass" mask="www.mysite.com"> # Get IP from PASS
314 # <cgihost type="ident" mask="otherbox.mysite.com"> # Get IP from ident
315 # <cgihost type="passfirst" mask="www.mysite.com"> # See the docs
317 # <cgihost type="webirc" pass="foobar"
318 # mask="somebox.mysite.com"> # Get IP from WEBIRC
323 # When you connect CGI:IRC clients, there are two connect classes which
324 # apply to these clients. When the client initially connects, the connect
325 # class which matches the cgi:irc site's host is checked. Therefore you
326 # must raise the maximum local/global clients for this ip as high as you
327 # want to allow cgi clients. After the client has connected and is
328 # determined to be a cgi:irc client, the class which matches the client's
329 # real IP is then checked. You may set this class to a lower value, so that
330 # the real IP of the client can still be restricted to, for example, 3
335 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
336 # Channel create module: Adds snomask +j, which will notify opers of
337 # any new channels that are created
338 #<module name="m_chancreate.so">
340 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
341 # Channel filter module: Allows channel-op defined message
342 # filtering using simple string matches (channel mode +g)
343 #<module name="m_chanfilter.so">
345 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
346 # Channel logging module: used to send snotice output to channels, to
347 # allow staff to centrally monitor and discuss network activity.
349 # The "channel" field is where you want the messages to go, "snomasks"
350 # is what snomasks you want to be sent to that channel. Multiple tags
352 #<module name="m_chanlog.so">
353 #<chanlog snomasks="AOcC" channel="#opers">
355 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
356 # Channelban: Implements extended ban j:, which stops anyone in already
357 # in a channel matching a mask like +b j:#channel*mask from joining.
358 #<module name="m_channelban.so">
360 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
361 # Chanprotect module: gives +q and +a channel modes
362 #<module name="m_chanprotect.so">
364 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
365 # Check module: gives /check
366 # Check is useful for looking up information on channels,
367 # users, IP addresses and hosts.
368 #<module name="m_check.so">
370 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
371 # CHGHOST module: Adds the /CHGHOST command
372 #<module name="m_chghost.so">
374 #-#-#-#-#-#-#-#-# /CHGHOST - /SETHOST CONFIGURATION #-#-#-#-#-#-#-#-#
375 # Optional - If you want to use special chars for hostnames you can #
376 # specify your own custom list of chars with the <hostname> tag: #
378 # charmap - A list of chars accepted as valid by the /CHGHOST #
379 # and /SETHOST commands. Also note that the list is #
381 #<hostname charmap="abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ.-_/0123456789">
383 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
384 # CHGIDENT module: Adds the /CHGIDENT command
385 #<module name="m_chgident.so">
387 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
388 # CHGNAME module: Adds the /CHGNAME command
389 #<module name="m_chgname.so">
391 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
392 # Cloaking module: Adds usermode +x and cloaking support.
393 # Relies on the module m_md5.so being loaded before m_cloaking.so in
394 # the configuration file.
395 #<module name="m_cloaking.so">
397 #-#-#-#-#-#-#-#-#-#-#- CLOAKING CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#
399 # Optional - If you specify the m_cloaking.so module as above, you #
400 # must define cloak keys, and optionally a cloak prefix as shown #
401 # below. When using cloaking, the cloak keys are MANDITORY and must #
402 # be included. However, if prefix is not included, it will default #
403 # to your networks name from the <server> tag. You can also include #
404 # the following optional values: #
406 # ipalways - Always cloak the IP address, not the hostname, #
407 # which doesn't reveal the user's ISP, but #
408 # results in hosts that are harder to read and #
411 # lowercase - Display the cloaked hostnames in lowercase #
412 # characters instead of uppercase #
414 # <cloak key1="0x2AF39F40" #
415 # key2="0x78E10B32" #
416 # key3="0x4F2D2E82" #
417 # key4="0x043A4C81" #
420 # lowercase="false"> #
422 # Please note that the key values will accept any number, and should #
423 # be large numbers. Using small numbers such as "7" or "1924" will #
424 # seriously weaken the security of your cloak. It is recommended you #
425 # use hexdecimal numbers prefixed by "0x", as shown in this example, #
426 # with each key eight hex digits long. #
428 #-#-#-#-#-#-#-#-#-#-#-#- CLOSE MODULE #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
429 # Close module: Allows an oper to close all unregistered connections.
430 #<module name="m_close.so">
432 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
433 # Clones module: Adds an oper command /CLONES for detecting cloned
434 # users. Warning: This module may be resource intensive when its
435 # command is issued, use with care.
436 #<module name="m_clones.so">
438 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
439 # Common channels module: Adds user mode +c, which, when set, requires
440 # that users must share a common channel with you to PRIVMSG or NOTICE
442 #<module name="m_commonchans.so">
444 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
445 # Conn-Join: Allows you to force users to join one or more channels
446 # automatically upon connecting to the server.
447 #<module name="m_conn_join.so">
449 #-#-#-#-#-#-#-#-#-#-#-#- CONNJOIN CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
451 # If you have m_conn_join.so loaded, you can configure it using the
454 #<autojoin channel="#one,#two,#three">
456 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
457 # Conn-Usermodes: Set modes on users when they connect
458 # When this module is loaded <connect:allow> tags may have an optional
459 # modes="" value, which contains modes to add or remove from users
460 # when they connect to the server.
461 #<module name="m_conn_umodes.so">
463 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
464 # Conn-Wait-for-Pong: Don't let a user connect until they PONG
465 #<module name="m_conn_waitpong.so">
467 #-#-#-#-#-#-#-#-#-#-#- WAITPONG CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
469 # If you have the m_conn_waitpong.so module loaded, configure it with #
470 # the <waitpong> tag: #
472 # sendsnotice - Whether to send a snotice on connect, like other #
475 # killonbadreply - Whether to kill the user if they send the wrong #
478 #<waitpong sendsnotice="yes" killonbadreply="yes">
481 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
482 # Channel cycle module. Server side /hop, with +ilk etc bypass.
483 #<module name="m_cycle.so">
485 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
486 # Connectban: Provides IP connection throttling. Any IP range that connects
487 # too many times (configurable) in an hour is zlined for a (configurable)
488 # duration, and their count resets to 0.
490 # ipv4cidr and ipv6cidr allow you to turn the comparison from individual
491 # IP addresses (32 and 128 bits) into CIDR masks, to allow for throttling
492 # over whole ISPs/blocks of IPs, which may be needed to prevent attacks.
494 #<connectban threshold="10" duration="10m" ipv4cidr="32" ipv6cidr="128">
495 # This allows for 10 quits in an hour with a 10 minute ban if that is exceeded.
497 #<module name="m_connectban.so">
499 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
500 # Connection throttle module. Configuration:
501 #<module name="m_connflood.so">
503 #-#-#-#-#-#-#-#-#-#-#- CONTHROTTLE CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
504 # seconds, maxconns - Amount of connections per <seconds>.
506 # timeout - Time to wait after the throttle was activated
507 # before deactivating it. Be aware that the time
508 # is seconds + timeout.
510 # quitmsg - The message that users get if they attempt to
511 # connect while the throttle is active.
513 # bootwait - Amount of time to wait before enforcing the
514 # throttling when the server just booted.
516 #<connflood seconds="30" maxconns="3" timeout="30"
517 # quitmsg="Throttled" bootwait="10">
519 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
520 # Custom title module: Adds the /TITLE command which allows for trusted
521 # users to gain a custom whois line and a optional
522 # vhost can be specified.
523 #<module name="m_customtitle.so">
525 #-#-#-#-#-#-#-#-#-#- CUSTOM TITLE CONFIGURATION -#-#-#-#-#-#-#-#-#-#
526 # name - The username used to identify
527 # password - The password used to identify
528 # host - Allowed hostmask [optional]
529 # title - Title shown in whois
530 # vhost - Displayed host [optional]
532 #<title name="foo" password="bar" title="Official Chat Helper">
533 #<title name="bar" password="foo" host="ident@host.name" title="Official Chat Helper" vhost="helper.network.chat">
535 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
536 # DCCALLOW module: Adds the /DCCALLOW command
537 #<module name="m_dccallow.so">
539 #-#-#-#-#-#-#-#-#-#-#- DCCALLOW CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
540 # blockchat - Whether to block DCC CHAT as well as DCC SEND
541 # length - Default duration of entries in DCCALLOW list
542 # action - Default action to take if no action is specified
543 # can be 'block' or 'allow'
545 # File configuration:
546 # pattern - The glob pattern to match against
547 # action - Action to take if a user attempts to send a file
548 # that matches this pattern, can be 'block' or 'allow'
550 #<dccallow blockchat="yes" length="5m" action="block">
551 #<banfile pattern="*.exe" action="block">
552 #<banfile pattern="*.txt" action="allow">
554 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
556 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
557 # Deaf module: adds support for ircu style usermode +d - deaf to
558 # channel messages and channel notices.
559 #<module name="m_deaf.so">
561 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
562 # Delay join module: Adds the channel mode +D which delays all JOIN
563 # messages from users until they speak. If they quit or part before
564 # speaking, their quit or part message will not be shown to the channel
565 # which helps cut down noise on large channels in a more friendly way
566 # than the auditorium mode. Only channel ops may set the +D mode.
567 #<module name="m_delayjoin.so">
569 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
570 # Deny Channels: Deny Channels from being used by users
571 #<module name="m_denychans.so">
573 #-#-#-#-#-#-#-#-#-#-#- DENYCHAN DEFINITIONS -#-#-#-#-#-#-#-#-#-#-#-#
575 # If you have the m_denychans.so module loaded, you need to specify #
576 # the channels to deny: #
578 # name - The channel name to deny. (glob masks are ok) #
580 # allowopers - If operators are allowed to override the deny. #
582 # reason - Reason given for the deny. #
584 # redirect - Redirect the user to a different channel #
586 #<badchan name="#gods*" allowopers="yes" reason="Tortoises!"> #
587 #<badchan name="#heaven" redirect="#hell" reason="Nice try!"> #
589 # Redirects will not work if the target channel is set +L. #
591 # Additionally, you may specify channels which are allowed, even if #
592 # a badchan tag specifies it would be denied: #
593 #<goodchan name="#godsleeps"> #
594 # Glob masks are accepted here also.
596 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
597 # Devoice Module: Let users devoice themselves.
598 #<module name="m_devoice.so">
600 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
601 # DNS Blacklist Module: Provides support for looking up IPs on one or #
603 #<module name="m_dnsbl.so"> #
605 # For configuration options please see the wiki page for m_dnsbl at #
606 # http://inspircd.org/wiki/DNS_Blacklist_Module #
608 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
609 # Filter module: Provides message filtering, similar to SPAMFILTER.
610 #<module name="m_filter.so">
612 # This module depends upon a regex provider such as m_regex_pcre or #
613 # m_regex_glob to function. You must specify which of these you want #
614 # m_filter to use via the tag below. #
616 # Valid engines are: #
618 # glob - Glob patterns, provided via m_regex_glob.so #
619 # pcre - PCRE regexps, provided via m_regex_pcre.so, needs libpcre #
620 # tre - TRE regexps, provided via m_regex_tre.so, requires libtre #
621 # posix - POSIX regexps, provided via m_regex_posix.so, not availale #
622 # on windows, no dependencies on other operating systems. #
624 #<filteropts engine="glob"> #
626 # Your choice of regex engine must match on all servers network-wide.
628 #-#-#-#-#-#-#-#-#-#-#- FILTER CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#
630 # Optional - If you specify to use the m_filter module, then #
631 # specfiy below the path to the filter.conf file, or define some #
634 #<include file="filter.conf">
636 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
637 # Foobar module: does nothing - historical relic
638 #<module name="m_foobar.so">
640 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
641 # Gecosban: Implements extended ban r:, which stops anyone matching
642 # a mask like +b r:*realname?here* from joining a channel.
643 #<module name="m_gecosban.so">
645 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
646 # GeoIP module: Allows the server admin to ban users by country code.
647 #<module name="m_geoip.so">
649 #-#-#-#-#-#-#-#-#-#-#-# GEOIP CONFIGURATION #-#-#-#-#-#-#-#-#-#-#-#-#
651 # <geoip banunknown="false"> #
653 # Set this value to true or yes to block unknown IP ranges which are #
654 # not in the database (usually LAN addresses, localhost, etc) #
656 # <geoban country="TR" reason="This country not permitted"> #
658 # Use one or more of these tags to ban countries by country code. #
659 # The country code must be in capitals and should be an ISO country #
660 # code such as TR, GB, or US. #
662 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
663 # Globops module: gives /GLOBOPS and SNOMASK +g
664 #<module name="m_globops.so">
666 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
667 # Global load module: Allows loading and unloading of modules network-
668 # wide (USE WITH EXTREME CAUTION!)
669 #<module name="m_globalload.so">
671 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
672 # HELPOP module: Provides the /HELPOP command
673 #<module name="m_helpop.so">
675 #-#-#-#-#-#-#-#-#-#-#-#- HELPOP CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
677 # Optional - If you specify to use the m_helpop.so module, then #
678 # specify below the path to the helpop.conf file, or if you like to #
679 # make a mess, define your helpop tags in this conf. #
681 #<include file="helpop.conf">
683 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
684 # HIDECHANS module: Allows opers to hide their channels list from non-
685 # opers by setting user mode +I on themselves.
686 # <module name="m_hidechans.so">
688 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
689 # HIDEOPER module: Allows opers to hide their oper status from non-
690 # opers by setting user mode +H on themselves.
691 # <module name="m_hideoper.so">
693 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
694 # Hostchange module: Allows a different style of cloaking
695 #<module name="m_hostchange.so">
697 #-#-#-#-#-#-#-#-#-#-#- HOSTCHANGE CONFIGURATION -#-#-#-#-#-#-#-#-#-#
699 # Optional - If you choose to use the m_hostchange.so module. #
700 # Config Help - See http://www.inspircd.org/wiki/Host_Changer_Module #
702 #<host suffix="polarbears.org" separator="." prefix="">
703 #<hostchange mask="*@fbi.gov" action="addnick">
704 #<hostchange mask="*r00t@*" action="suffix">
705 #<hostchange mask="a@b.com" action="set" value="blah.blah.blah">
706 #<hostchange mask="localhost" ports="7000,7001,7005-7007" action="set" value="blahblah.foo">
708 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
709 # httpd module: Provides http server support for InspIRCd
710 #<module name="m_httpd.so">
712 #-#-#-#-#-#-#-#-#-#-#-#- HTTPD CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
714 # Optional - If you choose to use the m_httpd.so module, then you must
715 # specify the port number and other details of your http server:
717 #<http ip="192.168.1.10" host="brainwave" port="32006"
718 # index="/home/brain/inspircd/http/index.html">
720 # You may have as many of these tags as you wish, each with a different
721 # IP, port, host or index file. Each one will act as an independent
725 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
726 # http ACL module: Provides access control lists for m_httpd dependent
727 # modules. Use this module to restrict pages by IP address and by
730 #<module name="m_httpd_acl.so">
732 #-#-#-#-#-#-#-#-#-#-#-#- HTTPD ACL CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
734 # Restrict access to the m_httpd_stats module to all but the local
735 # network and when the correct password is specified:
737 # <httpdacl path="/stats*" types="password,whitelist"
738 # username="secretstuff" password="mypasshere" whitelist="127.0.0.*,10.*">
740 # Deny all connections to all but the main index page:
742 # <httpdacl path="/*" types="blacklist" blacklist="*">
745 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
746 # http config module: Allows the server's configuration to be viewed
747 # over HTTP. Requires m_httpd.so to be loaded for it to function.
748 #<module name="m_httpd_config.so">
750 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
751 # http stats module: Provides basic stats pages over HTTP
752 # Requires m_httpd.so to be loaded for it to function.
753 #<module name="m_httpd_stats.so">
755 #-#-#-#-#-#-#-#-#-#-#-#- HTTPD STATS CONFIGURATION -#-#-#-#-#-#-#-#-#-#
757 #<httpstats stylesheet="http://remote.style/sheet.css">
760 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
761 # Ident: Provides RFC 1413 ident lookup support
762 # When this module is loaded <connect:allow> tags may have an optional
763 # useident="yes|no" boolean value, determining whether or not to lookup
764 # ident on users matching that connect tag.
765 #<module name="m_ident.so">
767 #-#-#-#-#-#-#-#-#-#-#-#- IDENT CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
769 # Optional - If you are using the m_ident.so module, then you can #
770 # specify the timeout for ident lookups here. If not defined, it will #
771 # default to one second. This is a non-blocking timeout which holds #
772 # the user in a 'connecting' state until the lookup is complete. #
773 # The bind value indicates which IP to bind outbound requests to. #
775 #<ident timeout="5" bind="">
777 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
778 # Invite except module: Adds support for channel invite exceptions (+I)
779 #<module name="m_inviteexception.so">
781 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
782 # Invisible module - Adds support for usermode +Q (quiet) which lets an
783 # oper go 'invisible' similar to unrealircd 3.1's +I mode. Note that
784 # opers are still able to see invisible users, and if an oper with +Q
785 # deopers, they will become visible.
787 # IMPORTANT NOTE: To allow this mode to be used by a type of oper, you
788 # must first add the value canquiet="yes" to that oper's type tag.
790 #<module name="m_invisible.so">
792 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
793 # Join flood module: Adds support for join flood protection (+j)
794 #<module name="m_joinflood.so">
796 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
797 # Jump Server module: Adds support for the RPL_REDIR numeric
798 #<module name="m_jumpserver.so">
800 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
801 # Anti-Auto-Rejoin: Adds support for prevention of auto-rejoin (+J)
802 #<module name="m_kicknorejoin.so">
804 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
805 # Knock module: adds the /KNOCK command and +K channel mode
806 #<module name="m_knock.so">
808 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
809 # LDAP authentication module: Adds the ability to authenticate users #
810 # via LDAP. This is an extra module which must be enabled explicitly #
811 # by symlinking it from modules/extra, and requires the OpenLDAP libs #
813 #<module name="m_ldapauth.so"> #
817 # <ldapauth baserdn="ou=People,dc=brainbox,dc=cc" #
819 # server="ldap://brainwave.brainbox.cc" #
820 # allowpattern="Guest*" #
821 # killreason="Access denied" #
822 # searchscope="subtree" #
823 # binddn="cn=Manager,dc=brainbox,dc=cc" #
824 # bindauth="mysecretpass" #
827 # The baserdn indicates the base DN to search in for users. Usually #
828 # this is 'ou=People,dc=yourdomain,dc=yourtld'. #
830 # The attribute value indicates the attribute which is used to locate #
831 # a user account by name. On POSIX systems this is usually 'uid'. #
833 # The server parameter indicates the LDAP server to connect to. The #
834 # ldap:// style scheme before the hostname proper is MANDITORY. #
836 # The allowpattern value allows you to specify a wildcard mask which #
837 # will always be allowed to connect regardless of if they have an #
838 # account, for example guest users. #
840 # Killreason indicates the QUIT reason to give to users if they fail #
843 # The searchscope value indicates the subtree to search under. On our #
844 # test system this is 'subtree'. Your mileage may vary. #
846 # Setting the verbose value causes an oper notice to be sent out for #
847 # every failed authentication to the server, with an error string. #
849 # The binddn and bindauth indicate the DN to bind to for searching, #
850 # and the password for the distinguished name. Some LDAP servers will #
851 # allow anonymous searching in which case these two values do not #
852 # need defining, otherwise they should be set similar to the examples #
855 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
856 # Lock server module: Adds /LOCKSERV and /UNLOCKSERV commands that is #
857 # used to temporarily close/open for new connections to the server. #
858 # These commands require OPER status and that the LOCKSERV UNLOCKSERV #
859 # are specified in a <class> tag that the oper is part of. This is so #
860 # you can control who has access to this possible dangerous command. #
861 # If your server is locked and you got disconnected, do a REHASH from #
862 # shell to open up again.
863 #<module name="m_lockserv.so">
865 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
866 # Msg flood module: Adds message/notice flood protection (+f)
867 #<module name="m_messageflood.so">
869 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
870 # MsSQL module: Allows other SQL modules to access MS SQL Server
871 # through a unified API. You must copy the source for this module
872 # from the directory src/modules/extra, plus the file m_sqlv2.h
873 #<module name="m_mssql.so">
875 #-#-#-#-#-#-#-#-#-#-#-#- SQL CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#-#
877 # m_mssql.so is more complex than described here, see wiki for more #
878 # info http://www.inspircd.org/wiki/SQLServer_Service_Provider_Module #
880 #<database name="db" username="user" password="pass" hostname="localhost" id="db1">
882 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
883 # MySQL module: Allows other SQL modules to access MySQL databases
884 # through a unified API. You must copy the source for this module
885 # from the directory src/modules/extra, plus the file m_sqlv2.h
886 #<module name="m_mysql.so">
888 #-#-#-#-#-#-#-#-#-#-#-#- SQL CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#-#
890 # m_mysql.so is more complex than described here, see the wiki for #
891 # more: http://www.inspircd.org/wiki/SQL_Service_Provider_Module #
893 #<database name="mydb" username="myuser" password="mypass" hostname="localhost" id="my_database2">
895 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
896 # NAMESX module: Provides support for the NAMESX extension which allows
897 # clients to see all the prefixes set on a user without getting confused.
898 # This is supported by mIRC, x-chat, klient, and maybe more.
899 #<module name="m_namesx.so">
901 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
902 # Nickchange flood protection module: Allows up to X nick changes in Y seconds.
903 # Provides channel mode +F.
904 #<module name="m_nickflood.so">
906 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
907 # Nicklock module: Let opers change a user's nick and then stop that
908 # user from changing their nick again.
909 #<module name="m_nicklock.so">
911 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
912 # No ctcp module: Adds the channel mode +C to block CTCPs
913 #<module name="m_noctcp.so">
915 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
916 # No kicks module: Adds the +Q channel mode
917 #<module name="m_nokicks.so">
919 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
920 # No nicks module: Adds the +N channel mode, as well as the +b N:
921 # extended bantype. +N stops all users from changing their nick,
922 # the +b N: extban stops anyone from matching a +b N:nick!user@host
923 # mask from changing their nick.
924 #<module name="m_nonicks.so">
926 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
927 # No Notice module: adds the channel mode +T
928 #<module name="m_nonotice.so">
930 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
931 # Oper channels mode: Adds the +O channel mode
932 #<module name="m_operchans.so">
934 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
935 # Oper flood module: Removes flood limits from users upon opering up
936 #<module name="m_operflood.so">
938 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
939 # Oper invex/extban module: Adds +beI type O, to ban, exempt, and invex
940 # given oper type masks.
941 # e.g, /mode #channel +iI O:* is equivilant to chmode +O, but you
942 # may also, e.g. /mode #channel +iI O:AdminTypeOnly to only allow admins.
944 # +be work in a similar fashion.
946 #<module name="m_operinvex.so">
948 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
949 # Oper Join module: Auto-joins opers to a channel upon oper-up
950 #<module name="m_operjoin.so">
952 #-#-#-#-#-#-#-#-#-#-# OPERJOIN CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
954 # If you are using the m_operjoin.so module, specify options here: #
956 # channel - The channel name to join, can also be a comma #
957 # seperated list eg. "#channel1,#channel2". #
959 # override - Lets the oper join walking thru any modes that #
960 # might be set, even bans. Use "yes" or "no". #
962 #<operjoin channel="#channel" override="no">
964 # Alternatively you can use the autojoin="channellist" in a <type> #
965 # tag to set specific autojoins for a type of oper, for example: #
967 #<type name="Helper" autojoin="#help" classes="...">
969 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
970 # Oper log module: Logs all oper commands to the ircd log at default
972 #<module name="m_operlog.so">
974 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
975 # Oper MOTD module: Provides support for seperate message of the day
977 #<module name="m_opermotd.so">
979 #-#-#-#-#-#-#-#-#-#-# OPERMOTD CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
981 # If you are using the m_opermotd.so module, specify the motd here #
983 #<opermotd file="oper.motd">
985 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
986 # Override module: Adds support for oper override
987 #<module name="m_override.so">
989 #-#-#-#-#-#-#-#-#-#-# OVERRIDE CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
991 # m_override.so is too complex it describe here, see the wiki: #
992 # http://www.inspircd.org/wiki/Oper_Override_Module #
994 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
995 # Oper levels module: Gives each oper a level and prevents
996 # actions being taken against higher level opers
997 # Specify the level as the 'level' parameter of the <type> tag
998 #<module name="m_operlevels.so">
1000 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1001 # Oper modes module: Allows you to specify modes to add/remove on oper
1002 # Specify the modes as the 'modes' parameter of the <type> tag
1003 # and/or as the 'modes' parameter of the <oper> tag.
1004 #<module name="m_opermodes.so">
1006 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1007 # Oper password hash module: Allows hashed oper passwords
1008 # Relies on the module m_md5.so and/or m_sha256.so being loaded before
1009 # m_password_hash.so in the configuration file.
1010 #<module name="m_password_hash.so">
1012 #-#-#-#-#-#-#-#-#-#-# OPER HASH CONFIGURATION #-#-#-#-#-#-#-#-#-#-#-#-#
1014 # To use this module, you must define a hash type for each oper's
1015 # password you want to hash. For example:
1017 # <oper name="Brain"
1018 # host="ident@dialup15.isp.com"
1020 # password="a41d730937a53b79f788c0ab13e9e1d5"
1023 # The types of hashing available vary depending on which hashing modules
1024 # you load, but usually if you load m_sha256.so and m_md5.so, both md5
1025 # and sha256 type hashing will be available (the most secure of which
1028 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1029 # Permanent Channels module: Channels with the permanent channels mode
1030 # will remain open even after everyone else has left the channel, and
1031 # therefore keep things like modes, ban lists and topic. Permanent
1032 # channels -may- need support from your Services package to function
1033 # properly with them. This adds channel mode +P.
1034 #<module name="m_permchannels.so">
1036 # You may also create channels on startup by using the <permchannels> block.
1037 #<permchannels channel="#opers" modes="is" topic="Opers only.">
1039 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1040 # PostgreSQL module: Allows other SQL modules to access PgSQL databases
1041 # through a unified API. You must copy the source for this module
1042 # from the directory src/modules/extra, plus the file m_sqlv2.h
1043 #<module name="m_pgsql.so">
1045 #-#-#-#-#-#-#-#-#-#-#-#- SQL CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#-#
1047 # m_pgsql.so is more complex than described here, see the wiki for #
1048 # more: http://www.inspircd.org/wiki/SQL_Service_Provider_Module #
1050 #<database name="mydb" username="myuser" password="mypass" hostname="localhost" id="my_database" ssl="no">
1052 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1053 # Muteban: Implements extended ban m:, which stops anyone matching
1054 # a mask like +b m:nick!user@host from speaking on channel.
1055 #<module name="m_muteban.so">
1058 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1059 # Random Quote module: provides a random quote on connect.
1060 # NOTE: Some of these may mimic fatal errors and confuse users and
1061 # opers alike! - BEWARE!
1062 #<module name="m_randquote.so">
1064 #-#-#-#-#-#-#-#-#-#- RANDOMQUOTES CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
1066 # Optional - If you specify to use the m_randquote.so module, then #
1067 # specify below the path to the randquotes.conf file. #
1069 #<randquote file="randquotes.conf">
1071 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1072 # Redirect module: Adds channel redirection (mode +L)
1073 #<module name="m_redirect.so">
1075 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1076 # Regular Expression Provider for Glob or wildcard (?/*) matching.
1077 # You must have at least 1 provider loaded to use m_filter or m_rline
1078 # modules. This module has no additional requirements, as it uses the
1079 # matching already present in InspIRCd core.
1080 #<module name="m_regex_glob.so">
1082 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1083 # Regular Expression Provider for PCRE (Perl-Compatible Regular
1084 # Expressions). You need libpcre installed to compile and load this
1085 # module. You must have at least 1 provider loaded to use m_filter or
1087 #<module name="m_regex_pcre.so">
1089 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1090 # Regular Expression Provider for POSIX Regular Expressions.
1091 # You shouldn't need any additional libraries on a POSIX-compatible
1092 # system (ie: any Linux, BSD, but not Windows). You must have at least
1093 # 1 provider loaded to use m_filter or m_rline.
1094 # On POSIX-compliant systems, regex syntax can be found by using the
1095 # command: 'man 7 regex'.
1096 #<module name="m_regex_posix.so">
1098 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1099 # Regular Expression Provider for TRE Regular Expressions.
1100 # This is the same regular expression engine used by UnrealIRCd, so
1101 # if you are most familiar with the syntax of /spamfilter from there,
1102 # this is the provider you want. You need libtre installed in order
1103 # to compile and load this module.
1104 #<module name="m_regex_tre.so">
1106 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1107 # Registered users only channel creation
1108 # Allows only registered users and opers to create new channels.
1109 #<module name="m_regonlycreate.so">
1111 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1112 # Remove module: Adds the /REMOVE command which is a peaceful
1113 # alternative to /KICK
1114 #<module name="m_remove.so">
1116 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1117 # Restrict banned users module:
1118 # Disallows banned users on a channel from messaging the channel,
1119 # changing nick, or changing the topic, if loaded.
1120 #<module name="m_restrictbanned.so">
1122 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1123 # Restricted channels module: Allows only opers to create channels
1124 #<module name="m_restrictchans.so">
1126 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1127 # Restrict message module: Allows users to only message opers
1128 #<module name="m_restrictmsg.so">
1130 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1131 # Ban users through regular expression patterns
1132 #<module name="m_rline.so">
1134 #-#-#-#-#-#-#-#-#-#-#-#- RLINE CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#-#
1136 # If you wish to re-check a user when they change nickname (can be
1137 # useful under some situations, but *can* also use CPU with more users
1138 # on a server) then set the following configuration value:
1139 # Also, this is where you set what Regular Expression engine is to be
1140 # used. If you ever change it while running, all of your R-Lines will be
1141 # wiped. This is the regex engine used by all R-Lines set, and
1142 # m_regex_<engine>.so must be loaded, or rline will be nonfunctional
1143 # until you load it or change the engine to one that is loaded.
1145 #<rline matchonnickchange="yes" engine="pcre">
1147 # Generally, you will NOT want to use 'glob' here, as this turns
1148 # rline into just another gline. The exceptions are that rline will
1149 # always use the full nick!user@host realname string, rather than only
1150 # user@host, but beware that only the ? and * wildcards are available,
1151 # and are the only way to specify where the space can occur if you do
1152 # use glob. For this reason, is recommended to use a real regex engine
1153 # so that at least \s or [[:space:]] is available.
1155 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1156 # JSON-RPC module: Encode and decode JSON-RPC requests for modules
1157 #<module name="m_rpc_json.so">
1159 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1160 # RPC test module: A test of the RPC API
1161 #<module name="m_rpctest.so">
1163 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1164 # Provide /LIST throttling (to prevent flooding) and /LIST safety to
1165 # prevent excess flood when the list is large.
1166 #<module name="m_safelist.so">
1168 #-#-#-#-#-#-#-#-#-#-# SAFELIST CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#-#
1170 # When using Safelist, you may set the following values;
1172 # The first value, 'throttle', sets the amount of time in seconds a user
1173 # must wait between LIST commands. For example, if this is set to 60
1174 # (the default) then the user may not /LIST more than once a minute.
1175 # If not defined, the default value is 60 seconds.
1177 # The second value, 'maxlisters', indicates the maximum number of users
1178 # which may be retrieving a LIST at once. It is not recommended you raise
1179 # this value, as increasing it too high can make your network vulnerable
1180 # to floodbots which waste your bandwidth and CPU time with LIST requests.
1182 #<safelist throttle="60" maxlisters="50">
1184 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1185 # SAJOIN module: Adds the /SAJOIN command
1186 #<module name="m_sajoin.so">
1188 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1189 # SAMODE module: Adds the oper /SAMODE command
1190 #<module name="m_samode.so">
1192 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1193 # SANICK module: Allows opers to change user's nicks
1194 #<module name="m_sanick.so">
1196 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1197 # SAPART module: Adds the oper /SAPART command
1198 #<module name="m_sapart.so">
1200 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1201 # SAQUIT module: Adds the oper /SAQUIT command (abusable!!!)
1202 #<module name="m_saquit.so">
1204 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1205 # SASL authentication module: Provides support for IRC Authentication
1206 # Layer (aka: atheme SASL) via AUTHENTICATE.
1207 #<module name="m_sasl.so">
1209 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1210 # Secure list module: Prevent /LIST in the first minute of connection,
1211 # crippling most spambots and trojan spreader bots.
1212 #<module name="m_securelist.so">
1214 #-#-#-#-#-#-#-#-#-# SECURELIST CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#-#
1216 # Securelist can be harmful to some irc search engines such as #
1217 # netsplit.de and searchirc.com. To prevent securelist blocking these #
1218 # sites from listing, define exception tags as shown below: #
1219 <securehost exception="*@*.searchirc.org">
1220 <securehost exception="*@*.netsplit.de">
1221 <securehost exception="*@echo940.server4you.de">
1223 # Define the following variable to change how long a user must wait #
1224 # before issuing a LIST. If not defined, defaults to 60 seconds. #
1226 #<securelist waittime="60"> #
1228 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1229 # Servprotect module: Provides support for Austhex style +k /
1230 # UnrealIRCD +S services mode
1231 #<module name="m_servprotect.so">
1233 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1234 # See nicks module: Allow for SNOMASK +N which shows nick changes.
1235 #<module name="m_seenicks.so">
1237 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1238 # Set Idle module: Adds a command for opers to change their
1239 # idle time (mainly a toy)
1240 #<module name="m_setidle.so">
1242 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1243 # Services support module: Adds several usermodes such as +R and +M
1244 # this module implements the 'identified' state via user mode +r, which
1245 # is similar to the DALnet and dreamforge systems.
1248 # >> This CAN NOT be used at the same time as m_services_account <<
1250 #<module name="m_services.so">
1252 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1253 # Services support module: Adds several usermodes such as +R and +M
1254 # this module implements the 'identified' state via account names (AC)
1255 # and is similar in operation to the way asuka and ircu handle services.
1257 # Also of note is that this module implements two extbans:
1258 # +b R: (stop matching account names from joining)
1259 # +b M: (stop matching account names from speaking)
1262 # >> This CAN NOT be used at the same time as m_services <<
1264 #<module name="m_services_account.so">
1266 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1267 # Sethost module: Adds the /SETHOST command
1268 # See m_chghost for how to customise valid chars for hostnames
1269 #<module name="m_sethost.so">
1271 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1272 # Setident module: Adds the /SETIDENT command
1273 #<module name="m_setident.so">
1275 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1276 # SETNAME module: Adds the /SETNAME command
1277 #<module name="m_setname.so">
1279 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1280 # Serverban: Implements extended ban s:, which stops anyone connected
1281 # to a server matching a mask like +b s:server.mask.here from joining.
1282 #<module name="m_serverban.so">
1284 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1285 # Show Whois module: Adds the +W usermode which allows opers
1286 # to see when they are whois'ed (can be annoying).
1287 #<module name="m_showwhois.so">
1289 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1290 # Shun module: Provides the /shun command, which stops a user executing
1292 #<module name="m_shun.so">
1294 # You may also configure which commands you wish a user to be able to
1295 # perform. It should be noted that if a shunned user issues QUIT or PART
1296 # then their message will be removed, as if they did not issue one.
1298 # You may also (optionally) let the user know that their command was blocked.
1299 #<shun enabledcommands="PING PONG QUIT PART JOIN" notifyuser="yes">
1301 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1302 # Spy module: Provides the ability to see the complete names list of
1303 # channels an oper is not a member of
1304 #<module name="m_spy.so">
1306 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1307 # SSL channel mode module: Adds support for SSL-only channels (+z).
1308 # does not do anything useful without a working SSL module (see below)
1309 #<module name="m_sslmodes.so">
1311 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1312 # Dummy ssl module: If you have other servers on your network which
1313 # have SSL, but your server does not have ssl enabled, you should load
1314 # this module, which will handle SSL metadata (e.g. the "Is using ssl"
1315 # field in the WHOIS information).
1316 #<module name="m_ssl_dummy.so">
1318 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1319 # GnuTLS ssl module: Adds support for client-server SSL using GnuTLS,
1320 # if enabled. You must copy the source for this module from the directory
1321 # src/modules/extra, or answer 'yes' in ./configure when asked if you
1322 # want to enable this, or it will not load.
1323 #<module name="m_ssl_gnutls.so">
1325 #-#-#-#-#-#-#-#-#-#-#- GNUTLS CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#
1327 # m_ssl_gnutls.so is too complex it describe here, see the wiki: #
1328 # http://www.inspircd.org/wiki/GnuTLS_SSL_Module #
1330 # NOTE: If you want to use this module to encrypt and sign your #
1331 # server to server traffic, you MUST load it before m_spanningtree in #
1332 # your configuration file! #
1334 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1335 # SSL Info module: Allows users to retrieve information about other
1336 # user's peer SSL certificates and keys. This can be used by client
1337 # scripts to validate users. For this to work, one of m_ssl_gnutls.so
1338 # or m_ssl_openssl.so must be loaded. You must symlink the source for
1339 # this module from the directory src/modules/extra.
1340 #<module name="m_sslinfo.so">
1342 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1343 # OpenSSL ssl module: Adds support for client-server SSL using OpenSSL,
1344 # if enabled. You must copy the source for this module from the directory
1345 # src/modules/extra, or answer 'yes' in ./configure when asked if you
1346 # want to enable this, or it will not load.
1347 #<module name="m_ssl_openssl.so">
1349 #-#-#-#-#-#-#-#-#-#-#- OPENSSL CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#
1351 # m_ssl_openssl.so is too complex it describe here, see the wiki: #
1352 # http://www.inspircd.org/wiki/OpenSSL_SSL_Module #
1354 # NOTE: If you want to use this module to encrypt and sign your #
1355 # server to server traffic, you MUST load it before m_spanningtree in #
1356 # your configuration file! #
1358 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1359 # SSL Cert Oper module: Allows opers to oper up using the key fingerprint
1360 # stored within their SSL certificate and key pair.
1361 # When using this module, one of m_ssl_gnutls.so or m_ssl_openssl.so must
1362 # be loaded. An extra value should be added to enabled opers, which
1363 # is in the following format: fingerprint="<hash>". For more information,
1364 # see the example in the oper blocks.
1365 #<module name="m_ssl_oper_cert.so">
1367 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1368 # Strip colour module: Adds the channel mode +S
1369 #<module name="m_stripcolor.so">
1371 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1372 # SILENCE module: Adds support for /SILENCE
1373 #<module name="m_silence.so">
1375 # Configuration tags:
1377 #<silence maxentries="32">
1379 # Sets the maximum number of entries on a users silence list.
1381 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1382 # SQLite3 module: Allows other SQL modules to access SQLite3 #
1383 # databases through a unified API. You must link the source for this #
1384 # module from the directory src/modules/extra to src/modules, plus #
1385 # the file m_sqlv2.h #
1386 #<module name="m_sqlite3.so">
1388 #-#-#-#-#-#-#-#-#-#-#-#- SQL CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#-#
1390 # m_sqlite.so is more complex than described here, see the wiki for #
1391 # more: http://www.inspircd.org/wiki/SQLite3_Service_Provider_Module #
1393 #<database hostname="/full/path/to/database.db" id="anytext">
1395 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1396 # SQLutils module: Provides some utilities to SQL client modules, such
1397 # as mapping queries to users and channels. You must copy the source
1398 # for this module from the directory src/modules/extra/m_sqlutils.cpp
1399 # and src/modules/extra/m_sqlutils.h into /src/modules
1400 # Needed for, and loaded before: SQLauth and SQLoper
1401 #<module name="m_sqlutils.so">
1403 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1404 # SQL authentication module: Allows IRCd connections to be tied into
1405 # a database table (for example a forum). You must copy the source for
1406 # this module from the directory src/modules/extra
1407 # Depends on the SQLutils module being loaded first.
1408 #<module name="m_sqlauth.so">
1410 #-#-#-#-#-#-#-#-#-#-#- SQLAUTH CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#
1412 # m_sqlauth.so is too complex it describe here, see the wiki: #
1413 # http://www.inspircd.org/wiki/SQL_Authentication_Module #
1415 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1416 # SQL logging module: Allows you to log network-wide data for your
1417 # network in a fully normalised set of SQL tables. You must copy the
1418 # source for this module from the directory src/modules/extra
1419 #<module name="m_sqllog.so">
1421 #-#-#-#-#-#-#-#-#-#-#- SQLLOG CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#
1423 # dbid - Database ID to use (see m_sql) #
1425 # See also: http://www.inspircd.org/wiki/SQL_Logging_Module #
1429 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1430 # SQL oper module: Allows you to store oper credentials in an SQL table
1431 # You must copy the source for this module from the directory src/modules/extra
1432 # Depends on the SQLutils module being loaded first.
1433 #<module name="m_sqloper.so">
1435 #-#-#-#-#-#-#-#-#-#-#- SQLOPER CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#
1437 # dbid - Database ID to use (see m_sql) #
1438 # hash - Hashing provider to use for password hashing #
1440 # See also: http://www.inspircd.org/wiki/SQL_Oper_Storage_Module #
1442 #<sqloper dbid="1" hash="md5">
1444 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1445 # SVSHold module: Implements SVSHOLD. Like Q:Lines, but can only be #
1446 # added/removed by Services. #
1447 #<module name="m_svshold.so">
1449 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1450 # SWHOIS module: Allows you to add arbitary lines to user WHOIS.
1451 #<module name="m_swhois.so">
1453 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1454 # Taxonomy module: Adds the /TAXONOMY command, used to view all
1455 # metadata attached to a user.
1456 #<module name="m_taxonomy.so">
1458 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1459 # Test command module: Does nothing significant. Read: pointless.
1460 #<module name="m_testcommand.so">
1462 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1463 # Timed bans module: Adds timed bans and the /TBAN command
1464 #<module name="m_timedbans.so">
1466 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1467 # Test line module: Adds the /TLINE command, used to test how many
1468 # users a /GLINE or /ZLINE etc would match.
1469 #<module name="m_tline.so">
1471 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1472 # UHNAMES support module: Adds support for the IRCX style UHNAMES
1473 # extension, which displays ident and hostname in the names list for
1474 # each user, saving clients from doing a WHO on the channel. Note that
1475 # this module is not widely supported yet. If a client does not support
1476 # UHNAMES it will not enable it, this will not break incompatible
1478 #<module name="m_uhnames.so">
1480 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1481 # Uninvite module: Adds the /UNINVITE command which lets users remove
1482 # pending invites from channels without waiting for the user to join.
1483 #<module name="m_uninvite.so">
1485 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1486 # Userip module: Adds the /USERIP command
1487 #<module name="m_userip.so">
1489 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1490 # Vhost module: Adds the VHOST command which allows for adding virtual
1491 # hosts which are accessible using a username and password in the config.
1492 #<module name="m_vhost.so">
1494 #-#-#-#-#-#-#-#-#-#-#- VHOST CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#-#
1496 # user - Username for the vhost. #
1498 # pass - Password for the vhost. #
1500 # host - Vhost to set. #
1502 #<vhost user="some_username" pass="some_password" host="some.host">
1504 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1505 # Watch module: Adds the WATCH command, which is used by clients to
1506 # maintain notify lists.
1507 #<module name="m_watch.so">
1509 # Configuration tags:
1511 #<watch maxentries="32">
1513 # Sets the maximum number of entries on a user's watch list.
1515 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1516 # XLine database: Stores all *Lines (G/Z/K/R/any added by other modules)
1517 # in a file "xline.db" which can be re-loaded on restart. This is useful
1518 # for two reasons: it keeps bans so users may not evade them, and on
1519 # bigger networks, server connections will take less time as there will
1520 # be a lot less bans to apply - as most of them will already be there.
1521 #<module name="m_xline_db.so">
1523 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1524 # ZipLinks module: Adds support for zlib deflate on server to server
1525 # connections. Both ends of the connection must load this module.
1527 #<module name="m_ziplink.so">
1529 # To use this module, you must enable it as a transport type in your
1530 # <link> tags or <bind> tags using the transport name 'zip'.
1531 # See the documentation of <link> and <bind>, respectively.