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://wiki.inspircd.org/Modules for a list of modules and #
14 # each modules link for any additional conf tags they require. #
16 # ____ _ _____ _ _ ____ _ _ _ #
17 # | _ \ ___ __ _ __| | |_ _| |__ (_)___ | __ )(_) |_| | #
18 # | |_) / _ \/ _` |/ _` | | | | '_ \| / __| | _ \| | __| | #
19 # | _ < __/ (_| | (_| | | | | | | | \__ \ | |_) | | |_|_| #
20 # |_| \_\___|\__,_|\__,_| |_| |_| |_|_|___/ |____/|_|\__(_) #
22 # To link servers to InspIRCd, you MUST load the m_spanningtree #
23 # module. If you don't do this, server links will NOT work at all. #
24 # This is by design, to allow for the implementation of other linking #
25 # protocols in modules in the future. #
28 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
29 # MD5 Module - Allows other modules to generate MD5 hashes, usually for
30 # cryptographic uses and security.
33 # Other modules such as m_cloaking.so and m_password_hash.so may rely on
34 # this module being loaded to function.
36 #<module name="m_md5.so">
38 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
39 # SHA256 Module - Allows other modules to generate SHA256 hashes,
40 # usually for cryptographic uses and security.
43 # Other modules such as m_password_hash.so may rely on this module being
44 # loaded to function. Certain modules such as m_spanningtree.so will
45 # function without this module but when it is loaded their features will
46 # be enhanced (for example the addition of HMAC authentication).
48 #<module name="m_sha256.so">
49 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
50 # RIPEMD160 Module - Allows other modules to generate RIPEMD160 hashes,
51 # usually for cryptographic uses and security.
54 # Other modules may rely on this module being loaded to function.
55 #<module name="m_ripemd160.so">
57 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
58 # Abbreviation module: Provides the ability to abbreviate commands a-la
60 #<module name="m_abbreviation.so">
62 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
63 # Alias module: Allows you to define server-side command aliases
64 #<module name="m_alias.so">
68 #<fantasy prefix="!" allowbots="no">
71 # Set the prefix for in-channel aliases (fantasy commands) to the
72 # specified character. If not set, the default is "!".
74 # If this is set to no, +B clients will not be able to use fantasy
75 # commands. If not set, the default is no.
77 #-#-#-#-#-#-#-#-#-#-#- ALIAS DEFINITIONS -#-#-#-#-#-#-#-#-#-#-#-#-#-#
79 # If you have the m_alias.so module loaded, you may also define #
80 # aliases as shown below. They are commonly used to provide shortcut #
81 # commands to services, however they are not limited to just this use.#
82 # An alias tag requires the following values to be defined in it: #
84 # text - The text to detect as the actual command line, #
85 # Cant contain spaces, but case insensitive. #
86 # You may have multiple aliases with the same #
87 # command name (text="" value), however the first #
88 # found will be executed if its format value is #
89 # matched, or it has no format value. Aliases are #
90 # read from the top of the file to the bottom. #
92 # usercommand - If this is true, the alias can be run simply as #
93 # /aliasname. Defaults to true. #
95 # channelcommand - If this is true, the alias can be used as an #
96 # in-channel alias or 'fantasy command', prefixed #
97 # by the fantasy prefix character, !aliasname by #
98 # default. Defaults to false. #
100 # format - If this is defined, the parameters of the alias #
101 # must match this glob pattern. For example if you #
102 # want the first parameter to start with a # for #
103 # the alias to be executed, set format="#*" in the #
104 # alias definition. Note that the :'s which are #
105 # part of IRC formatted lines will be preserved #
106 # for matching of this text. This value is #
109 # replace - The text to replace 'text' with. Usually this #
110 # will be "PRIVMSG ServiceName :$2-" or similar. #
111 # You may use the variables $1 through $9 in the #
112 # replace string, which refer to the first through #
113 # ninth word in the original string typed by the #
114 # user. You may also use $1- through $9- which #
115 # refer to the first word onwards, through to the #
116 # ninth word onwards, e.g. if the user types the #
117 # command "foo bar baz qux quz" then $3- will hold #
118 # "baz qux quz" and $2 will contain "bar". You may #
119 # also use the special variables: $nick, $ident, #
120 # $host and $vhost, and you may separate multiple #
121 # commands with a newline (which can be written in #
122 # the file literally, or encoded as &nl; or \n #
123 # depending on the config format setting). #
125 # requires - If you provide a value for 'requires' this means #
126 # the given nickname MUST be online for the alias #
127 # to successfully trigger. If they are not, then #
128 # the user receives a 'no such nick' 401 numeric. #
130 # uline - Defining this value with 'yes', 'true' or '1' #
131 # will ensure that the user given in 'requires' #
132 # must also be on a u-lined server, as well as #
133 # actually being on the network. If the user is #
134 # online, but not on a u-lined server, then an #
135 # oper-alert is sent out as this is possibly signs #
136 # of a user trying to impersonate a service. #
138 # operonly - Defining this value, with a value of 'yes', '1' #
139 # or true will make the alias oper only. If a non- #
140 # oper attempts to use the alias, it will appear #
143 #<alias text="NICKSERV" replace="PRIVMSG NickServ :$2-" requires="NickServ" uline="yes">
144 #<alias text="CHANSERV" replace="PRIVMSG ChanServ :$2-" requires="ChanServ" uline="yes">
145 #<alias text="OPERSERV" replace="PRIVMSG OperServ :$2-" requires="OperServ" uline="yes" operonly="yes">
146 #<alias text="BOTSERV" replace="PRIVMSG BotServ :$2-" requires="BotServ" uline="yes">
147 #<alias text="HOSTSERV" replace="PRIVMSG HostServ :$2-" requires="HostServ" uline="yes">
148 #<alias text="MEMOSERV" replace="PRIVMSG MemoServ :$2-" requires="MemoServ" uline="yes">
149 #<alias text="NS" replace="PRIVMSG NickServ :$2-" requires="NickServ" uline="yes">
150 #<alias text="CS" replace="PRIVMSG ChanServ :$2-" requires="ChanServ" uline="yes">
151 #<alias text="OS" replace="PRIVMSG OperServ :$2-" requires="OperServ" uline="yes" operonly="yes">
152 #<alias text="BS" replace="PRIVMSG BotServ :$2-" requires="BotServ" uline="yes">
153 #<alias text="HS" replace="PRIVMSG HostServ :$2-" requires="HostServ" uline="yes">
154 #<alias text="MS" replace="PRIVMSG MemoServ :$2-" requires="MemoServ" uline="yes">
156 # An example of using the format value to create an alias with two
157 # different behaviours depending on the format of the parameters.
159 #<alias text="ID" format="#*" replace="PRIVMSG ChanServ :IDENTIFY $2 $3"
160 # requires="ChanServ" uline="yes">
162 #<alias text="ID" replace="PRIVMSG NickServ :IDENTIFY $2"
163 # requires="NickServ" uline="yes">
165 # This alias fixes a glitch in xchat 2.6.x and above and the way it
166 # assumes IDENTIFY must be prefixed by a colon (:) character. It should
167 # be placed ABOVE the default NICKSERV alias (the first example) listed
170 #<alias text="NICKSERV" format=":IDENTIFY *" replace="PRIVMSG NickServ :IDENTIFY $3-"
171 # requires="NickServ" uline="yes">
173 # You may also add aliases to trigger based on something said in a
174 # channel, aka 'fantasy' commands, configured in the same manner as any
175 # other alias, with usercommand="no" and channelcommand="yes" The
176 # command must be preceded by the fantasy prefix when used.
178 #<alias text="CS" usercommand="no" channelcommand="yes"
179 # replace="PRIVMSG ChanServ :$1 $chan $2-" requires="ChanServ" uline="yes">
181 # This would be used as "!cs <command> <options>", with the channel
182 # being automatically inserted after the command in the message to
183 # ChanServ, assuming the fantasy prefix is "!".
185 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
186 # Allowinvite module: Gives channel mode +A to allow all users to use
187 # /invite, and extban A to deny invite from specific masks
188 #<module name="m_allowinvite.so">
190 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
191 # Alltime module: Shows time on all connected servers at once.
192 # This module is oper-only and provides /alltime.
193 # To use, ALLTIME must be in one of your oper class blocks.
194 #<module name="m_alltime.so">
196 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
197 # Auditorium module: Adds channel mode +u which makes everyone else
198 # except you in the channel invisible, used for large meetings etc.
199 #<module name="m_auditorium.so">
201 # Auditorium settings:
203 #<auditorium opvisible="no" opcansee="no" opercansee="yes">
205 # opvisible (auditorium-vis in exemptchanops):
206 # Show channel ops to all users
207 # opcansee (auditorium-see in exemptchanops):
208 # Allow ops to see all joins/parts/kicks in the channel
210 # Allow opers (channels/auspex) to see see all joins/parts/kicks in the channel
212 # Exemptchanops can be used to adjust the level at which users become visible or
213 # the level at which they can see the full member list of the channel.
215 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
216 # Autoop module: Adds basic channel access controls via the +w listmode.
217 # For example, +w o:R:Brain will op anyone identified to the account "Brain"
219 #<module name="m_autoop.so">
221 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
222 # Ban except module: Adds support for channel ban exceptions (+e)
223 #<module name="m_banexception.so">
225 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
226 # Ban redirection module: Allows bans which redirect to a specified
227 # channel. e.g. +b nick!ident@host#channelbanneduserissentto
228 #<module name="m_banredirect.so">
230 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
231 # Block amsg module: Attempt to block all usage of /amsg and /ame
232 #<module name="m_blockamsg.so">
234 #-#-#-#-#-#-#-#-#-#-#- BLOCKAMSG CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
236 # If you have the m_blockamsg.so module loaded, you can configure it #
237 # with the <blockamsg> tag: #
239 # delay - How many seconds between two messages to force #
240 # them to be recognised as unrelated. #
241 # action - Any of 'notice', 'noticeopers', 'silent', 'kill' #
242 # or 'killopers'. Define how to take action when #
243 # a user uses /amsg or /ame. #
245 #<blockamsg delay="3" action="killopers">
247 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
248 # Block CAPS module: Blocking all-CAPS messages with cmode +B
249 #<module name="m_blockcaps.so">
251 #-#-#-#-#-#-#-#-#-#-#- BLOCKCAPS CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
253 # percent - How many percent of text must be caps before text #
256 # minlen - The minimum length a line must be for the block #
257 # percent to have any effect. #
259 # capsmap - A list of chars to be considered CAPS, this was #
260 # you can add CAPS for your language. Also you can #
261 # add things like ! and space to further lock down #
263 #<blockcaps percent="50"
265 # capsmap="ABCDEFGHIJKLMNOPQRSTUVWXYZ! ">
267 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
268 # Block color module: Blocking color-coded messages with chan mode +c
269 #<module name="m_blockcolor.so">
271 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
272 # Botmode module: Adds the user mode +B
273 #<module name="m_botmode.so">
275 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
276 # CallerID module: Adds usermode +g which activates hybrid-style
277 # callerid: block all private messages unless you /accept first
278 #<module name="m_callerid.so">
280 #-#-#-#-#-#-#-#-#-#-#- CALLERID CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#
281 # maxaccepts - Maximum number of entires a user can add to his #
282 # /accept list. Default is 16 entries. #
283 # operoverride - Can opers (note: ALL opers) ignore callerid mode? #
285 # tracknick - Preserve /accept entries when a user changes nick? #
286 # If no (the default), the user is removed from #
287 # everyone's accept list if he changes nickname. #
288 # cooldown - Amount of time (in seconds) that must pass since #
289 # the last notification sent to a user before he can #
290 # be sent another. Default is 60 (1 minute). #
291 #<callerid maxaccepts="16"
296 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
297 # CAP module: Provides the CAP negotiation mechanism seen in
298 # ratbox-derived ircds
299 #<module name="m_cap.so">
301 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
302 # CBAN module: Lets you disallow channels from being used at runtime.
303 # This module is oper-only and provides /cban.
304 # To use, CBAN must be in one of your oper class blocks.
305 #<module name="m_cban.so">
307 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
308 # Censor module: Adds channel and user mode +G
309 #<module name="m_censor.so">
311 #-#-#-#-#-#-#-#-#-#-#- CENSOR CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#
313 # Optional - If you specify to use the m_censor module, then you must #
314 # specify some censor tags. See also: #
315 # http://wiki.inspircd.org/Modules/censor #
317 #<include file="examples/censor.conf.example">
319 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
320 # CGI:IRC module: Adds support for automatic host changing in CGI:IRC
321 # (http://cgiirc.sourceforge.net).
322 #<module name="m_cgiirc.so">
324 #-#-#-#-#-#-#-#-#-#-#-# CGIIRC CONFIGURATION #-#-#-#-#-#-#-#-#-#-#-#-#
326 # Optional - If you specify to use m_cgiirc, then you must specify one
327 # or more cgihost tags which indicate authorised CGI:IRC servers which
328 # will be connecting to your network, and an optional cgiirc tag.
329 # For more information see: http://wiki.inspircd.org/Modules/cgiirc
331 # Set to yes if you want to notice opers when CGI clients connect
332 # <cgiirc opernotice="no">
334 # The type field indicates where the module should get the real
335 # client's IP address from, for further information, please see the
336 # CGI:IRC documentation.
339 # <cgihost type="pass" mask="www.mysite.com"> # Get IP from PASS
340 # <cgihost type="ident" mask="otherbox.mysite.com"> # Get IP from ident
341 # <cgihost type="passfirst" mask="www.mysite.com"> # See the docs
343 # <cgihost type="webirc" password="foobar"
344 # mask="somebox.mysite.com"> # Get IP from WEBIRC
349 # When you connect CGI:IRC clients, there are two connect classes which
350 # apply to these clients. When the client initially connects, the connect
351 # class which matches the cgi:irc site's host is checked. Therefore you
352 # must raise the maximum local/global clients for this ip as high as you
353 # want to allow cgi clients. After the client has connected and is
354 # determined to be a cgi:irc client, the class which matches the client's
355 # real IP is then checked. You may set this class to a lower value, so that
356 # the real IP of the client can still be restricted to, for example, 3
361 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
362 # Channel create module: Adds snomask +j, which will notify opers of
363 # any new channels that are created.
364 # This module is oper-only.
365 #<module name="m_chancreate.so">
367 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
368 # Channel filter module: Allows channel-op defined message
369 # filtering using simple string matches (channel mode +g)
370 #<module name="m_chanfilter.so">
372 # If hidemask is set to yes, the user will not be shown the mask when
373 # his/her message is blocked.
374 #<chanfilter hidemask="yes">
376 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
377 # Channel History module: Displays the last 'X' lines of chat to a user
378 # joining a channel with +H 'X:T' set; 'T' is the maximum time to keep
379 # lines in the history buffer. Designed so that the new user knows what
380 # the current topic of conversation is when joining the channel.
381 #<module name="m_chanhistory.so">
383 # Set the maximum number of lines allowed to be stored per channel below.
384 # This is the hard limit for 'X'.
385 # If notice is set to yes, joining users will get a NOTICE before playback
386 # telling them about the following lines being the pre-join history.
387 # If bots is set to yes, it will also send to users marked with +B
388 #<chanhistory maxlines="20" notice="yes" bots="yes">
390 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
391 # Channel logging module: used to send snotice output to channels, to
392 # allow staff to centrally monitor and discuss network activity.
394 # The "channel" field is where you want the messages to go, "snomasks"
395 # is what snomasks you want to be sent to that channel. Multiple tags
397 #<module name="m_chanlog.so">
398 #<chanlog snomasks="AOcC" channel="#opers">
400 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
401 # Channel Names module: Allows disabling channels which have certain
402 # characters in the channel name such as bold, colorcodes, etc. which
403 # can be quite annoying and allow users to on occasion have a channel
404 # that looks like the name of another channel on the network.
405 #<module name="m_channames.so">
408 # denyrange: characters or range of characters to deny in channel
412 # allowrange: characters or range of characters to specifically allow
416 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
417 # Channelban: Implements extended ban j:, which stops anyone in already
418 # in a channel matching a mask like +b j:#channel*mask from joining.
419 #<module name="m_channelban.so">
421 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
422 # Check module: gives /check
423 # Check is useful for looking up information on channels,
424 # users, IP addresses and hosts.
425 # This module is oper-only.
426 # To use, CHECK must be in one of your oper class blocks.
427 #<module name="m_check.so">
429 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
430 # CHGHOST module: Adds the /CHGHOST command
431 # This module is oper-only.
432 # To use, CHGHOST must be in one of your oper class blocks.
433 # NOTE: Services will not be able to set vhosts on users if this module
434 # isn't loaded. If you're planning on running services, you probably
436 #<module name="m_chghost.so">
438 #-#-#-#-#-#-#-#-# /CHGHOST - /SETHOST CONFIGURATION #-#-#-#-#-#-#-#-#
439 # Optional - If you want to use special chars for hostnames you can #
440 # specify your own custom list of chars with the <hostname> tag: #
442 # charmap - A list of chars accepted as valid by the /CHGHOST #
443 # and /SETHOST commands. Also note that the list is #
445 #<hostname charmap="abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ.-_/0123456789">
447 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
448 # CHGIDENT module: Adds the /CHGIDENT command
449 # This module is oper-only.
450 # To use, CHGIDENT must be in one of your oper class blocks.
451 #<module name="m_chgident.so">
453 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
454 # CHGNAME module: Adds the /CHGNAME command
455 # This module is oper-only.
456 # To use, CHGNAME must be in one of your oper class blocks.
457 #<module name="m_chgname.so">
459 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
460 # Cloaking module: Adds usermode +x and cloaking support.
461 # Relies on the module m_md5.so being loaded.
462 # To use, you should enable m_conn_umodes and add +x as
463 # an enabled mode. See the m_conn_umodes module for more information.
464 #<module name="m_cloaking.so">
466 #-#-#-#-#-#-#-#-#-#-#- CLOAKING CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#
468 # To use m_cloaking, you must define a cloak key, and optionally a #
469 # cloak prefix as shown below. The cloak key must be shared across #
470 # the network for correct cloaking. #
472 # There are two methods of cloaking: #
474 # half Cloak only the "unique" portion of a host; show #
475 # the last 2 parts of the domain, /16 subnet of IPv4 #
476 # or /48 subnet of the IPv6 address. #
478 # full Cloak the users completely, using three slices for #
479 # common CIDR bans (IPv4: /16, /24; IPv6: /48, /64) #
481 # The methods use a single key that can be any length of text. #
482 # An optional prefix may be specified to mark cloaked hosts. #
483 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
489 #-#-#-#-#-#-#-#-#-#-#-#- CLOSE MODULE #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
490 # Close module: Allows an oper to close all unregistered connections.
491 # This module is oper-only and provides /close.
492 # To use, CLOSE must be in one of your oper class blocks.
493 #<module name="m_close.so">
495 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
496 # Clones module: Adds an oper command /CLONES for detecting cloned
497 # users. Warning: This command may be resource intensive when it is
498 # issued, use with care.
499 # This module is oper-only.
500 # To use, CLONES must be in one of your oper class blocks.
501 #<module name="m_clones.so">
503 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
504 # Common channels module: Adds user mode +c, which, when set, requires
505 # that users must share a common channel with you to PRIVMSG or NOTICE
507 #<module name="m_commonchans.so">
509 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
510 # Conn-Join: Allows you to force users to join one or more channels
511 # automatically upon connecting to the server.
512 #<module name="m_conn_join.so">
514 #-#-#-#-#-#-#-#-#-#-#-#- CONNJOIN CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
516 # If you have m_conn_join.so loaded, you can configure it using the
519 #<autojoin channel="#one,#two,#three">
521 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
522 # Conn-Usermodes: Set modes on users when they connect
523 # When this module is loaded <connect:allow> tags may have an optional
524 # modes="" value, which contains modes to add or remove from users
525 # when they connect to the server.
526 #<module name="m_conn_umodes.so">
528 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
529 # Conn-Wait-for-Pong: Don't let a user connect until they PONG
530 #<module name="m_conn_waitpong.so">
532 #-#-#-#-#-#-#-#-#-#-#- WAITPONG CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
534 # If you have the m_conn_waitpong.so module loaded, configure it with #
535 # the <waitpong> tag: #
537 # sendsnotice - Whether to send a snotice on connect, like other #
540 # killonbadreply - Whether to kill the user if they send the wrong #
543 #<waitpong sendsnotice="yes" killonbadreply="yes">
546 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
547 # Channel cycle module. Server side /hop, with +ilk etc. bypass.
548 #<module name="m_cycle.so">
550 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
551 # Connectban: Provides IP connection throttling. Any IP range that connects
552 # too many times (configurable) in an hour is zlined for a (configurable)
553 # duration, and their count resets to 0.
555 # ipv4cidr and ipv6cidr allow you to turn the comparison from individual
556 # IP addresses (32 and 128 bits) into CIDR masks, to allow for throttling
557 # over whole ISPs/blocks of IPs, which may be needed to prevent attacks.
559 #<connectban threshold="10" duration="10m" ipv4cidr="32" ipv6cidr="128">
560 # This allows for 10 connections in an hour with a 10 minute ban if that is exceeded.
562 #<module name="m_connectban.so">
564 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
565 # Connection throttle module. Configuration:
566 #<module name="m_connflood.so">
568 #-#-#-#-#-#-#-#-#-#-#- CONNTHROTTLE CONFIGURATION -#-#-#-#-#-#-#-#-#-#
569 # seconds, maxconns - Amount of connections per <seconds>.
571 # timeout - Time to wait after the throttle was activated
572 # before deactivating it. Be aware that the time
573 # is seconds + timeout.
575 # quitmsg - The message that users get if they attempt to
576 # connect while the throttle is active.
578 # bootwait - Amount of time in seconds to wait before enforcing
579 # the throttling when the server just booted.
581 #<connflood seconds="30" maxconns="3" timeout="30"
582 # quitmsg="Throttled" bootwait="10">
584 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
585 # Custom prefixes: allows for channel prefixes to be added.
586 #<module name="m_customprefix.so">
588 # name The name of the mode, must be unique from other modes
589 # letter The letter used for this mode. Required.
590 # prefix The prefix used for nicks with this mode. Not required.
591 # rank A numeric rank for this prefix, defining what permissions it gives
592 # VOICE_VALUE is 10000, HALFOP_VALUE is 20000, OP_VALUE is 30000
593 # ranktoset The numeric rank required to set/unset this mode. Defaults to rank.
594 # depriv Can you remove the mode from yourself? Defaults to yes.
595 #<customprefix name="founder" letter="q" prefix="~" rank="50000" ranktoset="50000">
596 #<customprefix name="admin" letter="a" prefix="&" rank="40000" ranktoset="50000">
597 #<customprefix name="halfop" letter="h" prefix="%" rank="20000" ranktoset="30000">
598 #<customprefix name="halfvoice" letter="V" prefix="-" rank="1" ranktoset="20000">
600 # Do /reloadmodule m_customprefix.so after changing the settings of this module.
602 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
603 # Custom title module: Adds the /TITLE command which allows for trusted
604 # users to gain a custom whois line and a optional
605 # vhost can be specified.
606 #<module name="m_customtitle.so">
608 #-#-#-#-#-#-#-#-#-#- CUSTOM TITLE CONFIGURATION -#-#-#-#-#-#-#-#-#-#
609 # name - The username used to identify
610 # password - The password used to identify
611 # hash - The hash for the specific user's password (optional)
612 # m_password_hash.so and a hashing module must be loaded for this to work
613 # host - Allowed hostmask [optional]
614 # title - Title shown in whois
615 # vhost - Displayed host [optional]
617 #<title name="foo" password="bar" title="Official Chat Helper">
618 #<title name="bar" password="foo" host="ident@host.name" title="Official Chat Helper" vhost="helper.network.chat">
619 #<title name="foo" password="fcde2b2edba56bf408601fb721fe9b5c338d10ee429ea04fae5511b68fbf8fb9" hash="sha256" title="Official Chat Helper">
621 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
622 # DCCALLOW module: Adds the /DCCALLOW command
623 #<module name="m_dccallow.so">
625 #-#-#-#-#-#-#-#-#-#-#- DCCALLOW CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
626 # blockchat - Whether to block DCC CHAT as well as DCC SEND
627 # length - Default duration of entries in DCCALLOW list
628 # action - Default action to take if no action is specified
629 # can be 'block' or 'allow'
631 # File configuration:
632 # pattern - The glob pattern to match against
633 # action - Action to take if a user attempts to send a file
634 # that matches this pattern, can be 'block' or 'allow'
636 #<dccallow blockchat="yes" length="5m" action="block">
637 #<banfile pattern="*.exe" action="block">
638 #<banfile pattern="*.txt" action="allow">
640 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
642 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
643 # Deaf module: adds support for ircu style usermode +d - deaf to
644 # channel messages and channel notices.
645 #<module name="m_deaf.so">
647 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
648 # Delay join module: Adds the channel mode +D which delays all JOIN
649 # messages from users until they speak. If they quit or part before
650 # speaking, their quit or part message will not be shown to the channel
651 # which helps cut down noise on large channels in a more friendly way
652 # than the auditorium mode. Only channel ops may set the +D mode.
653 #<module name="m_delayjoin.so">
655 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
656 # Delay message module: Adds the channel mode +d which disallows a user
657 # from talking in the channel unless they've been joined for X seconds.
658 # Settable a la: /mode +d 30
659 #<module name="m_delaymsg.so">
661 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
662 # Deny Channels: Deny Channels from being used by users
663 #<module name="m_denychans.so">
665 #-#-#-#-#-#-#-#-#-#-#- DENYCHAN DEFINITIONS -#-#-#-#-#-#-#-#-#-#-#-#
667 # If you have the m_denychans.so module loaded, you need to specify #
668 # the channels to deny: #
670 # name - The channel name to deny. (glob masks are ok) #
672 # allowopers - If operators are allowed to override the deny. #
674 # reason - Reason given for the deny. #
676 # redirect - Redirect the user to a different channel #
678 #<badchan name="#gods*" allowopers="yes" reason="Tortoises!"> #
679 #<badchan name="#heaven" redirect="#hell" reason="Nice try!"> #
681 # Redirects will not work if the target channel is set +L. #
683 # Additionally, you may specify channels which are allowed, even if #
684 # a badchan tag specifies it would be denied: #
685 #<goodchan name="#godsleeps"> #
686 # Glob masks are accepted here also.
688 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
689 # Devoice Module: Let users devoice themselves using /devoice #chan.
690 #<module name="m_devoice.so">
692 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
693 # DNS Blacklist Module: Provides support for looking up IPs on one or #
695 #<module name="m_dnsbl.so"> #
697 # For configuration options please see the wiki page for m_dnsbl at #
698 # http://wiki.inspircd.org/Modules/dnsbl #
700 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
701 # Exempt Channel Operators Module: Provides support for allowing #
702 # channel operators to be exempt from some channel modes. Supported #
703 # modes are blockcaps, noctcp, blockcolor, nickflood, flood, censor, #
704 # filter, regmoderated, nonick, nonotice, and stripcolor. #
705 #<module name="m_exemptchanops.so"> #
707 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
708 # Filter module: Provides message filtering, similar to SPAMFILTER.
709 #<module name="m_filter.so">
711 # This module depends upon a regex provider such as m_regex_pcre or #
712 # m_regex_glob to function. You must specify which of these you want #
713 # m_filter to use via the tag below. #
715 # Valid engines are: #
717 # glob - Glob patterns, provided via m_regex_glob.so #
718 # pcre - PCRE regexps, provided via m_regex_pcre.so, needs libpcre #
719 # tre - TRE regexps, provided via m_regex_tre.so, requires libtre #
720 # posix - POSIX regexps, provided via m_regex_posix.so, not availale #
721 # on windows, no dependencies on other operating systems. #
723 #<filteropts engine="glob"> #
725 # Your choice of regex engine must match on all servers network-wide.
727 # You may specify specific channels that are exempt from being filtered:
728 #<exemptfromfilter channel="#blah">
730 #-#-#-#-#-#-#-#-#-#-#- FILTER CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#
732 # Optional - If you specify to use the m_filter module, then #
733 # specfiy below the path to the filter.conf file, or define some #
736 #<include file="examples/filter.conf.example">
738 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
739 # Flash Policy Daemon module: Allows Flash IRC clients (e.g. LightIRC)#
740 # to connect. If no file is specified, it'll serve a default policy #
741 # allowing all IPs to connect to all plaintext IRC ports #
742 #<bind address="" port="8430" type="flashpolicyd"> #
743 #<flashpolicyd timeout="5" file=""> #
744 #<module name="m_flashpolicyd.so"> #
746 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
747 # Gecosban: Implements extended ban r:, which stops anyone matching
748 # a mask like +b r:*realname?here* from joining a channel.
749 #<module name="m_gecosban.so">
751 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
752 # GeoIP module: Allows the server admin to match users by country code.
753 # This modules is in extras. Re-run configure with: ./configure --enable-extras=m_geoip.cpp
754 # and run make install, then uncomment this module to enable it.
755 # This module requires GeoIP to be installed on your system,
756 # use your package manager to find the appropriate packages
757 # or check the InspIRCd wiki page for this module.
758 #<module name="m_geoip.so">
760 # The actual allow/ban actions are done by connect classes, not by the
761 # GeoIP module. An example connect class to ban people from russia or
764 # <connect deny="*" geoip="TR,RU">
766 # The country code must be in capitals and should be an ISO country
767 # code such as TR, GB, or US. Unknown IPs (localhost, LAN IPs, etc)
768 # will be assigned the country code "UNK". Since connect classes are
769 # matched from top down, your deny classes must be above your allow
770 # classes for them to match.
772 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
773 # Globops module: gives /GLOBOPS and SNOMASK +g
774 # This module is oper-only.
775 # To use, GLOBOPS must be in one of your oper class blocks.
776 #<module name="m_globops.so">
778 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
779 # Global load module: Allows loading and unloading of modules network-
780 # wide (USE WITH EXTREME CAUTION!)
781 # This module is oper-only and provides /gloadmodule, /gunloadmodule
782 # and /greloadmodule.
783 # To use, GLOADMODULE, GUNLOADMODULE and GRELOADMODULE
784 # must be in one of your oper class blocks.
785 #<module name="m_globalload.so">
787 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
788 # HELPOP module: Provides the /HELPOP command
789 #<module name="m_helpop.so">
791 #-#-#-#-#-#-#-#-#-#-#-#- HELPOP CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
793 # Optional - If you specify to use the m_helpop.so module, then #
794 # specify below the path to the helpop.conf file, or if you like to #
795 # make a mess, define your helpop tags in this conf. #
797 #<include file="examples/inspircd.helpop-full.example">
799 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
800 # HIDECHANS module: Allows users to hide their channels list from non-
801 # opers by setting user mode +I on themselves.
802 #<module name="m_hidechans.so">
804 # HIDECHANS can optionally prevent opers from seeing channels on a +I
805 # user, for more privacy if set to true.
806 # This setting is not recommended for most mainstream networks.
807 #<hidechans affectsopers="false">
809 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
810 # HIDEOPER module: Allows opers to hide their oper status from non-
811 # opers by setting user mode +H on themselves.
812 # This module is oper-only.
813 #<module name="m_hideoper.so">
815 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
816 # Hostchange module: Allows a different style of cloaking
817 #<module name="m_hostchange.so">
819 #-#-#-#-#-#-#-#-#-#-#- HOSTCHANGE CONFIGURATION -#-#-#-#-#-#-#-#-#-#
821 # Optional - If you choose to use the m_hostchange.so module. #
822 # Config Help - See http://wiki.inspircd.org/Modules/hostchange #
824 #<host suffix="polarbears.org" separator="." prefix="">
825 #<hostchange mask="*@fbi.gov" action="addnick">
826 #<hostchange mask="*r00t@*" action="suffix">
827 #<hostchange mask="a@b.com" action="set" value="blah.blah.blah">
828 #<hostchange mask="localhost" ports="7000,7001,7005-7007" action="set" value="blahblah.foo">
830 # hostcycle: If loaded, when a user gets a host or ident set, it will
831 # cycle them in all their channels. If not loaded it will simply change
832 # their host/ident without cycling them.
833 #<module name="m_hostcycle.so">
835 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
836 # httpd module: Provides http server support for InspIRCd
837 #<module name="m_httpd.so">
839 #-#-#-#-#-#-#-#-#-#-#-#- HTTPD CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
841 # If you choose to use the m_httpd.so module, then you will need to add
842 # a <bind> tag with type "httpd", and load at least one of the other
843 # m_httpd_* modules to provide pages to display.
846 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
847 # http ACL module: Provides access control lists for m_httpd dependent
848 # modules. Use this module to restrict pages by IP address and by
851 #<module name="m_httpd_acl.so">
853 #-#-#-#-#-#-#-#-#-#-#-#- HTTPD ACL CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
855 # Restrict access to the m_httpd_stats module to all but the local
856 # network and when the correct password is specified:
858 # <httpdacl path="/stats*" types="password,whitelist"
859 # username="secretstuff" password="mypasshere" whitelist="127.0.0.*,10.*">
861 # Deny all connections to all but the main index page:
863 # <httpdacl path="/*" types="blacklist" blacklist="*">
866 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
867 # http config module: Allows the server's configuration to be viewed
868 # over HTTP. Requires m_httpd.so to be loaded for it to function.
869 #<module name="m_httpd_config.so">
871 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
872 # http stats module: Provides basic stats pages over HTTP
873 # Requires m_httpd.so to be loaded for it to function.
874 #<module name="m_httpd_stats.so">
876 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
877 # Ident: Provides RFC 1413 ident lookup support
878 # When this module is loaded <connect:allow> tags may have an optional
879 # useident="yes|no" boolean value, determining whether or not to lookup
880 # ident on users matching that connect tag.
881 #<module name="m_ident.so">
883 #-#-#-#-#-#-#-#-#-#-#-#- IDENT CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
885 # Optional - If you are using the m_ident.so module, then you can #
886 # specify the timeout for ident lookups here. If not defined, it will #
887 # default to one second. This is a non-blocking timeout which holds #
888 # the user in a 'connecting' state until the lookup is complete. #
889 # The bind value indicates which IP to bind outbound requests to. #
893 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
894 # Invite except module: Adds support for channel invite exceptions (+I)
895 #<module name="m_inviteexception.so">
896 # Does a +I bypass channel +k in addition to +i?
897 #<inviteexception bypasskey="yes">
899 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
900 # IRCv3 module: Provides the following IRCv3.1 extensions:
901 # extended-join, away-notify and account-notify. These are optional
902 # enhancements to the client-to-server protocol. An extension is only
903 # active for a client when the client specifically requests it, so this
904 # module needs m_cap to work.
906 # Further information on these extensions can be found at the IRCv3
907 # working group website:
908 # http://ircv3.atheme.org/extensions/
910 #<module name="m_ircv3.so">
911 # The following block can be used to control which extensions are
913 #<ircv3 accountnotify="on" awaynotify="on" extendedjoin="on">
915 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
916 # Join flood module: Adds support for join flood protection (+j)
917 #<module name="m_joinflood.so">
919 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
920 # Jump Server module: Adds support for the RPL_REDIR numeric
921 # This module is oper-only.
922 # To use, JUMPSERVER must be in one of your oper class blocks.
923 # If your server is redirecting new clients and you get disconnected,
924 # do a REHASH from shell to open up again.
925 #<module name="m_jumpserver.so">
927 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
928 # Anti-Auto-Rejoin: Adds support for prevention of auto-rejoin (+J)
929 #<module name="m_kicknorejoin.so">
931 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
932 # Knock module: adds the /KNOCK command and +K channel mode
933 #<module name="m_knock.so">
934 # This setting specifes what to do when someone successfully /KNOCKs.
935 # If set to "notice", then a NOTICE will be sent to the channel.
936 # This is the default and the compatible setting, as it requires no
937 # special support from the clients.
938 # If set to "numeric" then a 710 numeric will be sent to the channel.
939 # This allows easier scripting but not all clients support it.
940 # If set to "both" then (surprise!) both will be sent.
941 #<knock notify="notice">
943 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
944 # LDAP module: Allows other SQL modules to access a LDAP database
945 # through a unified API.
946 # This modules is in extras. Re-run configure with: ./configure --enable-extras=m_ldap.cpp
947 # and run make install, then uncomment this module to enable it.
949 #<module name="m_ldap.so">
950 #<database module="ldap" id="ldapdb" server="ldap://localhost" binddn="cn=Manager,dc=inspircd,dc=org" bindauth="mysecretpass" searchscope="subtree">
951 # The server parameter indicates the LDAP server to connect to. The #
952 # ldap:// style scheme before the hostname proper is MANDATORY. #
954 # The binddn and bindauth indicate the DN to bind to for searching, #
955 # and the password for the distinguished name. Some LDAP servers will #
956 # allow anonymous searching in which case these two values do not #
957 # need defining, otherwise they should be set similar to the examples #
960 # The searchscope value indicates the subtree to search under. On our #
961 # test system this is 'subtree'. Your mileage may vary. #
963 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
964 # LDAP authentication module: Adds the ability to authenticate users #
967 #<module name="m_ldapauth.so"> #
971 # <ldapauth dbid="ldapdb" #
972 # baserdn="ou=People,dc=brainbox,dc=cc" #
974 # allowpattern="Guest*" #
975 # killreason="Access denied" #
977 # host="$uid.$ou.inspircd.org"> #
979 # <ldapwhitelist cidr="10.42.0.0/16"> #
981 # <ldaprequire attribute="attr" value="val"> #
983 # The baserdn indicates the base DN to search in for users. Usually #
984 # this is 'ou=People,dc=yourdomain,dc=yourtld'. #
986 # The attribute value indicates the attribute which is used to locate #
987 # a user account by name. On POSIX systems this is usually 'uid'. #
989 # The allowpattern value allows you to specify a wildcard mask which #
990 # will always be allowed to connect regardless of if they have an #
991 # account, for example guest users. #
993 # Killreason indicates the QUIT reason to give to users if they fail #
996 # Setting the verbose value causes an oper notice to be sent out for #
997 # every failed authentication to the server, with an error string. #
999 # ldapwhitelist indicates that clients connecting from an IP in the #
1000 # provided CIDR do not need to authenticate against LDAP. It can be #
1001 # repeated to whitelist multiple CIDRs. #
1003 # ldaprequire allows further filtering on the LDAP user, by requiring #
1004 # certain LDAP attibutes to have a given value. It can be repeated, #
1005 # in which case the list will act as an OR list, that is, the #
1006 # authentication will succeed if any of the requirements in the list #
1009 # host allows you to change the displayed host of users connecting #
1010 # from ldap. The string supplied takes formatters which are replaced #
1011 # from the DN. For instance, if your DN looks like: #
1012 # uid=w00t,ou=people,dc=inspircd,dc=org, then the formatters uid, ou #
1013 # and dc will be available to you. If a key is given multiple times #
1014 # in the DN, the last appearance will take precedence. #
1016 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1017 # LDAP oper configuration module: Adds the ability to authenticate #
1020 #<module name="m_ldapoper.so">
1024 # <ldapoper dbid="ldapdb"
1025 # baserdn="ou=People,dc=brainbox,dc=cc"
1028 # Available configuration items are identical to the same items in #
1029 # m_ldapauth above (except for the verbose setting, that is only #
1030 # supported in m_ldapauth). #
1031 # Please always specify a password in your <oper> tags even if the #
1032 # opers are to be authenticated via LDAP, so in case this module is #
1033 # not loaded the oper accounts are still protected by a password. #
1035 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1036 # Lock server module: Adds /LOCKSERV and /UNLOCKSERV commands that is #
1037 # used to temporarily close/open for new connections to the server. #
1038 # These commands require OPER status and that the LOCKSERV UNLOCKSERV #
1039 # are specified in a <class> tag that the oper is part of. This is so #
1040 # you can control who has access to this possible dangerous command. #
1041 # If your server is locked and you get disconnected, do a REHASH from #
1042 # shell to open up again. #
1044 # This module is oper-only.
1046 #<module name="m_lockserv.so">
1048 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1049 # Map hiding module: replaces /MAP and /LINKS output to users with a #
1050 # message to see a website, set by maphide="http://link.to/site" in #
1051 # the <security> tag, instead. #
1052 #<module name="m_maphide.so">
1054 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1055 # Msg flood module: Adds message/notice flood protection (+f)
1056 #<module name="m_messageflood.so">
1058 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1059 # MLOCK module: Adds support for server-side enforcement of services
1060 # side MLOCKs. Basically, this module suppresses any mode change that
1061 # would likely be immediately bounced by services.
1062 #<module name="m_mlock.so">
1064 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1065 # Modenotice module: Adds the /MODENOTICE command that allows opers to
1066 # send notices to all users having the given user mode(s) set.
1067 #<module name="m_modenotice.so">
1069 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1070 # MsSQL module: Allows other SQL modules to access MS SQL Server
1071 # through a unified API.
1072 # This modules is in extras. Re-run configure with: ./configure --enable-extras=m_mssql.cpp
1073 # and run make install, then uncomment this module to enable it.
1075 #<module name="m_mssql.so">
1077 #-#-#-#-#-#-#-#-#-#-#-#- SQL CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#-#
1079 # m_mssql.so is more complex than described here, see wiki for more #
1080 # info http://wiki.inspircd.org/Modules/mssql #
1082 #<database module="mssql" name="db" user="user" pass="pass" host="localhost" id="db1">
1084 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1085 # MySQL module: Allows other SQL modules to access MySQL databases
1086 # through a unified API.
1087 # This modules is in extras. Re-run configure with: ./configure --enable-extras=m_mysql.cpp
1088 # and run make install, then uncomment this module to enable it.
1090 #<module name="m_mysql.so">
1092 #-#-#-#-#-#-#-#-#-#-#-#- SQL CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#-#
1094 # m_mysql.so is more complex than described here, see the wiki for #
1095 # more: http://wiki.inspircd.org/Modules/mysql #
1097 #<database module="mysql" name="mydb" user="myuser" pass="mypass" host="localhost" id="my_database2">
1099 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1100 # Named Modes module: This module allows for the display and set/unset
1101 # of channel settings and modes via long-form mode names in channels with
1102 # channelmode +Z set. For example, to set a channelban with named modes:
1103 # /mode #channel +Z ban=foo!bar@baz . Currently this doesn't serve much
1104 # purpose outside of making channel administration a bit easier in some
1105 # cases, but eventually modules will start using named modes only because
1106 # we're running out of channelmodes. :D
1107 #<module name="m_namedmodes.so">
1109 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1110 # NAMESX module: Provides support for the NAMESX extension which allows
1111 # clients to see all the prefixes set on a user without getting confused.
1112 # This is supported by mIRC, x-chat, klient, and maybe more.
1113 #<module name="m_namesx.so">
1115 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1116 # National characters module:
1117 # 1) Allows using national characters in nicknames.
1118 # 2) Allows using custom (national) casemapping over the network.
1119 # file -- filename of existing file in "locales" directory
1120 # casemapping -- custom value for 005 numeric (if you want it to be
1121 # different from the filename.
1123 #<nationalchars file="bynets/russian-w1251-charlink" casemapping="ru_RU.cp1251-charlink">
1124 #<module name="m_nationalchars.so">
1126 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1127 # Nickchange flood protection module: Allows up to X nick changes in Y seconds.
1128 # Provides channel mode +F.
1129 #<module name="m_nickflood.so">
1131 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1132 # Nicklock module: Let opers change a user's nick and then stop that
1133 # user from changing their nick again.
1134 # This module is oper-only.
1135 # To use, NICKLOCK and NICKUNLOCK must be in one of your oper class blocks.
1136 #<module name="m_nicklock.so">
1138 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1139 # No ctcp module: Adds the channel mode +C to block CTCPs and extban C
1140 # to block CTCPs sent by specific users.
1141 #<module name="m_noctcp.so">
1143 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1144 # No kicks module: Adds the +Q channel mode and the Q: extban to deny
1145 # certain users from kicking.
1146 #<module name="m_nokicks.so">
1148 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1149 # No nicks module: Adds the +N channel mode, as well as the N extban.
1150 # +N stops all users from changing their nick, the N extban stops
1151 # anyone from matching a +b N:nick!user@host mask from changing their
1153 #<module name="m_nonicks.so">
1155 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1156 # No part message module: adds extban 'p' to block part messages from #
1158 #<module name="m_nopartmsg.so">
1160 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1161 # No Notice module: adds the channel mode +T and the extban T to block
1162 # specific users from noticing the channel.
1163 #<module name="m_nonotice.so">
1165 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1166 # Network business join module
1167 # Allows an oper to join a channel using /OJOIN, giving them +Y on the
1168 # channel which makes them immune to kick/deop/etc.
1169 #<module name="m_ojoin.so">
1171 #<ojoin prefix="!" notice="yes" op="yes">
1172 # Specify the prefix that +Y will grant here
1173 # Leave prefix empty if you do not wish +Y to grant a prefix
1174 # If notice is set to on, upon ojoin, the server will notice
1175 # the channel saying that the oper is joining on network business
1176 # If op is set to on, it will give them +o along with +Y
1179 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1180 # Oper channels mode: Adds the +O channel mode and +beI type O:<mask>
1181 # to ban, exempt, and invex given oper type masks.
1182 # e.g, /mode #channel +iI O:* is equivilant to chmode +O, but you
1183 # may also, e.g. /mode #channel +iI O:AdminTypeOnly to only allow admins.
1184 # +be work in a similar fashion.
1186 #<module name="m_operchans.so">
1188 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1189 # Oper Join module: Auto-joins opers to a channel upon oper-up
1190 # This module is oper-only. For the user equivalent, see m_conn_join.
1191 #<module name="m_operjoin.so">
1193 #-#-#-#-#-#-#-#-#-#-# OPERJOIN CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
1195 # If you are using the m_operjoin.so module, specify options here: #
1197 # channel - The channel name to join, can also be a comma #
1198 # separated list eg. "#channel1,#channel2". #
1200 # override - Lets the oper join walking thru any modes that #
1201 # might be set, even bans. Use "yes" or "no". #
1203 #<operjoin channel="#channel" override="no">
1205 # Alternatively you can use the autojoin="channellist" in a <type> #
1206 # tag to set specific autojoins for a type of oper, for example: #
1208 #<type name="Helper" autojoin="#help" classes="...">
1210 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1211 # Oper log module: Logs all oper commands to the ircd log at default
1212 # loglevel, and optionally to the 'r' SNOMASK.
1213 # This module is oper-only.
1214 #<module name="m_operlog.so">
1216 # If the following option is on then all oper commands will be sent to
1217 # the snomask 'r'. The default is off.
1218 #<operlog tosnomask="off">
1220 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1221 # Oper prefixing module: Gives IRC operators a prefix status character
1222 # on all channels they are in.
1224 #<module name="m_operprefix.so">
1226 # You may additionally customise the prefix character.
1227 #<operprefix prefix="!">
1229 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1230 # Oper MOTD module: Provides support for separate message of the day
1232 # This module is oper-only.
1233 #<module name="m_opermotd.so">
1235 #-#-#-#-#-#-#-#-#-#-# OPERMOTD CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
1237 # If you are using the m_opermotd.so module, specify the motd here #
1239 # onoper - Should the message be sent on /OPER or only when #
1240 # /OPERMOTD is used. Use "yes" or "no". #
1242 # processcolors - Allow color codes to be processed in the opermotd. #
1243 # Read the comment above <connect:allowmotdcolors> in #
1244 # inspircd.conf.example for details. #
1246 #<opermotd file="examples/opermotd.txt.example" onoper="yes" processcolors="false">
1248 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1249 # Override module: Adds support for oper override
1250 # This module is oper-only.
1251 #<module name="m_override.so">
1253 #-#-#-#-#-#-#-#-#-#-# OVERRIDE CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
1255 # m_override.so is too complex it describe here, see the wiki: #
1256 # http://wiki.inspircd.org/Modules/override #
1258 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1259 # Oper levels module: Gives each oper a level and prevents
1260 # actions being taken against higher level opers
1261 # Specify the level as the 'level' parameter of the <type> tag
1262 # This module is oper-only.
1263 #<module name="m_operlevels.so">
1265 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1266 # Oper modes module: Allows you to specify modes to add/remove on oper
1267 # Specify the modes as the 'modes' parameter of the <type> tag
1268 # and/or as the 'modes' parameter of the <oper> tag.
1269 # This module is oper-only. For the user equivalent, see m_conn_umodes
1270 #<module name="m_opermodes.so">
1272 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1273 # Password forwarding module: Forwards a password users can send on connect
1274 # to the specified client below. The client is usually nickserv and this
1275 # module is usually used to authenticate users with nickserv using their
1277 #<module name="m_passforward.so">
1280 # nick: nick to forward connect passwords to.
1283 # forwardmsg: Message to send to users using a connect password.
1284 # $nick will be the users' nick, $nickrequired will be the nick
1285 # of where the password is going (the nick above).
1286 # You can also use $user for the user ident string.
1287 forwardmsg="NOTICE $nick :*** Forwarding PASS to $nickrequired"
1289 # cmd: Command for the nick to run when it receives a connect
1291 cmd="PRIVMSG $nickrequired :IDENTIFY $pass">
1293 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1294 # Password hash module: Allows hashed passwords to be used.
1295 # To be useful, a hashing module like m_sha256.so also needs to be loaded.
1297 #<module name="m_password_hash.so">
1299 #-#-#-#-#-#-#-#-#-# PASSWORD HASH CONFIGURATION #-#-#-#-#-#-#-#-#-#-#-#
1301 # To use this module, you must define a hash type for each oper's
1302 # password you want to hash. For example:
1304 # <oper name="Brain"
1305 # host="ident@dialup15.isp.com"
1307 # password="01ba4719c80b6fe911b091a7c05124b64eeece964e09c058ef8f9805daca546b"
1310 # Starting from 2.0, you can use a more secure salted hash that prevents simply
1311 # looking up the hash's value in a rainbow table built for the hash.
1312 # hash="hmac-sha256" password="lkS1Nbtp$CyLd/WPQXizsbxFUTqFRoMvaC+zhOULEeZaQkUJj+Gg"
1314 # Generate hashes using the /MKPASSWD command on the server. Don't run it on a
1315 # server you don't trust with your password.
1317 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1318 # Permanent Channels module: Channels with the permanent channels mode
1319 # will remain open even after everyone else has left the channel, and
1320 # therefore keep things like modes, ban lists and topic. Permanent
1321 # channels -may- need support from your Services package to function
1322 # properly with them. This adds channel mode +P.
1323 # This module is oper-only.
1324 #<module name="m_permchannels.so">
1326 # If you like, m_permchannels can write a config file of permanent channels
1327 # whenever +P is set, unset, or the topic/modes on a +P channel is changed.
1328 # If you want to do this, set the filename below, and uncomment the include.
1330 # If 'listmodes' is true then all list modes (+b, +I, +e, +g...) will be
1331 # saved. Defaults to false.
1332 #<permchanneldb filename="data/permchannels.conf" listmodes="true">
1333 #<include file="data/permchannels.conf">
1335 # You may also create channels on startup by using the <permchannels> block.
1336 # Don't forget to set them +P in the modes, or they won't stay permanent.
1337 #<permchannels channel="#opers" modes="isP" topic="Opers only.">
1339 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1340 # PostgreSQL module: Allows other SQL modules to access PgSQL databases
1341 # through a unified API.
1342 # This modules is in extras. Re-run configure with: ./configure --enable-extras=m_pgsql.cpp
1343 # and run make install, then uncomment this module to enable it.
1345 #<module name="m_pgsql.so">
1347 #-#-#-#-#-#-#-#-#-#-#-#- SQL CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#-#
1349 # m_pgsql.so is more complex than described here, see the wiki for #
1350 # more: http://wiki.inspircd.org/Modules/pgsql #
1352 #<database module="pgsql" name="mydb" user="myuser" pass="mypass" host="localhost" id="my_database" ssl="no">
1354 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1355 # Muteban: Implements extended ban m:, which stops anyone matching
1356 # a mask like +b m:nick!user@host from speaking on channel.
1357 #<module name="m_muteban.so">
1360 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1361 # Random Quote module: provides a random quote on connect.
1362 # NOTE: Some of these may mimic fatal errors and confuse users and
1363 # opers alike! - BEWARE!
1364 #<module name="m_randquote.so">
1366 #-#-#-#-#-#-#-#-#-#- RANDOMQUOTES CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
1368 # Optional - If you specify to use the m_randquote.so module, then #
1369 # specify below the path to the randquotes.conf file. #
1371 #<randquote file="quotes.txt">
1373 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1374 # Redirect module: Adds channel redirection (mode +L) #
1375 # Optional: <redirect:antiredirect> to add usermode +L to stop forced #
1376 # redirection and instead print an error. #
1378 # Note: You can not update this with a simple rehash, it requires #
1379 # reloading the module for it to take effect. #
1380 # This also breaks linking to servers that do not have the option. #
1381 # This defaults to false for the 2.0 version, it will be enabled in #
1382 # all the future versions. #
1383 #<module name="m_redirect.so">
1384 #<redirect antiredirect="true">
1386 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1387 # Regular Expression Provider for Glob or wildcard (?/*) matching.
1388 # You must have at least 1 provider loaded to use m_filter or m_rline
1389 # modules. This module has no additional requirements, as it uses the
1390 # matching already present in InspIRCd core.
1391 #<module name="m_regex_glob.so">
1393 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1394 # Regular Expression Provider for PCRE (Perl-Compatible Regular
1395 # Expressions). You need libpcre installed to compile and load this
1396 # module. You must have at least 1 provider loaded to use m_filter or
1398 #<module name="m_regex_pcre.so">
1400 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1401 # Regular Expression Provider for RE2 Regular Expressions.
1402 # You need libre2 installed and in your include/library paths in order
1403 # to compile and load this module.
1404 #<module name="m_regex_re2.so">
1406 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1407 # Regular Expression Provider for POSIX Regular Expressions.
1408 # You shouldn't need any additional libraries on a POSIX-compatible
1409 # system (i.e.: any Linux, BSD, but not Windows). You must have at
1410 # least 1 provider loaded to use m_filter or m_rline.
1411 # On POSIX-compliant systems, regex syntax can be found by using the
1412 # command: 'man 7 regex'.
1413 #<module name="m_regex_posix.so">
1415 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1416 # Regular Expression Provider for C++11 std::regex Regular Expressions.
1417 # This module works on any fully compliant implementation of the C++11
1418 # std::regex container. Examples for such are Visual C++ 2010 and newer
1419 # but not libstdc++ (which GCC uses)
1420 # You should verify that std::regex is supported by your setup before
1421 # using this module, as it may compile normally but won't do anything
1422 # on some implementations.
1423 #<module name="m_regex_stdlib.so">
1425 # Specify the Regular Expression engine to use here. Valid settings are
1426 # bre, ere, awk, grep, egrep, ecmascript (default if not specified)
1427 #<stdregex type="ecmascript">
1429 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1430 # Regular Expression Provider for TRE Regular Expressions.
1431 # This is the same regular expression engine used by UnrealIRCd, so
1432 # if you are most familiar with the syntax of /spamfilter from there,
1433 # this is the provider you want. You need libtre installed in order
1434 # to compile and load this module.
1435 #<module name="m_regex_tre.so">
1437 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1438 # Registered users only channel creation
1439 # Allows only registered users and opers to create new channels.
1441 # You probably *DO NOT* want to load this module on a public network.
1443 #<module name="m_regonlycreate.so">
1445 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1446 # Remove module: Adds the /REMOVE command which is a peaceful
1447 # alternative to /KICK
1448 #<module name="m_remove.so">
1450 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1451 # A module to block, kick or ban upon similiar messages being uttered several times.
1452 # Syntax [~*][lines]:[sec]{[:difference]}{[:matchlines]}
1453 # ~ is to block, * is to ban, default is kick.
1454 # lines - In mode 1 the amount of lines that has to match consecutively - In mode 2 the size of the backlog to keep for matching
1455 # seconds - How old the message has to be before it's invalidated.
1456 # distance - Edit distance, in percent, between two strings to trigger on.
1457 # matchlines - When set, the function goes into mode 2. In this mode the function will trigger if this many of the last <lines> matches.
1459 # As this module can be rather CPU-intensive, it comes with some options.
1460 # maxbacklog - Maximum size that can be specified for backlog. 0 disables multiline matching.
1461 # maxdistance - Max percentage of difference between two lines we'll allow to match. Set to 0 to disable edit-distance matching.
1462 # maxlines - Max lines of backlog to match against.
1463 # maxsecs - Maximum value of seconds a user can set. 0 to allow any.
1464 # size - Maximum number of characters to check for, can be used to truncate messages
1465 # before they are checked, resulting in less CPU usage. Increasing this beyond 512
1466 # doesn't have any effect, as the maximum length of a message on IRC cannot exceed that.
1467 #<repeat maxbacklog="20" maxlines="20" maxdistance="50" maxsecs="0" size="512">
1468 #<module name="m_repeat.so">
1470 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1471 # Restricted channels module: Allows only opers to create channels.
1473 # You probably *DO NOT* want to load this module on a public network.
1475 #<module name="m_restrictchans.so">
1477 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1478 # Restrict message module: Allows users to only message opers.
1480 # You probably *DO NOT* want to load this module on a public network.
1482 #<module name="m_restrictmsg.so">
1484 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1485 # Ban users through regular expression patterns
1486 #<module name="m_rline.so">
1488 #-#-#-#-#-#-#-#-#-#-#-#- RLINE CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#-#
1490 # If you wish to re-check a user when they change nickname (can be
1491 # useful under some situations, but *can* also use CPU with more users
1492 # on a server) then set the following configuration value:
1493 # Also, this is where you set what Regular Expression engine is to be
1494 # used. If you ever change it while running, all of your R-Lines will be
1495 # wiped. This is the regex engine used by all R-Lines set, and
1496 # m_regex_<engine>.so must be loaded, or rline will be nonfunctional
1497 # until you load it or change the engine to one that is loaded.
1499 #<rline matchonnickchange="yes" engine="pcre">
1501 # Generally, you will NOT want to use 'glob' here, as this turns
1502 # rline into just another gline. The exceptions are that rline will
1503 # always use the full nick!user@host realname string, rather than only
1504 # user@host, but beware that only the ? and * wildcards are available,
1505 # and are the only way to specify where the space can occur if you do
1506 # use glob. For this reason, is recommended to use a real regex engine
1507 # so that at least \s or [[:space:]] is available.
1509 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1510 # RMODE module: Adds the /RMODE command
1511 # Allows channel mods to remove list modes en masse.
1512 # Syntax: /rmode <channel> <mode> [pattern]
1513 # E.g. '/rmode #Channel b m:*' will remove all mute-extbans on the channel.
1514 #<module name="m_rmode.so">
1516 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1517 # SAJOIN module: Adds the /SAJOIN command
1518 # This module is oper-only.
1519 # To use, SAJOIN must be in one of your oper class blocks.
1520 #<module name="m_sajoin.so">
1522 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1523 # SAKICK module: Adds the /SAKICK command
1524 # This module is oper-only.
1525 # To use, SAKICK must be in one of your oper class blocks.
1526 #<module name="m_sakick.so">
1528 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1529 # SAMODE module: Adds the oper /SAMODE command
1530 # This module is oper-only.
1531 # To use, SAMODE must be in one of your oper class blocks.
1532 #<module name="m_samode.so">
1534 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1535 # SANICK module: Allows opers to change user's nicks
1536 # This module is oper-only.
1537 # To use, SANICK must be in one of your oper class blocks.
1538 #<module name="m_sanick.so">
1540 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1541 # SAPART module: Adds the oper /SAPART command
1542 # This module is oper-only.
1543 # To use, SAPART must be in one of your oper class blocks.
1544 #<module name="m_sapart.so">
1546 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1547 # SAQUIT module: Adds the oper /SAQUIT command (abusable!!!)
1548 # This module is oper-only.
1549 # To use, SAQUIT must be in one of your oper class blocks.
1550 #<module name="m_saquit.so">
1552 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1553 # SATOPIC module: Adds the oper /SATOPIC command
1554 # This module is oper-only.
1555 # To use, SATOPIC must be in one of your oper class blocks.
1556 #<module name="m_satopic.so">
1558 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1559 # SASL authentication module: Provides support for IRC Authentication
1560 # Layer (aka: atheme SASL) via AUTHENTICATE.
1561 #<module name="m_sasl.so">
1563 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1564 # Secure list module: Prevent /LIST in the first minute of connection,
1565 # crippling most spambots and trojan spreader bots.
1566 #<module name="m_securelist.so">
1568 #-#-#-#-#-#-#-#-#-# SECURELIST CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#-#
1570 # Securelist can be harmful to some irc search engines such as #
1571 # netsplit.de and searchirc.com. To prevent securelist blocking these #
1572 # sites from listing, define exception tags as shown below: #
1573 <securehost exception="*@*.searchirc.org">
1574 <securehost exception="*@*.netsplit.de">
1575 <securehost exception="*@echo940.server4you.de">
1576 <securehost exception="*@*.ircdriven.com">
1578 # Define the following variable to change how long a user must wait #
1579 # before issuing a LIST. If not defined, defaults to 60 seconds. #
1581 #<securelist waittime="60"> #
1583 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1584 # Servprotect module: Provides support for Austhex style +k /
1585 # UnrealIRCD +S services mode
1586 #<module name="m_servprotect.so">
1588 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1589 # See nicks module: Allow for SNOMASK +N which shows nick changes.
1590 # This module is oper-only.
1591 #<module name="m_seenicks.so">
1593 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1594 # Set Idle module: Adds a command for opers to change their
1595 # idle time (mainly a toy)
1596 # This module is oper-only.
1597 # To use, SETIDLE must be in one of your oper class blocks.
1598 #<module name="m_setidle.so">
1600 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1601 # Services support module: Adds several usermodes such as +R and +M
1602 # this module implements the 'identified' state via account names (AC)
1603 # and is similar in operation to the way asuka and ircu handle services.
1605 # At the same time, this offers +r for users and channels to mark them
1606 # as identified separately from the idea of a master account, which
1607 # can be useful for services which are heavily nick-as-account centric.
1609 # This replaces m_services from 1.1 and earlier.
1611 # Also of note is that this module implements three extbans:
1612 # +b R: (stop matching account names from joining)
1613 # +b M: (stop matching account names from speaking)
1614 # +b U:n!u@h (blocks matching unregistered users)
1616 #<module name="m_services_account.so">
1618 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1619 # Sethost module: Adds the /SETHOST command
1620 # This module is oper-only.
1621 # To use, SETHOST must be in one of your oper class blocks.
1622 # See m_chghost for how to customise valid chars for hostnames
1623 #<module name="m_sethost.so">
1625 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1626 # Setident module: Adds the /SETIDENT command
1627 # This module is oper-only.
1628 # To use, SETIDENT must be in one of your oper class blocks.
1629 #<module name="m_setident.so">
1631 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1632 # SETNAME module: Adds the /SETNAME command
1633 #<module name="m_setname.so">
1635 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1636 # Serverban: Implements extended ban s:, which stops anyone connected
1637 # to a server matching a mask like +b s:server.mask.here from joining.
1638 #<module name="m_serverban.so">
1640 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1641 # Showfile: Provides support for showing a text file to users when #
1642 # they enter a command. #
1643 # This module adds one command for each <showfile> tag that shows the #
1644 # given file to the user as a series of messages or numerics. #
1645 #<module name="m_showfile.so"> #
1647 #-#-#-#-#-#-#-#-#-#-# SHOWFILE CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#-#
1649 # name - The name of the command which displays this file. This is #
1650 # the only mandatory setting, all others are optional. #
1651 # file - The text file to be shown to the user. #
1652 # By default same as the command name. #
1653 # method - How should the file be shown? #
1654 # * numeric: Send contents using a numeric #
1655 # (similiar to /MOTD; the default). #
1656 # * notice: Send contents as a series of notices. #
1657 # * msg: Send contents as a series of private messages. #
1658 # colors - If true, color codes (\c, \b, \u, etc.) will be processed #
1659 # and sent as ANSI colors. If false (default) the file will #
1660 # be displayed as-is. #
1662 # When using the method "numeric", the following extra settings are #
1665 # introtext - Introductory line, "Showing <name>" by default. #
1666 # intronumeric - Numeric used for the introductory line. #
1667 # numeric - Numeric used for sending the text itself. #
1668 # endtext - Ending line, "End of <name>" by default. #
1669 # endnumeric - Numeric used for the ending line. #
1671 #<showfile name="RULES"
1674 # introtext="Server rules:"
1675 # endtext="End of server rules.">
1677 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1678 # Show Whois module: Adds the +W usermode which allows opers
1679 # to see when they are whois'ed (can be annoying).
1680 # This module is oper-only.
1681 #<module name="m_showwhois.so">
1683 # If you wish, you may also let users set this mode. Only opers with the
1684 # users/auspex priv will see real hosts of people, though.
1685 #<showwhois opersonly="yes"
1687 # You may also set whether or not users should receive whois notices, should
1688 # they be /whois'd by an oper.
1689 # showfromopers="yes">
1691 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1692 # Shun module: Provides the /SHUN command, which stops a user from
1693 # executing all except configured commands.
1694 # This module is oper-only.
1695 # To use, SHUN must be in one of your oper class blocks.
1696 #<module name="m_shun.so">
1698 # You may also configure which commands you wish a user to be able to
1699 # perform. It should be noted that if a shunned user issues QUIT or PART
1700 # then their message will be removed, as if they did not issue one.
1702 # You can (optionally) let the user know that their command was blocked.
1704 # You may also let SHUN affect opers (defaults to no).
1705 #<shun enabledcommands="PING PONG QUIT PART JOIN" notifyuser="yes" affectopers="no">
1707 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1708 # SSL channel mode module: Adds support for SSL-only channels (+z).
1709 # does not do anything useful without a working SSL module (see below)
1710 #<module name="m_sslmodes.so">
1712 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1713 # GnuTLS SSL module: Adds support for SSL connections using GnuTLS,
1714 # if enabled. You must answer 'yes' in ./configure when asked or
1715 # manually symlink the source for this module from the directory
1716 # src/modules/extra, if you want to enable this, or it will not load.
1717 #<module name="m_ssl_gnutls.so">
1719 #-#-#-#-#-#-#-#-#-#-#- GNUTLS CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#
1721 # m_ssl_gnutls.so is too complex it describe here, see the wiki: #
1722 # http://wiki.inspircd.org/Modules/ssl_gnutls #
1724 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1725 # SSL Info module: Allows users to retrieve information about other
1726 # user's peer SSL certificates and keys. This can be used by client
1727 # scripts to validate users. For this to work, one of m_ssl_gnutls.so
1728 # or m_ssl_openssl.so must be loaded. This module also adds the
1729 # "* <user> is using a secure connection" whois line, the ability for
1730 # opers to use SSL fingerprints to verify their identity and the ability
1731 # to force opers to use SSL connections in order to oper up.
1732 # It is highly recommended to load this module especially if
1733 # you use SSL on your network.
1734 # For how to use the oper features, please see the first example <oper> tag
1735 # in opers.conf.example.
1737 #<module name="m_sslinfo.so">
1739 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1740 # OpenSSL SSL module: Adds support for SSL connections using OpenSSL,
1741 # if enabled. You must answer 'yes' in ./configure when asked or symlink
1742 # the source for this module from the directory src/modules/extra, if
1743 # you want to enable this, or it will not load.
1744 #<module name="m_ssl_openssl.so">
1746 #-#-#-#-#-#-#-#-#-#-#- OPENSSL CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#
1748 # m_ssl_openssl.so is too complex it describe here, see the wiki: #
1749 # http://wiki.inspircd.org/Modules/ssl_openssl #
1751 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1752 # Strip color module: Adds the channel mode +S
1753 #<module name="m_stripcolor.so">
1755 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1756 # SILENCE module: Adds support for /SILENCE
1757 #<module name="m_silence.so">
1759 # Configuration tags:
1761 #<silence maxentries="32">
1763 # Sets the maximum number of entries on a users silence list.
1765 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1766 # SQLite3 module: Allows other SQL modules to access SQLite3 #
1767 # databases through a unified API.
1768 # This modules is in extras. Re-run configure with: ./configure --enable-extras=m_sqlite.cpp
1769 # and run make install, then uncomment this module to enable it. #
1771 #<module name="m_sqlite3.so">
1773 #-#-#-#-#-#-#-#-#-#-#-#- SQL CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#-#
1775 # m_sqlite.so is more complex than described here, see the wiki for #
1776 # more: http://wiki.inspircd.org/Modules/sqlite3 #
1778 #<database module="sqlite" hostname="/full/path/to/database.db" id="anytext">
1780 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1781 # SQL authentication module: Allows IRCd connections to be tied into
1782 # a database table (for example a forum).
1783 # This modules is in extras. Re-run configure with: ./configure --enable-extras=m_sqlauth.cpp
1784 # and run make install, then uncomment this module to enable it.
1786 #<module name="m_sqlauth.so">
1788 #-#-#-#-#-#-#-#-#-#-#- SQLAUTH CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#
1790 # m_sqlauth.so is too complex it describe here, see the wiki: #
1791 # http://wiki.inspircd.org/Modules/sqlauth #
1793 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1794 # SQL oper module: Allows you to store oper credentials in an SQL table
1795 # This modules is in extras. Re-run configure with: ./configure --enable-extras=m_sqloper.cpp
1796 # and run make install, then uncomment this module to enable it.
1798 #<module name="m_sqloper.so">
1800 #-#-#-#-#-#-#-#-#-#-#- SQLOPER CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#
1802 # dbid - Database ID to use (see m_sql) #
1803 # hash - Hashing provider to use for password hashing #
1805 # See also: http://wiki.inspircd.org/Modules/sqloper #
1807 #<sqloper dbid="1" hash="md5">
1809 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1810 # StartTLS module: Implements STARTTLS, which allows clients #
1811 # connected to non SSL enabled ports to enable SSL, if a proper SSL #
1812 # module is loaded (either m_ssl_gnutls or m_ssl_openssl). #
1813 #<module name="m_starttls.so">
1815 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1816 # SVSHold module: Implements SVSHOLD. Like Q:Lines, but can only be #
1817 # added/removed by Services. #
1818 #<module name="m_svshold.so">
1820 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1821 # SWHOIS module: Allows you to add arbitary lines to user WHOIS.
1822 # This module is oper-only.
1823 # To use, SWHOIS must be in one of your oper class blocks.
1824 #<module name="m_swhois.so">
1826 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1827 # Test module: enable this to create a command useful in testing
1828 # flood control. To avoid accidental use on live networks, the server
1829 # name must contain ".test" to load the module
1830 #<module name="m_testnet.so">
1832 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1833 # Timed bans module: Adds timed channel bans and the /TBAN command
1834 #<module name="m_timedbans.so">
1836 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1837 # Test line module: Adds the /TLINE command, used to test how many
1838 # users a /GLINE or /ZLINE etc. would match.
1839 # This module is oper-only.
1840 # To use, TLINE must be in one of your oper class blocks.
1841 #<module name="m_tline.so">
1843 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1844 # Topiclock module: implements server-side topic locking to achieve deeper
1845 # integration with services packages.
1846 #<module name="m_topiclock.so">
1848 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1849 # UHNAMES support module: Adds support for the IRCX style UHNAMES
1850 # extension, which displays ident and hostname in the names list for
1851 # each user, saving clients from doing a WHO on the channel.
1852 # If a client does not support UHNAMES it will not enable it, this will
1853 # not break incompatible clients.
1854 #<module name="m_uhnames.so">
1856 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1857 # Uninvite module: Adds the /UNINVITE command which lets users remove
1858 # pending invites from channels without waiting for the user to join.
1859 #<module name="m_uninvite.so">
1861 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1862 # Userip module: Adds the /USERIP command
1863 # Allows users to query their own IP, also allows opers to query the IP
1865 #<module name="m_userip.so">
1867 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1868 # Vhost module: Adds the VHOST command which allows for adding virtual
1869 # hosts which are accessible using a username and password in the config.
1870 #<module name="m_vhost.so">
1872 #-#-#-#-#-#-#-#-#-#-#- VHOST CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#-#
1874 # user - Username for the vhost. #
1876 # pass - Password for the vhost. #
1878 # hash - The hash for the specific user (optional) #
1879 # m_password_hash.so and a hashing module must be loaded #
1880 # for this to work. #
1882 # host - Vhost to set. #
1884 #<vhost user="some_username" pass="some_password" host="some.host">
1885 #<vhost user="foo" password="fcde2b2edba56bf408601fb721fe9b5c338d10ee429ea04fae5511b68fbf8fb9" hash="sha256" host="some.other.host">
1887 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1888 # Watch module: Adds the WATCH command, which is used by clients to
1889 # maintain notify lists.
1890 #<module name="m_watch.so">
1892 # Configuration tags:
1894 #<watch maxentries="32">
1896 # Sets the maximum number of entries on a user's watch list.
1898 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1899 # XLine database: Stores all *Lines (G/Z/K/R/any added by other modules)
1900 # in a file "xline.db" which can be re-loaded on restart. This is useful
1901 # for two reasons: it keeps bans so users may not evade them, and on
1902 # bigger networks, server connections will take less time as there will
1903 # be a lot less bans to apply - as most of them will already be there.
1904 #<module name="m_xline_db.so">
1906 # Specify the filename for the xline database here
1907 #<xlinedb filename="data/xline.db">
1909 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1910 # ____ _ _____ _ _ ____ _ _ _ #
1911 # | _ \ ___ __ _ __| | |_ _| |__ (_)___ | __ )(_) |_| | #
1912 # | |_) / _ \/ _` |/ _` | | | | '_ \| / __| | _ \| | __| | #
1913 # | _ < __/ (_| | (_| | | | | | | | \__ \ | |_) | | |_|_| #
1914 # |_| \_\___|\__,_|\__,_| |_| |_| |_|_|___/ |____/|_|\__(_) #
1916 # To link servers to InspIRCd, you MUST load the m_spanningtree #
1917 # module. If you don't do this, server links will NOT work at all. #
1918 # This is by design, to allow for the implementation of other linking #
1919 # protocols in modules in the future. #
1922 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1923 # Spanning Tree module - allows linking of servers using the spanning
1924 # tree protocol (see the READ THIS BIT section above).
1925 # You will almost always want to load this.
1927 #<module name="m_spanningtree.so">
projects / user / henk / code / inspircd.git / blob