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://wiki.inspircd.org/Modules 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. Since several features (like SSL server links) rely on #
28 # other modules being loaded before m_spanningtree, the module itself #
29 # is at the bottom of this file. DO NOT forget to load it. If you DO #
30 # NOT do this, server links will NOT work at all. ie. The ports will #
31 # NOT bind, and /connect will not work properly. This is by design, #
32 # to allow for the implementation of other linking protocols in #
33 # modules in the future. #
36 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
37 # MD5 Module - Allows other modules to generate MD5 hashes, usually for
38 # cryptographic uses and security.
41 # Other modules such as m_cloaking.so and m_password_hash.so may rely on
42 # this module being loaded to function.
44 #<module name="m_md5.so">
46 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
47 # SHA256 Module - Allows other modules to generate SHA256 hashes,
48 # usually for cryptographic uses and security.
51 # Other modules such as m_password_hash.so may rely on this module being
52 # loaded to function. Certain modules such as m_spanningtree.so will
53 # function without this module but when it is loaded their features will
54 # be enhanced (for example the addition of HMAC authentication).
56 #<module name="m_sha256.so">
57 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
58 # RIPEMD160 Module - Allows other modules to generate RIPEMD160 hashes,
59 # usually for cryptographic uses and security.
62 # Other modules may rely on this module being loaded to function.
63 #<module name="m_ripemd160.so">
65 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
66 # Abbreviation module: Provides the ability to abbreviate commands a-la
68 #<module name="m_abbreviation.so">
70 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
71 # Alias module: Allows you to define server-side command aliases
72 #<module name="m_alias.so">
76 #<fantasy prefix="!" allowbots="no">
79 # Set the prefix for in-channel aliases (fantasy commands) to the
80 # specified character. If not set, the default is "!".
82 # If this is set to no, +B clients will not be able to use fantasy
83 # commands. If not set, the default is no.
85 #-#-#-#-#-#-#-#-#-#-#- ALIAS DEFINITIONS -#-#-#-#-#-#-#-#-#-#-#-#-#-#
87 # If you have the m_alias.so module loaded, you may also define #
88 # aliases as shown below. They are commonly used to provide shortcut #
89 # commands to services, however they are not limited to just this use.#
90 # An alias tag requires the following values to be defined in it: #
92 # text - The text to detect as the actual command line, #
93 # Cant contain spaces, but case insensitive. #
94 # You may have multiple aliases with the same #
95 # command name (text="" value), however the first #
96 # found will be executed if its format value is #
97 # matched, or it has no format value. Aliases are #
98 # read from the top of the file to the bottom. #
100 # usercommand - If this is true, the alias can be run simply as #
101 # /aliasname. Defaults to true. #
103 # channelcommand - If this is true, the alias can be used as an #
104 # in-channel alias or 'fantasy command', prefixed #
105 # by the fantasy prefix character, !aliasname by #
106 # default. Defaults to false. #
108 # format - If this is defined, the parameters of the alias #
109 # must match this glob pattern. For example if you #
110 # want the first parameter to start with a # for #
111 # the alias to be executed, set format="#*" in the #
112 # alias definition. Note that the :'s which are #
113 # part of IRC formatted lines will be preserved #
114 # for matching of this text. This value is #
117 # replace - The text to replace 'text' with. Usually this #
118 # will be "PRIVMSG ServiceName :$2-" or similar. #
119 # You may use the variables $1 through $9 in the #
120 # replace string, which refer to the first through #
121 # ninth word in the original string typed by the #
122 # user. You may also use $1- through $9- which #
123 # refer to the first word onwards, through to the #
124 # ninth word onwards, e.g. if the user types the #
125 # command "foo bar baz qux quz" then $3- will hold #
126 # "baz qux quz" and $2 will contain "bar". You may #
127 # also use the special variables: $nick, $ident, #
128 # $host and $vhost, and you may separate multiple #
129 # commands with \n. If you wish to use the ACTUAL #
130 # characters \ and n together in a line, you must #
131 # use the sequence "\\n". #
133 # requires - If you provide a value for 'requires' this means #
134 # the given nickname MUST be online for the alias #
135 # to successfully trigger. If they are not, then #
136 # the user receives a 'no such nick' 401 numeric. #
138 # uline - Defining this value with 'yes', 'true' or '1' #
139 # will ensure that the user given in 'requires' #
140 # must also be on a u-lined server, as well as #
141 # actually being on the network. If the user is #
142 # online, but not on a u-lined server, then an #
143 # oper-alert is sent out as this is possibly signs #
144 # of a user trying to impersonate a service. #
146 # operonly - Defining this value, with a value of 'yes', '1' #
147 # or true will make the alias oper only. If a non- #
148 # oper attempts to use the alias, it will appear #
151 #<alias text="NICKSERV" replace="PRIVMSG NickServ :$2-" requires="NickServ" uline="yes">
152 #<alias text="CHANSERV" replace="PRIVMSG ChanServ :$2-" requires="ChanServ" uline="yes">
153 #<alias text="OPERSERV" replace="PRIVMSG OperServ :$2-" requires="OperServ" uline="yes" operonly="yes">
154 #<alias text="NS" replace="PRIVMSG NickServ :$2-" requires="NickServ" uline="yes">
155 #<alias text="CS" replace="PRIVMSG ChanServ :$2-" requires="ChanServ" uline="yes">
156 #<alias text="OS" replace="PRIVMSG OperServ :$2-" requires="OperServ" uline="yes" operonly="yes">
158 # An example of using the format value to create an alias with two
159 # different behaviours depending on the format of the parameters.
161 #<alias text="ID" format="#*" replace="PRIVMSG ChanServ :IDENTIFY $2 $3"
162 # requires="ChanServ" uline="yes">
164 #<alias text="ID" replace="PRIVMSG NickServ :IDENTIFY $2"
165 # requires="NickServ" uline="yes">
167 # This alias fixes a glitch in xchat 2.6.x and above and the way it
168 # assumes IDENTIFY must be prefixed by a colon (:) character. It should
169 # be placed ABOVE the default NICKSERV alias (the first example) listed
172 #<alias text="NICKSERV" format=":IDENTIFY *" replace="PRIVMSG NickServ :IDENTIFY $3-"
173 # requires="NickServ" uline="yes">
175 # You may also add aliases to trigger based on something said in a
176 # channel, aka 'fantasy' commands, configured in the same manner as any
177 # other alias, with usercommand="no" and channelcommand="yes" The
178 # command must be preceded by the fantasy prefix when used.
180 #<alias text="CS" usercommand="no" channelcommand="yes"
181 # replace="PRIVMSG ChanServ :$1 $chan $2-" requires="ChanServ" uline="yes">
183 # This would be used as "!cs <command> <options>", with the channel
184 # being automatically inserted after the command in the message to
185 # ChanServ, assuming the fantasy prefix is "!".
187 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
188 # Allowinvite module: Gives channel mode +A to allow all users to use
189 # /invite, and extban A to deny invite from specific masks
190 #<module name="m_allowinvite.so">
192 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
193 # Alltime module: Shows time on all connected servers at once.
194 # This module is oper-only and provides /alltime.
195 # To use, ALLTIME must be in one of your oper class blocks.
196 #<module name="m_alltime.so">
198 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
199 # Antibear security module: Prevents 'bear.txt' based trojans from
200 # connecting to your network by sending them a numeric they can't handle.
201 #<module name="m_antibear.so">
203 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
204 # Antibottler module: Labels bottler leech bots
205 #<module name="m_antibottler.so">
207 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
208 # Auditorium module: Adds channel mode +u which makes everyone else
209 # except you in the channel invisible, used for large meetings etc.
210 #<module name="m_auditorium.so">
212 # Auditorium settings:
214 #<auditorium showops="no" operoverride="no">
217 # Setting this value to yes makes m_auditorium behave like unrealircd
218 # +u channel mode, e.g. ops see users joining, parting, etc, and users
219 # joining the channel see the ops. Without this flag, the mode acts
220 # like ircnet's +a (anonymous channels), showing only the user in the
221 # names list, and not even showing the ops in the list, or showing the
222 # ops that the user has joined.
224 # Setting this value to yes makes m_auditorium affect the userlist for
225 # regular users only. Opers will view all users in the channel normally.
227 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
228 # Ban except module: Adds support for channel ban exceptions (+e)
229 #<module name="m_banexception.so">
231 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
232 # Ban redirection module: Allows bans which redirect to a specified
233 # channel. e.g. +b nick!ident@host#channelbanneduserissentto
234 #<module name="m_banredirect.so">
236 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
237 # Block amsg module: Attempt to block all usage of /amsg and /ame
238 #<module name="m_blockamsg.so">
240 #-#-#-#-#-#-#-#-#-#-#- BLOCKAMSG CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
242 # If you have the m_blockamsg.so module loaded, you can configure it #
243 # with the <blockamsg> tag: #
245 # delay - How many seconds between two messages to force #
246 # them to be recognised as unrelated. #
247 # action - Any of 'notice', 'noticeopers', 'silent', 'kill' #
248 # or 'killopers'. Define how to take action when #
249 # a user uses /amsg or /ame. #
251 #<blockamsg delay="3" action="killopers">
253 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
254 # Block CAPS module: Blocking all-CAPS messages with cmode +B
255 #<module name="m_blockcaps.so">
257 #-#-#-#-#-#-#-#-#-#-#- BLOCKCAPS CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
259 # percent - How many percent of text must be caps before text #
262 # minlen - The minimum length a line must be for the block #
263 # percent to have any effect. #
265 # capsmap - A list of chars to be considered CAPS, this was #
266 # you can add CAPS for your language. Also you can #
267 # add things like ! and space to further lock down #
269 #<blockcaps percent="50"
271 # capsmap="ABCDEFGHIJKLMNOPQRSTUVWXYZ! ">
273 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
274 # Block colour module: Blocking colour-coded messages with cmode +c
275 #<module name="m_blockcolor.so">
277 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
278 # Botmode module: Adds the user mode +B
279 #<module name="m_botmode.so">
281 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
282 # CallerID module: Adds usermode +g which activates hybrid-style
283 # callerid (== block all private messages unless you /accept first)
284 #<module name="m_callerid.so">
286 #-#-#-#-#-#-#-#-#-#-#- CALLERID CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#
287 # maxaccepts - Maximum number of entires a user can add to his #
288 # /accept list. Default is 16 entries. #
289 # operoverride - Can opers (note: ALL opers) ignore callerid mode? #
291 # tracknick - Preserve /accept entries when a user changes nick? #
292 # If no (the default), the user is removed from #
293 # everyone's accept list if he changes nickname. #
294 # cooldown - Amount of time (in seconds) that must pass since #
295 # the last notification sent to a user before he can #
296 # be sent another. Default is 60 (1 minute). #
297 #<callerid maxaccepts="16"
302 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
303 # CAP module: Provides the CAP negotiation mechanism seen in
304 # ratbox-derived ircds
305 #<module name="m_cap.so">
307 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
308 # CBAN module: Lets you disallow channels from being used at runtime.
309 # This module is oper-only and provides /cban.
310 # To use, CBAN must be in one of your oper class blocks.
311 #<module name="m_cban.so">
313 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
314 # Censor module: Adds the channel mode +G
315 #<module name="m_censor.so">
317 #-#-#-#-#-#-#-#-#-#-#- CENSOR CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#
319 # Optional - If you specify to use the m_censor module, then you must #
320 # specify some censor tags. See also: #
321 # http://wiki.inspircd.org/Modules/censor #
323 #<include file="censor.conf">
325 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
326 # CGI:IRC module: Adds support for automatic host changing in CGI:IRC
327 # (http://cgiirc.sourceforge.net).
328 #<module name="m_cgiirc.so">
330 #-#-#-#-#-#-#-#-#-#-#-# CGIIRC CONFIGURATION #-#-#-#-#-#-#-#-#-#-#-#-#
332 # Optional - If you specify to use m_cgiirc, then you must specify one
333 # or more cgihost tags which indicate authorised CGI:IRC servers which
334 # will be connecting to your network, and an optional cgiirc tag.
335 # For more information see: http://wiki.inspircd.org/Modules/cgiirc
337 # Set to yes if you want to notice opers when CGI clients connect
338 # <cgiirc opernotice="no">
340 # The type field indicates where the module should get the real
341 # client's IP address from, for further information, please see the
342 # CGI:IRC documentation.
345 # <cgihost type="pass" mask="www.mysite.com"> # Get IP from PASS
346 # <cgihost type="ident" mask="otherbox.mysite.com"> # Get IP from ident
347 # <cgihost type="passfirst" mask="www.mysite.com"> # See the docs
349 # <cgihost type="webirc" password="foobar"
350 # mask="somebox.mysite.com"> # Get IP from WEBIRC
355 # When you connect CGI:IRC clients, there are two connect classes which
356 # apply to these clients. When the client initially connects, the connect
357 # class which matches the cgi:irc site's host is checked. Therefore you
358 # must raise the maximum local/global clients for this ip as high as you
359 # want to allow cgi clients. After the client has connected and is
360 # determined to be a cgi:irc client, the class which matches the client's
361 # real IP is then checked. You may set this class to a lower value, so that
362 # the real IP of the client can still be restricted to, for example, 3
367 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
368 # Channel create module: Adds snomask +j, which will notify opers of
369 # any new channels that are created.
370 # This module is oper-only.
371 #<module name="m_chancreate.so">
373 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
374 # Channel filter module: Allows channel-op defined message
375 # filtering using simple string matches (channel mode +g)
376 #<module name="m_chanfilter.so">
378 # If hidemask is set to yes, the user will not be shown the mask when
379 # his/her message is blocked.
380 #<chanfilter hidemask="yes">
382 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
383 # Channel logging module: used to send snotice output to channels, to
384 # allow staff to centrally monitor and discuss network activity.
386 # The "channel" field is where you want the messages to go, "snomasks"
387 # is what snomasks you want to be sent to that channel. Multiple tags
389 #<module name="m_chanlog.so">
390 #<chanlog snomasks="AOcC" channel="#opers">
392 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
393 # Channelban: Implements extended ban j:, which stops anyone in already
394 # in a channel matching a mask like +b j:#channel*mask from joining.
395 #<module name="m_channelban.so">
397 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
398 # Chanprotect module: gives +q and +a channel modes
399 #<module name="m_chanprotect.so">
402 # noservices: With this set to yes, when a user joins a empty channel,
403 # the server will set +q on them. If set to no, it will only set +o
404 # on them until they register the channel.
407 # qprefix: Prefix (symbol) to use for +q users.
410 # aprefix: Prefix (symbol) to use for +a users.
413 # deprotectself: If this value is set (true, yes or 1), it will allow
414 # +a and +q users to remove the +a and +q from themselves, otherwise,
415 # the status will have to be removed by services.
418 # deprotectothers: If this value is set to yes, true, or 1, then any
419 # user with +q or +a may remove the +q or +a from other users.
420 deprotectothers="yes">
423 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
424 # Check module: gives /check
425 # Check is useful for looking up information on channels,
426 # users, IP addresses and hosts.
427 # This module is oper-only.
428 # To use, CHECK must be in one of your oper class blocks.
429 #<module name="m_check.so">
431 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
432 # CHGHOST module: Adds the /CHGHOST command
433 # This module is oper-only.
434 # To use, CHGHOST must be in one of your oper class blocks.
435 #<module name="m_chghost.so">
437 #-#-#-#-#-#-#-#-# /CHGHOST - /SETHOST CONFIGURATION #-#-#-#-#-#-#-#-#
438 # Optional - If you want to use special chars for hostnames you can #
439 # specify your own custom list of chars with the <hostname> tag: #
441 # charmap - A list of chars accepted as valid by the /CHGHOST #
442 # and /SETHOST commands. Also note that the list is #
444 #<hostname charmap="abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ.-_/0123456789">
446 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
447 # CHGIDENT module: Adds the /CHGIDENT command
448 # This module is oper-only.
449 # To use, CHGIDENT must be in one of your oper class blocks.
450 #<module name="m_chgident.so">
452 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
453 # CHGNAME module: Adds the /CHGNAME command
454 # This module is oper-only.
455 # To use, CHGNAME must be in one of your oper class blocks.
456 #<module name="m_chgname.so">
458 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
459 # Cloaking module: Adds usermode +x and cloaking support.
460 # Relies on the module m_md5.so being loaded before m_cloaking.so in
461 # the configuration file.
462 # To use, you should enable m_conn_umodes and add +x as
463 # an enabled mode. See the m_conn_umodes module for more information.
464 #<module name="m_cloaking.so">
466 #-#-#-#-#-#-#-#-#-#-#- CLOAKING CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#
468 # Optional - If you specify the m_cloaking.so module as above, you #
469 # must define cloak keys, and optionally a cloak prefix as shown #
470 # below. When using cloaking, the cloak keys are MANDITORY and must #
471 # be included. However, if prefix is not included, it will default #
472 # to your networks name from the <server> tag. You can also include #
473 # the following optional values: #
475 # ipalways - Always cloak the IP address, not the hostname, #
476 # which doesn't reveal the user's ISP, but #
477 # results in hosts that are harder to read and #
480 # lowercase - Display the cloaked hostnames in lowercase #
481 # characters instead of uppercase #
483 # It is VERY IMPORTANT that you do not use the keys shown here. You #
484 # MUST randomly create your own cloak keys. #
486 # <cloak key1="0x01234567" #
487 # key2="0x89ABCDEF" #
488 # key3="0x01234567" #
489 # key4="0x89ABCDEF" #
492 # lowercase="false"> #
494 # Please note that the key values will accept any number, and should #
495 # be large numbers. Using small numbers such as "7" or "1924" will #
496 # seriously weaken the security of your cloak. It is recommended you #
497 # use hexdecimal numbers prefixed by "0x", as shown in this example, #
498 # with each key eight hex digits long. #
500 #-#-#-#-#-#-#-#-#-#-#-#- CLOSE MODULE #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
501 # Close module: Allows an oper to close all unregistered connections.
502 # This module is oper-only and provides /close.
503 # To use, CLOSE must be in one of your oper class blocks.
504 #<module name="m_close.so">
506 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
507 # Clones module: Adds an oper command /CLONES for detecting cloned
508 # users. Warning: This module may be resource intensive when its
509 # command is issued, use with care.
510 # This module is oper-only.
511 # To use, CLONES must be in one of your oper class blocks.
512 #<module name="m_clones.so">
514 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
515 # Common channels module: Adds user mode +c, which, when set, requires
516 # that users must share a common channel with you to PRIVMSG or NOTICE
518 #<module name="m_commonchans.so">
520 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
521 # Conn-Join: Allows you to force users to join one or more channels
522 # automatically upon connecting to the server.
523 #<module name="m_conn_join.so">
525 #-#-#-#-#-#-#-#-#-#-#-#- CONNJOIN CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
527 # If you have m_conn_join.so loaded, you can configure it using the
530 #<autojoin channel="#one,#two,#three">
532 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
533 # Conn-Usermodes: Set modes on users when they connect
534 # When this module is loaded <connect:allow> tags may have an optional
535 # modes="" value, which contains modes to add or remove from users
536 # when they connect to the server.
537 #<module name="m_conn_umodes.so">
539 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
540 # Conn-Wait-for-Pong: Don't let a user connect until they PONG
541 #<module name="m_conn_waitpong.so">
543 #-#-#-#-#-#-#-#-#-#-#- WAITPONG CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
545 # If you have the m_conn_waitpong.so module loaded, configure it with #
546 # the <waitpong> tag: #
548 # sendsnotice - Whether to send a snotice on connect, like other #
551 # killonbadreply - Whether to kill the user if they send the wrong #
554 #<waitpong sendsnotice="yes" killonbadreply="yes">
557 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
558 # Channel cycle module. Server side /hop, with +ilk etc bypass.
559 #<module name="m_cycle.so">
561 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
562 # Connectban: Provides IP connection throttling. Any IP range that connects
563 # too many times (configurable) in an hour is zlined for a (configurable)
564 # duration, and their count resets to 0.
566 # ipv4cidr and ipv6cidr allow you to turn the comparison from individual
567 # IP addresses (32 and 128 bits) into CIDR masks, to allow for throttling
568 # over whole ISPs/blocks of IPs, which may be needed to prevent attacks.
570 #<connectban threshold="10" duration="10m" ipv4cidr="32" ipv6cidr="128">
571 # This allows for 10 connections in an hour with a 10 minute ban if that is exceeded.
573 #<module name="m_connectban.so">
575 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
576 # Connection throttle module. Configuration:
577 #<module name="m_connflood.so">
579 #-#-#-#-#-#-#-#-#-#-#- CONTHROTTLE CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
580 # seconds, maxconns - Amount of connections per <seconds>.
582 # timeout - Time to wait after the throttle was activated
583 # before deactivating it. Be aware that the time
584 # is seconds + timeout.
586 # quitmsg - The message that users get if they attempt to
587 # connect while the throttle is active.
589 # bootwait - Amount of time to wait before enforcing the
590 # throttling when the server just booted.
592 #<connflood seconds="30" maxconns="3" timeout="30"
593 # quitmsg="Throttled" bootwait="10">
595 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
596 # Custom title module: Adds the /TITLE command which allows for trusted
597 # users to gain a custom whois line and a optional
598 # vhost can be specified.
599 #<module name="m_customtitle.so">
601 #-#-#-#-#-#-#-#-#-#- CUSTOM TITLE CONFIGURATION -#-#-#-#-#-#-#-#-#-#
602 # name - The username used to identify
603 # password - The password used to identify
604 # hash - The hash for the specific user's password (optional)
605 # m_password_hash.so and a hashing module must be loaded for this to work
606 # host - Allowed hostmask [optional]
607 # title - Title shown in whois
608 # vhost - Displayed host [optional]
610 #<title name="foo" password="bar" title="Official Chat Helper">
611 #<title name="bar" password="foo" host="ident@host.name" title="Official Chat Helper" vhost="helper.network.chat">
612 #<title name="foo" password="fcde2b2edba56bf408601fb721fe9b5c338d10ee429ea04fae5511b68fbf8fb9" hash="sha256" title="Official Chat Helper">
614 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
615 # DCCALLOW module: Adds the /DCCALLOW command
616 #<module name="m_dccallow.so">
618 #-#-#-#-#-#-#-#-#-#-#- DCCALLOW CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
619 # blockchat - Whether to block DCC CHAT as well as DCC SEND
620 # length - Default duration of entries in DCCALLOW list
621 # action - Default action to take if no action is specified
622 # can be 'block' or 'allow'
624 # File configuration:
625 # pattern - The glob pattern to match against
626 # action - Action to take if a user attempts to send a file
627 # that matches this pattern, can be 'block' or 'allow'
629 #<dccallow blockchat="yes" length="5m" action="block">
630 #<banfile pattern="*.exe" action="block">
631 #<banfile pattern="*.txt" action="allow">
633 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
635 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
636 # Deaf module: adds support for ircu style usermode +d - deaf to
637 # channel messages and channel notices.
638 #<module name="m_deaf.so">
640 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
641 # Delay join module: Adds the channel mode +D which delays all JOIN
642 # messages from users until they speak. If they quit or part before
643 # speaking, their quit or part message will not be shown to the channel
644 # which helps cut down noise on large channels in a more friendly way
645 # than the auditorium mode. Only channel ops may set the +D mode.
646 #<module name="m_delayjoin.so">
648 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
649 # Deny Channels: Deny Channels from being used by users
650 #<module name="m_denychans.so">
652 #-#-#-#-#-#-#-#-#-#-#- DENYCHAN DEFINITIONS -#-#-#-#-#-#-#-#-#-#-#-#
654 # If you have the m_denychans.so module loaded, you need to specify #
655 # the channels to deny: #
657 # name - The channel name to deny. (glob masks are ok) #
659 # allowopers - If operators are allowed to override the deny. #
661 # reason - Reason given for the deny. #
663 # redirect - Redirect the user to a different channel #
665 #<badchan name="#gods*" allowopers="yes" reason="Tortoises!"> #
666 #<badchan name="#heaven" redirect="#hell" reason="Nice try!"> #
668 # Redirects will not work if the target channel is set +L. #
670 # Additionally, you may specify channels which are allowed, even if #
671 # a badchan tag specifies it would be denied: #
672 #<goodchan name="#godsleeps"> #
673 # Glob masks are accepted here also.
675 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
676 # Devoice Module: Let users devoice themselves.
677 #<module name="m_devoice.so">
679 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
680 # DNS Blacklist Module: Provides support for looking up IPs on one or #
682 #<module name="m_dnsbl.so"> #
684 # For configuration options please see the wiki page for m_dnsbl at #
685 # http://wiki.inspircd.org/Modules/dnsbl #
687 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
688 # Filter module: Provides message filtering, similar to SPAMFILTER.
689 #<module name="m_filter.so">
691 # This module depends upon a regex provider such as m_regex_pcre or #
692 # m_regex_glob to function. You must specify which of these you want #
693 # m_filter to use via the tag below. #
695 # Valid engines are: #
697 # glob - Glob patterns, provided via m_regex_glob.so #
698 # pcre - PCRE regexps, provided via m_regex_pcre.so, needs libpcre #
699 # tre - TRE regexps, provided via m_regex_tre.so, requires libtre #
700 # posix - POSIX regexps, provided via m_regex_posix.so, not availale #
701 # on windows, no dependencies on other operating systems. #
703 #<filteropts engine="glob"> #
705 # Your choice of regex engine must match on all servers network-wide.
707 # You may specify specific channels that are exempt from being filtered:
708 #<exemptfromfilter channel="#blah">
710 #-#-#-#-#-#-#-#-#-#-#- FILTER CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#
712 # Optional - If you specify to use the m_filter module, then #
713 # specfiy below the path to the filter.conf file, or define some #
716 #<include file="filter.conf">
718 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
719 # Foobar module: does nothing - historical relic
720 #<module name="m_foobar.so">
722 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
723 # Gecosban: Implements extended ban r:, which stops anyone matching
724 # a mask like +b r:*realname?here* from joining a channel.
725 #<module name="m_gecosban.so">
727 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
728 # GeoIP module: Allows the server admin to ban users by country code.
729 # This modules is in extras. Re-run configure with: ./configure --enable-extras=m_geoip.cpp
730 # and run make install, then uncomment this module to enable it.
731 #<module name="m_geoip.so">
733 #-#-#-#-#-#-#-#-#-#-#-# GEOIP CONFIGURATION #-#-#-#-#-#-#-#-#-#-#-#-#
735 # <geoip banunknown="false"> #
737 # Set this value to true or yes to block unknown IP ranges which are #
738 # not in the database (usually LAN addresses, localhost, etc) #
740 # <geoban country="TR" reason="This country not permitted"> #
742 # Use one or more of these tags to ban countries by country code. #
743 # The country code must be in capitals and should be an ISO country #
744 # code such as TR, GB, or US. #
746 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
747 # Globops module: gives /GLOBOPS and SNOMASK +g
748 # This module is oper-only.
749 # To use, GLOBOPS must be in one of your oper class blocks.
750 #<module name="m_globops.so">
752 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
753 # Global load module: Allows loading and unloading of modules network-
754 # wide (USE WITH EXTREME CAUTION!)
755 # This module is oper-only and provides /gloadmodule, /gunloadmodule
756 # and /greloadmodule.
757 # To use, GLOADMODULE, GUNLOADMODULE and GRELOADMODULE
758 # must be in one of your oper class blocks.
759 #<module name="m_globalload.so">
761 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
762 # HELPOP module: Provides the /HELPOP command
763 #<module name="m_helpop.so">
765 #-#-#-#-#-#-#-#-#-#-#-#- HELPOP CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
767 # Optional - If you specify to use the m_helpop.so module, then #
768 # specify below the path to the helpop.conf file, or if you like to #
769 # make a mess, define your helpop tags in this conf. #
771 #<include file="helpop.conf">
773 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
774 # HIDECHANS module: Allows opers to hide their channels list from non-
775 # opers by setting user mode +I on themselves.
776 # <module name="m_hidechans.so">
778 # HIDECHANS can optionally prevent opers from seeing channels on a +I
779 # user, for more privacy if set to true.
780 # This setting is not recommended for most mainstream networks.
781 #<hidechans affectsopers="false">
783 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
784 # HIDEOPER module: Allows opers to hide their oper status from non-
785 # opers by setting user mode +H on themselves.
786 # This module is oper-only.
787 # <module name="m_hideoper.so">
789 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
790 # Hostchange module: Allows a different style of cloaking
791 #<module name="m_hostchange.so">
793 #-#-#-#-#-#-#-#-#-#-#- HOSTCHANGE CONFIGURATION -#-#-#-#-#-#-#-#-#-#
795 # Optional - If you choose to use the m_hostchange.so module. #
796 # Config Help - See http://wiki.inspircd.org/Modules/hostchange #
798 #<host suffix="polarbears.org" separator="." prefix="">
799 #<hostchange mask="*@fbi.gov" action="addnick">
800 #<hostchange mask="*r00t@*" action="suffix">
801 #<hostchange mask="a@b.com" action="set" value="blah.blah.blah">
802 #<hostchange mask="localhost" ports="7000,7001,7005-7007" action="set" value="blahblah.foo">
804 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
805 # httpd module: Provides http server support for InspIRCd
806 #<module name="m_httpd.so">
808 #-#-#-#-#-#-#-#-#-#-#-#- HTTPD CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
810 # Optional - If you choose to use the m_httpd.so module, then you must
811 # specify the port number and other details of your http server:
813 #<http ip="192.168.1.10" host="brainwave" port="32006"
814 # index="/home/brain/inspircd/http/index.html">
816 # You may have as many of these tags as you wish, each with a different
817 # IP, port, host or index file. Each one will act as an independent
821 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
822 # http ACL module: Provides access control lists for m_httpd dependent
823 # modules. Use this module to restrict pages by IP address and by
826 #<module name="m_httpd_acl.so">
828 #-#-#-#-#-#-#-#-#-#-#-#- HTTPD ACL CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
830 # Restrict access to the m_httpd_stats module to all but the local
831 # network and when the correct password is specified:
833 # <httpdacl path="/stats*" types="password,whitelist"
834 # username="secretstuff" password="mypasshere" whitelist="127.0.0.*,10.*">
836 # Deny all connections to all but the main index page:
838 # <httpdacl path="/*" types="blacklist" blacklist="*">
841 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
842 # http config module: Allows the server's configuration to be viewed
843 # over HTTP. Requires m_httpd.so to be loaded for it to function.
844 #<module name="m_httpd_config.so">
846 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
847 # http stats module: Provides basic stats pages over HTTP
848 # Requires m_httpd.so to be loaded for it to function.
849 #<module name="m_httpd_stats.so">
851 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
852 # Ident: Provides RFC 1413 ident lookup support
853 # When this module is loaded <connect:allow> tags may have an optional
854 # useident="yes|no" boolean value, determining whether or not to lookup
855 # ident on users matching that connect tag.
856 #<module name="m_ident.so">
858 #-#-#-#-#-#-#-#-#-#-#-#- IDENT CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
860 # Optional - If you are using the m_ident.so module, then you can #
861 # specify the timeout for ident lookups here. If not defined, it will #
862 # default to one second. This is a non-blocking timeout which holds #
863 # the user in a 'connecting' state until the lookup is complete. #
864 # The bind value indicates which IP to bind outbound requests to. #
868 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
869 # Invite except module: Adds support for channel invite exceptions (+I)
870 #<module name="m_inviteexception.so">
872 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
873 # Invisible module - Adds support for usermode +Q (quiet) which lets an
874 # oper go 'invisible' similar to unrealircd 3.1's +I mode. Note that
875 # opers are still able to see invisible users, and if an oper with +Q
876 # deopers, they will become visible.
878 # This module is oper-only.
880 #<module name="m_invisible.so">
882 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
883 # Join flood module: Adds support for join flood protection (+j)
884 #<module name="m_joinflood.so">
886 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
887 # Jump Server module: Adds support for the RPL_REDIR numeric
888 # This module is oper-only.
889 # To use, JUMPSERVER must be in one of your oper class blocks.
890 #<module name="m_jumpserver.so">
892 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
893 # Anti-Auto-Rejoin: Adds support for prevention of auto-rejoin (+J)
894 #<module name="m_kicknorejoin.so">
896 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
897 # Knock module: adds the /KNOCK command and +K channel mode
898 #<module name="m_knock.so">
900 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
901 # LDAP authentication module: Adds the ability to authenticate users #
902 # via LDAP. This is an extra module which must be enabled explicitly #
903 # by symlinking it from modules/extra, and requires the OpenLDAP libs #
904 # This modules is in extras. Re-run configure with: ./configure --enable-extras=m_ldapauth.cpp
905 # and run make install, then uncomment this module to enable it. #
907 #<module name="m_ldapauth.so"> #
911 # <ldapauth baserdn="ou=People,dc=brainbox,dc=cc" #
913 # server="ldap://brainwave.brainbox.cc" #
914 # allowpattern="Guest*" #
915 # killreason="Access denied" #
916 # searchscope="subtree" #
917 # binddn="cn=Manager,dc=brainbox,dc=cc" #
918 # bindauth="mysecretpass" #
921 # The baserdn indicates the base DN to search in for users. Usually #
922 # this is 'ou=People,dc=yourdomain,dc=yourtld'. #
924 # The attribute value indicates the attribute which is used to locate #
925 # a user account by name. On POSIX systems this is usually 'uid'. #
927 # The server parameter indicates the LDAP server to connect to. The #
928 # ldap:// style scheme before the hostname proper is MANDITORY. #
930 # The allowpattern value allows you to specify a wildcard mask which #
931 # will always be allowed to connect regardless of if they have an #
932 # account, for example guest users. #
934 # Killreason indicates the QUIT reason to give to users if they fail #
937 # The searchscope value indicates the subtree to search under. On our #
938 # test system this is 'subtree'. Your mileage may vary. #
940 # Setting the verbose value causes an oper notice to be sent out for #
941 # every failed authentication to the server, with an error string. #
943 # The binddn and bindauth indicate the DN to bind to for searching, #
944 # and the password for the distinguished name. Some LDAP servers will #
945 # allow anonymous searching in which case these two values do not #
946 # need defining, otherwise they should be set similar to the examples #
949 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
950 # LDAP oper configuration module: Adds the ability to authenticate #
951 # opers via LDAP. This is an extra module which must be enabled #
952 # explicitly by symlinking it from modules/extra, and requires the #
953 # OpenLDAP libs. Re-run configure with: ./configure --enable-extras=m_ldapoper.cpp
954 # and run make install, then uncomment this module to enable it. #
956 #<module name="m_ldapoper.so">
960 # <ldapoper baserdn="ou=People,dc=brainbox,dc=cc"
961 # server="ldap://brainwave.brainbox.cc"
962 # searchscope="subtree"
963 # binddn="cn=Manager,dc=brainbox,dc=cc"
964 # bindauth="mysecretpass">
966 # Available configuration items are identical to the same items in #
967 # m_ldapauth above. #
969 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
970 # Lock server module: Adds /LOCKSERV and /UNLOCKSERV commands that is #
971 # used to temporarily close/open for new connections to the server. #
972 # These commands require OPER status and that the LOCKSERV UNLOCKSERV #
973 # are specified in a <class> tag that the oper is part of. This is so #
974 # you can control who has access to this possible dangerous command. #
975 # If your server is locked and you got disconnected, do a REHASH from #
976 # shell to open up again.
978 # This module is oper-only.
980 #<module name="m_lockserv.so">
982 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
983 # Map hiding module: replaces /MAP and /LINKS output to users with a #
984 # message to see a website, set by maphide="http://link.to/site" in #
985 # the security tag, instead. #
986 #<module name="m_maphide.so">
988 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
989 # Msg flood module: Adds message/notice flood protection (+f)
990 #<module name="m_messageflood.so">
992 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
993 # MsSQL module: Allows other SQL modules to access MS SQL Server
994 # through a unified API. You must copy the source for this module
995 # from the directory src/modules/extra, plus the file m_sqlv2.h
996 # This modules is in extras. Re-run configure with: ./configure --enable-extras=m_mssql.cpp
997 # and run make install, then uncomment this module to enable it.
999 #<module name="m_mssql.so">
1001 #-#-#-#-#-#-#-#-#-#-#-#- SQL CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#-#
1003 # m_mssql.so is more complex than described here, see wiki for more #
1004 # info http://wiki.inspircd.org/Modules/mssql #
1006 #<database name="db" username="user" password="pass" hostname="localhost" id="db1">
1008 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1009 # MySQL module: Allows other SQL modules to access MySQL databases
1010 # through a unified API. You must copy the source for this module
1011 # from the directory src/modules/extra, plus the file m_sqlv2.h
1012 # This modules is in extras. Re-run configure with: ./configure --enable-extras=m_mysql.cpp
1013 # and run make install, then uncomment this module to enable it.
1015 #<module name="m_mysql.so">
1017 #-#-#-#-#-#-#-#-#-#-#-#- SQL CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#-#
1019 # m_mysql.so is more complex than described here, see the wiki for #
1020 # more: http://wiki.inspircd.org/Modules/mysql #
1022 #<database name="mydb" username="myuser" password="mypass" hostname="localhost" id="my_database2">
1024 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1025 # NAMESX module: Provides support for the NAMESX extension which allows
1026 # clients to see all the prefixes set on a user without getting confused.
1027 # This is supported by mIRC, x-chat, klient, and maybe more.
1028 #<module name="m_namesx.so">
1030 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1031 # National characters module:
1032 # 1) Allows using national characters in nicknames.
1033 # 2) Allows using custom (national) casemapping over the network.
1034 # file -- filename of existing file in "locales" directory
1035 # casemapping -- custom value for 005 numeric (if you want it to be
1036 # different from the filename.
1038 #<nationalchars file="bynets/russian-w1251-charlink" casemapping="ru_RU.cp1251-charlink">
1039 #<module name="m_nationalchars.so">
1041 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1042 # Nickchange flood protection module: Allows up to X nick changes in Y seconds.
1043 # Provides channel mode +F.
1044 #<module name="m_nickflood.so">
1046 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1047 # Nicklock module: Let opers change a user's nick and then stop that
1048 # user from changing their nick again.
1049 # This module is oper-only.
1050 # To use, NICKLOCK and NICKUNLOCK must be in one of your oper class blocks.
1051 #<module name="m_nicklock.so">
1053 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1054 # No ctcp module: Adds the channel mode +C to block CTCPs and extban C
1055 # to block CTCPs sent by specific users.
1056 #<module name="m_noctcp.so">
1058 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1059 # No kicks module: Adds the +Q channel mode and the Q: extban to deny
1060 # certain users from kicking.
1061 #<module name="m_nokicks.so">
1063 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1064 # No nicks module: Adds the +N channel mode, as well as the +b N:
1065 # extended bantype. +N stops all users from changing their nick,
1066 # the +b N: extban stops anyone from matching a +b N:nick!user@host
1067 # mask from changing their nick.
1068 #<module name="m_nonicks.so">
1070 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1071 # No part message module: adds extban 'p' to block part messages from #
1073 #<module name="m_nopartmsg.so">
1075 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1076 # No Notice module: adds the channel mode +T and the extban T to block
1077 # specific users from noticing the channel.
1078 #<module name="m_nonotice.so">
1080 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1081 # Oper channels mode: Adds the +O channel mode
1082 # This module is oper-only.
1083 #<module name="m_operchans.so">
1085 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1086 # Oper invex/extban module: Adds +beI type O, to ban, exempt, and invex
1087 # given oper type masks.
1088 # e.g, /mode #channel +iI O:* is equivilant to chmode +O, but you
1089 # may also, e.g. /mode #channel +iI O:AdminTypeOnly to only allow admins.
1090 # +be work in a similar fashion.
1091 # This module is oper-only.
1093 #<module name="m_operinvex.so">
1095 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1096 # Oper Join module: Auto-joins opers to a channel upon oper-up
1097 # This module is oper-only. For the user equivalent, see m_conn_join.
1098 #<module name="m_operjoin.so">
1100 #-#-#-#-#-#-#-#-#-#-# OPERJOIN CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
1102 # If you are using the m_operjoin.so module, specify options here: #
1104 # channel - The channel name to join, can also be a comma #
1105 # seperated list eg. "#channel1,#channel2". #
1107 # override - Lets the oper join walking thru any modes that #
1108 # might be set, even bans. Use "yes" or "no". #
1110 #<operjoin channel="#channel" override="no">
1112 # Alternatively you can use the autojoin="channellist" in a <type> #
1113 # tag to set specific autojoins for a type of oper, for example: #
1115 #<type name="Helper" autojoin="#help" classes="...">
1117 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1118 # Oper log module: Logs all oper commands to the ircd log at default
1120 # This module is oper-only.
1121 #<module name="m_operlog.so">
1123 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1124 # Oper prefixing module: Gives IRC operators a prefix status character
1125 # on all channels they are in.
1127 #<module name="m_operprefix.so">
1129 # You may additionally customise the prefix character.
1130 #<operprefix prefix="!">
1132 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1133 # Oper MOTD module: Provides support for seperate message of the day
1135 # This module is oper-only.
1136 #<module name="m_opermotd.so">
1138 #-#-#-#-#-#-#-#-#-#-# OPERMOTD CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
1140 # If you are using the m_opermotd.so module, specify the motd here #
1142 # onoper - Should the message be sent on /OPER or only when #
1143 # /OPERMOTD is used. Use "yes" or "no". #
1145 #<opermotd file="oper.motd" onoper="yes">
1147 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1148 # Override module: Adds support for oper override
1149 # This module is oper-only.
1150 #<module name="m_override.so">
1152 #-#-#-#-#-#-#-#-#-#-# OVERRIDE CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
1154 # m_override.so is too complex it describe here, see the wiki: #
1155 # http://wiki.inspircd.org/Modules/override #
1157 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1158 # Oper levels module: Gives each oper a level and prevents
1159 # actions being taken against higher level opers
1160 # Specify the level as the 'level' parameter of the <type> tag
1161 # # This module is oper-only.
1162 #<module name="m_operlevels.so">
1164 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1165 # Oper modes module: Allows you to specify modes to add/remove on oper
1166 # Specify the modes as the 'modes' parameter of the <type> tag
1167 # and/or as the 'modes' parameter of the <oper> tag.
1168 # This module is oper-only. For the user equivalent, see m_conn_umodes
1169 #<module name="m_opermodes.so">
1171 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1172 # Oper password hash module: Allows hashed oper passwords
1173 # Relies on the module m_md5.so and/or m_sha256.so being loaded before
1174 # m_password_hash.so in the configuration file.
1175 # This module is oper-only.
1176 #<module name="m_password_hash.so">
1178 #-#-#-#-#-#-#-#-#-#-# OPER HASH CONFIGURATION #-#-#-#-#-#-#-#-#-#-#-#-#
1180 # To use this module, you must define a hash type for each oper's
1181 # password you want to hash. For example:
1183 # <oper name="Brain"
1184 # host="ident@dialup15.isp.com"
1186 # password="a41d730937a53b79f788c0ab13e9e1d5"
1189 # The types of hashing available vary depending on which hashing modules
1190 # you load, but usually if you load m_sha256.so and m_md5.so, both md5
1191 # and sha256 type hashing will be available (the most secure of which
1194 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1195 # Permanent Channels module: Channels with the permanent channels mode
1196 # will remain open even after everyone else has left the channel, and
1197 # therefore keep things like modes, ban lists and topic. Permanent
1198 # channels -may- need support from your Services package to function
1199 # properly with them. This adds channel mode +P.
1200 # This module is oper-only.
1201 #<module name="m_permchannels.so">
1203 # You may also create channels on startup by using the <permchannels> block.
1204 #<permchannels channel="#opers" modes="is" topic="Opers only.">
1206 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1207 # PostgreSQL module: Allows other SQL modules to access PgSQL databases
1208 # through a unified API. You must copy the source for this module
1209 # from the directory src/modules/extra, plus the file m_sqlv2.h
1210 # This modules is in extras. Re-run configure with: ./configure --enable-extras=m_pgsql.cpp
1211 # and run make install, then uncomment this module to enable it.
1213 #<module name="m_pgsql.so">
1215 #-#-#-#-#-#-#-#-#-#-#-#- SQL CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#-#
1217 # m_pgsql.so is more complex than described here, see the wiki for #
1218 # more: http://wiki.inspircd.org/Modules/pgsql #
1220 #<database name="mydb" username="myuser" password="mypass" hostname="localhost" id="my_database" ssl="no">
1222 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1223 # Muteban: Implements extended ban m:, which stops anyone matching
1224 # a mask like +b m:nick!user@host from speaking on channel.
1225 #<module name="m_muteban.so">
1228 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1229 # Random Quote module: provides a random quote on connect.
1230 # NOTE: Some of these may mimic fatal errors and confuse users and
1231 # opers alike! - BEWARE!
1232 #<module name="m_randquote.so">
1234 #-#-#-#-#-#-#-#-#-#- RANDOMQUOTES CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
1236 # Optional - If you specify to use the m_randquote.so module, then #
1237 # specify below the path to the randquotes.conf file. #
1239 #<randquote file="randquotes.conf">
1241 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1242 # Redirect module: Adds channel redirection (mode +L)
1243 #<module name="m_redirect.so">
1245 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1246 # Regular Expression Provider for Glob or wildcard (?/*) matching.
1247 # You must have at least 1 provider loaded to use m_filter or m_rline
1248 # modules. This module has no additional requirements, as it uses the
1249 # matching already present in InspIRCd core.
1250 #<module name="m_regex_glob.so">
1252 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1253 # Regular Expression Provider for PCRE (Perl-Compatible Regular
1254 # Expressions). You need libpcre installed to compile and load this
1255 # module. You must have at least 1 provider loaded to use m_filter or
1257 #<module name="m_regex_pcre.so">
1259 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1260 # Regular Expression Provider for POSIX Regular Expressions.
1261 # You shouldn't need any additional libraries on a POSIX-compatible
1262 # system (ie: any Linux, BSD, but not Windows). You must have at least
1263 # 1 provider loaded to use m_filter or m_rline.
1264 # On POSIX-compliant systems, regex syntax can be found by using the
1265 # command: 'man 7 regex'.
1266 #<module name="m_regex_posix.so">
1268 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1269 # Regular Expression Provider for TRE Regular Expressions.
1270 # This is the same regular expression engine used by UnrealIRCd, so
1271 # if you are most familiar with the syntax of /spamfilter from there,
1272 # this is the provider you want. You need libtre installed in order
1273 # to compile and load this module.
1274 #<module name="m_regex_tre.so">
1276 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1277 # Registered users only channel creation
1278 # Allows only registered users and opers to create new channels.
1279 #<module name="m_regonlycreate.so">
1281 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1282 # Remove module: Adds the /REMOVE command which is a peaceful
1283 # alternative to /KICK
1284 #<module name="m_remove.so">
1286 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1287 # Restricted channels module: Allows only opers to create channels
1288 #<module name="m_restrictchans.so">
1290 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1291 # Restrict message module: Allows users to only message opers
1292 #<module name="m_restrictmsg.so">
1294 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1295 # Ban users through regular expression patterns
1296 #<module name="m_rline.so">
1298 #-#-#-#-#-#-#-#-#-#-#-#- RLINE CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#-#
1300 # If you wish to re-check a user when they change nickname (can be
1301 # useful under some situations, but *can* also use CPU with more users
1302 # on a server) then set the following configuration value:
1303 # Also, this is where you set what Regular Expression engine is to be
1304 # used. If you ever change it while running, all of your R-Lines will be
1305 # wiped. This is the regex engine used by all R-Lines set, and
1306 # m_regex_<engine>.so must be loaded, or rline will be nonfunctional
1307 # until you load it or change the engine to one that is loaded.
1309 #<rline matchonnickchange="yes" engine="pcre">
1311 # Generally, you will NOT want to use 'glob' here, as this turns
1312 # rline into just another gline. The exceptions are that rline will
1313 # always use the full nick!user@host realname string, rather than only
1314 # user@host, but beware that only the ? and * wildcards are available,
1315 # and are the only way to specify where the space can occur if you do
1316 # use glob. For this reason, is recommended to use a real regex engine
1317 # so that at least \s or [[:space:]] is available.
1319 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1320 # JSON-RPC module: Encode and decode JSON-RPC requests for modules
1321 #<module name="m_rpc_json.so">
1323 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1324 # RPC test module: A test of the RPC API
1325 #<module name="m_rpctest.so">
1327 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1328 # Provide /LIST throttling (to prevent flooding) and /LIST safety to
1329 # prevent excess flood when the list is large.
1330 #<module name="m_safelist.so">
1332 #-#-#-#-#-#-#-#-#-#-# SAFELIST CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#-#
1334 # When using Safelist, you may set the following values;
1336 # The first value, 'throttle', sets the amount of time in seconds a user
1337 # must wait between LIST commands. For example, if this is set to 60
1338 # (the default) then the user may not /LIST more than once a minute.
1339 # If not defined, the default value is 60 seconds.
1341 # The second value, 'maxlisters', indicates the maximum number of users
1342 # which may be retrieving a LIST at once. It is not recommended you raise
1343 # this value, as increasing it too high can make your network vulnerable
1344 # to floodbots which waste your bandwidth and CPU time with LIST requests.
1346 #<safelist throttle="60" maxlisters="50">
1348 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1349 # SAJOIN module: Adds the /SAJOIN command
1350 # This module is oper-only.
1351 # To use, SAJOIN must be in one of your oper class blocks.
1352 #<module name="m_sajoin.so">
1354 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1355 # SAKICK module: Adds the /SAKICK command
1356 # This module is oper-only.
1357 # To use, SAKICK must be in one of your oper class blocks.
1358 #<module name="m_sakick.so">
1360 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1361 # SAMODE module: Adds the oper /SAMODE command
1362 # This module is oper-only.
1363 # To use, SAMODE must be in one of your oper class blocks.
1364 #<module name="m_samode.so">
1366 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1367 # SANICK module: Allows opers to change user's nicks
1368 # This module is oper-only.
1369 # To use, SANICK must be in one of your oper class blocks.
1370 #<module name="m_sanick.so">
1372 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1373 # SAPART module: Adds the oper /SAPART command
1374 # This module is oper-only.
1375 # To use, SAPART must be in one of your oper class blocks.
1376 #<module name="m_sapart.so">
1378 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1379 # SAQUIT module: Adds the oper /SAQUIT command (abusable!!!)
1380 # This module is oper-only.
1381 # To use, SAQUIT must be in one of your oper class blocks.
1382 #<module name="m_saquit.so">
1384 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1385 # SATOPIC module: Adds the oper /SATOPIC command
1386 # This module is oper-only.
1387 # To use, SATOPIC must be in one of your oper class blocks.
1388 #<module name="m_satopic.so">
1390 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1391 # SASL authentication module: Provides support for IRC Authentication
1392 # Layer (aka: atheme SASL) via AUTHENTICATE.
1393 #<module name="m_sasl.so">
1395 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1396 # Secure list module: Prevent /LIST in the first minute of connection,
1397 # crippling most spambots and trojan spreader bots.
1398 #<module name="m_securelist.so">
1400 #-#-#-#-#-#-#-#-#-# SECURELIST CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#-#
1402 # Securelist can be harmful to some irc search engines such as #
1403 # netsplit.de and searchirc.com. To prevent securelist blocking these #
1404 # sites from listing, define exception tags as shown below: #
1405 <securehost exception="*@*.searchirc.org">
1406 <securehost exception="*@*.netsplit.de">
1407 <securehost exception="*@echo940.server4you.de">
1409 # Define the following variable to change how long a user must wait #
1410 # before issuing a LIST. If not defined, defaults to 60 seconds. #
1412 #<securelist waittime="60"> #
1414 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1415 # Servprotect module: Provides support for Austhex style +k /
1416 # UnrealIRCD +S services mode
1417 #<module name="m_servprotect.so">
1419 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1420 # See nicks module: Allow for SNOMASK +N which shows nick changes.
1421 # This module is oper-only.
1422 #<module name="m_seenicks.so">
1424 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1425 # Set Idle module: Adds a command for opers to change their
1426 # idle time (mainly a toy)
1427 # This module is oper-only.
1428 # To use, SETIDLE must be in one of your oper class blocks.
1429 #<module name="m_setidle.so">
1431 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1432 # Services support module: Adds several usermodes such as +R and +M
1433 # this module implements the 'identified' state via account names (AC)
1434 # and is similar in operation to the way asuka and ircu handle services.
1436 # At the same time, this offers +r for users and channels to mark them
1437 # as identified seperately from the idea of a master account, which
1438 # can be useful for services which are heavily nick-as-account centric.
1440 # This replaces m_services from 1.1 and earlier.
1442 # Also of note is that this module implements two extbans:
1443 # +b R: (stop matching account names from joining)
1444 # +b M: (stop matching account names from speaking)
1446 #<module name="m_services_account.so">
1448 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1449 # Sethost module: Adds the /SETHOST command
1450 # This module is oper-only.
1451 # To use, SETHOST must be in one of your oper class blocks.
1452 # See m_chghost for how to customise valid chars for hostnames
1453 #<module name="m_sethost.so">
1455 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1456 # Setident module: Adds the /SETIDENT command
1457 # This module is oper-only.
1458 # To use, SETIDENT must be in one of your oper class blocks.
1459 #<module name="m_setident.so">
1461 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1462 # SETNAME module: Adds the /SETNAME command
1463 # This module is oper-only.
1464 # To use, SETNAME must be in one of your oper class blocks.
1465 #<module name="m_setname.so">
1467 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1468 # Serverban: Implements extended ban s:, which stops anyone connected
1469 # to a server matching a mask like +b s:server.mask.here from joining.
1470 #<module name="m_serverban.so">
1472 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1473 # Show Whois module: Adds the +W usermode which allows opers
1474 # to see when they are whois'ed (can be annoying).
1475 # This module is oper-only.
1476 #<module name="m_showwhois.so">
1478 # If you wish, you may also let users set this mode. Only opers with the
1479 # users/auspex priv will see real hosts of people, though. This setting
1480 # is not reloadable via /rehash, and will require /reloadmodule, as
1481 # it directly affects the mode object itself.
1482 #<showwhois opersonly="yes"
1484 # You may also set whether or not users should recieve whois notices, should
1485 # they be /whois'd by an oper.
1486 # showfromopers="yes">
1488 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1489 # Shun module: Provides the /shun command, which stops a user executing
1491 # This module is oper-only.
1492 # To use, SHUN must be in one of your oper class blocks.
1493 #<module name="m_shun.so">
1495 # You may also configure which commands you wish a user to be able to
1496 # perform. It should be noted that if a shunned user issues QUIT or PART
1497 # then their message will be removed, as if they did not issue one.
1499 # You can (optionally) let the user know that their command was blocked.
1501 # You may also let SHUN affect opers (defaults to no).
1502 #<shun enabledcommands="PING PONG QUIT PART JOIN" notifyuser="yes" affectopers="no">
1504 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1505 # Spy module: Provides the ability to see the complete names list of
1506 # channels an oper is not a member of
1507 # This module is oper-only.
1508 #<module name="m_spy.so">
1510 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1511 # SSL channel mode module: Adds support for SSL-only channels (+z).
1512 # does not do anything useful without a working SSL module (see below)
1513 #<module name="m_sslmodes.so">
1515 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1516 # Dummy ssl module: If you have other servers on your network which
1517 # have SSL, but your server does not have ssl enabled, you should load
1518 # this module, which will handle SSL metadata (e.g. the "Is using ssl"
1519 # field in the WHOIS information).
1520 #<module name="m_ssl_dummy.so">
1522 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1523 # GnuTLS ssl module: Adds support for client-server SSL using GnuTLS,
1524 # if enabled. You must copy the source for this module from the directory
1525 # src/modules/extra, or answer 'yes' in ./configure when asked if you
1526 # want to enable this, or it will not load.
1527 #<module name="m_ssl_gnutls.so">
1529 #-#-#-#-#-#-#-#-#-#-#- GNUTLS CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#
1531 # m_ssl_gnutls.so is too complex it describe here, see the wiki: #
1532 # http://wiki.inspircd.org/Modules/ssl_gnutls #
1534 # NOTE: If you want to use this module to encrypt and sign your #
1535 # server to server traffic, you MUST load it before m_spanningtree in #
1536 # your configuration file! #
1538 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1539 # SSL Info module: Allows users to retrieve information about other
1540 # user's peer SSL certificates and keys. This can be used by client
1541 # scripts to validate users. For this to work, one of m_ssl_gnutls.so
1542 # or m_ssl_openssl.so must be loaded. You must symlink the source for
1543 # this module from the directory src/modules/extra.
1544 # This modules is in extras. Re-run configure with: ./configure --enable-extras=m_sslinfo.cpp
1545 # and run make install, then uncomment this module to enable it.
1547 #<module name="m_sslinfo.so">
1549 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1550 # OpenSSL ssl module: Adds support for client-server SSL using OpenSSL,
1551 # if enabled. You must copy the source for this module from the directory
1552 # src/modules/extra, or answer 'yes' in ./configure when asked if you
1553 # want to enable this, or it will not load.
1554 #<module name="m_ssl_openssl.so">
1556 #-#-#-#-#-#-#-#-#-#-#- OPENSSL CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#
1558 # m_ssl_openssl.so is too complex it describe here, see the wiki: #
1559 # http://wiki.inspircd.org/Modules/ssl_openssl #
1561 # NOTE: If you want to use this module to encrypt and sign your #
1562 # server to server traffic, you MUST load it before m_spanningtree in #
1563 # your configuration file! #
1565 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1566 # SSL Cert Oper module: Allows opers to oper up using the key fingerprint
1567 # stored within their SSL certificate and key pair.
1568 # When using this module, one of m_ssl_gnutls.so or m_ssl_openssl.so must
1569 # be loaded. An extra value should be added to enabled opers, which
1570 # is in the following format: fingerprint="<hash>". For more information,
1571 # see the example in the oper blocks.
1572 # This module is oper-only.
1573 #<module name="m_ssl_oper_cert.so">
1575 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1576 # Strip colour module: Adds the channel mode +S
1577 #<module name="m_stripcolor.so">
1579 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1580 # SILENCE module: Adds support for /SILENCE
1581 #<module name="m_silence.so">
1583 # Configuration tags:
1585 #<silence maxentries="32">
1587 # Sets the maximum number of entries on a users silence list.
1589 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1590 # SQLite3 module: Allows other SQL modules to access SQLite3 #
1591 # databases through a unified API. You must link the source for this #
1592 # module from the directory src/modules/extra to src/modules, plus #
1593 # the file m_sqlv2.h #
1594 # This modules is in extras. Re-run configure with: ./configure --enable-extras=m_aqlite.cpp
1595 # and run make install, then uncomment this module to enable it. #
1597 #<module name="m_sqlite3.so">
1599 #-#-#-#-#-#-#-#-#-#-#-#- SQL CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#-#
1601 # m_sqlite.so is more complex than described here, see the wiki for #
1602 # more: http://wiki.inspircd.org/Modules/sqlite3 #
1604 #<database hostname="/full/path/to/database.db" id="anytext">
1606 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1607 # SQLutils module: Provides some utilities to SQL client modules, such
1608 # as mapping queries to users and channels. You must copy the source
1609 # for this module from the directory src/modules/extra/m_sqlutils.cpp
1610 # and src/modules/extra/m_sqlutils.h into /src/modules
1611 # Needed for, and loaded before: SQLauth and SQLoper
1612 # This modules is in extras. Re-run configure with: ./configure --enable-extras=m_sqlutils.cpp
1613 # and run make install, then uncomment this module to enable it.
1615 #<module name="m_sqlutils.so">
1617 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1618 # SQL authentication module: Allows IRCd connections to be tied into
1619 # a database table (for example a forum). You must copy the source for
1620 # this module from the directory src/modules/extra
1621 # Depends on the SQLutils module being loaded first.
1622 # This modules is in extras. Re-run configure with: ./configure --enable-extras=m_sqlauth.cpp
1623 # and run make install, then uncomment this module to enable it.
1625 #<module name="m_sqlauth.so">
1627 #-#-#-#-#-#-#-#-#-#-#- SQLAUTH CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#
1629 # m_sqlauth.so is too complex it describe here, see the wiki: #
1630 # http://wiki.inspircd.org/Modules/sqlauth #
1632 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1633 # SQL logging module: Allows you to log network-wide data for your
1634 # network in a fully normalised set of SQL tables. You must copy the
1635 # source for this module from the directory src/modules/extra
1636 # This modules is in extras. Re-run configure with: ./configure --enable-extras=m_sqllog.cpp
1637 # and run make install, then uncomment this module to enable it.
1639 #<module name="m_sqllog.so">
1641 #-#-#-#-#-#-#-#-#-#-#- SQLLOG CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#
1643 # dbid - Database ID to use (see m_sql) #
1645 # See also: http://wiki.inspircd.org/Modules/sqllog #
1649 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1650 # SQL oper module: Allows you to store oper credentials in an SQL table
1651 # You must copy the source for this module from the directory src/modules/extra
1652 # Depends on the SQLutils module being loaded first.
1653 # This modules is in extras. Re-run configure with: ./configure --enable-extras=m_sqloper.cpp
1654 # and run make install, then uncomment this module to enable it.
1656 #<module name="m_sqloper.so">
1658 #-#-#-#-#-#-#-#-#-#-#- SQLOPER CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#
1660 # dbid - Database ID to use (see m_sql) #
1661 # hash - Hashing provider to use for password hashing #
1663 # See also: http://wiki.inspircd.org/Modules/sqloper #
1665 #<sqloper dbid="1" hash="md5">
1667 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1668 # SVSHold module: Implements SVSHOLD. Like Q:Lines, but can only be #
1669 # added/removed by Services. #
1670 #<module name="m_svshold.so">
1672 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1673 # SWHOIS module: Allows you to add arbitary lines to user WHOIS.
1674 # This module is oper-only.
1675 # To use, SWHOIS must be in one of your oper class blocks.
1676 #<module name="m_swhois.so">
1678 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1679 # Taxonomy module: Adds the /TAXONOMY command, used to view all
1680 # metadata attached to a user.
1681 # This module is oper-only.
1682 # To use, TAXONOMY must be in one of your oper class blocks.
1683 #<module name="m_taxonomy.so">
1685 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1686 # Test command module: Does nothing significant. Read: pointless.
1687 #<module name="m_testcommand.so">
1689 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1690 # Timed bans module: Adds timed channel bans and the /TBAN command
1691 #<module name="m_timedbans.so">
1693 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1694 # Test line module: Adds the /TLINE command, used to test how many
1695 # users a /GLINE or /ZLINE etc would match.
1696 # This module is oper-only.
1697 # To use, TLINE must be in one of your oper class blocks.
1698 #<module name="m_tline.so">
1700 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1701 # UHNAMES support module: Adds support for the IRCX style UHNAMES
1702 # extension, which displays ident and hostname in the names list for
1703 # each user, saving clients from doing a WHO on the channel. Note that
1704 # this module is not widely supported yet. If a client does not support
1705 # UHNAMES it will not enable it, this will not break incompatible
1707 #<module name="m_uhnames.so">
1709 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1710 # Uninvite module: Adds the /UNINVITE command which lets users remove
1711 # pending invites from channels without waiting for the user to join.
1712 #<module name="m_uninvite.so">
1714 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1715 # Userip module: Adds the /USERIP command
1716 # This module is oper-only.
1717 # To use, USERIP must be in one of your oper class blocks.
1718 #<module name="m_userip.so">
1720 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1721 # Vhost module: Adds the VHOST command which allows for adding virtual
1722 # hosts which are accessible using a username and password in the config.
1723 #<module name="m_vhost.so">
1725 #-#-#-#-#-#-#-#-#-#-#- VHOST CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#-#
1727 # user - Username for the vhost. #
1729 # pass - Password for the vhost. #
1731 # hash - The hash for the specific user (optional)
1732 # m_password_hash.so and a hashing module must be loaded for this to work
1734 # host - Vhost to set. #
1736 #<vhost user="some_username" pass="some_password" host="some.host">
1737 #<vhost user="foo" password="fcde2b2edba56bf408601fb721fe9b5c338d10ee429ea04fae5511b68fbf8fb9" hash="sha256" host="some.other.host">
1739 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1740 # Watch module: Adds the WATCH command, which is used by clients to
1741 # maintain notify lists.
1742 #<module name="m_watch.so">
1744 # Configuration tags:
1746 #<watch maxentries="32">
1748 # Sets the maximum number of entries on a user's watch list.
1750 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1751 # XLine database: Stores all *Lines (G/Z/K/R/any added by other modules)
1752 # in a file "xline.db" which can be re-loaded on restart. This is useful
1753 # for two reasons: it keeps bans so users may not evade them, and on
1754 # bigger networks, server connections will take less time as there will
1755 # be a lot less bans to apply - as most of them will already be there.
1756 #<module name="m_xline_db.so">
1758 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1759 # ZipLinks module: Adds support for zlib deflate on server to server
1760 # connections. Both ends of the connection must load this module.
1761 # This modules is in extras. Re-run configure with: ./configure --enable-extras=m_ziplink.cpp
1762 # and run make install, then uncomment this module to enable it.
1764 #<module name="m_ziplink.so">
1766 # To use this module, you must enable it as a transport type in your
1767 # <link> tags or <bind> tags using the transport name 'zip'.
1768 # See the documentation of <link> and <bind>, respectively.
1772 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1773 # ____ _ _____ _ _ ____ _ _ _ #
1774 # | _ \ ___ __ _ __| | |_ _| |__ (_)___ | __ )(_) |_| | #
1775 # | |_) / _ \/ _` |/ _` | | | | '_ \| / __| | _ \| | __| | #
1776 # | _ < __/ (_| | (_| | | | | | | | \__ \ | |_) | | |_|_| #
1777 # |_| \_\___|\__,_|\__,_| |_| |_| |_|_|___/ |____/|_|\__(_) #
1779 # To link servers to InspIRCd, you MUST load the m_spanningtree #
1780 # module. Since several features (like SSL server links) rely on #
1781 # other modules being loaded before m_spanningtree, the module itself #
1782 # is at the bottom of this file. DO NOT forget to load it. If you DO #
1783 # NOT do this, server links will NOT work at all. ie. The ports will #
1784 # NOT bind, and /connect will not work properly. This is by design, #
1785 # to allow for the implementation of other linking protocols in #
1786 # modules in the future. #
1789 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1790 # Spanning Tree module - allows linking of servers using the spanning
1791 # tree protocol (see the READ THIS BIT section above).
1792 # You will almost always want to load this.
1794 #<module name="m_spanningtree.so">
projects / user / henk / code / inspircd.git / blob