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 # This modules is in extras. Re-run configure with: ./configure --enable-extras=m_geoip.cpp
668 # and run make install, then uncomment this module to enable it.
669 #<module name="m_geoip.so">
671 #-#-#-#-#-#-#-#-#-#-#-# GEOIP CONFIGURATION #-#-#-#-#-#-#-#-#-#-#-#-#
673 # <geoip banunknown="false"> #
675 # Set this value to true or yes to block unknown IP ranges which are #
676 # not in the database (usually LAN addresses, localhost, etc) #
678 # <geoban country="TR" reason="This country not permitted"> #
680 # Use one or more of these tags to ban countries by country code. #
681 # The country code must be in capitals and should be an ISO country #
682 # code such as TR, GB, or US. #
684 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
685 # Globops module: gives /GLOBOPS and SNOMASK +g
686 # This module is oper-only.
687 # To use, GLOBOPS must be in one of your oper class blocks.
688 #<module name="m_globops.so">
690 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
691 # Global load module: Allows loading and unloading of modules network-
692 # wide (USE WITH EXTREME CAUTION!)
693 # This module is oper-only and provides /gloadmodule, /gunloadmodule
694 # and /greloadmodule.
695 # To use, GLOADMODULE, GUNLOADMODULE and GRELOADMODULE
696 # must be in one of your oper class blocks.
697 #<module name="m_globalload.so">
699 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
700 # HELPOP module: Provides the /HELPOP command
701 #<module name="m_helpop.so">
703 #-#-#-#-#-#-#-#-#-#-#-#- HELPOP CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
705 # Optional - If you specify to use the m_helpop.so module, then #
706 # specify below the path to the helpop.conf file, or if you like to #
707 # make a mess, define your helpop tags in this conf. #
709 #<include file="helpop.conf">
711 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
712 # HIDECHANS module: Allows opers to hide their channels list from non-
713 # opers by setting user mode +I on themselves.
714 # <module name="m_hidechans.so">
716 # HIDECHANS can optionally prevent opers from seeing channels on a +I
717 # user, for more privacy if set to true.
718 # This setting is not recommended for most mainstream networks.
719 #<hidechans affectsopers="false">
721 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
722 # HIDEOPER module: Allows opers to hide their oper status from non-
723 # opers by setting user mode +H on themselves.
724 # This module is oper-only.
725 # <module name="m_hideoper.so">
727 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
728 # Hostchange module: Allows a different style of cloaking
729 #<module name="m_hostchange.so">
731 #-#-#-#-#-#-#-#-#-#-#- HOSTCHANGE CONFIGURATION -#-#-#-#-#-#-#-#-#-#
733 # Optional - If you choose to use the m_hostchange.so module. #
734 # Config Help - See http://www.inspircd.org/wiki/Host_Changer_Module #
736 #<host suffix="polarbears.org" separator="." prefix="">
737 #<hostchange mask="*@fbi.gov" action="addnick">
738 #<hostchange mask="*r00t@*" action="suffix">
739 #<hostchange mask="a@b.com" action="set" value="blah.blah.blah">
740 #<hostchange mask="localhost" ports="7000,7001,7005-7007" action="set" value="blahblah.foo">
742 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
743 # httpd module: Provides http server support for InspIRCd
744 #<module name="m_httpd.so">
746 #-#-#-#-#-#-#-#-#-#-#-#- HTTPD CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
748 # Optional - If you choose to use the m_httpd.so module, then you must
749 # specify the port number and other details of your http server:
751 #<http ip="192.168.1.10" host="brainwave" port="32006"
752 # index="/home/brain/inspircd/http/index.html">
754 # You may have as many of these tags as you wish, each with a different
755 # IP, port, host or index file. Each one will act as an independent
759 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
760 # http ACL module: Provides access control lists for m_httpd dependent
761 # modules. Use this module to restrict pages by IP address and by
764 #<module name="m_httpd_acl.so">
766 #-#-#-#-#-#-#-#-#-#-#-#- HTTPD ACL CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
768 # Restrict access to the m_httpd_stats module to all but the local
769 # network and when the correct password is specified:
771 # <httpdacl path="/stats*" types="password,whitelist"
772 # username="secretstuff" password="mypasshere" whitelist="127.0.0.*,10.*">
774 # Deny all connections to all but the main index page:
776 # <httpdacl path="/*" types="blacklist" blacklist="*">
779 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
780 # http config module: Allows the server's configuration to be viewed
781 # over HTTP. Requires m_httpd.so to be loaded for it to function.
782 #<module name="m_httpd_config.so">
784 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
785 # http stats module: Provides basic stats pages over HTTP
786 # Requires m_httpd.so to be loaded for it to function.
787 #<module name="m_httpd_stats.so">
789 #-#-#-#-#-#-#-#-#-#-#-#- HTTPD STATS CONFIGURATION -#-#-#-#-#-#-#-#-#-#
791 #<httpstats stylesheet="http://remote.style/sheet.css">
794 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
795 # Ident: Provides RFC 1413 ident lookup support
796 # When this module is loaded <connect:allow> tags may have an optional
797 # useident="yes|no" boolean value, determining whether or not to lookup
798 # ident on users matching that connect tag.
799 #<module name="m_ident.so">
801 #-#-#-#-#-#-#-#-#-#-#-#- IDENT CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
803 # Optional - If you are using the m_ident.so module, then you can #
804 # specify the timeout for ident lookups here. If not defined, it will #
805 # default to one second. This is a non-blocking timeout which holds #
806 # the user in a 'connecting' state until the lookup is complete. #
807 # The bind value indicates which IP to bind outbound requests to. #
809 #<ident timeout="5" bind="">
811 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
812 # Invite except module: Adds support for channel invite exceptions (+I)
813 #<module name="m_inviteexception.so">
815 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
816 # Invisible module - Adds support for usermode +Q (quiet) which lets an
817 # oper go 'invisible' similar to unrealircd 3.1's +I mode. Note that
818 # opers are still able to see invisible users, and if an oper with +Q
819 # deopers, they will become visible.
821 # IMPORTANT NOTE: To allow this mode to be used by a type of oper, you
822 # must first add the value canquiet="yes" to that oper's type tag.
824 # This module is oper-only.
826 #<module name="m_invisible.so">
828 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
829 # Join flood module: Adds support for join flood protection (+j)
830 #<module name="m_joinflood.so">
832 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
833 # Jump Server module: Adds support for the RPL_REDIR numeric
834 # This module is oper-only.
835 # To use, JUMPSERVER must be in one of your oper class blocks.
836 #<module name="m_jumpserver.so">
838 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
839 # Anti-Auto-Rejoin: Adds support for prevention of auto-rejoin (+J)
840 #<module name="m_kicknorejoin.so">
842 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
843 # Knock module: adds the /KNOCK command and +K channel mode
844 #<module name="m_knock.so">
846 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
847 # LDAP authentication module: Adds the ability to authenticate users #
848 # via LDAP. This is an extra module which must be enabled explicitly #
849 # by symlinking it from modules/extra, and requires the OpenLDAP libs #
850 # This modules is in extras. Re-run configure with: ./configure --enable-extras=m_ldapauth.cpp
851 # and run make install, then uncomment this module to enable it. #
853 #<module name="m_ldapauth.so"> #
857 # <ldapauth baserdn="ou=People,dc=brainbox,dc=cc" #
859 # server="ldap://brainwave.brainbox.cc" #
860 # allowpattern="Guest*" #
861 # killreason="Access denied" #
862 # searchscope="subtree" #
863 # binddn="cn=Manager,dc=brainbox,dc=cc" #
864 # bindauth="mysecretpass" #
867 # The baserdn indicates the base DN to search in for users. Usually #
868 # this is 'ou=People,dc=yourdomain,dc=yourtld'. #
870 # The attribute value indicates the attribute which is used to locate #
871 # a user account by name. On POSIX systems this is usually 'uid'. #
873 # The server parameter indicates the LDAP server to connect to. The #
874 # ldap:// style scheme before the hostname proper is MANDITORY. #
876 # The allowpattern value allows you to specify a wildcard mask which #
877 # will always be allowed to connect regardless of if they have an #
878 # account, for example guest users. #
880 # Killreason indicates the QUIT reason to give to users if they fail #
883 # The searchscope value indicates the subtree to search under. On our #
884 # test system this is 'subtree'. Your mileage may vary. #
886 # Setting the verbose value causes an oper notice to be sent out for #
887 # every failed authentication to the server, with an error string. #
889 # The binddn and bindauth indicate the DN to bind to for searching, #
890 # and the password for the distinguished name. Some LDAP servers will #
891 # allow anonymous searching in which case these two values do not #
892 # need defining, otherwise they should be set similar to the examples #
895 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
896 # Lock server module: Adds /LOCKSERV and /UNLOCKSERV commands that is #
897 # used to temporarily close/open for new connections to the server. #
898 # These commands require OPER status and that the LOCKSERV UNLOCKSERV #
899 # are specified in a <class> tag that the oper is part of. This is so #
900 # you can control who has access to this possible dangerous command. #
901 # If your server is locked and you got disconnected, do a REHASH from #
902 # shell to open up again.
904 # This module is oper-only.
906 #<module name="m_lockserv.so">
908 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
909 # Msg flood module: Adds message/notice flood protection (+f)
910 #<module name="m_messageflood.so">
912 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
913 # MsSQL module: Allows other SQL modules to access MS SQL Server
914 # through a unified API. You must copy the source for this module
915 # from the directory src/modules/extra, plus the file m_sqlv2.h
916 # This modules is in extras. Re-run configure with: ./configure --enable-extras=m_mssql.cpp
917 # and run make install, then uncomment this module to enable it.
919 #<module name="m_mssql.so">
921 #-#-#-#-#-#-#-#-#-#-#-#- SQL CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#-#
923 # m_mssql.so is more complex than described here, see wiki for more #
924 # info http://www.inspircd.org/wiki/SQLServer_Service_Provider_Module #
926 #<database name="db" username="user" password="pass" hostname="localhost" id="db1">
928 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
929 # MySQL module: Allows other SQL modules to access MySQL databases
930 # through a unified API. You must copy the source for this module
931 # from the directory src/modules/extra, plus the file m_sqlv2.h
932 # This modules is in extras. Re-run configure with: ./configure --enable-extras=m_mysql.cpp
933 # and run make install, then uncomment this module to enable it.
935 #<module name="m_mysql.so">
937 #-#-#-#-#-#-#-#-#-#-#-#- SQL CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#-#
939 # m_mysql.so is more complex than described here, see the wiki for #
940 # more: http://www.inspircd.org/wiki/SQL_Service_Provider_Module #
942 #<database name="mydb" username="myuser" password="mypass" hostname="localhost" id="my_database2">
944 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
945 # NAMESX module: Provides support for the NAMESX extension which allows
946 # clients to see all the prefixes set on a user without getting confused.
947 # This is supported by mIRC, x-chat, klient, and maybe more.
948 #<module name="m_namesx.so">
950 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
951 # Nickchange flood protection module: Allows up to X nick changes in Y seconds.
952 # Provides channel mode +F.
953 #<module name="m_nickflood.so">
955 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
956 # Nicklock module: Let opers change a user's nick and then stop that
957 # user from changing their nick again.
958 # This module is oper-only.
959 # To use, NICKLOCK and NICKUNLOCK must be in one of your oper class blocks.
960 #<module name="m_nicklock.so">
962 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
963 # No ctcp module: Adds the channel mode +C to block CTCPs
964 #<module name="m_noctcp.so">
966 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
967 # No kicks module: Adds the +Q channel mode
968 #<module name="m_nokicks.so">
970 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
971 # No nicks module: Adds the +N channel mode, as well as the +b N:
972 # extended bantype. +N stops all users from changing their nick,
973 # the +b N: extban stops anyone from matching a +b N:nick!user@host
974 # mask from changing their nick.
975 #<module name="m_nonicks.so">
977 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
978 # No Notice module: adds the channel mode +T
979 #<module name="m_nonotice.so">
981 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
982 # Oper channels mode: Adds the +O channel mode
983 # This module is oper-only.
984 #<module name="m_operchans.so">
986 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
987 # Oper flood module: Removes flood limits from users upon opering up
988 # This module is oper-only.
989 #<module name="m_operflood.so">
991 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
992 # Oper invex/extban module: Adds +beI type O, to ban, exempt, and invex
993 # given oper type masks.
994 # e.g, /mode #channel +iI O:* is equivilant to chmode +O, but you
995 # may also, e.g. /mode #channel +iI O:AdminTypeOnly to only allow admins.
996 # +be work in a similar fashion.
997 # This module is oper-only.
999 #<module name="m_operinvex.so">
1001 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1002 # Oper Join module: Auto-joins opers to a channel upon oper-up
1003 # This module is oper-only. For the user equivalent, see m_conn_join.
1004 #<module name="m_operjoin.so">
1006 #-#-#-#-#-#-#-#-#-#-# OPERJOIN CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
1008 # If you are using the m_operjoin.so module, specify options here: #
1010 # channel - The channel name to join, can also be a comma #
1011 # seperated list eg. "#channel1,#channel2". #
1013 # override - Lets the oper join walking thru any modes that #
1014 # might be set, even bans. Use "yes" or "no". #
1016 #<operjoin channel="#channel" override="no">
1018 # Alternatively you can use the autojoin="channellist" in a <type> #
1019 # tag to set specific autojoins for a type of oper, for example: #
1021 #<type name="Helper" autojoin="#help" classes="...">
1023 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1024 # Oper log module: Logs all oper commands to the ircd log at default
1026 # This module is oper-only.
1027 #<module name="m_operlog.so">
1029 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1030 # Oper MOTD module: Provides support for seperate message of the day
1032 # This module is oper-only.
1033 #<module name="m_opermotd.so">
1035 #-#-#-#-#-#-#-#-#-#-# OPERMOTD CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
1037 # If you are using the m_opermotd.so module, specify the motd here #
1039 #<opermotd file="oper.motd">
1041 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1042 # Override module: Adds support for oper override
1043 # This module is oper-only.
1044 #<module name="m_override.so">
1046 #-#-#-#-#-#-#-#-#-#-# OVERRIDE CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
1048 # m_override.so is too complex it describe here, see the wiki: #
1049 # http://www.inspircd.org/wiki/Oper_Override_Module #
1051 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1052 # Oper levels module: Gives each oper a level and prevents
1053 # actions being taken against higher level opers
1054 # Specify the level as the 'level' parameter of the <type> tag
1055 # # This module is oper-only.
1056 #<module name="m_operlevels.so">
1058 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1059 # Oper modes module: Allows you to specify modes to add/remove on oper
1060 # Specify the modes as the 'modes' parameter of the <type> tag
1061 # and/or as the 'modes' parameter of the <oper> tag.
1062 # This module is oper-only. For the user equivalent, see m_conn_umodes
1063 #<module name="m_opermodes.so">
1065 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1066 # Oper password hash module: Allows hashed oper passwords
1067 # Relies on the module m_md5.so and/or m_sha256.so being loaded before
1068 # m_password_hash.so in the configuration file.
1069 # This module is oper-only.
1070 #<module name="m_password_hash.so">
1072 #-#-#-#-#-#-#-#-#-#-# OPER HASH CONFIGURATION #-#-#-#-#-#-#-#-#-#-#-#-#
1074 # To use this module, you must define a hash type for each oper's
1075 # password you want to hash. For example:
1077 # <oper name="Brain"
1078 # host="ident@dialup15.isp.com"
1080 # password="a41d730937a53b79f788c0ab13e9e1d5"
1083 # The types of hashing available vary depending on which hashing modules
1084 # you load, but usually if you load m_sha256.so and m_md5.so, both md5
1085 # and sha256 type hashing will be available (the most secure of which
1088 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1089 # Permanent Channels module: Channels with the permanent channels mode
1090 # will remain open even after everyone else has left the channel, and
1091 # therefore keep things like modes, ban lists and topic. Permanent
1092 # channels -may- need support from your Services package to function
1093 # properly with them. This adds channel mode +P.
1094 # This module is oper-only.
1095 #<module name="m_permchannels.so">
1097 # You may also create channels on startup by using the <permchannels> block.
1098 #<permchannels channel="#opers" modes="is" topic="Opers only.">
1100 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1101 # PostgreSQL module: Allows other SQL modules to access PgSQL databases
1102 # through a unified API. You must copy the source for this module
1103 # from the directory src/modules/extra, plus the file m_sqlv2.h
1104 # This modules is in extras. Re-run configure with: ./configure --enable-extras=m_pgsql.cpp
1105 # and run make install, then uncomment this module to enable it.
1107 #<module name="m_pgsql.so">
1109 #-#-#-#-#-#-#-#-#-#-#-#- SQL CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#-#
1111 # m_pgsql.so is more complex than described here, see the wiki for #
1112 # more: http://www.inspircd.org/wiki/SQL_Service_Provider_Module #
1114 #<database name="mydb" username="myuser" password="mypass" hostname="localhost" id="my_database" ssl="no">
1116 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1117 # Muteban: Implements extended ban m:, which stops anyone matching
1118 # a mask like +b m:nick!user@host from speaking on channel.
1119 #<module name="m_muteban.so">
1122 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1123 # Random Quote module: provides a random quote on connect.
1124 # NOTE: Some of these may mimic fatal errors and confuse users and
1125 # opers alike! - BEWARE!
1126 #<module name="m_randquote.so">
1128 #-#-#-#-#-#-#-#-#-#- RANDOMQUOTES CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
1130 # Optional - If you specify to use the m_randquote.so module, then #
1131 # specify below the path to the randquotes.conf file. #
1133 #<randquote file="randquotes.conf">
1135 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1136 # Redirect module: Adds channel redirection (mode +L)
1137 #<module name="m_redirect.so">
1139 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1140 # Regular Expression Provider for Glob or wildcard (?/*) matching.
1141 # You must have at least 1 provider loaded to use m_filter or m_rline
1142 # modules. This module has no additional requirements, as it uses the
1143 # matching already present in InspIRCd core.
1144 #<module name="m_regex_glob.so">
1146 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1147 # Regular Expression Provider for PCRE (Perl-Compatible Regular
1148 # Expressions). You need libpcre installed to compile and load this
1149 # module. You must have at least 1 provider loaded to use m_filter or
1151 #<module name="m_regex_pcre.so">
1153 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1154 # Regular Expression Provider for POSIX Regular Expressions.
1155 # You shouldn't need any additional libraries on a POSIX-compatible
1156 # system (ie: any Linux, BSD, but not Windows). You must have at least
1157 # 1 provider loaded to use m_filter or m_rline.
1158 # On POSIX-compliant systems, regex syntax can be found by using the
1159 # command: 'man 7 regex'.
1160 #<module name="m_regex_posix.so">
1162 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1163 # Regular Expression Provider for TRE Regular Expressions.
1164 # This is the same regular expression engine used by UnrealIRCd, so
1165 # if you are most familiar with the syntax of /spamfilter from there,
1166 # this is the provider you want. You need libtre installed in order
1167 # to compile and load this module.
1168 #<module name="m_regex_tre.so">
1170 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1171 # Registered users only channel creation
1172 # Allows only registered users and opers to create new channels.
1173 #<module name="m_regonlycreate.so">
1175 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1176 # Remove module: Adds the /REMOVE command which is a peaceful
1177 # alternative to /KICK
1178 #<module name="m_remove.so">
1180 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1181 # Restrict banned users module:
1182 # Disallows banned users on a channel from messaging the channel,
1183 # changing nick, or changing the topic, if loaded.
1184 #<module name="m_restrictbanned.so">
1186 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1187 # Restricted channels module: Allows only opers to create channels
1188 #<module name="m_restrictchans.so">
1190 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1191 # Restrict message module: Allows users to only message opers
1192 #<module name="m_restrictmsg.so">
1194 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1195 # Ban users through regular expression patterns
1196 #<module name="m_rline.so">
1198 #-#-#-#-#-#-#-#-#-#-#-#- RLINE CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#-#
1200 # If you wish to re-check a user when they change nickname (can be
1201 # useful under some situations, but *can* also use CPU with more users
1202 # on a server) then set the following configuration value:
1203 # Also, this is where you set what Regular Expression engine is to be
1204 # used. If you ever change it while running, all of your R-Lines will be
1205 # wiped. This is the regex engine used by all R-Lines set, and
1206 # m_regex_<engine>.so must be loaded, or rline will be nonfunctional
1207 # until you load it or change the engine to one that is loaded.
1209 #<rline matchonnickchange="yes" engine="pcre">
1211 # Generally, you will NOT want to use 'glob' here, as this turns
1212 # rline into just another gline. The exceptions are that rline will
1213 # always use the full nick!user@host realname string, rather than only
1214 # user@host, but beware that only the ? and * wildcards are available,
1215 # and are the only way to specify where the space can occur if you do
1216 # use glob. For this reason, is recommended to use a real regex engine
1217 # so that at least \s or [[:space:]] is available.
1219 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1220 # JSON-RPC module: Encode and decode JSON-RPC requests for modules
1221 #<module name="m_rpc_json.so">
1223 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1224 # RPC test module: A test of the RPC API
1225 #<module name="m_rpctest.so">
1227 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1228 # Provide /LIST throttling (to prevent flooding) and /LIST safety to
1229 # prevent excess flood when the list is large.
1230 #<module name="m_safelist.so">
1232 #-#-#-#-#-#-#-#-#-#-# SAFELIST CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#-#
1234 # When using Safelist, you may set the following values;
1236 # The first value, 'throttle', sets the amount of time in seconds a user
1237 # must wait between LIST commands. For example, if this is set to 60
1238 # (the default) then the user may not /LIST more than once a minute.
1239 # If not defined, the default value is 60 seconds.
1241 # The second value, 'maxlisters', indicates the maximum number of users
1242 # which may be retrieving a LIST at once. It is not recommended you raise
1243 # this value, as increasing it too high can make your network vulnerable
1244 # to floodbots which waste your bandwidth and CPU time with LIST requests.
1246 #<safelist throttle="60" maxlisters="50">
1248 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1249 # SAJOIN module: Adds the /SAJOIN command
1250 # This module is oper-only.
1251 # To use, SAJOIN must be in one of your oper class blocks.
1252 #<module name="m_sajoin.so">
1254 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1255 # SAMODE module: Adds the oper /SAMODE command
1256 # This module is oper-only.
1257 # To use, SAMODE must be in one of your oper class blocks.
1258 #<module name="m_samode.so">
1260 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1261 # SANICK module: Allows opers to change user's nicks
1262 # This module is oper-only.
1263 # To use, SANICK must be in one of your oper class blocks.
1264 #<module name="m_sanick.so">
1266 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1267 # SAPART module: Adds the oper /SAPART command
1268 # This module is oper-only.
1269 # To use, SAPART must be in one of your oper class blocks.
1270 #<module name="m_sapart.so">
1272 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1273 # SAQUIT module: Adds the oper /SAQUIT command (abusable!!!)
1274 # This module is oper-only.
1275 # To use, SAQUIT must be in one of your oper class blocks.
1276 #<module name="m_saquit.so">
1278 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1279 # SASL authentication module: Provides support for IRC Authentication
1280 # Layer (aka: atheme SASL) via AUTHENTICATE.
1281 #<module name="m_sasl.so">
1283 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1284 # Secure list module: Prevent /LIST in the first minute of connection,
1285 # crippling most spambots and trojan spreader bots.
1286 #<module name="m_securelist.so">
1288 #-#-#-#-#-#-#-#-#-# SECURELIST CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#-#
1290 # Securelist can be harmful to some irc search engines such as #
1291 # netsplit.de and searchirc.com. To prevent securelist blocking these #
1292 # sites from listing, define exception tags as shown below: #
1293 <securehost exception="*@*.searchirc.org">
1294 <securehost exception="*@*.netsplit.de">
1295 <securehost exception="*@echo940.server4you.de">
1297 # Define the following variable to change how long a user must wait #
1298 # before issuing a LIST. If not defined, defaults to 60 seconds. #
1300 #<securelist waittime="60"> #
1302 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1303 # Servprotect module: Provides support for Austhex style +k /
1304 # UnrealIRCD +S services mode
1305 #<module name="m_servprotect.so">
1307 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1308 # See nicks module: Allow for SNOMASK +N which shows nick changes.
1309 # This module is oper-only.
1310 #<module name="m_seenicks.so">
1312 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1313 # Set Idle module: Adds a command for opers to change their
1314 # idle time (mainly a toy)
1315 # This module is oper-only.
1316 # To use, SETIDLE must be in one of your oper class blocks.
1317 #<module name="m_setidle.so">
1319 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1320 # Services support module: Adds several usermodes such as +R and +M
1321 # this module implements the 'identified' state via user mode +r, which
1322 # is similar to the DALnet and dreamforge systems.
1325 # >> This CAN NOT be used at the same time as m_services_account <<
1327 # *** This module DOES NOT support Atheme services, please use ***
1328 # *** m_services_account if you are planning on using Atheme. ***
1329 #<module name="m_services.so">
1331 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1332 # Services support module: Adds several usermodes such as +R and +M
1333 # this module implements the 'identified' state via account names (AC)
1334 # and is similar in operation to the way asuka and ircu handle services.
1336 # Also of note is that this module implements two extbans:
1337 # +b R: (stop matching account names from joining)
1338 # +b M: (stop matching account names from speaking)
1341 # >> This CAN NOT be used at the same time as m_services <<
1343 #<module name="m_services_account.so">
1345 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1346 # Sethost module: Adds the /SETHOST command
1347 # This module is oper-only.
1348 # To use, SETHOST must be in one of your oper class blocks.
1349 # See m_chghost for how to customise valid chars for hostnames
1350 #<module name="m_sethost.so">
1352 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1353 # Setident module: Adds the /SETIDENT command
1354 # This module is oper-only.
1355 # To use, SETIDENT must be in one of your oper class blocks.
1356 #<module name="m_setident.so">
1358 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1359 # SETNAME module: Adds the /SETNAME command
1360 # This module is oper-only.
1361 # To use, SETNAME must be in one of your oper class blocks.
1362 #<module name="m_setname.so">
1364 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1365 # Serverban: Implements extended ban s:, which stops anyone connected
1366 # to a server matching a mask like +b s:server.mask.here from joining.
1367 #<module name="m_serverban.so">
1369 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1370 # Show Whois module: Adds the +W usermode which allows opers
1371 # to see when they are whois'ed (can be annoying).
1372 # This module is oper-only.
1373 #<module name="m_showwhois.so">
1375 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1376 # Shun module: Provides the /shun command, which stops a user executing
1378 # This module is oper-only.
1379 # To use, SHUN must be in one of your oper class blocks.
1380 #<module name="m_shun.so">
1382 # You may also configure which commands you wish a user to be able to
1383 # perform. It should be noted that if a shunned user issues QUIT or PART
1384 # then their message will be removed, as if they did not issue one.
1386 # You may also (optionally) let the user know that their command was blocked.
1387 #<shun enabledcommands="PING PONG QUIT PART JOIN" notifyuser="yes">
1389 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1390 # Spy module: Provides the ability to see the complete names list of
1391 # channels an oper is not a member of
1392 # This module is oper-only.
1393 #<module name="m_spy.so">
1395 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1396 # SSL channel mode module: Adds support for SSL-only channels (+z).
1397 # does not do anything useful without a working SSL module (see below)
1398 #<module name="m_sslmodes.so">
1400 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1401 # Dummy ssl module: If you have other servers on your network which
1402 # have SSL, but your server does not have ssl enabled, you should load
1403 # this module, which will handle SSL metadata (e.g. the "Is using ssl"
1404 # field in the WHOIS information).
1405 #<module name="m_ssl_dummy.so">
1407 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1408 # GnuTLS ssl module: Adds support for client-server SSL using GnuTLS,
1409 # if enabled. You must copy the source for this module from the directory
1410 # src/modules/extra, or answer 'yes' in ./configure when asked if you
1411 # want to enable this, or it will not load.
1412 #<module name="m_ssl_gnutls.so">
1414 #-#-#-#-#-#-#-#-#-#-#- GNUTLS CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#
1416 # m_ssl_gnutls.so is too complex it describe here, see the wiki: #
1417 # http://www.inspircd.org/wiki/GnuTLS_SSL_Module #
1419 # NOTE: If you want to use this module to encrypt and sign your #
1420 # server to server traffic, you MUST load it before m_spanningtree in #
1421 # your configuration file! #
1423 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1424 # SSL Info module: Allows users to retrieve information about other
1425 # user's peer SSL certificates and keys. This can be used by client
1426 # scripts to validate users. For this to work, one of m_ssl_gnutls.so
1427 # or m_ssl_openssl.so must be loaded. You must symlink the source for
1428 # this module from the directory src/modules/extra.
1429 # This modules is in extras. Re-run configure with: ./configure --enable-extras=m_sslinfo.cpp
1430 # and run make install, then uncomment this module to enable it.
1432 #<module name="m_sslinfo.so">
1434 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1435 # OpenSSL ssl module: Adds support for client-server SSL using OpenSSL,
1436 # if enabled. You must copy the source for this module from the directory
1437 # src/modules/extra, or answer 'yes' in ./configure when asked if you
1438 # want to enable this, or it will not load.
1439 #<module name="m_ssl_openssl.so">
1441 #-#-#-#-#-#-#-#-#-#-#- OPENSSL CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#
1443 # m_ssl_openssl.so is too complex it describe here, see the wiki: #
1444 # http://www.inspircd.org/wiki/OpenSSL_SSL_Module #
1446 # NOTE: If you want to use this module to encrypt and sign your #
1447 # server to server traffic, you MUST load it before m_spanningtree in #
1448 # your configuration file! #
1450 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1451 # SSL Cert Oper module: Allows opers to oper up using the key fingerprint
1452 # stored within their SSL certificate and key pair.
1453 # When using this module, one of m_ssl_gnutls.so or m_ssl_openssl.so must
1454 # be loaded. An extra value should be added to enabled opers, which
1455 # is in the following format: fingerprint="<hash>". For more information,
1456 # see the example in the oper blocks.
1457 # This module is oper-only.
1458 #<module name="m_ssl_oper_cert.so">
1460 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1461 # Strip colour module: Adds the channel mode +S
1462 #<module name="m_stripcolor.so">
1464 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1465 # SILENCE module: Adds support for /SILENCE
1466 #<module name="m_silence.so">
1468 # Configuration tags:
1470 #<silence maxentries="32">
1472 # Sets the maximum number of entries on a users silence list.
1474 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1475 # SQLite3 module: Allows other SQL modules to access SQLite3 #
1476 # databases through a unified API. You must link the source for this #
1477 # module from the directory src/modules/extra to src/modules, plus #
1478 # the file m_sqlv2.h #
1479 # This modules is in extras. Re-run configure with: ./configure --enable-extras=m_aqlite.cpp
1480 # and run make install, then uncomment this module to enable it. #
1482 #<module name="m_sqlite3.so">
1484 #-#-#-#-#-#-#-#-#-#-#-#- SQL CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#-#
1486 # m_sqlite.so is more complex than described here, see the wiki for #
1487 # more: http://www.inspircd.org/wiki/SQLite3_Service_Provider_Module #
1489 #<database hostname="/full/path/to/database.db" id="anytext">
1491 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1492 # SQLutils module: Provides some utilities to SQL client modules, such
1493 # as mapping queries to users and channels. You must copy the source
1494 # for this module from the directory src/modules/extra/m_sqlutils.cpp
1495 # and src/modules/extra/m_sqlutils.h into /src/modules
1496 # Needed for, and loaded before: SQLauth and SQLoper
1497 # This modules is in extras. Re-run configure with: ./configure --enable-extras=m_sqlutils.cpp
1498 # and run make install, then uncomment this module to enable it.
1500 #<module name="m_sqlutils.so">
1502 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1503 # SQL authentication module: Allows IRCd connections to be tied into
1504 # a database table (for example a forum). You must copy the source for
1505 # this module from the directory src/modules/extra
1506 # Depends on the SQLutils module being loaded first.
1507 # This modules is in extras. Re-run configure with: ./configure --enable-extras=m_sqlauth.cpp
1508 # and run make install, then uncomment this module to enable it.
1510 #<module name="m_sqlauth.so">
1512 #-#-#-#-#-#-#-#-#-#-#- SQLAUTH CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#
1514 # m_sqlauth.so is too complex it describe here, see the wiki: #
1515 # http://www.inspircd.org/wiki/SQL_Authentication_Module #
1517 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1518 # SQL logging module: Allows you to log network-wide data for your
1519 # network in a fully normalised set of SQL tables. You must copy the
1520 # source for this module from the directory src/modules/extra
1521 # This modules is in extras. Re-run configure with: ./configure --enable-extras=m_sqllog.cpp
1522 # and run make install, then uncomment this module to enable it.
1524 #<module name="m_sqllog.so">
1526 #-#-#-#-#-#-#-#-#-#-#- SQLLOG CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#
1528 # dbid - Database ID to use (see m_sql) #
1530 # See also: http://www.inspircd.org/wiki/SQL_Logging_Module #
1534 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1535 # SQL oper module: Allows you to store oper credentials in an SQL table
1536 # You must copy the source for this module from the directory src/modules/extra
1537 # Depends on the SQLutils module being loaded first.
1538 # This modules is in extras. Re-run configure with: ./configure --enable-extras=m_sqloper.cpp
1539 # and run make install, then uncomment this module to enable it.
1541 #<module name="m_sqloper.so">
1543 #-#-#-#-#-#-#-#-#-#-#- SQLOPER CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#
1545 # dbid - Database ID to use (see m_sql) #
1546 # hash - Hashing provider to use for password hashing #
1548 # See also: http://www.inspircd.org/wiki/SQL_Oper_Storage_Module #
1550 #<sqloper dbid="1" hash="md5">
1552 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1553 # SVSHold module: Implements SVSHOLD. Like Q:Lines, but can only be #
1554 # added/removed by Services. #
1555 #<module name="m_svshold.so">
1557 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1558 # SWHOIS module: Allows you to add arbitary lines to user WHOIS.
1559 # This module is oper-only.
1560 # To use, SWHOIS must be in one of your oper class blocks.
1561 #<module name="m_swhois.so">
1563 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1564 # Taxonomy module: Adds the /TAXONOMY command, used to view all
1565 # metadata attached to a user.
1566 # This module is oper-only.
1567 # To use, TAXONOMY must be in one of your oper class blocks.
1568 #<module name="m_taxonomy.so">
1570 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1571 # Test command module: Does nothing significant. Read: pointless.
1572 #<module name="m_testcommand.so">
1574 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1575 # Timed bans module: Adds timed bans and the /TBAN command
1576 # This module is oper-only.
1577 # To use, TBAN must be in one of your oper class blocks.
1578 #<module name="m_timedbans.so">
1580 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1581 # Test line module: Adds the /TLINE command, used to test how many
1582 # users a /GLINE or /ZLINE etc would match.
1583 # This module is oper-only.
1584 # To use, TLINE must be in one of your oper class blocks.
1585 #<module name="m_tline.so">
1587 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1588 # UHNAMES support module: Adds support for the IRCX style UHNAMES
1589 # extension, which displays ident and hostname in the names list for
1590 # each user, saving clients from doing a WHO on the channel. Note that
1591 # this module is not widely supported yet. If a client does not support
1592 # UHNAMES it will not enable it, this will not break incompatible
1594 #<module name="m_uhnames.so">
1596 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1597 # Uninvite module: Adds the /UNINVITE command which lets users remove
1598 # pending invites from channels without waiting for the user to join.
1599 #<module name="m_uninvite.so">
1601 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1602 # Userip module: Adds the /USERIP command
1603 # This module is oper-only.
1604 # To use, USERIP must be in one of your oper class blocks.
1605 #<module name="m_userip.so">
1607 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1608 # Vhost module: Adds the VHOST command which allows for adding virtual
1609 # hosts which are accessible using a username and password in the config.
1610 #<module name="m_vhost.so">
1612 #-#-#-#-#-#-#-#-#-#-#- VHOST CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#-#
1614 # user - Username for the vhost. #
1616 # pass - Password for the vhost. #
1618 # host - Vhost to set. #
1620 #<vhost user="some_username" pass="some_password" host="some.host">
1622 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1623 # Watch module: Adds the WATCH command, which is used by clients to
1624 # maintain notify lists.
1625 #<module name="m_watch.so">
1627 # Configuration tags:
1629 #<watch maxentries="32">
1631 # Sets the maximum number of entries on a user's watch list.
1633 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1634 # XLine database: Stores all *Lines (G/Z/K/R/any added by other modules)
1635 # in a file "xline.db" which can be re-loaded on restart. This is useful
1636 # for two reasons: it keeps bans so users may not evade them, and on
1637 # bigger networks, server connections will take less time as there will
1638 # be a lot less bans to apply - as most of them will already be there.
1639 #<module name="m_xline_db.so">
1641 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1642 # ZipLinks module: Adds support for zlib deflate on server to server
1643 # connections. Both ends of the connection must load this module.
1644 # This modules is in extras. Re-run configure with: ./configure --enable-extras=m_ziplink.cpp
1645 # and run make install, then uncomment this module to enable it.
1647 #<module name="m_ziplink.so">
1649 # To use this module, you must enable it as a transport type in your
1650 # <link> tags or <bind> tags using the transport name 'zip'.
1651 # See the documentation of <link> and <bind>, respectively.
projects / user / henk / code / inspircd.git / blob