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">
74 #-#-#-#-#-#-#-#-#-#-#- ALIAS DEFINITIONS -#-#-#-#-#-#-#-#-#-#-#-#-#-#
76 # If you have the m_alias.so module loaded, you may also define #
77 # aliases as shown below. They are commonly used to provide shortcut #
78 # commands to services, however they are not limited to just this use.#
79 # An alias tag requires the following values to be defined in it: #
81 # text - The text to detect as the actual command line, #
82 # Cant contain spaces, but case insensitive. #
83 # You may have multiple aliases with the same #
84 # command name (text="" value), however the first #
85 # found will be executed if its format value is #
86 # matched, or it has no format value. Aliases are #
87 # read from the top of the file to the bottom. #
89 # format - If this is defined, the parameters of the alias #
90 # must match this glob pattern. For example if you #
91 # want the first parameter to start with a # for #
92 # the alias to be executed, set format="#*" in the #
93 # alias definition. Note that the :'s which are #
94 # part of IRC formatted lines will be preserved #
95 # for matching of this text. This value is #
98 # replace - The text to replace 'text' with. Usually this #
99 # will be "PRIVMSG ServiceName :$2-" or similar. #
100 # You may use the variables $1 through $9 in the #
101 # replace string, which refer to the first through #
102 # ninth word in the original string typed by the #
103 # user. You may also use $1- through $9- which #
104 # refer to the first word onwards, through to the #
105 # ninth word onwards, e.g. if the user types the #
106 # command "foo bar baz qux quz" then $3- will hold #
107 # "baz qux quz" and $2 will contain "bar". You may #
108 # also use the special variables: $nick, $ident, #
109 # $host and $vhost, and you may separate multiple #
110 # commands with \n. If you wish to use the ACTUAL #
111 # characters \ and n together in a line, you must #
112 # use the sequence "\\n". #
114 # requires - If you provide a value for 'requires' this means #
115 # the given nickname MUST be online for the alias #
116 # to successfully trigger. If they are not, then #
117 # the user receives a 'no such nick' 401 numeric. #
119 # uline - Defining this value with 'yes', 'true' or '1' #
120 # will ensure that the user given in 'requires' #
121 # must also be on a u-lined server, as well as #
122 # actually being on the network. If the user is #
123 # online, but not on a u-lined server, then an #
124 # oper-alert is sent out as this is possibly signs #
125 # of a user trying to impersonate a service. #
127 # operonly - Defining this value, with a value of 'yes', '1' #
128 # or true will make the alias oper only. If a non- #
129 # oper attempts to use the alias, it will appear #
132 #<alias text="NICKSERV" replace="PRIVMSG NickServ :$2-" requires="NickServ" uline="yes">
133 #<alias text="CHANSERV" replace="PRIVMSG ChanServ :$2-" requires="ChanServ" uline="yes">
134 #<alias text="OPERSERV" replace="PRIVMSG OperServ :$2-" requires="OperServ" uline="yes" operonly="yes">
135 #<alias text="NS" replace="PRIVMSG NickServ :$2-" requires="NickServ" uline="yes">
136 #<alias text="CS" replace="PRIVMSG ChanServ :$2-" requires="ChanServ" uline="yes">
137 #<alias text="OS" replace="PRIVMSG OperServ :$2-" requires="OperServ" uline="yes" operonly="yes">
139 # An example of using the format value to create an alias with two
140 # different behaviours depending on the format of the parameters.
142 #<alias text="ID" format="#*" replace="PRIVMSG ChanServ :IDENTIFY $2 $3"
143 # requires="ChanServ" uline="yes">
145 #<alias text="ID" replace="PRIVMSG NickServ :IDENTIFY $2"
146 # requires="NickServ" uline="yes">
148 # This alias fixes a glitch in xchat 2.6.x and above and the way it
149 # assumes IDENTIFY must be prefixed by a colon (:) character. It should
150 # be placed ABOVE the default NICKSERV alias (the first example) listed
153 #<alias text="NICKSERV" format=":IDENTIFY *" replace="PRIVMSG NickServ :IDENTIFY $3-"
154 # requires="NickServ" uline="yes">
156 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
157 # Allowinvite module: Gives channel mode +A to allow all users to use
158 # /invite, and extban A to deny invite from specific masks
159 #<module name="m_allowinvite.so">
161 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
162 # Alltime module: Shows time on all connected servers at once.
163 # This module is oper-only and provides /alltime.
164 # To use, ALLTIME must be in one of your oper class blocks.
165 #<module name="m_alltime.so">
167 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
168 # Antibear security module: Prevents 'bear.txt' based trojans from
169 # connecting to your network by sending them a numeric they can't handle.
170 #<module name="m_antibear.so">
172 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
173 # Antibottler module: Labels bottler leech bots
174 #<module name="m_antibottler.so">
176 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
177 # Auditorium module: Adds channel mode +u which makes everyone else
178 # except you in the channel invisible, used for large meetings etc.
179 #<module name="m_auditorium.so">
181 # Auditorium settings:
183 #<auditorium showops="no" operoverride="no">
186 # Setting this value to yes makes m_auditorium behave like unrealircd
187 # +u channel mode, e.g. ops see users joining, parting, etc, and users
188 # joining the channel see the ops. Without this flag, the mode acts
189 # like ircnet's +a (anonymous channels), showing only the user in the
190 # names list, and not even showing the ops in the list, or showing the
191 # ops that the user has joined.
193 # Setting this value to yes makes m_auditorium affect the userlist for
194 # regular users only. Opers will view all users in the channel normally.
196 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
197 # Ban except module: Adds support for channel ban exceptions (+e)
198 #<module name="m_banexception.so">
200 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
201 # Ban redirection module: Allows bans which redirect to a specified
202 # channel. e.g. +b nick!ident@host#channelbanneduserissentto
203 #<module name="m_banredirect.so">
205 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
206 # Block amsg module: Attempt to block all usage of /amsg and /ame
207 #<module name="m_blockamsg.so">
209 #-#-#-#-#-#-#-#-#-#-#- BLOCKAMSG CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
211 # If you have the m_blockamsg.so module loaded, you can configure it #
212 # with the <blockamsg> tag: #
214 # delay - How many seconds between two messages to force #
215 # them to be recognised as unrelated. #
216 # action - Any of 'notice', 'noticeopers', 'silent', 'kill' #
217 # or 'killopers'. Define how to take action when #
218 # a user uses /amsg or /ame. #
220 #<blockamsg delay="3" action="killopers">
222 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
223 # Block CAPS module: Blocking all-CAPS messages with cmode +B
224 #<module name="m_blockcaps.so">
226 #-#-#-#-#-#-#-#-#-#-#- BLOCKCAPS CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
228 # percent - How many percent of text must be caps before text #
231 # minlen - The minimum length a line must be for the block #
232 # percent to have any effect. #
234 # capsmap - A list of chars to be considered CAPS, this was #
235 # you can add CAPS for your language. Also you can #
236 # add things like ! and space to further lock down #
238 #<blockcaps percent="50"
240 # capsmap="ABCDEFGHIJKLMNOPQRSTUVWXYZ! ">
242 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
243 # Block colour module: Blocking colour-coded messages with cmode +c
244 #<module name="m_blockcolor.so">
246 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
247 # Botmode module: Adds the user mode +B
248 #<module name="m_botmode.so">
250 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
251 # CallerID module: Adds usermode +g which activates hybrid-style
252 # callerid (== block all private messages unless you /accept first)
253 #<module name="m_callerid.so">
255 #-#-#-#-#-#-#-#-#-#-#- CALLERID CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#
256 # maxaccepts - Maximum number of entires a user can add to his #
257 # /accept list. Default is 16 entries. #
258 # operoverride - Can opers (note: ALL opers) ignore callerid mode? #
260 # tracknick - Preserve /accept entries when a user changes nick? #
261 # If no (the default), the user is removed from #
262 # everyone's accept list if he changes nickname. #
263 # cooldown - Amount of time (in seconds) that must pass since #
264 # the last notification sent to a user before he can #
265 # be sent another. Default is 60 (1 minute). #
266 #<callerid maxaccepts="16"
271 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
272 # CAP module: Provides the CAP negotiation mechanism seen in
273 # ratbox-derived ircds
274 #<module name="m_cap.so">
276 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
277 # CBAN module: Lets you disallow channels from being used at runtime.
278 # This module is oper-only and provides /cban.
279 # To use, CBAN must be in one of your oper class blocks.
280 #<module name="m_cban.so">
282 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
283 # Censor module: Adds the channel mode +G
284 #<module name="m_censor.so">
286 #-#-#-#-#-#-#-#-#-#-#- CENSOR CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#
288 # Optional - If you specify to use the m_censor module, then you must #
289 # specify some censor tags. See also: #
290 # http://www.inspircd.org/wiki/Censor_Module #
292 #<include file="censor.conf">
294 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
295 # CGI:IRC module: Adds support for automatic host changing in CGI:IRC
296 # (http://cgiirc.sourceforge.net).
297 #<module name="m_cgiirc.so">
299 #-#-#-#-#-#-#-#-#-#-#-# CGIIRC CONFIGURATION #-#-#-#-#-#-#-#-#-#-#-#-#
301 # Optional - If you specify to use m_cgiirc, then you must specify one
302 # or more cgihost tags which indicate authorised CGI:IRC servers which
303 # will be connecting to your network, and an optional cgiirc tag.
304 # For more information see: http://www.inspircd.org/wiki/CGI-IRC_Module
306 # Set to yes if you want to notice opers when CGI clients connect
307 # <cgiirc opernotice="no">
309 # The type field indicates where the module should get the real
310 # client's IP address from, for further information, please see the
311 # CGI:IRC documentation.
314 # <cgihost type="pass" mask="www.mysite.com"> # Get IP from PASS
315 # <cgihost type="ident" mask="otherbox.mysite.com"> # Get IP from ident
316 # <cgihost type="passfirst" mask="www.mysite.com"> # See the docs
318 # <cgihost type="webirc" pass="foobar"
319 # mask="somebox.mysite.com"> # Get IP from WEBIRC
324 # When you connect CGI:IRC clients, there are two connect classes which
325 # apply to these clients. When the client initially connects, the connect
326 # class which matches the cgi:irc site's host is checked. Therefore you
327 # must raise the maximum local/global clients for this ip as high as you
328 # want to allow cgi clients. After the client has connected and is
329 # determined to be a cgi:irc client, the class which matches the client's
330 # real IP is then checked. You may set this class to a lower value, so that
331 # the real IP of the client can still be restricted to, for example, 3
336 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
337 # Channel create module: Adds snomask +j, which will notify opers of
338 # any new channels that are created.
339 # This module is oper-only.
340 #<module name="m_chancreate.so">
342 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
343 # Channel filter module: Allows channel-op defined message
344 # filtering using simple string matches (channel mode +g)
345 #<module name="m_chanfilter.so">
347 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
348 # Channel logging module: used to send snotice output to channels, to
349 # allow staff to centrally monitor and discuss network activity.
351 # The "channel" field is where you want the messages to go, "snomasks"
352 # is what snomasks you want to be sent to that channel. Multiple tags
354 #<module name="m_chanlog.so">
355 #<chanlog snomasks="AOcC" channel="#opers">
357 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
358 # Channelban: Implements extended ban j:, which stops anyone in already
359 # in a channel matching a mask like +b j:#channel*mask from joining.
360 #<module name="m_channelban.so">
362 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
363 # Chanprotect module: gives +q and +a channel modes
364 #<module name="m_chanprotect.so">
367 # noservices: With this set to no, when a user joins a empty channel,
368 # the server will set +q on them. If set to yes, it will only set +o
369 # on them until they register the channel.
372 # qprefix: Prefix (symbol) to use for +q users.
375 # aprefix: Prefix (symbol) to use for +a users.
378 # deprotectself: If this value is set (true, yes or 1), it will allow
379 # +a and +q users to remove the +a and +q from themselves, otherwise,
380 # the status will have to be removed by services.
383 # deprotectothers: If this value is set to yes, true, or 1, then any
384 # user with +q or +a may remove the +q or +a from other users.
385 deprotectothers="yes">
388 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
389 # Check module: gives /check
390 # Check is useful for looking up information on channels,
391 # users, IP addresses and hosts.
392 # This module is oper-only.
393 # To use, CHECK must be in one of your oper class blocks.
394 #<module name="m_check.so">
396 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
397 # CHGHOST module: Adds the /CHGHOST command
398 # This module is oper-only.
399 # To use, CHGHOST must be in one of your oper class blocks.
400 #<module name="m_chghost.so">
402 #-#-#-#-#-#-#-#-# /CHGHOST - /SETHOST CONFIGURATION #-#-#-#-#-#-#-#-#
403 # Optional - If you want to use special chars for hostnames you can #
404 # specify your own custom list of chars with the <hostname> tag: #
406 # charmap - A list of chars accepted as valid by the /CHGHOST #
407 # and /SETHOST commands. Also note that the list is #
409 #<hostname charmap="abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ.-_/0123456789">
411 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
412 # CHGIDENT module: Adds the /CHGIDENT command
413 # This module is oper-only.
414 # To use, CHGIDENT must be in one of your oper class blocks.
415 #<module name="m_chgident.so">
417 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
418 # CHGNAME module: Adds the /CHGNAME command
419 # This module is oper-only.
420 # To use, CHGNAME must be in one of your oper class blocks.
421 #<module name="m_chgname.so">
423 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
424 # Cloaking module: Adds usermode +x and cloaking support.
425 # Relies on the module m_md5.so being loaded before m_cloaking.so in
426 # the configuration file.
427 # To use, you should enable m_conn_umodes and add +x as
428 # an enabled mode. See the m_conn_umodes module for more information.
429 #<module name="m_cloaking.so">
431 #-#-#-#-#-#-#-#-#-#-#- CLOAKING CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#
433 # Optional - If you specify the m_cloaking.so module as above, you #
434 # must define cloak keys, and optionally a cloak prefix as shown #
435 # below. When using cloaking, the cloak keys are MANDITORY and must #
436 # be included. However, if prefix is not included, it will default #
437 # to your networks name from the <server> tag. You can also include #
438 # the following optional values: #
440 # ipalways - Always cloak the IP address, not the hostname, #
441 # which doesn't reveal the user's ISP, but #
442 # results in hosts that are harder to read and #
445 # lowercase - Display the cloaked hostnames in lowercase #
446 # characters instead of uppercase #
448 # <cloak key1="0x2AF39F40" #
449 # key2="0x78E10B32" #
450 # key3="0x4F2D2E82" #
451 # key4="0x043A4C81" #
454 # lowercase="false"> #
456 # Please note that the key values will accept any number, and should #
457 # be large numbers. Using small numbers such as "7" or "1924" will #
458 # seriously weaken the security of your cloak. It is recommended you #
459 # use hexdecimal numbers prefixed by "0x", as shown in this example, #
460 # with each key eight hex digits long. #
462 #-#-#-#-#-#-#-#-#-#-#-#- CLOSE MODULE #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
463 # Close module: Allows an oper to close all unregistered connections.
464 # This module is oper-only and provides /close.
465 # To use, CLOSE must be in one of your oper class blocks.
466 #<module name="m_close.so">
468 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
469 # Clones module: Adds an oper command /CLONES for detecting cloned
470 # users. Warning: This module may be resource intensive when its
471 # command is issued, use with care.
472 # This module is oper-only.
473 # To use, CLONES must be in one of your oper class blocks.
474 #<module name="m_clones.so">
476 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
477 # Common channels module: Adds user mode +c, which, when set, requires
478 # that users must share a common channel with you to PRIVMSG or NOTICE
480 #<module name="m_commonchans.so">
482 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
483 # Conn-Join: Allows you to force users to join one or more channels
484 # automatically upon connecting to the server.
485 #<module name="m_conn_join.so">
487 #-#-#-#-#-#-#-#-#-#-#-#- CONNJOIN CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
489 # If you have m_conn_join.so loaded, you can configure it using the
492 #<autojoin channel="#one,#two,#three">
494 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
495 # Conn-Usermodes: Set modes on users when they connect
496 # When this module is loaded <connect:allow> tags may have an optional
497 # modes="" value, which contains modes to add or remove from users
498 # when they connect to the server.
499 #<module name="m_conn_umodes.so">
501 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
502 # Conn-Wait-for-Pong: Don't let a user connect until they PONG
503 #<module name="m_conn_waitpong.so">
505 #-#-#-#-#-#-#-#-#-#-#- WAITPONG CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
507 # If you have the m_conn_waitpong.so module loaded, configure it with #
508 # the <waitpong> tag: #
510 # sendsnotice - Whether to send a snotice on connect, like other #
513 # killonbadreply - Whether to kill the user if they send the wrong #
516 #<waitpong sendsnotice="yes" killonbadreply="yes">
519 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
520 # Channel cycle module. Server side /hop, with +ilk etc bypass.
521 #<module name="m_cycle.so">
523 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
524 # Connectban: Provides IP connection throttling. Any IP range that connects
525 # too many times (configurable) in an hour is zlined for a (configurable)
526 # duration, and their count resets to 0.
528 # ipv4cidr and ipv6cidr allow you to turn the comparison from individual
529 # IP addresses (32 and 128 bits) into CIDR masks, to allow for throttling
530 # over whole ISPs/blocks of IPs, which may be needed to prevent attacks.
532 #<connectban threshold="10" duration="10m" ipv4cidr="32" ipv6cidr="128">
533 # This allows for 10 connections in an hour with a 10 minute ban if that is exceeded.
535 #<module name="m_connectban.so">
537 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
538 # Connection throttle module. Configuration:
539 #<module name="m_connflood.so">
541 #-#-#-#-#-#-#-#-#-#-#- CONTHROTTLE CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
542 # seconds, maxconns - Amount of connections per <seconds>.
544 # timeout - Time to wait after the throttle was activated
545 # before deactivating it. Be aware that the time
546 # is seconds + timeout.
548 # quitmsg - The message that users get if they attempt to
549 # connect while the throttle is active.
551 # bootwait - Amount of time to wait before enforcing the
552 # throttling when the server just booted.
554 #<connflood seconds="30" maxconns="3" timeout="30"
555 # quitmsg="Throttled" bootwait="10">
557 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
558 # Custom title module: Adds the /TITLE command which allows for trusted
559 # users to gain a custom whois line and a optional
560 # vhost can be specified.
561 #<module name="m_customtitle.so">
563 #-#-#-#-#-#-#-#-#-#- CUSTOM TITLE CONFIGURATION -#-#-#-#-#-#-#-#-#-#
564 # name - The username used to identify
565 # password - The password used to identify
566 # host - Allowed hostmask [optional]
567 # title - Title shown in whois
568 # vhost - Displayed host [optional]
570 #<title name="foo" password="bar" title="Official Chat Helper">
571 #<title name="bar" password="foo" host="ident@host.name" title="Official Chat Helper" vhost="helper.network.chat">
573 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
574 # DCCALLOW module: Adds the /DCCALLOW command
575 #<module name="m_dccallow.so">
577 #-#-#-#-#-#-#-#-#-#-#- DCCALLOW CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
578 # blockchat - Whether to block DCC CHAT as well as DCC SEND
579 # length - Default duration of entries in DCCALLOW list
580 # action - Default action to take if no action is specified
581 # can be 'block' or 'allow'
583 # File configuration:
584 # pattern - The glob pattern to match against
585 # action - Action to take if a user attempts to send a file
586 # that matches this pattern, can be 'block' or 'allow'
588 #<dccallow blockchat="yes" length="5m" action="block">
589 #<banfile pattern="*.exe" action="block">
590 #<banfile pattern="*.txt" action="allow">
592 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
594 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
595 # Deaf module: adds support for ircu style usermode +d - deaf to
596 # channel messages and channel notices.
597 #<module name="m_deaf.so">
599 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
600 # Delay join module: Adds the channel mode +D which delays all JOIN
601 # messages from users until they speak. If they quit or part before
602 # speaking, their quit or part message will not be shown to the channel
603 # which helps cut down noise on large channels in a more friendly way
604 # than the auditorium mode. Only channel ops may set the +D mode.
605 #<module name="m_delayjoin.so">
607 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
608 # Deny Channels: Deny Channels from being used by users
609 #<module name="m_denychans.so">
611 #-#-#-#-#-#-#-#-#-#-#- DENYCHAN DEFINITIONS -#-#-#-#-#-#-#-#-#-#-#-#
613 # If you have the m_denychans.so module loaded, you need to specify #
614 # the channels to deny: #
616 # name - The channel name to deny. (glob masks are ok) #
618 # allowopers - If operators are allowed to override the deny. #
620 # reason - Reason given for the deny. #
622 # redirect - Redirect the user to a different channel #
624 #<badchan name="#gods*" allowopers="yes" reason="Tortoises!"> #
625 #<badchan name="#heaven" redirect="#hell" reason="Nice try!"> #
627 # Redirects will not work if the target channel is set +L. #
629 # Additionally, you may specify channels which are allowed, even if #
630 # a badchan tag specifies it would be denied: #
631 #<goodchan name="#godsleeps"> #
632 # Glob masks are accepted here also.
634 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
635 # Devoice Module: Let users devoice themselves.
636 #<module name="m_devoice.so">
638 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
639 # DNS Blacklist Module: Provides support for looking up IPs on one or #
641 #<module name="m_dnsbl.so"> #
643 # For configuration options please see the wiki page for m_dnsbl at #
644 # http://inspircd.org/wiki/DNS_Blacklist_Module #
646 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
647 # Filter module: Provides message filtering, similar to SPAMFILTER.
648 #<module name="m_filter.so">
650 # This module depends upon a regex provider such as m_regex_pcre or #
651 # m_regex_glob to function. You must specify which of these you want #
652 # m_filter to use via the tag below. #
654 # Valid engines are: #
656 # glob - Glob patterns, provided via m_regex_glob.so #
657 # pcre - PCRE regexps, provided via m_regex_pcre.so, needs libpcre #
658 # tre - TRE regexps, provided via m_regex_tre.so, requires libtre #
659 # posix - POSIX regexps, provided via m_regex_posix.so, not availale #
660 # on windows, no dependencies on other operating systems. #
662 #<filteropts engine="glob"> #
664 # Your choice of regex engine must match on all servers network-wide.
666 #-#-#-#-#-#-#-#-#-#-#- FILTER CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#
668 # Optional - If you specify to use the m_filter module, then #
669 # specfiy below the path to the filter.conf file, or define some #
672 #<include file="filter.conf">
674 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
675 # Foobar module: does nothing - historical relic
676 #<module name="m_foobar.so">
678 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
679 # Gecosban: Implements extended ban r:, which stops anyone matching
680 # a mask like +b r:*realname?here* from joining a channel.
681 #<module name="m_gecosban.so">
683 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
684 # GeoIP module: Allows the server admin to ban users by country code.
685 # This modules is in extras. Re-run configure with: ./configure --enable-extras=m_geoip.cpp
686 # and run make install, then uncomment this module to enable it.
687 #<module name="m_geoip.so">
689 #-#-#-#-#-#-#-#-#-#-#-# GEOIP CONFIGURATION #-#-#-#-#-#-#-#-#-#-#-#-#
691 # <geoip banunknown="false"> #
693 # Set this value to true or yes to block unknown IP ranges which are #
694 # not in the database (usually LAN addresses, localhost, etc) #
696 # <geoban country="TR" reason="This country not permitted"> #
698 # Use one or more of these tags to ban countries by country code. #
699 # The country code must be in capitals and should be an ISO country #
700 # code such as TR, GB, or US. #
702 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
703 # Globops module: gives /GLOBOPS and SNOMASK +g
704 # This module is oper-only.
705 # To use, GLOBOPS must be in one of your oper class blocks.
706 #<module name="m_globops.so">
708 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
709 # Global load module: Allows loading and unloading of modules network-
710 # wide (USE WITH EXTREME CAUTION!)
711 # This module is oper-only and provides /gloadmodule, /gunloadmodule
712 # and /greloadmodule.
713 # To use, GLOADMODULE, GUNLOADMODULE and GRELOADMODULE
714 # must be in one of your oper class blocks.
715 #<module name="m_globalload.so">
717 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
718 # HELPOP module: Provides the /HELPOP command
719 #<module name="m_helpop.so">
721 #-#-#-#-#-#-#-#-#-#-#-#- HELPOP CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
723 # Optional - If you specify to use the m_helpop.so module, then #
724 # specify below the path to the helpop.conf file, or if you like to #
725 # make a mess, define your helpop tags in this conf. #
727 #<include file="helpop.conf">
729 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
730 # HIDECHANS module: Allows opers to hide their channels list from non-
731 # opers by setting user mode +I on themselves.
732 # <module name="m_hidechans.so">
734 # HIDECHANS can optionally prevent opers from seeing channels on a +I
735 # user, for more privacy if set to true.
736 # This setting is not recommended for most mainstream networks.
737 #<hidechans affectsopers="false">
739 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
740 # HIDEOPER module: Allows opers to hide their oper status from non-
741 # opers by setting user mode +H on themselves.
742 # This module is oper-only.
743 # <module name="m_hideoper.so">
745 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
746 # Hostchange module: Allows a different style of cloaking
747 #<module name="m_hostchange.so">
749 #-#-#-#-#-#-#-#-#-#-#- HOSTCHANGE CONFIGURATION -#-#-#-#-#-#-#-#-#-#
751 # Optional - If you choose to use the m_hostchange.so module. #
752 # Config Help - See http://www.inspircd.org/wiki/Host_Changer_Module #
754 #<host suffix="polarbears.org" separator="." prefix="">
755 #<hostchange mask="*@fbi.gov" action="addnick">
756 #<hostchange mask="*r00t@*" action="suffix">
757 #<hostchange mask="a@b.com" action="set" value="blah.blah.blah">
758 #<hostchange mask="localhost" ports="7000,7001,7005-7007" action="set" value="blahblah.foo">
760 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
761 # httpd module: Provides http server support for InspIRCd
762 #<module name="m_httpd.so">
764 #-#-#-#-#-#-#-#-#-#-#-#- HTTPD CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
766 # Optional - If you choose to use the m_httpd.so module, then you must
767 # specify the port number and other details of your http server:
769 #<http ip="192.168.1.10" host="brainwave" port="32006"
770 # index="/home/brain/inspircd/http/index.html">
772 # You may have as many of these tags as you wish, each with a different
773 # IP, port, host or index file. Each one will act as an independent
777 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
778 # http ACL module: Provides access control lists for m_httpd dependent
779 # modules. Use this module to restrict pages by IP address and by
782 #<module name="m_httpd_acl.so">
784 #-#-#-#-#-#-#-#-#-#-#-#- HTTPD ACL CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
786 # Restrict access to the m_httpd_stats module to all but the local
787 # network and when the correct password is specified:
789 # <httpdacl path="/stats*" types="password,whitelist"
790 # username="secretstuff" password="mypasshere" whitelist="127.0.0.*,10.*">
792 # Deny all connections to all but the main index page:
794 # <httpdacl path="/*" types="blacklist" blacklist="*">
797 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
798 # http config module: Allows the server's configuration to be viewed
799 # over HTTP. Requires m_httpd.so to be loaded for it to function.
800 #<module name="m_httpd_config.so">
802 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
803 # http stats module: Provides basic stats pages over HTTP
804 # Requires m_httpd.so to be loaded for it to function.
805 #<module name="m_httpd_stats.so">
807 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
808 # Ident: Provides RFC 1413 ident lookup support
809 # When this module is loaded <connect:allow> tags may have an optional
810 # useident="yes|no" boolean value, determining whether or not to lookup
811 # ident on users matching that connect tag.
812 #<module name="m_ident.so">
814 #-#-#-#-#-#-#-#-#-#-#-#- IDENT CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
816 # Optional - If you are using the m_ident.so module, then you can #
817 # specify the timeout for ident lookups here. If not defined, it will #
818 # default to one second. This is a non-blocking timeout which holds #
819 # the user in a 'connecting' state until the lookup is complete. #
820 # The bind value indicates which IP to bind outbound requests to. #
824 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
825 # Invite except module: Adds support for channel invite exceptions (+I)
826 #<module name="m_inviteexception.so">
828 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
829 # Invisible module - Adds support for usermode +Q (quiet) which lets an
830 # oper go 'invisible' similar to unrealircd 3.1's +I mode. Note that
831 # opers are still able to see invisible users, and if an oper with +Q
832 # deopers, they will become visible.
834 # IMPORTANT NOTE: To allow this mode to be used by a type of oper, you
835 # must first add the value canquiet="yes" to that oper's type tag.
837 # This module is oper-only.
839 #<module name="m_invisible.so">
841 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
842 # Join flood module: Adds support for join flood protection (+j)
843 #<module name="m_joinflood.so">
845 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
846 # Jump Server module: Adds support for the RPL_REDIR numeric
847 # This module is oper-only.
848 # To use, JUMPSERVER must be in one of your oper class blocks.
849 #<module name="m_jumpserver.so">
851 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
852 # Anti-Auto-Rejoin: Adds support for prevention of auto-rejoin (+J)
853 #<module name="m_kicknorejoin.so">
855 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
856 # Knock module: adds the /KNOCK command and +K channel mode
857 #<module name="m_knock.so">
859 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
860 # LDAP authentication module: Adds the ability to authenticate users #
861 # via LDAP. This is an extra module which must be enabled explicitly #
862 # by symlinking it from modules/extra, and requires the OpenLDAP libs #
863 # This modules is in extras. Re-run configure with: ./configure --enable-extras=m_ldapauth.cpp
864 # and run make install, then uncomment this module to enable it. #
866 #<module name="m_ldapauth.so"> #
870 # <ldapauth baserdn="ou=People,dc=brainbox,dc=cc" #
872 # server="ldap://brainwave.brainbox.cc" #
873 # allowpattern="Guest*" #
874 # killreason="Access denied" #
875 # searchscope="subtree" #
876 # binddn="cn=Manager,dc=brainbox,dc=cc" #
877 # bindauth="mysecretpass" #
880 # The baserdn indicates the base DN to search in for users. Usually #
881 # this is 'ou=People,dc=yourdomain,dc=yourtld'. #
883 # The attribute value indicates the attribute which is used to locate #
884 # a user account by name. On POSIX systems this is usually 'uid'. #
886 # The server parameter indicates the LDAP server to connect to. The #
887 # ldap:// style scheme before the hostname proper is MANDITORY. #
889 # The allowpattern value allows you to specify a wildcard mask which #
890 # will always be allowed to connect regardless of if they have an #
891 # account, for example guest users. #
893 # Killreason indicates the QUIT reason to give to users if they fail #
896 # The searchscope value indicates the subtree to search under. On our #
897 # test system this is 'subtree'. Your mileage may vary. #
899 # Setting the verbose value causes an oper notice to be sent out for #
900 # every failed authentication to the server, with an error string. #
902 # The binddn and bindauth indicate the DN to bind to for searching, #
903 # and the password for the distinguished name. Some LDAP servers will #
904 # allow anonymous searching in which case these two values do not #
905 # need defining, otherwise they should be set similar to the examples #
908 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
909 # LDAP oper configuration module: Adds the ability to authenticate #
910 # opers via LDAP. This is an extra module which must be enabled #
911 # explicitly by symlinking it from modules/extra, and requires the #
912 # OpenLDAP libs. Re-run configure with: ./configure --enable-extras=m_ldapoper.cpp
913 # and run make install, then uncomment this module to enable it. #
915 #<module name="m_ldapoper.so">
919 # <ldapoper baserdn="ou=People,dc=brainbox,dc=cc"
920 # server="ldap://brainwave.brainbox.cc"
921 # searchscope="subtree"
922 # binddn="cn=Manager,dc=brainbox,dc=cc"
923 # bindauth="mysecretpass">
925 # Available configuration items are identical to the same items in #
926 # m_ldapauth above. #
928 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
929 # Lock server module: Adds /LOCKSERV and /UNLOCKSERV commands that is #
930 # used to temporarily close/open for new connections to the server. #
931 # These commands require OPER status and that the LOCKSERV UNLOCKSERV #
932 # are specified in a <class> tag that the oper is part of. This is so #
933 # you can control who has access to this possible dangerous command. #
934 # If your server is locked and you got disconnected, do a REHASH from #
935 # shell to open up again.
937 # This module is oper-only.
939 #<module name="m_lockserv.so">
941 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
942 # Map hiding module: replaces /MAP and /LINKS output to users with a #
943 # message to see a website, set by maphide="http://link.to/site" in #
944 # the security tag, instead. #
945 #<module name="m_maphide.so">
947 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
948 # Msg flood module: Adds message/notice flood protection (+f)
949 #<module name="m_messageflood.so">
951 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
952 # MsSQL module: Allows other SQL modules to access MS SQL Server
953 # through a unified API. You must copy the source for this module
954 # from the directory src/modules/extra, plus the file m_sqlv2.h
955 # This modules is in extras. Re-run configure with: ./configure --enable-extras=m_mssql.cpp
956 # and run make install, then uncomment this module to enable it.
958 #<module name="m_mssql.so">
960 #-#-#-#-#-#-#-#-#-#-#-#- SQL CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#-#
962 # m_mssql.so is more complex than described here, see wiki for more #
963 # info http://www.inspircd.org/wiki/SQLServer_Service_Provider_Module #
965 #<database name="db" username="user" password="pass" hostname="localhost" id="db1">
967 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
968 # MySQL module: Allows other SQL modules to access MySQL databases
969 # through a unified API. You must copy the source for this module
970 # from the directory src/modules/extra, plus the file m_sqlv2.h
971 # This modules is in extras. Re-run configure with: ./configure --enable-extras=m_mysql.cpp
972 # and run make install, then uncomment this module to enable it.
974 #<module name="m_mysql.so">
976 #-#-#-#-#-#-#-#-#-#-#-#- SQL CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#-#
978 # m_mysql.so is more complex than described here, see the wiki for #
979 # more: http://www.inspircd.org/wiki/SQL_Service_Provider_Module #
981 #<database name="mydb" username="myuser" password="mypass" hostname="localhost" id="my_database2">
983 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
984 # NAMESX module: Provides support for the NAMESX extension which allows
985 # clients to see all the prefixes set on a user without getting confused.
986 # This is supported by mIRC, x-chat, klient, and maybe more.
987 #<module name="m_namesx.so">
989 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
990 # Nickchange flood protection module: Allows up to X nick changes in Y seconds.
991 # Provides channel mode +F.
992 #<module name="m_nickflood.so">
994 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
995 # Nicklock module: Let opers change a user's nick and then stop that
996 # user from changing their nick again.
997 # This module is oper-only.
998 # To use, NICKLOCK and NICKUNLOCK must be in one of your oper class blocks.
999 #<module name="m_nicklock.so">
1001 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1002 # No ctcp module: Adds the channel mode +C to block CTCPs
1003 #<module name="m_noctcp.so">
1005 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1006 # No kicks module: Adds the +Q channel mode
1007 #<module name="m_nokicks.so">
1009 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1010 # No nicks module: Adds the +N channel mode, as well as the +b N:
1011 # extended bantype. +N stops all users from changing their nick,
1012 # the +b N: extban stops anyone from matching a +b N:nick!user@host
1013 # mask from changing their nick.
1014 #<module name="m_nonicks.so">
1016 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1017 # No part message module: adds extban 'p' to block part messages from #
1019 #<module name="m_nopartmsg.so">
1021 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1022 # No Notice module: adds the channel mode +T
1023 #<module name="m_nonotice.so">
1025 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1026 # Oper channels mode: Adds the +O channel mode
1027 # This module is oper-only.
1028 #<module name="m_operchans.so">
1030 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1031 # Oper invex/extban module: Adds +beI type O, to ban, exempt, and invex
1032 # given oper type masks.
1033 # e.g, /mode #channel +iI O:* is equivilant to chmode +O, but you
1034 # may also, e.g. /mode #channel +iI O:AdminTypeOnly to only allow admins.
1035 # +be work in a similar fashion.
1036 # This module is oper-only.
1038 #<module name="m_operinvex.so">
1040 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1041 # Oper Join module: Auto-joins opers to a channel upon oper-up
1042 # This module is oper-only. For the user equivalent, see m_conn_join.
1043 #<module name="m_operjoin.so">
1045 #-#-#-#-#-#-#-#-#-#-# OPERJOIN CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
1047 # If you are using the m_operjoin.so module, specify options here: #
1049 # channel - The channel name to join, can also be a comma #
1050 # seperated list eg. "#channel1,#channel2". #
1052 # override - Lets the oper join walking thru any modes that #
1053 # might be set, even bans. Use "yes" or "no". #
1055 #<operjoin channel="#channel" override="no">
1057 # Alternatively you can use the autojoin="channellist" in a <type> #
1058 # tag to set specific autojoins for a type of oper, for example: #
1060 #<type name="Helper" autojoin="#help" classes="...">
1062 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1063 # Oper log module: Logs all oper commands to the ircd log at default
1065 # This module is oper-only.
1066 #<module name="m_operlog.so">
1068 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1069 # Oper prefixing module: Gives IRC operators a prefix status character
1070 # on all channels they are in.
1072 #<module name="m_operprefix.so">
1074 # You may additionally customise the prefix character.
1075 #<operprefix prefix="!">
1077 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1078 # Oper MOTD module: Provides support for seperate message of the day
1080 # This module is oper-only.
1081 #<module name="m_opermotd.so">
1083 #-#-#-#-#-#-#-#-#-#-# OPERMOTD CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
1085 # If you are using the m_opermotd.so module, specify the motd here #
1087 #<opermotd file="oper.motd">
1089 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1090 # Override module: Adds support for oper override
1091 # This module is oper-only.
1092 #<module name="m_override.so">
1094 #-#-#-#-#-#-#-#-#-#-# OVERRIDE CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
1096 # m_override.so is too complex it describe here, see the wiki: #
1097 # http://www.inspircd.org/wiki/Oper_Override_Module #
1099 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1100 # Oper levels module: Gives each oper a level and prevents
1101 # actions being taken against higher level opers
1102 # Specify the level as the 'level' parameter of the <type> tag
1103 # # This module is oper-only.
1104 #<module name="m_operlevels.so">
1106 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1107 # Oper modes module: Allows you to specify modes to add/remove on oper
1108 # Specify the modes as the 'modes' parameter of the <type> tag
1109 # and/or as the 'modes' parameter of the <oper> tag.
1110 # This module is oper-only. For the user equivalent, see m_conn_umodes
1111 #<module name="m_opermodes.so">
1113 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1114 # Oper password hash module: Allows hashed oper passwords
1115 # Relies on the module m_md5.so and/or m_sha256.so being loaded before
1116 # m_password_hash.so in the configuration file.
1117 # This module is oper-only.
1118 #<module name="m_password_hash.so">
1120 #-#-#-#-#-#-#-#-#-#-# OPER HASH CONFIGURATION #-#-#-#-#-#-#-#-#-#-#-#-#
1122 # To use this module, you must define a hash type for each oper's
1123 # password you want to hash. For example:
1125 # <oper name="Brain"
1126 # host="ident@dialup15.isp.com"
1128 # password="a41d730937a53b79f788c0ab13e9e1d5"
1131 # The types of hashing available vary depending on which hashing modules
1132 # you load, but usually if you load m_sha256.so and m_md5.so, both md5
1133 # and sha256 type hashing will be available (the most secure of which
1136 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1137 # Permanent Channels module: Channels with the permanent channels mode
1138 # will remain open even after everyone else has left the channel, and
1139 # therefore keep things like modes, ban lists and topic. Permanent
1140 # channels -may- need support from your Services package to function
1141 # properly with them. This adds channel mode +P.
1142 # This module is oper-only.
1143 #<module name="m_permchannels.so">
1145 # You may also create channels on startup by using the <permchannels> block.
1146 #<permchannels channel="#opers" modes="is" topic="Opers only.">
1148 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1149 # PostgreSQL module: Allows other SQL modules to access PgSQL databases
1150 # through a unified API. You must copy the source for this module
1151 # from the directory src/modules/extra, plus the file m_sqlv2.h
1152 # This modules is in extras. Re-run configure with: ./configure --enable-extras=m_pgsql.cpp
1153 # and run make install, then uncomment this module to enable it.
1155 #<module name="m_pgsql.so">
1157 #-#-#-#-#-#-#-#-#-#-#-#- SQL CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#-#
1159 # m_pgsql.so is more complex than described here, see the wiki for #
1160 # more: http://www.inspircd.org/wiki/SQL_Service_Provider_Module #
1162 #<database name="mydb" username="myuser" password="mypass" hostname="localhost" id="my_database" ssl="no">
1164 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1165 # Muteban: Implements extended ban m:, which stops anyone matching
1166 # a mask like +b m:nick!user@host from speaking on channel.
1167 #<module name="m_muteban.so">
1170 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1171 # Random Quote module: provides a random quote on connect.
1172 # NOTE: Some of these may mimic fatal errors and confuse users and
1173 # opers alike! - BEWARE!
1174 #<module name="m_randquote.so">
1176 #-#-#-#-#-#-#-#-#-#- RANDOMQUOTES CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
1178 # Optional - If you specify to use the m_randquote.so module, then #
1179 # specify below the path to the randquotes.conf file. #
1181 #<randquote file="randquotes.conf">
1183 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1184 # Redirect module: Adds channel redirection (mode +L)
1185 #<module name="m_redirect.so">
1187 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1188 # Regular Expression Provider for Glob or wildcard (?/*) matching.
1189 # You must have at least 1 provider loaded to use m_filter or m_rline
1190 # modules. This module has no additional requirements, as it uses the
1191 # matching already present in InspIRCd core.
1192 #<module name="m_regex_glob.so">
1194 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1195 # Regular Expression Provider for PCRE (Perl-Compatible Regular
1196 # Expressions). You need libpcre installed to compile and load this
1197 # module. You must have at least 1 provider loaded to use m_filter or
1199 #<module name="m_regex_pcre.so">
1201 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1202 # Regular Expression Provider for POSIX Regular Expressions.
1203 # You shouldn't need any additional libraries on a POSIX-compatible
1204 # system (ie: any Linux, BSD, but not Windows). You must have at least
1205 # 1 provider loaded to use m_filter or m_rline.
1206 # On POSIX-compliant systems, regex syntax can be found by using the
1207 # command: 'man 7 regex'.
1208 #<module name="m_regex_posix.so">
1210 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1211 # Regular Expression Provider for TRE Regular Expressions.
1212 # This is the same regular expression engine used by UnrealIRCd, so
1213 # if you are most familiar with the syntax of /spamfilter from there,
1214 # this is the provider you want. You need libtre installed in order
1215 # to compile and load this module.
1216 #<module name="m_regex_tre.so">
1218 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1219 # Registered users only channel creation
1220 # Allows only registered users and opers to create new channels.
1221 #<module name="m_regonlycreate.so">
1223 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1224 # Remove module: Adds the /REMOVE command which is a peaceful
1225 # alternative to /KICK
1226 #<module name="m_remove.so">
1228 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1229 # Restricted channels module: Allows only opers to create channels
1230 #<module name="m_restrictchans.so">
1232 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1233 # Restrict message module: Allows users to only message opers
1234 #<module name="m_restrictmsg.so">
1236 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1237 # Ban users through regular expression patterns
1238 #<module name="m_rline.so">
1240 #-#-#-#-#-#-#-#-#-#-#-#- RLINE CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#-#
1242 # If you wish to re-check a user when they change nickname (can be
1243 # useful under some situations, but *can* also use CPU with more users
1244 # on a server) then set the following configuration value:
1245 # Also, this is where you set what Regular Expression engine is to be
1246 # used. If you ever change it while running, all of your R-Lines will be
1247 # wiped. This is the regex engine used by all R-Lines set, and
1248 # m_regex_<engine>.so must be loaded, or rline will be nonfunctional
1249 # until you load it or change the engine to one that is loaded.
1251 #<rline matchonnickchange="yes" engine="pcre">
1253 # Generally, you will NOT want to use 'glob' here, as this turns
1254 # rline into just another gline. The exceptions are that rline will
1255 # always use the full nick!user@host realname string, rather than only
1256 # user@host, but beware that only the ? and * wildcards are available,
1257 # and are the only way to specify where the space can occur if you do
1258 # use glob. For this reason, is recommended to use a real regex engine
1259 # so that at least \s or [[:space:]] is available.
1261 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1262 # JSON-RPC module: Encode and decode JSON-RPC requests for modules
1263 #<module name="m_rpc_json.so">
1265 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1266 # RPC test module: A test of the RPC API
1267 #<module name="m_rpctest.so">
1269 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1270 # Provide /LIST throttling (to prevent flooding) and /LIST safety to
1271 # prevent excess flood when the list is large.
1272 #<module name="m_safelist.so">
1274 #-#-#-#-#-#-#-#-#-#-# SAFELIST CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#-#
1276 # When using Safelist, you may set the following values;
1278 # The first value, 'throttle', sets the amount of time in seconds a user
1279 # must wait between LIST commands. For example, if this is set to 60
1280 # (the default) then the user may not /LIST more than once a minute.
1281 # If not defined, the default value is 60 seconds.
1283 # The second value, 'maxlisters', indicates the maximum number of users
1284 # which may be retrieving a LIST at once. It is not recommended you raise
1285 # this value, as increasing it too high can make your network vulnerable
1286 # to floodbots which waste your bandwidth and CPU time with LIST requests.
1288 #<safelist throttle="60" maxlisters="50">
1290 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1291 # SAJOIN module: Adds the /SAJOIN command
1292 # This module is oper-only.
1293 # To use, SAJOIN must be in one of your oper class blocks.
1294 #<module name="m_sajoin.so">
1296 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1297 # SAMODE module: Adds the oper /SAMODE command
1298 # This module is oper-only.
1299 # To use, SAMODE must be in one of your oper class blocks.
1300 #<module name="m_samode.so">
1302 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1303 # SANICK module: Allows opers to change user's nicks
1304 # This module is oper-only.
1305 # To use, SANICK must be in one of your oper class blocks.
1306 #<module name="m_sanick.so">
1308 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1309 # SAPART module: Adds the oper /SAPART command
1310 # This module is oper-only.
1311 # To use, SAPART must be in one of your oper class blocks.
1312 #<module name="m_sapart.so">
1314 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1315 # SAQUIT module: Adds the oper /SAQUIT command (abusable!!!)
1316 # This module is oper-only.
1317 # To use, SAQUIT must be in one of your oper class blocks.
1318 #<module name="m_saquit.so">
1320 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1321 # SATOPIC module: Adds the oper /SATOPIC command
1322 # This module is oper-only.
1323 # To use, SATOPIC must be in one of your oper class blocks.
1324 #<module name="m_satopic.so">
1326 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1327 # SASL authentication module: Provides support for IRC Authentication
1328 # Layer (aka: atheme SASL) via AUTHENTICATE.
1329 #<module name="m_sasl.so">
1331 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1332 # Secure list module: Prevent /LIST in the first minute of connection,
1333 # crippling most spambots and trojan spreader bots.
1334 #<module name="m_securelist.so">
1336 #-#-#-#-#-#-#-#-#-# SECURELIST CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#-#
1338 # Securelist can be harmful to some irc search engines such as #
1339 # netsplit.de and searchirc.com. To prevent securelist blocking these #
1340 # sites from listing, define exception tags as shown below: #
1341 <securehost exception="*@*.searchirc.org">
1342 <securehost exception="*@*.netsplit.de">
1343 <securehost exception="*@echo940.server4you.de">
1345 # Define the following variable to change how long a user must wait #
1346 # before issuing a LIST. If not defined, defaults to 60 seconds. #
1348 #<securelist waittime="60"> #
1350 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1351 # Servprotect module: Provides support for Austhex style +k /
1352 # UnrealIRCD +S services mode
1353 #<module name="m_servprotect.so">
1355 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1356 # See nicks module: Allow for SNOMASK +N which shows nick changes.
1357 # This module is oper-only.
1358 #<module name="m_seenicks.so">
1360 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1361 # Set Idle module: Adds a command for opers to change their
1362 # idle time (mainly a toy)
1363 # This module is oper-only.
1364 # To use, SETIDLE must be in one of your oper class blocks.
1365 #<module name="m_setidle.so">
1367 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1368 # Services support module: Adds several usermodes such as +R and +M
1369 # this module implements the 'identified' state via account names (AC)
1370 # and is similar in operation to the way asuka and ircu handle services.
1372 # At the same time, this offers +r for users and channels to mark them
1373 # as identified seperately from the idea of a master account, which
1374 # can be useful for services which are heavily nick-as-account centric.
1376 # This replaces m_services from 1.1 and earlier.
1378 # Also of note is that this module implements two extbans:
1379 # +b R: (stop matching account names from joining)
1380 # +b M: (stop matching account names from speaking)
1382 #<module name="m_services_account.so">
1384 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1385 # Sethost module: Adds the /SETHOST command
1386 # This module is oper-only.
1387 # To use, SETHOST must be in one of your oper class blocks.
1388 # See m_chghost for how to customise valid chars for hostnames
1389 #<module name="m_sethost.so">
1391 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1392 # Setident module: Adds the /SETIDENT command
1393 # This module is oper-only.
1394 # To use, SETIDENT must be in one of your oper class blocks.
1395 #<module name="m_setident.so">
1397 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1398 # SETNAME module: Adds the /SETNAME command
1399 # This module is oper-only.
1400 # To use, SETNAME must be in one of your oper class blocks.
1401 #<module name="m_setname.so">
1403 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1404 # Serverban: Implements extended ban s:, which stops anyone connected
1405 # to a server matching a mask like +b s:server.mask.here from joining.
1406 #<module name="m_serverban.so">
1408 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1409 # Show Whois module: Adds the +W usermode which allows opers
1410 # to see when they are whois'ed (can be annoying).
1411 # This module is oper-only.
1412 #<module name="m_showwhois.so">
1414 # If you wish, you may also let users set this mode. Only opers with the
1415 # users/auspex priv will see real hosts of people, though. This setting
1416 # is not reloadable via /rehash, and will require /reloadmodule, as
1417 # it directly affects the mode object itself.
1418 #<showwhois opersonly="yes"
1420 # You may also set whether or not users should recieve whois notices, should
1421 # they be /whois'd by an oper.
1422 # showfromopers="yes">
1424 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1425 # Shun module: Provides the /shun command, which stops a user executing
1427 # This module is oper-only.
1428 # To use, SHUN must be in one of your oper class blocks.
1429 #<module name="m_shun.so">
1431 # You may also configure which commands you wish a user to be able to
1432 # perform. It should be noted that if a shunned user issues QUIT or PART
1433 # then their message will be removed, as if they did not issue one.
1435 # You may also (optionally) let the user know that their command was blocked.
1436 #<shun enabledcommands="PING PONG QUIT PART JOIN" notifyuser="yes">
1438 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1439 # Spy module: Provides the ability to see the complete names list of
1440 # channels an oper is not a member of
1441 # This module is oper-only.
1442 #<module name="m_spy.so">
1444 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1445 # SSL channel mode module: Adds support for SSL-only channels (+z).
1446 # does not do anything useful without a working SSL module (see below)
1447 #<module name="m_sslmodes.so">
1449 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1450 # Dummy ssl module: If you have other servers on your network which
1451 # have SSL, but your server does not have ssl enabled, you should load
1452 # this module, which will handle SSL metadata (e.g. the "Is using ssl"
1453 # field in the WHOIS information).
1454 #<module name="m_ssl_dummy.so">
1456 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1457 # GnuTLS ssl module: Adds support for client-server SSL using GnuTLS,
1458 # if enabled. You must copy the source for this module from the directory
1459 # src/modules/extra, or answer 'yes' in ./configure when asked if you
1460 # want to enable this, or it will not load.
1461 #<module name="m_ssl_gnutls.so">
1463 #-#-#-#-#-#-#-#-#-#-#- GNUTLS CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#
1465 # m_ssl_gnutls.so is too complex it describe here, see the wiki: #
1466 # http://www.inspircd.org/wiki/GnuTLS_SSL_Module #
1468 # NOTE: If you want to use this module to encrypt and sign your #
1469 # server to server traffic, you MUST load it before m_spanningtree in #
1470 # your configuration file! #
1472 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1473 # SSL Info module: Allows users to retrieve information about other
1474 # user's peer SSL certificates and keys. This can be used by client
1475 # scripts to validate users. For this to work, one of m_ssl_gnutls.so
1476 # or m_ssl_openssl.so must be loaded. You must symlink the source for
1477 # this module from the directory src/modules/extra.
1478 # This modules is in extras. Re-run configure with: ./configure --enable-extras=m_sslinfo.cpp
1479 # and run make install, then uncomment this module to enable it.
1481 #<module name="m_sslinfo.so">
1483 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1484 # OpenSSL ssl module: Adds support for client-server SSL using OpenSSL,
1485 # if enabled. You must copy the source for this module from the directory
1486 # src/modules/extra, or answer 'yes' in ./configure when asked if you
1487 # want to enable this, or it will not load.
1488 #<module name="m_ssl_openssl.so">
1490 #-#-#-#-#-#-#-#-#-#-#- OPENSSL CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#
1492 # m_ssl_openssl.so is too complex it describe here, see the wiki: #
1493 # http://www.inspircd.org/wiki/OpenSSL_SSL_Module #
1495 # NOTE: If you want to use this module to encrypt and sign your #
1496 # server to server traffic, you MUST load it before m_spanningtree in #
1497 # your configuration file! #
1499 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1500 # SSL Cert Oper module: Allows opers to oper up using the key fingerprint
1501 # stored within their SSL certificate and key pair.
1502 # When using this module, one of m_ssl_gnutls.so or m_ssl_openssl.so must
1503 # be loaded. An extra value should be added to enabled opers, which
1504 # is in the following format: fingerprint="<hash>". For more information,
1505 # see the example in the oper blocks.
1506 # This module is oper-only.
1507 #<module name="m_ssl_oper_cert.so">
1509 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1510 # Strip colour module: Adds the channel mode +S
1511 #<module name="m_stripcolor.so">
1513 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1514 # SILENCE module: Adds support for /SILENCE
1515 #<module name="m_silence.so">
1517 # Configuration tags:
1519 #<silence maxentries="32">
1521 # Sets the maximum number of entries on a users silence list.
1523 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1524 # SQLite3 module: Allows other SQL modules to access SQLite3 #
1525 # databases through a unified API. You must link the source for this #
1526 # module from the directory src/modules/extra to src/modules, plus #
1527 # the file m_sqlv2.h #
1528 # This modules is in extras. Re-run configure with: ./configure --enable-extras=m_aqlite.cpp
1529 # and run make install, then uncomment this module to enable it. #
1531 #<module name="m_sqlite3.so">
1533 #-#-#-#-#-#-#-#-#-#-#-#- SQL CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#-#
1535 # m_sqlite.so is more complex than described here, see the wiki for #
1536 # more: http://www.inspircd.org/wiki/SQLite3_Service_Provider_Module #
1538 #<database hostname="/full/path/to/database.db" id="anytext">
1540 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1541 # SQLutils module: Provides some utilities to SQL client modules, such
1542 # as mapping queries to users and channels. You must copy the source
1543 # for this module from the directory src/modules/extra/m_sqlutils.cpp
1544 # and src/modules/extra/m_sqlutils.h into /src/modules
1545 # Needed for, and loaded before: SQLauth and SQLoper
1546 # This modules is in extras. Re-run configure with: ./configure --enable-extras=m_sqlutils.cpp
1547 # and run make install, then uncomment this module to enable it.
1549 #<module name="m_sqlutils.so">
1551 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1552 # SQL authentication module: Allows IRCd connections to be tied into
1553 # a database table (for example a forum). You must copy the source for
1554 # this module from the directory src/modules/extra
1555 # Depends on the SQLutils module being loaded first.
1556 # This modules is in extras. Re-run configure with: ./configure --enable-extras=m_sqlauth.cpp
1557 # and run make install, then uncomment this module to enable it.
1559 #<module name="m_sqlauth.so">
1561 #-#-#-#-#-#-#-#-#-#-#- SQLAUTH CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#
1563 # m_sqlauth.so is too complex it describe here, see the wiki: #
1564 # http://www.inspircd.org/wiki/SQL_Authentication_Module #
1566 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1567 # SQL logging module: Allows you to log network-wide data for your
1568 # network in a fully normalised set of SQL tables. You must copy the
1569 # source for this module from the directory src/modules/extra
1570 # This modules is in extras. Re-run configure with: ./configure --enable-extras=m_sqllog.cpp
1571 # and run make install, then uncomment this module to enable it.
1573 #<module name="m_sqllog.so">
1575 #-#-#-#-#-#-#-#-#-#-#- SQLLOG CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#
1577 # dbid - Database ID to use (see m_sql) #
1579 # See also: http://www.inspircd.org/wiki/SQL_Logging_Module #
1583 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1584 # SQL oper module: Allows you to store oper credentials in an SQL table
1585 # You must copy the source for this module from the directory src/modules/extra
1586 # Depends on the SQLutils module being loaded first.
1587 # This modules is in extras. Re-run configure with: ./configure --enable-extras=m_sqloper.cpp
1588 # and run make install, then uncomment this module to enable it.
1590 #<module name="m_sqloper.so">
1592 #-#-#-#-#-#-#-#-#-#-#- SQLOPER CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#
1594 # dbid - Database ID to use (see m_sql) #
1595 # hash - Hashing provider to use for password hashing #
1597 # See also: http://www.inspircd.org/wiki/SQL_Oper_Storage_Module #
1599 #<sqloper dbid="1" hash="md5">
1601 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1602 # SVSHold module: Implements SVSHOLD. Like Q:Lines, but can only be #
1603 # added/removed by Services. #
1604 #<module name="m_svshold.so">
1606 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1607 # SWHOIS module: Allows you to add arbitary lines to user WHOIS.
1608 # This module is oper-only.
1609 # To use, SWHOIS must be in one of your oper class blocks.
1610 #<module name="m_swhois.so">
1612 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1613 # Taxonomy module: Adds the /TAXONOMY command, used to view all
1614 # metadata attached to a user.
1615 # This module is oper-only.
1616 # To use, TAXONOMY must be in one of your oper class blocks.
1617 #<module name="m_taxonomy.so">
1619 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1620 # Test command module: Does nothing significant. Read: pointless.
1621 #<module name="m_testcommand.so">
1623 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1624 # Timed bans module: Adds timed bans and the /TBAN command
1625 # This module is oper-only.
1626 # To use, TBAN must be in one of your oper class blocks.
1627 #<module name="m_timedbans.so">
1629 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1630 # Test line module: Adds the /TLINE command, used to test how many
1631 # users a /GLINE or /ZLINE etc would match.
1632 # This module is oper-only.
1633 # To use, TLINE must be in one of your oper class blocks.
1634 #<module name="m_tline.so">
1636 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1637 # UHNAMES support module: Adds support for the IRCX style UHNAMES
1638 # extension, which displays ident and hostname in the names list for
1639 # each user, saving clients from doing a WHO on the channel. Note that
1640 # this module is not widely supported yet. If a client does not support
1641 # UHNAMES it will not enable it, this will not break incompatible
1643 #<module name="m_uhnames.so">
1645 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1646 # Uninvite module: Adds the /UNINVITE command which lets users remove
1647 # pending invites from channels without waiting for the user to join.
1648 #<module name="m_uninvite.so">
1650 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1651 # Userip module: Adds the /USERIP command
1652 # This module is oper-only.
1653 # To use, USERIP must be in one of your oper class blocks.
1654 #<module name="m_userip.so">
1656 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1657 # Vhost module: Adds the VHOST command which allows for adding virtual
1658 # hosts which are accessible using a username and password in the config.
1659 #<module name="m_vhost.so">
1661 #-#-#-#-#-#-#-#-#-#-#- VHOST CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#-#
1663 # user - Username for the vhost. #
1665 # pass - Password for the vhost. #
1667 # host - Vhost to set. #
1669 #<vhost user="some_username" pass="some_password" host="some.host">
1671 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1672 # Watch module: Adds the WATCH command, which is used by clients to
1673 # maintain notify lists.
1674 #<module name="m_watch.so">
1676 # Configuration tags:
1678 #<watch maxentries="32">
1680 # Sets the maximum number of entries on a user's watch list.
1682 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1683 # XLine database: Stores all *Lines (G/Z/K/R/any added by other modules)
1684 # in a file "xline.db" which can be re-loaded on restart. This is useful
1685 # for two reasons: it keeps bans so users may not evade them, and on
1686 # bigger networks, server connections will take less time as there will
1687 # be a lot less bans to apply - as most of them will already be there.
1688 #<module name="m_xline_db.so">
1690 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1691 # ZipLinks module: Adds support for zlib deflate on server to server
1692 # connections. Both ends of the connection must load this module.
1693 # This modules is in extras. Re-run configure with: ./configure --enable-extras=m_ziplink.cpp
1694 # and run make install, then uncomment this module to enable it.
1696 #<module name="m_ziplink.so">
1698 # To use this module, you must enable it as a transport type in your
1699 # <link> tags or <bind> tags using the transport name 'zip'.
1700 # See the documentation of <link> and <bind>, respectively.
1704 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1705 # ____ _ _____ _ _ ____ _ _ _ #
1706 # | _ \ ___ __ _ __| | |_ _| |__ (_)___ | __ )(_) |_| | #
1707 # | |_) / _ \/ _` |/ _` | | | | '_ \| / __| | _ \| | __| | #
1708 # | _ < __/ (_| | (_| | | | | | | | \__ \ | |_) | | |_|_| #
1709 # |_| \_\___|\__,_|\__,_| |_| |_| |_|_|___/ |____/|_|\__(_) #
1711 # To link servers to InspIRCd, you MUST load the m_spanningtree #
1712 # module. Since several features (like SSL server links) rely on #
1713 # other modules being loaded before m_spanningtree, the module itself #
1714 # is at the bottom of this file. DO NOT forget to load it. If you DO #
1715 # NOT do this, server links will NOT work at all. ie. The ports will #
1716 # NOT bind, and /connect will not work properly. This is by design, #
1717 # to allow for the implementation of other linking protocols in #
1718 # modules in the future. #
1721 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1722 # Spanning Tree module - allows linking of servers using the spanning
1723 # tree protocol (see the READ THIS BIT section above).
1724 # You will almost always want to load this.
1726 #<module name="m_spanningtree.so">