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">
79 # Set the prefix for in-channel aliases (fantasy commands) to the
80 # specified character. If not set, the default is "!".
82 #-#-#-#-#-#-#-#-#-#-#- ALIAS DEFINITIONS -#-#-#-#-#-#-#-#-#-#-#-#-#-#
84 # If you have the m_alias.so module loaded, you may also define #
85 # aliases as shown below. They are commonly used to provide shortcut #
86 # commands to services, however they are not limited to just this use.#
87 # An alias tag requires the following values to be defined in it: #
89 # text - The text to detect as the actual command line, #
90 # Cant contain spaces, but case insensitive. #
91 # You may have multiple aliases with the same #
92 # command name (text="" value), however the first #
93 # found will be executed if its format value is #
94 # matched, or it has no format value. Aliases are #
95 # read from the top of the file to the bottom. #
97 # usercommand - If this is true, the alias can be run simply as #
98 # /aliasname. Defaults to true. #
100 # channelcommand - If this is true, the alias can be used as an #
101 # in-channel alias or 'fantasy command', prefixed #
102 # by the fantasy prefix character, !aliasname by #
103 # default. Defaults to false. #
105 # format - If this is defined, the parameters of the alias #
106 # must match this glob pattern. For example if you #
107 # want the first parameter to start with a # for #
108 # the alias to be executed, set format="#*" in the #
109 # alias definition. Note that the :'s which are #
110 # part of IRC formatted lines will be preserved #
111 # for matching of this text. This value is #
114 # replace - The text to replace 'text' with. Usually this #
115 # will be "PRIVMSG ServiceName :$2-" or similar. #
116 # You may use the variables $1 through $9 in the #
117 # replace string, which refer to the first through #
118 # ninth word in the original string typed by the #
119 # user. You may also use $1- through $9- which #
120 # refer to the first word onwards, through to the #
121 # ninth word onwards, e.g. if the user types the #
122 # command "foo bar baz qux quz" then $3- will hold #
123 # "baz qux quz" and $2 will contain "bar". You may #
124 # also use the special variables: $nick, $ident, #
125 # $host and $vhost, and you may separate multiple #
126 # commands with \n. If you wish to use the ACTUAL #
127 # characters \ and n together in a line, you must #
128 # use the sequence "\\n". #
130 # requires - If you provide a value for 'requires' this means #
131 # the given nickname MUST be online for the alias #
132 # to successfully trigger. If they are not, then #
133 # the user receives a 'no such nick' 401 numeric. #
135 # uline - Defining this value with 'yes', 'true' or '1' #
136 # will ensure that the user given in 'requires' #
137 # must also be on a u-lined server, as well as #
138 # actually being on the network. If the user is #
139 # online, but not on a u-lined server, then an #
140 # oper-alert is sent out as this is possibly signs #
141 # of a user trying to impersonate a service. #
143 # operonly - Defining this value, with a value of 'yes', '1' #
144 # or true will make the alias oper only. If a non- #
145 # oper attempts to use the alias, it will appear #
148 #<alias text="NICKSERV" replace="PRIVMSG NickServ :$2-" requires="NickServ" uline="yes">
149 #<alias text="CHANSERV" replace="PRIVMSG ChanServ :$2-" requires="ChanServ" uline="yes">
150 #<alias text="OPERSERV" replace="PRIVMSG OperServ :$2-" requires="OperServ" uline="yes" operonly="yes">
151 #<alias text="NS" replace="PRIVMSG NickServ :$2-" requires="NickServ" uline="yes">
152 #<alias text="CS" replace="PRIVMSG ChanServ :$2-" requires="ChanServ" uline="yes">
153 #<alias text="OS" replace="PRIVMSG OperServ :$2-" requires="OperServ" uline="yes" operonly="yes">
155 # An example of using the format value to create an alias with two
156 # different behaviours depending on the format of the parameters.
158 #<alias text="ID" format="#*" replace="PRIVMSG ChanServ :IDENTIFY $2 $3"
159 # requires="ChanServ" uline="yes">
161 #<alias text="ID" replace="PRIVMSG NickServ :IDENTIFY $2"
162 # requires="NickServ" uline="yes">
164 # This alias fixes a glitch in xchat 2.6.x and above and the way it
165 # assumes IDENTIFY must be prefixed by a colon (:) character. It should
166 # be placed ABOVE the default NICKSERV alias (the first example) listed
169 #<alias text="NICKSERV" format=":IDENTIFY *" replace="PRIVMSG NickServ :IDENTIFY $3-"
170 # requires="NickServ" uline="yes">
172 # You may also add aliases to trigger based on something said in a
173 # channel, aka 'fantasy' commands, configured in the same manner as any
174 # other alias, with usercommand="no" and channelcommand="yes" The
175 # command must be preceded by the fantasy prefix when used.
177 #<alias text="CS" usercommand="no" channelcommand="yes"
178 # replace="PRIVMSG ChanServ :$1 $chan $2-" requires="ChanServ" uline="yes">
180 # This would be used as "!cs <command> <options>", with the channel
181 # being automatically inserted after the command in the message to
182 # ChanServ, assuming the fantasy prefix is "!".
184 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
185 # Allowinvite module: Gives channel mode +A to allow all users to use
186 # /invite, and extban A to deny invite from specific masks
187 #<module name="m_allowinvite.so">
189 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
190 # Alltime module: Shows time on all connected servers at once.
191 # This module is oper-only and provides /alltime.
192 # To use, ALLTIME must be in one of your oper class blocks.
193 #<module name="m_alltime.so">
195 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
196 # Antibear security module: Prevents 'bear.txt' based trojans from
197 # connecting to your network by sending them a numeric they can't handle.
198 #<module name="m_antibear.so">
200 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
201 # Antibottler module: Labels bottler leech bots
202 #<module name="m_antibottler.so">
204 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
205 # Auditorium module: Adds channel mode +u which makes everyone else
206 # except you in the channel invisible, used for large meetings etc.
207 #<module name="m_auditorium.so">
209 # Auditorium settings:
211 #<auditorium showops="no" operoverride="no">
214 # Setting this value to yes makes m_auditorium behave like unrealircd
215 # +u channel mode, e.g. ops see users joining, parting, etc, and users
216 # joining the channel see the ops. Without this flag, the mode acts
217 # like ircnet's +a (anonymous channels), showing only the user in the
218 # names list, and not even showing the ops in the list, or showing the
219 # ops that the user has joined.
221 # Setting this value to yes makes m_auditorium affect the userlist for
222 # regular users only. Opers will view all users in the channel normally.
224 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
225 # Ban except module: Adds support for channel ban exceptions (+e)
226 #<module name="m_banexception.so">
228 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
229 # Ban redirection module: Allows bans which redirect to a specified
230 # channel. e.g. +b nick!ident@host#channelbanneduserissentto
231 #<module name="m_banredirect.so">
233 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
234 # Block amsg module: Attempt to block all usage of /amsg and /ame
235 #<module name="m_blockamsg.so">
237 #-#-#-#-#-#-#-#-#-#-#- BLOCKAMSG CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
239 # If you have the m_blockamsg.so module loaded, you can configure it #
240 # with the <blockamsg> tag: #
242 # delay - How many seconds between two messages to force #
243 # them to be recognised as unrelated. #
244 # action - Any of 'notice', 'noticeopers', 'silent', 'kill' #
245 # or 'killopers'. Define how to take action when #
246 # a user uses /amsg or /ame. #
248 #<blockamsg delay="3" action="killopers">
250 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
251 # Block CAPS module: Blocking all-CAPS messages with cmode +B
252 #<module name="m_blockcaps.so">
254 #-#-#-#-#-#-#-#-#-#-#- BLOCKCAPS CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
256 # percent - How many percent of text must be caps before text #
259 # minlen - The minimum length a line must be for the block #
260 # percent to have any effect. #
262 # capsmap - A list of chars to be considered CAPS, this was #
263 # you can add CAPS for your language. Also you can #
264 # add things like ! and space to further lock down #
266 #<blockcaps percent="50"
268 # capsmap="ABCDEFGHIJKLMNOPQRSTUVWXYZ! ">
270 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
271 # Block colour module: Blocking colour-coded messages with cmode +c
272 #<module name="m_blockcolor.so">
274 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
275 # Botmode module: Adds the user mode +B
276 #<module name="m_botmode.so">
278 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
279 # CallerID module: Adds usermode +g which activates hybrid-style
280 # callerid (== block all private messages unless you /accept first)
281 #<module name="m_callerid.so">
283 #-#-#-#-#-#-#-#-#-#-#- CALLERID CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#
284 # maxaccepts - Maximum number of entires a user can add to his #
285 # /accept list. Default is 16 entries. #
286 # operoverride - Can opers (note: ALL opers) ignore callerid mode? #
288 # tracknick - Preserve /accept entries when a user changes nick? #
289 # If no (the default), the user is removed from #
290 # everyone's accept list if he changes nickname. #
291 # cooldown - Amount of time (in seconds) that must pass since #
292 # the last notification sent to a user before he can #
293 # be sent another. Default is 60 (1 minute). #
294 #<callerid maxaccepts="16"
299 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
300 # CAP module: Provides the CAP negotiation mechanism seen in
301 # ratbox-derived ircds
302 #<module name="m_cap.so">
304 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
305 # CBAN module: Lets you disallow channels from being used at runtime.
306 # This module is oper-only and provides /cban.
307 # To use, CBAN must be in one of your oper class blocks.
308 #<module name="m_cban.so">
310 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
311 # Censor module: Adds the channel mode +G
312 #<module name="m_censor.so">
314 #-#-#-#-#-#-#-#-#-#-#- CENSOR CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#
316 # Optional - If you specify to use the m_censor module, then you must #
317 # specify some censor tags. See also: #
318 # http://www.inspircd.org/wiki/Censor_Module #
320 #<include file="censor.conf">
322 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
323 # CGI:IRC module: Adds support for automatic host changing in CGI:IRC
324 # (http://cgiirc.sourceforge.net).
325 #<module name="m_cgiirc.so">
327 #-#-#-#-#-#-#-#-#-#-#-# CGIIRC CONFIGURATION #-#-#-#-#-#-#-#-#-#-#-#-#
329 # Optional - If you specify to use m_cgiirc, then you must specify one
330 # or more cgihost tags which indicate authorised CGI:IRC servers which
331 # will be connecting to your network, and an optional cgiirc tag.
332 # For more information see: http://www.inspircd.org/wiki/CGI-IRC_Module
334 # Set to yes if you want to notice opers when CGI clients connect
335 # <cgiirc opernotice="no">
337 # The type field indicates where the module should get the real
338 # client's IP address from, for further information, please see the
339 # CGI:IRC documentation.
342 # <cgihost type="pass" mask="www.mysite.com"> # Get IP from PASS
343 # <cgihost type="ident" mask="otherbox.mysite.com"> # Get IP from ident
344 # <cgihost type="passfirst" mask="www.mysite.com"> # See the docs
346 # <cgihost type="webirc" pass="foobar"
347 # mask="somebox.mysite.com"> # Get IP from WEBIRC
352 # When you connect CGI:IRC clients, there are two connect classes which
353 # apply to these clients. When the client initially connects, the connect
354 # class which matches the cgi:irc site's host is checked. Therefore you
355 # must raise the maximum local/global clients for this ip as high as you
356 # want to allow cgi clients. After the client has connected and is
357 # determined to be a cgi:irc client, the class which matches the client's
358 # real IP is then checked. You may set this class to a lower value, so that
359 # the real IP of the client can still be restricted to, for example, 3
364 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
365 # Channel create module: Adds snomask +j, which will notify opers of
366 # any new channels that are created.
367 # This module is oper-only.
368 #<module name="m_chancreate.so">
370 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
371 # Channel filter module: Allows channel-op defined message
372 # filtering using simple string matches (channel mode +g)
373 #<module name="m_chanfilter.so">
375 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
376 # Channel logging module: used to send snotice output to channels, to
377 # allow staff to centrally monitor and discuss network activity.
379 # The "channel" field is where you want the messages to go, "snomasks"
380 # is what snomasks you want to be sent to that channel. Multiple tags
382 #<module name="m_chanlog.so">
383 #<chanlog snomasks="AOcC" channel="#opers">
385 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
386 # Channelban: Implements extended ban j:, which stops anyone in already
387 # in a channel matching a mask like +b j:#channel*mask from joining.
388 #<module name="m_channelban.so">
390 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
391 # Chanprotect module: gives +q and +a channel modes
392 #<module name="m_chanprotect.so">
395 # noservices: With this set to no, when a user joins a empty channel,
396 # the server will set +q on them. If set to yes, it will only set +o
397 # on them until they register the channel.
400 # qprefix: Prefix (symbol) to use for +q users.
403 # aprefix: Prefix (symbol) to use for +a users.
406 # deprotectself: If this value is set (true, yes or 1), it will allow
407 # +a and +q users to remove the +a and +q from themselves, otherwise,
408 # the status will have to be removed by services.
411 # deprotectothers: If this value is set to yes, true, or 1, then any
412 # user with +q or +a may remove the +q or +a from other users.
413 deprotectothers="yes">
416 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
417 # Check module: gives /check
418 # Check is useful for looking up information on channels,
419 # users, IP addresses and hosts.
420 # This module is oper-only.
421 # To use, CHECK must be in one of your oper class blocks.
422 #<module name="m_check.so">
424 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
425 # CHGHOST module: Adds the /CHGHOST command
426 # This module is oper-only.
427 # To use, CHGHOST must be in one of your oper class blocks.
428 #<module name="m_chghost.so">
430 #-#-#-#-#-#-#-#-# /CHGHOST - /SETHOST CONFIGURATION #-#-#-#-#-#-#-#-#
431 # Optional - If you want to use special chars for hostnames you can #
432 # specify your own custom list of chars with the <hostname> tag: #
434 # charmap - A list of chars accepted as valid by the /CHGHOST #
435 # and /SETHOST commands. Also note that the list is #
437 #<hostname charmap="abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ.-_/0123456789">
439 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
440 # CHGIDENT module: Adds the /CHGIDENT command
441 # This module is oper-only.
442 # To use, CHGIDENT must be in one of your oper class blocks.
443 #<module name="m_chgident.so">
445 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
446 # CHGNAME module: Adds the /CHGNAME command
447 # This module is oper-only.
448 # To use, CHGNAME must be in one of your oper class blocks.
449 #<module name="m_chgname.so">
451 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
452 # Cloaking module: Adds usermode +x and cloaking support.
453 # Relies on the module m_md5.so being loaded before m_cloaking.so in
454 # the configuration file.
455 # To use, you should enable m_conn_umodes and add +x as
456 # an enabled mode. See the m_conn_umodes module for more information.
457 #<module name="m_cloaking.so">
459 #-#-#-#-#-#-#-#-#-#-#- CLOAKING CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#
461 # Optional - If you specify the m_cloaking.so module as above, you #
462 # must define cloak keys, and optionally a cloak prefix as shown #
463 # below. When using cloaking, the cloak keys are MANDITORY and must #
464 # be included. However, if prefix is not included, it will default #
465 # to your networks name from the <server> tag. You can also include #
466 # the following optional values: #
468 # ipalways - Always cloak the IP address, not the hostname, #
469 # which doesn't reveal the user's ISP, but #
470 # results in hosts that are harder to read and #
473 # lowercase - Display the cloaked hostnames in lowercase #
474 # characters instead of uppercase #
476 # <cloak key1="0x2AF39F40" #
477 # key2="0x78E10B32" #
478 # key3="0x4F2D2E82" #
479 # key4="0x043A4C81" #
482 # lowercase="false"> #
484 # Please note that the key values will accept any number, and should #
485 # be large numbers. Using small numbers such as "7" or "1924" will #
486 # seriously weaken the security of your cloak. It is recommended you #
487 # use hexdecimal numbers prefixed by "0x", as shown in this example, #
488 # with each key eight hex digits long. #
490 #-#-#-#-#-#-#-#-#-#-#-#- CLOSE MODULE #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
491 # Close module: Allows an oper to close all unregistered connections.
492 # This module is oper-only and provides /close.
493 # To use, CLOSE must be in one of your oper class blocks.
494 #<module name="m_close.so">
496 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
497 # Clones module: Adds an oper command /CLONES for detecting cloned
498 # users. Warning: This module may be resource intensive when its
499 # command is issued, use with care.
500 # This module is oper-only.
501 # To use, CLONES must be in one of your oper class blocks.
502 #<module name="m_clones.so">
504 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
505 # Common channels module: Adds user mode +c, which, when set, requires
506 # that users must share a common channel with you to PRIVMSG or NOTICE
508 #<module name="m_commonchans.so">
510 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
511 # Conn-Join: Allows you to force users to join one or more channels
512 # automatically upon connecting to the server.
513 #<module name="m_conn_join.so">
515 #-#-#-#-#-#-#-#-#-#-#-#- CONNJOIN CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
517 # If you have m_conn_join.so loaded, you can configure it using the
520 #<autojoin channel="#one,#two,#three">
522 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
523 # Conn-Usermodes: Set modes on users when they connect
524 # When this module is loaded <connect:allow> tags may have an optional
525 # modes="" value, which contains modes to add or remove from users
526 # when they connect to the server.
527 #<module name="m_conn_umodes.so">
529 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
530 # Conn-Wait-for-Pong: Don't let a user connect until they PONG
531 #<module name="m_conn_waitpong.so">
533 #-#-#-#-#-#-#-#-#-#-#- WAITPONG CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
535 # If you have the m_conn_waitpong.so module loaded, configure it with #
536 # the <waitpong> tag: #
538 # sendsnotice - Whether to send a snotice on connect, like other #
541 # killonbadreply - Whether to kill the user if they send the wrong #
544 #<waitpong sendsnotice="yes" killonbadreply="yes">
547 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
548 # Channel cycle module. Server side /hop, with +ilk etc bypass.
549 #<module name="m_cycle.so">
551 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
552 # Connectban: Provides IP connection throttling. Any IP range that connects
553 # too many times (configurable) in an hour is zlined for a (configurable)
554 # duration, and their count resets to 0.
556 # ipv4cidr and ipv6cidr allow you to turn the comparison from individual
557 # IP addresses (32 and 128 bits) into CIDR masks, to allow for throttling
558 # over whole ISPs/blocks of IPs, which may be needed to prevent attacks.
560 #<connectban threshold="10" duration="10m" ipv4cidr="32" ipv6cidr="128">
561 # This allows for 10 connections in an hour with a 10 minute ban if that is exceeded.
563 #<module name="m_connectban.so">
565 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
566 # Connection throttle module. Configuration:
567 #<module name="m_connflood.so">
569 #-#-#-#-#-#-#-#-#-#-#- CONTHROTTLE CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
570 # seconds, maxconns - Amount of connections per <seconds>.
572 # timeout - Time to wait after the throttle was activated
573 # before deactivating it. Be aware that the time
574 # is seconds + timeout.
576 # quitmsg - The message that users get if they attempt to
577 # connect while the throttle is active.
579 # bootwait - Amount of time to wait before enforcing the
580 # throttling when the server just booted.
582 #<connflood seconds="30" maxconns="3" timeout="30"
583 # quitmsg="Throttled" bootwait="10">
585 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
586 # Custom title module: Adds the /TITLE command which allows for trusted
587 # users to gain a custom whois line and a optional
588 # vhost can be specified.
589 #<module name="m_customtitle.so">
591 #-#-#-#-#-#-#-#-#-#- CUSTOM TITLE CONFIGURATION -#-#-#-#-#-#-#-#-#-#
592 # name - The username used to identify
593 # password - The password used to identify
594 # host - Allowed hostmask [optional]
595 # title - Title shown in whois
596 # vhost - Displayed host [optional]
598 #<title name="foo" password="bar" title="Official Chat Helper">
599 #<title name="bar" password="foo" host="ident@host.name" title="Official Chat Helper" vhost="helper.network.chat">
601 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
602 # DCCALLOW module: Adds the /DCCALLOW command
603 #<module name="m_dccallow.so">
605 #-#-#-#-#-#-#-#-#-#-#- DCCALLOW CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
606 # blockchat - Whether to block DCC CHAT as well as DCC SEND
607 # length - Default duration of entries in DCCALLOW list
608 # action - Default action to take if no action is specified
609 # can be 'block' or 'allow'
611 # File configuration:
612 # pattern - The glob pattern to match against
613 # action - Action to take if a user attempts to send a file
614 # that matches this pattern, can be 'block' or 'allow'
616 #<dccallow blockchat="yes" length="5m" action="block">
617 #<banfile pattern="*.exe" action="block">
618 #<banfile pattern="*.txt" action="allow">
620 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
622 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
623 # Deaf module: adds support for ircu style usermode +d - deaf to
624 # channel messages and channel notices.
625 #<module name="m_deaf.so">
627 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
628 # Delay join module: Adds the channel mode +D which delays all JOIN
629 # messages from users until they speak. If they quit or part before
630 # speaking, their quit or part message will not be shown to the channel
631 # which helps cut down noise on large channels in a more friendly way
632 # than the auditorium mode. Only channel ops may set the +D mode.
633 #<module name="m_delayjoin.so">
635 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
636 # Deny Channels: Deny Channels from being used by users
637 #<module name="m_denychans.so">
639 #-#-#-#-#-#-#-#-#-#-#- DENYCHAN DEFINITIONS -#-#-#-#-#-#-#-#-#-#-#-#
641 # If you have the m_denychans.so module loaded, you need to specify #
642 # the channels to deny: #
644 # name - The channel name to deny. (glob masks are ok) #
646 # allowopers - If operators are allowed to override the deny. #
648 # reason - Reason given for the deny. #
650 # redirect - Redirect the user to a different channel #
652 #<badchan name="#gods*" allowopers="yes" reason="Tortoises!"> #
653 #<badchan name="#heaven" redirect="#hell" reason="Nice try!"> #
655 # Redirects will not work if the target channel is set +L. #
657 # Additionally, you may specify channels which are allowed, even if #
658 # a badchan tag specifies it would be denied: #
659 #<goodchan name="#godsleeps"> #
660 # Glob masks are accepted here also.
662 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
663 # Devoice Module: Let users devoice themselves.
664 #<module name="m_devoice.so">
666 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
667 # DNS Blacklist Module: Provides support for looking up IPs on one or #
669 #<module name="m_dnsbl.so"> #
671 # For configuration options please see the wiki page for m_dnsbl at #
672 # http://inspircd.org/wiki/DNS_Blacklist_Module #
674 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
675 # Filter module: Provides message filtering, similar to SPAMFILTER.
676 #<module name="m_filter.so">
678 # This module depends upon a regex provider such as m_regex_pcre or #
679 # m_regex_glob to function. You must specify which of these you want #
680 # m_filter to use via the tag below. #
682 # Valid engines are: #
684 # glob - Glob patterns, provided via m_regex_glob.so #
685 # pcre - PCRE regexps, provided via m_regex_pcre.so, needs libpcre #
686 # tre - TRE regexps, provided via m_regex_tre.so, requires libtre #
687 # posix - POSIX regexps, provided via m_regex_posix.so, not availale #
688 # on windows, no dependencies on other operating systems. #
690 #<filteropts engine="glob"> #
692 # Your choice of regex engine must match on all servers network-wide.
694 #-#-#-#-#-#-#-#-#-#-#- FILTER CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#
696 # Optional - If you specify to use the m_filter module, then #
697 # specfiy below the path to the filter.conf file, or define some #
700 #<include file="filter.conf">
702 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
703 # Foobar module: does nothing - historical relic
704 #<module name="m_foobar.so">
706 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
707 # Gecosban: Implements extended ban r:, which stops anyone matching
708 # a mask like +b r:*realname?here* from joining a channel.
709 #<module name="m_gecosban.so">
711 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
712 # GeoIP module: Allows the server admin to ban users by country code.
713 # This modules is in extras. Re-run configure with: ./configure --enable-extras=m_geoip.cpp
714 # and run make install, then uncomment this module to enable it.
715 #<module name="m_geoip.so">
717 #-#-#-#-#-#-#-#-#-#-#-# GEOIP CONFIGURATION #-#-#-#-#-#-#-#-#-#-#-#-#
719 # <geoip banunknown="false"> #
721 # Set this value to true or yes to block unknown IP ranges which are #
722 # not in the database (usually LAN addresses, localhost, etc) #
724 # <geoban country="TR" reason="This country not permitted"> #
726 # Use one or more of these tags to ban countries by country code. #
727 # The country code must be in capitals and should be an ISO country #
728 # code such as TR, GB, or US. #
730 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
731 # Globops module: gives /GLOBOPS and SNOMASK +g
732 # This module is oper-only.
733 # To use, GLOBOPS must be in one of your oper class blocks.
734 #<module name="m_globops.so">
736 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
737 # Global load module: Allows loading and unloading of modules network-
738 # wide (USE WITH EXTREME CAUTION!)
739 # This module is oper-only and provides /gloadmodule, /gunloadmodule
740 # and /greloadmodule.
741 # To use, GLOADMODULE, GUNLOADMODULE and GRELOADMODULE
742 # must be in one of your oper class blocks.
743 #<module name="m_globalload.so">
745 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
746 # HELPOP module: Provides the /HELPOP command
747 #<module name="m_helpop.so">
749 #-#-#-#-#-#-#-#-#-#-#-#- HELPOP CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
751 # Optional - If you specify to use the m_helpop.so module, then #
752 # specify below the path to the helpop.conf file, or if you like to #
753 # make a mess, define your helpop tags in this conf. #
755 #<include file="helpop.conf">
757 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
758 # HIDECHANS module: Allows opers to hide their channels list from non-
759 # opers by setting user mode +I on themselves.
760 # <module name="m_hidechans.so">
762 # HIDECHANS can optionally prevent opers from seeing channels on a +I
763 # user, for more privacy if set to true.
764 # This setting is not recommended for most mainstream networks.
765 #<hidechans affectsopers="false">
767 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
768 # HIDEOPER module: Allows opers to hide their oper status from non-
769 # opers by setting user mode +H on themselves.
770 # This module is oper-only.
771 # <module name="m_hideoper.so">
773 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
774 # Hostchange module: Allows a different style of cloaking
775 #<module name="m_hostchange.so">
777 #-#-#-#-#-#-#-#-#-#-#- HOSTCHANGE CONFIGURATION -#-#-#-#-#-#-#-#-#-#
779 # Optional - If you choose to use the m_hostchange.so module. #
780 # Config Help - See http://www.inspircd.org/wiki/Host_Changer_Module #
782 #<host suffix="polarbears.org" separator="." prefix="">
783 #<hostchange mask="*@fbi.gov" action="addnick">
784 #<hostchange mask="*r00t@*" action="suffix">
785 #<hostchange mask="a@b.com" action="set" value="blah.blah.blah">
786 #<hostchange mask="localhost" ports="7000,7001,7005-7007" action="set" value="blahblah.foo">
788 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
789 # httpd module: Provides http server support for InspIRCd
790 #<module name="m_httpd.so">
792 #-#-#-#-#-#-#-#-#-#-#-#- HTTPD CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
794 # Optional - If you choose to use the m_httpd.so module, then you must
795 # specify the port number and other details of your http server:
797 #<http ip="192.168.1.10" host="brainwave" port="32006"
798 # index="/home/brain/inspircd/http/index.html">
800 # You may have as many of these tags as you wish, each with a different
801 # IP, port, host or index file. Each one will act as an independent
805 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
806 # http ACL module: Provides access control lists for m_httpd dependent
807 # modules. Use this module to restrict pages by IP address and by
810 #<module name="m_httpd_acl.so">
812 #-#-#-#-#-#-#-#-#-#-#-#- HTTPD ACL CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
814 # Restrict access to the m_httpd_stats module to all but the local
815 # network and when the correct password is specified:
817 # <httpdacl path="/stats*" types="password,whitelist"
818 # username="secretstuff" password="mypasshere" whitelist="127.0.0.*,10.*">
820 # Deny all connections to all but the main index page:
822 # <httpdacl path="/*" types="blacklist" blacklist="*">
825 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
826 # http config module: Allows the server's configuration to be viewed
827 # over HTTP. Requires m_httpd.so to be loaded for it to function.
828 #<module name="m_httpd_config.so">
830 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
831 # http stats module: Provides basic stats pages over HTTP
832 # Requires m_httpd.so to be loaded for it to function.
833 #<module name="m_httpd_stats.so">
835 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
836 # Ident: Provides RFC 1413 ident lookup support
837 # When this module is loaded <connect:allow> tags may have an optional
838 # useident="yes|no" boolean value, determining whether or not to lookup
839 # ident on users matching that connect tag.
840 #<module name="m_ident.so">
842 #-#-#-#-#-#-#-#-#-#-#-#- IDENT CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
844 # Optional - If you are using the m_ident.so module, then you can #
845 # specify the timeout for ident lookups here. If not defined, it will #
846 # default to one second. This is a non-blocking timeout which holds #
847 # the user in a 'connecting' state until the lookup is complete. #
848 # The bind value indicates which IP to bind outbound requests to. #
852 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
853 # Invite except module: Adds support for channel invite exceptions (+I)
854 #<module name="m_inviteexception.so">
856 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
857 # Invisible module - Adds support for usermode +Q (quiet) which lets an
858 # oper go 'invisible' similar to unrealircd 3.1's +I mode. Note that
859 # opers are still able to see invisible users, and if an oper with +Q
860 # deopers, they will become visible.
862 # IMPORTANT NOTE: To allow this mode to be used by a type of oper, you
863 # must first add the value canquiet="yes" to that oper's type tag.
865 # This module is oper-only.
867 #<module name="m_invisible.so">
869 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
870 # Join flood module: Adds support for join flood protection (+j)
871 #<module name="m_joinflood.so">
873 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
874 # Jump Server module: Adds support for the RPL_REDIR numeric
875 # This module is oper-only.
876 # To use, JUMPSERVER must be in one of your oper class blocks.
877 #<module name="m_jumpserver.so">
879 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
880 # Anti-Auto-Rejoin: Adds support for prevention of auto-rejoin (+J)
881 #<module name="m_kicknorejoin.so">
883 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
884 # Knock module: adds the /KNOCK command and +K channel mode
885 #<module name="m_knock.so">
887 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
888 # LDAP authentication module: Adds the ability to authenticate users #
889 # via LDAP. This is an extra module which must be enabled explicitly #
890 # by symlinking it from modules/extra, and requires the OpenLDAP libs #
891 # This modules is in extras. Re-run configure with: ./configure --enable-extras=m_ldapauth.cpp
892 # and run make install, then uncomment this module to enable it. #
894 #<module name="m_ldapauth.so"> #
898 # <ldapauth baserdn="ou=People,dc=brainbox,dc=cc" #
900 # server="ldap://brainwave.brainbox.cc" #
901 # allowpattern="Guest*" #
902 # killreason="Access denied" #
903 # searchscope="subtree" #
904 # binddn="cn=Manager,dc=brainbox,dc=cc" #
905 # bindauth="mysecretpass" #
908 # The baserdn indicates the base DN to search in for users. Usually #
909 # this is 'ou=People,dc=yourdomain,dc=yourtld'. #
911 # The attribute value indicates the attribute which is used to locate #
912 # a user account by name. On POSIX systems this is usually 'uid'. #
914 # The server parameter indicates the LDAP server to connect to. The #
915 # ldap:// style scheme before the hostname proper is MANDITORY. #
917 # The allowpattern value allows you to specify a wildcard mask which #
918 # will always be allowed to connect regardless of if they have an #
919 # account, for example guest users. #
921 # Killreason indicates the QUIT reason to give to users if they fail #
924 # The searchscope value indicates the subtree to search under. On our #
925 # test system this is 'subtree'. Your mileage may vary. #
927 # Setting the verbose value causes an oper notice to be sent out for #
928 # every failed authentication to the server, with an error string. #
930 # The binddn and bindauth indicate the DN to bind to for searching, #
931 # and the password for the distinguished name. Some LDAP servers will #
932 # allow anonymous searching in which case these two values do not #
933 # need defining, otherwise they should be set similar to the examples #
936 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
937 # LDAP oper configuration module: Adds the ability to authenticate #
938 # opers via LDAP. This is an extra module which must be enabled #
939 # explicitly by symlinking it from modules/extra, and requires the #
940 # OpenLDAP libs. Re-run configure with: ./configure --enable-extras=m_ldapoper.cpp
941 # and run make install, then uncomment this module to enable it. #
943 #<module name="m_ldapoper.so">
947 # <ldapoper baserdn="ou=People,dc=brainbox,dc=cc"
948 # server="ldap://brainwave.brainbox.cc"
949 # searchscope="subtree"
950 # binddn="cn=Manager,dc=brainbox,dc=cc"
951 # bindauth="mysecretpass">
953 # Available configuration items are identical to the same items in #
954 # m_ldapauth above. #
956 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
957 # Lock server module: Adds /LOCKSERV and /UNLOCKSERV commands that is #
958 # used to temporarily close/open for new connections to the server. #
959 # These commands require OPER status and that the LOCKSERV UNLOCKSERV #
960 # are specified in a <class> tag that the oper is part of. This is so #
961 # you can control who has access to this possible dangerous command. #
962 # If your server is locked and you got disconnected, do a REHASH from #
963 # shell to open up again.
965 # This module is oper-only.
967 #<module name="m_lockserv.so">
969 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
970 # Map hiding module: replaces /MAP and /LINKS output to users with a #
971 # message to see a website, set by maphide="http://link.to/site" in #
972 # the security tag, instead. #
973 #<module name="m_maphide.so">
975 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
976 # Msg flood module: Adds message/notice flood protection (+f)
977 #<module name="m_messageflood.so">
979 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
980 # MsSQL module: Allows other SQL modules to access MS SQL Server
981 # through a unified API. You must copy the source for this module
982 # from the directory src/modules/extra, plus the file m_sqlv2.h
983 # This modules is in extras. Re-run configure with: ./configure --enable-extras=m_mssql.cpp
984 # and run make install, then uncomment this module to enable it.
986 #<module name="m_mssql.so">
988 #-#-#-#-#-#-#-#-#-#-#-#- SQL CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#-#
990 # m_mssql.so is more complex than described here, see wiki for more #
991 # info http://www.inspircd.org/wiki/SQLServer_Service_Provider_Module #
993 #<database name="db" username="user" password="pass" hostname="localhost" id="db1">
995 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
996 # MySQL module: Allows other SQL modules to access MySQL databases
997 # through a unified API. You must copy the source for this module
998 # from the directory src/modules/extra, plus the file m_sqlv2.h
999 # This modules is in extras. Re-run configure with: ./configure --enable-extras=m_mysql.cpp
1000 # and run make install, then uncomment this module to enable it.
1002 #<module name="m_mysql.so">
1004 #-#-#-#-#-#-#-#-#-#-#-#- SQL CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#-#
1006 # m_mysql.so is more complex than described here, see the wiki for #
1007 # more: http://www.inspircd.org/wiki/SQL_Service_Provider_Module #
1009 #<database name="mydb" username="myuser" password="mypass" hostname="localhost" id="my_database2">
1011 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1012 # NAMESX module: Provides support for the NAMESX extension which allows
1013 # clients to see all the prefixes set on a user without getting confused.
1014 # This is supported by mIRC, x-chat, klient, and maybe more.
1015 #<module name="m_namesx.so">
1017 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1018 # National characters module:
1019 # 1) Allows using national characters in nicknames.
1020 # 2) Allows using custom (national) casemapping over the network.
1021 # file -- filename of existing file in "locales" directory
1022 # casemapping -- custom value for 005 numeric (if you want it to be
1023 # different from the filename.
1025 #<nationalchars file="bynets/russian-w1251-charlink" casemapping="ru_RU.cp1251-charlink">
1026 #<module name="m_nationalchars.so">
1028 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1029 # Nickchange flood protection module: Allows up to X nick changes in Y seconds.
1030 # Provides channel mode +F.
1031 #<module name="m_nickflood.so">
1033 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1034 # Nicklock module: Let opers change a user's nick and then stop that
1035 # user from changing their nick again.
1036 # This module is oper-only.
1037 # To use, NICKLOCK and NICKUNLOCK must be in one of your oper class blocks.
1038 #<module name="m_nicklock.so">
1040 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1041 # No ctcp module: Adds the channel mode +C to block CTCPs
1042 #<module name="m_noctcp.so">
1044 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1045 # No kicks module: Adds the +Q channel mode
1046 #<module name="m_nokicks.so">
1048 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1049 # No nicks module: Adds the +N channel mode, as well as the +b N:
1050 # extended bantype. +N stops all users from changing their nick,
1051 # the +b N: extban stops anyone from matching a +b N:nick!user@host
1052 # mask from changing their nick.
1053 #<module name="m_nonicks.so">
1055 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1056 # No part message module: adds extban 'p' to block part messages from #
1058 #<module name="m_nopartmsg.so">
1060 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1061 # No Notice module: adds the channel mode +T
1062 #<module name="m_nonotice.so">
1064 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1065 # Oper channels mode: Adds the +O channel mode
1066 # This module is oper-only.
1067 #<module name="m_operchans.so">
1069 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1070 # Oper invex/extban module: Adds +beI type O, to ban, exempt, and invex
1071 # given oper type masks.
1072 # e.g, /mode #channel +iI O:* is equivilant to chmode +O, but you
1073 # may also, e.g. /mode #channel +iI O:AdminTypeOnly to only allow admins.
1074 # +be work in a similar fashion.
1075 # This module is oper-only.
1077 #<module name="m_operinvex.so">
1079 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1080 # Oper Join module: Auto-joins opers to a channel upon oper-up
1081 # This module is oper-only. For the user equivalent, see m_conn_join.
1082 #<module name="m_operjoin.so">
1084 #-#-#-#-#-#-#-#-#-#-# OPERJOIN CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
1086 # If you are using the m_operjoin.so module, specify options here: #
1088 # channel - The channel name to join, can also be a comma #
1089 # seperated list eg. "#channel1,#channel2". #
1091 # override - Lets the oper join walking thru any modes that #
1092 # might be set, even bans. Use "yes" or "no". #
1094 #<operjoin channel="#channel" override="no">
1096 # Alternatively you can use the autojoin="channellist" in a <type> #
1097 # tag to set specific autojoins for a type of oper, for example: #
1099 #<type name="Helper" autojoin="#help" classes="...">
1101 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1102 # Oper log module: Logs all oper commands to the ircd log at default
1104 # This module is oper-only.
1105 #<module name="m_operlog.so">
1107 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1108 # Oper prefixing module: Gives IRC operators a prefix status character
1109 # on all channels they are in.
1111 #<module name="m_operprefix.so">
1113 # You may additionally customise the prefix character.
1114 #<operprefix prefix="!">
1116 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1117 # Oper MOTD module: Provides support for seperate message of the day
1119 # This module is oper-only.
1120 #<module name="m_opermotd.so">
1122 #-#-#-#-#-#-#-#-#-#-# OPERMOTD CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
1124 # If you are using the m_opermotd.so module, specify the motd here #
1126 # onoper - Should the message be sent on /OPER or only when #
1127 # /OPERMOTD is used. Use "yes" or "no". #
1129 #<opermotd file="oper.motd" onoper="yes">
1131 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1132 # Override module: Adds support for oper override
1133 # This module is oper-only.
1134 #<module name="m_override.so">
1136 #-#-#-#-#-#-#-#-#-#-# OVERRIDE CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
1138 # m_override.so is too complex it describe here, see the wiki: #
1139 # http://www.inspircd.org/wiki/Oper_Override_Module #
1141 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1142 # Oper levels module: Gives each oper a level and prevents
1143 # actions being taken against higher level opers
1144 # Specify the level as the 'level' parameter of the <type> tag
1145 # # This module is oper-only.
1146 #<module name="m_operlevels.so">
1148 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1149 # Oper modes module: Allows you to specify modes to add/remove on oper
1150 # Specify the modes as the 'modes' parameter of the <type> tag
1151 # and/or as the 'modes' parameter of the <oper> tag.
1152 # This module is oper-only. For the user equivalent, see m_conn_umodes
1153 #<module name="m_opermodes.so">
1155 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1156 # Oper password hash module: Allows hashed oper passwords
1157 # Relies on the module m_md5.so and/or m_sha256.so being loaded before
1158 # m_password_hash.so in the configuration file.
1159 # This module is oper-only.
1160 #<module name="m_password_hash.so">
1162 #-#-#-#-#-#-#-#-#-#-# OPER HASH CONFIGURATION #-#-#-#-#-#-#-#-#-#-#-#-#
1164 # To use this module, you must define a hash type for each oper's
1165 # password you want to hash. For example:
1167 # <oper name="Brain"
1168 # host="ident@dialup15.isp.com"
1170 # password="a41d730937a53b79f788c0ab13e9e1d5"
1173 # The types of hashing available vary depending on which hashing modules
1174 # you load, but usually if you load m_sha256.so and m_md5.so, both md5
1175 # and sha256 type hashing will be available (the most secure of which
1178 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1179 # Permanent Channels module: Channels with the permanent channels mode
1180 # will remain open even after everyone else has left the channel, and
1181 # therefore keep things like modes, ban lists and topic. Permanent
1182 # channels -may- need support from your Services package to function
1183 # properly with them. This adds channel mode +P.
1184 # This module is oper-only.
1185 #<module name="m_permchannels.so">
1187 # You may also create channels on startup by using the <permchannels> block.
1188 #<permchannels channel="#opers" modes="is" topic="Opers only.">
1190 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1191 # PostgreSQL module: Allows other SQL modules to access PgSQL databases
1192 # through a unified API. You must copy the source for this module
1193 # from the directory src/modules/extra, plus the file m_sqlv2.h
1194 # This modules is in extras. Re-run configure with: ./configure --enable-extras=m_pgsql.cpp
1195 # and run make install, then uncomment this module to enable it.
1197 #<module name="m_pgsql.so">
1199 #-#-#-#-#-#-#-#-#-#-#-#- SQL CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#-#
1201 # m_pgsql.so is more complex than described here, see the wiki for #
1202 # more: http://www.inspircd.org/wiki/SQL_Service_Provider_Module #
1204 #<database name="mydb" username="myuser" password="mypass" hostname="localhost" id="my_database" ssl="no">
1206 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1207 # Muteban: Implements extended ban m:, which stops anyone matching
1208 # a mask like +b m:nick!user@host from speaking on channel.
1209 #<module name="m_muteban.so">
1212 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1213 # Random Quote module: provides a random quote on connect.
1214 # NOTE: Some of these may mimic fatal errors and confuse users and
1215 # opers alike! - BEWARE!
1216 #<module name="m_randquote.so">
1218 #-#-#-#-#-#-#-#-#-#- RANDOMQUOTES CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
1220 # Optional - If you specify to use the m_randquote.so module, then #
1221 # specify below the path to the randquotes.conf file. #
1223 #<randquote file="randquotes.conf">
1225 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1226 # Redirect module: Adds channel redirection (mode +L)
1227 #<module name="m_redirect.so">
1229 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1230 # Regular Expression Provider for Glob or wildcard (?/*) matching.
1231 # You must have at least 1 provider loaded to use m_filter or m_rline
1232 # modules. This module has no additional requirements, as it uses the
1233 # matching already present in InspIRCd core.
1234 #<module name="m_regex_glob.so">
1236 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1237 # Regular Expression Provider for PCRE (Perl-Compatible Regular
1238 # Expressions). You need libpcre installed to compile and load this
1239 # module. You must have at least 1 provider loaded to use m_filter or
1241 #<module name="m_regex_pcre.so">
1243 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1244 # Regular Expression Provider for POSIX Regular Expressions.
1245 # You shouldn't need any additional libraries on a POSIX-compatible
1246 # system (ie: any Linux, BSD, but not Windows). You must have at least
1247 # 1 provider loaded to use m_filter or m_rline.
1248 # On POSIX-compliant systems, regex syntax can be found by using the
1249 # command: 'man 7 regex'.
1250 #<module name="m_regex_posix.so">
1252 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1253 # Regular Expression Provider for TRE Regular Expressions.
1254 # This is the same regular expression engine used by UnrealIRCd, so
1255 # if you are most familiar with the syntax of /spamfilter from there,
1256 # this is the provider you want. You need libtre installed in order
1257 # to compile and load this module.
1258 #<module name="m_regex_tre.so">
1260 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1261 # Registered users only channel creation
1262 # Allows only registered users and opers to create new channels.
1263 #<module name="m_regonlycreate.so">
1265 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1266 # Remove module: Adds the /REMOVE command which is a peaceful
1267 # alternative to /KICK
1268 #<module name="m_remove.so">
1270 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1271 # Restricted channels module: Allows only opers to create channels
1272 #<module name="m_restrictchans.so">
1274 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1275 # Restrict message module: Allows users to only message opers
1276 #<module name="m_restrictmsg.so">
1278 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1279 # Ban users through regular expression patterns
1280 #<module name="m_rline.so">
1282 #-#-#-#-#-#-#-#-#-#-#-#- RLINE CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#-#
1284 # If you wish to re-check a user when they change nickname (can be
1285 # useful under some situations, but *can* also use CPU with more users
1286 # on a server) then set the following configuration value:
1287 # Also, this is where you set what Regular Expression engine is to be
1288 # used. If you ever change it while running, all of your R-Lines will be
1289 # wiped. This is the regex engine used by all R-Lines set, and
1290 # m_regex_<engine>.so must be loaded, or rline will be nonfunctional
1291 # until you load it or change the engine to one that is loaded.
1293 #<rline matchonnickchange="yes" engine="pcre">
1295 # Generally, you will NOT want to use 'glob' here, as this turns
1296 # rline into just another gline. The exceptions are that rline will
1297 # always use the full nick!user@host realname string, rather than only
1298 # user@host, but beware that only the ? and * wildcards are available,
1299 # and are the only way to specify where the space can occur if you do
1300 # use glob. For this reason, is recommended to use a real regex engine
1301 # so that at least \s or [[:space:]] is available.
1303 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1304 # JSON-RPC module: Encode and decode JSON-RPC requests for modules
1305 #<module name="m_rpc_json.so">
1307 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1308 # RPC test module: A test of the RPC API
1309 #<module name="m_rpctest.so">
1311 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1312 # Provide /LIST throttling (to prevent flooding) and /LIST safety to
1313 # prevent excess flood when the list is large.
1314 #<module name="m_safelist.so">
1316 #-#-#-#-#-#-#-#-#-#-# SAFELIST CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#-#
1318 # When using Safelist, you may set the following values;
1320 # The first value, 'throttle', sets the amount of time in seconds a user
1321 # must wait between LIST commands. For example, if this is set to 60
1322 # (the default) then the user may not /LIST more than once a minute.
1323 # If not defined, the default value is 60 seconds.
1325 # The second value, 'maxlisters', indicates the maximum number of users
1326 # which may be retrieving a LIST at once. It is not recommended you raise
1327 # this value, as increasing it too high can make your network vulnerable
1328 # to floodbots which waste your bandwidth and CPU time with LIST requests.
1330 #<safelist throttle="60" maxlisters="50">
1332 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1333 # SAJOIN module: Adds the /SAJOIN command
1334 # This module is oper-only.
1335 # To use, SAJOIN must be in one of your oper class blocks.
1336 #<module name="m_sajoin.so">
1338 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1339 # SAMODE module: Adds the oper /SAMODE command
1340 # This module is oper-only.
1341 # To use, SAMODE must be in one of your oper class blocks.
1342 #<module name="m_samode.so">
1344 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1345 # SANICK module: Allows opers to change user's nicks
1346 # This module is oper-only.
1347 # To use, SANICK must be in one of your oper class blocks.
1348 #<module name="m_sanick.so">
1350 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1351 # SAPART module: Adds the oper /SAPART command
1352 # This module is oper-only.
1353 # To use, SAPART must be in one of your oper class blocks.
1354 #<module name="m_sapart.so">
1356 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1357 # SAQUIT module: Adds the oper /SAQUIT command (abusable!!!)
1358 # This module is oper-only.
1359 # To use, SAQUIT must be in one of your oper class blocks.
1360 #<module name="m_saquit.so">
1362 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1363 # SATOPIC module: Adds the oper /SATOPIC command
1364 # This module is oper-only.
1365 # To use, SATOPIC must be in one of your oper class blocks.
1366 #<module name="m_satopic.so">
1368 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1369 # SASL authentication module: Provides support for IRC Authentication
1370 # Layer (aka: atheme SASL) via AUTHENTICATE.
1371 #<module name="m_sasl.so">
1373 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1374 # Secure list module: Prevent /LIST in the first minute of connection,
1375 # crippling most spambots and trojan spreader bots.
1376 #<module name="m_securelist.so">
1378 #-#-#-#-#-#-#-#-#-# SECURELIST CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#-#
1380 # Securelist can be harmful to some irc search engines such as #
1381 # netsplit.de and searchirc.com. To prevent securelist blocking these #
1382 # sites from listing, define exception tags as shown below: #
1383 <securehost exception="*@*.searchirc.org">
1384 <securehost exception="*@*.netsplit.de">
1385 <securehost exception="*@echo940.server4you.de">
1387 # Define the following variable to change how long a user must wait #
1388 # before issuing a LIST. If not defined, defaults to 60 seconds. #
1390 #<securelist waittime="60"> #
1392 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1393 # Servprotect module: Provides support for Austhex style +k /
1394 # UnrealIRCD +S services mode
1395 #<module name="m_servprotect.so">
1397 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1398 # See nicks module: Allow for SNOMASK +N which shows nick changes.
1399 # This module is oper-only.
1400 #<module name="m_seenicks.so">
1402 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1403 # Set Idle module: Adds a command for opers to change their
1404 # idle time (mainly a toy)
1405 # This module is oper-only.
1406 # To use, SETIDLE must be in one of your oper class blocks.
1407 #<module name="m_setidle.so">
1409 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1410 # Services support module: Adds several usermodes such as +R and +M
1411 # this module implements the 'identified' state via account names (AC)
1412 # and is similar in operation to the way asuka and ircu handle services.
1414 # At the same time, this offers +r for users and channels to mark them
1415 # as identified seperately from the idea of a master account, which
1416 # can be useful for services which are heavily nick-as-account centric.
1418 # This replaces m_services from 1.1 and earlier.
1420 # Also of note is that this module implements two extbans:
1421 # +b R: (stop matching account names from joining)
1422 # +b M: (stop matching account names from speaking)
1424 #<module name="m_services_account.so">
1426 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1427 # Sethost module: Adds the /SETHOST command
1428 # This module is oper-only.
1429 # To use, SETHOST must be in one of your oper class blocks.
1430 # See m_chghost for how to customise valid chars for hostnames
1431 #<module name="m_sethost.so">
1433 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1434 # Setident module: Adds the /SETIDENT command
1435 # This module is oper-only.
1436 # To use, SETIDENT must be in one of your oper class blocks.
1437 #<module name="m_setident.so">
1439 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1440 # SETNAME module: Adds the /SETNAME command
1441 # This module is oper-only.
1442 # To use, SETNAME must be in one of your oper class blocks.
1443 #<module name="m_setname.so">
1445 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1446 # Serverban: Implements extended ban s:, which stops anyone connected
1447 # to a server matching a mask like +b s:server.mask.here from joining.
1448 #<module name="m_serverban.so">
1450 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1451 # Show Whois module: Adds the +W usermode which allows opers
1452 # to see when they are whois'ed (can be annoying).
1453 # This module is oper-only.
1454 #<module name="m_showwhois.so">
1456 # If you wish, you may also let users set this mode. Only opers with the
1457 # users/auspex priv will see real hosts of people, though. This setting
1458 # is not reloadable via /rehash, and will require /reloadmodule, as
1459 # it directly affects the mode object itself.
1460 #<showwhois opersonly="yes"
1462 # You may also set whether or not users should recieve whois notices, should
1463 # they be /whois'd by an oper.
1464 # showfromopers="yes">
1466 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1467 # Shun module: Provides the /shun command, which stops a user executing
1469 # This module is oper-only.
1470 # To use, SHUN must be in one of your oper class blocks.
1471 #<module name="m_shun.so">
1473 # You may also configure which commands you wish a user to be able to
1474 # perform. It should be noted that if a shunned user issues QUIT or PART
1475 # then their message will be removed, as if they did not issue one.
1477 # You may also (optionally) let the user know that their command was blocked.
1478 #<shun enabledcommands="PING PONG QUIT PART JOIN" notifyuser="yes">
1480 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1481 # Spy module: Provides the ability to see the complete names list of
1482 # channels an oper is not a member of
1483 # This module is oper-only.
1484 #<module name="m_spy.so">
1486 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1487 # SSL channel mode module: Adds support for SSL-only channels (+z).
1488 # does not do anything useful without a working SSL module (see below)
1489 #<module name="m_sslmodes.so">
1491 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1492 # Dummy ssl module: If you have other servers on your network which
1493 # have SSL, but your server does not have ssl enabled, you should load
1494 # this module, which will handle SSL metadata (e.g. the "Is using ssl"
1495 # field in the WHOIS information).
1496 #<module name="m_ssl_dummy.so">
1498 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1499 # GnuTLS ssl module: Adds support for client-server SSL using GnuTLS,
1500 # if enabled. You must copy the source for this module from the directory
1501 # src/modules/extra, or answer 'yes' in ./configure when asked if you
1502 # want to enable this, or it will not load.
1503 #<module name="m_ssl_gnutls.so">
1505 #-#-#-#-#-#-#-#-#-#-#- GNUTLS CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#
1507 # m_ssl_gnutls.so is too complex it describe here, see the wiki: #
1508 # http://www.inspircd.org/wiki/GnuTLS_SSL_Module #
1510 # NOTE: If you want to use this module to encrypt and sign your #
1511 # server to server traffic, you MUST load it before m_spanningtree in #
1512 # your configuration file! #
1514 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1515 # SSL Info module: Allows users to retrieve information about other
1516 # user's peer SSL certificates and keys. This can be used by client
1517 # scripts to validate users. For this to work, one of m_ssl_gnutls.so
1518 # or m_ssl_openssl.so must be loaded. You must symlink the source for
1519 # this module from the directory src/modules/extra.
1520 # This modules is in extras. Re-run configure with: ./configure --enable-extras=m_sslinfo.cpp
1521 # and run make install, then uncomment this module to enable it.
1523 #<module name="m_sslinfo.so">
1525 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1526 # OpenSSL ssl module: Adds support for client-server SSL using OpenSSL,
1527 # if enabled. You must copy the source for this module from the directory
1528 # src/modules/extra, or answer 'yes' in ./configure when asked if you
1529 # want to enable this, or it will not load.
1530 #<module name="m_ssl_openssl.so">
1532 #-#-#-#-#-#-#-#-#-#-#- OPENSSL CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#
1534 # m_ssl_openssl.so is too complex it describe here, see the wiki: #
1535 # http://www.inspircd.org/wiki/OpenSSL_SSL_Module #
1537 # NOTE: If you want to use this module to encrypt and sign your #
1538 # server to server traffic, you MUST load it before m_spanningtree in #
1539 # your configuration file! #
1541 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1542 # SSL Cert Oper module: Allows opers to oper up using the key fingerprint
1543 # stored within their SSL certificate and key pair.
1544 # When using this module, one of m_ssl_gnutls.so or m_ssl_openssl.so must
1545 # be loaded. An extra value should be added to enabled opers, which
1546 # is in the following format: fingerprint="<hash>". For more information,
1547 # see the example in the oper blocks.
1548 # This module is oper-only.
1549 #<module name="m_ssl_oper_cert.so">
1551 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1552 # Strip colour module: Adds the channel mode +S
1553 #<module name="m_stripcolor.so">
1555 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1556 # SILENCE module: Adds support for /SILENCE
1557 #<module name="m_silence.so">
1559 # Configuration tags:
1561 #<silence maxentries="32">
1563 # Sets the maximum number of entries on a users silence list.
1565 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1566 # SQLite3 module: Allows other SQL modules to access SQLite3 #
1567 # databases through a unified API. You must link the source for this #
1568 # module from the directory src/modules/extra to src/modules, plus #
1569 # the file m_sqlv2.h #
1570 # This modules is in extras. Re-run configure with: ./configure --enable-extras=m_aqlite.cpp
1571 # and run make install, then uncomment this module to enable it. #
1573 #<module name="m_sqlite3.so">
1575 #-#-#-#-#-#-#-#-#-#-#-#- SQL CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#-#
1577 # m_sqlite.so is more complex than described here, see the wiki for #
1578 # more: http://www.inspircd.org/wiki/SQLite3_Service_Provider_Module #
1580 #<database hostname="/full/path/to/database.db" id="anytext">
1582 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1583 # SQLutils module: Provides some utilities to SQL client modules, such
1584 # as mapping queries to users and channels. You must copy the source
1585 # for this module from the directory src/modules/extra/m_sqlutils.cpp
1586 # and src/modules/extra/m_sqlutils.h into /src/modules
1587 # Needed for, and loaded before: SQLauth and SQLoper
1588 # This modules is in extras. Re-run configure with: ./configure --enable-extras=m_sqlutils.cpp
1589 # and run make install, then uncomment this module to enable it.
1591 #<module name="m_sqlutils.so">
1593 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1594 # SQL authentication module: Allows IRCd connections to be tied into
1595 # a database table (for example a forum). You must copy the source for
1596 # this module from the directory src/modules/extra
1597 # Depends on the SQLutils module being loaded first.
1598 # This modules is in extras. Re-run configure with: ./configure --enable-extras=m_sqlauth.cpp
1599 # and run make install, then uncomment this module to enable it.
1601 #<module name="m_sqlauth.so">
1603 #-#-#-#-#-#-#-#-#-#-#- SQLAUTH CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#
1605 # m_sqlauth.so is too complex it describe here, see the wiki: #
1606 # http://www.inspircd.org/wiki/SQL_Authentication_Module #
1608 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1609 # SQL logging module: Allows you to log network-wide data for your
1610 # network in a fully normalised set of SQL tables. You must copy the
1611 # source for this module from the directory src/modules/extra
1612 # This modules is in extras. Re-run configure with: ./configure --enable-extras=m_sqllog.cpp
1613 # and run make install, then uncomment this module to enable it.
1615 #<module name="m_sqllog.so">
1617 #-#-#-#-#-#-#-#-#-#-#- SQLLOG CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#
1619 # dbid - Database ID to use (see m_sql) #
1621 # See also: http://www.inspircd.org/wiki/SQL_Logging_Module #
1625 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1626 # SQL oper module: Allows you to store oper credentials in an SQL table
1627 # You must copy the source for this module from the directory src/modules/extra
1628 # Depends on the SQLutils module being loaded first.
1629 # This modules is in extras. Re-run configure with: ./configure --enable-extras=m_sqloper.cpp
1630 # and run make install, then uncomment this module to enable it.
1632 #<module name="m_sqloper.so">
1634 #-#-#-#-#-#-#-#-#-#-#- SQLOPER CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#
1636 # dbid - Database ID to use (see m_sql) #
1637 # hash - Hashing provider to use for password hashing #
1639 # See also: http://www.inspircd.org/wiki/SQL_Oper_Storage_Module #
1641 #<sqloper dbid="1" hash="md5">
1643 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1644 # SVSHold module: Implements SVSHOLD. Like Q:Lines, but can only be #
1645 # added/removed by Services. #
1646 #<module name="m_svshold.so">
1648 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1649 # SWHOIS module: Allows you to add arbitary lines to user WHOIS.
1650 # This module is oper-only.
1651 # To use, SWHOIS must be in one of your oper class blocks.
1652 #<module name="m_swhois.so">
1654 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1655 # Taxonomy module: Adds the /TAXONOMY command, used to view all
1656 # metadata attached to a user.
1657 # This module is oper-only.
1658 # To use, TAXONOMY must be in one of your oper class blocks.
1659 #<module name="m_taxonomy.so">
1661 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1662 # Test command module: Does nothing significant. Read: pointless.
1663 #<module name="m_testcommand.so">
1665 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1666 # Timed bans module: Adds timed bans and the /TBAN command
1667 # This module is oper-only.
1668 # To use, TBAN must be in one of your oper class blocks.
1669 #<module name="m_timedbans.so">
1671 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1672 # Test line module: Adds the /TLINE command, used to test how many
1673 # users a /GLINE or /ZLINE etc would match.
1674 # This module is oper-only.
1675 # To use, TLINE must be in one of your oper class blocks.
1676 #<module name="m_tline.so">
1678 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1679 # UHNAMES support module: Adds support for the IRCX style UHNAMES
1680 # extension, which displays ident and hostname in the names list for
1681 # each user, saving clients from doing a WHO on the channel. Note that
1682 # this module is not widely supported yet. If a client does not support
1683 # UHNAMES it will not enable it, this will not break incompatible
1685 #<module name="m_uhnames.so">
1687 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1688 # Uninvite module: Adds the /UNINVITE command which lets users remove
1689 # pending invites from channels without waiting for the user to join.
1690 #<module name="m_uninvite.so">
1692 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1693 # Userip module: Adds the /USERIP command
1694 # This module is oper-only.
1695 # To use, USERIP must be in one of your oper class blocks.
1696 #<module name="m_userip.so">
1698 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1699 # Vhost module: Adds the VHOST command which allows for adding virtual
1700 # hosts which are accessible using a username and password in the config.
1701 #<module name="m_vhost.so">
1703 #-#-#-#-#-#-#-#-#-#-#- VHOST CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#-#
1705 # user - Username for the vhost. #
1707 # pass - Password for the vhost. #
1709 # host - Vhost to set. #
1711 #<vhost user="some_username" pass="some_password" host="some.host">
1713 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1714 # Watch module: Adds the WATCH command, which is used by clients to
1715 # maintain notify lists.
1716 #<module name="m_watch.so">
1718 # Configuration tags:
1720 #<watch maxentries="32">
1722 # Sets the maximum number of entries on a user's watch list.
1724 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1725 # XLine database: Stores all *Lines (G/Z/K/R/any added by other modules)
1726 # in a file "xline.db" which can be re-loaded on restart. This is useful
1727 # for two reasons: it keeps bans so users may not evade them, and on
1728 # bigger networks, server connections will take less time as there will
1729 # be a lot less bans to apply - as most of them will already be there.
1730 #<module name="m_xline_db.so">
1732 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1733 # ZipLinks module: Adds support for zlib deflate on server to server
1734 # connections. Both ends of the connection must load this module.
1735 # This modules is in extras. Re-run configure with: ./configure --enable-extras=m_ziplink.cpp
1736 # and run make install, then uncomment this module to enable it.
1738 #<module name="m_ziplink.so">
1740 # To use this module, you must enable it as a transport type in your
1741 # <link> tags or <bind> tags using the transport name 'zip'.
1742 # See the documentation of <link> and <bind>, respectively.
1746 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1747 # ____ _ _____ _ _ ____ _ _ _ #
1748 # | _ \ ___ __ _ __| | |_ _| |__ (_)___ | __ )(_) |_| | #
1749 # | |_) / _ \/ _` |/ _` | | | | '_ \| / __| | _ \| | __| | #
1750 # | _ < __/ (_| | (_| | | | | | | | \__ \ | |_) | | |_|_| #
1751 # |_| \_\___|\__,_|\__,_| |_| |_| |_|_|___/ |____/|_|\__(_) #
1753 # To link servers to InspIRCd, you MUST load the m_spanningtree #
1754 # module. Since several features (like SSL server links) rely on #
1755 # other modules being loaded before m_spanningtree, the module itself #
1756 # is at the bottom of this file. DO NOT forget to load it. If you DO #
1757 # NOT do this, server links will NOT work at all. ie. The ports will #
1758 # NOT bind, and /connect will not work properly. This is by design, #
1759 # to allow for the implementation of other linking protocols in #
1760 # modules in the future. #
1763 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1764 # Spanning Tree module - allows linking of servers using the spanning
1765 # tree protocol (see the READ THIS BIT section above).
1766 # You will almost always want to load this.
1768 #<module name="m_spanningtree.so">
projects / user / henk / code / inspircd.git / blob