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 # You may use wildcards in a <module> tag to load all modules which #
17 # match a glob pattern (e.g. m_sa????.so would load m_sajoin, #
18 # m_sapart, m_saquit and m_sanick) #
20 # ____ _ _____ _ _ ____ _ _ _ #
21 # | _ \ ___ __ _ __| | |_ _| |__ (_)___ | __ )(_) |_| | #
22 # | |_) / _ \/ _` |/ _` | | | | '_ \| / __| | _ \| | __| | #
23 # | _ < __/ (_| | (_| | | | | | | | \__ \ | |_) | | |_|_| #
24 # |_| \_\___|\__,_|\__,_| |_| |_| |_|_|___/ |____/|_|\__(_) #
26 # To link servers to InspIRCd, you MUST load the m_spanningtree #
27 # module. Since several features (like SSL server links) rely on #
28 # other modules being loaded before m_spanningtree, the module itself #
29 # is at the bottom of this file. DO NOT forget to load it. If you DO #
30 # NOT do this, server links will NOT work at all. ie. The ports will #
31 # NOT bind, and /connect will not work properly. This is by design, #
32 # to allow for the implementation of other linking protocols in #
33 # modules in the future. #
36 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
37 # MD5 Module - Allows other modules to generate MD5 hashes, usually for
38 # cryptographic uses and security.
41 # Other modules such as m_cloaking.so and m_password_hash.so may rely on
42 # this module being loaded to function.
44 #<module name="m_md5.so">
46 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
47 # SHA256 Module - Allows other modules to generate SHA256 hashes,
48 # usually for cryptographic uses and security.
51 # Other modules such as m_password_hash.so may rely on this module being
52 # loaded to function. Certain modules such as m_spanningtree.so will
53 # function without this module but when it is loaded their features will
54 # be enhanced (for example the addition of HMAC authentication).
56 #<module name="m_sha256.so">
57 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
58 # RIPEMD160 Module - Allows other modules to generate RIPEMD160 hashes,
59 # usually for cryptographic uses and security.
62 # Other modules may rely on this module being loaded to function.
63 #<module name="m_ripemd160.so">
65 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
66 # Abbreviation module: Provides the ability to abbreviate commands a-la
68 #<module name="m_abbreviation.so">
70 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
71 # Alias module: Allows you to define server-side command aliases
72 #<module name="m_alias.so">
76 #<fantasy prefix="!" allowbots="no">
79 # Set the prefix for in-channel aliases (fantasy commands) to the
80 # specified character. If not set, the default is "!".
82 # If this is set to no, +B clients will not be able to use fantasy
83 # commands. If not set, the default is no.
85 #-#-#-#-#-#-#-#-#-#-#- ALIAS DEFINITIONS -#-#-#-#-#-#-#-#-#-#-#-#-#-#
87 # If you have the m_alias.so module loaded, you may also define #
88 # aliases as shown below. They are commonly used to provide shortcut #
89 # commands to services, however they are not limited to just this use.#
90 # An alias tag requires the following values to be defined in it: #
92 # text - The text to detect as the actual command line, #
93 # Cant contain spaces, but case insensitive. #
94 # You may have multiple aliases with the same #
95 # command name (text="" value), however the first #
96 # found will be executed if its format value is #
97 # matched, or it has no format value. Aliases are #
98 # read from the top of the file to the bottom. #
100 # usercommand - If this is true, the alias can be run simply as #
101 # /aliasname. Defaults to true. #
103 # channelcommand - If this is true, the alias can be used as an #
104 # in-channel alias or 'fantasy command', prefixed #
105 # by the fantasy prefix character, !aliasname by #
106 # default. Defaults to false. #
108 # format - If this is defined, the parameters of the alias #
109 # must match this glob pattern. For example if you #
110 # want the first parameter to start with a # for #
111 # the alias to be executed, set format="#*" in the #
112 # alias definition. Note that the :'s which are #
113 # part of IRC formatted lines will be preserved #
114 # for matching of this text. This value is #
117 # replace - The text to replace 'text' with. Usually this #
118 # will be "PRIVMSG ServiceName :$2-" or similar. #
119 # You may use the variables $1 through $9 in the #
120 # replace string, which refer to the first through #
121 # ninth word in the original string typed by the #
122 # user. You may also use $1- through $9- which #
123 # refer to the first word onwards, through to the #
124 # ninth word onwards, e.g. if the user types the #
125 # command "foo bar baz qux quz" then $3- will hold #
126 # "baz qux quz" and $2 will contain "bar". You may #
127 # also use the special variables: $nick, $ident, #
128 # $host and $vhost, and you may separate multiple #
129 # commands with \n. If you wish to use the ACTUAL #
130 # characters \ and n together in a line, you must #
131 # use the sequence "\\n". #
133 # requires - If you provide a value for 'requires' this means #
134 # the given nickname MUST be online for the alias #
135 # to successfully trigger. If they are not, then #
136 # the user receives a 'no such nick' 401 numeric. #
138 # uline - Defining this value with 'yes', 'true' or '1' #
139 # will ensure that the user given in 'requires' #
140 # must also be on a u-lined server, as well as #
141 # actually being on the network. If the user is #
142 # online, but not on a u-lined server, then an #
143 # oper-alert is sent out as this is possibly signs #
144 # of a user trying to impersonate a service. #
146 # operonly - Defining this value, with a value of 'yes', '1' #
147 # or true will make the alias oper only. If a non- #
148 # oper attempts to use the alias, it will appear #
151 #<alias text="NICKSERV" replace="PRIVMSG NickServ :$2-" requires="NickServ" uline="yes">
152 #<alias text="CHANSERV" replace="PRIVMSG ChanServ :$2-" requires="ChanServ" uline="yes">
153 #<alias text="OPERSERV" replace="PRIVMSG OperServ :$2-" requires="OperServ" uline="yes" operonly="yes">
154 #<alias text="BOTSERV" replace="PRIVMSG BotServ :$2-" requires="BotServ" uline="yes">
155 #<alias text="HOSTSERV" replace="PRIVMSG HostServ :$2-" requires="HostServ" uline="yes">
156 #<alias text="MEMOSERV" replace="PRIVMSG MemoServ :$2-" requires="MemoServ" uline="yes">
157 #<alias text="NS" replace="PRIVMSG NickServ :$2-" requires="NickServ" uline="yes">
158 #<alias text="CS" replace="PRIVMSG ChanServ :$2-" requires="ChanServ" uline="yes">
159 #<alias text="OS" replace="PRIVMSG OperServ :$2-" requires="OperServ" uline="yes" operonly="yes">
160 #<alias text="BS" replace="PRIVMSG BotServ :$2-" requires="BotServ" uline="yes">
161 #<alias text="HS" replace="PRIVMSG HostServ :$2-" requires="HostServ" uline="yes">
162 #<alias text="MS" replace="PRIVMSG MemoServ :$2-" requires="MemoServ" uline="yes">
164 # An example of using the format value to create an alias with two
165 # different behaviours depending on the format of the parameters.
167 #<alias text="ID" format="#*" replace="PRIVMSG ChanServ :IDENTIFY $2 $3"
168 # requires="ChanServ" uline="yes">
170 #<alias text="ID" replace="PRIVMSG NickServ :IDENTIFY $2"
171 # requires="NickServ" uline="yes">
173 # This alias fixes a glitch in xchat 2.6.x and above and the way it
174 # assumes IDENTIFY must be prefixed by a colon (:) character. It should
175 # be placed ABOVE the default NICKSERV alias (the first example) listed
178 #<alias text="NICKSERV" format=":IDENTIFY *" replace="PRIVMSG NickServ :IDENTIFY $3-"
179 # requires="NickServ" uline="yes">
181 # You may also add aliases to trigger based on something said in a
182 # channel, aka 'fantasy' commands, configured in the same manner as any
183 # other alias, with usercommand="no" and channelcommand="yes" The
184 # command must be preceded by the fantasy prefix when used.
186 #<alias text="CS" usercommand="no" channelcommand="yes"
187 # replace="PRIVMSG ChanServ :$1 $chan $2-" requires="ChanServ" uline="yes">
189 # This would be used as "!cs <command> <options>", with the channel
190 # being automatically inserted after the command in the message to
191 # ChanServ, assuming the fantasy prefix is "!".
193 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
194 # Allowinvite module: Gives channel mode +A to allow all users to use
195 # /invite, and extban A to deny invite from specific masks
196 #<module name="m_allowinvite.so">
198 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
199 # Alltime module: Shows time on all connected servers at once.
200 # This module is oper-only and provides /alltime.
201 # To use, ALLTIME must be in one of your oper class blocks.
202 #<module name="m_alltime.so">
204 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
205 # Antibear security module: Prevents 'bear.txt' based trojans from
206 # connecting to your network by sending them a numeric they can't handle.
207 #<module name="m_antibear.so">
209 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
210 # Antibottler module: Labels bottler leech bots
211 #<module name="m_antibottler.so">
213 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
214 # Auditorium module: Adds channel mode +u which makes everyone else
215 # except you in the channel invisible, used for large meetings etc.
216 #<module name="m_auditorium.so">
218 # Auditorium settings:
220 #<auditorium showops="no" operoverride="no">
223 # Setting this value to yes makes m_auditorium behave like unrealircd
224 # +u channel mode, e.g. ops see users joining, parting, etc, and users
225 # joining the channel see the ops. Without this flag, the mode acts
226 # like ircnet's +a (anonymous channels), showing only the user in the
227 # names list, and not even showing the ops in the list, or showing the
228 # ops that the user has joined.
230 # Setting this value to yes makes m_auditorium affect the userlist for
231 # regular users only. Opers will view all users in the channel normally.
233 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
234 # Ban except module: Adds support for channel ban exceptions (+e)
235 #<module name="m_banexception.so">
237 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
238 # Ban redirection module: Allows bans which redirect to a specified
239 # channel. e.g. +b nick!ident@host#channelbanneduserissentto
240 #<module name="m_banredirect.so">
242 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
243 # Block amsg module: Attempt to block all usage of /amsg and /ame
244 #<module name="m_blockamsg.so">
246 #-#-#-#-#-#-#-#-#-#-#- BLOCKAMSG CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
248 # If you have the m_blockamsg.so module loaded, you can configure it #
249 # with the <blockamsg> tag: #
251 # delay - How many seconds between two messages to force #
252 # them to be recognised as unrelated. #
253 # action - Any of 'notice', 'noticeopers', 'silent', 'kill' #
254 # or 'killopers'. Define how to take action when #
255 # a user uses /amsg or /ame. #
257 #<blockamsg delay="3" action="killopers">
259 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
260 # Block CAPS module: Blocking all-CAPS messages with cmode +B
261 #<module name="m_blockcaps.so">
263 #-#-#-#-#-#-#-#-#-#-#- BLOCKCAPS CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
265 # percent - How many percent of text must be caps before text #
268 # minlen - The minimum length a line must be for the block #
269 # percent to have any effect. #
271 # capsmap - A list of chars to be considered CAPS, this was #
272 # you can add CAPS for your language. Also you can #
273 # add things like ! and space to further lock down #
275 #<blockcaps percent="50"
277 # capsmap="ABCDEFGHIJKLMNOPQRSTUVWXYZ! ">
279 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
280 # Block colour module: Blocking colour-coded messages with cmode +c
281 #<module name="m_blockcolor.so">
283 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
284 # Botmode module: Adds the user mode +B
285 #<module name="m_botmode.so">
287 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
288 # CallerID module: Adds usermode +g which activates hybrid-style
289 # callerid (== block all private messages unless you /accept first)
290 #<module name="m_callerid.so">
292 #-#-#-#-#-#-#-#-#-#-#- CALLERID CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#
293 # maxaccepts - Maximum number of entires a user can add to his #
294 # /accept list. Default is 16 entries. #
295 # operoverride - Can opers (note: ALL opers) ignore callerid mode? #
297 # tracknick - Preserve /accept entries when a user changes nick? #
298 # If no (the default), the user is removed from #
299 # everyone's accept list if he changes nickname. #
300 # cooldown - Amount of time (in seconds) that must pass since #
301 # the last notification sent to a user before he can #
302 # be sent another. Default is 60 (1 minute). #
303 #<callerid maxaccepts="16"
308 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
309 # CAP module: Provides the CAP negotiation mechanism seen in
310 # ratbox-derived ircds
311 #<module name="m_cap.so">
313 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
314 # CBAN module: Lets you disallow channels from being used at runtime.
315 # This module is oper-only and provides /cban.
316 # To use, CBAN must be in one of your oper class blocks.
317 #<module name="m_cban.so">
319 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
320 # Censor module: Adds the channel mode +G
321 #<module name="m_censor.so">
323 #-#-#-#-#-#-#-#-#-#-#- CENSOR CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#
325 # Optional - If you specify to use the m_censor module, then you must #
326 # specify some censor tags. See also: #
327 # http://wiki.inspircd.org/Modules/censor #
329 #<include file="censor.conf">
331 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
332 # CGI:IRC module: Adds support for automatic host changing in CGI:IRC
333 # (http://cgiirc.sourceforge.net).
334 #<module name="m_cgiirc.so">
336 #-#-#-#-#-#-#-#-#-#-#-# CGIIRC CONFIGURATION #-#-#-#-#-#-#-#-#-#-#-#-#
338 # Optional - If you specify to use m_cgiirc, then you must specify one
339 # or more cgihost tags which indicate authorised CGI:IRC servers which
340 # will be connecting to your network, and an optional cgiirc tag.
341 # For more information see: http://wiki.inspircd.org/Modules/cgiirc
343 # Set to yes if you want to notice opers when CGI clients connect
344 # <cgiirc opernotice="no">
346 # The type field indicates where the module should get the real
347 # client's IP address from, for further information, please see the
348 # CGI:IRC documentation.
351 # <cgihost type="pass" mask="www.mysite.com"> # Get IP from PASS
352 # <cgihost type="ident" mask="otherbox.mysite.com"> # Get IP from ident
353 # <cgihost type="passfirst" mask="www.mysite.com"> # See the docs
355 # <cgihost type="webirc" password="foobar"
356 # mask="somebox.mysite.com"> # Get IP from WEBIRC
361 # When you connect CGI:IRC clients, there are two connect classes which
362 # apply to these clients. When the client initially connects, the connect
363 # class which matches the cgi:irc site's host is checked. Therefore you
364 # must raise the maximum local/global clients for this ip as high as you
365 # want to allow cgi clients. After the client has connected and is
366 # determined to be a cgi:irc client, the class which matches the client's
367 # real IP is then checked. You may set this class to a lower value, so that
368 # the real IP of the client can still be restricted to, for example, 3
373 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
374 # Channel create module: Adds snomask +j, which will notify opers of
375 # any new channels that are created.
376 # This module is oper-only.
377 #<module name="m_chancreate.so">
379 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
380 # Channel filter module: Allows channel-op defined message
381 # filtering using simple string matches (channel mode +g)
382 #<module name="m_chanfilter.so">
384 # If hidemask is set to yes, the user will not be shown the mask when
385 # his/her message is blocked.
386 #<chanfilter hidemask="yes">
388 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
389 # Channel logging module: used to send snotice output to channels, to
390 # allow staff to centrally monitor and discuss network activity.
392 # The "channel" field is where you want the messages to go, "snomasks"
393 # is what snomasks you want to be sent to that channel. Multiple tags
395 #<module name="m_chanlog.so">
396 #<chanlog snomasks="AOcC" channel="#opers">
398 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
399 # Channelban: Implements extended ban j:, which stops anyone in already
400 # in a channel matching a mask like +b j:#channel*mask from joining.
401 #<module name="m_channelban.so">
403 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
404 # Chanprotect module: gives +q and +a channel modes
405 #<module name="m_chanprotect.so">
408 # noservices: With this set to yes, when a user joins a empty channel,
409 # the server will set +q on them. If set to no, it will only set +o
410 # on them until they register the channel.
413 # qprefix: Prefix (symbol) to use for +q users.
416 # aprefix: Prefix (symbol) to use for +a users.
419 # deprotectself: If this value is set (true, yes or 1), it will allow
420 # +a and +q users to remove the +a and +q from themselves, otherwise,
421 # the status will have to be removed by services.
424 # deprotectothers: If this value is set to yes, true, or 1, then any
425 # user with +q or +a may remove the +q or +a from other users.
426 deprotectothers="yes">
429 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
430 # Check module: gives /check
431 # Check is useful for looking up information on channels,
432 # users, IP addresses and hosts.
433 # This module is oper-only.
434 # To use, CHECK must be in one of your oper class blocks.
435 #<module name="m_check.so">
437 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
438 # CHGHOST module: Adds the /CHGHOST command
439 # This module is oper-only.
440 # To use, CHGHOST must be in one of your oper class blocks.
441 # NOTE: Services will not be able to set vhosts on users if this module
442 # isn't loaded. If you're planning on running services, you probably
444 #<module name="m_chghost.so">
446 #-#-#-#-#-#-#-#-# /CHGHOST - /SETHOST CONFIGURATION #-#-#-#-#-#-#-#-#
447 # Optional - If you want to use special chars for hostnames you can #
448 # specify your own custom list of chars with the <hostname> tag: #
450 # charmap - A list of chars accepted as valid by the /CHGHOST #
451 # and /SETHOST commands. Also note that the list is #
453 #<hostname charmap="abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ.-_/0123456789">
455 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
456 # CHGIDENT module: Adds the /CHGIDENT command
457 # This module is oper-only.
458 # To use, CHGIDENT must be in one of your oper class blocks.
459 #<module name="m_chgident.so">
461 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
462 # CHGNAME module: Adds the /CHGNAME command
463 # This module is oper-only.
464 # To use, CHGNAME must be in one of your oper class blocks.
465 #<module name="m_chgname.so">
467 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
468 # Cloaking module: Adds usermode +x and cloaking support.
469 # Relies on the module m_md5.so being loaded before m_cloaking.so in
470 # the configuration file.
471 # To use, you should enable m_conn_umodes and add +x as
472 # an enabled mode. See the m_conn_umodes module for more information.
473 #<module name="m_cloaking.so">
475 #-#-#-#-#-#-#-#-#-#-#- CLOAKING CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#
477 # Optional - If you specify the m_cloaking.so module as above, you #
478 # must define cloak keys, and optionally a cloak prefix as shown #
479 # below. When using cloaking, the cloak keys are MANDITORY and must #
480 # be included. However, if prefix is not included, it will default #
481 # to your networks name from the <server> tag. You can also include #
482 # the following optional values: #
484 # ipalways - Always cloak the IP address, not the hostname, #
485 # which doesn't reveal the user's ISP, but #
486 # results in hosts that are harder to read and #
489 # lowercase - Display the cloaked hostnames in lowercase #
490 # characters instead of uppercase #
492 # <cloak key1="0x2AF39F40" #
493 # key2="0x78E10B32" #
494 # key3="0x4F2D2E82" #
495 # key4="0x043A4C81" #
498 # lowercase="false"> #
500 # Please note that the key values will accept any number, and should #
501 # be large numbers. Using small numbers such as "7" or "1924" will #
502 # seriously weaken the security of your cloak. It is recommended you #
503 # use hexdecimal numbers prefixed by "0x", as shown in this example, #
504 # with each key eight hex digits long. #
506 #-#-#-#-#-#-#-#-#-#-#-#- CLOSE MODULE #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
507 # Close module: Allows an oper to close all unregistered connections.
508 # This module is oper-only and provides /close.
509 # To use, CLOSE must be in one of your oper class blocks.
510 #<module name="m_close.so">
512 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
513 # Clones module: Adds an oper command /CLONES for detecting cloned
514 # users. Warning: This module may be resource intensive when its
515 # command is issued, use with care.
516 # This module is oper-only.
517 # To use, CLONES must be in one of your oper class blocks.
518 #<module name="m_clones.so">
520 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
521 # Common channels module: Adds user mode +c, which, when set, requires
522 # that users must share a common channel with you to PRIVMSG or NOTICE
524 #<module name="m_commonchans.so">
526 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
527 # Conn-Join: Allows you to force users to join one or more channels
528 # automatically upon connecting to the server.
529 #<module name="m_conn_join.so">
531 #-#-#-#-#-#-#-#-#-#-#-#- CONNJOIN CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
533 # If you have m_conn_join.so loaded, you can configure it using the
536 #<autojoin channel="#one,#two,#three">
538 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
539 # Conn-Usermodes: Set modes on users when they connect
540 # When this module is loaded <connect:allow> tags may have an optional
541 # modes="" value, which contains modes to add or remove from users
542 # when they connect to the server.
543 #<module name="m_conn_umodes.so">
545 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
546 # Conn-Wait-for-Pong: Don't let a user connect until they PONG
547 #<module name="m_conn_waitpong.so">
549 #-#-#-#-#-#-#-#-#-#-#- WAITPONG CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
551 # If you have the m_conn_waitpong.so module loaded, configure it with #
552 # the <waitpong> tag: #
554 # sendsnotice - Whether to send a snotice on connect, like other #
557 # killonbadreply - Whether to kill the user if they send the wrong #
560 #<waitpong sendsnotice="yes" killonbadreply="yes">
563 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
564 # Channel cycle module. Server side /hop, with +ilk etc bypass.
565 #<module name="m_cycle.so">
567 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
568 # Connectban: Provides IP connection throttling. Any IP range that connects
569 # too many times (configurable) in an hour is zlined for a (configurable)
570 # duration, and their count resets to 0.
572 # ipv4cidr and ipv6cidr allow you to turn the comparison from individual
573 # IP addresses (32 and 128 bits) into CIDR masks, to allow for throttling
574 # over whole ISPs/blocks of IPs, which may be needed to prevent attacks.
576 #<connectban threshold="10" duration="10m" ipv4cidr="32" ipv6cidr="128">
577 # This allows for 10 connections in an hour with a 10 minute ban if that is exceeded.
579 #<module name="m_connectban.so">
581 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
582 # Connection throttle module. Configuration:
583 #<module name="m_connflood.so">
585 #-#-#-#-#-#-#-#-#-#-#- CONTHROTTLE CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
586 # seconds, maxconns - Amount of connections per <seconds>.
588 # timeout - Time to wait after the throttle was activated
589 # before deactivating it. Be aware that the time
590 # is seconds + timeout.
592 # quitmsg - The message that users get if they attempt to
593 # connect while the throttle is active.
595 # bootwait - Amount of time to wait before enforcing the
596 # throttling when the server just booted.
598 #<connflood seconds="30" maxconns="3" timeout="30"
599 # quitmsg="Throttled" bootwait="10">
601 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
602 # Custom title module: Adds the /TITLE command which allows for trusted
603 # users to gain a custom whois line and a optional
604 # vhost can be specified.
605 #<module name="m_customtitle.so">
607 #-#-#-#-#-#-#-#-#-#- CUSTOM TITLE CONFIGURATION -#-#-#-#-#-#-#-#-#-#
608 # name - The username used to identify
609 # password - The password used to identify
610 # hash - The hash for the specific user's password (optional)
611 # m_password_hash.so and a hashing module must be loaded for this to work
612 # host - Allowed hostmask [optional]
613 # title - Title shown in whois
614 # vhost - Displayed host [optional]
616 #<title name="foo" password="bar" title="Official Chat Helper">
617 #<title name="bar" password="foo" host="ident@host.name" title="Official Chat Helper" vhost="helper.network.chat">
618 #<title name="foo" password="fcde2b2edba56bf408601fb721fe9b5c338d10ee429ea04fae5511b68fbf8fb9" hash="sha256" title="Official Chat Helper">
620 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
621 # DCCALLOW module: Adds the /DCCALLOW command
622 #<module name="m_dccallow.so">
624 #-#-#-#-#-#-#-#-#-#-#- DCCALLOW CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
625 # blockchat - Whether to block DCC CHAT as well as DCC SEND
626 # length - Default duration of entries in DCCALLOW list
627 # action - Default action to take if no action is specified
628 # can be 'block' or 'allow'
630 # File configuration:
631 # pattern - The glob pattern to match against
632 # action - Action to take if a user attempts to send a file
633 # that matches this pattern, can be 'block' or 'allow'
635 #<dccallow blockchat="yes" length="5m" action="block">
636 #<banfile pattern="*.exe" action="block">
637 #<banfile pattern="*.txt" action="allow">
639 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
641 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
642 # Deaf module: adds support for ircu style usermode +d - deaf to
643 # channel messages and channel notices.
644 #<module name="m_deaf.so">
646 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
647 # Delay join module: Adds the channel mode +D which delays all JOIN
648 # messages from users until they speak. If they quit or part before
649 # speaking, their quit or part message will not be shown to the channel
650 # which helps cut down noise on large channels in a more friendly way
651 # than the auditorium mode. Only channel ops may set the +D mode.
652 #<module name="m_delayjoin.so">
654 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
655 # Delay message module: Adds the channel mode +d which disallows a user
656 # from talking in the channel unless they've been joined for X seconds.
657 # Settable a la: /mode +d 30
658 #<module name="m_delaymsg.so>
660 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
661 # Deny Channels: Deny Channels from being used by users
662 #<module name="m_denychans.so">
664 #-#-#-#-#-#-#-#-#-#-#- DENYCHAN DEFINITIONS -#-#-#-#-#-#-#-#-#-#-#-#
666 # If you have the m_denychans.so module loaded, you need to specify #
667 # the channels to deny: #
669 # name - The channel name to deny. (glob masks are ok) #
671 # allowopers - If operators are allowed to override the deny. #
673 # reason - Reason given for the deny. #
675 # redirect - Redirect the user to a different channel #
677 #<badchan name="#gods*" allowopers="yes" reason="Tortoises!"> #
678 #<badchan name="#heaven" redirect="#hell" reason="Nice try!"> #
680 # Redirects will not work if the target channel is set +L. #
682 # Additionally, you may specify channels which are allowed, even if #
683 # a badchan tag specifies it would be denied: #
684 #<goodchan name="#godsleeps"> #
685 # Glob masks are accepted here also.
687 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
688 # Devoice Module: Let users devoice themselves.
689 #<module name="m_devoice.so">
691 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
692 # DNS Blacklist Module: Provides support for looking up IPs on one or #
694 #<module name="m_dnsbl.so"> #
696 # For configuration options please see the wiki page for m_dnsbl at #
697 # http://wiki.inspircd.org/Modules/dnsbl #
699 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
700 # Exempt Channel Operators Module: Provides support for allowing #
701 # channel operators to be exempt from some channel modes. Supported #
702 # modes are blockcaps, noctcp, blockcolor, nickflood, flood, censor, #
703 # filter, regmoderated, nonick, nonotice, and stripcolor. #
704 #<module name="m_exemptchanops.so"> #
706 #-#-#-#-#-#-#-#-#-#- EXEMPTCHANOPS CONFIGURATION -#-#-#-#-#-#-#-#-#-#
707 # alwaysexempt - Modes channel operators are always exempt from,
708 # regardless of channel setting.
709 # neverexempt - Modes channel operators are never exempt from,
710 # regardless of channel setting.
711 #<exemptchanops alwaysexempt="nickflood censor flood filter" neverexempt="regmoderated">
714 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
715 # Filter module: Provides message filtering, similar to SPAMFILTER.
716 #<module name="m_filter.so">
718 # This module depends upon a regex provider such as m_regex_pcre or #
719 # m_regex_glob to function. You must specify which of these you want #
720 # m_filter to use via the tag below. #
722 # Valid engines are: #
724 # glob - Glob patterns, provided via m_regex_glob.so #
725 # pcre - PCRE regexps, provided via m_regex_pcre.so, needs libpcre #
726 # tre - TRE regexps, provided via m_regex_tre.so, requires libtre #
727 # posix - POSIX regexps, provided via m_regex_posix.so, not availale #
728 # on windows, no dependencies on other operating systems. #
730 #<filteropts engine="glob"> #
732 # Your choice of regex engine must match on all servers network-wide.
734 # You may specify specific channels that are exempt from being filtered:
735 #<exemptfromfilter channel="#blah">
737 #-#-#-#-#-#-#-#-#-#-#- FILTER CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#
739 # Optional - If you specify to use the m_filter module, then #
740 # specfiy below the path to the filter.conf file, or define some #
743 #<include file="filter.conf">
745 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
746 # Gecosban: Implements extended ban r:, which stops anyone matching
747 # a mask like +b r:*realname?here* from joining a channel.
748 #<module name="m_gecosban.so">
750 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
751 # GeoIP module: Allows the server admin to ban users by country code.
752 # This modules is in extras. Re-run configure with: ./configure --enable-extras=m_geoip.cpp
753 # and run make install, then uncomment this module to enable it.
754 # This module requires GeoIP to be installed on your system,
755 # use your package manager to find the appropriate packages
756 # or check the InspIRCd wiki page for this module.
757 #<module name="m_geoip.so">
759 #-#-#-#-#-#-#-#-#-#-#-# GEOIP CONFIGURATION #-#-#-#-#-#-#-#-#-#-#-#-#
761 # <geoip banunknown="false"> #
763 # Set this value to true or yes to block unknown IP ranges which are #
764 # not in the database (usually LAN addresses, localhost, etc) #
766 # <geoban country="TR" reason="This country not permitted"> #
768 # Use one or more of these tags to ban countries by country code. #
769 # The country code must be in capitals and should be an ISO country #
770 # code such as TR, GB, or US. #
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="helpop.conf">
799 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
800 # HIDECHANS module: Allows opers 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 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
831 # httpd module: Provides http server support for InspIRCd
832 #<module name="m_httpd.so">
834 #-#-#-#-#-#-#-#-#-#-#-#- HTTPD CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
836 # Optional - If you choose to use the m_httpd.so module, then you must
837 # specify the port number and other details of your http server:
839 #<http ip="192.168.1.10" host="brainwave" port="32006"
840 # index="/home/brain/inspircd/http/index.html">
842 # You may have as many of these tags as you wish, each with a different
843 # IP, port, host or index file. Each one will act as an independent
847 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
848 # http ACL module: Provides access control lists for m_httpd dependent
849 # modules. Use this module to restrict pages by IP address and by
852 #<module name="m_httpd_acl.so">
854 #-#-#-#-#-#-#-#-#-#-#-#- HTTPD ACL CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
856 # Restrict access to the m_httpd_stats module to all but the local
857 # network and when the correct password is specified:
859 # <httpdacl path="/stats*" types="password,whitelist"
860 # username="secretstuff" password="mypasshere" whitelist="127.0.0.*,10.*">
862 # Deny all connections to all but the main index page:
864 # <httpdacl path="/*" types="blacklist" blacklist="*">
867 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
868 # http config module: Allows the server's configuration to be viewed
869 # over HTTP. Requires m_httpd.so to be loaded for it to function.
870 #<module name="m_httpd_config.so">
872 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
873 # http stats module: Provides basic stats pages over HTTP
874 # Requires m_httpd.so to be loaded for it to function.
875 #<module name="m_httpd_stats.so">
877 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
878 # Ident: Provides RFC 1413 ident lookup support
879 # When this module is loaded <connect:allow> tags may have an optional
880 # useident="yes|no" boolean value, determining whether or not to lookup
881 # ident on users matching that connect tag.
882 #<module name="m_ident.so">
884 #-#-#-#-#-#-#-#-#-#-#-#- IDENT CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
886 # Optional - If you are using the m_ident.so module, then you can #
887 # specify the timeout for ident lookups here. If not defined, it will #
888 # default to one second. This is a non-blocking timeout which holds #
889 # the user in a 'connecting' state until the lookup is complete. #
890 # The bind value indicates which IP to bind outbound requests to. #
894 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
895 # Invite except module: Adds support for channel invite exceptions (+I)
896 #<module name="m_inviteexception.so">
898 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
899 # Invisible module - Adds support for usermode +Q (quiet) which lets an
900 # oper go 'invisible' similar to unrealircd 3.1's +I mode. Note that
901 # opers are still able to see invisible users, and if an oper with +Q
902 # deopers, they will become visible.
904 # This module is oper-only and seen by many to be quite abusive.
906 #<module name="m_invisible.so">
908 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
909 # Join flood module: Adds support for join flood protection (+j)
910 #<module name="m_joinflood.so">
912 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
913 # Jump Server module: Adds support for the RPL_REDIR numeric
914 # This module is oper-only.
915 # To use, JUMPSERVER must be in one of your oper class blocks.
916 #<module name="m_jumpserver.so">
918 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
919 # Anti-Auto-Rejoin: Adds support for prevention of auto-rejoin (+J)
920 #<module name="m_kicknorejoin.so">
922 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
923 # Knock module: adds the /KNOCK command and +K channel mode
924 #<module name="m_knock.so">
926 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
927 # LDAP authentication module: Adds the ability to authenticate users #
928 # via LDAP. This is an extra module which must be enabled explicitly #
929 # by symlinking it from modules/extra, and requires the OpenLDAP libs #
930 # This modules is in extras. Re-run configure with: ./configure --enable-extras=m_ldapauth.cpp
931 # and run make install, then uncomment this module to enable it. #
933 #<module name="m_ldapauth.so"> #
937 # <ldapauth baserdn="ou=People,dc=brainbox,dc=cc" #
939 # server="ldap://brainwave.brainbox.cc" #
940 # allowpattern="Guest*" #
941 # killreason="Access denied" #
942 # searchscope="subtree" #
943 # binddn="cn=Manager,dc=brainbox,dc=cc" #
944 # bindauth="mysecretpass" #
947 # The baserdn indicates the base DN to search in for users. Usually #
948 # this is 'ou=People,dc=yourdomain,dc=yourtld'. #
950 # The attribute value indicates the attribute which is used to locate #
951 # a user account by name. On POSIX systems this is usually 'uid'. #
953 # The server parameter indicates the LDAP server to connect to. The #
954 # ldap:// style scheme before the hostname proper is MANDITORY. #
956 # The allowpattern value allows you to specify a wildcard mask which #
957 # will always be allowed to connect regardless of if they have an #
958 # account, for example guest users. #
960 # Killreason indicates the QUIT reason to give to users if they fail #
963 # The searchscope value indicates the subtree to search under. On our #
964 # test system this is 'subtree'. Your mileage may vary. #
966 # Setting the verbose value causes an oper notice to be sent out for #
967 # every failed authentication to the server, with an error string. #
969 # The binddn and bindauth indicate the DN to bind to for searching, #
970 # and the password for the distinguished name. Some LDAP servers will #
971 # allow anonymous searching in which case these two values do not #
972 # need defining, otherwise they should be set similar to the examples #
975 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
976 # LDAP oper configuration module: Adds the ability to authenticate #
977 # opers via LDAP. This is an extra module which must be enabled #
978 # explicitly by symlinking it from modules/extra, and requires the #
979 # OpenLDAP libs. Re-run configure with: ./configure --enable-extras=m_ldapoper.cpp
980 # and run make install, then uncomment this module to enable it. #
982 #<module name="m_ldapoper.so">
986 # <ldapoper baserdn="ou=People,dc=brainbox,dc=cc"
987 # server="ldap://brainwave.brainbox.cc"
988 # searchscope="subtree"
989 # binddn="cn=Manager,dc=brainbox,dc=cc"
990 # bindauth="mysecretpass">
992 # Available configuration items are identical to the same items in #
993 # m_ldapauth above. #
995 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
996 # Lock server module: Adds /LOCKSERV and /UNLOCKSERV commands that is #
997 # used to temporarily close/open for new connections to the server. #
998 # These commands require OPER status and that the LOCKSERV UNLOCKSERV #
999 # are specified in a <class> tag that the oper is part of. This is so #
1000 # you can control who has access to this possible dangerous command. #
1001 # If your server is locked and you got disconnected, do a REHASH from #
1002 # shell to open up again.
1004 # This module is oper-only.
1006 #<module name="m_lockserv.so">
1008 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1009 # Map hiding module: replaces /MAP and /LINKS output to users with a #
1010 # message to see a website, set by maphide="http://link.to/site" in #
1011 # the security tag, instead. #
1012 #<module name="m_maphide.so">
1014 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1015 # Msg flood module: Adds message/notice flood protection (+f)
1016 #<module name="m_messageflood.so">
1018 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1019 # MsSQL module: Allows other SQL modules to access MS SQL Server
1020 # through a unified API. You must copy the source for this module
1021 # from the directory src/modules/extra, plus the file m_sqlv2.h
1022 # This modules is in extras. Re-run configure with: ./configure --enable-extras=m_mssql.cpp
1023 # and run make install, then uncomment this module to enable it.
1025 #<module name="m_mssql.so">
1027 #-#-#-#-#-#-#-#-#-#-#-#- SQL CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#-#
1029 # m_mssql.so is more complex than described here, see wiki for more #
1030 # info http://wiki.inspircd.org/Modules/mssql #
1032 #<database name="db" username="user" password="pass" hostname="localhost" id="db1">
1034 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1035 # MySQL module: Allows other SQL modules to access MySQL databases
1036 # through a unified API. You must copy the source for this module
1037 # from the directory src/modules/extra, plus the file m_sqlv2.h
1038 # This modules is in extras. Re-run configure with: ./configure --enable-extras=m_mysql.cpp
1039 # and run make install, then uncomment this module to enable it.
1041 #<module name="m_mysql.so">
1043 #-#-#-#-#-#-#-#-#-#-#-#- SQL CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#-#
1045 # m_mysql.so is more complex than described here, see the wiki for #
1046 # more: http://wiki.inspircd.org/Modules/mysql #
1048 #<database name="mydb" username="myuser" password="mypass" hostname="localhost" id="my_database2">
1050 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1051 # NAMESX module: Provides support for the NAMESX extension which allows
1052 # clients to see all the prefixes set on a user without getting confused.
1053 # This is supported by mIRC, x-chat, klient, and maybe more.
1054 #<module name="m_namesx.so">
1056 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1057 # National characters module:
1058 # 1) Allows using national characters in nicknames.
1059 # 2) Allows using custom (national) casemapping over the network.
1060 # file -- filename of existing file in "locales" directory
1061 # casemapping -- custom value for 005 numeric (if you want it to be
1062 # different from the filename.
1064 #<nationalchars file="bynets/russian-w1251-charlink" casemapping="ru_RU.cp1251-charlink">
1065 #<module name="m_nationalchars.so">
1067 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1068 # Nickchange flood protection module: Allows up to X nick changes in Y seconds.
1069 # Provides channel mode +F.
1070 #<module name="m_nickflood.so">
1072 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1073 # Nicklock module: Let opers change a user's nick and then stop that
1074 # user from changing their nick again.
1075 # This module is oper-only.
1076 # To use, NICKLOCK and NICKUNLOCK must be in one of your oper class blocks.
1077 #<module name="m_nicklock.so">
1079 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1080 # No ctcp module: Adds the channel mode +C to block CTCPs and extban C
1081 # to block CTCPs sent by specific users.
1082 #<module name="m_noctcp.so">
1084 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1085 # No kicks module: Adds the +Q channel mode and the Q: extban to deny
1086 # certain users from kicking.
1087 #<module name="m_nokicks.so">
1089 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1090 # No nicks module: Adds the +N channel mode, as well as the +b N:
1091 # extended bantype. +N stops all users from changing their nick,
1092 # the +b N: extban stops anyone from matching a +b N:nick!user@host
1093 # mask from changing their nick.
1094 #<module name="m_nonicks.so">
1096 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1097 # No part message module: adds extban 'p' to block part messages from #
1099 #<module name="m_nopartmsg.so">
1101 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1102 # No Notice module: adds the channel mode +T and the extban T to block
1103 # specific users from noticing the channel.
1104 #<module name="m_nonotice.so">
1106 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1107 # Network buisness join module
1108 # Allows an oper to join a channel using /OJOIN, giving them +Y on the
1109 # channel which makes them immune to kick/deop/etc.
1110 #<module name="m_ojoin.so">
1112 #<ojoin prefix="!" notice="yes" op="yes">
1113 # Specify the prefix that +Y will grant here
1114 # Leave prefix empty if you do not wish +Y to grant a prefix
1115 # If notice is set to on, upon ojoin, the server will notice
1116 # the channel saying that the oper is joining on network business
1117 # If op is set to on, it will give them +o along with +Y
1120 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1121 # Oper channels mode: Adds the +O channel mode and +beI type O:<mask>
1122 # to ban, exempt, and invex given oper type masks.
1123 # e.g, /mode #channel +iI O:* is equivilant to chmode +O, but you
1124 # may also, e.g. /mode #channel +iI O:AdminTypeOnly to only allow admins.
1125 # +be work in a similar fashion.
1127 #<module name="m_operchans.so">
1129 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1130 # Oper Join module: Auto-joins opers to a channel upon oper-up
1131 # This module is oper-only. For the user equivalent, see m_conn_join.
1132 #<module name="m_operjoin.so">
1134 #-#-#-#-#-#-#-#-#-#-# OPERJOIN CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
1136 # If you are using the m_operjoin.so module, specify options here: #
1138 # channel - The channel name to join, can also be a comma #
1139 # seperated list eg. "#channel1,#channel2". #
1141 # override - Lets the oper join walking thru any modes that #
1142 # might be set, even bans. Use "yes" or "no". #
1144 #<operjoin channel="#channel" override="no">
1146 # Alternatively you can use the autojoin="channellist" in a <type> #
1147 # tag to set specific autojoins for a type of oper, for example: #
1149 #<type name="Helper" autojoin="#help" classes="...">
1151 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1152 # Oper log module: Logs all oper commands to the ircd log at default
1154 # This module is oper-only.
1155 #<module name="m_operlog.so">
1157 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1158 # Oper prefixing module: Gives IRC operators a prefix status character
1159 # on all channels they are in.
1161 #<module name="m_operprefix.so">
1163 # You may additionally customise the prefix character.
1164 #<operprefix prefix="!">
1166 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1167 # Oper MOTD module: Provides support for seperate message of the day
1169 # This module is oper-only.
1170 #<module name="m_opermotd.so">
1172 #-#-#-#-#-#-#-#-#-#-# OPERMOTD CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
1174 # If you are using the m_opermotd.so module, specify the motd here #
1176 # onoper - Should the message be sent on /OPER or only when #
1177 # /OPERMOTD is used. Use "yes" or "no". #
1179 #<opermotd file="oper.motd" onoper="yes">
1181 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1182 # Override module: Adds support for oper override
1183 # This module is oper-only.
1184 #<module name="m_override.so">
1186 #-#-#-#-#-#-#-#-#-#-# OVERRIDE CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
1188 # m_override.so is too complex it describe here, see the wiki: #
1189 # http://wiki.inspircd.org/Modules/override #
1191 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1192 # Oper levels module: Gives each oper a level and prevents
1193 # actions being taken against higher level opers
1194 # Specify the level as the 'level' parameter of the <type> tag
1195 # # This module is oper-only.
1196 #<module name="m_operlevels.so">
1198 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1199 # Oper modes module: Allows you to specify modes to add/remove on oper
1200 # Specify the modes as the 'modes' parameter of the <type> tag
1201 # and/or as the 'modes' parameter of the <oper> tag.
1202 # This module is oper-only. For the user equivalent, see m_conn_umodes
1203 #<module name="m_opermodes.so">
1205 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1206 # Oper password hash module: Allows hashed oper passwords
1207 # Relies on the module m_md5.so and/or m_sha256.so being loaded before
1208 # m_password_hash.so in the configuration file.
1209 # This module is oper-only.
1210 #<module name="m_password_hash.so">
1212 #-#-#-#-#-#-#-#-#-#-# OPER HASH CONFIGURATION #-#-#-#-#-#-#-#-#-#-#-#-#
1214 # To use this module, you must define a hash type for each oper's
1215 # password you want to hash. For example:
1217 # <oper name="Brain"
1218 # host="ident@dialup15.isp.com"
1220 # password="a41d730937a53b79f788c0ab13e9e1d5"
1223 # The types of hashing available vary depending on which hashing modules
1224 # you load, but usually if you load m_sha256.so and m_md5.so, both md5
1225 # and sha256 type hashing will be available (the most secure of which
1228 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1229 # Permanent Channels module: Channels with the permanent channels mode
1230 # will remain open even after everyone else has left the channel, and
1231 # therefore keep things like modes, ban lists and topic. Permanent
1232 # channels -may- need support from your Services package to function
1233 # properly with them. This adds channel mode +P.
1234 # This module is oper-only.
1235 #<module name="m_permchannels.so">
1237 # If you like, m_permchannels can write a config file of permanent channels
1238 # whenever +P is set, unset, or the topic/modes on a +P channel is changed.
1239 # If you want to do this, set the filename below, and uncomment the include.
1241 # The conf file generated has a path relative to the inspircd binary, hence '../conf/'.
1243 #<permchanneldb filename="../conf/permchannels.conf">
1244 #<include file="permchannels.conf">
1246 # You may also create channels on startup by using the <permchannels> block.
1247 #<permchannels channel="#opers" modes="is" topic="Opers only.">
1249 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1250 # PostgreSQL module: Allows other SQL modules to access PgSQL databases
1251 # through a unified API. You must copy the source for this module
1252 # from the directory src/modules/extra, plus the file m_sqlv2.h
1253 # This modules is in extras. Re-run configure with: ./configure --enable-extras=m_pgsql.cpp
1254 # and run make install, then uncomment this module to enable it.
1256 #<module name="m_pgsql.so">
1258 #-#-#-#-#-#-#-#-#-#-#-#- SQL CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#-#
1260 # m_pgsql.so is more complex than described here, see the wiki for #
1261 # more: http://wiki.inspircd.org/Modules/pgsql #
1263 #<database name="mydb" username="myuser" password="mypass" hostname="localhost" id="my_database" ssl="no">
1265 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1266 # Muteban: Implements extended ban m:, which stops anyone matching
1267 # a mask like +b m:nick!user@host from speaking on channel.
1268 #<module name="m_muteban.so">
1271 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1272 # Random Quote module: provides a random quote on connect.
1273 # NOTE: Some of these may mimic fatal errors and confuse users and
1274 # opers alike! - BEWARE!
1275 #<module name="m_randquote.so">
1277 #-#-#-#-#-#-#-#-#-#- RANDOMQUOTES CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
1279 # Optional - If you specify to use the m_randquote.so module, then #
1280 # specify below the path to the randquotes.conf file. #
1282 #<randquote file="randquotes.conf">
1284 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1285 # Redirect module: Adds channel redirection (mode +L)
1286 #<module name="m_redirect.so">
1288 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1289 # Regular Expression Provider for Glob or wildcard (?/*) matching.
1290 # You must have at least 1 provider loaded to use m_filter or m_rline
1291 # modules. This module has no additional requirements, as it uses the
1292 # matching already present in InspIRCd core.
1293 #<module name="m_regex_glob.so">
1295 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1296 # Regular Expression Provider for PCRE (Perl-Compatible Regular
1297 # Expressions). You need libpcre installed to compile and load this
1298 # module. You must have at least 1 provider loaded to use m_filter or
1300 #<module name="m_regex_pcre.so">
1302 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1303 # Regular Expression Provider for POSIX Regular Expressions.
1304 # You shouldn't need any additional libraries on a POSIX-compatible
1305 # system (ie: any Linux, BSD, but not Windows). You must have at least
1306 # 1 provider loaded to use m_filter or m_rline.
1307 # On POSIX-compliant systems, regex syntax can be found by using the
1308 # command: 'man 7 regex'.
1309 #<module name="m_regex_posix.so">
1311 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1312 # Regular Expression Provider for TRE Regular Expressions.
1313 # This is the same regular expression engine used by UnrealIRCd, so
1314 # if you are most familiar with the syntax of /spamfilter from there,
1315 # this is the provider you want. You need libtre installed in order
1316 # to compile and load this module.
1317 #<module name="m_regex_tre.so">
1319 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1320 # Registered users only channel creation
1321 # Allows only registered users and opers to create new channels.
1323 # You probably *DO NOT* want to load this module on a public network.
1325 #<module name="m_regonlycreate.so">
1327 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1328 # Remove module: Adds the /REMOVE command which is a peaceful
1329 # alternative to /KICK
1330 #<module name="m_remove.so">
1332 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1333 # Restricted channels module: Allows only opers to create channels.
1335 # You probably *DO NOT* want to load this module on a public network.
1337 #<module name="m_restrictchans.so">
1339 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1340 # Restrict message module: Allows users to only message opers.
1342 # You probably *DO NOT* want to load this module on a public network.
1344 #<module name="m_restrictmsg.so">
1346 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1347 # Ban users through regular expression patterns
1348 #<module name="m_rline.so">
1350 #-#-#-#-#-#-#-#-#-#-#-#- RLINE CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#-#
1352 # If you wish to re-check a user when they change nickname (can be
1353 # useful under some situations, but *can* also use CPU with more users
1354 # on a server) then set the following configuration value:
1355 # Also, this is where you set what Regular Expression engine is to be
1356 # used. If you ever change it while running, all of your R-Lines will be
1357 # wiped. This is the regex engine used by all R-Lines set, and
1358 # m_regex_<engine>.so must be loaded, or rline will be nonfunctional
1359 # until you load it or change the engine to one that is loaded.
1361 #<rline matchonnickchange="yes" engine="pcre">
1363 # Generally, you will NOT want to use 'glob' here, as this turns
1364 # rline into just another gline. The exceptions are that rline will
1365 # always use the full nick!user@host realname string, rather than only
1366 # user@host, but beware that only the ? and * wildcards are available,
1367 # and are the only way to specify where the space can occur if you do
1368 # use glob. For this reason, is recommended to use a real regex engine
1369 # so that at least \s or [[:space:]] is available.
1371 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1372 # JSON-RPC module: Encode and decode JSON-RPC requests for modules
1373 #<module name="m_rpc_json.so">
1375 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1376 # RPC test module: A test of the RPC API
1377 #<module name="m_rpctest.so">
1379 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1380 # SAJOIN module: Adds the /SAJOIN command
1381 # This module is oper-only.
1382 # To use, SAJOIN must be in one of your oper class blocks.
1383 #<module name="m_sajoin.so">
1385 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1386 # SAKICK module: Adds the /SAKICK command
1387 # This module is oper-only.
1388 # To use, SAKICK must be in one of your oper class blocks.
1389 #<module name="m_sakick.so">
1391 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1392 # SAMODE module: Adds the oper /SAMODE command
1393 # This module is oper-only.
1394 # To use, SAMODE must be in one of your oper class blocks.
1395 #<module name="m_samode.so">
1397 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1398 # SANICK module: Allows opers to change user's nicks
1399 # This module is oper-only.
1400 # To use, SANICK must be in one of your oper class blocks.
1401 #<module name="m_sanick.so">
1403 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1404 # SAPART module: Adds the oper /SAPART command
1405 # This module is oper-only.
1406 # To use, SAPART must be in one of your oper class blocks.
1407 #<module name="m_sapart.so">
1409 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1410 # SAQUIT module: Adds the oper /SAQUIT command (abusable!!!)
1411 # This module is oper-only.
1412 # To use, SAQUIT must be in one of your oper class blocks.
1413 #<module name="m_saquit.so">
1415 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1416 # SATOPIC module: Adds the oper /SATOPIC command
1417 # This module is oper-only.
1418 # To use, SATOPIC must be in one of your oper class blocks.
1419 #<module name="m_satopic.so">
1421 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1422 # SASL authentication module: Provides support for IRC Authentication
1423 # Layer (aka: atheme SASL) via AUTHENTICATE.
1424 #<module name="m_sasl.so">
1426 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1427 # Secure list module: Prevent /LIST in the first minute of connection,
1428 # crippling most spambots and trojan spreader bots.
1429 #<module name="m_securelist.so">
1431 #-#-#-#-#-#-#-#-#-# SECURELIST CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#-#
1433 # Securelist can be harmful to some irc search engines such as #
1434 # netsplit.de and searchirc.com. To prevent securelist blocking these #
1435 # sites from listing, define exception tags as shown below: #
1436 <securehost exception="*@*.searchirc.org">
1437 <securehost exception="*@*.netsplit.de">
1438 <securehost exception="*@echo940.server4you.de">
1440 # Define the following variable to change how long a user must wait #
1441 # before issuing a LIST. If not defined, defaults to 60 seconds. #
1443 #<securelist waittime="60"> #
1445 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1446 # Servprotect module: Provides support for Austhex style +k /
1447 # UnrealIRCD +S services mode
1448 #<module name="m_servprotect.so">
1450 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1451 # See nicks module: Allow for SNOMASK +N which shows nick changes.
1452 # This module is oper-only.
1453 #<module name="m_seenicks.so">
1455 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1456 # Set Idle module: Adds a command for opers to change their
1457 # idle time (mainly a toy)
1458 # This module is oper-only.
1459 # To use, SETIDLE must be in one of your oper class blocks.
1460 #<module name="m_setidle.so">
1462 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1463 # Services support module: Adds several usermodes such as +R and +M
1464 # this module implements the 'identified' state via account names (AC)
1465 # and is similar in operation to the way asuka and ircu handle services.
1467 # At the same time, this offers +r for users and channels to mark them
1468 # as identified seperately from the idea of a master account, which
1469 # can be useful for services which are heavily nick-as-account centric.
1471 # This replaces m_services from 1.1 and earlier.
1473 # Also of note is that this module implements two extbans:
1474 # +b R: (stop matching account names from joining)
1475 # +b M: (stop matching account names from speaking)
1477 #<module name="m_services_account.so">
1479 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1480 # Sethost module: Adds the /SETHOST command
1481 # This module is oper-only.
1482 # To use, SETHOST must be in one of your oper class blocks.
1483 # See m_chghost for how to customise valid chars for hostnames
1484 #<module name="m_sethost.so">
1486 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1487 # Setident module: Adds the /SETIDENT command
1488 # This module is oper-only.
1489 # To use, SETIDENT must be in one of your oper class blocks.
1490 #<module name="m_setident.so">
1492 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1493 # SETNAME module: Adds the /SETNAME command
1494 # This module is oper-only.
1495 # To use, SETNAME must be in one of your oper class blocks.
1496 #<module name="m_setname.so">
1498 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1499 # Serverban: Implements extended ban s:, which stops anyone connected
1500 # to a server matching a mask like +b s:server.mask.here from joining.
1501 #<module name="m_serverban.so">
1503 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1504 # Show Whois module: Adds the +W usermode which allows opers
1505 # to see when they are whois'ed (can be annoying).
1506 # This module is oper-only.
1507 #<module name="m_showwhois.so">
1509 # If you wish, you may also let users set this mode. Only opers with the
1510 # users/auspex priv will see real hosts of people, though. This setting
1511 # is not reloadable via /rehash, and will require /reloadmodule, as
1512 # it directly affects the mode object itself.
1513 #<showwhois opersonly="yes"
1515 # You may also set whether or not users should recieve whois notices, should
1516 # they be /whois'd by an oper.
1517 # showfromopers="yes">
1519 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1520 # Shun module: Provides the /shun command, which stops a user executing
1522 # This module is oper-only.
1523 # To use, SHUN must be in one of your oper class blocks.
1524 #<module name="m_shun.so">
1526 # You may also configure which commands you wish a user to be able to
1527 # perform. It should be noted that if a shunned user issues QUIT or PART
1528 # then their message will be removed, as if they did not issue one.
1530 # You can (optionally) let the user know that their command was blocked.
1532 # You may also let SHUN affect opers (defaults to no).
1533 #<shun enabledcommands="PING PONG QUIT PART JOIN" notifyuser="yes" affectopers="no">
1535 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1536 # Spy module: Provides the ability to see the complete names list of
1537 # channels an oper is not a member of
1538 # This module is oper-only.
1539 #<module name="m_spy.so">
1541 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1542 # SSL channel mode module: Adds support for SSL-only channels (+z).
1543 # does not do anything useful without a working SSL module (see below)
1544 #<module name="m_sslmodes.so">
1546 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1547 # GnuTLS ssl module: Adds support for client-server SSL using GnuTLS,
1548 # if enabled. You must copy the source for this module from the directory
1549 # src/modules/extra, or answer 'yes' in ./configure when asked if you
1550 # want to enable this, or it will not load.
1551 #<module name="m_ssl_gnutls.so">
1553 #-#-#-#-#-#-#-#-#-#-#- GNUTLS CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#
1555 # m_ssl_gnutls.so is too complex it describe here, see the wiki: #
1556 # http://wiki.inspircd.org/Modules/ssl_gnutls #
1558 # NOTE: If you want to use this module to encrypt and sign your #
1559 # server to server traffic, you MUST load it before m_spanningtree in #
1560 # your configuration file! #
1562 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1563 # SSL Info module: Allows users to retrieve information about other
1564 # user's peer SSL certificates and keys. This can be used by client
1565 # scripts to validate users. For this to work, one of m_ssl_gnutls.so
1566 # or m_ssl_openssl.so must be loaded. This module also adds the
1567 # "* <user> is using a secure connection" whois line, the ability for
1568 # opers to use SSL fingerprints to verify their identity and the ability
1569 # to force opers to use SSL connections in order to oper up.
1570 # It is highly recommended to load this module especially if
1571 # you use SSL on your network.
1572 # For how to use the oper features, please see the first example <oper> tag
1573 # in opers.conf.example.
1575 #<module name="m_sslinfo.so">
1577 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1578 # OpenSSL ssl module: Adds support for client-server SSL using OpenSSL,
1579 # if enabled. You must copy the source for this module from the directory
1580 # src/modules/extra, or answer 'yes' in ./configure when asked if you
1581 # want to enable this, or it will not load.
1582 #<module name="m_ssl_openssl.so">
1584 #-#-#-#-#-#-#-#-#-#-#- OPENSSL CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#
1586 # m_ssl_openssl.so is too complex it describe here, see the wiki: #
1587 # http://wiki.inspircd.org/Modules/ssl_openssl #
1589 # NOTE: If you want to use this module to encrypt and sign your #
1590 # server to server traffic, you MUST load it before m_spanningtree in #
1591 # your configuration file! #
1593 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1594 # Strip colour module: Adds the channel mode +S
1595 #<module name="m_stripcolor.so">
1597 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1598 # SILENCE module: Adds support for /SILENCE
1599 #<module name="m_silence.so">
1601 # Configuration tags:
1603 #<silence maxentries="32">
1605 # Sets the maximum number of entries on a users silence list.
1607 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1608 # SQLite3 module: Allows other SQL modules to access SQLite3 #
1609 # databases through a unified API. You must link the source for this #
1610 # module from the directory src/modules/extra to src/modules, plus #
1611 # the file m_sqlv2.h #
1612 # This modules is in extras. Re-run configure with: ./configure --enable-extras=m_aqlite.cpp
1613 # and run make install, then uncomment this module to enable it. #
1615 #<module name="m_sqlite3.so">
1617 #-#-#-#-#-#-#-#-#-#-#-#- SQL CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#-#
1619 # m_sqlite.so is more complex than described here, see the wiki for #
1620 # more: http://wiki.inspircd.org/Modules/sqlite3 #
1622 #<database hostname="/full/path/to/database.db" id="anytext">
1624 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1625 # SQLutils module: Provides some utilities to SQL client modules, such
1626 # as mapping queries to users and channels. You must copy the source
1627 # for this module from the directory src/modules/extra/m_sqlutils.cpp
1628 # and src/modules/extra/m_sqlutils.h into /src/modules
1629 # Needed for, and loaded before: SQLauth and SQLoper
1630 # This modules is in extras. Re-run configure with: ./configure --enable-extras=m_sqlutils.cpp
1631 # and run make install, then uncomment this module to enable it.
1633 #<module name="m_sqlutils.so">
1635 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1636 # SQL authentication module: Allows IRCd connections to be tied into
1637 # a database table (for example a forum). You must copy the source for
1638 # this module from the directory src/modules/extra
1639 # Depends on the SQLutils module being loaded first.
1640 # This modules is in extras. Re-run configure with: ./configure --enable-extras=m_sqlauth.cpp
1641 # and run make install, then uncomment this module to enable it.
1643 #<module name="m_sqlauth.so">
1645 #-#-#-#-#-#-#-#-#-#-#- SQLAUTH CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#
1647 # m_sqlauth.so is too complex it describe here, see the wiki: #
1648 # http://wiki.inspircd.org/Modules/sqlauth #
1650 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1651 # SQL logging module: Allows you to log network-wide data for your
1652 # network in a fully normalised set of SQL tables. You must copy the
1653 # source for this module from the directory src/modules/extra
1654 # This modules is in extras. Re-run configure with: ./configure --enable-extras=m_sqllog.cpp
1655 # and run make install, then uncomment this module to enable it.
1657 #<module name="m_sqllog.so">
1659 #-#-#-#-#-#-#-#-#-#-#- SQLLOG CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#
1661 # dbid - Database ID to use (see m_sql) #
1663 # See also: http://wiki.inspircd.org/Modules/sqllog #
1667 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1668 # SQL oper module: Allows you to store oper credentials in an SQL table
1669 # You must copy the source for this module from the directory src/modules/extra
1670 # Depends on the SQLutils module being loaded first.
1671 # This modules is in extras. Re-run configure with: ./configure --enable-extras=m_sqloper.cpp
1672 # and run make install, then uncomment this module to enable it.
1674 #<module name="m_sqloper.so">
1676 #-#-#-#-#-#-#-#-#-#-#- SQLOPER CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#
1678 # dbid - Database ID to use (see m_sql) #
1679 # hash - Hashing provider to use for password hashing #
1681 # See also: http://wiki.inspircd.org/Modules/sqloper #
1683 #<sqloper dbid="1" hash="md5">
1685 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1686 # SVSHold module: Implements SVSHOLD. Like Q:Lines, but can only be #
1687 # added/removed by Services. #
1688 #<module name="m_svshold.so">
1690 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1691 # SWHOIS module: Allows you to add arbitary lines to user WHOIS.
1692 # This module is oper-only.
1693 # To use, SWHOIS must be in one of your oper class blocks.
1694 #<module name="m_swhois.so">
1696 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1697 # Test module: enable this to create a command useful in testing
1698 # flood control. To avoid accidental use on live networks, the server
1699 # name must contain ".test" to load the module
1700 #<module name="m_testnet.so">
1702 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1703 # Timed bans module: Adds timed channel bans and the /TBAN command
1704 #<module name="m_timedbans.so">
1706 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1707 # Test line module: Adds the /TLINE command, used to test how many
1708 # users a /GLINE or /ZLINE etc would match.
1709 # This module is oper-only.
1710 # To use, TLINE must be in one of your oper class blocks.
1711 #<module name="m_tline.so">
1713 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1714 # UHNAMES support module: Adds support for the IRCX style UHNAMES
1715 # extension, which displays ident and hostname in the names list for
1716 # each user, saving clients from doing a WHO on the channel. Note that
1717 # this module is not widely supported yet. If a client does not support
1718 # UHNAMES it will not enable it, this will not break incompatible
1720 #<module name="m_uhnames.so">
1722 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1723 # Uninvite module: Adds the /UNINVITE command which lets users remove
1724 # pending invites from channels without waiting for the user to join.
1725 #<module name="m_uninvite.so">
1727 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1728 # Userip module: Adds the /USERIP command
1729 # This module is oper-only.
1730 # To use, USERIP must be in one of your oper class blocks.
1731 #<module name="m_userip.so">
1733 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1734 # Vhost module: Adds the VHOST command which allows for adding virtual
1735 # hosts which are accessible using a username and password in the config.
1736 #<module name="m_vhost.so">
1738 #-#-#-#-#-#-#-#-#-#-#- VHOST CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#-#
1740 # user - Username for the vhost. #
1742 # pass - Password for the vhost. #
1744 # hash - The hash for the specific user (optional)
1745 # m_password_hash.so and a hashing module must be loaded for this to work
1747 # host - Vhost to set. #
1749 #<vhost user="some_username" pass="some_password" host="some.host">
1750 #<vhost user="foo" password="fcde2b2edba56bf408601fb721fe9b5c338d10ee429ea04fae5511b68fbf8fb9" hash="sha256" host="some.other.host">
1752 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1753 # Watch module: Adds the WATCH command, which is used by clients to
1754 # maintain notify lists.
1755 #<module name="m_watch.so">
1757 # Configuration tags:
1759 #<watch maxentries="32">
1761 # Sets the maximum number of entries on a user's watch list.
1763 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1764 # XLine database: Stores all *Lines (G/Z/K/R/any added by other modules)
1765 # in a file "xline.db" which can be re-loaded on restart. This is useful
1766 # for two reasons: it keeps bans so users may not evade them, and on
1767 # bigger networks, server connections will take less time as there will
1768 # be a lot less bans to apply - as most of them will already be there.
1769 #<module name="m_xline_db.so">
1771 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1772 # ZipLinks module: Adds support for zlib deflate on server to server
1773 # connections. Both ends of the connection must load this module.
1774 # This modules is in extras. Re-run configure with: ./configure --enable-extras=m_ziplink.cpp
1775 # and run make install, then uncomment this module to enable it.
1777 #<module name="m_ziplink.so">
1779 # To use this module, you must enable it as a ssl type in your
1780 # <link> tags or <bind> tags using the ssl name 'ziplinks'.
1781 # See the documentation of <link> and <bind>, respectively.
1785 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1786 # ____ _ _____ _ _ ____ _ _ _ #
1787 # | _ \ ___ __ _ __| | |_ _| |__ (_)___ | __ )(_) |_| | #
1788 # | |_) / _ \/ _` |/ _` | | | | '_ \| / __| | _ \| | __| | #
1789 # | _ < __/ (_| | (_| | | | | | | | \__ \ | |_) | | |_|_| #
1790 # |_| \_\___|\__,_|\__,_| |_| |_| |_|_|___/ |____/|_|\__(_) #
1792 # To link servers to InspIRCd, you MUST load the m_spanningtree #
1793 # module. Since several features (like SSL server links) rely on #
1794 # other modules being loaded before m_spanningtree, the module itself #
1795 # is at the bottom of this file. DO NOT forget to load it. If you DO #
1796 # NOT do this, server links will NOT work at all. ie. The ports will #
1797 # NOT bind, and /connect will not work properly. This is by design, #
1798 # to allow for the implementation of other linking protocols in #
1799 # 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