1 #-#-#-#-#-#-#-#-#-#-#-#-#- MODULE OPTIONS -#-#-#-#-#-#-#-#-#-#-#-#-#
3 # These tags define which modules will be loaded on startup by your #
4 # server. Add modules without any paths. When you make your ircd #
5 # using the 'make' command, all compiled modules will be moved into #
6 # the folder you specified when you ran ./configure. The module tag #
7 # automatically looks for modules in this location. #
8 # If you attempt to load a module outside of this location, either #
9 # in the config, or via /LOADMODULE, you will receive an error. #
11 # By default, ALL modules are commented out. You must uncomment them #
12 # or add lines to your config to load modules. Please refer to #
13 # http://wiki.inspircd.org/Modules for a list of modules and #
14 # each modules link for any additional conf tags they require. #
16 # ____ _ _____ _ _ ____ _ _ _ #
17 # | _ \ ___ __ _ __| | |_ _| |__ (_)___ | __ )(_) |_| | #
18 # | |_) / _ \/ _` |/ _` | | | | '_ \| / __| | _ \| | __| | #
19 # | _ < __/ (_| | (_| | | | | | | | \__ \ | |_) | | |_|_| #
20 # |_| \_\___|\__,_|\__,_| |_| |_| |_|_|___/ |____/|_|\__(_) #
22 # To link servers to InspIRCd, you MUST load the m_spanningtree #
23 # module. If you don't do this, server links will NOT work at all. #
24 # This is by design, to allow for the implementation of other linking #
25 # protocols in modules in the future. #
28 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
29 # MD5 module: Allows other modules to generate MD5 hashes, usually for
30 # cryptographic uses and security.
33 # Other modules such as m_cloaking.so and m_password_hash.so may rely on
34 # this module being loaded to function.
36 #<module name="m_md5.so">
38 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
39 # SHA256 module: Allows other modules to generate SHA256 hashes,
40 # usually for cryptographic uses and security.
43 # Other modules such as m_password_hash.so may rely on this module being
44 # loaded to function. Certain modules such as m_spanningtree.so will
45 # function without this module but when it is loaded their features will
46 # be enhanced (for example the addition of HMAC authentication).
48 #<module name="m_sha256.so">
49 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
50 # RIPEMD160 module: Allows other modules to generate RIPEMD160 hashes,
51 # usually for cryptographic uses and security.
54 # Other modules may rely on this module being loaded to function.
55 #<module name="m_ripemd160.so">
57 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
58 # Abbreviation module: Provides the ability to abbreviate commands a-la
60 #<module name="m_abbreviation.so">
62 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
63 # Alias module: Allows you to define server-side command aliases.
64 #<module name="m_alias.so">
66 # Set the 'prefix' for in-channel aliases (fantasy commands) to the
67 # specified character. If not set, the default is "!".
68 # If 'allowbots' is disabled, +B clients will not be able to use
69 # fantasy commands. If not set, the default is no.
70 #<fantasy prefix="!" allowbots="no">
72 #-#-#-#-#-#-#-#-#-#-#- ALIAS DEFINITIONS -#-#-#-#-#-#-#-#-#-#-#-#-#-#
74 # If you have the m_alias.so module loaded, you may also define #
75 # aliases as shown below. They are commonly used to provide shortcut #
76 # commands to services, however they are not limited to just this use.#
77 # An alias tag requires the following values to be defined in it: #
79 # text - The text to detect as the actual command line. #
80 # Can't contain spaces, but case insensitive. #
81 # You may have multiple aliases with the same #
82 # command name (text="" value), however the first #
83 # found will be executed if its format value is #
84 # matched, or it has no format value. Aliases are #
85 # read from the top of the file to the bottom. #
87 # usercommand - If this is true, the alias can be run simply as #
88 # /aliasname. Defaults to true. #
90 # channelcommand - If this is true, the alias can be used as an #
91 # in-channel alias or 'fantasy command', prefixed #
92 # by the fantasy prefix character, !aliasname by #
93 # default. Defaults to false. #
95 # format - If this is defined, the parameters of the alias #
96 # must match this glob pattern. For example if you #
97 # want the first parameter to start with a # for #
98 # the alias to be executed, set format="#*" in the #
99 # alias definition. Note that the :'s which are #
100 # part of IRC formatted lines will be preserved #
101 # for matching of this text. This value is #
104 # replace - The text to replace 'text' with. Usually this #
105 # will be "PRIVMSG ServiceName :$2-" or similar. #
106 # You may use the variables $1 through $9 in the #
107 # replace string, which refer to the first through #
108 # ninth word in the original string typed by the #
109 # user. You may also use $1- through $9- which #
110 # refer to the first word onwards, through to the #
111 # ninth word onwards, e.g. if the user types the #
112 # command "foo bar baz qux quz" then $3- will hold #
113 # "baz qux quz" and $2 will contain "bar". You may #
114 # also use the special variables: $nick, $ident, #
115 # $host and $vhost, and you may separate multiple #
116 # commands with a newline (which can be written in #
117 # the file literally, or encoded as &nl; or \n #
118 # depending on the config format setting). #
120 # requires - If you provide a value for 'requires' this means #
121 # the given nickname MUST be online for the alias #
122 # to successfully trigger. If they are not, then #
123 # the user receives a 'no such nick' 401 numeric. #
125 # uline - Setting this to true will ensure that the user #
126 # given in 'requires' is also on a u-lined server, #
127 # as well as actually being on the network. If the #
128 # user is online, but not on a u-lined server, #
129 # then an oper alert is sent out as this is #
130 # possibly a sign of a user trying to impersonate #
133 # operonly - If true, this will make the alias oper only. #
134 # If a non-oper attempts to use the alias, it will #
135 # appear to not exist. #
137 #<alias text="NICKSERV" replace="PRIVMSG NickServ :$2-" requires="NickServ" uline="yes">
138 #<alias text="CHANSERV" replace="PRIVMSG ChanServ :$2-" requires="ChanServ" uline="yes">
139 #<alias text="OPERSERV" replace="PRIVMSG OperServ :$2-" requires="OperServ" uline="yes" operonly="yes">
140 #<alias text="BOTSERV" replace="PRIVMSG BotServ :$2-" requires="BotServ" uline="yes">
141 #<alias text="HOSTSERV" replace="PRIVMSG HostServ :$2-" requires="HostServ" uline="yes">
142 #<alias text="MEMOSERV" replace="PRIVMSG MemoServ :$2-" requires="MemoServ" uline="yes">
143 #<alias text="NS" replace="PRIVMSG NickServ :$2-" requires="NickServ" uline="yes">
144 #<alias text="CS" replace="PRIVMSG ChanServ :$2-" requires="ChanServ" uline="yes">
145 #<alias text="OS" replace="PRIVMSG OperServ :$2-" requires="OperServ" uline="yes" operonly="yes">
146 #<alias text="BS" replace="PRIVMSG BotServ :$2-" requires="BotServ" uline="yes">
147 #<alias text="HS" replace="PRIVMSG HostServ :$2-" requires="HostServ" uline="yes">
148 #<alias text="MS" replace="PRIVMSG MemoServ :$2-" requires="MemoServ" uline="yes">
150 # An example of using the format value to create an alias with two
151 # different behaviours depending on the format of the parameters.
153 #<alias text="ID" format="#*" replace="PRIVMSG ChanServ :IDENTIFY $2 $3"
154 # requires="ChanServ" uline="yes">
156 #<alias text="ID" replace="PRIVMSG NickServ :IDENTIFY $2"
157 # requires="NickServ" uline="yes">
159 # This alias fixes a glitch in xchat 2.6.x and above and the way it
160 # assumes IDENTIFY must be prefixed by a colon (:) character. It should
161 # be placed ABOVE the default NICKSERV alias (the first example) listed
164 #<alias text="NICKSERV" format=":IDENTIFY *" replace="PRIVMSG NickServ :IDENTIFY $3-"
165 # requires="NickServ" uline="yes">
167 # You may also add aliases to trigger based on something said in a
168 # channel, aka 'fantasy' commands, configured in the same manner as any
169 # other alias, with usercommand="no" and channelcommand="yes" The
170 # command must be preceded by the fantasy prefix when used.
172 #<alias text="CS" usercommand="no" channelcommand="yes"
173 # replace="PRIVMSG ChanServ :$1 $chan $2-" requires="ChanServ" uline="yes">
175 # This would be used as "!cs <command> <options>", with the channel
176 # being automatically inserted after the command in the message to
177 # ChanServ, assuming the fantasy prefix is "!".
179 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
180 # Allowinvite module: Gives channel mode +A to allow all users to use
181 # /INVITE, and extban A to deny invite from specific masks.
182 #<module name="m_allowinvite.so">
184 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
185 # Alltime module: Shows time on all connected servers at once.
186 # This module is oper-only and provides /ALLTIME.
187 # To use, ALLTIME must be in one of your oper class blocks.
188 #<module name="m_alltime.so">
190 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
191 # Auditorium module: Adds channel mode +u which makes everyone else
192 # except you in the channel invisible, used for large meetings etc.
193 #<module name="m_auditorium.so">
195 # Auditorium settings:
197 #<auditorium opvisible="no" opcansee="no" opercansee="yes">
199 # opvisible (auditorium-vis in exemptchanops):
200 # Show channel ops to all users
201 # opcansee (auditorium-see in exemptchanops):
202 # Allow ops to see all joins/parts/kicks in the channel
204 # Allow opers (channels/auspex) to see see all joins/parts/kicks in the channel
206 # Exemptchanops can be used to adjust the level at which users become visible or
207 # the level at which they can see the full member list of the channel.
209 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
210 # Autoop module: Adds basic channel access controls via the +w listmode.
211 # For example +w o:*!Attila@127.0.0.1 will op anyone matching that mask
212 # on join. This can be combined with extbans, for example +w o:R:Brain
213 # will op anyone identified to the account "Brain".
214 # Another useful combination is with SSL client certificate
215 # fingerprints: +w h:z:72db600734bb9546c1bdd02377bc21d2a9690d48 will
216 # give halfop to the user(s) having the given certificate.
217 #<module name="m_autoop.so">
219 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
220 # Ban except module: Adds support for channel ban exceptions (+e).
221 #<module name="m_banexception.so">
223 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
224 # Ban redirection module: Allows bans which redirect to a specified
225 # channel. e.g. +b nick!ident@host#channelbanneduserissentto
226 #<module name="m_banredirect.so">
228 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
229 # Block amsg module: Attempt to block all usage of /amsg and /ame.
230 #<module name="m_blockamsg.so">
232 #-#-#-#-#-#-#-#-#-#-#- BLOCKAMSG CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
234 # If you have the m_blockamsg.so module loaded, you can configure it #
235 # with the <blockamsg> tag: #
237 # delay - How many seconds between two messages to force #
238 # them to be recognised as unrelated. #
239 # action - Any of 'notice', 'noticeopers', 'silent', 'kill' #
240 # or 'killopers'. Define how to take action when #
241 # a user uses /amsg or /ame. #
243 #<blockamsg delay="3" action="killopers">
245 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
246 # Block CAPS module: Blocking all-CAPS messages with channel mode +B.
247 #<module name="m_blockcaps.so">
249 #-#-#-#-#-#-#-#-#-#-#- BLOCKCAPS CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
251 # percent - How many percent of text must be caps before text #
254 # minlen - The minimum length a line must be for the block #
255 # percent to have any effect. #
257 # capsmap - A list of chars to be considered CAPS, this was #
258 # you can add CAPS for your language. Also you can #
259 # add things like ! and space to further lock down #
261 #<blockcaps percent="50"
263 # capsmap="ABCDEFGHIJKLMNOPQRSTUVWXYZ! ">
265 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
266 # Block color module: Blocking color-coded messages with chan mode +c.
267 #<module name="m_blockcolor.so">
269 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
270 # Botmode module: Adds the user mode +B. If set on a user, it will
271 # show that the user is a bot in /WHOIS.
272 #<module name="m_botmode.so">
274 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
275 # CallerID module: Adds usermode +g which activates hybrid-style
276 # callerid: block all private messages unless you /accept first
277 #<module name="m_callerid.so">
279 #-#-#-#-#-#-#-#-#-#-#- CALLERID CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#
280 # maxaccepts - Maximum number of entries a user can add to his #
281 # /accept list. Default is 16 entries. #
282 # operoverride - Can opers (note: ALL opers) override callerid? #
284 # tracknick - Preserve /accept entries when a user changes nick? #
285 # If no (the default), the user is removed from #
286 # everyone's accept list if he changes nickname. #
287 # cooldown - Amount of time (in seconds) that must pass since #
288 # the last notification sent to a user before he can #
289 # be sent another. Default is 60 (1 minute). #
290 #<callerid maxaccepts="16"
295 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
296 # CAP module: Provides the CAP negotiation mechanism seen in
297 # ratbox-derived ircds.
298 #<module name="m_cap.so">
300 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
301 # CBAN module: Lets you disallow channels from being used at runtime.
302 # This module is oper-only and provides /cban.
303 # To use, CBAN must be in one of your oper class blocks.
304 #<module name="m_cban.so">
306 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
307 # Censor module: Adds channel and user mode +G.
308 #<module name="m_censor.so">
310 #-#-#-#-#-#-#-#-#-#-#- CENSOR CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#
312 # Optional - If you specify to use the m_censor module, then you must #
313 # specify some censor tags. See also: #
314 # http://wiki.inspircd.org/Modules/censor #
316 #<include file="examples/censor.conf.example">
318 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
319 # CGI:IRC module: Adds support for automatic host changing in CGI:IRC
320 # (http://cgiirc.sourceforge.net).
321 # Adds snomask +w for monitoring CGI:IRC connections.
322 #<module name="m_cgiirc.so">
324 #-#-#-#-#-#-#-#-#-#-#-# CGIIRC CONFIGURATION #-#-#-#-#-#-#-#-#-#-#-#-#
326 # Optional - If you specify to use m_cgiirc, then you must specify one
327 # or more cgihost tags which indicate authorised CGI:IRC servers which
328 # will be connecting to your network, and an optional cgiirc tag.
329 # For more information see: http://wiki.inspircd.org/Modules/cgiirc
331 # Set to yes if you want to notice opers when CGI:IRC clients connect.
332 # <cgiirc opernotice="no">
334 # The type field indicates where the module should get the real
335 # client's IP address from, for further information, please see the
336 # CGI:IRC documentation.
339 # <cgihost type="pass" mask="www.mysite.com"> # Get IP from PASS
340 # <cgihost type="ident" mask="otherbox.mysite.com"> # Get IP from ident
341 # <cgihost type="passfirst" mask="www.mysite.com"> # See the docs
343 # <cgihost type="webirc" password="foobar"
344 # mask="somebox.mysite.com"> # Get IP from WEBIRC
349 # When you connect CGI:IRC clients, there are two connect classes which
350 # apply to these clients. When the client initially connects, the connect
351 # class which matches the CGI:IRC site's host is checked. Therefore you
352 # must raise the maximum local/global clients for this ip as high as you
353 # want to allow cgi clients. After the client has connected and is
354 # determined to be a cgi:irc client, the class which matches the client's
355 # real IP is then checked. You may set this class to a lower value, so that
356 # the real IP of the client can still be restricted to, for example, 3
359 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
360 # Channel create module: Adds snomask +j, which will notify opers of
361 # any new channels that are created.
362 # This module is oper-only.
363 #<module name="m_chancreate.so">
365 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
366 # Channel filter module: Allows channel-op defined message filtering
367 # using simple string matches (channel mode +g).
368 #<module name="m_chanfilter.so">
370 # If hidemask is set to yes, the user will not be shown the mask when
371 # his/her message is blocked.
372 #<chanfilter hidemask="yes">
374 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
375 # Channel history module: Displays the last 'X' lines of chat to a user
376 # joining a channel with +H 'X:T' set; 'T' is the maximum time to keep
377 # lines in the history buffer. Designed so that the new user knows what
378 # the current topic of conversation is when joining the channel.
379 #<module name="m_chanhistory.so">
381 # Set the maximum number of lines allowed to be stored per channel below.
382 # This is the hard limit for 'X'.
383 # If notice is set to yes, joining users will get a NOTICE before playback
384 # telling them about the following lines being the pre-join history.
385 # If bots is set to yes, it will also send to users marked with +B
386 #<chanhistory maxlines="20" notice="yes" bots="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 # Channel names module: Allows disabling channels which have certain
400 # characters in the channel name such as bold, colorcodes, etc. which
401 # can be quite annoying and allow users to on occasion have a channel
402 # that looks like the name of another channel on the network.
403 #<module name="m_channames.so">
406 # denyrange: characters or range of characters to deny in channel
410 # allowrange: characters or range of characters to specifically allow
414 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
415 # Channelban: Implements extended ban j:, which stops anyone already
416 # in a channel matching a ban like +b j:#channel*mask from joining.
417 #<module name="m_channelban.so">
419 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
420 # Check module: Adds the /CHECK command.
421 # Check is useful for looking up information on channels, users,
422 # IP addresses and hosts.
423 # This module is oper-only.
424 # To use, CHECK must be in one of your oper class blocks.
425 #<module name="m_check.so">
427 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
428 # CHGHOST module: Adds the /CHGHOST command.
429 # This module is oper-only.
430 # To use, CHGHOST must be in one of your oper class blocks.
431 # NOTE: Services will not be able to set vhosts on users if this module
432 # isn't loaded. If you're planning on running services, you probably
434 #<module name="m_chghost.so">
436 #-#-#-#-#-#-#-#-# /CHGHOST - /SETHOST CONFIGURATION #-#-#-#-#-#-#-#-#
437 # Optional - If you want to use special chars for hostnames you can #
438 # specify your own custom list of chars with the <hostname> tag: #
440 # charmap - A list of chars accepted as valid by the /CHGHOST #
441 # and /SETHOST commands. Also note that the list is #
443 #<hostname charmap="abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ.-_/0123456789">
445 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
446 # CHGIDENT module: Adds the /CHGIDENT command.
447 # This module is oper-only.
448 # To use, CHGIDENT must be in one of your oper class blocks.
449 #<module name="m_chgident.so">
451 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
452 # CHGNAME module: Adds the /CHGNAME command
453 # This module is oper-only.
454 # To use, CHGNAME must be in one of your oper class blocks.
455 #<module name="m_chgname.so">
457 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
458 # Clear chan module: Allows opers to masskick, masskill or mass-G/ZLine
459 # all users on a channel using /CLEARCHAN.
460 #<module name="m_clearchan.so">
462 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
463 # Cloaking module: Adds usermode +x and cloaking support.
464 # Relies on the module m_md5.so being loaded.
465 # To use, you should enable m_conn_umodes and add +x as
466 # an enabled mode. See the m_conn_umodes module for more information.
467 #<module name="m_cloaking.so">
469 #-#-#-#-#-#-#-#-#-#-#- CLOAKING CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#
471 # To use m_cloaking, you must define a cloak key, and optionally a #
472 # cloak prefix as shown below. The cloak key must be shared across #
473 # the network for correct cloaking. #
475 # There are two methods of cloaking: #
477 # half Cloak only the "unique" portion of a host; show #
478 # the last 2 parts of the domain, /16 subnet of IPv4 #
479 # or /48 subnet of the IPv6 address. #
481 # full Cloak the users completely, using three slices for #
482 # common CIDR bans (IPv4: /16, /24; IPv6: /48, /64). #
484 # The methods use a single key that can be any length of text. #
485 # An optional prefix may be specified to mark cloaked hosts. #
486 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
492 #-#-#-#-#-#-#-#-#-#-#-#- CLOSE MODULE #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
493 # Close module: Allows an oper to close all unregistered connections.
494 # This module is oper-only and provides the /CLOSE command.
495 # To use, CLOSE must be in one of your oper class blocks.
496 #<module name="m_close.so">
498 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
499 # Clones module: Adds an oper command /CLONES for detecting cloned
500 # users. Warning: This command may be resource intensive when it is
501 # issued, use with care.
502 # This module is oper-only.
503 # To use, CLONES must be in one of your oper class blocks.
504 #<module name="m_clones.so">
506 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
507 # Common channels module: Adds user mode +c, which, when set, requires
508 # that users must share a common channel with you to PRIVMSG or NOTICE
510 #<module name="m_commonchans.so">
512 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
513 # Auto join on connect module: Allows you to force users to join one
514 # or more channels automatically upon connecting to the server, or
515 # join them in case they aren't on any channels after being online
517 #<module name="m_conn_join.so">
519 #-#-#-#-#-#-#-#-#-#-#-#- CONNJOIN CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
521 # If you have m_conn_join.so loaded, you can configure it using the
522 # following values, or set autojoin="#chat,#help" in <connect> blocks.
524 # Join users immediately after connection to #one #two and #three.
525 #<autojoin channel="#one,#two,#three">
526 # Join users to #chat after 15 seconds if they aren't on any channels.
527 #<autojoin channel="#chat" delay="15">
529 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
530 # Set modes on connect module: When this module is loaded <connect>
531 # blocks may have an optional modes="" value, which contains modes to
532 # add or remove from users when they connect to the server.
533 #<module name="m_conn_umodes.so">
535 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
536 # Wait for PONG on connect module: Send a PING to all connecting users
537 # and don't let them connect until they reply with a PONG.
538 # This is useful to stop certain kinds of bots and proxies.
539 #<module name="m_conn_waitpong.so">
541 #-#-#-#-#-#-#-#-#-#-#- WAITPONG CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
543 # If you have the m_conn_waitpong.so module loaded, configure it with #
544 # the <waitpong> tag: #
546 # sendsnotice - Whether to send a helpful notice to users on #
547 # connect telling them how to connect, should #
548 # their client not reply PONG automatically. #
550 # killonbadreply - Whether to kill the user if they send the wrong #
553 #<waitpong sendsnotice="yes" killonbadreply="yes">
555 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
556 # Channel cycle module: Adds the /CYCLE command which is a server-side
557 # /HOP that bypasses restrictive modes.
558 #<module name="m_cycle.so">
560 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
561 # Connectban: Provides IP connection throttling. Any IP range that
562 # connects too many times (configurable) in an hour is Z-Lined for a
563 # (configurable) duration, and their count resets to 0.
564 #<module name="m_connectban.so">
566 # ipv4cidr and ipv6cidr allow you to turn the comparison from
567 # individual IP addresses (32 and 128 bits) into CIDR masks, to allow
568 # for throttling over whole ISPs/blocks of IPs, which may be needed to
571 # This allows for 10 connections in an hour with a 10 minute ban if
573 #<connectban threshold="10" duration="10m" ipv4cidr="32" ipv6cidr="128"
574 # A custom ban message may optionally be specified.
575 # banmessage="Your IP range has been attempting to connect too many times in too short a duration. Wait a while, and you will be able to connect.">
577 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
578 # Connection throttle module.
579 #<module name="m_connflood.so">
581 #-#-#-#-#-#-#-#-#-#-#- CONNTHROTTLE CONFIGURATION -#-#-#-#-#-#-#-#-#-#
582 # seconds, maxconns - Amount of connections per <seconds>.
584 # timeout - Time to wait after the throttle was activated
585 # before deactivating it. Be aware that the time
586 # is seconds + timeout.
588 # quitmsg - The message that users get if they attempt to
589 # connect while the throttle is active.
591 # bootwait - Amount of time in seconds to wait before enforcing
592 # the throttling when the server just booted.
594 #<connflood seconds="30" maxconns="3" timeout="30"
595 # quitmsg="Throttled" bootwait="10">
597 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
598 # Custom prefixes: Allows for channel prefixes to be added.
599 #<module name="m_customprefix.so">
601 # name The name of the mode, must be unique from other modes.
602 # letter The letter used for this mode. Required.
603 # prefix The prefix used for nicks with this mode. Not required.
604 # rank A numeric rank for this prefix, defining what permissions it gives.
605 # The rank of voice, halfop and op is 10000, 20000, and 30000,
607 # ranktoset The numeric rank required to set/unset this mode. Defaults to rank.
608 # depriv Can you remove the mode from yourself? Defaults to yes.
609 #<customprefix name="founder" letter="q" prefix="~" rank="50000" ranktoset="50000">
610 #<customprefix name="admin" letter="a" prefix="&" rank="40000" ranktoset="50000">
611 #<customprefix name="halfop" letter="h" prefix="%" rank="20000" ranktoset="30000">
612 #<customprefix name="halfvoice" letter="V" prefix="-" rank="1" ranktoset="20000">
614 # Do /RELOADMODULE m_customprefix.so after changing the settings of this module.
616 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
617 # Custom title module: Adds the /TITLE command which allows for trusted
618 # users to gain a custom whois line and an optional vhost can be
620 #<module name="m_customtitle.so">
622 #-#-#-#-#-#-#-#-#-#- CUSTOM TITLE CONFIGURATION -#-#-#-#-#-#-#-#-#-#
623 # name - The username used to identify.
624 # password - The password used to identify.
625 # hash - The hash for the specific user's password (optional).
626 # m_password_hash.so and a hashing module must be loaded
628 # host - Allowed hostmask (optional).
629 # title - Title shown in whois.
630 # vhost - Displayed host (optional).
632 #<title name="foo" password="bar" title="Official Chat Helper">
633 #<title name="bar" password="foo" host="ident@host.name" title="Official Chat Helper" vhost="helper.network.chat">
634 #<title name="foo" password="fcde2b2edba56bf408601fb721fe9b5c338d10ee429ea04fae5511b68fbf8fb9" hash="sha256" title="Official Chat Helper">
636 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
637 # DCCALLOW module: Adds the /DCCALLOW command.
638 #<module name="m_dccallow.so">
640 #-#-#-#-#-#-#-#-#-#-#- DCCALLOW CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
641 # blockchat - Whether to block DCC CHAT as well as DCC SEND.
642 # length - Default duration of entries in DCCALLOW list.
643 # action - Default action to take if no action is
644 # specified, can be 'block' or 'allow'.
646 # File configuration:
647 # pattern - The glob pattern to match against.
648 # action - Action to take if a user attempts to send a file
649 # that matches this pattern, can be 'block' or
652 #<dccallow blockchat="yes" length="5m" action="block">
653 #<banfile pattern="*.exe" action="block">
654 #<banfile pattern="*.txt" action="allow">
656 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
657 # Deaf module: Adds support for the usermode +d - deaf to channel
658 # messages and channel notices.
659 #<module name="m_deaf.so">
661 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
662 # Delay join module: Adds the channel mode +D which delays all JOIN
663 # messages from users until they speak. If they quit or part before
664 # speaking, their quit or part message will not be shown to the channel
665 # which helps cut down noise on large channels in a more friendly way
666 # than the auditorium mode. Only channel ops may set the +D mode.
667 #<module name="m_delayjoin.so">
669 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
670 # Delay message module: Adds the channel mode +d which disallows a user
671 # from talking in the channel unless they've been joined for X seconds.
672 # Settable using /MODE #chan +d 30
673 #<module name="m_delaymsg.so">
675 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
676 # Deny channels module: Deny channels from being used by users.
677 #<module name="m_denychans.so">
679 #-#-#-#-#-#-#-#-#-#-#- DENYCHAN DEFINITIONS -#-#-#-#-#-#-#-#-#-#-#-#
681 # If you have the m_denychans.so module loaded, you need to specify #
682 # the channels to deny: #
684 # name - The channel name to deny (glob masks are ok). #
685 # allowopers - If operators are allowed to override the deny. #
686 # reason - Reason given for the deny. #
687 # redirect - Redirect the user to a different channel. #
689 #<badchan name="#gods*" allowopers="yes" reason="Tortoises!"> #
690 #<badchan name="#heaven" redirect="#hell" reason="Nice try!"> #
692 # Redirects will not work if the target channel is set +L. #
694 # Additionally, you may specify channels which are allowed, even if #
695 # a badchan tag specifies it would be denied: #
696 #<goodchan name="#godsleeps"> #
697 # Glob masks are accepted here also. #
699 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
700 # Devoice module: Let users devoice themselves using /DEVOICE #chan.
701 #<module name="m_devoice.so">
703 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
704 # DNS blacklist module: Provides support for looking up IPs on one or #
706 #<module name="m_dnsbl.so"> #
708 # For configuration options please see the wiki page for m_dnsbl at #
709 # http://wiki.inspircd.org/Modules/dnsbl #
711 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
712 # Exempt channel operators module: Provides support for allowing #
713 # channel operators to be exempt from some channel modes. Supported #
714 # modes are blockcaps, noctcp, blockcolor, nickflood, flood, censor, #
715 # filter, regmoderated, nonick, nonotice, and stripcolor. #
716 #<module name="m_exemptchanops.so"> #
718 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
719 # Filter module: Provides message filtering, similar to SPAMFILTER. #
720 #<module name="m_filter.so">
722 # This module depends upon a regex provider such as m_regex_pcre or #
723 # m_regex_glob to function. You must specify which of these you want #
724 # m_filter to use via the tag below. #
726 # Valid engines are: #
728 # glob - Glob patterns, provided via m_regex_glob.so #
729 # pcre - PCRE regexps, provided via m_regex_pcre.so, needs libpcre #
730 # tre - TRE regexps, provided via m_regex_tre.so, requires libtre #
731 # posix - POSIX regexps, provided via m_regex_posix.so, not availale #
732 # on windows, no dependencies on other operating systems. #
734 #<filteropts engine="glob"> #
736 # Your choice of regex engine must match on all servers network-wide.
738 # You may specify specific channels that are exempt from being filtered:
739 #<exemptfromfilter channel="#blah">
741 #-#-#-#-#-#-#-#-#-#-#- FILTER CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#
743 # Optional - If you specify to use the m_filter module, then #
744 # specify below the path to the filter.conf file, or define some #
747 #<include file="examples/filter.conf.example">
749 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
750 # Flash Policy Daemon module: Allows Flash IRC clients (e.g. LightIRC)#
751 # to connect. If no file is specified, it'll serve a default policy #
752 # allowing all IPs to connect to all plaintext IRC ports #
753 #<bind address="" port="8430" type="flashpolicyd"> #
754 #<flashpolicyd timeout="5" file=""> #
755 #<module name="m_flashpolicyd.so"> #
757 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
758 # Gecos ban: Implements extended ban 'r', which stops anyone matching
759 # a mask like +b r:*realname?here* from joining a channel.
760 #<module name="m_gecosban.so">
762 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
763 # GeoIP module: Allows the server admin to match users by country code.
764 # This module is in extras. Re-run configure with:
765 # ./configure --enable-extras=m_geoip.cpp
766 # and run make install, then uncomment this module to enable it.
767 # This module requires GeoIP to be installed on your system,
768 # use your package manager to find the appropriate packages
769 # or check the InspIRCd wiki page for this module.
770 #<module name="m_geoip.so">
772 # The actual allow/ban actions are done by connect classes, not by the
773 # GeoIP module. An example connect class to ban people from russia or
776 # <connect deny="*" geoip="TR,RU">
778 # The country code must be in capitals and should be an ISO country
779 # code such as TR, GB, or US. Unknown IPs (localhost, LAN IPs, etc)
780 # will be assigned the country code "UNK". Since connect classes are
781 # matched from top down, your deny classes must be above your allow
782 # classes for them to match.
784 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
785 # Globops module: Provides the /GLOBOPS command and snomask +g.
786 # This module is oper-only.
787 # To use, GLOBOPS must be in one of your oper class blocks.
788 #<module name="m_globops.so">
790 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
791 # Global load module: Allows loading and unloading of modules network-
792 # wide (USE WITH EXTREME CAUTION!)
793 # This module is oper-only and provides /gloadmodule, /gunloadmodule
794 # and /greloadmodule.
795 # To use, GLOADMODULE, GUNLOADMODULE and GRELOADMODULE
796 # must be in one of your oper class blocks.
797 #<module name="m_globalload.so">
799 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
800 # HELPOP module: Provides the /HELPOP command
801 #<module name="m_helpop.so">
803 #-#-#-#-#-#-#-#-#-#-#-#- HELPOP CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
805 # If you specify to use the m_helpop.so module, then specify below #
806 # the path to the helpop.conf file. #
808 #<include file="examples/inspircd.helpop-full.example">
810 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
811 # Hide chans module: Allows users to hide their channels list from non-
812 # opers by setting user mode +I on themselves.
813 #<module name="m_hidechans.so">
815 # This mode can optionally prevent opers from seeing channels on a +I
816 # user, for more privacy if set to true.
817 # This setting is not recommended for most mainstream networks.
818 #<hidechans affectsopers="false">
820 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
821 # Hide oper module: Allows opers to hide their oper status from non-
822 # opers by setting user mode +H on themselves.
823 # This module is oper-only.
824 #<module name="m_hideoper.so">
826 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
827 # Hostchange module: Allows a different style of cloaking.
828 #<module name="m_hostchange.so">
830 #-#-#-#-#-#-#-#-#-#-#- HOSTCHANGE CONFIGURATION -#-#-#-#-#-#-#-#-#-#
832 # See http://wiki.inspircd.org/Modules/hostchange for help. #
834 #<host suffix="polarbears.org" separator="." prefix="">
835 #<hostchange mask="*@fbi.gov" action="addnick">
836 #<hostchange mask="*r00t@*" action="suffix">
837 #<hostchange mask="a@b.com" action="set" value="blah.blah.blah">
838 #<hostchange mask="localhost" ports="7000,7001,7005-7007" action="set" value="blahblah.foo">
840 # hostcycle: If loaded, when a user gets a host or ident set, it will
841 # cycle them in all their channels. If not loaded it will simply change
842 # their host/ident without cycling them.
843 #<module name="m_hostcycle.so">
845 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
846 # httpd module: Provides HTTP server support for InspIRCd.
847 #<module name="m_httpd.so">
849 #-#-#-#-#-#-#-#-#-#-#-#- HTTPD CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
851 # If you choose to use the m_httpd.so module, then you will need to add
852 # a <bind> tag with type "httpd", and load at least one of the other
853 # m_httpd_* modules to provide pages to display.
855 # You can adjust the timeout for HTTP connections below. All HTTP
856 # connections will be closed after (roughly) this many seconds.
857 #<httpd timeout="20">
859 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
860 # HTTP ACL module: Provides access control lists for m_httpd dependent
861 # modules. Use this module to restrict pages by IP address and by
863 #<module name="m_httpd_acl.so">
865 #-#-#-#-#-#-#-#-#-#-#-#- HTTPD ACL CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
867 # Restrict access to the m_httpd_stats module to all but the local
868 # network and when the correct password is specified:
869 # <httpdacl path="/stats*" types="password,whitelist"
870 # username="secretstuff" password="mypasshere" whitelist="127.0.0.*,10.*">
872 # Deny all connections to all but the main index page:
873 # <httpdacl path="/*" types="blacklist" blacklist="*">
875 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
876 # HTTP config module: Allows the configuration of the server to be
877 # viewed over HTTP. Requires m_httpd.so to be loaded for it to function.
878 #<module name="m_httpd_config.so">
880 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
881 # HTTP stats module: Provides basic stats pages over HTTP.
882 # Requires m_httpd.so to be loaded for it to function.
883 #<module name="m_httpd_stats.so">
885 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
886 # Ident: Provides RFC 1413 ident lookup support.
887 # When this module is loaded <connect:allow> tags may have an optional
888 # useident="yes|no" boolean value, determining whether or not to lookup
889 # ident on users matching that connect tag.
890 #<module name="m_ident.so">
892 #-#-#-#-#-#-#-#-#-#-#-#- IDENT CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
894 # Optional - If you are using the m_ident.so module, then you can #
895 # specify the timeout for ident lookups here. If not defined, it will #
896 # default to 5 seconds. This is a non-blocking timeout which holds #
897 # the user in a 'connecting' state until the lookup is complete. #
898 # The bind value indicates which IP to bind outbound requests to. #
902 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
903 # Invite exception module: Adds support for channel invite exceptions
905 #<module name="m_inviteexception.so">
906 # Does a +I bypass channel +k in addition to +i?
907 #<inviteexception bypasskey="yes">
909 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
910 # IRCv3 module: Provides the following IRCv3.1 extensions:
911 # extended-join, away-notify and account-notify. These are optional
912 # enhancements to the client-to-server protocol. An extension is only
913 # active for a client when the client specifically requests it, so this
914 # module needs m_cap to work.
916 # Further information on these extensions can be found at the IRCv3
917 # working group website:
918 # http://ircv3.org/extensions/
920 #<module name="m_ircv3.so">
921 # The following block can be used to control which extensions are
922 # enabled. Note that extended-join can be incompatible with m_delayjoin
924 #<ircv3 accountnotify="on" awaynotify="on" extendedjoin="on">
926 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
927 # Join flood module: Adds support for join flood protection +j X:Y.
928 # Closes the channel for 60 seconds if X users join in Y seconds.
929 #<module name="m_joinflood.so">
931 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
932 # Jump server module: Adds support for the RPL_REDIR numeric.
933 # This module is oper-only.
934 # To use, JUMPSERVER must be in one of your oper class blocks.
935 # If your server is redirecting new clients and you get disconnected,
936 # do a REHASH from shell to open up again.
937 #<module name="m_jumpserver.so">
939 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
940 # Anti auto rejoin: Adds support for prevention of auto-rejoin (+J).
941 #<module name="m_kicknorejoin.so">
943 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
944 # Knock module: Adds the /KNOCK command and channel mode +K.
945 #<module name="m_knock.so">
947 # This setting specifies what to do when someone successfully /KNOCKs.
948 # If set to "notice", then a NOTICE will be sent to the channel.
949 # This is the default and the compatible setting, as it requires no
950 # special support from the clients.
951 # If set to "numeric" then a 710 numeric will be sent to the channel.
952 # This allows easier scripting but not all clients support it.
953 # If set to "both" then (surprise!) both will be sent.
954 #<knock notify="notice">
956 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
957 # LDAP module: Allows other SQL modules to access a LDAP database
958 # through a unified API.
959 # This modules is in extras. Re-run configure with:
960 # ./configure --enable-extras=m_ldap.cpp
961 # and run make install, then uncomment this module to enable it.
963 #<module name="m_ldap.so">
964 #<database module="ldap" id="ldapdb" server="ldap://localhost" binddn="cn=Manager,dc=inspircd,dc=org" bindauth="mysecretpass" searchscope="subtree">
965 # The server parameter indicates the LDAP server to connect to. The #
966 # ldap:// style scheme before the hostname proper is MANDATORY. #
968 # The binddn and bindauth indicate the DN to bind to for searching, #
969 # and the password for the distinguished name. Some LDAP servers will #
970 # allow anonymous searching in which case these two values do not #
971 # need defining, otherwise they should be set similar to the examples #
974 # The searchscope value indicates the subtree to search under. On our #
975 # test system this is 'subtree'. Your mileage may vary. #
977 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
978 # LDAP authentication module: Adds the ability to authenticate users #
980 #<module name="m_ldapauth.so">
984 # <ldapauth dbid="ldapdb" #
985 # baserdn="ou=People,dc=brainbox,dc=cc" #
987 # allowpattern="Guest* Bot*" #
988 # killreason="Access denied" #
990 # host="$uid.$ou.inspircd.org"> #
992 # <ldapwhitelist cidr="10.42.0.0/16"> #
994 # <ldaprequire attribute="attr" value="val"> #
996 # The baserdn indicates the base DN to search in for users. Usually #
997 # this is 'ou=People,dc=yourdomain,dc=yourtld'. #
999 # The attribute value indicates the attribute which is used to locate #
1000 # a user account by name. On POSIX systems this is usually 'uid'. #
1002 # The allowpattern value allows you to specify a space separated list #
1003 # of wildcard masks which will always be allowed to connect #
1004 # regardless of if they have an account, for example guest and bot #
1007 # Killreason indicates the QUIT reason to give to users if they fail #
1008 # to authenticate. #
1010 # Setting the verbose value causes an oper notice to be sent out for #
1011 # every failed authentication to the server, with an error string. #
1013 # ldapwhitelist indicates that clients connecting from an IP in the #
1014 # provided CIDR do not need to authenticate against LDAP. It can be #
1015 # repeated to whitelist multiple CIDRs. #
1017 # ldaprequire allows further filtering on the LDAP user, by requiring #
1018 # certain LDAP attibutes to have a given value. It can be repeated, #
1019 # in which case the list will act as an OR list, that is, the #
1020 # authentication will succeed if any of the requirements in the list #
1023 # host allows you to change the displayed host of users connecting #
1024 # from ldap. The string supplied takes formatters which are replaced #
1025 # from the DN. For instance, if your DN looks like: #
1026 # uid=w00t,ou=people,dc=inspircd,dc=org, then the formatters uid, ou #
1027 # and dc will be available to you. If a key is given multiple times #
1028 # in the DN, the last appearance will take precedence. #
1030 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1031 # LDAP oper configuration module: Adds the ability to authenticate #
1033 #<module name="m_ldapoper.so">
1037 # <ldapoper dbid="ldapdb"
1038 # baserdn="ou=People,dc=brainbox,dc=cc"
1041 # Available configuration items are identical to the same items in #
1042 # m_ldapauth above (except for the verbose setting, that is only #
1043 # supported in m_ldapauth). #
1044 # Please always specify a password in your <oper> tags even if the #
1045 # opers are to be authenticated via LDAP, so in case this module is #
1046 # not loaded the oper accounts are still protected by a password. #
1048 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1049 # Lock server module: Adds /LOCKSERV and /UNLOCKSERV commands that #
1050 # are used to temporarily close/open the server for new connections. #
1051 # These commands require that the /LOCKSERV and /UNLOCKSERV commands #
1052 # are specified in a <class> tag that the oper is part of. This is so #
1053 # you can control who has access to this possible dangerous command. #
1054 # If your server is locked and you get disconnected, do a REHASH from #
1055 # shell to open up again. #
1056 # This module is oper-only.
1057 #<module name="m_lockserv.so">
1059 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1060 # Map hiding module: replaces /MAP and /LINKS output to users with a #
1061 # message to see a website, set by maphide="http://link.to/site" in #
1062 # the <security> tag, instead. #
1063 #<module name="m_maphide.so">
1065 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1066 # Message flood module: Adds message/notice flood protection via
1068 #<module name="m_messageflood.so">
1070 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1071 # MLOCK module: Adds support for server-side enforcement of services
1072 # side MLOCKs. Basically, this module suppresses any mode change that
1073 # would likely be immediately bounced by services.
1074 #<module name="m_mlock.so">
1076 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1077 # Modenotice module: Adds the /MODENOTICE command that allows opers to
1078 # send notices to all users having the given user mode(s) set.
1079 #<module name="m_modenotice.so">
1081 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1082 # MsSQL module: Allows other SQL modules to access MS SQL Server
1083 # through a unified API.
1084 # This module is in extras. Re-run configure with:
1085 # ./configure --enable-extras=m_mssql.cpp
1086 # and run make install, then uncomment this module to enable it.
1087 #<module name="m_mssql.so">
1089 #-#-#-#-#-#-#-#-#-#-#-#- SQL CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#-#
1091 # m_mssql.so is more complex than described here, see wiki for more #
1092 # info http://wiki.inspircd.org/Modules/mssql #
1094 #<database module="mssql" name="db" user="user" pass="pass" host="localhost" id="db1">
1096 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1097 # MySQL module: Allows other SQL modules to access MySQL databases
1098 # through a unified API.
1099 # This module is in extras. Re-run configure with:
1100 # ./configure --enable-extras=m_mysql.cpp
1101 # and run make install, then uncomment this module to enable it.
1102 #<module name="m_mysql.so">
1104 #-#-#-#-#-#-#-#-#-#-#-#- SQL CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#-#
1106 # m_mysql.so is more complex than described here, see the wiki for #
1107 # more: http://wiki.inspircd.org/Modules/mysql #
1109 #<database module="mysql" name="mydb" user="myuser" pass="mypass" host="localhost" id="my_database2">
1111 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1112 # Named modes module: Allows for the display and set/unset of channel
1113 # modes via long-form mode names via +Z and the /PROP command.
1114 # For example, to set a ban, do /mode #channel +Z ban=foo!bar@baz or
1115 # /PROP #channel ban=foo!bar@baz
1116 #<module name="m_namedmodes.so">
1118 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1119 # NAMESX module: Provides support for the NAMESX extension which allows
1120 # clients to see all the prefixes set on a user without getting confused.
1121 # This is supported by mIRC, x-chat, klient, and maybe more.
1122 #<module name="m_namesx.so">
1124 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1125 # National characters module:
1126 # 1) Allows using national characters in nicknames.
1127 # 2) Allows using custom (national) casemapping over the network.
1128 #<module name="m_nationalchars.so">
1130 # file - filename of existing file in "locales" directory
1131 # casemapping - custom value for 005 numeric (if you want it to be
1132 # different from the filename).
1133 #<nationalchars file="bynets/russian-w1251-charlink" casemapping="ru_RU.cp1251-charlink">
1135 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1136 # Nickchange flood protection module: Provides channel mode +F X:Y
1137 # which allows up to X nick changes in Y seconds.
1138 #<module name="m_nickflood.so">
1140 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1141 # Nicklock module: Let opers change a user's nick and then stop that
1142 # user from changing their nick again.
1143 # This module is oper-only.
1144 # To use, NICKLOCK and NICKUNLOCK must be in one of your oper class blocks.
1145 #<module name="m_nicklock.so">
1147 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1148 # No CTCP module: Adds the channel mode +C to block CTCPs and extban
1149 # 'C' to block CTCPs sent by specific users.
1150 #<module name="m_noctcp.so">
1152 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1153 # No kicks module: Adds the +Q channel mode and the Q: extban to deny
1154 # certain users from kicking.
1155 #<module name="m_nokicks.so">
1157 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1158 # No nicks module: Adds the +N channel mode, as well as the 'N' extban.
1159 # +N stops all users from changing their nick, the N extban stops
1160 # anyone from matching a +b N:nick!user@host mask from changing their
1162 #<module name="m_nonicks.so">
1164 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1165 # No part message module: Adds extban 'p' to block part messages from #
1167 #<module name="m_nopartmsg.so">
1169 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1170 # No notice module: Adds the channel mode +T and the extban 'T' to
1171 # block specific users from noticing the channel.
1172 #<module name="m_nonotice.so">
1174 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1175 # Network business join module:
1176 # Allows an oper to join a channel using /OJOIN, giving them +Y on the
1177 # channel which makes them immune to kick/deop/etc.
1178 #<module name="m_ojoin.so">
1180 # Specify the prefix that +Y will grant here.
1181 # Leave 'prefix' empty if you do not wish +Y to grant a prefix.
1182 # If 'notice' is set to on, upon /OJOIN, the server will notice the
1183 # channel saying that the oper is joining on network business.
1184 # If 'op' is set to on, it will give them +o along with +Y.
1185 #<ojoin prefix="!" notice="yes" op="yes">
1187 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1188 # Oper channels mode: Adds the +O channel mode and extban O:<mask>
1189 # to ban, except, etc. specific oper types. For example
1190 # /mode #channel +iI O:* is equivalent to channel mode +O, but you
1191 # may also set +iI O:AdminTypeOnly to only allow admins.
1192 # Modes +I and +e work in a similar fashion.
1193 #<module name="m_operchans.so">
1195 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1196 # Oper join module: Auto-joins opers to a channel upon oper-up.
1197 # This module is oper-only. For the user equivalent, see m_conn_join.
1198 #<module name="m_operjoin.so">
1200 #-#-#-#-#-#-#-#-#-#-# OPERJOIN CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
1202 # If you are using the m_operjoin.so module, specify options here: #
1204 # channel - The channel name to join, can also be a comma #
1205 # separated list e.g. "#channel1,#channel2". #
1207 # override - If on, lets the oper join walking thru any modes #
1208 # that might be set, even bans. #
1210 #<operjoin channel="#channel" override="no">
1212 # Alternatively you can use the autojoin="channellist" in a <type> #
1213 # tag to set specific autojoins for a type of oper, for example: #
1215 #<type name="Helper" autojoin="#help" classes="...">
1217 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1218 # Oper log module: Logs all oper commands to the server log (with log
1219 # type "m_operlog" at default loglevel), and optionally to the 'r'
1221 # This module is oper-only.
1222 #<module name="m_operlog.so">
1224 # If the following option is on then all oper commands will be sent to
1225 # the snomask 'r'. The default is off.
1226 #<operlog tosnomask="off">
1228 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1229 # Oper prefixing module: Gives server operators a prefix status
1230 # character on all channels they are in.
1231 #<module name="m_operprefix.so">
1233 # You may additionally customise the prefix character.
1234 #<operprefix prefix="!">
1236 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1237 # Oper MOTD module: Provides support for separate message of the day
1239 # This module is oper-only.
1240 #<module name="m_opermotd.so">
1242 #-#-#-#-#-#-#-#-#-#-# OPERMOTD CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
1244 # If you are using the m_opermotd.so module, specify the motd here. #
1246 # onoper - If on, the message is sent on /OPER, otherwise it's #
1247 # only sent when /OPERMOTD is used. #
1249 # processcolors - Allow color codes to be processed in the opermotd. #
1250 # Read the comment above <connect:allowmotdcolors> in #
1251 # inspircd.conf.example for details. #
1253 #<opermotd file="examples/opermotd.txt.example" onoper="yes" processcolors="false">
1255 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1256 # Override module: Adds support for oper override.
1257 # This module is oper-only.
1258 #<module name="m_override.so">
1260 #-#-#-#-#-#-#-#-#-#-# OVERRIDE CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
1262 # m_override.so is too complex it describe here, see the wiki: #
1263 # http://wiki.inspircd.org/Modules/override #
1265 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1266 # Oper levels module: Gives each oper a level and prevents actions
1267 # being taken by lower level opers against higher level opers.
1268 # Specify the level as the 'level' parameter of the <type> tag.
1269 # This module is oper-only.
1270 #<module name="m_operlevels.so">
1272 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1273 # Oper modes module: Allows you to specify modes to add/remove on oper.
1274 # Specify the modes as the 'modes' parameter of the <type> tag
1275 # and/or as the 'modes' parameter of the <oper> tag.
1276 # This module is oper-only. For the user equivalent, see m_conn_umodes.
1277 #<module name="m_opermodes.so">
1279 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1280 # Password forwarding module: Forwards a password users can send on
1281 # connect to the specified client below. The client is usually NickServ
1282 # and this module is usually used to authenticate users with NickServ
1283 # using their connect password.
1284 #<module name="m_passforward.so">
1287 # nick: nick to forward connect passwords to.
1290 # forwardmsg: Message to send to users using a connect password.
1291 # $nick will be the users' nick, $nickrequired will be the nick
1292 # of where the password is going (the nick above).
1293 # You can also use $user for the user ident string.
1294 forwardmsg="NOTICE $nick :*** Forwarding PASS to $nickrequired"
1296 # cmd: Command for the user to run when it receives a connect
1298 cmd="PRIVMSG $nickrequired :IDENTIFY $pass">
1300 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1301 # Password hash module: Allows hashed passwords to be used.
1302 # To be useful, a hashing module like m_sha256.so also needs to be loaded.
1303 #<module name="m_password_hash.so">
1305 #-#-#-#-#-#-#-#-#-# PASSWORD HASH CONFIGURATION #-#-#-#-#-#-#-#-#-#-#-#
1307 # To use this module, you must define a hash type for each oper's
1308 # password you want to hash. For example:
1310 # <oper name="Brain"
1311 # host="ident@dialup15.isp.com"
1313 # password="01ba4719c80b6fe911b091a7c05124b64eeece964e09c058ef8f9805daca546b"
1316 # Starting from 2.0, you can use a more secure salted hash that prevents simply
1317 # looking up the hash's value in a rainbow table built for the hash.
1318 # hash="hmac-sha256" password="lkS1Nbtp$CyLd/WPQXizsbxFUTqFRoMvaC+zhOULEeZaQkUJj+Gg"
1320 # Generate hashes using the /MKPASSWD command on the server.
1321 # Don't run it on a server you don't trust with your password.
1323 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1324 # Permanent channels module: Channels with the permanent channel mode
1325 # will remain open even after everyone else has left the channel, and
1326 # therefore keep things like modes, ban lists and topic. Permanent
1327 # channels -may- need support from your Services package to function
1328 # properly with them. This adds channel mode +P.
1329 # This module is oper-only.
1330 #<module name="m_permchannels.so">
1332 # If you like, m_permchannels can write a config file of permanent channels
1333 # whenever +P is set, unset, or the topic/modes on a +P channel is changed.
1334 # If you want to do this, set the filename below, and uncomment the include.
1336 # If 'listmodes' is true then all list modes (+b, +I, +e, +g...) will be
1337 # saved. Defaults to false.
1338 #<permchanneldb filename="permchannels.conf" listmodes="true">
1339 #<include file="permchannels.conf">
1341 # You may also create channels on startup by using the <permchannels> block.
1342 # Don't forget to set them +P in the modes, or they won't stay permanent.
1343 #<permchannels channel="#opers" modes="isP" topic="Opers only.">
1345 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1346 # PostgreSQL module: Allows other SQL modules to access PgSQL databases
1347 # through a unified API.
1348 # This module is in extras. Re-run configure with:
1349 # ./configure --enable-extras=m_pgsql.cpp
1350 # and run make install, then uncomment this module to enable it.
1351 #<module name="m_pgsql.so">
1353 #-#-#-#-#-#-#-#-#-#-#-#- SQL CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#-#
1355 # m_pgsql.so is more complex than described here, see the wiki for #
1356 # more: http://wiki.inspircd.org/Modules/pgsql #
1358 #<database module="pgsql" name="mydb" user="myuser" pass="mypass" host="localhost" id="my_database" ssl="no">
1360 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1361 # Muteban: Implements extended ban 'm', which stops anyone matching
1362 # a mask like +b m:nick!user@host from speaking on channel.
1363 #<module name="m_muteban.so">
1365 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1366 # Random quote module: Provides a random quote on connect.
1367 # NOTE: Some of these may mimic fatal errors and confuse users and
1368 # opers alike - BEWARE!
1369 #<module name="m_randquote.so">
1371 #-#-#-#-#-#-#-#-#-#- RANDOMQUOTES CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
1373 # Optional - If you specify to use the m_randquote.so module, then #
1374 # specify below the path to the quotes file. #
1376 #<randquote file="quotes.txt">
1378 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1379 # Redirect module: Adds channel redirection mode +L. #
1380 # Optional: <redirect:antiredirect> to add usermode +L to stop forced #
1381 # redirection and instead print an error. #
1383 # Note: You can not update this with a simple rehash, it requires #
1384 # reloading the module for it to take effect. #
1385 # This also breaks linking to servers that do not have the option. #
1386 # This defaults to false for the 2.0 version, it will be enabled in #
1387 # all the future versions. #
1388 #<module name="m_redirect.so">
1389 #<redirect antiredirect="true">
1391 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1392 # Regular expression provider for glob or wildcard (?/*) matching.
1393 # You must have at least 1 provider loaded to use m_filter or m_rline
1394 # modules. This module has no additional requirements, as it uses the
1395 # matching already present in InspIRCd core.
1396 #<module name="m_regex_glob.so">
1398 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1399 # Regular expression provider for PCRE (Perl-Compatible Regular
1400 # Expressions). You need libpcre installed to compile and load this
1401 # module. You must have at least 1 provider loaded to use m_filter or
1403 #<module name="m_regex_pcre.so">
1405 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1406 # Regular Expression Provider for RE2 Regular Expressions.
1407 # You need libre2 installed and in your include/library paths in order
1408 # to compile and load this module.
1409 #<module name="m_regex_re2.so">
1411 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1412 # Regular expression provider for POSIX regular expressions.
1413 # You shouldn't need any additional libraries on a POSIX-compatible
1414 # system (i.e.: any Linux, BSD, but not Windows). You must have at
1415 # least 1 provider loaded to use m_filter or m_rline.
1416 # On POSIX-compliant systems, regex syntax can be found by using the
1417 # command: 'man 7 regex'.
1418 #<module name="m_regex_posix.so">
1420 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1421 # Regular expression provider for C++11 std::regex regular expressions.
1422 # This module works on any fully compliant implementation of the C++11
1423 # std::regex container. Examples for such are Visual C++ 2010 and newer
1424 # but not libstdc++ (which GCC uses).
1425 # You should verify that std::regex is supported by your setup before
1426 # using this module, as it may compile normally but won't do anything
1427 # on some implementations.
1428 #<module name="m_regex_stdlib.so">
1430 # Specify the regular expression engine to use here. Valid settings are
1431 # bre, ere, awk, grep, egrep, ecmascript (default if not specified).
1432 #<stdregex type="ecmascript">
1434 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1435 # Regular expression provider for TRE regular expressions.
1436 # This is the same regular expression engine used by UnrealIRCd, so
1437 # if you are most familiar with the syntax of /spamfilter from there,
1438 # this is the provider you want. You need libtre installed in order
1439 # to compile and load this module.
1440 #<module name="m_regex_tre.so">
1442 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1443 # Registered users only channel creation module. If enabled, only
1444 # registered users and opers can create new channels.
1446 # You probably *DO NOT* want to load this module on a public network.
1448 #<module name="m_regonlycreate.so">
1450 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1451 # Remove module: Adds the /REMOVE command which is a peaceful
1452 # alternative to /KICK.
1453 #<module name="m_remove.so">
1455 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1456 # A module to block, kick or ban upon similiar messages being uttered several times.
1457 # Syntax [~*][lines]:[sec]{[:difference]}{[:matchlines]}
1458 # ~ is to block, * is to ban, default is kick.
1459 # lines - In mode 1 the amount of lines that has to match consecutively - In mode 2 the size of the backlog to keep for matching
1460 # seconds - How old the message has to be before it's invalidated.
1461 # distance - Edit distance, in percent, between two strings to trigger on.
1462 # matchlines - When set, the function goes into mode 2. In this mode the function will trigger if this many of the last <lines> matches.
1464 # As this module can be rather CPU-intensive, it comes with some options.
1465 # maxbacklog - Maximum size that can be specified for backlog. 0 disables multiline matching.
1466 # maxdistance - Max percentage of difference between two lines we'll allow to match. Set to 0 to disable edit-distance matching.
1467 # maxlines - Max lines of backlog to match against.
1468 # maxsecs - Maximum value of seconds a user can set. 0 to allow any.
1469 # size - Maximum number of characters to check for, can be used to truncate messages
1470 # before they are checked, resulting in less CPU usage. Increasing this beyond 512
1471 # doesn't have any effect, as the maximum length of a message on IRC cannot exceed that.
1472 #<repeat maxbacklog="20" maxlines="20" maxdistance="50" maxsecs="0" size="512">
1473 #<module name="m_repeat.so">
1475 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1476 # Restricted channels module: Allows only opers to create channels.
1478 # You probably *DO NOT* want to load this module on a public network.
1480 #<module name="m_restrictchans.so">
1482 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1483 # Restrict message module: Allows users to only message opers.
1485 # You probably *DO NOT* want to load this module on a public network.
1487 #<module name="m_restrictmsg.so">
1489 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1490 # R-Line module: Ban users through regular expression patterns.
1491 #<module name="m_rline.so">
1493 #-#-#-#-#-#-#-#-#-#-#-#- RLINE CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#-#
1495 # If you wish to re-check a user when they change nickname (can be
1496 # useful under some situations, but *can* also use CPU with more users
1497 # on a server) then set 'matchonnickchange' to yes.
1498 # Also, this is where you set what Regular Expression engine is to be
1499 # used. If you ever change it while running, all of your R-Lines will
1500 # be wiped. This is the regex engine used by all R-Lines set, and
1501 # m_regex_<engine>.so must be loaded, or rline will be non-functional
1502 # until you load it or change the engine to one that is loaded.
1504 #<rline matchonnickchange="yes" engine="pcre">
1506 # Generally, you will NOT want to use 'glob' here, as this turns
1507 # rline into just another gline. The exceptions are that rline will
1508 # always use the full "nick!user@host realname" string, rather than only
1509 # user@host, but beware that only the ? and * wildcards are available,
1510 # and are the only way to specify where the space can occur if you do
1511 # use glob. For this reason, is recommended to use a real regex engine
1512 # so that at least \s or [[:space:]] is available.
1514 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1515 # RMODE module: Adds the /RMODE command
1516 # Allows channel mods to remove list modes en masse.
1517 # Syntax: /rmode <channel> <mode> [pattern]
1518 # E.g. '/rmode #Channel b m:*' will remove all mute-extbans on the channel.
1519 #<module name="m_rmode.so">
1521 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1522 # SAJOIN module: Adds the /SAJOIN command which forcibly joins a user
1523 # to the given channel.
1524 # This module is oper-only.
1525 # To use, SAJOIN must be in one of your oper class blocks.
1526 # Opers need the users/sajoin-others priv to be able to /SAJOIN users
1527 # other than themselves.
1528 #<module name="m_sajoin.so">
1530 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1531 # SAKICK module: Adds the /SAKICK command which kicks a user from the
1533 # This module is oper-only.
1534 # To use, SAKICK must be in one of your oper class blocks.
1535 #<module name="m_sakick.so">
1537 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1538 # SAMODE module: Adds the /SAMODE command which allows server operators
1539 # to change modes on a channel without requiring them to have any
1540 # channel priviliges. Also allows changing user modes for any user.
1541 # This module is oper-only.
1542 # To use, SAMODE must be in one of your oper class blocks.
1543 #<module name="m_samode.so">
1545 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1546 # SANICK module: Adds the /SANICK command which allows opers to change
1548 # This module is oper-only.
1549 # To use, SANICK must be in one of your oper class blocks.
1550 #<module name="m_sanick.so">
1552 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1553 # SAPART module: Adds the /SAPART command which forcibly parts a user
1555 # This module is oper-only.
1556 # To use, SAPART must be in one of your oper class blocks.
1557 #<module name="m_sapart.so">
1559 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1560 # SAQUIT module: Adds the /SAQUIT command which forcibly quits a user.
1561 # This module is oper-only.
1562 # To use, SAQUIT must be in one of your oper class blocks.
1563 #<module name="m_saquit.so">
1565 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1566 # SATOPIC module: Adds the /SATOPIC command which allows changing the
1567 # topic on a channel without requiring any channel priviliges.
1568 # This module is oper-only.
1569 # To use, SATOPIC must be in one of your oper class blocks.
1570 #<module name="m_satopic.so">
1572 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1573 # SASL authentication module: Provides support for IRC Authentication
1574 # Layer via AUTHENTICATE. Note: You also need to have m_cap.so loaded
1576 #<module name="m_sasl.so">
1578 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1579 # Secure list module: Prevent /LIST in the first minute of connection,
1580 # crippling most spambots and trojan spreader bots.
1581 #<module name="m_securelist.so">
1583 #-#-#-#-#-#-#-#-#-# SECURELIST CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#-#
1585 # Securelist can be harmful to some IRC search engines such as #
1586 # netsplit.de and searchirc.com. To prevent securelist blocking these #
1587 # sites from listing, define exception tags as shown below: #
1588 #<securehost exception="*@*.searchirc.org">
1589 #<securehost exception="*@*.netsplit.de">
1590 #<securehost exception="*@echo940.server4you.de">
1591 #<securehost exception="*@*.ircdriven.com">
1593 # Define the following variable to change how long a user must wait #
1594 # before issuing a LIST. If not defined, defaults to 60 seconds. #
1596 #<securelist waittime="60"> #
1598 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1599 # Servprotect module: Provides support for Austhex style +k /
1600 # UnrealIRCD +S services mode.
1601 #<module name="m_servprotect.so">
1603 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1604 # See nicks module: Adds snomask +n and +N which show local and remote
1606 # This module is oper-only.
1607 #<module name="m_seenicks.so">
1609 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1610 # Set idle module: Adds a command for opers to change their idle time.
1611 # This module is oper-only.
1612 # To use, SETIDLE must be in one of your oper class blocks.
1613 #<module name="m_setidle.so">
1615 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1616 # Services support module: Adds several usermodes such as +R and +M.
1617 # This module implements the 'identified' state via account names,
1618 # and is similar in operation to the way asuka and ircu handle services.
1620 # At the same time, this offers +r for users and channels to mark them
1621 # as identified separately from the idea of a master account, which
1622 # can be useful for services which are heavily nick-as-account centric.
1624 # Also of note is that this module implements three extbans:
1625 # +b R: (stop matching account names from joining)
1626 # +b M: (stop matching account names from speaking)
1627 # +b U:n!u@h (blocks matching unregistered users)
1629 #<module name="m_services_account.so">
1631 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1632 # Sethost module: Adds the /SETHOST command.
1633 # This module is oper-only.
1634 # To use, SETHOST must be in one of your oper class blocks.
1635 # See m_chghost for how to customise valid chars for hostnames
1636 #<module name="m_sethost.so">
1638 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1639 # Setident module: Adds the /SETIDENT command.
1640 # This module is oper-only.
1641 # To use, SETIDENT must be in one of your oper class blocks.
1642 #<module name="m_setident.so">
1644 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1645 # SETNAME module: Adds the /SETNAME command.
1646 #<module name="m_setname.so">
1648 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1649 # Serverban: Implements extended ban 's', which stops anyone connected
1650 # to a server matching a mask like +b s:server.mask.here from joining.
1651 #<module name="m_serverban.so">
1653 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1654 # Showfile: Provides support for showing a text file to users when #
1655 # they enter a command. #
1656 # This module adds one command for each <showfile> tag that shows the #
1657 # given file to the user as a series of messages or numerics. #
1658 #<module name="m_showfile.so"> #
1660 #-#-#-#-#-#-#-#-#-#-# SHOWFILE CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#-#
1662 # name - The name of the command which displays this file. This is #
1663 # the only mandatory setting, all others are optional. #
1664 # file - The text file to be shown to the user. #
1665 # By default same as the command name. #
1666 # method - How should the file be shown? #
1667 # * numeric: Send contents using a numeric #
1668 # (similiar to /MOTD; the default). #
1669 # * notice: Send contents as a series of notices. #
1670 # * msg: Send contents as a series of private messages. #
1671 # colors - If true, color codes (\c, \b, \u, etc.) will be processed #
1672 # and sent as ANSI colors. If false (default) the file will #
1673 # be displayed as-is. #
1675 # When using the method "numeric", the following extra settings are #
1678 # introtext - Introductory line, "Showing <name>" by default. #
1679 # intronumeric - Numeric used for the introductory line. #
1680 # numeric - Numeric used for sending the text itself. #
1681 # endtext - Ending line, "End of <name>" by default. #
1682 # endnumeric - Numeric used for the ending line. #
1684 #<showfile name="RULES"
1687 # introtext="Server rules:"
1688 # endtext="End of server rules.">
1690 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1691 # Show whois module: Adds the +W usermode which allows opers to see
1692 # when they are /WHOIS'd.
1693 # This module is oper-only by default.
1694 #<module name="m_showwhois.so">
1696 # If you wish, you may also let users set this mode. Only opers with the
1697 # users/auspex priv will see real hosts of people, though.
1698 #<showwhois opersonly="yes"
1700 # You may also set whether or not users should receive whois notices,
1701 # should they be /WHOIS'd by an oper.
1702 #showfromopers="yes">
1704 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1705 # Shun module: Provides the /SHUN command, which stops a user from
1706 # executing all except configured commands.
1707 # This module is oper-only.
1708 # To use, SHUN must be in one of your oper class blocks.
1709 #<module name="m_shun.so">
1711 # You may also configure which commands you wish a user to be able to
1712 # perform when shunned. It should be noted that if a shunned user
1713 # issues QUIT or PART then their message will be removed, as if they
1714 # did not issue one.
1716 # You can optionally let the user know that their command was blocked.
1718 # You may also let SHUN affect opers (defaults to no).
1719 #<shun enabledcommands="PING PONG QUIT PART JOIN" notifyuser="yes" affectopers="no">
1721 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1722 # SSL channel mode module: Adds support for SSL-only channels via
1723 # channel mode +z and the 'z' extban which matches SSL client
1724 # certificate fingerprints.
1725 # Does not do anything useful without a working SSL module (see below).
1726 #<module name="m_sslmodes.so">
1728 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1729 # GnuTLS SSL module: Adds support for SSL connections using GnuTLS,
1730 # if enabled. You must answer 'yes' in ./configure when asked or
1731 # manually symlink the source for this module from the directory
1732 # src/modules/extra, if you want to enable this, or it will not load.
1733 #<module name="m_ssl_gnutls.so">
1735 #-#-#-#-#-#-#-#-#-#-#- GNUTLS CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#
1737 # m_ssl_gnutls.so is too complex to describe here, see the wiki: #
1738 # http://wiki.inspircd.org/Modules/ssl_gnutls #
1740 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1741 # SSL info module: Allows users to retrieve information about other
1742 # users' peer SSL certificates and keys. This can be used by client
1743 # scripts to validate users. For this to work, one of m_ssl_gnutls.so
1744 # or m_ssl_openssl.so must be loaded. This module also adds the
1745 # "* <user> is using a secure connection" whois line, the ability for
1746 # opers to use SSL fingerprints to verify their identity and the
1747 # ability to force opers to use SSL connections in order to oper up.
1748 # It is highly recommended to load this module if you use SSL on your
1750 # For how to use the oper features, please see the first example <oper> tag
1751 # in opers.conf.example.
1753 #<module name="m_sslinfo.so">
1755 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1756 # OpenSSL SSL module: Adds support for SSL connections using OpenSSL,
1757 # if enabled. You must answer 'yes' in ./configure when asked or symlink
1758 # the source for this module from the directory src/modules/extra, if
1759 # you want to enable this, or it will not load.
1760 #<module name="m_ssl_openssl.so">
1762 #-#-#-#-#-#-#-#-#-#-#- OPENSSL CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#
1764 # m_ssl_openssl.so is too complex to describe here, see the wiki: #
1765 # http://wiki.inspircd.org/Modules/ssl_openssl #
1767 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1768 # Strip color module: Adds channel mode +S that strips mIRC color
1769 # codes from all messages sent to the channel.
1770 #<module name="m_stripcolor.so">
1772 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1773 # Silence module: Adds support for the /SILENCE command, which allows
1774 # users to have a server-side ignore list for their client.
1775 #<module name="m_silence.so">
1777 # Set the maximum number of entries allowed on a user's silence list.
1778 #<silence maxentries="32">
1780 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1781 # SQLite3 module: Allows other SQL modules to access SQLite3 #
1782 # databases through a unified API. #
1783 # This module is in extras. Re-run configure with: #
1784 # ./configure --enable-extras=m_sqlite.cpp
1785 # and run make install, then uncomment this module to enable it. #
1787 #<module name="m_sqlite3.so">
1789 #-#-#-#-#-#-#-#-#-#-#-#- SQL CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#-#
1791 # m_sqlite.so is more complex than described here, see the wiki for #
1792 # more: http://wiki.inspircd.org/Modules/sqlite3 #
1794 #<database module="sqlite" hostname="/full/path/to/database.db" id="anytext">
1796 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1797 # SQL authentication module: Allows IRCd connections to be tied into
1798 # a database table (for example a forum).
1799 # This module is in extras. Re-run configure with:
1800 # ./configure --enable-extras=m_sqlauth.cpp
1801 # and run make install, then uncomment this module to enable it.
1803 #<module name="m_sqlauth.so">
1805 #-#-#-#-#-#-#-#-#-#-#- SQLAUTH CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#
1807 # m_sqlauth.so is too complex to describe here, see the wiki: #
1808 # http://wiki.inspircd.org/Modules/sqlauth #
1810 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1811 # SQL oper module: Allows you to store oper credentials in an SQL table
1812 # This module is in extras. Re-run configure with:
1813 # ./configure --enable-extras=m_sqloper.cpp
1814 # and run make install, then uncomment this module to enable it.
1816 #<module name="m_sqloper.so">
1818 #-#-#-#-#-#-#-#-#-#-#- SQLOPER CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#
1820 # dbid - Database ID to use (see SQL modules). #
1821 # hash - Hashing provider to use for password hashing. #
1823 # See also: http://wiki.inspircd.org/Modules/sqloper #
1825 #<sqloper dbid="1" hash="md5">
1827 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1828 # StartTLS module: Implements STARTTLS, which allows clients #
1829 # connected to non SSL enabled ports to enable SSL, if a proper SSL #
1830 # module is loaded (either m_ssl_gnutls or m_ssl_openssl). #
1831 #<module name="m_starttls.so">
1833 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1834 # SVSHold module: Implements SVSHOLD. Like Q:Lines, but can only be #
1835 # added/removed by Services. #
1836 #<module name="m_svshold.so">
1837 # SVSHOLD does not generate server notices by default, you can turn
1838 # notices on by uncommenting the next line.
1839 #<svshold silent="false">
1841 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1842 # SWHOIS module: Allows you to add arbitrary lines to user WHOIS.
1843 # This module is oper-only.
1844 # To use, SWHOIS must be in one of your oper class blocks.
1845 #<module name="m_swhois.so">
1847 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1848 # Test module: Enable this to create a command useful in testing
1849 # flood control. To avoid accidental use on live networks, the server
1850 # name must contain ".test" to load the module
1851 #<module name="m_testnet.so">
1853 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1854 # Timed bans module: Adds timed channel bans with the /TBAN command.
1855 #<module name="m_timedbans.so">
1857 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1858 # Test line module: Adds the /TLINE command, used to test how many
1859 # users a /GLINE or /ZLINE etc. would match.
1860 # This module is oper-only.
1861 # To use, TLINE must be in one of your oper class blocks.
1862 #<module name="m_tline.so">
1864 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1865 # Topiclock module: implements server-side topic locking to achieve deeper
1866 # integration with services packages.
1867 #<module name="m_topiclock.so">
1869 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1870 # UHNAMES support module: Adds support for the IRCX style UHNAMES
1871 # extension, which displays ident and hostname in the names list for
1872 # each user, saving clients from doing a WHO on the channel.
1873 # If a client does not support UHNAMES it will not enable it, this will
1874 # not break incompatible clients.
1875 #<module name="m_uhnames.so">
1877 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1878 # Uninvite module: Adds the /UNINVITE command which lets users remove
1879 # pending invites from channels without waiting for the user to join.
1880 #<module name="m_uninvite.so">
1882 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1883 # Userip module: Adds the /USERIP command.
1884 # Allows users to query their own IP, also allows opers to query the IP
1886 #<module name="m_userip.so">
1888 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1889 # Vhost module: Adds the VHOST command which allows for adding virtual
1890 # hosts which are accessible using a username and password in the config.
1891 #<module name="m_vhost.so">
1893 #-#-#-#-#-#-#-#-#-#-#- VHOST CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#-#
1895 # user - Username for the vhost. #
1897 # pass - Password for the vhost. #
1899 # hash - The hash for the specific user (optional) #
1900 # m_password_hash.so and a hashing module must be loaded #
1901 # for this to work. #
1903 # host - Vhost to set. #
1905 #<vhost user="some_username" pass="some_password" host="some.host">
1906 #<vhost user="foo" password="fcde2b2edba56bf408601fb721fe9b5c338d10ee429ea04fae5511b68fbf8fb9" hash="sha256" host="some.other.host">
1908 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1909 # Watch module: Adds the WATCH command, which is used by clients to
1910 # maintain notify lists.
1911 #<module name="m_watch.so">
1913 # Set the maximum number of entries on a user's watch list below.
1914 #<watch maxentries="32">
1916 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1917 # XLine database: Stores all *Lines (G/Z/K/R/any added by other modules)
1918 # in a file which is re-loaded on restart. This is useful
1919 # for two reasons: it keeps bans so users may not evade them, and on
1920 # bigger networks, server connections will take less time as there will
1921 # be a lot less bans to apply - as most of them will already be there.
1922 #<module name="m_xline_db.so">
1924 # Specify the filename for the xline database here.
1925 #<xlinedb filename="data/xline.db">
1927 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1928 # ____ _ _____ _ _ ____ _ _ _ #
1929 # | _ \ ___ __ _ __| | |_ _| |__ (_)___ | __ )(_) |_| | #
1930 # | |_) / _ \/ _` |/ _` | | | | '_ \| / __| | _ \| | __| | #
1931 # | _ < __/ (_| | (_| | | | | | | | \__ \ | |_) | | |_|_| #
1932 # |_| \_\___|\__,_|\__,_| |_| |_| |_|_|___/ |____/|_|\__(_) #
1934 # To link servers to InspIRCd, you MUST load the m_spanningtree #
1935 # module. If you don't do this, server links will NOT work at all. #
1936 # This is by design, to allow for the implementation of other linking #
1937 # protocols in modules in the future. #
1939 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1940 # Spanning tree module: Allows linking of servers using the spanning
1941 # tree protocol (see the READ THIS BIT section above).
1942 # You will almost always want to load this.
1944 #<module name="m_spanningtree.so">
projects / user / henk / code / inspircd.git / blob