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. 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://www.inspircd.org/wiki/Censor_Module #
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://www.inspircd.org/wiki/CGI-IRC_Module
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 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
379 # Channel logging module: used to send snotice output to channels, to
380 # allow staff to centrally monitor and discuss network activity.
382 # The "channel" field is where you want the messages to go, "snomasks"
383 # is what snomasks you want to be sent to that channel. Multiple tags
385 #<module name="m_chanlog.so">
386 #<chanlog snomasks="AOcC" channel="#opers">
388 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
389 # Channelban: Implements extended ban j:, which stops anyone in already
390 # in a channel matching a mask like +b j:#channel*mask from joining.
391 #<module name="m_channelban.so">
393 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
394 # Chanprotect module: gives +q and +a channel modes
395 #<module name="m_chanprotect.so">
398 # noservices: With this set to no, when a user joins a empty channel,
399 # the server will set +q on them. If set to yes, it will only set +o
400 # on them until they register the channel.
403 # qprefix: Prefix (symbol) to use for +q users.
406 # aprefix: Prefix (symbol) to use for +a users.
409 # deprotectself: If this value is set (true, yes or 1), it will allow
410 # +a and +q users to remove the +a and +q from themselves, otherwise,
411 # the status will have to be removed by services.
414 # deprotectothers: If this value is set to yes, true, or 1, then any
415 # user with +q or +a may remove the +q or +a from other users.
416 deprotectothers="yes">
419 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
420 # Check module: gives /check
421 # Check is useful for looking up information on channels,
422 # users, IP addresses and hosts.
423 # This module is oper-only.
424 # To use, CHECK must be in one of your oper class blocks.
425 #<module name="m_check.so">
427 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
428 # CHGHOST module: Adds the /CHGHOST command
429 # This module is oper-only.
430 # To use, CHGHOST must be in one of your oper class blocks.
431 #<module name="m_chghost.so">
433 #-#-#-#-#-#-#-#-# /CHGHOST - /SETHOST CONFIGURATION #-#-#-#-#-#-#-#-#
434 # Optional - If you want to use special chars for hostnames you can #
435 # specify your own custom list of chars with the <hostname> tag: #
437 # charmap - A list of chars accepted as valid by the /CHGHOST #
438 # and /SETHOST commands. Also note that the list is #
440 #<hostname charmap="abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ.-_/0123456789">
442 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
443 # CHGIDENT module: Adds the /CHGIDENT command
444 # This module is oper-only.
445 # To use, CHGIDENT must be in one of your oper class blocks.
446 #<module name="m_chgident.so">
448 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
449 # CHGNAME module: Adds the /CHGNAME command
450 # This module is oper-only.
451 # To use, CHGNAME must be in one of your oper class blocks.
452 #<module name="m_chgname.so">
454 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
455 # Cloaking module: Adds usermode +x and cloaking support.
456 # Relies on the module m_md5.so being loaded before m_cloaking.so in
457 # the configuration file.
458 # To use, you should enable m_conn_umodes and add +x as
459 # an enabled mode. See the m_conn_umodes module for more information.
460 #<module name="m_cloaking.so">
462 #-#-#-#-#-#-#-#-#-#-#- CLOAKING CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#
464 # Optional - If you specify the m_cloaking.so module as above, you #
465 # must define cloak keys, and optionally a cloak prefix as shown #
466 # below. When using cloaking, the cloak keys are MANDITORY and must #
467 # be included. However, if prefix is not included, it will default #
468 # to your networks name from the <server> tag. You can also include #
469 # the following optional values: #
471 # ipalways - Always cloak the IP address, not the hostname, #
472 # which doesn't reveal the user's ISP, but #
473 # results in hosts that are harder to read and #
476 # lowercase - Display the cloaked hostnames in lowercase #
477 # characters instead of uppercase #
479 # <cloak key1="0x2AF39F40" #
480 # key2="0x78E10B32" #
481 # key3="0x4F2D2E82" #
482 # key4="0x043A4C81" #
485 # lowercase="false"> #
487 # Please note that the key values will accept any number, and should #
488 # be large numbers. Using small numbers such as "7" or "1924" will #
489 # seriously weaken the security of your cloak. It is recommended you #
490 # use hexdecimal numbers prefixed by "0x", as shown in this example, #
491 # with each key eight hex digits long. #
493 #-#-#-#-#-#-#-#-#-#-#-#- CLOSE MODULE #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
494 # Close module: Allows an oper to close all unregistered connections.
495 # This module is oper-only and provides /close.
496 # To use, CLOSE must be in one of your oper class blocks.
497 #<module name="m_close.so">
499 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
500 # Clones module: Adds an oper command /CLONES for detecting cloned
501 # users. Warning: This module may be resource intensive when its
502 # command is issued, use with care.
503 # This module is oper-only.
504 # To use, CLONES must be in one of your oper class blocks.
505 #<module name="m_clones.so">
507 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
508 # Common channels module: Adds user mode +c, which, when set, requires
509 # that users must share a common channel with you to PRIVMSG or NOTICE
511 #<module name="m_commonchans.so">
513 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
514 # Conn-Join: Allows you to force users to join one or more channels
515 # automatically upon connecting to the server.
516 #<module name="m_conn_join.so">
518 #-#-#-#-#-#-#-#-#-#-#-#- CONNJOIN CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
520 # If you have m_conn_join.so loaded, you can configure it using the
523 #<autojoin channel="#one,#two,#three">
525 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
526 # Conn-Usermodes: Set modes on users when they connect
527 # When this module is loaded <connect:allow> tags may have an optional
528 # modes="" value, which contains modes to add or remove from users
529 # when they connect to the server.
530 #<module name="m_conn_umodes.so">
532 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
533 # Conn-Wait-for-Pong: Don't let a user connect until they PONG
534 #<module name="m_conn_waitpong.so">
536 #-#-#-#-#-#-#-#-#-#-#- WAITPONG CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
538 # If you have the m_conn_waitpong.so module loaded, configure it with #
539 # the <waitpong> tag: #
541 # sendsnotice - Whether to send a snotice on connect, like other #
544 # killonbadreply - Whether to kill the user if they send the wrong #
547 #<waitpong sendsnotice="yes" killonbadreply="yes">
550 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
551 # Channel cycle module. Server side /hop, with +ilk etc bypass.
552 #<module name="m_cycle.so">
554 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
555 # Connectban: Provides IP connection throttling. Any IP range that connects
556 # too many times (configurable) in an hour is zlined for a (configurable)
557 # duration, and their count resets to 0.
559 # ipv4cidr and ipv6cidr allow you to turn the comparison from individual
560 # IP addresses (32 and 128 bits) into CIDR masks, to allow for throttling
561 # over whole ISPs/blocks of IPs, which may be needed to prevent attacks.
563 #<connectban threshold="10" duration="10m" ipv4cidr="32" ipv6cidr="128">
564 # This allows for 10 connections in an hour with a 10 minute ban if that is exceeded.
566 #<module name="m_connectban.so">
568 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
569 # Connection throttle module. Configuration:
570 #<module name="m_connflood.so">
572 #-#-#-#-#-#-#-#-#-#-#- CONTHROTTLE CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
573 # seconds, maxconns - Amount of connections per <seconds>.
575 # timeout - Time to wait after the throttle was activated
576 # before deactivating it. Be aware that the time
577 # is seconds + timeout.
579 # quitmsg - The message that users get if they attempt to
580 # connect while the throttle is active.
582 # bootwait - Amount of time to wait before enforcing the
583 # throttling when the server just booted.
585 #<connflood seconds="30" maxconns="3" timeout="30"
586 # quitmsg="Throttled" bootwait="10">
588 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
589 # Custom title module: Adds the /TITLE command which allows for trusted
590 # users to gain a custom whois line and a optional
591 # vhost can be specified.
592 #<module name="m_customtitle.so">
594 #-#-#-#-#-#-#-#-#-#- CUSTOM TITLE CONFIGURATION -#-#-#-#-#-#-#-#-#-#
595 # name - The username used to identify
596 # password - The password used to identify
597 # host - Allowed hostmask [optional]
598 # title - Title shown in whois
599 # vhost - Displayed host [optional]
601 #<title name="foo" password="bar" title="Official Chat Helper">
602 #<title name="bar" password="foo" host="ident@host.name" title="Official Chat Helper" vhost="helper.network.chat">
604 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
605 # DCCALLOW module: Adds the /DCCALLOW command
606 #<module name="m_dccallow.so">
608 #-#-#-#-#-#-#-#-#-#-#- DCCALLOW CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
609 # blockchat - Whether to block DCC CHAT as well as DCC SEND
610 # length - Default duration of entries in DCCALLOW list
611 # action - Default action to take if no action is specified
612 # can be 'block' or 'allow'
614 # File configuration:
615 # pattern - The glob pattern to match against
616 # action - Action to take if a user attempts to send a file
617 # that matches this pattern, can be 'block' or 'allow'
619 #<dccallow blockchat="yes" length="5m" action="block">
620 #<banfile pattern="*.exe" action="block">
621 #<banfile pattern="*.txt" action="allow">
623 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
625 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
626 # Deaf module: adds support for ircu style usermode +d - deaf to
627 # channel messages and channel notices.
628 #<module name="m_deaf.so">
630 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
631 # Delay join module: Adds the channel mode +D which delays all JOIN
632 # messages from users until they speak. If they quit or part before
633 # speaking, their quit or part message will not be shown to the channel
634 # which helps cut down noise on large channels in a more friendly way
635 # than the auditorium mode. Only channel ops may set the +D mode.
636 #<module name="m_delayjoin.so">
638 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
639 # Deny Channels: Deny Channels from being used by users
640 #<module name="m_denychans.so">
642 #-#-#-#-#-#-#-#-#-#-#- DENYCHAN DEFINITIONS -#-#-#-#-#-#-#-#-#-#-#-#
644 # If you have the m_denychans.so module loaded, you need to specify #
645 # the channels to deny: #
647 # name - The channel name to deny. (glob masks are ok) #
649 # allowopers - If operators are allowed to override the deny. #
651 # reason - Reason given for the deny. #
653 # redirect - Redirect the user to a different channel #
655 #<badchan name="#gods*" allowopers="yes" reason="Tortoises!"> #
656 #<badchan name="#heaven" redirect="#hell" reason="Nice try!"> #
658 # Redirects will not work if the target channel is set +L. #
660 # Additionally, you may specify channels which are allowed, even if #
661 # a badchan tag specifies it would be denied: #
662 #<goodchan name="#godsleeps"> #
663 # Glob masks are accepted here also.
665 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
666 # Devoice Module: Let users devoice themselves.
667 #<module name="m_devoice.so">
669 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
670 # DNS Blacklist Module: Provides support for looking up IPs on one or #
672 #<module name="m_dnsbl.so"> #
674 # For configuration options please see the wiki page for m_dnsbl at #
675 # http://inspircd.org/wiki/DNS_Blacklist_Module #
677 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
678 # Filter module: Provides message filtering, similar to SPAMFILTER.
679 #<module name="m_filter.so">
681 # This module depends upon a regex provider such as m_regex_pcre or #
682 # m_regex_glob to function. You must specify which of these you want #
683 # m_filter to use via the tag below. #
685 # Valid engines are: #
687 # glob - Glob patterns, provided via m_regex_glob.so #
688 # pcre - PCRE regexps, provided via m_regex_pcre.so, needs libpcre #
689 # tre - TRE regexps, provided via m_regex_tre.so, requires libtre #
690 # posix - POSIX regexps, provided via m_regex_posix.so, not availale #
691 # on windows, no dependencies on other operating systems. #
693 #<filteropts engine="glob"> #
695 # Your choice of regex engine must match on all servers network-wide.
697 #-#-#-#-#-#-#-#-#-#-#- FILTER CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#
699 # Optional - If you specify to use the m_filter module, then #
700 # specfiy below the path to the filter.conf file, or define some #
703 #<include file="filter.conf">
705 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
706 # Foobar module: does nothing - historical relic
707 #<module name="m_foobar.so">
709 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
710 # Gecosban: Implements extended ban r:, which stops anyone matching
711 # a mask like +b r:*realname?here* from joining a channel.
712 #<module name="m_gecosban.so">
714 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
715 # GeoIP module: Allows the server admin to ban users by country code.
716 # This modules is in extras. Re-run configure with: ./configure --enable-extras=m_geoip.cpp
717 # and run make install, then uncomment this module to enable it.
718 #<module name="m_geoip.so">
720 #-#-#-#-#-#-#-#-#-#-#-# GEOIP CONFIGURATION #-#-#-#-#-#-#-#-#-#-#-#-#
722 # <geoip banunknown="false"> #
724 # Set this value to true or yes to block unknown IP ranges which are #
725 # not in the database (usually LAN addresses, localhost, etc) #
727 # <geoban country="TR" reason="This country not permitted"> #
729 # Use one or more of these tags to ban countries by country code. #
730 # The country code must be in capitals and should be an ISO country #
731 # code such as TR, GB, or US. #
733 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
734 # Globops module: gives /GLOBOPS and SNOMASK +g
735 # This module is oper-only.
736 # To use, GLOBOPS must be in one of your oper class blocks.
737 #<module name="m_globops.so">
739 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
740 # Global load module: Allows loading and unloading of modules network-
741 # wide (USE WITH EXTREME CAUTION!)
742 # This module is oper-only and provides /gloadmodule, /gunloadmodule
743 # and /greloadmodule.
744 # To use, GLOADMODULE, GUNLOADMODULE and GRELOADMODULE
745 # must be in one of your oper class blocks.
746 #<module name="m_globalload.so">
748 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
749 # HELPOP module: Provides the /HELPOP command
750 #<module name="m_helpop.so">
752 #-#-#-#-#-#-#-#-#-#-#-#- HELPOP CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
754 # Optional - If you specify to use the m_helpop.so module, then #
755 # specify below the path to the helpop.conf file, or if you like to #
756 # make a mess, define your helpop tags in this conf. #
758 #<include file="helpop.conf">
760 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
761 # HIDECHANS module: Allows opers to hide their channels list from non-
762 # opers by setting user mode +I on themselves.
763 # <module name="m_hidechans.so">
765 # HIDECHANS can optionally prevent opers from seeing channels on a +I
766 # user, for more privacy if set to true.
767 # This setting is not recommended for most mainstream networks.
768 #<hidechans affectsopers="false">
770 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
771 # HIDEOPER module: Allows opers to hide their oper status from non-
772 # opers by setting user mode +H on themselves.
773 # This module is oper-only.
774 # <module name="m_hideoper.so">
776 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
777 # Hostchange module: Allows a different style of cloaking
778 #<module name="m_hostchange.so">
780 #-#-#-#-#-#-#-#-#-#-#- HOSTCHANGE CONFIGURATION -#-#-#-#-#-#-#-#-#-#
782 # Optional - If you choose to use the m_hostchange.so module. #
783 # Config Help - See http://www.inspircd.org/wiki/Host_Changer_Module #
785 #<host suffix="polarbears.org" separator="." prefix="">
786 #<hostchange mask="*@fbi.gov" action="addnick">
787 #<hostchange mask="*r00t@*" action="suffix">
788 #<hostchange mask="a@b.com" action="set" value="blah.blah.blah">
789 #<hostchange mask="localhost" ports="7000,7001,7005-7007" action="set" value="blahblah.foo">
791 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
792 # httpd module: Provides http server support for InspIRCd
793 #<module name="m_httpd.so">
795 #-#-#-#-#-#-#-#-#-#-#-#- HTTPD CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
797 # Optional - If you choose to use the m_httpd.so module, then you must
798 # specify the port number and other details of your http server:
800 #<http ip="192.168.1.10" host="brainwave" port="32006"
801 # index="/home/brain/inspircd/http/index.html">
803 # You may have as many of these tags as you wish, each with a different
804 # IP, port, host or index file. Each one will act as an independent
808 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
809 # http ACL module: Provides access control lists for m_httpd dependent
810 # modules. Use this module to restrict pages by IP address and by
813 #<module name="m_httpd_acl.so">
815 #-#-#-#-#-#-#-#-#-#-#-#- HTTPD ACL CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
817 # Restrict access to the m_httpd_stats module to all but the local
818 # network and when the correct password is specified:
820 # <httpdacl path="/stats*" types="password,whitelist"
821 # username="secretstuff" password="mypasshere" whitelist="127.0.0.*,10.*">
823 # Deny all connections to all but the main index page:
825 # <httpdacl path="/*" types="blacklist" blacklist="*">
828 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
829 # http config module: Allows the server's configuration to be viewed
830 # over HTTP. Requires m_httpd.so to be loaded for it to function.
831 #<module name="m_httpd_config.so">
833 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
834 # http stats module: Provides basic stats pages over HTTP
835 # Requires m_httpd.so to be loaded for it to function.
836 #<module name="m_httpd_stats.so">
838 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
839 # Ident: Provides RFC 1413 ident lookup support
840 # When this module is loaded <connect:allow> tags may have an optional
841 # useident="yes|no" boolean value, determining whether or not to lookup
842 # ident on users matching that connect tag.
843 #<module name="m_ident.so">
845 #-#-#-#-#-#-#-#-#-#-#-#- IDENT CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
847 # Optional - If you are using the m_ident.so module, then you can #
848 # specify the timeout for ident lookups here. If not defined, it will #
849 # default to one second. This is a non-blocking timeout which holds #
850 # the user in a 'connecting' state until the lookup is complete. #
851 # The bind value indicates which IP to bind outbound requests to. #
855 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
856 # Invite except module: Adds support for channel invite exceptions (+I)
857 #<module name="m_inviteexception.so">
859 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
860 # Invisible module - Adds support for usermode +Q (quiet) which lets an
861 # oper go 'invisible' similar to unrealircd 3.1's +I mode. Note that
862 # opers are still able to see invisible users, and if an oper with +Q
863 # deopers, they will become visible.
865 # IMPORTANT NOTE: To allow this mode to be used by a type of oper, you
866 # must first add the value canquiet="yes" to that oper's type tag.
868 # This module is oper-only.
870 #<module name="m_invisible.so">
872 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
873 # Join flood module: Adds support for join flood protection (+j)
874 #<module name="m_joinflood.so">
876 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
877 # Jump Server module: Adds support for the RPL_REDIR numeric
878 # This module is oper-only.
879 # To use, JUMPSERVER must be in one of your oper class blocks.
880 #<module name="m_jumpserver.so">
882 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
883 # Anti-Auto-Rejoin: Adds support for prevention of auto-rejoin (+J)
884 #<module name="m_kicknorejoin.so">
886 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
887 # Knock module: adds the /KNOCK command and +K channel mode
888 #<module name="m_knock.so">
890 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
891 # LDAP authentication module: Adds the ability to authenticate users #
892 # via LDAP. This is an extra module which must be enabled explicitly #
893 # by symlinking it from modules/extra, and requires the OpenLDAP libs #
894 # This modules is in extras. Re-run configure with: ./configure --enable-extras=m_ldapauth.cpp
895 # and run make install, then uncomment this module to enable it. #
897 #<module name="m_ldapauth.so"> #
901 # <ldapauth baserdn="ou=People,dc=brainbox,dc=cc" #
903 # server="ldap://brainwave.brainbox.cc" #
904 # allowpattern="Guest*" #
905 # killreason="Access denied" #
906 # searchscope="subtree" #
907 # binddn="cn=Manager,dc=brainbox,dc=cc" #
908 # bindauth="mysecretpass" #
911 # The baserdn indicates the base DN to search in for users. Usually #
912 # this is 'ou=People,dc=yourdomain,dc=yourtld'. #
914 # The attribute value indicates the attribute which is used to locate #
915 # a user account by name. On POSIX systems this is usually 'uid'. #
917 # The server parameter indicates the LDAP server to connect to. The #
918 # ldap:// style scheme before the hostname proper is MANDITORY. #
920 # The allowpattern value allows you to specify a wildcard mask which #
921 # will always be allowed to connect regardless of if they have an #
922 # account, for example guest users. #
924 # Killreason indicates the QUIT reason to give to users if they fail #
927 # The searchscope value indicates the subtree to search under. On our #
928 # test system this is 'subtree'. Your mileage may vary. #
930 # Setting the verbose value causes an oper notice to be sent out for #
931 # every failed authentication to the server, with an error string. #
933 # The binddn and bindauth indicate the DN to bind to for searching, #
934 # and the password for the distinguished name. Some LDAP servers will #
935 # allow anonymous searching in which case these two values do not #
936 # need defining, otherwise they should be set similar to the examples #
939 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
940 # LDAP oper configuration module: Adds the ability to authenticate #
941 # opers via LDAP. This is an extra module which must be enabled #
942 # explicitly by symlinking it from modules/extra, and requires the #
943 # OpenLDAP libs. Re-run configure with: ./configure --enable-extras=m_ldapoper.cpp
944 # and run make install, then uncomment this module to enable it. #
946 #<module name="m_ldapoper.so">
950 # <ldapoper baserdn="ou=People,dc=brainbox,dc=cc"
951 # server="ldap://brainwave.brainbox.cc"
952 # searchscope="subtree"
953 # binddn="cn=Manager,dc=brainbox,dc=cc"
954 # bindauth="mysecretpass">
956 # Available configuration items are identical to the same items in #
957 # m_ldapauth above. #
959 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
960 # Lock server module: Adds /LOCKSERV and /UNLOCKSERV commands that is #
961 # used to temporarily close/open for new connections to the server. #
962 # These commands require OPER status and that the LOCKSERV UNLOCKSERV #
963 # are specified in a <class> tag that the oper is part of. This is so #
964 # you can control who has access to this possible dangerous command. #
965 # If your server is locked and you got disconnected, do a REHASH from #
966 # shell to open up again.
968 # This module is oper-only.
970 #<module name="m_lockserv.so">
972 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
973 # Map hiding module: replaces /MAP and /LINKS output to users with a #
974 # message to see a website, set by maphide="http://link.to/site" in #
975 # the security tag, instead. #
976 #<module name="m_maphide.so">
978 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
979 # Msg flood module: Adds message/notice flood protection (+f)
980 #<module name="m_messageflood.so">
982 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
983 # MsSQL module: Allows other SQL modules to access MS SQL Server
984 # through a unified API. You must copy the source for this module
985 # from the directory src/modules/extra, plus the file m_sqlv2.h
986 # This modules is in extras. Re-run configure with: ./configure --enable-extras=m_mssql.cpp
987 # and run make install, then uncomment this module to enable it.
989 #<module name="m_mssql.so">
991 #-#-#-#-#-#-#-#-#-#-#-#- SQL CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#-#
993 # m_mssql.so is more complex than described here, see wiki for more #
994 # info http://www.inspircd.org/wiki/SQLServer_Service_Provider_Module #
996 #<database name="db" username="user" password="pass" hostname="localhost" id="db1">
998 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
999 # MySQL module: Allows other SQL modules to access MySQL databases
1000 # through a unified API. You must copy the source for this module
1001 # from the directory src/modules/extra, plus the file m_sqlv2.h
1002 # This modules is in extras. Re-run configure with: ./configure --enable-extras=m_mysql.cpp
1003 # and run make install, then uncomment this module to enable it.
1005 #<module name="m_mysql.so">
1007 #-#-#-#-#-#-#-#-#-#-#-#- SQL CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#-#
1009 # m_mysql.so is more complex than described here, see the wiki for #
1010 # more: http://www.inspircd.org/wiki/SQL_Service_Provider_Module #
1012 #<database name="mydb" username="myuser" password="mypass" hostname="localhost" id="my_database2">
1014 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1015 # NAMESX module: Provides support for the NAMESX extension which allows
1016 # clients to see all the prefixes set on a user without getting confused.
1017 # This is supported by mIRC, x-chat, klient, and maybe more.
1018 #<module name="m_namesx.so">
1020 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1021 # National characters module:
1022 # 1) Allows using national characters in nicknames.
1023 # 2) Allows using custom (national) casemapping over the network.
1024 # file -- filename of existing file in "locales" directory
1025 # casemapping -- custom value for 005 numeric (if you want it to be
1026 # different from the filename.
1028 #<nationalchars file="bynets/russian-w1251-charlink" casemapping="ru_RU.cp1251-charlink">
1029 #<module name="m_nationalchars.so">
1031 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1032 # Nickchange flood protection module: Allows up to X nick changes in Y seconds.
1033 # Provides channel mode +F.
1034 #<module name="m_nickflood.so">
1036 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1037 # Nicklock module: Let opers change a user's nick and then stop that
1038 # user from changing their nick again.
1039 # This module is oper-only.
1040 # To use, NICKLOCK and NICKUNLOCK must be in one of your oper class blocks.
1041 #<module name="m_nicklock.so">
1043 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1044 # No ctcp module: Adds the channel mode +C to block CTCPs
1045 #<module name="m_noctcp.so">
1047 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1048 # No kicks module: Adds the +Q channel mode
1049 #<module name="m_nokicks.so">
1051 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1052 # No nicks module: Adds the +N channel mode, as well as the +b N:
1053 # extended bantype. +N stops all users from changing their nick,
1054 # the +b N: extban stops anyone from matching a +b N:nick!user@host
1055 # mask from changing their nick.
1056 #<module name="m_nonicks.so">
1058 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1059 # No part message module: adds extban 'p' to block part messages from #
1061 #<module name="m_nopartmsg.so">
1063 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1064 # No Notice module: adds the channel mode +T
1065 #<module name="m_nonotice.so">
1067 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1068 # Oper channels mode: Adds the +O channel mode
1069 # This module is oper-only.
1070 #<module name="m_operchans.so">
1072 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1073 # Oper invex/extban module: Adds +beI type O, to ban, exempt, and invex
1074 # given oper type masks.
1075 # e.g, /mode #channel +iI O:* is equivilant to chmode +O, but you
1076 # may also, e.g. /mode #channel +iI O:AdminTypeOnly to only allow admins.
1077 # +be work in a similar fashion.
1078 # This module is oper-only.
1080 #<module name="m_operinvex.so">
1082 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1083 # Oper Join module: Auto-joins opers to a channel upon oper-up
1084 # This module is oper-only. For the user equivalent, see m_conn_join.
1085 #<module name="m_operjoin.so">
1087 #-#-#-#-#-#-#-#-#-#-# OPERJOIN CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
1089 # If you are using the m_operjoin.so module, specify options here: #
1091 # channel - The channel name to join, can also be a comma #
1092 # seperated list eg. "#channel1,#channel2". #
1094 # override - Lets the oper join walking thru any modes that #
1095 # might be set, even bans. Use "yes" or "no". #
1097 #<operjoin channel="#channel" override="no">
1099 # Alternatively you can use the autojoin="channellist" in a <type> #
1100 # tag to set specific autojoins for a type of oper, for example: #
1102 #<type name="Helper" autojoin="#help" classes="...">
1104 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1105 # Oper log module: Logs all oper commands to the ircd log at default
1107 # This module is oper-only.
1108 #<module name="m_operlog.so">
1110 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1111 # Oper prefixing module: Gives IRC operators a prefix status character
1112 # on all channels they are in.
1114 #<module name="m_operprefix.so">
1116 # You may additionally customise the prefix character.
1117 #<operprefix prefix="!">
1119 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1120 # Oper MOTD module: Provides support for seperate message of the day
1122 # This module is oper-only.
1123 #<module name="m_opermotd.so">
1125 #-#-#-#-#-#-#-#-#-#-# OPERMOTD CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
1127 # If you are using the m_opermotd.so module, specify the motd here #
1129 # onoper - Should the message be sent on /OPER or only when #
1130 # /OPERMOTD is used. Use "yes" or "no". #
1132 #<opermotd file="oper.motd" onoper="yes">
1134 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1135 # Override module: Adds support for oper override
1136 # This module is oper-only.
1137 #<module name="m_override.so">
1139 #-#-#-#-#-#-#-#-#-#-# OVERRIDE CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
1141 # m_override.so is too complex it describe here, see the wiki: #
1142 # http://www.inspircd.org/wiki/Oper_Override_Module #
1144 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1145 # Oper levels module: Gives each oper a level and prevents
1146 # actions being taken against higher level opers
1147 # Specify the level as the 'level' parameter of the <type> tag
1148 # # This module is oper-only.
1149 #<module name="m_operlevels.so">
1151 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1152 # Oper modes module: Allows you to specify modes to add/remove on oper
1153 # Specify the modes as the 'modes' parameter of the <type> tag
1154 # and/or as the 'modes' parameter of the <oper> tag.
1155 # This module is oper-only. For the user equivalent, see m_conn_umodes
1156 #<module name="m_opermodes.so">
1158 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1159 # Oper password hash module: Allows hashed oper passwords
1160 # Relies on the module m_md5.so and/or m_sha256.so being loaded before
1161 # m_password_hash.so in the configuration file.
1162 # This module is oper-only.
1163 #<module name="m_password_hash.so">
1165 #-#-#-#-#-#-#-#-#-#-# OPER HASH CONFIGURATION #-#-#-#-#-#-#-#-#-#-#-#-#
1167 # To use this module, you must define a hash type for each oper's
1168 # password you want to hash. For example:
1170 # <oper name="Brain"
1171 # host="ident@dialup15.isp.com"
1173 # password="a41d730937a53b79f788c0ab13e9e1d5"
1176 # The types of hashing available vary depending on which hashing modules
1177 # you load, but usually if you load m_sha256.so and m_md5.so, both md5
1178 # and sha256 type hashing will be available (the most secure of which
1181 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1182 # Permanent Channels module: Channels with the permanent channels mode
1183 # will remain open even after everyone else has left the channel, and
1184 # therefore keep things like modes, ban lists and topic. Permanent
1185 # channels -may- need support from your Services package to function
1186 # properly with them. This adds channel mode +P.
1187 # This module is oper-only.
1188 #<module name="m_permchannels.so">
1190 # You may also create channels on startup by using the <permchannels> block.
1191 #<permchannels channel="#opers" modes="is" topic="Opers only.">
1193 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1194 # PostgreSQL module: Allows other SQL modules to access PgSQL databases
1195 # through a unified API. You must copy the source for this module
1196 # from the directory src/modules/extra, plus the file m_sqlv2.h
1197 # This modules is in extras. Re-run configure with: ./configure --enable-extras=m_pgsql.cpp
1198 # and run make install, then uncomment this module to enable it.
1200 #<module name="m_pgsql.so">
1202 #-#-#-#-#-#-#-#-#-#-#-#- SQL CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#-#
1204 # m_pgsql.so is more complex than described here, see the wiki for #
1205 # more: http://www.inspircd.org/wiki/SQL_Service_Provider_Module #
1207 #<database name="mydb" username="myuser" password="mypass" hostname="localhost" id="my_database" ssl="no">
1209 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1210 # Muteban: Implements extended ban m:, which stops anyone matching
1211 # a mask like +b m:nick!user@host from speaking on channel.
1212 #<module name="m_muteban.so">
1215 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1216 # Random Quote module: provides a random quote on connect.
1217 # NOTE: Some of these may mimic fatal errors and confuse users and
1218 # opers alike! - BEWARE!
1219 #<module name="m_randquote.so">
1221 #-#-#-#-#-#-#-#-#-#- RANDOMQUOTES CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
1223 # Optional - If you specify to use the m_randquote.so module, then #
1224 # specify below the path to the randquotes.conf file. #
1226 #<randquote file="randquotes.conf">
1228 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1229 # Redirect module: Adds channel redirection (mode +L)
1230 #<module name="m_redirect.so">
1232 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1233 # Regular Expression Provider for Glob or wildcard (?/*) matching.
1234 # You must have at least 1 provider loaded to use m_filter or m_rline
1235 # modules. This module has no additional requirements, as it uses the
1236 # matching already present in InspIRCd core.
1237 #<module name="m_regex_glob.so">
1239 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1240 # Regular Expression Provider for PCRE (Perl-Compatible Regular
1241 # Expressions). You need libpcre installed to compile and load this
1242 # module. You must have at least 1 provider loaded to use m_filter or
1244 #<module name="m_regex_pcre.so">
1246 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1247 # Regular Expression Provider for POSIX Regular Expressions.
1248 # You shouldn't need any additional libraries on a POSIX-compatible
1249 # system (ie: any Linux, BSD, but not Windows). You must have at least
1250 # 1 provider loaded to use m_filter or m_rline.
1251 # On POSIX-compliant systems, regex syntax can be found by using the
1252 # command: 'man 7 regex'.
1253 #<module name="m_regex_posix.so">
1255 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1256 # Regular Expression Provider for TRE Regular Expressions.
1257 # This is the same regular expression engine used by UnrealIRCd, so
1258 # if you are most familiar with the syntax of /spamfilter from there,
1259 # this is the provider you want. You need libtre installed in order
1260 # to compile and load this module.
1261 #<module name="m_regex_tre.so">
1263 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1264 # Registered users only channel creation
1265 # Allows only registered users and opers to create new channels.
1266 #<module name="m_regonlycreate.so">
1268 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1269 # Remove module: Adds the /REMOVE command which is a peaceful
1270 # alternative to /KICK
1271 #<module name="m_remove.so">
1273 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1274 # Restricted channels module: Allows only opers to create channels
1275 #<module name="m_restrictchans.so">
1277 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1278 # Restrict message module: Allows users to only message opers
1279 #<module name="m_restrictmsg.so">
1281 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1282 # Ban users through regular expression patterns
1283 #<module name="m_rline.so">
1285 #-#-#-#-#-#-#-#-#-#-#-#- RLINE CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#-#
1287 # If you wish to re-check a user when they change nickname (can be
1288 # useful under some situations, but *can* also use CPU with more users
1289 # on a server) then set the following configuration value:
1290 # Also, this is where you set what Regular Expression engine is to be
1291 # used. If you ever change it while running, all of your R-Lines will be
1292 # wiped. This is the regex engine used by all R-Lines set, and
1293 # m_regex_<engine>.so must be loaded, or rline will be nonfunctional
1294 # until you load it or change the engine to one that is loaded.
1296 #<rline matchonnickchange="yes" engine="pcre">
1298 # Generally, you will NOT want to use 'glob' here, as this turns
1299 # rline into just another gline. The exceptions are that rline will
1300 # always use the full nick!user@host realname string, rather than only
1301 # user@host, but beware that only the ? and * wildcards are available,
1302 # and are the only way to specify where the space can occur if you do
1303 # use glob. For this reason, is recommended to use a real regex engine
1304 # so that at least \s or [[:space:]] is available.
1306 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1307 # JSON-RPC module: Encode and decode JSON-RPC requests for modules
1308 #<module name="m_rpc_json.so">
1310 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1311 # RPC test module: A test of the RPC API
1312 #<module name="m_rpctest.so">
1314 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1315 # Provide /LIST throttling (to prevent flooding) and /LIST safety to
1316 # prevent excess flood when the list is large.
1317 #<module name="m_safelist.so">
1319 #-#-#-#-#-#-#-#-#-#-# SAFELIST CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#-#
1321 # When using Safelist, you may set the following values;
1323 # The first value, 'throttle', sets the amount of time in seconds a user
1324 # must wait between LIST commands. For example, if this is set to 60
1325 # (the default) then the user may not /LIST more than once a minute.
1326 # If not defined, the default value is 60 seconds.
1328 # The second value, 'maxlisters', indicates the maximum number of users
1329 # which may be retrieving a LIST at once. It is not recommended you raise
1330 # this value, as increasing it too high can make your network vulnerable
1331 # to floodbots which waste your bandwidth and CPU time with LIST requests.
1333 #<safelist throttle="60" maxlisters="50">
1335 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1336 # SAJOIN module: Adds the /SAJOIN command
1337 # This module is oper-only.
1338 # To use, SAJOIN must be in one of your oper class blocks.
1339 #<module name="m_sajoin.so">
1341 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1342 # SAKICK module: Adds the /SAKICK command
1343 # This module is oper-only.
1344 # To use, SAKICK must be in one of your oper class blocks.
1345 #<module name="m_sakick.so">
1347 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1348 # SAMODE module: Adds the oper /SAMODE command
1349 # This module is oper-only.
1350 # To use, SAMODE must be in one of your oper class blocks.
1351 #<module name="m_samode.so">
1353 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1354 # SANICK module: Allows opers to change user's nicks
1355 # This module is oper-only.
1356 # To use, SANICK must be in one of your oper class blocks.
1357 #<module name="m_sanick.so">
1359 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1360 # SAPART module: Adds the oper /SAPART command
1361 # This module is oper-only.
1362 # To use, SAPART must be in one of your oper class blocks.
1363 #<module name="m_sapart.so">
1365 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1366 # SAQUIT module: Adds the oper /SAQUIT command (abusable!!!)
1367 # This module is oper-only.
1368 # To use, SAQUIT must be in one of your oper class blocks.
1369 #<module name="m_saquit.so">
1371 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1372 # SATOPIC module: Adds the oper /SATOPIC command
1373 # This module is oper-only.
1374 # To use, SATOPIC must be in one of your oper class blocks.
1375 #<module name="m_satopic.so">
1377 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1378 # SASL authentication module: Provides support for IRC Authentication
1379 # Layer (aka: atheme SASL) via AUTHENTICATE.
1380 #<module name="m_sasl.so">
1382 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1383 # Secure list module: Prevent /LIST in the first minute of connection,
1384 # crippling most spambots and trojan spreader bots.
1385 #<module name="m_securelist.so">
1387 #-#-#-#-#-#-#-#-#-# SECURELIST CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#-#
1389 # Securelist can be harmful to some irc search engines such as #
1390 # netsplit.de and searchirc.com. To prevent securelist blocking these #
1391 # sites from listing, define exception tags as shown below: #
1392 <securehost exception="*@*.searchirc.org">
1393 <securehost exception="*@*.netsplit.de">
1394 <securehost exception="*@echo940.server4you.de">
1396 # Define the following variable to change how long a user must wait #
1397 # before issuing a LIST. If not defined, defaults to 60 seconds. #
1399 #<securelist waittime="60"> #
1401 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1402 # Servprotect module: Provides support for Austhex style +k /
1403 # UnrealIRCD +S services mode
1404 #<module name="m_servprotect.so">
1406 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1407 # See nicks module: Allow for SNOMASK +N which shows nick changes.
1408 # This module is oper-only.
1409 #<module name="m_seenicks.so">
1411 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1412 # Set Idle module: Adds a command for opers to change their
1413 # idle time (mainly a toy)
1414 # This module is oper-only.
1415 # To use, SETIDLE must be in one of your oper class blocks.
1416 #<module name="m_setidle.so">
1418 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1419 # Services support module: Adds several usermodes such as +R and +M
1420 # this module implements the 'identified' state via account names (AC)
1421 # and is similar in operation to the way asuka and ircu handle services.
1423 # At the same time, this offers +r for users and channels to mark them
1424 # as identified seperately from the idea of a master account, which
1425 # can be useful for services which are heavily nick-as-account centric.
1427 # This replaces m_services from 1.1 and earlier.
1429 # Also of note is that this module implements two extbans:
1430 # +b R: (stop matching account names from joining)
1431 # +b M: (stop matching account names from speaking)
1433 #<module name="m_services_account.so">
1435 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1436 # Sethost module: Adds the /SETHOST command
1437 # This module is oper-only.
1438 # To use, SETHOST must be in one of your oper class blocks.
1439 # See m_chghost for how to customise valid chars for hostnames
1440 #<module name="m_sethost.so">
1442 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1443 # Setident module: Adds the /SETIDENT command
1444 # This module is oper-only.
1445 # To use, SETIDENT must be in one of your oper class blocks.
1446 #<module name="m_setident.so">
1448 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1449 # SETNAME module: Adds the /SETNAME command
1450 # This module is oper-only.
1451 # To use, SETNAME must be in one of your oper class blocks.
1452 #<module name="m_setname.so">
1454 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1455 # Serverban: Implements extended ban s:, which stops anyone connected
1456 # to a server matching a mask like +b s:server.mask.here from joining.
1457 #<module name="m_serverban.so">
1459 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1460 # Show Whois module: Adds the +W usermode which allows opers
1461 # to see when they are whois'ed (can be annoying).
1462 # This module is oper-only.
1463 #<module name="m_showwhois.so">
1465 # If you wish, you may also let users set this mode. Only opers with the
1466 # users/auspex priv will see real hosts of people, though. This setting
1467 # is not reloadable via /rehash, and will require /reloadmodule, as
1468 # it directly affects the mode object itself.
1469 #<showwhois opersonly="yes"
1471 # You may also set whether or not users should recieve whois notices, should
1472 # they be /whois'd by an oper.
1473 # showfromopers="yes">
1475 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1476 # Shun module: Provides the /shun command, which stops a user executing
1478 # This module is oper-only.
1479 # To use, SHUN must be in one of your oper class blocks.
1480 #<module name="m_shun.so">
1482 # You may also configure which commands you wish a user to be able to
1483 # perform. It should be noted that if a shunned user issues QUIT or PART
1484 # then their message will be removed, as if they did not issue one.
1486 # You can (optionally) let the user know that their command was blocked.
1488 # You may also let SHUN affect opers (defaults to no).
1489 #<shun enabledcommands="PING PONG QUIT PART JOIN" notifyuser="yes" affectopers="no">
1491 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1492 # Spy module: Provides the ability to see the complete names list of
1493 # channels an oper is not a member of
1494 # This module is oper-only.
1495 #<module name="m_spy.so">
1497 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1498 # SSL channel mode module: Adds support for SSL-only channels (+z).
1499 # does not do anything useful without a working SSL module (see below)
1500 #<module name="m_sslmodes.so">
1502 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1503 # Dummy ssl module: If you have other servers on your network which
1504 # have SSL, but your server does not have ssl enabled, you should load
1505 # this module, which will handle SSL metadata (e.g. the "Is using ssl"
1506 # field in the WHOIS information).
1507 #<module name="m_ssl_dummy.so">
1509 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1510 # GnuTLS ssl module: Adds support for client-server SSL using GnuTLS,
1511 # if enabled. You must copy the source for this module from the directory
1512 # src/modules/extra, or answer 'yes' in ./configure when asked if you
1513 # want to enable this, or it will not load.
1514 #<module name="m_ssl_gnutls.so">
1516 #-#-#-#-#-#-#-#-#-#-#- GNUTLS CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#
1518 # m_ssl_gnutls.so is too complex it describe here, see the wiki: #
1519 # http://www.inspircd.org/wiki/GnuTLS_SSL_Module #
1521 # NOTE: If you want to use this module to encrypt and sign your #
1522 # server to server traffic, you MUST load it before m_spanningtree in #
1523 # your configuration file! #
1525 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1526 # SSL Info module: Allows users to retrieve information about other
1527 # user's peer SSL certificates and keys. This can be used by client
1528 # scripts to validate users. For this to work, one of m_ssl_gnutls.so
1529 # or m_ssl_openssl.so must be loaded. You must symlink the source for
1530 # this module from the directory src/modules/extra.
1531 # This modules is in extras. Re-run configure with: ./configure --enable-extras=m_sslinfo.cpp
1532 # and run make install, then uncomment this module to enable it.
1534 #<module name="m_sslinfo.so">
1536 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1537 # OpenSSL ssl module: Adds support for client-server SSL using OpenSSL,
1538 # if enabled. You must copy the source for this module from the directory
1539 # src/modules/extra, or answer 'yes' in ./configure when asked if you
1540 # want to enable this, or it will not load.
1541 #<module name="m_ssl_openssl.so">
1543 #-#-#-#-#-#-#-#-#-#-#- OPENSSL CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#
1545 # m_ssl_openssl.so is too complex it describe here, see the wiki: #
1546 # http://www.inspircd.org/wiki/OpenSSL_SSL_Module #
1548 # NOTE: If you want to use this module to encrypt and sign your #
1549 # server to server traffic, you MUST load it before m_spanningtree in #
1550 # your configuration file! #
1552 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1553 # SSL Cert Oper module: Allows opers to oper up using the key fingerprint
1554 # stored within their SSL certificate and key pair.
1555 # When using this module, one of m_ssl_gnutls.so or m_ssl_openssl.so must
1556 # be loaded. An extra value should be added to enabled opers, which
1557 # is in the following format: fingerprint="<hash>". For more information,
1558 # see the example in the oper blocks.
1559 # This module is oper-only.
1560 #<module name="m_ssl_oper_cert.so">
1562 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1563 # Strip colour module: Adds the channel mode +S
1564 #<module name="m_stripcolor.so">
1566 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1567 # SILENCE module: Adds support for /SILENCE
1568 #<module name="m_silence.so">
1570 # Configuration tags:
1572 #<silence maxentries="32">
1574 # Sets the maximum number of entries on a users silence list.
1576 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1577 # SQLite3 module: Allows other SQL modules to access SQLite3 #
1578 # databases through a unified API. You must link the source for this #
1579 # module from the directory src/modules/extra to src/modules, plus #
1580 # the file m_sqlv2.h #
1581 # This modules is in extras. Re-run configure with: ./configure --enable-extras=m_aqlite.cpp
1582 # and run make install, then uncomment this module to enable it. #
1584 #<module name="m_sqlite3.so">
1586 #-#-#-#-#-#-#-#-#-#-#-#- SQL CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#-#
1588 # m_sqlite.so is more complex than described here, see the wiki for #
1589 # more: http://www.inspircd.org/wiki/SQLite3_Service_Provider_Module #
1591 #<database hostname="/full/path/to/database.db" id="anytext">
1593 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1594 # SQLutils module: Provides some utilities to SQL client modules, such
1595 # as mapping queries to users and channels. You must copy the source
1596 # for this module from the directory src/modules/extra/m_sqlutils.cpp
1597 # and src/modules/extra/m_sqlutils.h into /src/modules
1598 # Needed for, and loaded before: SQLauth and SQLoper
1599 # This modules is in extras. Re-run configure with: ./configure --enable-extras=m_sqlutils.cpp
1600 # and run make install, then uncomment this module to enable it.
1602 #<module name="m_sqlutils.so">
1604 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1605 # SQL authentication module: Allows IRCd connections to be tied into
1606 # a database table (for example a forum). You must copy the source for
1607 # this module from the directory src/modules/extra
1608 # Depends on the SQLutils module being loaded first.
1609 # This modules is in extras. Re-run configure with: ./configure --enable-extras=m_sqlauth.cpp
1610 # and run make install, then uncomment this module to enable it.
1612 #<module name="m_sqlauth.so">
1614 #-#-#-#-#-#-#-#-#-#-#- SQLAUTH CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#
1616 # m_sqlauth.so is too complex it describe here, see the wiki: #
1617 # http://www.inspircd.org/wiki/SQL_Authentication_Module #
1619 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1620 # SQL logging module: Allows you to log network-wide data for your
1621 # network in a fully normalised set of SQL tables. You must copy the
1622 # source for this module from the directory src/modules/extra
1623 # This modules is in extras. Re-run configure with: ./configure --enable-extras=m_sqllog.cpp
1624 # and run make install, then uncomment this module to enable it.
1626 #<module name="m_sqllog.so">
1628 #-#-#-#-#-#-#-#-#-#-#- SQLLOG CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#
1630 # dbid - Database ID to use (see m_sql) #
1632 # See also: http://www.inspircd.org/wiki/SQL_Logging_Module #
1636 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1637 # SQL oper module: Allows you to store oper credentials in an SQL table
1638 # You must copy the source for this module from the directory src/modules/extra
1639 # Depends on the SQLutils module being loaded first.
1640 # This modules is in extras. Re-run configure with: ./configure --enable-extras=m_sqloper.cpp
1641 # and run make install, then uncomment this module to enable it.
1643 #<module name="m_sqloper.so">
1645 #-#-#-#-#-#-#-#-#-#-#- SQLOPER CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#
1647 # dbid - Database ID to use (see m_sql) #
1648 # hash - Hashing provider to use for password hashing #
1650 # See also: http://www.inspircd.org/wiki/SQL_Oper_Storage_Module #
1652 #<sqloper dbid="1" hash="md5">
1654 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1655 # SVSHold module: Implements SVSHOLD. Like Q:Lines, but can only be #
1656 # added/removed by Services. #
1657 #<module name="m_svshold.so">
1659 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1660 # SWHOIS module: Allows you to add arbitary lines to user WHOIS.
1661 # This module is oper-only.
1662 # To use, SWHOIS must be in one of your oper class blocks.
1663 #<module name="m_swhois.so">
1665 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1666 # Taxonomy module: Adds the /TAXONOMY command, used to view all
1667 # metadata attached to a user.
1668 # This module is oper-only.
1669 # To use, TAXONOMY must be in one of your oper class blocks.
1670 #<module name="m_taxonomy.so">
1672 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1673 # Test command module: Does nothing significant. Read: pointless.
1674 #<module name="m_testcommand.so">
1676 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1677 # Timed bans module: Adds timed bans and the /TBAN command
1678 # This module is oper-only.
1679 # To use, TBAN must be in one of your oper class blocks.
1680 #<module name="m_timedbans.so">
1682 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1683 # Test line module: Adds the /TLINE command, used to test how many
1684 # users a /GLINE or /ZLINE etc would match.
1685 # This module is oper-only.
1686 # To use, TLINE must be in one of your oper class blocks.
1687 #<module name="m_tline.so">
1689 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1690 # UHNAMES support module: Adds support for the IRCX style UHNAMES
1691 # extension, which displays ident and hostname in the names list for
1692 # each user, saving clients from doing a WHO on the channel. Note that
1693 # this module is not widely supported yet. If a client does not support
1694 # UHNAMES it will not enable it, this will not break incompatible
1696 #<module name="m_uhnames.so">
1698 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1699 # Uninvite module: Adds the /UNINVITE command which lets users remove
1700 # pending invites from channels without waiting for the user to join.
1701 #<module name="m_uninvite.so">
1703 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1704 # Userip module: Adds the /USERIP command
1705 # This module is oper-only.
1706 # To use, USERIP must be in one of your oper class blocks.
1707 #<module name="m_userip.so">
1709 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1710 # Vhost module: Adds the VHOST command which allows for adding virtual
1711 # hosts which are accessible using a username and password in the config.
1712 #<module name="m_vhost.so">
1714 #-#-#-#-#-#-#-#-#-#-#- VHOST CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#-#
1716 # user - Username for the vhost. #
1718 # pass - Password for the vhost. #
1720 # host - Vhost to set. #
1722 #<vhost user="some_username" pass="some_password" host="some.host">
1724 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1725 # Watch module: Adds the WATCH command, which is used by clients to
1726 # maintain notify lists.
1727 #<module name="m_watch.so">
1729 # Configuration tags:
1731 #<watch maxentries="32">
1733 # Sets the maximum number of entries on a user's watch list.
1735 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1736 # XLine database: Stores all *Lines (G/Z/K/R/any added by other modules)
1737 # in a file "xline.db" which can be re-loaded on restart. This is useful
1738 # for two reasons: it keeps bans so users may not evade them, and on
1739 # bigger networks, server connections will take less time as there will
1740 # be a lot less bans to apply - as most of them will already be there.
1741 #<module name="m_xline_db.so">
1743 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1744 # ZipLinks module: Adds support for zlib deflate on server to server
1745 # connections. Both ends of the connection must load this module.
1746 # This modules is in extras. Re-run configure with: ./configure --enable-extras=m_ziplink.cpp
1747 # and run make install, then uncomment this module to enable it.
1749 #<module name="m_ziplink.so">
1751 # To use this module, you must enable it as a transport type in your
1752 # <link> tags or <bind> tags using the transport name 'zip'.
1753 # See the documentation of <link> and <bind>, respectively.
1757 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1758 # ____ _ _____ _ _ ____ _ _ _ #
1759 # | _ \ ___ __ _ __| | |_ _| |__ (_)___ | __ )(_) |_| | #
1760 # | |_) / _ \/ _` |/ _` | | | | '_ \| / __| | _ \| | __| | #
1761 # | _ < __/ (_| | (_| | | | | | | | \__ \ | |_) | | |_|_| #
1762 # |_| \_\___|\__,_|\__,_| |_| |_| |_|_|___/ |____/|_|\__(_) #
1764 # To link servers to InspIRCd, you MUST load the m_spanningtree #
1765 # module. Since several features (like SSL server links) rely on #
1766 # other modules being loaded before m_spanningtree, the module itself #
1767 # is at the bottom of this file. DO NOT forget to load it. If you DO #
1768 # NOT do this, server links will NOT work at all. ie. The ports will #
1769 # NOT bind, and /connect will not work properly. This is by design, #
1770 # to allow for the implementation of other linking protocols in #
1771 # modules in the future. #
1774 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1775 # Spanning Tree module - allows linking of servers using the spanning
1776 # tree protocol (see the READ THIS BIT section above).
1777 # You will almost always want to load this.
1779 #<module name="m_spanningtree.so">
projects / user / henk / code / inspircd.git / blob