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 membe 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 cmode +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 the channel 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="conf/censor.conf">
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 # NOTE: Currently hard-limited to a maximum of 50 lines.
382 #<module name="m_chanhistory.so">
384 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
385 # Channel logging module: used to send snotice output to channels, to
386 # allow staff to centrally monitor and discuss network activity.
388 # The "channel" field is where you want the messages to go, "snomasks"
389 # is what snomasks you want to be sent to that channel. Multiple tags
391 #<module name="m_chanlog.so">
392 #<chanlog snomasks="AOcC" channel="#opers">
394 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
395 # Channel Names module: Allows disabling channels which have certain
396 # characters in the channel name such as bold, colorcodes, etc which
397 # can be quite annoying and allow users to on occasion have a channel
398 # that looks like the name of another channel on the network.
399 #<module name="m_channames.so">
402 # denyrange: characters or range of characters to deny in channel
406 # allowrange: characters or range of characters to specifically allow
410 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
411 # Channelban: Implements extended ban j:, which stops anyone in already
412 # in a channel matching a mask like +b j:#channel*mask from joining.
413 #<module name="m_channelban.so">
415 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
416 # Chanprotect module: gives +q and +a channel modes
417 #<module name="m_chanprotect.so">
420 # noservices: With this set to yes, when a user joins a empty channel,
421 # the server will set +q on them. If set to no, it will only set +o
422 # on them until they register the channel.
425 # qprefix: Prefix (symbol) to use for +q users.
428 # aprefix: Prefix (symbol) to use for +a users.
431 # deprotectself: If this value is set (true, yes or 1), it will allow
432 # +a and +q users to remove the +a and +q from themselves, otherwise,
433 # the status will have to be removed by services.
436 # deprotectothers: If this value is set to yes, true, or 1, then any
437 # user with +q or +a may remove the +q or +a from other users.
438 deprotectothers="yes">
441 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
442 # Check module: gives /check
443 # Check is useful for looking up information on channels,
444 # users, IP addresses and hosts.
445 # This module is oper-only.
446 # To use, CHECK must be in one of your oper class blocks.
447 #<module name="m_check.so">
449 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
450 # CHGHOST module: Adds the /CHGHOST command
451 # This module is oper-only.
452 # To use, CHGHOST must be in one of your oper class blocks.
453 # NOTE: Services will not be able to set vhosts on users if this module
454 # isn't loaded. If you're planning on running services, you probably
456 #<module name="m_chghost.so">
458 #-#-#-#-#-#-#-#-# /CHGHOST - /SETHOST CONFIGURATION #-#-#-#-#-#-#-#-#
459 # Optional - If you want to use special chars for hostnames you can #
460 # specify your own custom list of chars with the <hostname> tag: #
462 # charmap - A list of chars accepted as valid by the /CHGHOST #
463 # and /SETHOST commands. Also note that the list is #
465 #<hostname charmap="abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ.-_/0123456789">
467 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
468 # CHGIDENT module: Adds the /CHGIDENT command
469 # This module is oper-only.
470 # To use, CHGIDENT must be in one of your oper class blocks.
471 #<module name="m_chgident.so">
473 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
474 # CHGNAME module: Adds the /CHGNAME command
475 # This module is oper-only.
476 # To use, CHGNAME must be in one of your oper class blocks.
477 #<module name="m_chgname.so">
479 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
480 # Cloaking module: Adds usermode +x and cloaking support.
481 # Relies on the module m_md5.so being loaded before m_cloaking.so in
482 # the configuration file.
483 # To use, you should enable m_conn_umodes and add +x as
484 # an enabled mode. See the m_conn_umodes module for more information.
485 #<module name="m_cloaking.so">
487 #-#-#-#-#-#-#-#-#-#-#- CLOAKING CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#
489 # If you specify the m_cloaking.so module as above, you must define #
490 # cloak keys, and optionally a cloak prefix as shown below. The cloak #
491 # keys must be shared across the network for correct cloaking. #
493 # There are four methods of cloaking: #
495 # half Cloak only the "unique" portion of a host; show #
496 # the last 2 parts of the domain, /16 subnet of IPv4 #
497 # or /48 subnet of the IPv6 address. #
499 # full Cloak the users completely, using three slices for #
500 # common CIDR bans (IPv4: /16, /24; IPv6: /48, /64) #
502 # These methods use a single key that can be any length of text. #
503 # An optional prefix may be specified to mark cloaked hosts. #
505 # The following methods are maintained for backwards compatibility; #
506 # they are slightly less secure, and always hide unresolved IPs #
508 # compat-host InspIRCd 1.2-compatible host-based cloaking #
509 # compat-ip InspIRCd 1.2-compatible ip-always cloaking #
511 # You must specify key1, key2, key3, key4 for the compat cloaking #
512 # modes; the values must be less than 0x80000000 and should be picked #
513 # at random. Prefix is mandatory, will default to network name if not #
514 # specified, and will always have a "-" appended. #
515 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
521 #-#-#-#-#-#-#-#-#-#-#-#- CLOSE MODULE #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
522 # Close module: Allows an oper to close all unregistered connections.
523 # This module is oper-only and provides /close.
524 # To use, CLOSE must be in one of your oper class blocks.
525 #<module name="m_close.so">
527 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
528 # Clones module: Adds an oper command /CLONES for detecting cloned
529 # users. Warning: This module may be resource intensive when its
530 # command is issued, use with care.
531 # This module is oper-only.
532 # To use, CLONES must be in one of your oper class blocks.
533 #<module name="m_clones.so">
535 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
536 # Common channels module: Adds user mode +c, which, when set, requires
537 # that users must share a common channel with you to PRIVMSG or NOTICE
539 #<module name="m_commonchans.so">
541 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
542 # Conn-Join: Allows you to force users to join one or more channels
543 # automatically upon connecting to the server.
544 #<module name="m_conn_join.so">
546 #-#-#-#-#-#-#-#-#-#-#-#- CONNJOIN CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
548 # If you have m_conn_join.so loaded, you can configure it using the
551 #<autojoin channel="#one,#two,#three">
553 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
554 # Conn-Usermodes: Set modes on users when they connect
555 # When this module is loaded <connect:allow> tags may have an optional
556 # modes="" value, which contains modes to add or remove from users
557 # when they connect to the server.
558 #<module name="m_conn_umodes.so">
560 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
561 # Conn-Wait-for-Pong: Don't let a user connect until they PONG
562 #<module name="m_conn_waitpong.so">
564 #-#-#-#-#-#-#-#-#-#-#- WAITPONG CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
566 # If you have the m_conn_waitpong.so module loaded, configure it with #
567 # the <waitpong> tag: #
569 # sendsnotice - Whether to send a snotice on connect, like other #
572 # killonbadreply - Whether to kill the user if they send the wrong #
575 #<waitpong sendsnotice="yes" killonbadreply="yes">
578 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
579 # Channel cycle module. Server side /hop, with +ilk etc bypass.
580 #<module name="m_cycle.so">
582 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
583 # Connectban: Provides IP connection throttling. Any IP range that connects
584 # too many times (configurable) in an hour is zlined for a (configurable)
585 # duration, and their count resets to 0.
587 # ipv4cidr and ipv6cidr allow you to turn the comparison from individual
588 # IP addresses (32 and 128 bits) into CIDR masks, to allow for throttling
589 # over whole ISPs/blocks of IPs, which may be needed to prevent attacks.
591 #<connectban threshold="10" duration="10m" ipv4cidr="32" ipv6cidr="128">
592 # This allows for 10 connections in an hour with a 10 minute ban if that is exceeded.
594 #<module name="m_connectban.so">
596 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
597 # Connection throttle module. Configuration:
598 #<module name="m_connflood.so">
600 #-#-#-#-#-#-#-#-#-#-#- CONTHROTTLE CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
601 # seconds, maxconns - Amount of connections per <seconds>.
603 # timeout - Time to wait after the throttle was activated
604 # before deactivating it. Be aware that the time
605 # is seconds + timeout.
607 # quitmsg - The message that users get if they attempt to
608 # connect while the throttle is active.
610 # bootwait - Amount of time in seconds to wait before enforcing
611 # the throttling when the server just booted.
613 #<connflood seconds="30" maxconns="3" timeout="30"
614 # quitmsg="Throttled" bootwait="10">
616 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
617 # Custom prefixes : allows for channel prefixes to be added.
618 # This can replace m_chanprotect and m_halfop, except for services that
619 # recognise those modules by name
620 #<module name="m_customprefix.so">
622 # name The name of the mode, must be unique from other modes
623 # letter The letter used for this mode. Required.
624 # prefix The prefix used for nicks with this mode. Not required.
625 # rank A numeric rank for this prefix, defining what permissions it gives
626 # VOICE_VALUE is 10000, HALFOP_VALUE is 20000, OP_VALUE is 30000
627 # ranktoset The numeric rank required to set/unset this mode. Defaults to rank.
628 # depriv Can you remove the mode from yourself? Defaults to yes.
629 #<customprefix name="founder" letter="q" prefix="~" rank="50000" ranktoset="50000">
630 #<customprefix name="admin" letter="a" prefix="&" rank="40000" ranktoset="50000">
631 #<customprefix name="halfop" letter="h" prefix="%" rank="20000" ranktoset="30000">
632 #<customprefix name="halfvoice" letter="V" prefix="-" rank="1" ranktoset="20000">
634 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
635 # Custom title module: Adds the /TITLE command which allows for trusted
636 # users to gain a custom whois line and a optional
637 # vhost can be specified.
638 #<module name="m_customtitle.so">
640 #-#-#-#-#-#-#-#-#-#- CUSTOM TITLE CONFIGURATION -#-#-#-#-#-#-#-#-#-#
641 # name - The username used to identify
642 # password - The password used to identify
643 # hash - The hash for the specific user's password (optional)
644 # m_password_hash.so and a hashing module must be loaded for this to work
645 # host - Allowed hostmask [optional]
646 # title - Title shown in whois
647 # vhost - Displayed host [optional]
649 #<title name="foo" password="bar" title="Official Chat Helper">
650 #<title name="bar" password="foo" host="ident@host.name" title="Official Chat Helper" vhost="helper.network.chat">
651 #<title name="foo" password="fcde2b2edba56bf408601fb721fe9b5c338d10ee429ea04fae5511b68fbf8fb9" hash="sha256" title="Official Chat Helper">
653 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
654 # DCCALLOW module: Adds the /DCCALLOW command
655 #<module name="m_dccallow.so">
657 #-#-#-#-#-#-#-#-#-#-#- DCCALLOW CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
658 # blockchat - Whether to block DCC CHAT as well as DCC SEND
659 # length - Default duration of entries in DCCALLOW list
660 # action - Default action to take if no action is specified
661 # can be 'block' or 'allow'
663 # File configuration:
664 # pattern - The glob pattern to match against
665 # action - Action to take if a user attempts to send a file
666 # that matches this pattern, can be 'block' or 'allow'
668 #<dccallow blockchat="yes" length="5m" action="block">
669 #<banfile pattern="*.exe" action="block">
670 #<banfile pattern="*.txt" action="allow">
672 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
674 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
675 # Deaf module: adds support for ircu style usermode +d - deaf to
676 # channel messages and channel notices.
677 #<module name="m_deaf.so">
679 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
680 # Delay join module: Adds the channel mode +D which delays all JOIN
681 # messages from users until they speak. If they quit or part before
682 # speaking, their quit or part message will not be shown to the channel
683 # which helps cut down noise on large channels in a more friendly way
684 # than the auditorium mode. Only channel ops may set the +D mode.
685 #<module name="m_delayjoin.so">
687 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
688 # Delay message module: Adds the channel mode +d which disallows a user
689 # from talking in the channel unless they've been joined for X seconds.
690 # Settable a la: /mode +d 30
691 #<module name="m_delaymsg.so">
693 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
694 # Deny Channels: Deny Channels from being used by users
695 #<module name="m_denychans.so">
697 #-#-#-#-#-#-#-#-#-#-#- DENYCHAN DEFINITIONS -#-#-#-#-#-#-#-#-#-#-#-#
699 # If you have the m_denychans.so module loaded, you need to specify #
700 # the channels to deny: #
702 # name - The channel name to deny. (glob masks are ok) #
704 # allowopers - If operators are allowed to override the deny. #
706 # reason - Reason given for the deny. #
708 # redirect - Redirect the user to a different channel #
710 #<badchan name="#gods*" allowopers="yes" reason="Tortoises!"> #
711 #<badchan name="#heaven" redirect="#hell" reason="Nice try!"> #
713 # Redirects will not work if the target channel is set +L. #
715 # Additionally, you may specify channels which are allowed, even if #
716 # a badchan tag specifies it would be denied: #
717 #<goodchan name="#godsleeps"> #
718 # Glob masks are accepted here also.
720 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
721 # Devoice Module: Let users devoice themselves.
722 #<module name="m_devoice.so">
724 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
725 # DNS Blacklist Module: Provides support for looking up IPs on one or #
727 #<module name="m_dnsbl.so"> #
729 # For configuration options please see the wiki page for m_dnsbl at #
730 # http://wiki.inspircd.org/Modules/dnsbl #
732 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
733 # Exempt Channel Operators Module: Provides support for allowing #
734 # channel operators to be exempt from some channel modes. Supported #
735 # modes are blockcaps, noctcp, blockcolor, nickflood, flood, censor, #
736 # filter, regmoderated, nonick, nonotice, and stripcolor. #
737 #<module name="m_exemptchanops.so"> #
739 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
740 # Filter module: Provides message filtering, similar to SPAMFILTER.
741 #<module name="m_filter.so">
743 # This module depends upon a regex provider such as m_regex_pcre or #
744 # m_regex_glob to function. You must specify which of these you want #
745 # m_filter to use via the tag below. #
747 # Valid engines are: #
749 # glob - Glob patterns, provided via m_regex_glob.so #
750 # pcre - PCRE regexps, provided via m_regex_pcre.so, needs libpcre #
751 # tre - TRE regexps, provided via m_regex_tre.so, requires libtre #
752 # posix - POSIX regexps, provided via m_regex_posix.so, not availale #
753 # on windows, no dependencies on other operating systems. #
755 #<filteropts engine="glob"> #
757 # Your choice of regex engine must match on all servers network-wide.
759 # You may specify specific channels that are exempt from being filtered:
760 #<exemptfromfilter channel="#blah">
762 #-#-#-#-#-#-#-#-#-#-#- FILTER CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#
764 # Optional - If you specify to use the m_filter module, then #
765 # specfiy below the path to the filter.conf file, or define some #
768 #<include file="conf/filter.conf">
770 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
771 # Gecosban: Implements extended ban r:, which stops anyone matching
772 # a mask like +b r:*realname?here* from joining a channel.
773 #<module name="m_gecosban.so">
775 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
776 # GeoIP module: Allows the server admin to match users by country code.
777 # This modules is in extras. Re-run configure with: ./configure --enable-extras=m_geoip.cpp
778 # and run make install, then uncomment this module to enable it.
779 # This module requires GeoIP to be installed on your system,
780 # use your package manager to find the appropriate packages
781 # or check the InspIRCd wiki page for this module.
782 #<module name="m_geoip.so">
784 # The actual allow/ban actions are done by connect classes, not by the
785 # GeoIP module. An example connect class to ban people from russia or
788 # <connect deny="*" geoip="TR,RU">
790 # The country code must be in capitals and should be an ISO country
791 # code such as TR, GB, or US. Unknown IPs (localhost, LAN IPs, etc)
792 # will be assigned the country code "UNK". Since connect classes are
793 # matched from top down, your deny classes must be above your allow
794 # classes for them to match.
796 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
797 # Globops module: gives /GLOBOPS and SNOMASK +g
798 # This module is oper-only.
799 # To use, GLOBOPS must be in one of your oper class blocks.
800 #<module name="m_globops.so">
802 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
803 # Global load module: Allows loading and unloading of modules network-
804 # wide (USE WITH EXTREME CAUTION!)
805 # This module is oper-only and provides /gloadmodule, /gunloadmodule
806 # and /greloadmodule.
807 # To use, GLOADMODULE, GUNLOADMODULE and GRELOADMODULE
808 # must be in one of your oper class blocks.
809 #<module name="m_globalload.so">
811 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
812 # Halfop module: Provides the +h (halfops) channel status mode.
813 #<module name="m_halfop.so">
815 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
816 # HELPOP module: Provides the /HELPOP command
817 #<module name="m_helpop.so">
819 #-#-#-#-#-#-#-#-#-#-#-#- HELPOP CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
821 # Optional - If you specify to use the m_helpop.so module, then #
822 # specify below the path to the helpop.conf file, or if you like to #
823 # make a mess, define your helpop tags in this conf. #
825 #<include file="conf/inspircd.helpop-full.example">
827 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
828 # HIDECHANS module: Allows opers to hide their channels list from non-
829 # opers by setting user mode +I on themselves.
830 #<module name="m_hidechans.so">
832 # HIDECHANS can optionally prevent opers from seeing channels on a +I
833 # user, for more privacy if set to true.
834 # This setting is not recommended for most mainstream networks.
835 #<hidechans affectsopers="false">
837 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
838 # HIDEOPER module: Allows opers to hide their oper status from non-
839 # opers by setting user mode +H on themselves.
840 # This module is oper-only.
841 #<module name="m_hideoper.so">
843 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
844 # Hostchange module: Allows a different style of cloaking
845 #<module name="m_hostchange.so">
847 #-#-#-#-#-#-#-#-#-#-#- HOSTCHANGE CONFIGURATION -#-#-#-#-#-#-#-#-#-#
849 # Optional - If you choose to use the m_hostchange.so module. #
850 # Config Help - See http://wiki.inspircd.org/Modules/hostchange #
852 #<host suffix="polarbears.org" separator="." prefix="">
853 #<hostchange mask="*@fbi.gov" action="addnick">
854 #<hostchange mask="*r00t@*" action="suffix">
855 #<hostchange mask="a@b.com" action="set" value="blah.blah.blah">
856 #<hostchange mask="localhost" ports="7000,7001,7005-7007" action="set" value="blahblah.foo">
858 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
859 # httpd module: Provides http server support for InspIRCd
860 #<module name="m_httpd.so">
862 #-#-#-#-#-#-#-#-#-#-#-#- HTTPD CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
864 # If you choose to use the m_httpd.so module, then you will need to add
865 # a <bind> tag with type "httpd", and load at least one of the other
866 # m_httpd_* modules to provide pages to display.
869 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
870 # http ACL module: Provides access control lists for m_httpd dependent
871 # modules. Use this module to restrict pages by IP address and by
874 #<module name="m_httpd_acl.so">
876 #-#-#-#-#-#-#-#-#-#-#-#- HTTPD ACL CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
878 # Restrict access to the m_httpd_stats module to all but the local
879 # network and when the correct password is specified:
881 # <httpdacl path="/stats*" types="password,whitelist"
882 # username="secretstuff" password="mypasshere" whitelist="127.0.0.*,10.*">
884 # Deny all connections to all but the main index page:
886 # <httpdacl path="/*" types="blacklist" blacklist="*">
889 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
890 # http config module: Allows the server's configuration to be viewed
891 # over HTTP. Requires m_httpd.so to be loaded for it to function.
892 #<module name="m_httpd_config.so">
894 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
895 # http stats module: Provides basic stats pages over HTTP
896 # Requires m_httpd.so to be loaded for it to function.
897 #<module name="m_httpd_stats.so">
899 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
900 # Ident: Provides RFC 1413 ident lookup support
901 # When this module is loaded <connect:allow> tags may have an optional
902 # useident="yes|no" boolean value, determining whether or not to lookup
903 # ident on users matching that connect tag.
904 #<module name="m_ident.so">
906 #-#-#-#-#-#-#-#-#-#-#-#- IDENT CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
908 # Optional - If you are using the m_ident.so module, then you can #
909 # specify the timeout for ident lookups here. If not defined, it will #
910 # default to one second. This is a non-blocking timeout which holds #
911 # the user in a 'connecting' state until the lookup is complete. #
912 # The bind value indicates which IP to bind outbound requests to. #
916 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
917 # Invite except module: Adds support for channel invite exceptions (+I)
918 #<module name="m_inviteexception.so">
919 # Does a +I bypass channel +k in addition to +i?
920 #<inviteexception bypasskey="yes">
922 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
923 # Join flood module: Adds support for join flood protection (+j)
924 #<module name="m_joinflood.so">
926 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
927 # Jump Server module: Adds support for the RPL_REDIR numeric
928 # This module is oper-only.
929 # To use, JUMPSERVER must be in one of your oper class blocks.
930 # If your server is redirecting new clients and you get disconnected,
931 # do a REHASH from shell to open up again.
932 #<module name="m_jumpserver.so">
934 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
935 # Anti-Auto-Rejoin: Adds support for prevention of auto-rejoin (+J)
936 #<module name="m_kicknorejoin.so">
938 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
939 # Knock module: adds the /KNOCK command and +K channel mode
940 #<module name="m_knock.so">
942 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
943 # LDAP authentication module: Adds the ability to authenticate users #
944 # via LDAP. This is an extra module which must be enabled explicitly #
945 # by symlinking it from modules/extra, and requires the OpenLDAP libs #
946 # This modules is in extras. Re-run configure with: ./configure --enable-extras=m_ldapauth.cpp
947 # and run make install, then uncomment this module to enable it. #
949 #<module name="m_ldapauth.so"> #
953 # <ldapauth baserdn="ou=People,dc=brainbox,dc=cc" #
955 # server="ldap://brainwave.brainbox.cc" #
956 # allowpattern="Guest*" #
957 # killreason="Access denied" #
958 # searchscope="subtree" #
959 # binddn="cn=Manager,dc=brainbox,dc=cc" #
960 # bindauth="mysecretpass" #
963 # <ldapwhitelist cidr="10.42.0.0/16"> #
965 # The baserdn indicates the base DN to search in for users. Usually #
966 # this is 'ou=People,dc=yourdomain,dc=yourtld'. #
968 # The attribute value indicates the attribute which is used to locate #
969 # a user account by name. On POSIX systems this is usually 'uid'. #
971 # The server parameter indicates the LDAP server to connect to. The #
972 # ldap:// style scheme before the hostname proper is MANDITORY. #
974 # The allowpattern value allows you to specify a wildcard mask which #
975 # will always be allowed to connect regardless of if they have an #
976 # account, for example guest users. #
978 # Killreason indicates the QUIT reason to give to users if they fail #
981 # The searchscope value indicates the subtree to search under. On our #
982 # test system this is 'subtree'. Your mileage may vary. #
984 # Setting the verbose value causes an oper notice to be sent out for #
985 # every failed authentication to the server, with an error string. #
987 # The binddn and bindauth indicate the DN to bind to for searching, #
988 # and the password for the distinguished name. Some LDAP servers will #
989 # allow anonymous searching in which case these two values do not #
990 # need defining, otherwise they should be set similar to the examples #
993 # ldapwhitelist indicates that clients connecting from an IP in the #
994 # provided CIDR do not need to authenticate against LDAP. It can be #
995 # repeated to whitelist multiple CIDRs. #
997 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
998 # LDAP oper configuration module: Adds the ability to authenticate #
999 # opers via LDAP. This is an extra module which must be enabled #
1000 # explicitly by symlinking it from modules/extra, and requires the #
1001 # OpenLDAP libs. Re-run configure with: ./configure --enable-extras=m_ldapoper.cpp
1002 # and run make install, then uncomment this module to enable it. #
1004 #<module name="m_ldapoper.so">
1008 # <ldapoper baserdn="ou=People,dc=brainbox,dc=cc"
1009 # server="ldap://brainwave.brainbox.cc"
1010 # searchscope="subtree"
1011 # binddn="cn=Manager,dc=brainbox,dc=cc"
1012 # bindauth="mysecretpass">
1014 # Available configuration items are identical to the same items in #
1015 # m_ldapauth above. #
1017 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1018 # Lock server module: Adds /LOCKSERV and /UNLOCKSERV commands that is #
1019 # used to temporarily close/open for new connections to the server. #
1020 # These commands require OPER status and that the LOCKSERV UNLOCKSERV #
1021 # are specified in a <class> tag that the oper is part of. This is so #
1022 # you can control who has access to this possible dangerous command. #
1023 # If your server is locked and you get disconnected, do a REHASH from #
1024 # shell to open up again.
1026 # This module is oper-only.
1028 #<module name="m_lockserv.so">
1030 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1031 # Map hiding module: replaces /MAP and /LINKS output to users with a #
1032 # message to see a website, set by maphide="http://link.to/site" in #
1033 # the security tag, instead. #
1034 #<module name="m_maphide.so">
1036 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1037 # Msg flood module: Adds message/notice flood protection (+f)
1038 #<module name="m_messageflood.so">
1040 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1041 # MLOCK module: Adds support for server-side enforcement of services
1042 # side MLOCKs. Basically, this module suppresses any mode change that
1043 # would likely be immediately bounced by services.
1044 #<module name="m_mlock.so">
1046 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1047 # MsSQL module: Allows other SQL modules to access MS SQL Server
1048 # through a unified API. You must copy the source for this module
1049 # from the directory src/modules/extra, plus the file m_sqlv2.h
1050 # This modules is in extras. Re-run configure with: ./configure --enable-extras=m_mssql.cpp
1051 # and run make install, then uncomment this module to enable it.
1053 #<module name="m_mssql.so">
1055 #-#-#-#-#-#-#-#-#-#-#-#- SQL CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#-#
1057 # m_mssql.so is more complex than described here, see wiki for more #
1058 # info http://wiki.inspircd.org/Modules/mssql #
1060 #<database module="mssql" name="db" user="user" pass="pass" host="localhost" id="db1">
1062 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1063 # MySQL module: Allows other SQL modules to access MySQL databases
1064 # through a unified API. You must copy the source for this module
1065 # from the directory src/modules/extra, plus the file m_sqlv2.h
1066 # This modules is in extras. Re-run configure with: ./configure --enable-extras=m_mysql.cpp
1067 # and run make install, then uncomment this module to enable it.
1069 #<module name="m_mysql.so">
1071 #-#-#-#-#-#-#-#-#-#-#-#- SQL CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#-#
1073 # m_mysql.so is more complex than described here, see the wiki for #
1074 # more: http://wiki.inspircd.org/Modules/mysql #
1076 #<database module="mysql" name="mydb" user="myuser" pass="mypass" host="localhost" id="my_database2">
1078 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1079 # Named Modes module: This module allows for the display and set/unset
1080 # of channel settings and modes via long-form mode names in channels with
1081 # channelmode +Z set. For example, to set a channelban with named modes:
1082 # /mode #channel +Z ban=foo!bar@baz . Currently this doesn't serve much
1083 # purpose outside of making channel administration a bit easier in some
1084 # cases, but eventually modules will start using named modes only because
1085 # we're running out of channelmodes. :D
1086 #<module name="m_namedmodes.so">
1088 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1089 # NAMESX module: Provides support for the NAMESX extension which allows
1090 # clients to see all the prefixes set on a user without getting confused.
1091 # This is supported by mIRC, x-chat, klient, and maybe more.
1092 #<module name="m_namesx.so">
1094 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1095 # National characters module:
1096 # 1) Allows using national characters in nicknames.
1097 # 2) Allows using custom (national) casemapping over the network.
1098 # file -- filename of existing file in "locales" directory
1099 # casemapping -- custom value for 005 numeric (if you want it to be
1100 # different from the filename.
1102 #<nationalchars file="bynets/russian-w1251-charlink" casemapping="ru_RU.cp1251-charlink">
1103 #<module name="m_nationalchars.so">
1105 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1106 # Nickchange flood protection module: Allows up to X nick changes in Y seconds.
1107 # Provides channel mode +F.
1108 #<module name="m_nickflood.so">
1110 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1111 # Nicklock module: Let opers change a user's nick and then stop that
1112 # user from changing their nick again.
1113 # This module is oper-only.
1114 # To use, NICKLOCK and NICKUNLOCK must be in one of your oper class blocks.
1115 #<module name="m_nicklock.so">
1117 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1118 # No ctcp module: Adds the channel mode +C to block CTCPs and extban C
1119 # to block CTCPs sent by specific users.
1120 #<module name="m_noctcp.so">
1122 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1123 # No kicks module: Adds the +Q channel mode and the Q: extban to deny
1124 # certain users from kicking.
1125 #<module name="m_nokicks.so">
1127 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1128 # No nicks module: Adds the +N channel mode, as well as the +b N:
1129 # extended bantype. +N stops all users from changing their nick,
1130 # the +b N: extban stops anyone from matching a +b N:nick!user@host
1131 # mask from changing their nick.
1132 #<module name="m_nonicks.so">
1134 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1135 # No part message module: adds extban 'p' to block part messages from #
1137 #<module name="m_nopartmsg.so">
1139 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1140 # No Notice module: adds the channel mode +T and the extban T to block
1141 # specific users from noticing the channel.
1142 #<module name="m_nonotice.so">
1144 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1145 # Network buisness join module
1146 # Allows an oper to join a channel using /OJOIN, giving them +Y on the
1147 # channel which makes them immune to kick/deop/etc.
1148 #<module name="m_ojoin.so">
1150 #<ojoin prefix="!" notice="yes" op="yes">
1151 # Specify the prefix that +Y will grant here
1152 # Leave prefix empty if you do not wish +Y to grant a prefix
1153 # If notice is set to on, upon ojoin, the server will notice
1154 # the channel saying that the oper is joining on network business
1155 # If op is set to on, it will give them +o along with +Y
1158 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1159 # Oper channels mode: Adds the +O channel mode and +beI type O:<mask>
1160 # to ban, exempt, and invex given oper type masks.
1161 # e.g, /mode #channel +iI O:* is equivilant to chmode +O, but you
1162 # may also, e.g. /mode #channel +iI O:AdminTypeOnly to only allow admins.
1163 # +be work in a similar fashion.
1165 #<module name="m_operchans.so">
1167 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1168 # Oper Join module: Auto-joins opers to a channel upon oper-up
1169 # This module is oper-only. For the user equivalent, see m_conn_join.
1170 #<module name="m_operjoin.so">
1172 #-#-#-#-#-#-#-#-#-#-# OPERJOIN CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
1174 # If you are using the m_operjoin.so module, specify options here: #
1176 # channel - The channel name to join, can also be a comma #
1177 # seperated list eg. "#channel1,#channel2". #
1179 # override - Lets the oper join walking thru any modes that #
1180 # might be set, even bans. Use "yes" or "no". #
1182 #<operjoin channel="#channel" override="no">
1184 # Alternatively you can use the autojoin="channellist" in a <type> #
1185 # tag to set specific autojoins for a type of oper, for example: #
1187 #<type name="Helper" autojoin="#help" classes="...">
1189 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1190 # Oper log module: Logs all oper commands to the ircd log at default
1192 # This module is oper-only.
1193 #<module name="m_operlog.so">
1195 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1196 # Oper prefixing module: Gives IRC operators a prefix status character
1197 # on all channels they are in.
1199 #<module name="m_operprefix.so">
1201 # You may additionally customise the prefix character.
1202 #<operprefix prefix="!">
1204 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1205 # Oper MOTD module: Provides support for seperate message of the day
1207 # This module is oper-only.
1208 #<module name="m_opermotd.so">
1210 #-#-#-#-#-#-#-#-#-#-# OPERMOTD CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
1212 # If you are using the m_opermotd.so module, specify the motd here #
1214 # onoper - Should the message be sent on /OPER or only when #
1215 # /OPERMOTD is used. Use "yes" or "no". #
1217 #<opermotd file="oper.motd" onoper="yes">
1219 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1220 # Override module: Adds support for oper override
1221 # This module is oper-only.
1222 #<module name="m_override.so">
1224 #-#-#-#-#-#-#-#-#-#-# OVERRIDE CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
1226 # m_override.so is too complex it describe here, see the wiki: #
1227 # http://wiki.inspircd.org/Modules/override #
1229 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1230 # Oper levels module: Gives each oper a level and prevents
1231 # actions being taken against higher level opers
1232 # Specify the level as the 'level' parameter of the <type> tag
1233 # # This module is oper-only.
1234 #<module name="m_operlevels.so">
1236 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1237 # Oper modes module: Allows you to specify modes to add/remove on oper
1238 # Specify the modes as the 'modes' parameter of the <type> tag
1239 # and/or as the 'modes' parameter of the <oper> tag.
1240 # This module is oper-only. For the user equivalent, see m_conn_umodes
1241 #<module name="m_opermodes.so">
1243 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1244 # Password forwarding module: Forwards a password users can send on connect
1245 # to the specified client below. The client is usually nickserv and this
1246 # module is usually used to authenticate users with nickserv using their
1248 #<module name="m_passforward.so">
1251 # nick: nick to forward connect passwords to.
1254 # forwardmsg: Message to send to users using a connect password.
1255 # $nick will be the users' nick, $nickrequired will be the nick
1256 # of where the password is going (the nick above).
1257 forwardmsg="NOTICE $nick :*** Forwarding PASS to $nickrequired"
1259 # cmd: Command for the nick to run when it recieves a connect
1261 cmd="PRIVMSG $nickrequired :IDENTIFY $pass">
1263 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1264 # Password hash module: Allows hashed passwords to be used.
1265 # To be useful, a hashing module like m_sha256.so also needs to be loaded.
1267 #<module name="m_password_hash.so">
1269 #-#-#-#-#-#-#-#-#-# PASSWORD HASH CONFIGURATION #-#-#-#-#-#-#-#-#-#-#-#
1271 # To use this module, you must define a hash type for each oper's
1272 # password you want to hash. For example:
1274 # <oper name="Brain"
1275 # host="ident@dialup15.isp.com"
1277 # password="01ba4719c80b6fe911b091a7c05124b64eeece964e09c058ef8f9805daca546b"
1280 # Starting from 2.0, you can use a more secure salted hash that prevents simply
1281 # looking up the hash's value in a rainbow table built for the hash.
1282 # hash="hmac-sha256" password="lkS1Nbtp$CyLd/WPQXizsbxFUTqFRoMvaC+zhOULEeZaQkUJj+Gg"
1284 # Generate hashes using the /MKPASSWD command on the server. Don't run it on a
1285 # server you don't trust with your password.
1287 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1288 # Permanent Channels module: Channels with the permanent channels mode
1289 # will remain open even after everyone else has left the channel, and
1290 # therefore keep things like modes, ban lists and topic. Permanent
1291 # channels -may- need support from your Services package to function
1292 # properly with them. This adds channel mode +P.
1293 # This module is oper-only.
1294 #<module name="m_permchannels.so">
1296 # If you like, m_permchannels can write a config file of permanent channels
1297 # whenever +P is set, unset, or the topic/modes on a +P channel is changed.
1298 # If you want to do this, set the filename below, and uncomment the include.
1300 #<permchanneldb filename="data/permchannels.conf">
1301 #<include file="data/permchannels.conf">
1303 # You may also create channels on startup by using the <permchannels> block.
1304 # Don't forget to set them +P in the modes, or they won't stay permanent.
1305 #<permchannels channel="#opers" modes="isP" topic="Opers only.">
1307 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1308 # PostgreSQL module: Allows other SQL modules to access PgSQL databases
1309 # through a unified API. You must copy the source for this module
1310 # from the directory src/modules/extra, plus the file m_sqlv2.h
1311 # This modules is in extras. Re-run configure with: ./configure --enable-extras=m_pgsql.cpp
1312 # and run make install, then uncomment this module to enable it.
1314 #<module name="m_pgsql.so">
1316 #-#-#-#-#-#-#-#-#-#-#-#- SQL CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#-#
1318 # m_pgsql.so is more complex than described here, see the wiki for #
1319 # more: http://wiki.inspircd.org/Modules/pgsql #
1321 #<database module="pgsql" name="mydb" user="myuser" pass="mypass" host="localhost" id="my_database" ssl="no">
1323 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1324 # Muteban: Implements extended ban m:, which stops anyone matching
1325 # a mask like +b m:nick!user@host from speaking on channel.
1326 #<module name="m_muteban.so">
1329 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1330 # Random Quote module: provides a random quote on connect.
1331 # NOTE: Some of these may mimic fatal errors and confuse users and
1332 # opers alike! - BEWARE!
1333 #<module name="m_randquote.so">
1335 #-#-#-#-#-#-#-#-#-#- RANDOMQUOTES CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
1337 # Optional - If you specify to use the m_randquote.so module, then #
1338 # specify below the path to the randquotes.conf file. #
1340 #<randquote file="randquotes.conf">
1342 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1343 # Redirect module: Adds channel redirection (mode +L)
1344 #<module name="m_redirect.so">
1346 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1347 # Regular Expression Provider for Glob or wildcard (?/*) matching.
1348 # You must have at least 1 provider loaded to use m_filter or m_rline
1349 # modules. This module has no additional requirements, as it uses the
1350 # matching already present in InspIRCd core.
1351 #<module name="m_regex_glob.so">
1353 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1354 # Regular Expression Provider for PCRE (Perl-Compatible Regular
1355 # Expressions). You need libpcre installed to compile and load this
1356 # module. You must have at least 1 provider loaded to use m_filter or
1358 #<module name="m_regex_pcre.so">
1360 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1361 # Regular Expression Provider for POSIX Regular Expressions.
1362 # You shouldn't need any additional libraries on a POSIX-compatible
1363 # system (ie: any Linux, BSD, but not Windows). You must have at least
1364 # 1 provider loaded to use m_filter or m_rline.
1365 # On POSIX-compliant systems, regex syntax can be found by using the
1366 # command: 'man 7 regex'.
1367 #<module name="m_regex_posix.so">
1369 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1370 # Regular Expression Provider for TRE Regular Expressions.
1371 # This is the same regular expression engine used by UnrealIRCd, so
1372 # if you are most familiar with the syntax of /spamfilter from there,
1373 # this is the provider you want. You need libtre installed in order
1374 # to compile and load this module.
1375 #<module name="m_regex_tre.so">
1377 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1378 # Registered users only channel creation
1379 # Allows only registered users and opers to create new channels.
1381 # You probably *DO NOT* want to load this module on a public network.
1383 #<module name="m_regonlycreate.so">
1385 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1386 # Remove module: Adds the /REMOVE command which is a peaceful
1387 # alternative to /KICK
1388 #<module name="m_remove.so">
1390 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1391 # Restricted channels module: Allows only opers to create channels.
1393 # You probably *DO NOT* want to load this module on a public network.
1395 #<module name="m_restrictchans.so">
1397 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1398 # Restrict message module: Allows users to only message opers.
1400 # You probably *DO NOT* want to load this module on a public network.
1402 #<module name="m_restrictmsg.so">
1404 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1405 # Ban users through regular expression patterns
1406 #<module name="m_rline.so">
1408 #-#-#-#-#-#-#-#-#-#-#-#- RLINE CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#-#
1410 # If you wish to re-check a user when they change nickname (can be
1411 # useful under some situations, but *can* also use CPU with more users
1412 # on a server) then set the following configuration value:
1413 # Also, this is where you set what Regular Expression engine is to be
1414 # used. If you ever change it while running, all of your R-Lines will be
1415 # wiped. This is the regex engine used by all R-Lines set, and
1416 # m_regex_<engine>.so must be loaded, or rline will be nonfunctional
1417 # until you load it or change the engine to one that is loaded.
1419 #<rline matchonnickchange="yes" engine="pcre">
1421 # Generally, you will NOT want to use 'glob' here, as this turns
1422 # rline into just another gline. The exceptions are that rline will
1423 # always use the full nick!user@host realname string, rather than only
1424 # user@host, but beware that only the ? and * wildcards are available,
1425 # and are the only way to specify where the space can occur if you do
1426 # use glob. For this reason, is recommended to use a real regex engine
1427 # so that at least \s or [[:space:]] is available.
1429 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1430 # SAJOIN module: Adds the /SAJOIN command
1431 # This module is oper-only.
1432 # To use, SAJOIN must be in one of your oper class blocks.
1433 #<module name="m_sajoin.so">
1435 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1436 # SAKICK module: Adds the /SAKICK command
1437 # This module is oper-only.
1438 # To use, SAKICK must be in one of your oper class blocks.
1439 #<module name="m_sakick.so">
1441 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1442 # SAMODE module: Adds the oper /SAMODE command
1443 # This module is oper-only.
1444 # To use, SAMODE must be in one of your oper class blocks.
1445 #<module name="m_samode.so">
1447 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1448 # SANICK module: Allows opers to change user's nicks
1449 # This module is oper-only.
1450 # To use, SANICK must be in one of your oper class blocks.
1451 #<module name="m_sanick.so">
1453 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1454 # SAPART module: Adds the oper /SAPART command
1455 # This module is oper-only.
1456 # To use, SAPART must be in one of your oper class blocks.
1457 #<module name="m_sapart.so">
1459 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1460 # SAQUIT module: Adds the oper /SAQUIT command (abusable!!!)
1461 # This module is oper-only.
1462 # To use, SAQUIT must be in one of your oper class blocks.
1463 #<module name="m_saquit.so">
1465 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1466 # SATOPIC module: Adds the oper /SATOPIC command
1467 # This module is oper-only.
1468 # To use, SATOPIC must be in one of your oper class blocks.
1469 #<module name="m_satopic.so">
1471 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1472 # SASL authentication module: Provides support for IRC Authentication
1473 # Layer (aka: atheme SASL) via AUTHENTICATE.
1474 #<module name="m_sasl.so">
1476 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1477 # Secure list module: Prevent /LIST in the first minute of connection,
1478 # crippling most spambots and trojan spreader bots.
1479 #<module name="m_securelist.so">
1481 #-#-#-#-#-#-#-#-#-# SECURELIST CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#-#
1483 # Securelist can be harmful to some irc search engines such as #
1484 # netsplit.de and searchirc.com. To prevent securelist blocking these #
1485 # sites from listing, define exception tags as shown below: #
1486 <securehost exception="*@*.searchirc.org">
1487 <securehost exception="*@*.netsplit.de">
1488 <securehost exception="*@echo940.server4you.de">
1489 <securehost exception="*@*.ircdriven.com">
1491 # Define the following variable to change how long a user must wait #
1492 # before issuing a LIST. If not defined, defaults to 60 seconds. #
1494 #<securelist waittime="60"> #
1496 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1497 # Servprotect module: Provides support for Austhex style +k /
1498 # UnrealIRCD +S services mode
1499 #<module name="m_servprotect.so">
1501 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1502 # See nicks module: Allow for SNOMASK +N which shows nick changes.
1503 # This module is oper-only.
1504 #<module name="m_seenicks.so">
1506 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1507 # Set Idle module: Adds a command for opers to change their
1508 # idle time (mainly a toy)
1509 # This module is oper-only.
1510 # To use, SETIDLE must be in one of your oper class blocks.
1511 #<module name="m_setidle.so">
1513 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1514 # Services support module: Adds several usermodes such as +R and +M
1515 # this module implements the 'identified' state via account names (AC)
1516 # and is similar in operation to the way asuka and ircu handle services.
1518 # At the same time, this offers +r for users and channels to mark them
1519 # as identified seperately from the idea of a master account, which
1520 # can be useful for services which are heavily nick-as-account centric.
1522 # This replaces m_services from 1.1 and earlier.
1524 # Also of note is that this module implements two extbans:
1525 # +b R: (stop matching account names from joining)
1526 # +b M: (stop matching account names from speaking)
1528 #<module name="m_services_account.so">
1530 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1531 # Sethost module: Adds the /SETHOST command
1532 # This module is oper-only.
1533 # To use, SETHOST must be in one of your oper class blocks.
1534 # See m_chghost for how to customise valid chars for hostnames
1535 #<module name="m_sethost.so">
1537 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1538 # Setident module: Adds the /SETIDENT command
1539 # This module is oper-only.
1540 # To use, SETIDENT must be in one of your oper class blocks.
1541 #<module name="m_setident.so">
1543 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1544 # SETNAME module: Adds the /SETNAME command
1545 # This module is oper-only.
1546 # To use, SETNAME must be in one of your oper class blocks.
1547 #<module name="m_setname.so">
1549 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1550 # Serverban: Implements extended ban s:, which stops anyone connected
1551 # to a server matching a mask like +b s:server.mask.here from joining.
1552 #<module name="m_serverban.so">
1554 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1555 # Show Whois module: Adds the +W usermode which allows opers
1556 # to see when they are whois'ed (can be annoying).
1557 # This module is oper-only.
1558 #<module name="m_showwhois.so">
1560 # If you wish, you may also let users set this mode. Only opers with the
1561 # users/auspex priv will see real hosts of people, though. This setting
1562 # is not reloadable via /rehash, and will require /reloadmodule, as
1563 # it directly affects the mode object itself.
1564 #<showwhois opersonly="yes"
1566 # You may also set whether or not users should recieve whois notices, should
1567 # they be /whois'd by an oper.
1568 # showfromopers="yes">
1570 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1571 # Shun module: Provides the /SHUN command, which stops a user from
1572 # executing all except configured commands.
1573 # This module is oper-only.
1574 # To use, SHUN must be in one of your oper class blocks.
1575 #<module name="m_shun.so">
1577 # You may also configure which commands you wish a user to be able to
1578 # perform. It should be noted that if a shunned user issues QUIT or PART
1579 # then their message will be removed, as if they did not issue one.
1581 # You can (optionally) let the user know that their command was blocked.
1583 # You may also let SHUN affect opers (defaults to no).
1584 #<shun enabledcommands="PING PONG QUIT PART JOIN" notifyuser="yes" affectopers="no">
1586 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1587 # SSL channel mode module: Adds support for SSL-only channels (+z).
1588 # does not do anything useful without a working SSL module (see below)
1589 #<module name="m_sslmodes.so">
1591 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1592 # GnuTLS ssl module: Adds support for client-server SSL using GnuTLS,
1593 # if enabled. You must copy the source for this module from the directory
1594 # src/modules/extra, or answer 'yes' in ./configure when asked if you
1595 # want to enable this, or it will not load.
1596 #<module name="m_ssl_gnutls.so">
1598 #-#-#-#-#-#-#-#-#-#-#- GNUTLS CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#
1600 # m_ssl_gnutls.so is too complex it describe here, see the wiki: #
1601 # http://wiki.inspircd.org/Modules/ssl_gnutls #
1603 # NOTE: If you want to use this module to encrypt and sign your #
1604 # server to server traffic, you MUST load it before m_spanningtree in #
1605 # your configuration file! #
1607 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1608 # SSL Info module: Allows users to retrieve information about other
1609 # user's peer SSL certificates and keys. This can be used by client
1610 # scripts to validate users. For this to work, one of m_ssl_gnutls.so
1611 # or m_ssl_openssl.so must be loaded. This module also adds the
1612 # "* <user> is using a secure connection" whois line, the ability for
1613 # opers to use SSL fingerprints to verify their identity and the ability
1614 # to force opers to use SSL connections in order to oper up.
1615 # It is highly recommended to load this module especially if
1616 # you use SSL on your network.
1617 # For how to use the oper features, please see the first example <oper> tag
1618 # in opers.conf.example.
1620 #<module name="m_sslinfo.so">
1622 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1623 # OpenSSL ssl module: Adds support for client-server SSL using OpenSSL,
1624 # if enabled. You must copy the source for this module from the directory
1625 # src/modules/extra, or answer 'yes' in ./configure when asked if you
1626 # want to enable this, or it will not load.
1627 #<module name="m_ssl_openssl.so">
1629 #-#-#-#-#-#-#-#-#-#-#- OPENSSL CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#
1631 # m_ssl_openssl.so is too complex it describe here, see the wiki: #
1632 # http://wiki.inspircd.org/Modules/ssl_openssl #
1634 # NOTE: If you want to use this module to encrypt and sign your #
1635 # server to server traffic, you MUST load it before m_spanningtree in #
1636 # your configuration file! #
1638 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1639 # Strip color module: Adds the channel mode +S
1640 #<module name="m_stripcolor.so">
1642 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1643 # SILENCE module: Adds support for /SILENCE
1644 #<module name="m_silence.so">
1646 # Configuration tags:
1648 #<silence maxentries="32">
1650 # Sets the maximum number of entries on a users silence list.
1652 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1653 # SQLite3 module: Allows other SQL modules to access SQLite3 #
1654 # databases through a unified API. You must link the source for this #
1655 # module from the directory src/modules/extra to src/modules, plus #
1656 # the file m_sqlv2.h #
1657 # This modules is in extras. Re-run configure with: ./configure --enable-extras=m_aqlite.cpp
1658 # and run make install, then uncomment this module to enable it. #
1660 #<module name="m_sqlite3.so">
1662 #-#-#-#-#-#-#-#-#-#-#-#- SQL CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#-#
1664 # m_sqlite.so is more complex than described here, see the wiki for #
1665 # more: http://wiki.inspircd.org/Modules/sqlite3 #
1667 #<database module="sqlite" hostname="/full/path/to/database.db" id="anytext">
1669 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1670 # SQL authentication module: Allows IRCd connections to be tied into
1671 # a database table (for example a forum). You must copy the source for
1672 # this module from the directory src/modules/extra
1673 # Depends on the SQLutils module being loaded first.
1674 # This modules is in extras. Re-run configure with: ./configure --enable-extras=m_sqlauth.cpp
1675 # and run make install, then uncomment this module to enable it.
1677 #<module name="m_sqlauth.so">
1679 #-#-#-#-#-#-#-#-#-#-#- SQLAUTH CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#
1681 # m_sqlauth.so is too complex it describe here, see the wiki: #
1682 # http://wiki.inspircd.org/Modules/sqlauth #
1684 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1685 # SQL oper module: Allows you to store oper credentials in an SQL table
1686 # You must copy the source for this module from the directory src/modules/extra
1687 # Depends on the SQLutils module being loaded first.
1688 # This modules is in extras. Re-run configure with: ./configure --enable-extras=m_sqloper.cpp
1689 # and run make install, then uncomment this module to enable it.
1691 #<module name="m_sqloper.so">
1693 #-#-#-#-#-#-#-#-#-#-#- SQLOPER CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#
1695 # dbid - Database ID to use (see m_sql) #
1696 # hash - Hashing provider to use for password hashing #
1698 # See also: http://wiki.inspircd.org/Modules/sqloper #
1700 #<sqloper dbid="1" hash="md5">
1702 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1703 # SVSHold module: Implements SVSHOLD. Like Q:Lines, but can only be #
1704 # added/removed by Services. #
1705 #<module name="m_svshold.so">
1707 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1708 # SWHOIS module: Allows you to add arbitary lines to user WHOIS.
1709 # This module is oper-only.
1710 # To use, SWHOIS must be in one of your oper class blocks.
1711 #<module name="m_swhois.so">
1713 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1714 # Test module: enable this to create a command useful in testing
1715 # flood control. To avoid accidental use on live networks, the server
1716 # name must contain ".test" to load the module
1717 #<module name="m_testnet.so">
1719 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1720 # Timed bans module: Adds timed channel bans and the /TBAN command
1721 #<module name="m_timedbans.so">
1723 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1724 # Test line module: Adds the /TLINE command, used to test how many
1725 # users a /GLINE or /ZLINE etc would match.
1726 # This module is oper-only.
1727 # To use, TLINE must be in one of your oper class blocks.
1728 #<module name="m_tline.so">
1730 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1731 # UHNAMES support module: Adds support for the IRCX style UHNAMES
1732 # extension, which displays ident and hostname in the names list for
1733 # each user, saving clients from doing a WHO on the channel. Note that
1734 # this module is not widely supported yet. If a client does not support
1735 # UHNAMES it will not enable it, this will not break incompatible
1737 #<module name="m_uhnames.so">
1739 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1740 # Uninvite module: Adds the /UNINVITE command which lets users remove
1741 # pending invites from channels without waiting for the user to join.
1742 #<module name="m_uninvite.so">
1744 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1745 # Userip module: Adds the /USERIP command
1746 # This module is oper-only.
1747 # To use, USERIP must be in one of your oper class blocks.
1748 #<module name="m_userip.so">
1750 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1751 # Vhost module: Adds the VHOST command which allows for adding virtual
1752 # hosts which are accessible using a username and password in the config.
1753 #<module name="m_vhost.so">
1755 #-#-#-#-#-#-#-#-#-#-#- VHOST CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#-#
1757 # user - Username for the vhost. #
1759 # pass - Password for the vhost. #
1761 # hash - The hash for the specific user (optional) #
1762 # m_password_hash.so and a hashing module must be loaded #
1763 # for this to work. #
1765 # host - Vhost to set. #
1767 #<vhost user="some_username" pass="some_password" host="some.host">
1768 #<vhost user="foo" password="fcde2b2edba56bf408601fb721fe9b5c338d10ee429ea04fae5511b68fbf8fb9" hash="sha256" host="some.other.host">
1770 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1771 # Watch module: Adds the WATCH command, which is used by clients to
1772 # maintain notify lists.
1773 #<module name="m_watch.so">
1775 # Configuration tags:
1777 #<watch maxentries="32">
1779 # Sets the maximum number of entries on a user's watch list.
1781 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1782 # XLine database: Stores all *Lines (G/Z/K/R/any added by other modules)
1783 # in a file "xline.db" which can be re-loaded on restart. This is useful
1784 # for two reasons: it keeps bans so users may not evade them, and on
1785 # bigger networks, server connections will take less time as there will
1786 # be a lot less bans to apply - as most of them will already be there.
1787 #<module name="m_xline_db.so">
1789 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1790 # ____ _ _____ _ _ ____ _ _ _ #
1791 # | _ \ ___ __ _ __| | |_ _| |__ (_)___ | __ )(_) |_| | #
1792 # | |_) / _ \/ _` |/ _` | | | | '_ \| / __| | _ \| | __| | #
1793 # | _ < __/ (_| | (_| | | | | | | | \__ \ | |_) | | |_|_| #
1794 # |_| \_\___|\__,_|\__,_| |_| |_| |_|_|___/ |____/|_|\__(_) #
1796 # To link servers to InspIRCd, you MUST load the m_spanningtree #
1797 # module. If you don't do this, server links will NOT work at all. #
1798 # This is by design, to allow for the implementation of other linking #
1799 # protocols in modules in the future. #
1802 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1803 # Spanning Tree module - allows linking of servers using the spanning
1804 # tree protocol (see the READ THIS BIT section above).
1805 # You will almost always want to load this.
1807 #<module name="m_spanningtree.so">
projects / user / henk / code / inspircd.git / blob