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 a newline (which can be written in #
130 # the file literally, or encoded as &nl; or \n #
131 # depending on the config format setting). #
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 # If you specify the m_cloaking.so module as above, you must define #
478 # cloak keys, and optionally a cloak prefix as shown below. The cloak #
479 # keys must be shared across the network for correct cloaking. #
481 # There are four methods of cloaking: #
483 # half Cloak only the "unique" portion of a host; show #
484 # the last 2 parts of the domain, /16 subnet of IPv4 #
485 # or /48 subnet of the IPv6 address. #
487 # full Cloak the users completely, using three slices for #
488 # common CIDR bans (IPv4: /16, /24; IPv6: /48, /64) #
490 # These methods use a single key that can be any length of text. #
491 # An optional prefix may be specified to mark cloaked hosts. #
493 # The following methods are maintained for backwards compatibility; #
494 # they are slightly less secure, and always hide unresolved IPs #
496 # compat-host InspIRCd 1.2-compatible host-based cloaking #
497 # compat-ip InspIRCd 1.2-compatible ip-always cloaking #
499 # You must specify key1, key2, key3, key4 for the compat cloaking #
500 # modes; the values must be less than 0x80000000 and should be picked #
501 # at random. Prefix is mandatory, will default to network name if not #
502 # specified, and will always have a "-" appended. #
503 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
509 #-#-#-#-#-#-#-#-#-#-#-#- CLOSE MODULE #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
510 # Close module: Allows an oper to close all unregistered connections.
511 # This module is oper-only and provides /close.
512 # To use, CLOSE must be in one of your oper class blocks.
513 #<module name="m_close.so">
515 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
516 # Clones module: Adds an oper command /CLONES for detecting cloned
517 # users. Warning: This module may be resource intensive when its
518 # command is issued, use with care.
519 # This module is oper-only.
520 # To use, CLONES must be in one of your oper class blocks.
521 #<module name="m_clones.so">
523 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
524 # Common channels module: Adds user mode +c, which, when set, requires
525 # that users must share a common channel with you to PRIVMSG or NOTICE
527 #<module name="m_commonchans.so">
529 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
530 # Conn-Join: Allows you to force users to join one or more channels
531 # automatically upon connecting to the server.
532 #<module name="m_conn_join.so">
534 #-#-#-#-#-#-#-#-#-#-#-#- CONNJOIN CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
536 # If you have m_conn_join.so loaded, you can configure it using the
539 #<autojoin channel="#one,#two,#three">
541 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
542 # Conn-Usermodes: Set modes on users when they connect
543 # When this module is loaded <connect:allow> tags may have an optional
544 # modes="" value, which contains modes to add or remove from users
545 # when they connect to the server.
546 #<module name="m_conn_umodes.so">
548 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
549 # Conn-Wait-for-Pong: Don't let a user connect until they PONG
550 #<module name="m_conn_waitpong.so">
552 #-#-#-#-#-#-#-#-#-#-#- WAITPONG CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
554 # If you have the m_conn_waitpong.so module loaded, configure it with #
555 # the <waitpong> tag: #
557 # sendsnotice - Whether to send a snotice on connect, like other #
560 # killonbadreply - Whether to kill the user if they send the wrong #
563 #<waitpong sendsnotice="yes" killonbadreply="yes">
566 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
567 # Channel cycle module. Server side /hop, with +ilk etc bypass.
568 #<module name="m_cycle.so">
570 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
571 # Connectban: Provides IP connection throttling. Any IP range that connects
572 # too many times (configurable) in an hour is zlined for a (configurable)
573 # duration, and their count resets to 0.
575 # ipv4cidr and ipv6cidr allow you to turn the comparison from individual
576 # IP addresses (32 and 128 bits) into CIDR masks, to allow for throttling
577 # over whole ISPs/blocks of IPs, which may be needed to prevent attacks.
579 #<connectban threshold="10" duration="10m" ipv4cidr="32" ipv6cidr="128">
580 # This allows for 10 connections in an hour with a 10 minute ban if that is exceeded.
582 #<module name="m_connectban.so">
584 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
585 # Connection throttle module. Configuration:
586 #<module name="m_connflood.so">
588 #-#-#-#-#-#-#-#-#-#-#- CONTHROTTLE CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
589 # seconds, maxconns - Amount of connections per <seconds>.
591 # timeout - Time to wait after the throttle was activated
592 # before deactivating it. Be aware that the time
593 # is seconds + timeout.
595 # quitmsg - The message that users get if they attempt to
596 # connect while the throttle is active.
598 # bootwait - Amount of time to wait before enforcing the
599 # throttling when the server just booted.
601 #<connflood seconds="30" maxconns="3" timeout="30"
602 # quitmsg="Throttled" bootwait="10">
604 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
605 # Custom title module: Adds the /TITLE command which allows for trusted
606 # users to gain a custom whois line and a optional
607 # vhost can be specified.
608 #<module name="m_customtitle.so">
610 #-#-#-#-#-#-#-#-#-#- CUSTOM TITLE CONFIGURATION -#-#-#-#-#-#-#-#-#-#
611 # name - The username used to identify
612 # password - The password used to identify
613 # hash - The hash for the specific user's password (optional)
614 # m_password_hash.so and a hashing module must be loaded for this to work
615 # host - Allowed hostmask [optional]
616 # title - Title shown in whois
617 # vhost - Displayed host [optional]
619 #<title name="foo" password="bar" title="Official Chat Helper">
620 #<title name="bar" password="foo" host="ident@host.name" title="Official Chat Helper" vhost="helper.network.chat">
621 #<title name="foo" password="fcde2b2edba56bf408601fb721fe9b5c338d10ee429ea04fae5511b68fbf8fb9" hash="sha256" title="Official Chat Helper">
623 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
624 # DCCALLOW module: Adds the /DCCALLOW command
625 #<module name="m_dccallow.so">
627 #-#-#-#-#-#-#-#-#-#-#- DCCALLOW CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
628 # blockchat - Whether to block DCC CHAT as well as DCC SEND
629 # length - Default duration of entries in DCCALLOW list
630 # action - Default action to take if no action is specified
631 # can be 'block' or 'allow'
633 # File configuration:
634 # pattern - The glob pattern to match against
635 # action - Action to take if a user attempts to send a file
636 # that matches this pattern, can be 'block' or 'allow'
638 #<dccallow blockchat="yes" length="5m" action="block">
639 #<banfile pattern="*.exe" action="block">
640 #<banfile pattern="*.txt" action="allow">
642 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
644 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
645 # Deaf module: adds support for ircu style usermode +d - deaf to
646 # channel messages and channel notices.
647 #<module name="m_deaf.so">
649 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
650 # Delay join module: Adds the channel mode +D which delays all JOIN
651 # messages from users until they speak. If they quit or part before
652 # speaking, their quit or part message will not be shown to the channel
653 # which helps cut down noise on large channels in a more friendly way
654 # than the auditorium mode. Only channel ops may set the +D mode.
655 #<module name="m_delayjoin.so">
657 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
658 # Delay message module: Adds the channel mode +d which disallows a user
659 # from talking in the channel unless they've been joined for X seconds.
660 # Settable a la: /mode +d 30
661 #<module name="m_delaymsg.so>
663 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
664 # Deny Channels: Deny Channels from being used by users
665 #<module name="m_denychans.so">
667 #-#-#-#-#-#-#-#-#-#-#- DENYCHAN DEFINITIONS -#-#-#-#-#-#-#-#-#-#-#-#
669 # If you have the m_denychans.so module loaded, you need to specify #
670 # the channels to deny: #
672 # name - The channel name to deny. (glob masks are ok) #
674 # allowopers - If operators are allowed to override the deny. #
676 # reason - Reason given for the deny. #
678 # redirect - Redirect the user to a different channel #
680 #<badchan name="#gods*" allowopers="yes" reason="Tortoises!"> #
681 #<badchan name="#heaven" redirect="#hell" reason="Nice try!"> #
683 # Redirects will not work if the target channel is set +L. #
685 # Additionally, you may specify channels which are allowed, even if #
686 # a badchan tag specifies it would be denied: #
687 #<goodchan name="#godsleeps"> #
688 # Glob masks are accepted here also.
690 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
691 # Devoice Module: Let users devoice themselves.
692 #<module name="m_devoice.so">
694 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
695 # DNS Blacklist Module: Provides support for looking up IPs on one or #
697 #<module name="m_dnsbl.so"> #
699 # For configuration options please see the wiki page for m_dnsbl at #
700 # http://wiki.inspircd.org/Modules/dnsbl #
702 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
703 # Exempt Channel Operators Module: Provides support for allowing #
704 # channel operators to be exempt from some channel modes. Supported #
705 # modes are blockcaps, noctcp, blockcolor, nickflood, flood, censor, #
706 # filter, regmoderated, nonick, nonotice, and stripcolor. #
707 #<module name="m_exemptchanops.so"> #
709 #-#-#-#-#-#-#-#-#-#- EXEMPTCHANOPS CONFIGURATION -#-#-#-#-#-#-#-#-#-#
710 # alwaysexempt - Modes channel operators are always exempt from,
711 # regardless of channel setting.
712 # neverexempt - Modes channel operators are never exempt from,
713 # regardless of channel setting.
714 #<exemptchanops alwaysexempt="nickflood censor flood filter" neverexempt="regmoderated">
717 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
718 # Filter module: Provides message filtering, similar to SPAMFILTER.
719 #<module name="m_filter.so">
721 # This module depends upon a regex provider such as m_regex_pcre or #
722 # m_regex_glob to function. You must specify which of these you want #
723 # m_filter to use via the tag below. #
725 # Valid engines are: #
727 # glob - Glob patterns, provided via m_regex_glob.so #
728 # pcre - PCRE regexps, provided via m_regex_pcre.so, needs libpcre #
729 # tre - TRE regexps, provided via m_regex_tre.so, requires libtre #
730 # posix - POSIX regexps, provided via m_regex_posix.so, not availale #
731 # on windows, no dependencies on other operating systems. #
733 #<filteropts engine="glob"> #
735 # Your choice of regex engine must match on all servers network-wide.
737 # You may specify specific channels that are exempt from being filtered:
738 #<exemptfromfilter channel="#blah">
740 #-#-#-#-#-#-#-#-#-#-#- FILTER CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#
742 # Optional - If you specify to use the m_filter module, then #
743 # specfiy below the path to the filter.conf file, or define some #
746 #<include file="filter.conf">
748 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
749 # Gecosban: Implements extended ban r:, which stops anyone matching
750 # a mask like +b r:*realname?here* from joining a channel.
751 #<module name="m_gecosban.so">
753 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
754 # GeoIP module: Allows the server admin to ban users by country code.
755 # This modules is in extras. Re-run configure with: ./configure --enable-extras=m_geoip.cpp
756 # and run make install, then uncomment this module to enable it.
757 # This module requires GeoIP to be installed on your system,
758 # use your package manager to find the appropriate packages
759 # or check the InspIRCd wiki page for this module.
760 #<module name="m_geoip.so">
762 #-#-#-#-#-#-#-#-#-#-#-# GEOIP CONFIGURATION #-#-#-#-#-#-#-#-#-#-#-#-#
764 # <geoip banunknown="false"> #
766 # Set this value to true or yes to block unknown IP ranges which are #
767 # not in the database (usually LAN addresses, localhost, etc) #
769 # <geoban country="TR" reason="This country not permitted"> #
771 # Use one or more of these tags to ban countries by country code. #
772 # The country code must be in capitals and should be an ISO country #
773 # code such as TR, GB, or US. #
775 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
776 # Globops module: gives /GLOBOPS and SNOMASK +g
777 # This module is oper-only.
778 # To use, GLOBOPS must be in one of your oper class blocks.
779 #<module name="m_globops.so">
781 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
782 # Global load module: Allows loading and unloading of modules network-
783 # wide (USE WITH EXTREME CAUTION!)
784 # This module is oper-only and provides /gloadmodule, /gunloadmodule
785 # and /greloadmodule.
786 # To use, GLOADMODULE, GUNLOADMODULE and GRELOADMODULE
787 # must be in one of your oper class blocks.
788 #<module name="m_globalload.so">
790 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
791 # HELPOP module: Provides the /HELPOP command
792 #<module name="m_helpop.so">
794 #-#-#-#-#-#-#-#-#-#-#-#- HELPOP CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
796 # Optional - If you specify to use the m_helpop.so module, then #
797 # specify below the path to the helpop.conf file, or if you like to #
798 # make a mess, define your helpop tags in this conf. #
800 #<include file="helpop.conf">
802 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
803 # HIDECHANS module: Allows opers to hide their channels list from non-
804 # opers by setting user mode +I on themselves.
805 # <module name="m_hidechans.so">
807 # HIDECHANS can optionally prevent opers from seeing channels on a +I
808 # user, for more privacy if set to true.
809 # This setting is not recommended for most mainstream networks.
810 #<hidechans affectsopers="false">
812 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
813 # HIDEOPER module: Allows opers to hide their oper status from non-
814 # opers by setting user mode +H on themselves.
815 # This module is oper-only.
816 # <module name="m_hideoper.so">
818 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
819 # Hostchange module: Allows a different style of cloaking
820 #<module name="m_hostchange.so">
822 #-#-#-#-#-#-#-#-#-#-#- HOSTCHANGE CONFIGURATION -#-#-#-#-#-#-#-#-#-#
824 # Optional - If you choose to use the m_hostchange.so module. #
825 # Config Help - See http://wiki.inspircd.org/Modules/hostchange #
827 #<host suffix="polarbears.org" separator="." prefix="">
828 #<hostchange mask="*@fbi.gov" action="addnick">
829 #<hostchange mask="*r00t@*" action="suffix">
830 #<hostchange mask="a@b.com" action="set" value="blah.blah.blah">
831 #<hostchange mask="localhost" ports="7000,7001,7005-7007" action="set" value="blahblah.foo">
833 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
834 # httpd module: Provides http server support for InspIRCd
835 #<module name="m_httpd.so">
837 #-#-#-#-#-#-#-#-#-#-#-#- HTTPD CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
839 # If you choose to use the m_httpd.so module, then you will need to add
840 # a <bind> tag with type "httpd", and load at least one of the other
841 # m_httpd_* modules to provide pages to display.
844 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
845 # http ACL module: Provides access control lists for m_httpd dependent
846 # modules. Use this module to restrict pages by IP address and by
849 #<module name="m_httpd_acl.so">
851 #-#-#-#-#-#-#-#-#-#-#-#- HTTPD ACL CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
853 # Restrict access to the m_httpd_stats module to all but the local
854 # network and when the correct password is specified:
856 # <httpdacl path="/stats*" types="password,whitelist"
857 # username="secretstuff" password="mypasshere" whitelist="127.0.0.*,10.*">
859 # Deny all connections to all but the main index page:
861 # <httpdacl path="/*" types="blacklist" blacklist="*">
864 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
865 # http config module: Allows the server's configuration to be viewed
866 # over HTTP. Requires m_httpd.so to be loaded for it to function.
867 #<module name="m_httpd_config.so">
869 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
870 # http stats module: Provides basic stats pages over HTTP
871 # Requires m_httpd.so to be loaded for it to function.
872 #<module name="m_httpd_stats.so">
874 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
875 # Ident: Provides RFC 1413 ident lookup support
876 # When this module is loaded <connect:allow> tags may have an optional
877 # useident="yes|no" boolean value, determining whether or not to lookup
878 # ident on users matching that connect tag.
879 #<module name="m_ident.so">
881 #-#-#-#-#-#-#-#-#-#-#-#- IDENT CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
883 # Optional - If you are using the m_ident.so module, then you can #
884 # specify the timeout for ident lookups here. If not defined, it will #
885 # default to one second. This is a non-blocking timeout which holds #
886 # the user in a 'connecting' state until the lookup is complete. #
887 # The bind value indicates which IP to bind outbound requests to. #
891 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
892 # Invite except module: Adds support for channel invite exceptions (+I)
893 #<module name="m_inviteexception.so">
895 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
896 # Invisible module - Adds support for usermode +Q (quiet) which lets an
897 # oper go 'invisible' similar to unrealircd 3.1's +I mode. Note that
898 # opers are still able to see invisible users, and if an oper with +Q
899 # deopers, they will become visible.
901 # This module is oper-only and seen by many to be quite abusive.
903 #<module name="m_invisible.so">
905 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
906 # Join flood module: Adds support for join flood protection (+j)
907 #<module name="m_joinflood.so">
909 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
910 # Jump Server module: Adds support for the RPL_REDIR numeric
911 # This module is oper-only.
912 # To use, JUMPSERVER must be in one of your oper class blocks.
913 #<module name="m_jumpserver.so">
915 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
916 # Anti-Auto-Rejoin: Adds support for prevention of auto-rejoin (+J)
917 #<module name="m_kicknorejoin.so">
919 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
920 # Knock module: adds the /KNOCK command and +K channel mode
921 #<module name="m_knock.so">
923 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
924 # LDAP authentication module: Adds the ability to authenticate users #
925 # via LDAP. This is an extra module which must be enabled explicitly #
926 # by symlinking it from modules/extra, and requires the OpenLDAP libs #
927 # This modules is in extras. Re-run configure with: ./configure --enable-extras=m_ldapauth.cpp
928 # and run make install, then uncomment this module to enable it. #
930 #<module name="m_ldapauth.so"> #
934 # <ldapauth baserdn="ou=People,dc=brainbox,dc=cc" #
936 # server="ldap://brainwave.brainbox.cc" #
937 # allowpattern="Guest*" #
938 # killreason="Access denied" #
939 # searchscope="subtree" #
940 # binddn="cn=Manager,dc=brainbox,dc=cc" #
941 # bindauth="mysecretpass" #
944 # The baserdn indicates the base DN to search in for users. Usually #
945 # this is 'ou=People,dc=yourdomain,dc=yourtld'. #
947 # The attribute value indicates the attribute which is used to locate #
948 # a user account by name. On POSIX systems this is usually 'uid'. #
950 # The server parameter indicates the LDAP server to connect to. The #
951 # ldap:// style scheme before the hostname proper is MANDITORY. #
953 # The allowpattern value allows you to specify a wildcard mask which #
954 # will always be allowed to connect regardless of if they have an #
955 # account, for example guest users. #
957 # Killreason indicates the QUIT reason to give to users if they fail #
960 # The searchscope value indicates the subtree to search under. On our #
961 # test system this is 'subtree'. Your mileage may vary. #
963 # Setting the verbose value causes an oper notice to be sent out for #
964 # every failed authentication to the server, with an error string. #
966 # The binddn and bindauth indicate the DN to bind to for searching, #
967 # and the password for the distinguished name. Some LDAP servers will #
968 # allow anonymous searching in which case these two values do not #
969 # need defining, otherwise they should be set similar to the examples #
972 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
973 # LDAP oper configuration module: Adds the ability to authenticate #
974 # opers via LDAP. This is an extra module which must be enabled #
975 # explicitly by symlinking it from modules/extra, and requires the #
976 # OpenLDAP libs. Re-run configure with: ./configure --enable-extras=m_ldapoper.cpp
977 # and run make install, then uncomment this module to enable it. #
979 #<module name="m_ldapoper.so">
983 # <ldapoper baserdn="ou=People,dc=brainbox,dc=cc"
984 # server="ldap://brainwave.brainbox.cc"
985 # searchscope="subtree"
986 # binddn="cn=Manager,dc=brainbox,dc=cc"
987 # bindauth="mysecretpass">
989 # Available configuration items are identical to the same items in #
990 # m_ldapauth above. #
992 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
993 # Lock server module: Adds /LOCKSERV and /UNLOCKSERV commands that is #
994 # used to temporarily close/open for new connections to the server. #
995 # These commands require OPER status and that the LOCKSERV UNLOCKSERV #
996 # are specified in a <class> tag that the oper is part of. This is so #
997 # you can control who has access to this possible dangerous command. #
998 # If your server is locked and you got disconnected, do a REHASH from #
999 # shell to open up again.
1001 # This module is oper-only.
1003 #<module name="m_lockserv.so">
1005 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1006 # Map hiding module: replaces /MAP and /LINKS output to users with a #
1007 # message to see a website, set by maphide="http://link.to/site" in #
1008 # the security tag, instead. #
1009 #<module name="m_maphide.so">
1011 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1012 # Msg flood module: Adds message/notice flood protection (+f)
1013 #<module name="m_messageflood.so">
1015 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1016 # MsSQL module: Allows other SQL modules to access MS SQL Server
1017 # through a unified API. You must copy the source for this module
1018 # from the directory src/modules/extra, plus the file m_sqlv2.h
1019 # This modules is in extras. Re-run configure with: ./configure --enable-extras=m_mssql.cpp
1020 # and run make install, then uncomment this module to enable it.
1022 #<module name="m_mssql.so">
1024 #-#-#-#-#-#-#-#-#-#-#-#- SQL CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#-#
1026 # m_mssql.so is more complex than described here, see wiki for more #
1027 # info http://wiki.inspircd.org/Modules/mssql #
1029 #<database name="db" username="user" password="pass" hostname="localhost" id="db1">
1031 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1032 # MySQL module: Allows other SQL modules to access MySQL databases
1033 # through a unified API. You must copy the source for this module
1034 # from the directory src/modules/extra, plus the file m_sqlv2.h
1035 # This modules is in extras. Re-run configure with: ./configure --enable-extras=m_mysql.cpp
1036 # and run make install, then uncomment this module to enable it.
1038 #<module name="m_mysql.so">
1040 #-#-#-#-#-#-#-#-#-#-#-#- SQL CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#-#
1042 # m_mysql.so is more complex than described here, see the wiki for #
1043 # more: http://wiki.inspircd.org/Modules/mysql #
1045 #<database name="mydb" username="myuser" password="mypass" hostname="localhost" id="my_database2">
1047 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1048 # NAMESX module: Provides support for the NAMESX extension which allows
1049 # clients to see all the prefixes set on a user without getting confused.
1050 # This is supported by mIRC, x-chat, klient, and maybe more.
1051 #<module name="m_namesx.so">
1053 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1054 # National characters module:
1055 # 1) Allows using national characters in nicknames.
1056 # 2) Allows using custom (national) casemapping over the network.
1057 # file -- filename of existing file in "locales" directory
1058 # casemapping -- custom value for 005 numeric (if you want it to be
1059 # different from the filename.
1061 #<nationalchars file="bynets/russian-w1251-charlink" casemapping="ru_RU.cp1251-charlink">
1062 #<module name="m_nationalchars.so">
1064 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1065 # Nickchange flood protection module: Allows up to X nick changes in Y seconds.
1066 # Provides channel mode +F.
1067 #<module name="m_nickflood.so">
1069 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1070 # Nicklock module: Let opers change a user's nick and then stop that
1071 # user from changing their nick again.
1072 # This module is oper-only.
1073 # To use, NICKLOCK and NICKUNLOCK must be in one of your oper class blocks.
1074 #<module name="m_nicklock.so">
1076 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1077 # No ctcp module: Adds the channel mode +C to block CTCPs and extban C
1078 # to block CTCPs sent by specific users.
1079 #<module name="m_noctcp.so">
1081 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1082 # No kicks module: Adds the +Q channel mode and the Q: extban to deny
1083 # certain users from kicking.
1084 #<module name="m_nokicks.so">
1086 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1087 # No nicks module: Adds the +N channel mode, as well as the +b N:
1088 # extended bantype. +N stops all users from changing their nick,
1089 # the +b N: extban stops anyone from matching a +b N:nick!user@host
1090 # mask from changing their nick.
1091 #<module name="m_nonicks.so">
1093 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1094 # No part message module: adds extban 'p' to block part messages from #
1096 #<module name="m_nopartmsg.so">
1098 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1099 # No Notice module: adds the channel mode +T and the extban T to block
1100 # specific users from noticing the channel.
1101 #<module name="m_nonotice.so">
1103 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1104 # Network buisness join module
1105 # Allows an oper to join a channel using /OJOIN, giving them +Y on the
1106 # channel which makes them immune to kick/deop/etc.
1107 #<module name="m_ojoin.so">
1109 #<ojoin prefix="!" notice="yes" op="yes">
1110 # Specify the prefix that +Y will grant here
1111 # Leave prefix empty if you do not wish +Y to grant a prefix
1112 # If notice is set to on, upon ojoin, the server will notice
1113 # the channel saying that the oper is joining on network business
1114 # If op is set to on, it will give them +o along with +Y
1117 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1118 # Oper channels mode: Adds the +O channel mode and +beI type O:<mask>
1119 # to ban, exempt, and invex given oper type masks.
1120 # e.g, /mode #channel +iI O:* is equivilant to chmode +O, but you
1121 # may also, e.g. /mode #channel +iI O:AdminTypeOnly to only allow admins.
1122 # +be work in a similar fashion.
1124 #<module name="m_operchans.so">
1126 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1127 # Oper Join module: Auto-joins opers to a channel upon oper-up
1128 # This module is oper-only. For the user equivalent, see m_conn_join.
1129 #<module name="m_operjoin.so">
1131 #-#-#-#-#-#-#-#-#-#-# OPERJOIN CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
1133 # If you are using the m_operjoin.so module, specify options here: #
1135 # channel - The channel name to join, can also be a comma #
1136 # seperated list eg. "#channel1,#channel2". #
1138 # override - Lets the oper join walking thru any modes that #
1139 # might be set, even bans. Use "yes" or "no". #
1141 #<operjoin channel="#channel" override="no">
1143 # Alternatively you can use the autojoin="channellist" in a <type> #
1144 # tag to set specific autojoins for a type of oper, for example: #
1146 #<type name="Helper" autojoin="#help" classes="...">
1148 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1149 # Oper log module: Logs all oper commands to the ircd log at default
1151 # This module is oper-only.
1152 #<module name="m_operlog.so">
1154 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1155 # Oper prefixing module: Gives IRC operators a prefix status character
1156 # on all channels they are in.
1158 #<module name="m_operprefix.so">
1160 # You may additionally customise the prefix character.
1161 #<operprefix prefix="!">
1163 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1164 # Oper MOTD module: Provides support for seperate message of the day
1166 # This module is oper-only.
1167 #<module name="m_opermotd.so">
1169 #-#-#-#-#-#-#-#-#-#-# OPERMOTD CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
1171 # If you are using the m_opermotd.so module, specify the motd here #
1173 # onoper - Should the message be sent on /OPER or only when #
1174 # /OPERMOTD is used. Use "yes" or "no". #
1176 #<opermotd file="oper.motd" onoper="yes">
1178 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1179 # Override module: Adds support for oper override
1180 # This module is oper-only.
1181 #<module name="m_override.so">
1183 #-#-#-#-#-#-#-#-#-#-# OVERRIDE CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
1185 # m_override.so is too complex it describe here, see the wiki: #
1186 # http://wiki.inspircd.org/Modules/override #
1188 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1189 # Oper levels module: Gives each oper a level and prevents
1190 # actions being taken against higher level opers
1191 # Specify the level as the 'level' parameter of the <type> tag
1192 # # This module is oper-only.
1193 #<module name="m_operlevels.so">
1195 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1196 # Oper modes module: Allows you to specify modes to add/remove on oper
1197 # Specify the modes as the 'modes' parameter of the <type> tag
1198 # and/or as the 'modes' parameter of the <oper> tag.
1199 # This module is oper-only. For the user equivalent, see m_conn_umodes
1200 #<module name="m_opermodes.so">
1202 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1203 # Oper password hash module: Allows hashed oper passwords
1204 # Relies on the module m_md5.so and/or m_sha256.so being loaded before
1205 # m_password_hash.so in the configuration file.
1206 # This module is oper-only.
1207 #<module name="m_password_hash.so">
1209 #-#-#-#-#-#-#-#-#-#-# OPER HASH CONFIGURATION #-#-#-#-#-#-#-#-#-#-#-#-#
1211 # To use this module, you must define a hash type for each oper's
1212 # password you want to hash. For example:
1214 # <oper name="Brain"
1215 # host="ident@dialup15.isp.com"
1217 # password="a41d730937a53b79f788c0ab13e9e1d5"
1220 # The types of hashing available vary depending on which hashing modules
1221 # you load, but usually if you load m_sha256.so and m_md5.so, both md5
1222 # and sha256 type hashing will be available (the most secure of which
1225 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1226 # Permanent Channels module: Channels with the permanent channels mode
1227 # will remain open even after everyone else has left the channel, and
1228 # therefore keep things like modes, ban lists and topic. Permanent
1229 # channels -may- need support from your Services package to function
1230 # properly with them. This adds channel mode +P.
1231 # This module is oper-only.
1232 #<module name="m_permchannels.so">
1234 # If you like, m_permchannels can write a config file of permanent channels
1235 # whenever +P is set, unset, or the topic/modes on a +P channel is changed.
1236 # If you want to do this, set the filename below, and uncomment the include.
1238 #<permchanneldb filename="conf/permchannels.conf">
1239 #<include file="permchannels.conf">
1241 # You may also create channels on startup by using the <permchannels> block.
1242 #<permchannels channel="#opers" modes="is" topic="Opers only.">
1244 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1245 # PostgreSQL module: Allows other SQL modules to access PgSQL databases
1246 # through a unified API. You must copy the source for this module
1247 # from the directory src/modules/extra, plus the file m_sqlv2.h
1248 # This modules is in extras. Re-run configure with: ./configure --enable-extras=m_pgsql.cpp
1249 # and run make install, then uncomment this module to enable it.
1251 #<module name="m_pgsql.so">
1253 #-#-#-#-#-#-#-#-#-#-#-#- SQL CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#-#
1255 # m_pgsql.so is more complex than described here, see the wiki for #
1256 # more: http://wiki.inspircd.org/Modules/pgsql #
1258 #<database name="mydb" username="myuser" password="mypass" hostname="localhost" id="my_database" ssl="no">
1260 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1261 # Muteban: Implements extended ban m:, which stops anyone matching
1262 # a mask like +b m:nick!user@host from speaking on channel.
1263 #<module name="m_muteban.so">
1266 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1267 # Random Quote module: provides a random quote on connect.
1268 # NOTE: Some of these may mimic fatal errors and confuse users and
1269 # opers alike! - BEWARE!
1270 #<module name="m_randquote.so">
1272 #-#-#-#-#-#-#-#-#-#- RANDOMQUOTES CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
1274 # Optional - If you specify to use the m_randquote.so module, then #
1275 # specify below the path to the randquotes.conf file. #
1277 #<randquote file="randquotes.conf">
1279 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1280 # Redirect module: Adds channel redirection (mode +L)
1281 #<module name="m_redirect.so">
1283 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1284 # Regular Expression Provider for Glob or wildcard (?/*) matching.
1285 # You must have at least 1 provider loaded to use m_filter or m_rline
1286 # modules. This module has no additional requirements, as it uses the
1287 # matching already present in InspIRCd core.
1288 #<module name="m_regex_glob.so">
1290 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1291 # Regular Expression Provider for PCRE (Perl-Compatible Regular
1292 # Expressions). You need libpcre installed to compile and load this
1293 # module. You must have at least 1 provider loaded to use m_filter or
1295 #<module name="m_regex_pcre.so">
1297 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1298 # Regular Expression Provider for POSIX Regular Expressions.
1299 # You shouldn't need any additional libraries on a POSIX-compatible
1300 # system (ie: any Linux, BSD, but not Windows). You must have at least
1301 # 1 provider loaded to use m_filter or m_rline.
1302 # On POSIX-compliant systems, regex syntax can be found by using the
1303 # command: 'man 7 regex'.
1304 #<module name="m_regex_posix.so">
1306 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1307 # Regular Expression Provider for TRE Regular Expressions.
1308 # This is the same regular expression engine used by UnrealIRCd, so
1309 # if you are most familiar with the syntax of /spamfilter from there,
1310 # this is the provider you want. You need libtre installed in order
1311 # to compile and load this module.
1312 #<module name="m_regex_tre.so">
1314 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1315 # Registered users only channel creation
1316 # Allows only registered users and opers to create new channels.
1318 # You probably *DO NOT* want to load this module on a public network.
1320 #<module name="m_regonlycreate.so">
1322 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1323 # Remove module: Adds the /REMOVE command which is a peaceful
1324 # alternative to /KICK
1325 #<module name="m_remove.so">
1327 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1328 # Restricted channels module: Allows only opers to create channels.
1330 # You probably *DO NOT* want to load this module on a public network.
1332 #<module name="m_restrictchans.so">
1334 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1335 # Restrict message module: Allows users to only message opers.
1337 # You probably *DO NOT* want to load this module on a public network.
1339 #<module name="m_restrictmsg.so">
1341 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1342 # Ban users through regular expression patterns
1343 #<module name="m_rline.so">
1345 #-#-#-#-#-#-#-#-#-#-#-#- RLINE CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#-#
1347 # If you wish to re-check a user when they change nickname (can be
1348 # useful under some situations, but *can* also use CPU with more users
1349 # on a server) then set the following configuration value:
1350 # Also, this is where you set what Regular Expression engine is to be
1351 # used. If you ever change it while running, all of your R-Lines will be
1352 # wiped. This is the regex engine used by all R-Lines set, and
1353 # m_regex_<engine>.so must be loaded, or rline will be nonfunctional
1354 # until you load it or change the engine to one that is loaded.
1356 #<rline matchonnickchange="yes" engine="pcre">
1358 # Generally, you will NOT want to use 'glob' here, as this turns
1359 # rline into just another gline. The exceptions are that rline will
1360 # always use the full nick!user@host realname string, rather than only
1361 # user@host, but beware that only the ? and * wildcards are available,
1362 # and are the only way to specify where the space can occur if you do
1363 # use glob. For this reason, is recommended to use a real regex engine
1364 # so that at least \s or [[:space:]] is available.
1366 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1367 # JSON-RPC module: Encode and decode JSON-RPC requests for modules
1368 #<module name="m_rpc_json.so">
1370 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1371 # RPC test module: A test of the RPC API
1372 #<module name="m_rpctest.so">
1374 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1375 # SAJOIN module: Adds the /SAJOIN command
1376 # This module is oper-only.
1377 # To use, SAJOIN must be in one of your oper class blocks.
1378 #<module name="m_sajoin.so">
1380 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1381 # SAKICK module: Adds the /SAKICK command
1382 # This module is oper-only.
1383 # To use, SAKICK must be in one of your oper class blocks.
1384 #<module name="m_sakick.so">
1386 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1387 # SAMODE module: Adds the oper /SAMODE command
1388 # This module is oper-only.
1389 # To use, SAMODE must be in one of your oper class blocks.
1390 #<module name="m_samode.so">
1392 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1393 # SANICK module: Allows opers to change user's nicks
1394 # This module is oper-only.
1395 # To use, SANICK must be in one of your oper class blocks.
1396 #<module name="m_sanick.so">
1398 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1399 # SAPART module: Adds the oper /SAPART command
1400 # This module is oper-only.
1401 # To use, SAPART must be in one of your oper class blocks.
1402 #<module name="m_sapart.so">
1404 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1405 # SAQUIT module: Adds the oper /SAQUIT command (abusable!!!)
1406 # This module is oper-only.
1407 # To use, SAQUIT must be in one of your oper class blocks.
1408 #<module name="m_saquit.so">
1410 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1411 # SATOPIC module: Adds the oper /SATOPIC command
1412 # This module is oper-only.
1413 # To use, SATOPIC must be in one of your oper class blocks.
1414 #<module name="m_satopic.so">
1416 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1417 # SASL authentication module: Provides support for IRC Authentication
1418 # Layer (aka: atheme SASL) via AUTHENTICATE.
1419 #<module name="m_sasl.so">
1421 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1422 # Secure list module: Prevent /LIST in the first minute of connection,
1423 # crippling most spambots and trojan spreader bots.
1424 #<module name="m_securelist.so">
1426 #-#-#-#-#-#-#-#-#-# SECURELIST CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#-#
1428 # Securelist can be harmful to some irc search engines such as #
1429 # netsplit.de and searchirc.com. To prevent securelist blocking these #
1430 # sites from listing, define exception tags as shown below: #
1431 <securehost exception="*@*.searchirc.org">
1432 <securehost exception="*@*.netsplit.de">
1433 <securehost exception="*@echo940.server4you.de">
1434 <securehost exception="*@*.ircdriven.com">
1436 # Define the following variable to change how long a user must wait #
1437 # before issuing a LIST. If not defined, defaults to 60 seconds. #
1439 #<securelist waittime="60"> #
1441 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1442 # Servprotect module: Provides support for Austhex style +k /
1443 # UnrealIRCD +S services mode
1444 #<module name="m_servprotect.so">
1446 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1447 # See nicks module: Allow for SNOMASK +N which shows nick changes.
1448 # This module is oper-only.
1449 #<module name="m_seenicks.so">
1451 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1452 # Set Idle module: Adds a command for opers to change their
1453 # idle time (mainly a toy)
1454 # This module is oper-only.
1455 # To use, SETIDLE must be in one of your oper class blocks.
1456 #<module name="m_setidle.so">
1458 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1459 # Services support module: Adds several usermodes such as +R and +M
1460 # this module implements the 'identified' state via account names (AC)
1461 # and is similar in operation to the way asuka and ircu handle services.
1463 # At the same time, this offers +r for users and channels to mark them
1464 # as identified seperately from the idea of a master account, which
1465 # can be useful for services which are heavily nick-as-account centric.
1467 # This replaces m_services from 1.1 and earlier.
1469 # Also of note is that this module implements two extbans:
1470 # +b R: (stop matching account names from joining)
1471 # +b M: (stop matching account names from speaking)
1473 #<module name="m_services_account.so">
1475 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1476 # Sethost module: Adds the /SETHOST command
1477 # This module is oper-only.
1478 # To use, SETHOST must be in one of your oper class blocks.
1479 # See m_chghost for how to customise valid chars for hostnames
1480 #<module name="m_sethost.so">
1482 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1483 # Setident module: Adds the /SETIDENT command
1484 # This module is oper-only.
1485 # To use, SETIDENT must be in one of your oper class blocks.
1486 #<module name="m_setident.so">
1488 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1489 # SETNAME module: Adds the /SETNAME command
1490 # This module is oper-only.
1491 # To use, SETNAME must be in one of your oper class blocks.
1492 #<module name="m_setname.so">
1494 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1495 # Serverban: Implements extended ban s:, which stops anyone connected
1496 # to a server matching a mask like +b s:server.mask.here from joining.
1497 #<module name="m_serverban.so">
1499 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1500 # Show Whois module: Adds the +W usermode which allows opers
1501 # to see when they are whois'ed (can be annoying).
1502 # This module is oper-only.
1503 #<module name="m_showwhois.so">
1505 # If you wish, you may also let users set this mode. Only opers with the
1506 # users/auspex priv will see real hosts of people, though. This setting
1507 # is not reloadable via /rehash, and will require /reloadmodule, as
1508 # it directly affects the mode object itself.
1509 #<showwhois opersonly="yes"
1511 # You may also set whether or not users should recieve whois notices, should
1512 # they be /whois'd by an oper.
1513 # showfromopers="yes">
1515 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1516 # Shun module: Provides the /shun command, which stops a user executing
1518 # This module is oper-only.
1519 # To use, SHUN must be in one of your oper class blocks.
1520 #<module name="m_shun.so">
1522 # You may also configure which commands you wish a user to be able to
1523 # perform. It should be noted that if a shunned user issues QUIT or PART
1524 # then their message will be removed, as if they did not issue one.
1526 # You can (optionally) let the user know that their command was blocked.
1528 # You may also let SHUN affect opers (defaults to no).
1529 #<shun enabledcommands="PING PONG QUIT PART JOIN" notifyuser="yes" affectopers="no">
1531 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1532 # Spy module: Provides the ability to see the complete names list of
1533 # channels an oper is not a member of
1534 # This module is oper-only.
1535 #<module name="m_spy.so">
1537 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1538 # SSL channel mode module: Adds support for SSL-only channels (+z).
1539 # does not do anything useful without a working SSL module (see below)
1540 #<module name="m_sslmodes.so">
1542 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1543 # GnuTLS ssl module: Adds support for client-server SSL using GnuTLS,
1544 # if enabled. You must copy the source for this module from the directory
1545 # src/modules/extra, or answer 'yes' in ./configure when asked if you
1546 # want to enable this, or it will not load.
1547 #<module name="m_ssl_gnutls.so">
1549 #-#-#-#-#-#-#-#-#-#-#- GNUTLS CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#
1551 # m_ssl_gnutls.so is too complex it describe here, see the wiki: #
1552 # http://wiki.inspircd.org/Modules/ssl_gnutls #
1554 # NOTE: If you want to use this module to encrypt and sign your #
1555 # server to server traffic, you MUST load it before m_spanningtree in #
1556 # your configuration file! #
1558 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1559 # SSL Info module: Allows users to retrieve information about other
1560 # user's peer SSL certificates and keys. This can be used by client
1561 # scripts to validate users. For this to work, one of m_ssl_gnutls.so
1562 # or m_ssl_openssl.so must be loaded. This module also adds the
1563 # "* <user> is using a secure connection" whois line, the ability for
1564 # opers to use SSL fingerprints to verify their identity and the ability
1565 # to force opers to use SSL connections in order to oper up.
1566 # It is highly recommended to load this module especially if
1567 # you use SSL on your network.
1568 # For how to use the oper features, please see the first example <oper> tag
1569 # in opers.conf.example.
1571 #<module name="m_sslinfo.so">
1573 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1574 # OpenSSL ssl module: Adds support for client-server SSL using OpenSSL,
1575 # if enabled. You must copy the source for this module from the directory
1576 # src/modules/extra, or answer 'yes' in ./configure when asked if you
1577 # want to enable this, or it will not load.
1578 #<module name="m_ssl_openssl.so">
1580 #-#-#-#-#-#-#-#-#-#-#- OPENSSL CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#
1582 # m_ssl_openssl.so is too complex it describe here, see the wiki: #
1583 # http://wiki.inspircd.org/Modules/ssl_openssl #
1585 # NOTE: If you want to use this module to encrypt and sign your #
1586 # server to server traffic, you MUST load it before m_spanningtree in #
1587 # your configuration file! #
1589 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1590 # Strip colour module: Adds the channel mode +S
1591 #<module name="m_stripcolor.so">
1593 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1594 # SILENCE module: Adds support for /SILENCE
1595 #<module name="m_silence.so">
1597 # Configuration tags:
1599 #<silence maxentries="32">
1601 # Sets the maximum number of entries on a users silence list.
1603 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1604 # SQLite3 module: Allows other SQL modules to access SQLite3 #
1605 # databases through a unified API. You must link the source for this #
1606 # module from the directory src/modules/extra to src/modules, plus #
1607 # the file m_sqlv2.h #
1608 # This modules is in extras. Re-run configure with: ./configure --enable-extras=m_aqlite.cpp
1609 # and run make install, then uncomment this module to enable it. #
1611 #<module name="m_sqlite3.so">
1613 #-#-#-#-#-#-#-#-#-#-#-#- SQL CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#-#
1615 # m_sqlite.so is more complex than described here, see the wiki for #
1616 # more: http://wiki.inspircd.org/Modules/sqlite3 #
1618 #<database hostname="/full/path/to/database.db" id="anytext">
1620 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1621 # SQLutils module: Provides some utilities to SQL client modules, such
1622 # as mapping queries to users and channels. You must copy the source
1623 # for this module from the directory src/modules/extra/m_sqlutils.cpp
1624 # and src/modules/extra/m_sqlutils.h into /src/modules
1625 # Needed for, and loaded before: SQLauth and SQLoper
1626 # This modules is in extras. Re-run configure with: ./configure --enable-extras=m_sqlutils.cpp
1627 # and run make install, then uncomment this module to enable it.
1629 #<module name="m_sqlutils.so">
1631 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1632 # SQL authentication module: Allows IRCd connections to be tied into
1633 # a database table (for example a forum). You must copy the source for
1634 # this module from the directory src/modules/extra
1635 # Depends on the SQLutils module being loaded first.
1636 # This modules is in extras. Re-run configure with: ./configure --enable-extras=m_sqlauth.cpp
1637 # and run make install, then uncomment this module to enable it.
1639 #<module name="m_sqlauth.so">
1641 #-#-#-#-#-#-#-#-#-#-#- SQLAUTH CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#
1643 # m_sqlauth.so is too complex it describe here, see the wiki: #
1644 # http://wiki.inspircd.org/Modules/sqlauth #
1646 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1647 # SQL logging module: Allows you to log network-wide data for your
1648 # network in a fully normalised set of SQL tables. You must copy the
1649 # source for this module from the directory src/modules/extra
1650 # This modules is in extras. Re-run configure with: ./configure --enable-extras=m_sqllog.cpp
1651 # and run make install, then uncomment this module to enable it.
1653 #<module name="m_sqllog.so">
1655 #-#-#-#-#-#-#-#-#-#-#- SQLLOG CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#
1657 # dbid - Database ID to use (see m_sql) #
1659 # See also: http://wiki.inspircd.org/Modules/sqllog #
1663 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1664 # SQL oper module: Allows you to store oper credentials in an SQL table
1665 # You must copy the source for this module from the directory src/modules/extra
1666 # Depends on the SQLutils module being loaded first.
1667 # This modules is in extras. Re-run configure with: ./configure --enable-extras=m_sqloper.cpp
1668 # and run make install, then uncomment this module to enable it.
1670 #<module name="m_sqloper.so">
1672 #-#-#-#-#-#-#-#-#-#-#- SQLOPER CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#
1674 # dbid - Database ID to use (see m_sql) #
1675 # hash - Hashing provider to use for password hashing #
1677 # See also: http://wiki.inspircd.org/Modules/sqloper #
1679 #<sqloper dbid="1" hash="md5">
1681 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1682 # SVSHold module: Implements SVSHOLD. Like Q:Lines, but can only be #
1683 # added/removed by Services. #
1684 #<module name="m_svshold.so">
1686 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1687 # SWHOIS module: Allows you to add arbitary lines to user WHOIS.
1688 # This module is oper-only.
1689 # To use, SWHOIS must be in one of your oper class blocks.
1690 #<module name="m_swhois.so">
1692 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1693 # Test module: enable this to create a command useful in testing
1694 # flood control. To avoid accidental use on live networks, the server
1695 # name must contain ".test" to load the module
1696 #<module name="m_testnet.so">
1698 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1699 # Timed bans module: Adds timed channel bans and the /TBAN command
1700 #<module name="m_timedbans.so">
1702 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1703 # Test line module: Adds the /TLINE command, used to test how many
1704 # users a /GLINE or /ZLINE etc would match.
1705 # This module is oper-only.
1706 # To use, TLINE must be in one of your oper class blocks.
1707 #<module name="m_tline.so">
1709 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1710 # UHNAMES support module: Adds support for the IRCX style UHNAMES
1711 # extension, which displays ident and hostname in the names list for
1712 # each user, saving clients from doing a WHO on the channel. Note that
1713 # this module is not widely supported yet. If a client does not support
1714 # UHNAMES it will not enable it, this will not break incompatible
1716 #<module name="m_uhnames.so">
1718 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1719 # Uninvite module: Adds the /UNINVITE command which lets users remove
1720 # pending invites from channels without waiting for the user to join.
1721 #<module name="m_uninvite.so">
1723 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1724 # Userip module: Adds the /USERIP command
1725 # This module is oper-only.
1726 # To use, USERIP must be in one of your oper class blocks.
1727 #<module name="m_userip.so">
1729 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1730 # Vhost module: Adds the VHOST command which allows for adding virtual
1731 # hosts which are accessible using a username and password in the config.
1732 #<module name="m_vhost.so">
1734 #-#-#-#-#-#-#-#-#-#-#- VHOST CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#-#
1736 # user - Username for the vhost. #
1738 # pass - Password for the vhost. #
1740 # hash - The hash for the specific user (optional)
1741 # m_password_hash.so and a hashing module must be loaded for this to work
1743 # host - Vhost to set. #
1745 #<vhost user="some_username" pass="some_password" host="some.host">
1746 #<vhost user="foo" password="fcde2b2edba56bf408601fb721fe9b5c338d10ee429ea04fae5511b68fbf8fb9" hash="sha256" host="some.other.host">
1748 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1749 # Watch module: Adds the WATCH command, which is used by clients to
1750 # maintain notify lists.
1751 #<module name="m_watch.so">
1753 # Configuration tags:
1755 #<watch maxentries="32">
1757 # Sets the maximum number of entries on a user's watch list.
1759 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1760 # XLine database: Stores all *Lines (G/Z/K/R/any added by other modules)
1761 # in a file "xline.db" which can be re-loaded on restart. This is useful
1762 # for two reasons: it keeps bans so users may not evade them, and on
1763 # bigger networks, server connections will take less time as there will
1764 # be a lot less bans to apply - as most of them will already be there.
1765 #<module name="m_xline_db.so">
1767 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1768 # ZipLinks module: Adds support for zlib deflate on server to server
1769 # connections. Both ends of the connection must load this module.
1770 # This modules is in extras. Re-run configure with: ./configure --enable-extras=m_ziplink.cpp
1771 # and run make install, then uncomment this module to enable it.
1773 #<module name="m_ziplink.so">
1775 # To use this module, you must enable it as a ssl type in your
1776 # <link> tags or <bind> tags using the ssl name 'ziplinks'.
1777 # See the documentation of <link> and <bind>, respectively.
1781 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1782 # ____ _ _____ _ _ ____ _ _ _ #
1783 # | _ \ ___ __ _ __| | |_ _| |__ (_)___ | __ )(_) |_| | #
1784 # | |_) / _ \/ _` |/ _` | | | | '_ \| / __| | _ \| | __| | #
1785 # | _ < __/ (_| | (_| | | | | | | | \__ \ | |_) | | |_|_| #
1786 # |_| \_\___|\__,_|\__,_| |_| |_| |_|_|___/ |____/|_|\__(_) #
1788 # To link servers to InspIRCd, you MUST load the m_spanningtree #
1789 # module. Since several features (like SSL server links) rely on #
1790 # other modules being loaded before m_spanningtree, the module itself #
1791 # is at the bottom of this file. DO NOT forget to load it. If you DO #
1792 # NOT do this, server links will NOT work at all. ie. The ports will #
1793 # NOT bind, and /connect will not work properly. This is by design, #
1794 # to allow for the implementation of other linking protocols in #
1795 # modules in the future. #
1798 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1799 # Spanning Tree module - allows linking of servers using the spanning
1800 # tree protocol (see the READ THIS BIT section above).
1801 # You will almost always want to load this.
1803 #<module name="m_spanningtree.so">
projects / user / henk / code / inspircd.git / blob