1 #-#-#-#-#-#-#-#-#-#-#-#-#- MODULE OPTIONS -#-#-#-#-#-#-#-#-#-#-#-#-#
3 # These tags define which modules will be loaded on startup by your #
4 # server. Add modules without any paths. When you make your ircd #
5 # using the 'make' command, all compiled modules will be moved into #
6 # the folder you specified when you ran ./configure. The module tag #
7 # automatically looks for modules in this location. #
8 # If you attempt to load a module outside of this location, either #
9 # in the config, or via /LOADMODULE, you will receive an error. #
11 # By default, ALL modules are commented out. You must uncomment them #
12 # or add lines to your config to load modules. Please refer to #
13 # http://www.inspircd.org/wiki/Modules_List for a list of modules and#
14 # each modules link for any additional conf tags they require. #
16 # You may use wildcards in a <module> tag to load all modules which #
17 # match a glob pattern (e.g. m_sa????.so would load m_sajoin, #
18 # m_sapart, m_saquit and m_sanick) #
20 # ____ _ _____ _ _ ____ _ _ _ #
21 # | _ \ ___ __ _ __| | |_ _| |__ (_)___ | __ )(_) |_| | #
22 # | |_) / _ \/ _` |/ _` | | | | '_ \| / __| | _ \| | __| | #
23 # | _ < __/ (_| | (_| | | | | | | | \__ \ | |_) | | |_|_| #
24 # |_| \_\___|\__,_|\__,_| |_| |_| |_|_|___/ |____/|_|\__(_) #
26 # To link servers to InspIRCd, you MUST load the m_spanningtree #
27 # module, as shown below. If you DO NOT do this, server links will #
28 # NOT work at all. ie. The ports will NOT bind, and /connect will not #
29 # work properly. This is by design, to allow for the implementation #
30 # of other linking protocols in modules in the future. #
32 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
33 # Spanning Tree module - allows linking of servers using the spanning
34 # tree protocol (see the READ THIS BIT section above).
35 # You will almost always want to load this.
37 #<module name="m_spanningtree.so">
40 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
41 # MD5 Module - Allows other modules to generate MD5 hashes, usually for
42 # cryptographic uses and security.
45 # Other modules such as m_cloaking.so and m_password_hash.so may rely on
46 # this module being loaded to function.
48 #<module name="m_md5.so">
50 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
51 # SHA256 Module - Allows other modules to generate SHA256 hashes,
52 # usually for cryptographic uses and security.
55 # Other modules such as m_password_hash.so may rely on this module being
56 # loaded to function. Certain modules such as m_spanningtree.so will
57 # function without this module but when it is loaded their features will
58 # be enhanced (for example the addition of HMAC authentication).
60 #<module name="m_sha256.so">
61 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
62 # RIPEMD160 Module - Allows other modules to generate RIPEMD160 hashes,
63 # usually for cryptographic uses and security.
66 # Other modules may rely on this module being loaded to function.
67 #<module name="m_ripemd160.so">
69 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
70 # Abbreviation module: Provides the ability to abbreviate commands a-la
72 #<module name="m_abbreviation.so">
74 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
75 # Alias module: Allows you to define server-side command aliases
76 #<module name="m_alias.so">
78 #-#-#-#-#-#-#-#-#-#-#- ALIAS DEFINITIONS -#-#-#-#-#-#-#-#-#-#-#-#-#-#
80 # If you have the m_alias.so module loaded, you may also define #
81 # aliases as shown below. They are commonly used to provide shortcut #
82 # commands to services, however they are not limited to just this use.#
83 # An alias tag requires the following values to be defined in it: #
85 # text - The text to detect as the actual command line, #
86 # Cant contain spaces, but case insensitive. #
87 # You may have multiple aliases with the same #
88 # command name (text="" value), however the first #
89 # found will be executed if its format value is #
90 # matched, or it has no format value. Aliases are #
91 # read from the top of the file to the bottom. #
93 # format - If this is defined, the parameters of the alias #
94 # must match this glob pattern. For example if you #
95 # want the first parameter to start with a # for #
96 # the alias to be executed, set format="#*" in the #
97 # alias definition. Note that the :'s which are #
98 # part of IRC formatted lines will be preserved #
99 # for matching of this text. This value is #
102 # replace - The text to replace 'text' with. Usually this #
103 # will be "PRIVMSG ServiceName :$2-" or similar. #
104 # You may use the variables $1 through $9 in the #
105 # replace string, which refer to the first through #
106 # ninth word in the original string typed by the #
107 # user. You may also use $1- through $9- which #
108 # refer to the first word onwards, through to the #
109 # ninth word onwards, e.g. if the user types the #
110 # command "foo bar baz qux quz" then $3- will hold #
111 # "baz qux quz" and $2 will contain "bar". You may #
112 # also use the special variables: $nick, $ident, #
113 # $host and $vhost, and you may separate multiple #
114 # commands with \n. If you wish to use the ACTUAL #
115 # characters \ and n together in a line, you must #
116 # use the sequence "\\n". #
118 # requires - If you provide a value for 'requires' this means #
119 # the given nickname MUST be online for the alias #
120 # to successfully trigger. If they are not, then #
121 # the user receives a 'no such nick' 401 numeric. #
123 # uline - Defining this value with 'yes', 'true' or '1' #
124 # will ensure that the user given in 'requires' #
125 # must also be on a u-lined server, as well as #
126 # actually being on the network. If the user is #
127 # online, but not on a u-lined server, then an #
128 # oper-alert is sent out as this is possibly signs #
129 # of a user trying to impersonate a service. #
131 # operonly - Defining this value, with a value of 'yes', '1' #
132 # or true will make the alias oper only. If a non- #
133 # oper attempts to use the alias, it will appear #
136 #<alias text="NICKSERV" replace="PRIVMSG NickServ :$2-" requires="NickServ" uline="yes">
137 #<alias text="CHANSERV" replace="PRIVMSG ChanServ :$2-" requires="ChanServ" uline="yes">
138 #<alias text="OPERSERV" replace="PRIVMSG OperServ :$2-" requires="OperServ" uline="yes" operonly="yes">
139 #<alias text="NS" replace="PRIVMSG NickServ :$2-" requires="NickServ" uline="yes">
140 #<alias text="CS" replace="PRIVMSG ChanServ :$2-" requires="ChanServ" uline="yes">
141 #<alias text="OS" replace="PRIVMSG OperServ :$2-" requires="OperServ" uline="yes" operonly="yes">
143 # An example of using the format value to create an alias with two
144 # different behaviours depending on the format of the parameters.
146 #<alias text="ID" format="#*" replace="PRIVMSG ChanServ :IDENTIFY $2 $3"
147 # requires="ChanServ" uline="yes">
149 #<alias text="ID" replace="PRIVMSG NickServ :IDENTIFY $2"
150 # requires="NickServ" uline="yes">
152 # This alias fixes a glitch in xchat 2.6.x and above and the way it
153 # assumes IDENTIFY must be prefixed by a colon (:) character. It should
154 # be placed ABOVE the default NICKSERV alias (the first example) listed
157 #<alias text="NICKSERV" format=":IDENTIFY *" replace="PRIVMSG NickServ :IDENTIFY $3-"
158 # requires="NickServ" uline="yes">
160 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
161 # Allowinvite module: Gives channel mode +A to allow all users to use
162 # /invite, and extban A to deny invite from specific masks
163 #<module name="m_allowinvite.so">
165 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
166 # Alltime module: Shows time on all connected servers at once.
167 # This module is oper-only and provides /alltime.
168 # To use, ALLTIME must be in one of your oper class blocks.
169 #<module name="m_alltime.so">
171 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
172 # Antibear security module: Prevents 'bear.txt' based trojans from
173 # connecting to your network by sending them a numeric they can't handle.
174 #<module name="m_antibear.so">
176 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
177 # Antibottler module: Labels bottler leech bots
178 #<module name="m_antibottler.so">
180 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
181 # Auditorium module: Adds channel mode +u which makes everyone else
182 # except you in the channel invisible, used for large meetings etc.
183 #<module name="m_auditorium.so">
185 # Auditorium settings:
187 #<auditorium showops="no" operoverride="no">
190 # Setting this value to yes makes m_auditorium behave like unrealircd
191 # +u channel mode, e.g. ops see users joining, parting, etc, and users
192 # joining the channel see the ops. Without this flag, the mode acts
193 # like ircnet's +a (anonymous channels), showing only the user in the
194 # names list, and not even showing the ops in the list, or showing the
195 # ops that the user has joined.
197 # Setting this value to yes makes m_auditorium affect the userlist for
198 # regular users only. Opers will view all users in the channel normally.
200 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
201 # Ban except module: Adds support for channel ban exceptions (+e)
202 #<module name="m_banexception.so">
204 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
205 # Ban redirection module: Allows bans which redirect to a specified
206 # channel. e.g. +b nick!ident@host#channelbanneduserissentto
207 #<module name="m_banredirect.so">
209 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
210 # Block amsg module: Attempt to block all usage of /amsg and /ame
211 #<module name="m_blockamsg.so">
213 #-#-#-#-#-#-#-#-#-#-#- BLOCKAMSG CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
215 # If you have the m_blockamsg.so module loaded, you can configure it #
216 # with the <blockamsg> tag: #
218 # delay - How many seconds between two messages to force #
219 # them to be recognised as unrelated. #
220 # action - Any of 'notice', 'noticeopers', 'silent', 'kill' #
221 # or 'killopers'. Define how to take action when #
222 # a user uses /amsg or /ame. #
224 #<blockamsg delay="3" action="killopers">
226 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
227 # Block CAPS module: Blocking all-CAPS messages with cmode +B
228 #<module name="m_blockcaps.so">
230 #-#-#-#-#-#-#-#-#-#-#- BLOCKCAPS CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
232 # percent - How many percent of text must be caps before text #
235 # minlen - The minimum length a line must be for the block #
236 # percent to have any effect. #
238 # capsmap - A list of chars to be considered CAPS, this was #
239 # you can add CAPS for your language. Also you can #
240 # add things like ! and space to further lock down #
242 #<blockcaps percent="50"
244 # capsmap="ABCDEFGHIJKLMNOPQRSTUVWXYZ! ">
246 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
247 # Block colour module: Blocking colour-coded messages with cmode +c
248 #<module name="m_blockcolor.so">
250 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
251 # Botmode module: Adds the user mode +B
252 #<module name="m_botmode.so">
254 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
255 # CallerID module: Adds usermode +g which activates hybrid-style
256 # callerid (== block all private messages unless you /accept first)
257 #<module name="m_callerid.so">
259 #-#-#-#-#-#-#-#-#-#-#- CALLERID CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#
260 # maxaccepts - Maximum number of entires a user can add to his #
261 # /accept list. Default is 16 entries. #
262 # operoverride - Can opers (note: ALL opers) ignore callerid mode? #
264 # tracknick - Preserve /accept entries when a user changes nick? #
265 # If no (the default), the user is removed from #
266 # everyone's accept list if he changes nickname. #
267 # cooldown - Amount of time (in seconds) that must pass since #
268 # the last notification sent to a user before he can #
269 # be sent another. Default is 60 (1 minute). #
270 #<callerid maxaccepts="16"
275 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
276 # CAP module: Provides the CAP negotiation mechanism seen in
277 # ratbox-derived ircds
278 #<module name="m_cap.so">
280 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
281 # CBAN module: Lets you disallow channels from being used at runtime.
282 # This module is oper-only and provides /cban.
283 # To use, CBAN must be in one of your oper class blocks.
284 #<module name="m_cban.so">
286 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
287 # Censor module: Adds the channel mode +G
288 #<module name="m_censor.so">
290 #-#-#-#-#-#-#-#-#-#-#- CENSOR CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#
292 # Optional - If you specify to use the m_censor module, then you must #
293 # specify some censor tags. See also: #
294 # http://www.inspircd.org/wiki/Censor_Module #
296 #<include file="censor.conf">
298 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
299 # CGI:IRC module: Adds support for automatic host changing in CGI:IRC
300 # (http://cgiirc.sourceforge.net).
301 #<module name="m_cgiirc.so">
303 #-#-#-#-#-#-#-#-#-#-#-# CGIIRC CONFIGURATION #-#-#-#-#-#-#-#-#-#-#-#-#
305 # Optional - If you specify to use m_cgiirc, then you must specify one
306 # or more cgihost tags which indicate authorised CGI:IRC servers which
307 # will be connecting to your network, and an optional cgiirc tag.
308 # For more information see: http://www.inspircd.org/wiki/CGI-IRC_Module
310 # Set to yes if you want to notice opers when CGI clients connect
311 # <cgiirc opernotice="no">
313 # The type field indicates where the module should get the real
314 # client's IP address from, for further information, please see the
315 # CGI:IRC documentation.
318 # <cgihost type="pass" mask="www.mysite.com"> # Get IP from PASS
319 # <cgihost type="ident" mask="otherbox.mysite.com"> # Get IP from ident
320 # <cgihost type="passfirst" mask="www.mysite.com"> # See the docs
322 # <cgihost type="webirc" pass="foobar"
323 # mask="somebox.mysite.com"> # Get IP from WEBIRC
328 # When you connect CGI:IRC clients, there are two connect classes which
329 # apply to these clients. When the client initially connects, the connect
330 # class which matches the cgi:irc site's host is checked. Therefore you
331 # must raise the maximum local/global clients for this ip as high as you
332 # want to allow cgi clients. After the client has connected and is
333 # determined to be a cgi:irc client, the class which matches the client's
334 # real IP is then checked. You may set this class to a lower value, so that
335 # the real IP of the client can still be restricted to, for example, 3
340 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
341 # Channel create module: Adds snomask +j, which will notify opers of
342 # any new channels that are created.
343 # This module is oper-only.
344 #<module name="m_chancreate.so">
346 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
347 # Channel filter module: Allows channel-op defined message
348 # filtering using simple string matches (channel mode +g)
349 #<module name="m_chanfilter.so">
351 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
352 # Channel logging module: used to send snotice output to channels, to
353 # allow staff to centrally monitor and discuss network activity.
355 # The "channel" field is where you want the messages to go, "snomasks"
356 # is what snomasks you want to be sent to that channel. Multiple tags
358 #<module name="m_chanlog.so">
359 #<chanlog snomasks="AOcC" channel="#opers">
361 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
362 # Channelban: Implements extended ban j:, which stops anyone in already
363 # in a channel matching a mask like +b j:#channel*mask from joining.
364 #<module name="m_channelban.so">
366 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
367 # Chanprotect module: gives +q and +a channel modes
368 #<module name="m_chanprotect.so">
370 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
371 # Check module: gives /check
372 # Check is useful for looking up information on channels,
373 # users, IP addresses and hosts.
374 # This module is oper-only.
375 # To use, CHECK must be in one of your oper class blocks.
376 #<module name="m_check.so">
378 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
379 # CHGHOST module: Adds the /CHGHOST command
380 # This module is oper-only.
381 # To use, CHGHOST must be in one of your oper class blocks.
382 #<module name="m_chghost.so">
384 #-#-#-#-#-#-#-#-# /CHGHOST - /SETHOST CONFIGURATION #-#-#-#-#-#-#-#-#
385 # Optional - If you want to use special chars for hostnames you can #
386 # specify your own custom list of chars with the <hostname> tag: #
388 # charmap - A list of chars accepted as valid by the /CHGHOST #
389 # and /SETHOST commands. Also note that the list is #
391 #<hostname charmap="abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ.-_/0123456789">
393 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
394 # CHGIDENT module: Adds the /CHGIDENT command
395 # This module is oper-only.
396 # To use, CHGIDENT must be in one of your oper class blocks.
397 #<module name="m_chgident.so">
399 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
400 # CHGNAME module: Adds the /CHGNAME command
401 # This module is oper-only.
402 # To use, CHGNAME must be in one of your oper class blocks.
403 #<module name="m_chgname.so">
405 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
406 # Cloaking module: Adds usermode +x and cloaking support.
407 # Relies on the module m_md5.so being loaded before m_cloaking.so in
408 # the configuration file.
409 # To use, you should enable m_conn_umodes and add +x as
410 # an enabled mode. See the m_conn_umodes module for more information.
411 #<module name="m_cloaking.so">
413 #-#-#-#-#-#-#-#-#-#-#- CLOAKING CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#
415 # Optional - If you specify the m_cloaking.so module as above, you #
416 # must define cloak keys, and optionally a cloak prefix as shown #
417 # below. When using cloaking, the cloak keys are MANDITORY and must #
418 # be included. However, if prefix is not included, it will default #
419 # to your networks name from the <server> tag. You can also include #
420 # the following optional values: #
422 # ipalways - Always cloak the IP address, not the hostname, #
423 # which doesn't reveal the user's ISP, but #
424 # results in hosts that are harder to read and #
427 # lowercase - Display the cloaked hostnames in lowercase #
428 # characters instead of uppercase #
430 # <cloak key1="0x2AF39F40" #
431 # key2="0x78E10B32" #
432 # key3="0x4F2D2E82" #
433 # key4="0x043A4C81" #
436 # lowercase="false"> #
438 # Please note that the key values will accept any number, and should #
439 # be large numbers. Using small numbers such as "7" or "1924" will #
440 # seriously weaken the security of your cloak. It is recommended you #
441 # use hexdecimal numbers prefixed by "0x", as shown in this example, #
442 # with each key eight hex digits long. #
444 #-#-#-#-#-#-#-#-#-#-#-#- CLOSE MODULE #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
445 # Close module: Allows an oper to close all unregistered connections.
446 # This module is oper-only and provides /close.
447 # To use, CLOSE must be in one of your oper class blocks.
448 #<module name="m_close.so">
450 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
451 # Clones module: Adds an oper command /CLONES for detecting cloned
452 # users. Warning: This module may be resource intensive when its
453 # command is issued, use with care.
454 # This module is oper-only.
455 # To use, CLONES must be in one of your oper class blocks.
456 #<module name="m_clones.so">
458 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
459 # Common channels module: Adds user mode +c, which, when set, requires
460 # that users must share a common channel with you to PRIVMSG or NOTICE
462 #<module name="m_commonchans.so">
464 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
465 # Conn-Join: Allows you to force users to join one or more channels
466 # automatically upon connecting to the server.
467 #<module name="m_conn_join.so">
469 #-#-#-#-#-#-#-#-#-#-#-#- CONNJOIN CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
471 # If you have m_conn_join.so loaded, you can configure it using the
474 #<autojoin channel="#one,#two,#three">
476 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
477 # Conn-Usermodes: Set modes on users when they connect
478 # When this module is loaded <connect:allow> tags may have an optional
479 # modes="" value, which contains modes to add or remove from users
480 # when they connect to the server.
481 #<module name="m_conn_umodes.so">
483 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
484 # Conn-Wait-for-Pong: Don't let a user connect until they PONG
485 #<module name="m_conn_waitpong.so">
487 #-#-#-#-#-#-#-#-#-#-#- WAITPONG CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
489 # If you have the m_conn_waitpong.so module loaded, configure it with #
490 # the <waitpong> tag: #
492 # sendsnotice - Whether to send a snotice on connect, like other #
495 # killonbadreply - Whether to kill the user if they send the wrong #
498 #<waitpong sendsnotice="yes" killonbadreply="yes">
501 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
502 # Channel cycle module. Server side /hop, with +ilk etc bypass.
503 #<module name="m_cycle.so">
505 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
506 # Connectban: Provides IP connection throttling. Any IP range that connects
507 # too many times (configurable) in an hour is zlined for a (configurable)
508 # duration, and their count resets to 0.
510 # ipv4cidr and ipv6cidr allow you to turn the comparison from individual
511 # IP addresses (32 and 128 bits) into CIDR masks, to allow for throttling
512 # over whole ISPs/blocks of IPs, which may be needed to prevent attacks.
514 #<connectban threshold="10" duration="10m" ipv4cidr="32" ipv6cidr="128">
515 # This allows for 10 quits in an hour with a 10 minute ban if that is exceeded.
517 #<module name="m_connectban.so">
519 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
520 # Connection throttle module. Configuration:
521 #<module name="m_connflood.so">
523 #-#-#-#-#-#-#-#-#-#-#- CONTHROTTLE CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
524 # seconds, maxconns - Amount of connections per <seconds>.
526 # timeout - Time to wait after the throttle was activated
527 # before deactivating it. Be aware that the time
528 # is seconds + timeout.
530 # quitmsg - The message that users get if they attempt to
531 # connect while the throttle is active.
533 # bootwait - Amount of time to wait before enforcing the
534 # throttling when the server just booted.
536 #<connflood seconds="30" maxconns="3" timeout="30"
537 # quitmsg="Throttled" bootwait="10">
539 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
540 # Custom title module: Adds the /TITLE command which allows for trusted
541 # users to gain a custom whois line and a optional
542 # vhost can be specified.
543 #<module name="m_customtitle.so">
545 #-#-#-#-#-#-#-#-#-#- CUSTOM TITLE CONFIGURATION -#-#-#-#-#-#-#-#-#-#
546 # name - The username used to identify
547 # password - The password used to identify
548 # host - Allowed hostmask [optional]
549 # title - Title shown in whois
550 # vhost - Displayed host [optional]
552 #<title name="foo" password="bar" title="Official Chat Helper">
553 #<title name="bar" password="foo" host="ident@host.name" title="Official Chat Helper" vhost="helper.network.chat">
555 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
556 # DCCALLOW module: Adds the /DCCALLOW command
557 #<module name="m_dccallow.so">
559 #-#-#-#-#-#-#-#-#-#-#- DCCALLOW CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
560 # blockchat - Whether to block DCC CHAT as well as DCC SEND
561 # length - Default duration of entries in DCCALLOW list
562 # action - Default action to take if no action is specified
563 # can be 'block' or 'allow'
565 # File configuration:
566 # pattern - The glob pattern to match against
567 # action - Action to take if a user attempts to send a file
568 # that matches this pattern, can be 'block' or 'allow'
570 #<dccallow blockchat="yes" length="5m" action="block">
571 #<banfile pattern="*.exe" action="block">
572 #<banfile pattern="*.txt" action="allow">
574 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
576 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
577 # Deaf module: adds support for ircu style usermode +d - deaf to
578 # channel messages and channel notices.
579 #<module name="m_deaf.so">
581 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
582 # Delay join module: Adds the channel mode +D which delays all JOIN
583 # messages from users until they speak. If they quit or part before
584 # speaking, their quit or part message will not be shown to the channel
585 # which helps cut down noise on large channels in a more friendly way
586 # than the auditorium mode. Only channel ops may set the +D mode.
587 #<module name="m_delayjoin.so">
589 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
590 # Deny Channels: Deny Channels from being used by users
591 #<module name="m_denychans.so">
593 #-#-#-#-#-#-#-#-#-#-#- DENYCHAN DEFINITIONS -#-#-#-#-#-#-#-#-#-#-#-#
595 # If you have the m_denychans.so module loaded, you need to specify #
596 # the channels to deny: #
598 # name - The channel name to deny. (glob masks are ok) #
600 # allowopers - If operators are allowed to override the deny. #
602 # reason - Reason given for the deny. #
604 # redirect - Redirect the user to a different channel #
606 #<badchan name="#gods*" allowopers="yes" reason="Tortoises!"> #
607 #<badchan name="#heaven" redirect="#hell" reason="Nice try!"> #
609 # Redirects will not work if the target channel is set +L. #
611 # Additionally, you may specify channels which are allowed, even if #
612 # a badchan tag specifies it would be denied: #
613 #<goodchan name="#godsleeps"> #
614 # Glob masks are accepted here also.
616 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
617 # Devoice Module: Let users devoice themselves.
618 #<module name="m_devoice.so">
620 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
621 # DNS Blacklist Module: Provides support for looking up IPs on one or #
623 #<module name="m_dnsbl.so"> #
625 # For configuration options please see the wiki page for m_dnsbl at #
626 # http://inspircd.org/wiki/DNS_Blacklist_Module #
628 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
629 # Filter module: Provides message filtering, similar to SPAMFILTER.
630 #<module name="m_filter.so">
632 # This module depends upon a regex provider such as m_regex_pcre or #
633 # m_regex_glob to function. You must specify which of these you want #
634 # m_filter to use via the tag below. #
636 # Valid engines are: #
638 # glob - Glob patterns, provided via m_regex_glob.so #
639 # pcre - PCRE regexps, provided via m_regex_pcre.so, needs libpcre #
640 # tre - TRE regexps, provided via m_regex_tre.so, requires libtre #
641 # posix - POSIX regexps, provided via m_regex_posix.so, not availale #
642 # on windows, no dependencies on other operating systems. #
644 #<filteropts engine="glob"> #
646 # Your choice of regex engine must match on all servers network-wide.
648 #-#-#-#-#-#-#-#-#-#-#- FILTER CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#
650 # Optional - If you specify to use the m_filter module, then #
651 # specfiy below the path to the filter.conf file, or define some #
654 #<include file="filter.conf">
656 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
657 # Foobar module: does nothing - historical relic
658 #<module name="m_foobar.so">
660 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
661 # Gecosban: Implements extended ban r:, which stops anyone matching
662 # a mask like +b r:*realname?here* from joining a channel.
663 #<module name="m_gecosban.so">
665 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
666 # GeoIP module: Allows the server admin to ban users by country code.
667 #<module name="m_geoip.so">
669 #-#-#-#-#-#-#-#-#-#-#-# GEOIP CONFIGURATION #-#-#-#-#-#-#-#-#-#-#-#-#
671 # <geoip banunknown="false"> #
673 # Set this value to true or yes to block unknown IP ranges which are #
674 # not in the database (usually LAN addresses, localhost, etc) #
676 # <geoban country="TR" reason="This country not permitted"> #
678 # Use one or more of these tags to ban countries by country code. #
679 # The country code must be in capitals and should be an ISO country #
680 # code such as TR, GB, or US. #
682 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
683 # Globops module: gives /GLOBOPS and SNOMASK +g
684 # This module is oper-only.
685 # To use, GLOBOPS must be in one of your oper class blocks.
686 #<module name="m_globops.so">
688 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
689 # Global load module: Allows loading and unloading of modules network-
690 # wide (USE WITH EXTREME CAUTION!)
691 # This module is oper-only and provides /gloadmodule, /gunloadmodule
692 # and /greloadmodule.
693 # To use, GLOADMODULE, GUNLOADMODULE and GRELOADMODULE
694 # must be in one of your oper class blocks.
695 #<module name="m_globalload.so">
697 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
698 # HELPOP module: Provides the /HELPOP command
699 #<module name="m_helpop.so">
701 #-#-#-#-#-#-#-#-#-#-#-#- HELPOP CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
703 # Optional - If you specify to use the m_helpop.so module, then #
704 # specify below the path to the helpop.conf file, or if you like to #
705 # make a mess, define your helpop tags in this conf. #
707 #<include file="helpop.conf">
709 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
710 # HIDECHANS module: Allows opers to hide their channels list from non-
711 # opers by setting user mode +I on themselves.
712 # <module name="m_hidechans.so">
714 # HIDECHANS can optionally prevent opers from seeing channels on a +I
715 # user, for more privacy if set to true.
716 # This setting is not recommended for most mainstream networks.
717 #<hidechans affectsopers="false">
719 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
720 # HIDEOPER module: Allows opers to hide their oper status from non-
721 # opers by setting user mode +H on themselves.
722 # This module is oper-only.
723 # <module name="m_hideoper.so">
725 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
726 # Hostchange module: Allows a different style of cloaking
727 #<module name="m_hostchange.so">
729 #-#-#-#-#-#-#-#-#-#-#- HOSTCHANGE CONFIGURATION -#-#-#-#-#-#-#-#-#-#
731 # Optional - If you choose to use the m_hostchange.so module. #
732 # Config Help - See http://www.inspircd.org/wiki/Host_Changer_Module #
734 #<host suffix="polarbears.org" separator="." prefix="">
735 #<hostchange mask="*@fbi.gov" action="addnick">
736 #<hostchange mask="*r00t@*" action="suffix">
737 #<hostchange mask="a@b.com" action="set" value="blah.blah.blah">
738 #<hostchange mask="localhost" ports="7000,7001,7005-7007" action="set" value="blahblah.foo">
740 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
741 # httpd module: Provides http server support for InspIRCd
742 #<module name="m_httpd.so">
744 #-#-#-#-#-#-#-#-#-#-#-#- HTTPD CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
746 # Optional - If you choose to use the m_httpd.so module, then you must
747 # specify the port number and other details of your http server:
749 #<http ip="192.168.1.10" host="brainwave" port="32006"
750 # index="/home/brain/inspircd/http/index.html">
752 # You may have as many of these tags as you wish, each with a different
753 # IP, port, host or index file. Each one will act as an independent
757 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
758 # http ACL module: Provides access control lists for m_httpd dependent
759 # modules. Use this module to restrict pages by IP address and by
762 #<module name="m_httpd_acl.so">
764 #-#-#-#-#-#-#-#-#-#-#-#- HTTPD ACL CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
766 # Restrict access to the m_httpd_stats module to all but the local
767 # network and when the correct password is specified:
769 # <httpdacl path="/stats*" types="password,whitelist"
770 # username="secretstuff" password="mypasshere" whitelist="127.0.0.*,10.*">
772 # Deny all connections to all but the main index page:
774 # <httpdacl path="/*" types="blacklist" blacklist="*">
777 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
778 # http config module: Allows the server's configuration to be viewed
779 # over HTTP. Requires m_httpd.so to be loaded for it to function.
780 #<module name="m_httpd_config.so">
782 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
783 # http stats module: Provides basic stats pages over HTTP
784 # Requires m_httpd.so to be loaded for it to function.
785 #<module name="m_httpd_stats.so">
787 #-#-#-#-#-#-#-#-#-#-#-#- HTTPD STATS CONFIGURATION -#-#-#-#-#-#-#-#-#-#
789 #<httpstats stylesheet="http://remote.style/sheet.css">
792 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
793 # Ident: Provides RFC 1413 ident lookup support
794 # When this module is loaded <connect:allow> tags may have an optional
795 # useident="yes|no" boolean value, determining whether or not to lookup
796 # ident on users matching that connect tag.
797 #<module name="m_ident.so">
799 #-#-#-#-#-#-#-#-#-#-#-#- IDENT CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
801 # Optional - If you are using the m_ident.so module, then you can #
802 # specify the timeout for ident lookups here. If not defined, it will #
803 # default to one second. This is a non-blocking timeout which holds #
804 # the user in a 'connecting' state until the lookup is complete. #
805 # The bind value indicates which IP to bind outbound requests to. #
807 #<ident timeout="5" bind="">
809 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
810 # Invite except module: Adds support for channel invite exceptions (+I)
811 #<module name="m_inviteexception.so">
813 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
814 # Invisible module - Adds support for usermode +Q (quiet) which lets an
815 # oper go 'invisible' similar to unrealircd 3.1's +I mode. Note that
816 # opers are still able to see invisible users, and if an oper with +Q
817 # deopers, they will become visible.
819 # IMPORTANT NOTE: To allow this mode to be used by a type of oper, you
820 # must first add the value canquiet="yes" to that oper's type tag.
822 # This module is oper-only.
824 #<module name="m_invisible.so">
826 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
827 # Join flood module: Adds support for join flood protection (+j)
828 #<module name="m_joinflood.so">
830 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
831 # Jump Server module: Adds support for the RPL_REDIR numeric
832 # This module is oper-only.
833 # To use, JUMPSERVER must be in one of your oper class blocks.
834 #<module name="m_jumpserver.so">
836 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
837 # Anti-Auto-Rejoin: Adds support for prevention of auto-rejoin (+J)
838 #<module name="m_kicknorejoin.so">
840 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
841 # Knock module: adds the /KNOCK command and +K channel mode
842 #<module name="m_knock.so">
844 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
845 # LDAP authentication module: Adds the ability to authenticate users #
846 # via LDAP. This is an extra module which must be enabled explicitly #
847 # by symlinking it from modules/extra, and requires the OpenLDAP libs #
849 #<module name="m_ldapauth.so"> #
853 # <ldapauth baserdn="ou=People,dc=brainbox,dc=cc" #
855 # server="ldap://brainwave.brainbox.cc" #
856 # allowpattern="Guest*" #
857 # killreason="Access denied" #
858 # searchscope="subtree" #
859 # binddn="cn=Manager,dc=brainbox,dc=cc" #
860 # bindauth="mysecretpass" #
863 # The baserdn indicates the base DN to search in for users. Usually #
864 # this is 'ou=People,dc=yourdomain,dc=yourtld'. #
866 # The attribute value indicates the attribute which is used to locate #
867 # a user account by name. On POSIX systems this is usually 'uid'. #
869 # The server parameter indicates the LDAP server to connect to. The #
870 # ldap:// style scheme before the hostname proper is MANDITORY. #
872 # The allowpattern value allows you to specify a wildcard mask which #
873 # will always be allowed to connect regardless of if they have an #
874 # account, for example guest users. #
876 # Killreason indicates the QUIT reason to give to users if they fail #
879 # The searchscope value indicates the subtree to search under. On our #
880 # test system this is 'subtree'. Your mileage may vary. #
882 # Setting the verbose value causes an oper notice to be sent out for #
883 # every failed authentication to the server, with an error string. #
885 # The binddn and bindauth indicate the DN to bind to for searching, #
886 # and the password for the distinguished name. Some LDAP servers will #
887 # allow anonymous searching in which case these two values do not #
888 # need defining, otherwise they should be set similar to the examples #
891 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
892 # Lock server module: Adds /LOCKSERV and /UNLOCKSERV commands that is #
893 # used to temporarily close/open for new connections to the server. #
894 # These commands require OPER status and that the LOCKSERV UNLOCKSERV #
895 # are specified in a <class> tag that the oper is part of. This is so #
896 # you can control who has access to this possible dangerous command. #
897 # If your server is locked and you got disconnected, do a REHASH from #
898 # shell to open up again.
900 # This module is oper-only.
902 #<module name="m_lockserv.so">
904 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
905 # Msg flood module: Adds message/notice flood protection (+f)
906 #<module name="m_messageflood.so">
908 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
909 # MsSQL module: Allows other SQL modules to access MS SQL Server
910 # through a unified API. You must copy the source for this module
911 # from the directory src/modules/extra, plus the file m_sqlv2.h
912 #<module name="m_mssql.so">
914 #-#-#-#-#-#-#-#-#-#-#-#- SQL CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#-#
916 # m_mssql.so is more complex than described here, see wiki for more #
917 # info http://www.inspircd.org/wiki/SQLServer_Service_Provider_Module #
919 #<database name="db" username="user" password="pass" hostname="localhost" id="db1">
921 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
922 # MySQL module: Allows other SQL modules to access MySQL databases
923 # through a unified API. You must copy the source for this module
924 # from the directory src/modules/extra, plus the file m_sqlv2.h
925 #<module name="m_mysql.so">
927 #-#-#-#-#-#-#-#-#-#-#-#- SQL CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#-#
929 # m_mysql.so is more complex than described here, see the wiki for #
930 # more: http://www.inspircd.org/wiki/SQL_Service_Provider_Module #
932 #<database name="mydb" username="myuser" password="mypass" hostname="localhost" id="my_database2">
934 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
935 # NAMESX module: Provides support for the NAMESX extension which allows
936 # clients to see all the prefixes set on a user without getting confused.
937 # This is supported by mIRC, x-chat, klient, and maybe more.
938 #<module name="m_namesx.so">
940 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
941 # Nickchange flood protection module: Allows up to X nick changes in Y seconds.
942 # Provides channel mode +F.
943 #<module name="m_nickflood.so">
945 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
946 # Nicklock module: Let opers change a user's nick and then stop that
947 # user from changing their nick again.
948 # This module is oper-only.
949 # To use, NICKLOCK and NICKUNLOCK must be in one of your oper class blocks.
950 #<module name="m_nicklock.so">
952 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
953 # No ctcp module: Adds the channel mode +C to block CTCPs
954 #<module name="m_noctcp.so">
956 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
957 # No kicks module: Adds the +Q channel mode
958 #<module name="m_nokicks.so">
960 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
961 # No nicks module: Adds the +N channel mode, as well as the +b N:
962 # extended bantype. +N stops all users from changing their nick,
963 # the +b N: extban stops anyone from matching a +b N:nick!user@host
964 # mask from changing their nick.
965 #<module name="m_nonicks.so">
967 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
968 # No Notice module: adds the channel mode +T
969 #<module name="m_nonotice.so">
971 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
972 # Oper channels mode: Adds the +O channel mode
973 # This module is oper-only.
974 #<module name="m_operchans.so">
976 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
977 # Oper flood module: Removes flood limits from users upon opering up
978 # This module is oper-only.
979 #<module name="m_operflood.so">
981 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
982 # Oper invex/extban module: Adds +beI type O, to ban, exempt, and invex
983 # given oper type masks.
984 # e.g, /mode #channel +iI O:* is equivilant to chmode +O, but you
985 # may also, e.g. /mode #channel +iI O:AdminTypeOnly to only allow admins.
986 # +be work in a similar fashion.
987 # This module is oper-only.
989 #<module name="m_operinvex.so">
991 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
992 # Oper Join module: Auto-joins opers to a channel upon oper-up
993 # This module is oper-only. For the user equivalent, see m_conn_join.
994 #<module name="m_operjoin.so">
996 #-#-#-#-#-#-#-#-#-#-# OPERJOIN CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
998 # If you are using the m_operjoin.so module, specify options here: #
1000 # channel - The channel name to join, can also be a comma #
1001 # seperated list eg. "#channel1,#channel2". #
1003 # override - Lets the oper join walking thru any modes that #
1004 # might be set, even bans. Use "yes" or "no". #
1006 #<operjoin channel="#channel" override="no">
1008 # Alternatively you can use the autojoin="channellist" in a <type> #
1009 # tag to set specific autojoins for a type of oper, for example: #
1011 #<type name="Helper" autojoin="#help" classes="...">
1013 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1014 # Oper log module: Logs all oper commands to the ircd log at default
1016 # This module is oper-only.
1017 #<module name="m_operlog.so">
1019 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1020 # Oper MOTD module: Provides support for seperate message of the day
1022 # This module is oper-only.
1023 #<module name="m_opermotd.so">
1025 #-#-#-#-#-#-#-#-#-#-# OPERMOTD CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
1027 # If you are using the m_opermotd.so module, specify the motd here #
1029 #<opermotd file="oper.motd">
1031 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1032 # Override module: Adds support for oper override
1033 # This module is oper-only.
1034 #<module name="m_override.so">
1036 #-#-#-#-#-#-#-#-#-#-# OVERRIDE CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
1038 # m_override.so is too complex it describe here, see the wiki: #
1039 # http://www.inspircd.org/wiki/Oper_Override_Module #
1041 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1042 # Oper levels module: Gives each oper a level and prevents
1043 # actions being taken against higher level opers
1044 # Specify the level as the 'level' parameter of the <type> tag
1045 # # This module is oper-only.
1046 #<module name="m_operlevels.so">
1048 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1049 # Oper modes module: Allows you to specify modes to add/remove on oper
1050 # Specify the modes as the 'modes' parameter of the <type> tag
1051 # and/or as the 'modes' parameter of the <oper> tag.
1052 # This module is oper-only. For the user equivalent, see m_conn_umodes
1053 #<module name="m_opermodes.so">
1055 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1056 # Oper password hash module: Allows hashed oper passwords
1057 # Relies on the module m_md5.so and/or m_sha256.so being loaded before
1058 # m_password_hash.so in the configuration file.
1059 # This module is oper-only.
1060 #<module name="m_password_hash.so">
1062 #-#-#-#-#-#-#-#-#-#-# OPER HASH CONFIGURATION #-#-#-#-#-#-#-#-#-#-#-#-#
1064 # To use this module, you must define a hash type for each oper's
1065 # password you want to hash. For example:
1067 # <oper name="Brain"
1068 # host="ident@dialup15.isp.com"
1070 # password="a41d730937a53b79f788c0ab13e9e1d5"
1073 # The types of hashing available vary depending on which hashing modules
1074 # you load, but usually if you load m_sha256.so and m_md5.so, both md5
1075 # and sha256 type hashing will be available (the most secure of which
1078 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1079 # Permanent Channels module: Channels with the permanent channels mode
1080 # will remain open even after everyone else has left the channel, and
1081 # therefore keep things like modes, ban lists and topic. Permanent
1082 # channels -may- need support from your Services package to function
1083 # properly with them. This adds channel mode +P.
1084 # This module is oper-only.
1085 #<module name="m_permchannels.so">
1087 # You may also create channels on startup by using the <permchannels> block.
1088 #<permchannels channel="#opers" modes="is" topic="Opers only.">
1090 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1091 # PostgreSQL module: Allows other SQL modules to access PgSQL databases
1092 # through a unified API. You must copy the source for this module
1093 # from the directory src/modules/extra, plus the file m_sqlv2.h
1094 #<module name="m_pgsql.so">
1096 #-#-#-#-#-#-#-#-#-#-#-#- SQL CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#-#
1098 # m_pgsql.so is more complex than described here, see the wiki for #
1099 # more: http://www.inspircd.org/wiki/SQL_Service_Provider_Module #
1101 #<database name="mydb" username="myuser" password="mypass" hostname="localhost" id="my_database" ssl="no">
1103 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1104 # Muteban: Implements extended ban m:, which stops anyone matching
1105 # a mask like +b m:nick!user@host from speaking on channel.
1106 #<module name="m_muteban.so">
1109 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1110 # Random Quote module: provides a random quote on connect.
1111 # NOTE: Some of these may mimic fatal errors and confuse users and
1112 # opers alike! - BEWARE!
1113 #<module name="m_randquote.so">
1115 #-#-#-#-#-#-#-#-#-#- RANDOMQUOTES CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
1117 # Optional - If you specify to use the m_randquote.so module, then #
1118 # specify below the path to the randquotes.conf file. #
1120 #<randquote file="randquotes.conf">
1122 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1123 # Redirect module: Adds channel redirection (mode +L)
1124 #<module name="m_redirect.so">
1126 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1127 # Regular Expression Provider for Glob or wildcard (?/*) matching.
1128 # You must have at least 1 provider loaded to use m_filter or m_rline
1129 # modules. This module has no additional requirements, as it uses the
1130 # matching already present in InspIRCd core.
1131 #<module name="m_regex_glob.so">
1133 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1134 # Regular Expression Provider for PCRE (Perl-Compatible Regular
1135 # Expressions). You need libpcre installed to compile and load this
1136 # module. You must have at least 1 provider loaded to use m_filter or
1138 #<module name="m_regex_pcre.so">
1140 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1141 # Regular Expression Provider for POSIX Regular Expressions.
1142 # You shouldn't need any additional libraries on a POSIX-compatible
1143 # system (ie: any Linux, BSD, but not Windows). You must have at least
1144 # 1 provider loaded to use m_filter or m_rline.
1145 # On POSIX-compliant systems, regex syntax can be found by using the
1146 # command: 'man 7 regex'.
1147 #<module name="m_regex_posix.so">
1149 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1150 # Regular Expression Provider for TRE Regular Expressions.
1151 # This is the same regular expression engine used by UnrealIRCd, so
1152 # if you are most familiar with the syntax of /spamfilter from there,
1153 # this is the provider you want. You need libtre installed in order
1154 # to compile and load this module.
1155 #<module name="m_regex_tre.so">
1157 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1158 # Registered users only channel creation
1159 # Allows only registered users and opers to create new channels.
1160 #<module name="m_regonlycreate.so">
1162 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1163 # Remove module: Adds the /REMOVE command which is a peaceful
1164 # alternative to /KICK
1165 #<module name="m_remove.so">
1167 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1168 # Restrict banned users module:
1169 # Disallows banned users on a channel from messaging the channel,
1170 # changing nick, or changing the topic, if loaded.
1171 #<module name="m_restrictbanned.so">
1173 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1174 # Restricted channels module: Allows only opers to create channels
1175 #<module name="m_restrictchans.so">
1177 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1178 # Restrict message module: Allows users to only message opers
1179 #<module name="m_restrictmsg.so">
1181 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1182 # Ban users through regular expression patterns
1183 #<module name="m_rline.so">
1185 #-#-#-#-#-#-#-#-#-#-#-#- RLINE CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#-#
1187 # If you wish to re-check a user when they change nickname (can be
1188 # useful under some situations, but *can* also use CPU with more users
1189 # on a server) then set the following configuration value:
1190 # Also, this is where you set what Regular Expression engine is to be
1191 # used. If you ever change it while running, all of your R-Lines will be
1192 # wiped. This is the regex engine used by all R-Lines set, and
1193 # m_regex_<engine>.so must be loaded, or rline will be nonfunctional
1194 # until you load it or change the engine to one that is loaded.
1196 #<rline matchonnickchange="yes" engine="pcre">
1198 # Generally, you will NOT want to use 'glob' here, as this turns
1199 # rline into just another gline. The exceptions are that rline will
1200 # always use the full nick!user@host realname string, rather than only
1201 # user@host, but beware that only the ? and * wildcards are available,
1202 # and are the only way to specify where the space can occur if you do
1203 # use glob. For this reason, is recommended to use a real regex engine
1204 # so that at least \s or [[:space:]] is available.
1206 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1207 # JSON-RPC module: Encode and decode JSON-RPC requests for modules
1208 #<module name="m_rpc_json.so">
1210 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1211 # RPC test module: A test of the RPC API
1212 #<module name="m_rpctest.so">
1214 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1215 # Provide /LIST throttling (to prevent flooding) and /LIST safety to
1216 # prevent excess flood when the list is large.
1217 #<module name="m_safelist.so">
1219 #-#-#-#-#-#-#-#-#-#-# SAFELIST CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#-#
1221 # When using Safelist, you may set the following values;
1223 # The first value, 'throttle', sets the amount of time in seconds a user
1224 # must wait between LIST commands. For example, if this is set to 60
1225 # (the default) then the user may not /LIST more than once a minute.
1226 # If not defined, the default value is 60 seconds.
1228 # The second value, 'maxlisters', indicates the maximum number of users
1229 # which may be retrieving a LIST at once. It is not recommended you raise
1230 # this value, as increasing it too high can make your network vulnerable
1231 # to floodbots which waste your bandwidth and CPU time with LIST requests.
1233 #<safelist throttle="60" maxlisters="50">
1235 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1236 # SAJOIN module: Adds the /SAJOIN command
1237 # This module is oper-only.
1238 # To use, SAJOIN must be in one of your oper class blocks.
1239 #<module name="m_sajoin.so">
1241 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1242 # SAMODE module: Adds the oper /SAMODE command
1243 # This module is oper-only.
1244 # To use, SAMODE must be in one of your oper class blocks.
1245 #<module name="m_samode.so">
1247 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1248 # SANICK module: Allows opers to change user's nicks
1249 # This module is oper-only.
1250 # To use, SANICK must be in one of your oper class blocks.
1251 #<module name="m_sanick.so">
1253 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1254 # SAPART module: Adds the oper /SAPART command
1255 # This module is oper-only.
1256 # To use, SAPART must be in one of your oper class blocks.
1257 #<module name="m_sapart.so">
1259 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1260 # SAQUIT module: Adds the oper /SAQUIT command (abusable!!!)
1261 # This module is oper-only.
1262 # To use, SAQUIT must be in one of your oper class blocks.
1263 #<module name="m_saquit.so">
1265 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1266 # SASL authentication module: Provides support for IRC Authentication
1267 # Layer (aka: atheme SASL) via AUTHENTICATE.
1268 #<module name="m_sasl.so">
1270 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1271 # Secure list module: Prevent /LIST in the first minute of connection,
1272 # crippling most spambots and trojan spreader bots.
1273 #<module name="m_securelist.so">
1275 #-#-#-#-#-#-#-#-#-# SECURELIST CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#-#
1277 # Securelist can be harmful to some irc search engines such as #
1278 # netsplit.de and searchirc.com. To prevent securelist blocking these #
1279 # sites from listing, define exception tags as shown below: #
1280 <securehost exception="*@*.searchirc.org">
1281 <securehost exception="*@*.netsplit.de">
1282 <securehost exception="*@echo940.server4you.de">
1284 # Define the following variable to change how long a user must wait #
1285 # before issuing a LIST. If not defined, defaults to 60 seconds. #
1287 #<securelist waittime="60"> #
1289 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1290 # Servprotect module: Provides support for Austhex style +k /
1291 # UnrealIRCD +S services mode
1292 #<module name="m_servprotect.so">
1294 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1295 # See nicks module: Allow for SNOMASK +N which shows nick changes.
1296 # This module is oper-only.
1297 #<module name="m_seenicks.so">
1299 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1300 # Set Idle module: Adds a command for opers to change their
1301 # idle time (mainly a toy)
1302 # This module is oper-only.
1303 # To use, SETIDLE must be in one of your oper class blocks.
1304 #<module name="m_setidle.so">
1306 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1307 # Services support module: Adds several usermodes such as +R and +M
1308 # this module implements the 'identified' state via user mode +r, which
1309 # is similar to the DALnet and dreamforge systems.
1312 # >> This CAN NOT be used at the same time as m_services_account <<
1314 # *** This module DOES NOT support Atheme services, please use ***
1315 # *** m_services_account if you are planning on using Atheme. ***
1316 #<module name="m_services.so">
1318 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1319 # Services support module: Adds several usermodes such as +R and +M
1320 # this module implements the 'identified' state via account names (AC)
1321 # and is similar in operation to the way asuka and ircu handle services.
1323 # Also of note is that this module implements two extbans:
1324 # +b R: (stop matching account names from joining)
1325 # +b M: (stop matching account names from speaking)
1328 # >> This CAN NOT be used at the same time as m_services <<
1330 #<module name="m_services_account.so">
1332 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1333 # Sethost module: Adds the /SETHOST command
1334 # This module is oper-only.
1335 # To use, SETHOST must be in one of your oper class blocks.
1336 # See m_chghost for how to customise valid chars for hostnames
1337 #<module name="m_sethost.so">
1339 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1340 # Setident module: Adds the /SETIDENT command
1341 # This module is oper-only.
1342 # To use, SETIDENT must be in one of your oper class blocks.
1343 #<module name="m_setident.so">
1345 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1346 # SETNAME module: Adds the /SETNAME command
1347 # This module is oper-only.
1348 # To use, SETNAME must be in one of your oper class blocks.
1349 #<module name="m_setname.so">
1351 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1352 # Serverban: Implements extended ban s:, which stops anyone connected
1353 # to a server matching a mask like +b s:server.mask.here from joining.
1354 #<module name="m_serverban.so">
1356 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1357 # Show Whois module: Adds the +W usermode which allows opers
1358 # to see when they are whois'ed (can be annoying).
1359 # This module is oper-only.
1360 #<module name="m_showwhois.so">
1362 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1363 # Shun module: Provides the /shun command, which stops a user executing
1365 # This module is oper-only.
1366 # To use, SHUN must be in one of your oper class blocks.
1367 #<module name="m_shun.so">
1369 # You may also configure which commands you wish a user to be able to
1370 # perform. It should be noted that if a shunned user issues QUIT or PART
1371 # then their message will be removed, as if they did not issue one.
1373 # You may also (optionally) let the user know that their command was blocked.
1374 #<shun enabledcommands="PING PONG QUIT PART JOIN" notifyuser="yes">
1376 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1377 # Spy module: Provides the ability to see the complete names list of
1378 # channels an oper is not a member of
1379 # This module is oper-only.
1380 #<module name="m_spy.so">
1382 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1383 # SSL channel mode module: Adds support for SSL-only channels (+z).
1384 # does not do anything useful without a working SSL module (see below)
1385 #<module name="m_sslmodes.so">
1387 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1388 # Dummy ssl module: If you have other servers on your network which
1389 # have SSL, but your server does not have ssl enabled, you should load
1390 # this module, which will handle SSL metadata (e.g. the "Is using ssl"
1391 # field in the WHOIS information).
1392 #<module name="m_ssl_dummy.so">
1394 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1395 # GnuTLS ssl module: Adds support for client-server SSL using GnuTLS,
1396 # if enabled. You must copy the source for this module from the directory
1397 # src/modules/extra, or answer 'yes' in ./configure when asked if you
1398 # want to enable this, or it will not load.
1399 #<module name="m_ssl_gnutls.so">
1401 #-#-#-#-#-#-#-#-#-#-#- GNUTLS CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#
1403 # m_ssl_gnutls.so is too complex it describe here, see the wiki: #
1404 # http://www.inspircd.org/wiki/GnuTLS_SSL_Module #
1406 # NOTE: If you want to use this module to encrypt and sign your #
1407 # server to server traffic, you MUST load it before m_spanningtree in #
1408 # your configuration file! #
1410 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1411 # SSL Info module: Allows users to retrieve information about other
1412 # user's peer SSL certificates and keys. This can be used by client
1413 # scripts to validate users. For this to work, one of m_ssl_gnutls.so
1414 # or m_ssl_openssl.so must be loaded. You must symlink the source for
1415 # this module from the directory src/modules/extra.
1416 #<module name="m_sslinfo.so">
1418 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1419 # OpenSSL ssl module: Adds support for client-server SSL using OpenSSL,
1420 # if enabled. You must copy the source for this module from the directory
1421 # src/modules/extra, or answer 'yes' in ./configure when asked if you
1422 # want to enable this, or it will not load.
1423 #<module name="m_ssl_openssl.so">
1425 #-#-#-#-#-#-#-#-#-#-#- OPENSSL CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#
1427 # m_ssl_openssl.so is too complex it describe here, see the wiki: #
1428 # http://www.inspircd.org/wiki/OpenSSL_SSL_Module #
1430 # NOTE: If you want to use this module to encrypt and sign your #
1431 # server to server traffic, you MUST load it before m_spanningtree in #
1432 # your configuration file! #
1434 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1435 # SSL Cert Oper module: Allows opers to oper up using the key fingerprint
1436 # stored within their SSL certificate and key pair.
1437 # When using this module, one of m_ssl_gnutls.so or m_ssl_openssl.so must
1438 # be loaded. An extra value should be added to enabled opers, which
1439 # is in the following format: fingerprint="<hash>". For more information,
1440 # see the example in the oper blocks.
1441 # This module is oper-only.
1442 #<module name="m_ssl_oper_cert.so">
1444 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1445 # Strip colour module: Adds the channel mode +S
1446 #<module name="m_stripcolor.so">
1448 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1449 # SILENCE module: Adds support for /SILENCE
1450 #<module name="m_silence.so">
1452 # Configuration tags:
1454 #<silence maxentries="32">
1456 # Sets the maximum number of entries on a users silence list.
1458 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1459 # SQLite3 module: Allows other SQL modules to access SQLite3 #
1460 # databases through a unified API. You must link the source for this #
1461 # module from the directory src/modules/extra to src/modules, plus #
1462 # the file m_sqlv2.h #
1463 #<module name="m_sqlite3.so">
1465 #-#-#-#-#-#-#-#-#-#-#-#- SQL CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#-#
1467 # m_sqlite.so is more complex than described here, see the wiki for #
1468 # more: http://www.inspircd.org/wiki/SQLite3_Service_Provider_Module #
1470 #<database hostname="/full/path/to/database.db" id="anytext">
1472 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1473 # SQLutils module: Provides some utilities to SQL client modules, such
1474 # as mapping queries to users and channels. You must copy the source
1475 # for this module from the directory src/modules/extra/m_sqlutils.cpp
1476 # and src/modules/extra/m_sqlutils.h into /src/modules
1477 # Needed for, and loaded before: SQLauth and SQLoper
1478 #<module name="m_sqlutils.so">
1480 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1481 # SQL authentication module: Allows IRCd connections to be tied into
1482 # a database table (for example a forum). You must copy the source for
1483 # this module from the directory src/modules/extra
1484 # Depends on the SQLutils module being loaded first.
1485 #<module name="m_sqlauth.so">
1487 #-#-#-#-#-#-#-#-#-#-#- SQLAUTH CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#
1489 # m_sqlauth.so is too complex it describe here, see the wiki: #
1490 # http://www.inspircd.org/wiki/SQL_Authentication_Module #
1492 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1493 # SQL logging module: Allows you to log network-wide data for your
1494 # network in a fully normalised set of SQL tables. You must copy the
1495 # source for this module from the directory src/modules/extra
1496 #<module name="m_sqllog.so">
1498 #-#-#-#-#-#-#-#-#-#-#- SQLLOG CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#
1500 # dbid - Database ID to use (see m_sql) #
1502 # See also: http://www.inspircd.org/wiki/SQL_Logging_Module #
1506 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1507 # SQL oper module: Allows you to store oper credentials in an SQL table
1508 # You must copy the source for this module from the directory src/modules/extra
1509 # Depends on the SQLutils module being loaded first.
1510 #<module name="m_sqloper.so">
1512 #-#-#-#-#-#-#-#-#-#-#- SQLOPER CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#
1514 # dbid - Database ID to use (see m_sql) #
1515 # hash - Hashing provider to use for password hashing #
1517 # See also: http://www.inspircd.org/wiki/SQL_Oper_Storage_Module #
1519 #<sqloper dbid="1" hash="md5">
1521 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1522 # SVSHold module: Implements SVSHOLD. Like Q:Lines, but can only be #
1523 # added/removed by Services. #
1524 #<module name="m_svshold.so">
1526 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1527 # SWHOIS module: Allows you to add arbitary lines to user WHOIS.
1528 # This module is oper-only.
1529 # To use, SWHOIS must be in one of your oper class blocks.
1530 #<module name="m_swhois.so">
1532 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1533 # Taxonomy module: Adds the /TAXONOMY command, used to view all
1534 # metadata attached to a user.
1535 # This module is oper-only.
1536 # To use, TAXONOMY must be in one of your oper class blocks.
1537 #<module name="m_taxonomy.so">
1539 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1540 # Test command module: Does nothing significant. Read: pointless.
1541 #<module name="m_testcommand.so">
1543 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1544 # Timed bans module: Adds timed bans and the /TBAN command
1545 # This module is oper-only.
1546 # To use, TBAN must be in one of your oper class blocks.
1547 #<module name="m_timedbans.so">
1549 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1550 # Test line module: Adds the /TLINE command, used to test how many
1551 # users a /GLINE or /ZLINE etc would match.
1552 # This module is oper-only.
1553 # To use, TLINE must be in one of your oper class blocks.
1554 #<module name="m_tline.so">
1556 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1557 # UHNAMES support module: Adds support for the IRCX style UHNAMES
1558 # extension, which displays ident and hostname in the names list for
1559 # each user, saving clients from doing a WHO on the channel. Note that
1560 # this module is not widely supported yet. If a client does not support
1561 # UHNAMES it will not enable it, this will not break incompatible
1563 #<module name="m_uhnames.so">
1565 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1566 # Uninvite module: Adds the /UNINVITE command which lets users remove
1567 # pending invites from channels without waiting for the user to join.
1568 #<module name="m_uninvite.so">
1570 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1571 # Userip module: Adds the /USERIP command
1572 # This module is oper-only.
1573 # To use, USERIP must be in one of your oper class blocks.
1574 #<module name="m_userip.so">
1576 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1577 # Vhost module: Adds the VHOST command which allows for adding virtual
1578 # hosts which are accessible using a username and password in the config.
1579 #<module name="m_vhost.so">
1581 #-#-#-#-#-#-#-#-#-#-#- VHOST CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#-#
1583 # user - Username for the vhost. #
1585 # pass - Password for the vhost. #
1587 # host - Vhost to set. #
1589 #<vhost user="some_username" pass="some_password" host="some.host">
1591 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1592 # Watch module: Adds the WATCH command, which is used by clients to
1593 # maintain notify lists.
1594 #<module name="m_watch.so">
1596 # Configuration tags:
1598 #<watch maxentries="32">
1600 # Sets the maximum number of entries on a user's watch list.
1602 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1603 # XLine database: Stores all *Lines (G/Z/K/R/any added by other modules)
1604 # in a file "xline.db" which can be re-loaded on restart. This is useful
1605 # for two reasons: it keeps bans so users may not evade them, and on
1606 # bigger networks, server connections will take less time as there will
1607 # be a lot less bans to apply - as most of them will already be there.
1608 #<module name="m_xline_db.so">
1610 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1611 # ZipLinks module: Adds support for zlib deflate on server to server
1612 # connections. Both ends of the connection must load this module.
1614 #<module name="m_ziplink.so">
1616 # To use this module, you must enable it as a transport type in your
1617 # <link> tags or <bind> tags using the transport name 'zip'.
1618 # See the documentation of <link> and <bind>, respectively.
projects / user / henk / code / inspircd.git / blob