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 spanningtree module. #
23 # 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. This module is at the bottom of #
29 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
30 # MD5 module: Allows other modules to generate MD5 hashes, usually for
31 # cryptographic uses and security.
34 # Other modules such as cloaking and password_hash may rely on
35 # this module being loaded to function.
39 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
40 # SHA256 module: Allows other modules to generate SHA256 hashes,
41 # usually for cryptographic uses and security.
44 # Other modules such as password_hash may rely on this module being
45 # loaded to function. Certain modules such as spanningtree will
46 # function without this module but when it is loaded their features will
47 # be enhanced (for example the addition of HMAC authentication).
49 #<module name="sha256">
50 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
51 # RIPEMD160 module: Allows other modules to generate RIPEMD160 hashes,
52 # usually for cryptographic uses and security.
55 # Other modules may rely on this module being loaded to function.
56 #<module name="ripemd160">
58 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
59 # Abbreviation module: Provides the ability to abbreviate commands a-la
61 #<module name="abbreviation">
63 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
64 # Alias module: Allows you to define server-side command aliases.
65 #<module name="alias">
67 # Set the 'prefix' for in-channel aliases (fantasy commands) to the
68 # specified character. If not set, the default is "!".
69 # If 'allowbots' is disabled, +B clients will not be able to use
70 # fantasy commands. If not set, the default is no.
71 #<fantasy prefix="!" allowbots="no">
73 #-#-#-#-#-#-#-#-#-#-#- ALIAS DEFINITIONS -#-#-#-#-#-#-#-#-#-#-#-#-#-#
75 # If you have the alias module loaded, you may also define aliases as #
76 # shown below. They are commonly used to provide shortcut commands to #
77 # services, however they are not limited to just this use. #
78 # An alias tag requires the following values to be defined in it: #
80 # text - The text to detect as the actual command line. #
81 # Can't contain spaces, but case insensitive. #
82 # You may have multiple aliases with the same #
83 # command name (text="" value), however the first #
84 # found will be executed if its format value is #
85 # matched, or it has no format value. Aliases are #
86 # read from the top of the file to the bottom. #
88 # usercommand - If this is true, the alias can be run simply as #
89 # /aliasname. Defaults to true. #
91 # channelcommand - If this is true, the alias can be used as an #
92 # in-channel alias or 'fantasy command', prefixed #
93 # by the fantasy prefix character, !aliasname by #
94 # default. Defaults to false. #
96 # format - If this is defined, the parameters of the alias #
97 # must match this glob pattern. For example if you #
98 # want the first parameter to start with a # for #
99 # the alias to be executed, set format="#*" in the #
100 # alias definition. Note that the :'s which are #
101 # part of IRC formatted lines will be preserved #
102 # for matching of this text. This value is #
105 # replace - The text to replace 'text' with. Usually this #
106 # will be "PRIVMSG ServiceName :$2-" or similar. #
107 # You may use the variables $1 through $9 in the #
108 # replace string, which refer to the first through #
109 # ninth word in the original string typed by the #
110 # user. You may also use $1- through $9- which #
111 # refer to the first word onwards, through to the #
112 # ninth word onwards, e.g. if the user types the #
113 # command "foo bar baz qux quz" then $3- will hold #
114 # "baz qux quz" and $2 will contain "bar". You may #
115 # also use the special variables: $nick, $ident, #
116 # $host and $vhost, and you may separate multiple #
117 # commands with a newline (which can be written in #
118 # the file literally, or encoded as &nl; or \n #
119 # depending on the config format setting). #
121 # requires - If you provide a value for 'requires' this means #
122 # the given nickname MUST be online for the alias #
123 # to successfully trigger. If they are not, then #
124 # the user receives a 'no such nick' 401 numeric. #
126 # uline - Setting this to true will ensure that the user #
127 # given in 'requires' is also on a u-lined server, #
128 # as well as actually being on the network. If the #
129 # user is online, but not on a u-lined server, #
130 # then an oper alert is sent out as this is #
131 # possibly a sign of a user trying to impersonate #
134 # operonly - If true, this will make the alias oper only. #
135 # If a non-oper attempts to use the alias, it will #
136 # appear to not exist. #
139 # An example of using the format value to create an alias with two
140 # different behaviours depending on the format of the parameters.
142 #<alias text="ID" format="#*" replace="PRIVMSG ChanServ :IDENTIFY $2 $3"
143 # requires="ChanServ" uline="yes">
145 #<alias text="ID" replace="PRIVMSG NickServ :IDENTIFY $2"
146 # requires="NickServ" uline="yes">
148 # This alias fixes a glitch in xchat 2.6.x and above and the way it
149 # assumes IDENTIFY must be prefixed by a colon (:) character. It should
150 # be placed ABOVE the default NICKSERV alias.
152 #<alias text="NICKSERV" format=":IDENTIFY *" replace="PRIVMSG NickServ :IDENTIFY $3-"
153 # requires="NickServ" uline="yes">
155 # You may also add aliases to trigger based on something said in a
156 # channel, aka 'fantasy' commands, configured in the same manner as any
157 # other alias, with usercommand="no" and channelcommand="yes" The
158 # command must be preceded by the fantasy prefix when used.
160 #<alias text="CS" usercommand="no" channelcommand="yes"
161 # replace="PRIVMSG ChanServ :$1 $chan $2-" requires="ChanServ" uline="yes">
163 # This would be used as "!cs <command> <options>", with the channel
164 # being automatically inserted after the command in the message to
165 # ChanServ, assuming the fantasy prefix is "!".
167 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
168 # Allowinvite module: Gives channel mode +A to allow all users to use
169 # /INVITE, and extban A to deny invite from specific masks.
170 #<module name="allowinvite">
172 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
173 # Alltime module: Shows time on all connected servers at once.
174 # This module is oper-only and provides /ALLTIME.
175 # To use, ALLTIME must be in one of your oper class blocks.
176 #<module name="alltime">
178 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
179 # Auditorium module: Adds channel mode +u which makes everyone else
180 # except you in the channel invisible, used for large meetings etc.
181 #<module name="auditorium">
183 # Auditorium settings:
185 #<auditorium opvisible="no" opcansee="no" opercansee="yes">
187 # opvisible (auditorium-vis in exemptchanops):
188 # Show channel ops to all users
189 # opcansee (auditorium-see in exemptchanops):
190 # Allow ops to see all joins/parts/kicks in the channel
192 # Allow opers (channels/auspex) to see see all joins/parts/kicks in the channel
194 # Exemptchanops can be used to adjust the level at which users become visible or
195 # the level at which they can see the full member list of the channel.
197 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
198 # Autoop module: Adds basic channel access controls via the +w listmode.
199 # For example +w o:*!Attila@127.0.0.1 will op anyone matching that mask
200 # on join. This can be combined with extbans, for example +w o:R:Brain
201 # will op anyone identified to the account "Brain".
202 # Another useful combination is with SSL client certificate
203 # fingerprints: +w h:z:72db600734bb9546c1bdd02377bc21d2a9690d48 will
204 # give halfop to the user(s) having the given certificate.
205 #<module name="autoop">
207 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
208 # Ban except module: Adds support for channel ban exceptions (+e).
209 #<module name="banexception">
211 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
212 # Ban redirection module: Allows bans which redirect to a specified
213 # channel. e.g. +b nick!ident@host#channelbanneduserissentto
214 #<module name="banredirect">
216 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
217 # bcrypt module: Allows other modules to generate bcrypt hashes,
218 # usually for cryptographic uses and security.
219 #<module name="bcrypt">
221 # rounds: Defines how many rounds the bcrypt function will run when
222 # generating new hashes.
223 #<bcrypt rounds="10">
225 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
226 # Block amsg module: Attempt to block all usage of /amsg and /ame.
227 #<module name="blockamsg">
229 #-#-#-#-#-#-#-#-#-#-#- BLOCKAMSG CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
231 # If you have the blockamsg module loaded, you can configure it with #
232 # the <blockamsg> tag: #
234 # delay - How much time between two messages to force them #
235 # to be recognised as unrelated. #
236 # action - Any of 'notice', 'noticeopers', 'silent', 'kill' #
237 # or 'killopers'. Define how to take action when #
238 # a user uses /amsg or /ame. #
240 #<blockamsg delay="3" action="killopers">
242 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
243 # Block CAPS module: Adds channel mode +B, blocks all-CAPS messages.
244 #<module name="blockcaps">
246 #-#-#-#-#-#-#-#-#-#-#- BLOCKCAPS CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
248 # percent - What percentage of the text must be caps before #
249 # text will be blocked. #
251 # minlen - The minimum length a line must be for the block #
252 # percent to have any effect. #
254 # capsmap - A list of chars to be considered CAPS. Can be used #
255 # to add CAPS characters for your language. Also you #
256 # can add things like ! and space to further lock #
257 # down on caps usage. #
258 #<blockcaps percent="50"
260 # capsmap="ABCDEFGHIJKLMNOPQRSTUVWXYZ! ">
262 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
263 # Block color module: Blocking color-coded messages with chan mode +c.
264 #<module name="blockcolor">
266 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
267 # Botmode module: Adds the user mode +B. If set on a user, it will
268 # show that the user is a bot in /WHOIS.
269 #<module name="botmode">
271 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
272 # CallerID module: Adds usermode +g which activates hybrid-style
273 # callerid: block all private messages unless you /ACCEPT first.
274 #<module name="callerid">
276 #-#-#-#-#-#-#-#-#-#-#- CALLERID CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#
277 # maxaccepts - Maximum number of entries a user can add to his #
278 # /ACCEPT list. Default is 16 entries. #
279 # operoverride - Can opers (note: ALL opers) override callerid? #
281 # tracknick - Preserve /accept entries when a user changes nick? #
282 # If no (the default), the user is removed from #
283 # everyone's accept list if he changes nickname. #
284 # cooldown - Amount of time that must pass since the last #
285 # notification sent to a user before he can be sent #
286 # another. Default is 1 minute. #
287 #<callerid maxaccepts="16"
292 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
293 # CAP module: Provides the CAP negotiation mechanism required by the
294 # sasl, namesx, uhnames, and ircv3 modules.
295 # It is also recommended for STARTTLS support in the starttls module.
298 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
299 # CBAN module: Lets you disallow channels from being used at runtime.
300 # This module is oper-only and provides /CBAN.
301 # To use, CBAN must be in one of your oper class blocks.
302 #<module name="cban">
304 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
305 # Censor module: Adds channel and user mode +G.
306 #<module name="censor">
308 #-#-#-#-#-#-#-#-#-#-#- CENSOR CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#
310 # Optional - If you specify to use the censor module, then you must #
311 # specify some censor tags. See also: #
312 # http://wiki.inspircd.org/Modules/censor #
314 #<include file="examples/censor.conf.example">
316 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
317 # CGI:IRC module: Adds support for automatic host changing in CGI:IRC
318 # (http://cgiirc.sourceforge.net).
319 # Adds snomask +w for monitoring CGI:IRC connections.
320 #<module name="cgiirc">
322 #-#-#-#-#-#-#-#-#-#-#-# CGIIRC CONFIGURATION #-#-#-#-#-#-#-#-#-#-#-#-#
324 # Optional - If you specify to use cgiirc, then you must specify one
325 # or more cgihost tags which indicate authorised CGI:IRC servers which
326 # will be connecting to your network, and an optional cgiirc tag.
327 # For more information see: http://wiki.inspircd.org/Modules/cgiirc
329 # Set to yes if you want to notice opers when CGI:IRC clients connect.
330 # <cgiirc opernotice="no">
332 # The type field indicates where the module should get the real
333 # client's IP address from, for further information, please see the
334 # CGI:IRC documentation.
337 # <cgihost type="ident" mask="otherbox.example.com"> # Get IP from ident
339 # <cgihost type="webirc" password="foobar"
340 # mask="somebox.example.com"> # Get IP from WEBIRC
345 # When you connect CGI:IRC clients, there are two connect classes which
346 # apply to these clients. When the client initially connects, the connect
347 # class which matches the CGI:IRC site's host is checked. Therefore you
348 # must raise the maximum local/global clients for this ip as high as you
349 # want to allow cgi clients. After the client has connected and is
350 # determined to be a cgi:irc client, the class which matches the client's
351 # real IP is then checked. You may set this class to a lower value, so that
352 # the real IP of the client can still be restricted to, for example, 3
355 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
356 # Channel create module: Adds snomask +j, which will notify opers of
357 # any new channels that are created.
358 # This module is oper-only.
359 #<module name="chancreate">
361 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
362 # Channel filter module: Allows channel-op defined message filtering
363 # using simple string matches (channel mode +g).
364 #<module name="chanfilter">
366 # If hidemask is set to yes, the user will not be shown the mask when
367 # his/her message is blocked.
368 #<chanfilter hidemask="yes">
370 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
371 # Channel history module: Displays the last 'X' lines of chat to a user
372 # joining a channel with +H 'X:T' set; 'T' is the maximum time to keep
373 # lines in the history buffer. Designed so that the new user knows what
374 # the current topic of conversation is when joining the channel.
375 #<module name="chanhistory">
377 # Set the maximum number of lines allowed to be stored per channel below.
378 # This is the hard limit for 'X'.
379 # If notice is set to yes, joining users will get a NOTICE before playback
380 # telling them about the following lines being the pre-join history.
381 # If bots is set to yes, it will also send to users marked with +B
382 #<chanhistory maxlines="20" notice="yes" bots="yes">
384 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
385 # Channel logging module: Used to send snotice output to channels, to
386 # allow staff to centrally monitor and discuss network activity.
388 # The "channel" field is where you want the messages to go, "snomasks"
389 # is what snomasks you want to be sent to that channel. Multiple tags
391 #<module name="chanlog">
392 #<chanlog snomasks="AOcC" channel="#opers">
394 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
395 # Channel names module: Allows disabling channels which have certain
396 # characters in the channel name such as bold, colorcodes, etc. which
397 # can be quite annoying and allow users to on occasion have a channel
398 # that looks like the name of another channel on the network.
399 #<module name="channames">
402 # denyrange: characters or range of characters to deny in channel
406 # allowrange: characters or range of characters to specifically allow
410 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
411 # Channelban: Implements extended ban j:, which stops anyone already
412 # in a channel matching a ban like +b j:#channel*mask from joining.
413 # Note that by default wildcard characters * and ? are allowed in
414 # channel names. To disallow them, load m_channames and add characters
415 # 42 and 63 to denyrange (see above).
416 #<module name="channelban">
418 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
419 # Check module: Adds the /CHECK command.
420 # Check is useful for looking up information on channels, users,
421 # IP addresses and hosts.
422 # This module is oper-only.
423 # To use, CHECK must be in one of your oper class blocks.
424 #<module name="check">
426 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
427 # CHGHOST module: Adds the /CHGHOST command.
428 # This module is oper-only.
429 # To use, CHGHOST must be in one of your oper class blocks.
430 # NOTE: Services will not be able to set vhosts on users if this module
431 # isn't loaded. If you're planning on running services, you probably
433 #<module name="chghost">
435 #-#-#-#-#-#-#-#-# /CHGHOST - /SETHOST CONFIGURATION #-#-#-#-#-#-#-#-#
436 # Optional - If you want to use special chars for hostnames you can #
437 # specify your own custom list of chars with the <hostname> tag: #
439 # charmap - A list of chars accepted as valid by the /CHGHOST #
440 # and /SETHOST commands. Also note that the list is #
442 #<hostname charmap="abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ.-_/0123456789">
444 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
445 # CHGIDENT module: Adds the /CHGIDENT command.
446 # This module is oper-only.
447 # To use, CHGIDENT must be in one of your oper class blocks.
448 #<module name="chgident">
450 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
451 # CHGNAME module: Adds the /CHGNAME command.
452 # This module is oper-only.
453 # To use, CHGNAME must be in one of your oper class blocks.
454 #<module name="chgname">
456 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
457 # Connection class ban module: Adds support for extban 'n' which
458 # matches against the class name of the user's connection.
459 # This module assumes that connection classes are named in a uniform
460 # way on all servers of the network.
461 #<module name="classban">
463 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
464 # Clear chan module: Allows opers to masskick, masskill or mass-G/ZLine
465 # all users on a channel using /CLEARCHAN.
466 #<module name="clearchan">
468 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
469 # Cloaking module: Adds usermode +x and cloaking support.
470 # Relies on the md5 module being loaded.
471 # To cloak users when they connect, load the conn_umodes module and set
472 # <connect:modes> to include the +x mode. The example <connect> tag
473 # shows this. See the conn_umodes module for more information.
474 #<module name="cloaking">
476 #-#-#-#-#-#-#-#-#-#-#- CLOAKING CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#
478 # To use cloaking, you must define a cloak key, and optionally a #
479 # cloak prefix as shown below. The cloak key must be shared across #
480 # the network for correct cloaking. #
482 # There are two methods of cloaking: #
484 # half Cloak only the "unique" portion of a host; show #
485 # the last 2 parts of the domain, /16 subnet of IPv4 #
486 # or /48 subnet of the IPv6 address. #
488 # full Cloak the users completely, using three slices for #
489 # common CIDR bans (IPv4: /16, /24; IPv6: /48, /64). #
491 # The methods use a single key that can be any length of text. #
492 # An optional prefix may be specified to mark cloaked hosts. #
493 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
499 #-#-#-#-#-#-#-#-#-#-#-#- CLOSE MODULE #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
500 # Close module: Allows an oper to close all unregistered connections.
501 # This module is oper-only and provides the /CLOSE command.
502 # To use, CLOSE must be in one of your oper class blocks.
503 #<module name="close">
505 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
506 # Clones module: Adds an oper command /CLONES for detecting cloned
507 # users. Warning: This command may be resource intensive when it is
508 # issued, use with care.
509 # This module is oper-only.
510 # To use, CLONES must be in one of your oper class blocks.
511 #<module name="clones">
513 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
514 # Common channels module: Adds user mode +c, which, when set, requires
515 # that users must share a common channel with you to PRIVMSG or NOTICE
517 #<module name="commonchans">
519 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
520 # Auto join on connect module: Allows you to force users to join one
521 # or more channels automatically upon connecting to the server, or
522 # join them in case they aren't on any channels after being online
524 #<module name="conn_join">
526 #-#-#-#-#-#-#-#-#-#-#-#- CONNJOIN CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
528 # If you have the conn_join module loaded, you can configure it below
529 # or set autojoin="#chat,#help" in <connect> blocks.
531 # Join users immediately after connection to #one #two and #three.
532 #<autojoin channel="#one,#two,#three">
533 # Join users to #chat after 15 seconds if they aren't on any channels.
534 #<autojoin channel="#chat" delay="15">
536 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
537 # Set modes on connect module: When this module is loaded <connect>
538 # blocks may have an optional modes="" value, which contains modes to
539 # add or remove from users when they connect to the server.
540 #<module name="conn_umodes">
542 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
543 # Wait for PONG on connect module: Send a PING to all connecting users
544 # and don't let them connect until they reply with a PONG.
545 # This is useful to stop certain kinds of bots and proxies.
546 #<module name="conn_waitpong">
548 #-#-#-#-#-#-#-#-#-#-#- WAITPONG CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
550 # If you have the conn_waitpong module loaded, configure it with the #
553 # sendsnotice - Whether to send a helpful notice to users on #
554 # connect telling them how to connect, should #
555 # their client not reply PONG automatically. #
557 # killonbadreply - Whether to kill the user if they send the wrong #
560 #<waitpong sendsnotice="yes" killonbadreply="yes">
562 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
563 # Channel cycle module: Adds the /CYCLE command which is a server-side
564 # /HOP that bypasses restrictive modes.
565 #<module name="cycle">
567 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
568 # Connectban: Provides IP connection throttling. Any IP range that
569 # connects too many times (configurable) in an hour is Z-Lined for a
570 # (configurable) duration, and their count resets to 0.
571 #<module name="connectban">
573 # ipv4cidr and ipv6cidr allow you to turn the comparison from
574 # individual IP addresses (32 and 128 bits) into CIDR masks, to allow
575 # for throttling over whole ISPs/blocks of IPs, which may be needed to
578 # This allows for 10 connections in an hour with a 10 minute ban if
580 #<connectban threshold="10" duration="10m" ipv4cidr="32" ipv6cidr="128"
581 # A custom ban message may optionally be specified.
582 # 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.">
584 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
585 # Connection throttle module.
586 #<module name="connflood">
588 #-#-#-#-#-#-#-#-#-#-#- CONNTHROTTLE CONFIGURATION -#-#-#-#-#-#-#-#-#-#
589 # period, maxconns - Amount of connections per <period>.
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 in seconds to wait before enforcing
599 # the throttling when the server just booted.
601 #<connflood seconds="30" maxconns="3" timeout="30"
602 # quitmsg="Throttled" bootwait="10">
604 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
605 # Custom prefixes: Allows for channel prefixes to be added.
606 #<module name="customprefix">
608 # name The name of the mode, must be unique from other modes.
609 # letter The letter used for this mode. Required.
610 # prefix The prefix used for nicks with this mode. Not required.
611 # rank A numeric rank for this prefix, defining what permissions it gives.
612 # The rank of voice, halfop and op is 10000, 20000, and 30000,
614 # ranktoset The numeric rank required to set/unset this mode. Defaults to rank.
615 # depriv Can you remove the mode from yourself? Defaults to yes.
616 #<customprefix name="founder" letter="q" prefix="~" rank="50000" ranktoset="50000">
617 #<customprefix name="admin" letter="a" prefix="&" rank="40000" ranktoset="50000">
618 #<customprefix name="halfop" letter="h" prefix="%" rank="20000" ranktoset="30000">
619 #<customprefix name="halfvoice" letter="V" prefix="-" rank="1" ranktoset="20000">
621 # Do /RELOADMODULE customprefix after changing the settings of this module.
623 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
624 # Custom title module: Adds the /TITLE command which allows for trusted
625 # users to gain a custom whois line and an optional vhost can be
627 #<module name="customtitle">
629 #-#-#-#-#-#-#-#-#-#- CUSTOM TITLE CONFIGURATION -#-#-#-#-#-#-#-#-#-#
630 # name - The username used to identify.
631 # password - The password used to identify.
632 # hash - The hash for the specific user's password (optional).
633 # password_hash and a hashing module must be loaded
635 # host - Allowed hostmask (optional).
636 # title - Title shown in whois.
637 # vhost - Displayed host (optional).
639 #<title name="foo" password="bar" title="Official Chat Helper">
640 #<title name="bar" password="foo" host="ident@test.org" title="Official Chat Helper" vhost="helper.test.org">
641 #<title name="foo" password="$2a$10$UYZ4OcO8NNTCCGyCdY9SK.2GHiqGgxZfHFPOPmWuxEVWVQTtoDC7C" hash="bcrypt" title="Official Chat Helper">
643 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
644 # DCCALLOW module: Adds the /DCCALLOW command.
645 #<module name="dccallow">
647 #-#-#-#-#-#-#-#-#-#-#- DCCALLOW CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
648 # blockchat - Whether to block DCC CHAT as well as DCC SEND.
649 # length - Default duration of entries in DCCALLOW list.
650 # action - Default action to take if no action is
651 # specified, can be 'block' or 'allow'.
652 # maxentries - Max number of nicks to allow on a DCCALLOW list.
654 # File configuration:
655 # pattern - The glob pattern to match against.
656 # action - Action to take if a user attempts to send a file
657 # that matches this pattern, can be 'block' or
660 #<dccallow blockchat="yes" length="5m" action="block" maxentries="20">
661 #<banfile pattern="*.exe" action="block">
662 #<banfile pattern="*.txt" action="allow">
664 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
665 # Deaf module: Adds support for the usermode +d - deaf to channel
666 # messages and channel notices.
667 #<module name="deaf">
669 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
670 # Delay join module: Adds the channel mode +D which delays all JOIN
671 # messages from users until they speak. If they quit or part before
672 # speaking, their quit or part message will not be shown to the channel
673 # which helps cut down noise on large channels in a more friendly way
674 # than the auditorium mode. Only channel ops may set the +D mode.
675 #<module name="delayjoin">
677 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
678 # Delay message module: Adds the channel mode +d which disallows a user
679 # from talking in the channel unless they've been joined for X seconds.
680 # Settable using /MODE #chan +d 30
681 #<module name="delaymsg">
682 # Set allownotice to no to disallow NOTICEs too. Defaults to yes.
683 #<delaymsg allownotice="no">
685 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
686 # Deny channels module: Deny channels from being used by users.
687 #<module name="denychans">
689 #-#-#-#-#-#-#-#-#-#-#- DENYCHAN DEFINITIONS -#-#-#-#-#-#-#-#-#-#-#-#
691 # If you have the denychans module loaded, you need to specify the #
692 # channels to deny: #
694 # name - The channel name to deny (glob masks are ok). #
695 # allowopers - If operators are allowed to override the deny. #
696 # reason - Reason given for the deny. #
697 # redirect - Redirect the user to a different channel. #
699 #<badchan name="#gods*" allowopers="yes" reason="Tortoises!"> #
700 #<badchan name="#chan1" redirect="#chan2" reason="Chan1 is closed"> #
702 # Redirects will not work if the target channel is set +L. #
704 # Additionally, you may specify channels which are allowed, even if #
705 # a badchan tag specifies it would be denied: #
706 #<goodchan name="#funtimes"> #
707 # Glob masks are accepted here also. #
709 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
710 # Devoice module: Let users devoice themselves using /DEVOICE #chan.
711 #<module name="devoice">
713 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
714 # DNS blacklist module: Provides support for looking up IPs on one or #
716 #<module name="dnsbl"> #
718 # For configuration options please see the wiki page for dnsbl at #
719 # http://wiki.inspircd.org/Modules/dnsbl #
721 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
722 # Exempt channel operators module: Provides support for allowing #
723 # channel operators to be exempt from some channel modes. Supported #
724 # modes are blockcaps, noctcp, blockcolor, nickflood, flood, censor, #
725 # filter, regmoderated, nonick, nonotice, and stripcolor. #
726 #<module name="exemptchanops"> #
728 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
729 # Filter module: Provides message filtering, similar to SPAMFILTER. #
730 #<module name="filter">
732 # This module depends upon a regex provider such as regex_pcre or #
733 # regex_glob to function. You must specify which of these you want #
734 # the filter module to use via the tag below. #
736 # Valid engines are: #
738 # glob - Glob patterns, provided via regex_glob. #
739 # pcre - PCRE regexps, provided via regex_pcre, needs libpcre. #
740 # tre - TRE regexps, provided via regex_tre, requires libtre. #
741 # posix - POSIX regexps, provided via regex_posix, not available #
742 # on Windows, no dependencies on other operating systems. #
743 # stdlib - stdlib regexps, provided via regex_stdlib, see comment #
744 # at the <module> tag for info on availability. #
746 #<filteropts engine="glob"> #
748 # Your choice of regex engine must match on all servers network-wide.
750 # To learn more about the configuration of this module, read #
751 # examples/filter.conf.example, which covers the various types of #
752 # filters and shows how to add exemptions. #
754 #-#-#-#-#-#-#-#-#-#-#- FILTER CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#
756 # Optional - If you specify to use the filter module, then #
757 # specify below the path to the filter.conf file, or define some #
760 #<include file="examples/filter.conf.example">
762 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
763 # Flash Policy Daemon module: Allows Flash IRC clients (e.g. LightIRC)#
764 # to connect. If no file is specified, it'll serve a default policy #
765 # allowing all IPs to connect to all plaintext IRC ports #
766 #<bind address="" port="8430" type="flashpolicyd"> #
767 #<flashpolicyd timeout="5" file=""> #
768 #<module name="flashpolicyd"> #
770 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
771 # Gecos ban: Implements extended ban 'r', which stops anyone matching
772 # a mask like +b r:*realname?here* from joining a channel.
773 #<module name="gecosban">
775 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
776 # GeoIP module: Allows the server admin to match users by country code.
777 # This module is in extras. Re-run configure with:
778 # ./configure --enable-extras=m_geoip.cpp
779 # and run make install, then uncomment this module to enable it.
780 # This module requires GeoIP to be installed on your system,
781 # use your package manager to find the appropriate packages
782 # or check the InspIRCd wiki page for this module.
783 #<module name="geoip">
785 # The actual allow/ban actions are done by connect classes, not by the
786 # GeoIP module. An example connect class to ban people from russia or
789 # <connect deny="*" geoip="TR,RU">
791 # The country code must be in capitals and should be an ISO country
792 # code such as TR, GB, or US. Unknown IPs (localhost, LAN IPs, etc)
793 # will be assigned the country code "UNK". Since connect classes are
794 # matched from top down, your deny classes must be above your allow
795 # classes for them to match.
797 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
798 # Globops module: Provides the /GLOBOPS command and snomask +g.
799 # This module is oper-only.
800 # To use, GLOBOPS must be in one of your oper class blocks.
801 #<module name="globops">
803 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
804 # Global load module: Allows loading and unloading of modules network-
805 # wide (USE WITH EXTREME CAUTION!)
806 # This module is oper-only and provides /GLOADMODULE, /GUNLOADMODULE
807 # and /GRELOADMODULE.
808 # To use, GLOADMODULE, GUNLOADMODULE and GRELOADMODULE
809 # must be in one of your oper class blocks.
810 #<module name="globalload">
812 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
813 # HELPOP module: Provides the /HELPOP command
814 #<module name="helpop">
816 #-#-#-#-#-#-#-#-#-#-#-#- HELPOP CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
818 # If you specify to use the helpop module, then specify below the #
819 # path to the helpop.conf file. #
821 #<include file="examples/inspircd.helpop-full.example">
823 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
824 # Hide chans module: Allows users to hide their channels list from non-
825 # opers by setting user mode +I on themselves.
826 #<module name="hidechans">
828 # This mode can optionally prevent opers from seeing channels on a +I
829 # user, for more privacy if set to true.
830 # This setting is not recommended for most mainstream networks.
831 #<hidechans affectsopers="false">
833 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
834 # Hide list module: Allows for hiding the list of listmodes from users
835 # who do not have sufficient channel rank.
836 #<module name="hidelist">
838 # Each <hidelist> tag configures one listmode to hide.
839 # mode: Name of the listmode to hide.
840 # rank: Minimum rank required to view the list. If set to 0, all
841 # members of the channel may view the list, but non-members may not.
842 # The rank of the built-in op and voice mode is 30000 and 10000,
843 # respectively; the rank of other prefix modes is configurable.
846 # Hiding the ban list is not recommended because it may break some
849 # Hide filter (+g) list:
850 #<hidelist mode="filter" rank="30000">
851 # Only show invite exceptions (+I) to channel members:
852 #<hidelist mode="invex" rank="0">
854 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
855 # Hide oper module: Allows opers to hide their oper status from non-
856 # opers by setting user mode +H on themselves.
857 # This module is oper-only.
858 #<module name="hideoper">
860 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
861 # Hostchange module: Allows a different style of cloaking.
862 #<module name="hostchange">
864 #-#-#-#-#-#-#-#-#-#-#- HOSTCHANGE CONFIGURATION -#-#-#-#-#-#-#-#-#-#
866 # See http://wiki.inspircd.org/Modules/hostchange for help. #
868 #<host suffix="invalid.org" separator="." prefix="">
869 #<hostchange mask="*@42.theanswer.example.org" action="addnick">
870 #<hostchange mask="*root@*" action="suffix">
871 #<hostchange mask="a@example.com" action="set" value="foo.bar.baz">
872 #<hostchange mask="localhost" ports="7000,7001,7005-7007" action="set" value="blahblah.foo">
874 # hostcycle: If loaded, when a user gets a host or ident set, it will
875 # cycle them in all their channels. If not loaded it will simply change
876 # their host/ident without cycling them.
877 # This module is compatible with the ircv3_chghost module. Clients
878 # supporting the chghost extension will get the chghost message instead
879 # of seeing a host cycle.
880 #<module name="hostcycle">
882 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
883 # httpd module: Provides HTTP server support for InspIRCd.
884 #<module name="httpd">
886 #-#-#-#-#-#-#-#-#-#-#-#- HTTPD CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
888 # If you choose to use the httpd module, then you will need to add
889 # a <bind> tag with type "httpd", and load at least one of the other
890 # httpd_* modules to provide pages to display.
892 # You can adjust the timeout for HTTP connections below. All HTTP
893 # connections will be closed after (roughly) this time period.
894 #<httpd timeout="20">
896 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
897 # HTTP ACL module: Provides access control lists for httpd dependent
898 # modules. Use this module to restrict pages by IP address and by
900 #<module name="httpd_acl">
902 #-#-#-#-#-#-#-#-#-#-#-#- HTTPD ACL CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
904 # Restrict access to the httpd_stats module to all but the local
905 # network and when the correct password is specified:
906 # <httpdacl path="/stats*" types="password,whitelist"
907 # username="secrets" password="mypasshere" whitelist="127.0.0.*,10.*">
909 # Deny all connections to all but the main index page:
910 # <httpdacl path="/*" types="blacklist" blacklist="*">
912 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
913 # HTTP config module: Allows the configuration of the server to be
914 # viewed over HTTP. Requires httpd to be loaded for it to function.
915 #<module name="httpd_config">
917 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
918 # HTTP stats module: Provides basic stats pages over HTTP.
919 # Requires httpd to be loaded for it to function.
920 #<module name="httpd_stats">
922 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
923 # Ident: Provides RFC 1413 ident lookup support.
924 # When this module is loaded <connect:allow> tags may have an optional
925 # useident="yes|no" boolean value, determining whether or not to lookup
926 # ident on users matching that connect tag.
927 #<module name="ident">
929 #-#-#-#-#-#-#-#-#-#-#-#- IDENT CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
931 # Optional - If you are using the ident module, then you can specify #
932 # the timeout for ident lookups here. If not defined, it will default #
933 # to 5 seconds. This is a non-blocking timeout which holds the user #
934 # in a 'connecting' state until the lookup is complete. #
935 # The bind value indicates which IP to bind outbound requests to. #
936 # nolookupprefix: If on, the idents of users being in a connect class #
937 # with ident lookups disabled (i.e. <connect useident="off">) will be #
938 # prefixed with a "~". If off, the ident of those users will not be #
939 # prefixed. Default is off. #
941 #<ident timeout="5" nolookupprefix="no">
943 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
944 # Invite exception module: Adds support for channel invite exceptions
946 #<module name="inviteexception">
947 # bypasskey: If this is enabled, exceptions will bypass +k as well as +i
948 #<inviteexception bypasskey="yes">
950 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
951 # IRCv3 module: Provides the following IRCv3.1 extensions:
952 # extended-join, away-notify and account-notify. These are optional
953 # enhancements to the client-to-server protocol. An extension is only
954 # active for a client when the client specifically requests it, so this
955 # module needs the cap module to work.
957 # Further information on these extensions can be found at the IRCv3
958 # working group website:
959 # http://ircv3.org/extensions/
961 #<module name="ircv3">
962 # The following block can be used to control which extensions are
963 # enabled. Note that extended-join can be incompatible with delayjoin
965 #<ircv3 accountnotify="on" awaynotify="on" extendedjoin="on">
967 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
968 # IRCv3 cap-notify module: Provides the cap-notify IRCv3.2 extension.
969 # Required for IRCv3.2 conformance.
970 #<module name="ircv3_capnotify">
972 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
973 # IRCv3 chghost module: Provides the chghost IRCv3.2 extension which
974 # allows capable clients to learn when the host/ident of another user
975 # changes without cycling the user. This module is compatible with the
976 # hostcycle module. If both are loaded, clients supporting the chghost
977 # extension will get the chghost message and won't see host cycling.
978 #<module name="ircv3_chghost">
980 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
981 # IRCv3 echo-message module: Provides the echo-message IRCv3.2
982 # extension which allows capable clients to get an acknowledgement when
983 # their messages are delivered and learn what modifications, if any,
984 # were applied to them.
985 #<module name="ircv3_echomessage">
987 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
988 # IRCv3 invite-notify module: Provides the invite-notify IRCv3.2
989 # extension which notifies supporting clients when a user invites
990 # another user into a channel. This respects <options:announceinvites>.
991 #<module name="ircv3_invitenotify">
993 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
994 # Join flood module: Adds support for join flood protection +j X:Y.
995 # Closes the channel for N seconds if X users join in Y seconds.
996 #<module name="joinflood">
998 # The number of seconds to close the channel for:
999 #<joinflood duration="1m">
1001 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1002 # Jump server module: Adds support for the RPL_REDIR numeric.
1003 # This module is oper-only.
1004 # To use, JUMPSERVER must be in one of your oper class blocks.
1005 # If your server is redirecting new clients and you get disconnected,
1006 # do a REHASH from shell to open up again.
1007 #<module name="jumpserver">
1009 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1010 # Anti auto rejoin: Adds support for prevention of auto-rejoin (+J).
1011 #<module name="kicknorejoin">
1013 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1014 # Knock module: Adds the /KNOCK command and channel mode +K.
1015 #<module name="knock">
1017 # This setting specifies what to do when someone successfully /KNOCKs.
1018 # If set to "notice", then a NOTICE will be sent to the channel.
1019 # This is the default and the compatible setting, as it requires no
1020 # special support from the clients.
1021 # If set to "numeric" then a 710 numeric will be sent to the channel.
1022 # This allows easier scripting but not all clients support it.
1023 # If set to "both" then (surprise!) both will be sent.
1024 #<knock notify="notice">
1026 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1027 # LDAP module: Allows other SQL modules to access a LDAP database
1028 # through a unified API.
1029 # This modules is in extras. Re-run configure with:
1030 # ./configure --enable-extras=m_ldap.cpp
1031 # and run make install, then uncomment this module to enable it.
1033 #<module name="ldap">
1034 #<database module="ldap" id="ldapdb" server="ldap://localhost" binddn="cn=Manager,dc=inspircd,dc=org" bindauth="mysecretpass" searchscope="subtree">
1035 # The server parameter indicates the LDAP server to connect to. The #
1036 # ldap:// style scheme before the hostname proper is MANDATORY. #
1038 # The binddn and bindauth indicate the DN to bind to for searching, #
1039 # and the password for the distinguished name. Some LDAP servers will #
1040 # allow anonymous searching in which case these two values do not #
1041 # need defining, otherwise they should be set similar to the examples #
1044 # The searchscope value indicates the subtree to search under. On our #
1045 # test system this is 'subtree'. Your mileage may vary. #
1047 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1048 # LDAP authentication module: Adds the ability to authenticate users #
1050 #<module name="ldapauth">
1054 # <ldapauth dbid="ldapdb" #
1055 # baserdn="ou=People,dc=brainbox,dc=cc" #
1057 # allowpattern="Guest* Bot*" #
1058 # killreason="Access denied" #
1060 # host="$uid.$ou.inspircd.org" #
1061 # useusername="no"> #
1063 # <ldapwhitelist cidr="10.42.0.0/16"> #
1065 # <ldaprequire attribute="attr" value="val"> #
1067 # The baserdn indicates the base DN to search in for users. Usually #
1068 # this is 'ou=People,dc=yourdomain,dc=yourtld'. #
1070 # The attribute value indicates the attribute which is used to locate #
1071 # a user account by name. On POSIX systems this is usually 'uid'. #
1073 # The allowpattern value allows you to specify a space separated list #
1074 # of wildcard masks which will always be allowed to connect #
1075 # regardless of if they have an account, for example guest and bot #
1078 # The useusername setting chooses whether the user's username or #
1079 # nickname is used when locating a user account, if a username isn't #
1080 # provided in PASS. #
1082 # Killreason indicates the QUIT reason to give to users if they fail #
1083 # to authenticate. #
1085 # Setting the verbose value causes an oper notice to be sent out for #
1086 # every failed authentication to the server, with an error string. #
1088 # ldapwhitelist indicates that clients connecting from an IP in the #
1089 # provided CIDR do not need to authenticate against LDAP. It can be #
1090 # repeated to whitelist multiple CIDRs. #
1092 # ldaprequire allows further filtering on the LDAP user, by requiring #
1093 # certain LDAP attibutes to have a given value. It can be repeated, #
1094 # in which case the list will act as an OR list, that is, the #
1095 # authentication will succeed if any of the requirements in the list #
1098 # host allows you to change the displayed host of users connecting #
1099 # from ldap. The string supplied takes formatters which are replaced #
1100 # from the DN. For instance, if your DN looks like: #
1101 # uid=w00t,ou=people,dc=inspircd,dc=org, then the formatters uid, ou #
1102 # and dc will be available to you. If a key is given multiple times #
1103 # in the DN, the last appearance will take precedence. #
1105 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1106 # LDAP oper configuration module: Adds the ability to authenticate #
1108 #<module name="ldapoper">
1112 # <ldapoper dbid="ldapdb"
1113 # baserdn="ou=People,dc=brainbox,dc=cc"
1116 # Available configuration items are identical to the same items in #
1117 # ldapauth above (except for the verbose setting, that is only #
1118 # supported in ldapauth). #
1119 # Please always specify a password in your <oper> tags even if the #
1120 # opers are to be authenticated via LDAP, so in case this module is #
1121 # not loaded the oper accounts are still protected by a password. #
1123 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1124 # Lock server module: Adds /LOCKSERV and /UNLOCKSERV commands that #
1125 # are used to temporarily close/open the server for new connections. #
1126 # These commands require that the /LOCKSERV and /UNLOCKSERV commands #
1127 # are specified in a <class> tag that the oper is part of. This is so #
1128 # you can control who has access to this possible dangerous command. #
1129 # If your server is locked and you get disconnected, do a REHASH from #
1130 # shell to open up again. #
1131 # This module is oper-only.
1132 #<module name="lockserv">
1134 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1135 # Map hiding module: replaces /MAP and /LINKS output to users with a #
1136 # message to see a website, set by maphide="http://test.org/map" in #
1137 # the <security> tag, instead. #
1138 #<module name="maphide">
1140 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1141 # Message flood module: Adds message/notice flood protection via
1143 #<module name="messageflood">
1145 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1146 # MLOCK module: Adds support for server-side enforcement of services
1147 # side MLOCKs. Basically, this module suppresses any mode change that
1148 # would likely be immediately bounced by services.
1149 #<module name="mlock">
1151 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1152 # Modenotice module: Adds the /MODENOTICE command that allows opers to
1153 # send notices to all users having the given user mode(s) set.
1154 #<module name="modenotice">
1156 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1157 # Monitor module: Adds support for MONITOR which is used by clients to
1158 # maintain notify lists.
1159 #<module name="monitor">
1161 # Set the maximum number of entries on a user's monitor list below.
1162 #<monitor maxentries="30">
1164 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1165 # MySQL module: Allows other SQL modules to access MySQL databases
1166 # through a unified API.
1167 # This module is in extras. Re-run configure with:
1168 # ./configure --enable-extras=m_mysql.cpp
1169 # and run make install, then uncomment this module to enable it.
1170 #<module name="mysql">
1172 #-#-#-#-#-#-#-#-#-#-#-#- SQL CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#-#
1174 # mysql is more complex than described here, see the wiki for more #
1175 # info: http://wiki.inspircd.org/Modules/mysql #
1177 #<database module="mysql" name="mydb" user="myuser" pass="mypass" host="localhost" id="my_database2">
1179 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1180 # Named modes module: Allows for the display and set/unset of channel
1181 # modes via long-form mode names via +Z and the /PROP command.
1182 # For example, to set a ban, do /mode #channel +Z ban=foo!bar@baz or
1183 # /PROP #channel ban=foo!bar@baz
1184 #<module name="namedmodes">
1186 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1187 # NAMESX module: Provides support for the NAMESX extension which allows
1188 # clients to see all the prefixes set on a user without getting confused.
1189 # This is supported by mIRC, x-chat, klient, and maybe more.
1190 #<module name="namesx">
1192 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1193 # National characters module:
1194 # 1) Allows using national characters in nicknames.
1195 # 2) Allows using custom (national) casemapping over the network.
1196 #<module name="nationalchars">
1198 # file - Location of the file which contains casemapping rules. If this
1199 # is a relative path then it is relative to "<PWD>/../locales"
1200 # on UNIX and "<PWD>/locales" on Windows.
1201 # casemapping - The name of the casemapping sent to clients in the 005
1202 # numeric. If this is not set then it defaults to the name
1203 # of the casemapping file unless the file name contains a
1204 # space in which case you will have to specify it manually.
1205 #<nationalchars file="bynets/russian-w1251-charlink" casemapping="ru_RU.cp1251-charlink">
1207 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1208 # Nickchange flood protection module: Provides channel mode +F X:Y
1209 # which allows up to X nick changes in Y seconds.
1210 #<module name="nickflood">
1212 # The number of seconds to prevent nick changes for:
1213 #<nickflood duration="1m">
1215 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1216 # Nicklock module: Let opers change a user's nick and then stop that
1217 # user from changing their nick again until unlocked.
1218 # This module is oper-only.
1219 # To use, NICKLOCK and NICKUNLOCK must be in one of your oper class blocks.
1220 #<module name="nicklock">
1222 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1223 # No CTCP module: Adds the channel mode +C to block CTCPs and extban
1224 # 'C' to block CTCPs sent by specific users.
1225 #<module name="noctcp">
1227 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1228 # No kicks module: Adds the +Q channel mode and the Q: extban to deny
1229 # certain users from kicking.
1230 #<module name="nokicks">
1232 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1233 # No nicks module: Adds the +N channel mode, as well as the 'N' extban.
1234 # +N stops all users from changing their nick, the N extban stops
1235 # anyone from matching a +b N:nick!user@host mask from changing their
1237 #<module name="nonicks">
1239 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1240 # No part message module: Adds extban 'p' to block part messages from #
1242 #<module name="nopartmsg">
1244 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1245 # No notice module: Adds the channel mode +T and the extban 'T' to
1246 # block specific users from noticing the channel.
1247 #<module name="nonotice">
1249 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1250 # Network business join module:
1251 # Allows an oper to join a channel using /OJOIN, giving them +Y on the
1252 # channel which makes them immune to kick/deop/etc.
1253 #<module name="ojoin">
1255 # Specify the prefix that +Y will grant here.
1256 # Leave 'prefix' empty if you do not wish +Y to grant a prefix.
1257 # If 'notice' is set to on, upon /OJOIN, the server will notice the
1258 # channel saying that the oper is joining on network business.
1259 # If 'op' is set to on, it will give them +o along with +Y.
1260 #<ojoin prefix="!" notice="yes" op="yes">
1262 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1263 # Oper channels mode: Adds the +O channel mode and extban O:<mask>
1264 # to ban, except, etc. specific oper types. For example
1265 # /mode #channel +iI O:* is equivalent to channel mode +O, but you
1266 # may also set +iI O:AdminTypeOnly to only allow admins.
1267 # Modes +I and +e work in a similar fashion.
1268 #<module name="operchans">
1270 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1271 # Oper join module: Auto-joins opers to a channel upon oper-up.
1272 # This module is oper-only. For the user equivalent, see the conn_join
1274 #<module name="operjoin">
1276 #-#-#-#-#-#-#-#-#-#-# OPERJOIN CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
1278 # If you are using the operjoin module, specify options here: #
1280 # channel - The channel name to join, can also be a comma #
1281 # separated list e.g. "#channel1,#channel2". #
1283 # override - If on, lets the oper join walking thru any modes #
1284 # that might be set, even bans. #
1286 #<operjoin channel="#channel" override="no">
1288 # Alternatively you can use the autojoin="channellist" in a <type> #
1289 # tag to set specific autojoins for a type of oper, for example: #
1291 #<type name="Helper" autojoin="#help" classes="...">
1293 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1294 # Oper log module: Logs all oper commands to the server log (with log
1295 # type "m_operlog" at default loglevel), and optionally to the 'r'
1297 # This module is oper-only.
1298 #<module name="operlog">
1300 # If the following option is on then all oper commands will be sent to
1301 # the snomask 'r'. The default is off.
1302 #<operlog tosnomask="off">
1304 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1305 # Oper prefixing module: Adds a channel prefix mode +y which is given
1306 # to all IRC operators automatically on all channels they are in.
1307 # This prefix mode is more powerful than channel op and other regular
1310 # Load this module if you want all your IRC operators to have channel
1312 #<module name="operprefix">
1314 # You may additionally customise the prefix character.
1315 #<operprefix prefix="!">
1317 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1318 # Oper MOTD module: Provides support for separate message of the day
1320 # This module is oper-only.
1321 #<module name="opermotd">
1323 #-#-#-#-#-#-#-#-#-#-# OPERMOTD CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
1325 # If you are using the opermotd module, specify the motd here. #
1327 # onoper - If on, the message is sent on /OPER, otherwise it's #
1328 # only sent when /OPERMOTD is used. #
1330 # processcolors - Allow color codes to be processed in the opermotd. #
1331 # Read the comment above <connect:allowmotdcolors> in #
1332 # inspircd.conf.example for details. #
1334 #<opermotd file="examples/opermotd.txt.example" onoper="yes" processcolors="false">
1336 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1337 # Override module: Adds support for oper override.
1338 # This module is oper-only.
1339 #<module name="override">
1341 #-#-#-#-#-#-#-#-#-#-# OVERRIDE CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
1343 # override is too complex it describe here, see the wiki: #
1344 # http://wiki.inspircd.org/Modules/override #
1346 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1347 # Oper levels module: Gives each oper a level and prevents actions
1348 # being taken by lower level opers against higher level opers.
1349 # Specify the level as the 'level' parameter of the <type> tag.
1350 # This module is oper-only.
1351 #<module name="operlevels">
1353 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1354 # Oper modes module: Allows you to specify modes to add/remove on oper.
1355 # Specify the modes as the 'modes' parameter of the <type> tag
1356 # and/or as the 'modes' parameter of the <oper> tag.
1357 # This module is oper-only. For the user equivalent, see the
1358 # conn_umodes module.
1359 #<module name="opermodes">
1361 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1362 # Password forwarding module: Forwards a password users can send on
1363 # connect to the specified client below. The client is usually NickServ
1364 # and this module is usually used to authenticate users with NickServ
1365 # using their connect password.
1366 #<module name="passforward">
1369 # nick: nick to forward connect passwords to.
1372 # forwardmsg: Message to send to users using a connect password.
1373 # $nick will be the users' nick, $nickrequired will be the nick
1374 # of where the password is going (the nick above).
1375 # You can also use $user for the user ident string.
1376 forwardmsg="NOTICE $nick :*** Forwarding PASS to $nickrequired"
1378 # cmd: Command for the user to run when it receives a connect
1380 cmd="PRIVMSG $nickrequired :IDENTIFY $pass">
1382 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1383 # Password hash module: Allows hashed passwords to be used.
1384 # To be useful, a hashing module like bcrypt also needs to be loaded.
1385 #<module name="password_hash">
1387 #-#-#-#-#-#-#-#-#-# PASSWORD HASH CONFIGURATION #-#-#-#-#-#-#-#-#-#-#-#
1389 # To use this module, you must define a hash type for each oper's
1390 # password you want to hash. For example:
1392 # <oper name="Brain"
1393 # host="ident@dialup15.isp.test.com"
1395 # password="$2a$10$Mss9AtHHslZTLBrXqM0FB.JBwD.UTSu8A48SfrY9exrpxbsRiRTbO"
1398 # If you are using a hash algorithm which does not perform salting you can use
1399 # HMAC to salt your passwords in order to prevent them from being looked up in
1402 # hash="hmac-sha256" password="lkS1Nbtp$CyLd/WPQXizsbxFUTqFRoMvaC+zhOULEeZaQkUJj+Gg"
1404 # Generate hashes using the /MKPASSWD command on the server.
1405 # Don't run it on a server you don't trust with your password.
1407 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1408 # PBKDF2 module: Allows other modules to generate PBKDF2 hashes,
1409 # usually for cryptographic uses and security.
1410 # This module relies on other hash providers (e.g. SHA256).
1411 #<module name="pbkdf2">
1413 # iterations: Iterations the hashing function runs when generating new
1415 # length: Length in bytes of the derived key.
1416 #<pbkdf2 iterations="12288" length="32">
1417 # You can override these values with specific values
1418 # for specific providers if you want to. Example given for SHA256.
1419 #<pbkdf2prov hash="sha256" iterations="24576">
1421 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1422 # Permanent channels module: Channels with the permanent channel mode
1423 # will remain open even after everyone else has left the channel, and
1424 # therefore keep things like modes, ban lists and topic. Permanent
1425 # channels -may- need support from your Services package to function
1426 # properly with them. This adds channel mode +P.
1427 # This module is oper-only.
1428 #<module name="permchannels">
1430 # If you like, this module can write a config file of permanent channels
1431 # whenever +P is set, unset, or the topic/modes on a +P channel is changed.
1432 # If you want to do this, set the filename below, and uncomment the include.
1434 # If 'listmodes' is true then all list modes (+b, +I, +e, +g...) will be
1435 # saved. Defaults to false.
1436 #<permchanneldb filename="permchannels.conf" listmodes="true">
1437 #<include file="permchannels.conf">
1439 # You may also create channels on startup by using the <permchannels> block.
1440 #<permchannels channel="#opers" modes="isP" topic="Opers only.">
1442 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1443 # PostgreSQL module: Allows other SQL modules to access PgSQL databases
1444 # through a unified API.
1445 # This module is in extras. Re-run configure with:
1446 # ./configure --enable-extras=m_pgsql.cpp
1447 # and run make install, then uncomment this module to enable it.
1448 #<module name="pgsql">
1450 #-#-#-#-#-#-#-#-#-#-#-#- SQL CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#-#
1452 # pgsql is more complex than described here, see the wiki for #
1453 # more: http://wiki.inspircd.org/Modules/pgsql #
1455 #<database module="pgsql" name="mydb" user="myuser" pass="mypass" host="localhost" id="my_database" ssl="no">
1457 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1458 # Muteban: Implements extended ban 'm', which stops anyone matching
1459 # a mask like +b m:nick!user@host from speaking on channel.
1460 #<module name="muteban">
1462 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1463 # Random quote module: Provides a random quote on connect.
1464 # NOTE: Some of these may mimic fatal errors and confuse users and
1465 # opers alike - BEWARE!
1466 #<module name="randquote">
1468 #-#-#-#-#-#-#-#-#-#- RANDOMQUOTES CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
1470 # Optional - If you specify to use the randquote module, then specify #
1471 # below the path to the quotes file. #
1473 #<randquote file="quotes.txt">
1475 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1476 # Redirect module: Adds channel redirection mode +L. #
1477 # Optional: <redirect:antiredirect> to add usermode +L to stop forced #
1478 # redirection and instead print an error. #
1480 # Note: You can not update this with a simple rehash, it requires #
1481 # reloading the module for it to take effect. #
1482 # This also breaks linking to servers that do not have the option. #
1483 # This defaults to false for the 2.0 version, it will be enabled in #
1484 # all the future versions. #
1485 #<module name="redirect">
1486 #<redirect antiredirect="true">
1488 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1489 # Regular expression provider for glob or wildcard (?/*) matching.
1490 # You must have at least 1 provider loaded to use the filter or rline
1491 # modules. This module has no additional requirements, as it uses the
1492 # matching already present in InspIRCd core.
1493 #<module name="regex_glob">
1495 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1496 # Regular expression provider for PCRE (Perl-Compatible Regular
1497 # Expressions). You need libpcre installed to compile and load this
1498 # module. You must have at least 1 provider loaded to use the filter or
1500 #<module name="regex_pcre">
1502 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1503 # Regular Expression Provider for RE2 Regular Expressions.
1504 # You need libre2 installed and in your include/library paths in order
1505 # to compile and load this module.
1506 #<module name="regex_re2">
1508 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1509 # Regular expression provider for POSIX regular expressions.
1510 # You shouldn't need any additional libraries on a POSIX-compatible
1511 # system (i.e.: any Linux, BSD, but not Windows). You must have at
1512 # least 1 provider loaded to use filter or rline.
1513 # On POSIX-compliant systems, regex syntax can be found by using the
1514 # command: 'man 7 regex'.
1515 #<module name="regex_posix">
1517 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1518 # Regular expression provider for C++11 std::regex regular expressions.
1519 # This module works on any fully compliant implementation of the C++11
1520 # std::regex container. Examples for such are Visual C++ 2010 and newer
1521 # but not libstdc++ (which GCC uses).
1522 # You should verify that std::regex is supported by your setup before
1523 # using this module, as it may compile normally but won't do anything
1524 # on some implementations.
1525 #<module name="regex_stdlib">
1527 # Specify the regular expression engine to use here. Valid settings are
1528 # bre, ere, awk, grep, egrep, ecmascript (default if not specified).
1529 #<stdregex type="ecmascript">
1531 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1532 # Regular expression provider for TRE regular expressions.
1533 # This is the same regular expression engine used by UnrealIRCd, so
1534 # if you are most familiar with the syntax of /SPAMFILTER from there,
1535 # this is the provider you want. You need libtre installed in order
1536 # to compile and load this module.
1537 #<module name="regex_tre">
1539 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1540 # Registered users only channel creation module. If enabled, only
1541 # registered users and opers can create new channels.
1543 # You probably *DO NOT* want to load this module on a public network.
1545 #<module name="regonlycreate">
1547 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1548 # Remove module: Adds the /REMOVE command which is a peaceful
1549 # alternative to /KICK.
1550 #<module name="remove">
1552 # supportnokicks: If true, /REMOVE is not allowed on channels where the
1553 # nokicks (+Q) mode is set. Defaults to false.
1554 # protectedrank: Members having this rank or above may not be /REMOVE'd
1555 # by anyone. Set to 0 to disable this feature. Defaults to 50000.
1556 #<remove supportnokicks="true" protectedrank="50000">
1558 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1559 # A module to block, kick or ban upon similar messages being uttered several times.
1560 # Syntax [~*][lines]:[sec]{[:difference]}{[:matchlines]}
1561 # ~ is to block, * is to ban, default is kick.
1562 # 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
1563 # seconds - How old the message has to be before it's invalidated.
1564 # distance - Edit distance, in percent, between two strings to trigger on.
1565 # matchlines - When set, the function goes into mode 2. In this mode the function will trigger if this many of the last <lines> matches.
1567 # As this module can be rather CPU-intensive, it comes with some options.
1568 # maxbacklog - Maximum size that can be specified for backlog. 0 disables multiline matching.
1569 # maxdistance - Max percentage of difference between two lines we'll allow to match. Set to 0 to disable edit-distance matching.
1570 # maxlines - Max lines of backlog to match against.
1571 # maxtime - Maximum period of time a user can set. 0 to allow any.
1572 # size - Maximum number of characters to check for, can be used to truncate messages
1573 # before they are checked, resulting in less CPU usage. Increasing this beyond 512
1574 # doesn't have any effect, as the maximum length of a message on IRC cannot exceed that.
1575 #<repeat maxbacklog="20" maxlines="20" maxdistance="50" maxtime="0" size="512">
1576 #<module name="repeat">
1578 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1579 # Restricted channels module: Allows only opers to create channels.
1581 # You probably *DO NOT* want to load this module on a public network.
1583 #<module name="restrictchans">
1585 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1586 # Restrict message module: Allows users to only message opers.
1588 # You probably *DO NOT* want to load this module on a public network.
1590 #<module name="restrictmsg">
1592 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1593 # R-Line module: Ban users through regular expression patterns.
1594 #<module name="rline">
1596 #-#-#-#-#-#-#-#-#-#-#-#- RLINE CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#-#
1598 # If you wish to re-check a user when they change nickname (can be
1599 # useful under some situations, but *can* also use CPU with more users
1600 # on a server) then set 'matchonnickchange' to yes.
1601 # Also, this is where you set what Regular Expression engine is to be
1602 # used. If you ever change it while running, all of your R-Lines will
1603 # be wiped. This is the regex engine used by all R-Lines set, and
1604 # regex_<engine> must be loaded, or rline will be non-functional
1605 # until you load it or change the engine to one that is loaded.
1607 #<rline matchonnickchange="yes" engine="pcre">
1609 # Generally, you will NOT want to use 'glob' here, as this turns
1610 # rline into just another gline. The exceptions are that rline will
1611 # always use the full "nick!user@host realname" string, rather than only
1612 # user@host, but beware that only the ? and * wildcards are available,
1613 # and are the only way to specify where the space can occur if you do
1614 # use glob. For this reason, is recommended to use a real regex engine
1615 # so that at least \s or [[:space:]] is available.
1617 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1618 # RMODE module: Adds the /RMODE command
1619 # Allows channel mods to remove list modes en masse.
1620 # Syntax: /rmode <channel> <mode> [pattern]
1621 # E.g. '/rmode #Channel b m:*' will remove all mute-extbans on the channel.
1622 #<module name="rmode">
1624 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1625 # SAJOIN module: Adds the /SAJOIN command which forcibly joins a user
1626 # to the given channel.
1627 # This module is oper-only.
1628 # To use, SAJOIN must be in one of your oper class blocks.
1629 # Opers need the users/sajoin-others priv to be able to /SAJOIN users
1630 # other than themselves.
1631 #<module name="sajoin">
1633 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1634 # SAKICK module: Adds the /SAKICK command which kicks a user from the
1636 # This module is oper-only.
1637 # To use, SAKICK must be in one of your oper class blocks.
1638 #<module name="sakick">
1640 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1641 # SAMODE module: Adds the /SAMODE command which allows server operators
1642 # to change modes on a channel without requiring them to have any
1643 # channel priviliges. Also allows changing user modes for any user.
1644 # This module is oper-only.
1645 # To use, SAMODE must be in one of your oper class blocks.
1646 #<module name="samode">
1648 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1649 # SANICK module: Adds the /SANICK command which allows opers to change
1651 # This module is oper-only.
1652 # To use, SANICK must be in one of your oper class blocks.
1653 #<module name="sanick">
1655 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1656 # SAPART module: Adds the /SAPART command which forcibly parts a user
1658 # This module is oper-only.
1659 # To use, SAPART must be in one of your oper class blocks.
1660 #<module name="sapart">
1662 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1663 # SAQUIT module: Adds the /SAQUIT command which forcibly quits a user.
1664 # This module is oper-only.
1665 # To use, SAQUIT must be in one of your oper class blocks.
1666 #<module name="saquit">
1668 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1669 # SATOPIC module: Adds the /SATOPIC command which allows changing the
1670 # topic on a channel without requiring any channel priviliges.
1671 # This module is oper-only.
1672 # To use, SATOPIC must be in one of your oper class blocks.
1673 #<module name="satopic">
1675 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1676 # SASL authentication module: Provides support for IRC Authentication
1677 # Layer via AUTHENTICATE. Note: You also need to have cap loaded
1679 #<module name="sasl">
1681 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1682 # Secure list module: Prevent /LIST in the first minute of connection,
1683 # crippling most spambots and trojan spreader bots.
1684 #<module name="securelist">
1686 #-#-#-#-#-#-#-#-#-# SECURELIST CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#-#
1688 # Securelist can be harmful to some IRC search engines. To prevent #
1689 # securelist blocking these sites from listing, define exception tags #
1691 #<securehost exception="*@*.netsplit.de">
1692 #<securehost exception="*@*.ircdriven.com">
1693 #<securehost exception="*@*.irc-source.com">
1695 # Define the following variable to change how long a user must wait #
1696 # before issuing a LIST. If not defined, defaults to 60 seconds. #
1698 #<securelist waittime="1m"> #
1700 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1701 # Servprotect module: Provides support for Austhex style +k /
1702 # UnrealIRCD +S services mode.
1703 #<module name="servprotect">
1705 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1706 # See nicks module: Adds snomask +n and +N which show local and remote
1708 # This module is oper-only.
1709 #<module name="seenicks">
1711 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1712 # Set idle module: Adds a command for opers to change their idle time.
1713 # This module is oper-only.
1714 # To use, SETIDLE must be in one of your oper class blocks.
1715 #<module name="setidle">
1717 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1718 # Services support module: Adds several usermodes such as +R and +M.
1719 # This module implements the 'identified' state via account names,
1720 # and is similar in operation to the way asuka and ircu handle services.
1722 # At the same time, this offers +r for users and channels to mark them
1723 # as identified separately from the idea of a master account, which
1724 # can be useful for services which are heavily nick-as-account centric.
1726 # Also of note is that this module implements two extbans:
1727 # +b R: (stop matching account names from joining)
1728 # +b U:n!u@h (blocks matching unregistered users)
1730 #<module name="services_account">
1732 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1733 # Sethost module: Adds the /SETHOST command.
1734 # This module is oper-only.
1735 # To use, SETHOST must be in one of your oper class blocks.
1736 # See the chghost module for how to customise valid chars for hostnames.
1737 #<module name="sethost">
1739 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1740 # Setident module: Adds the /SETIDENT command.
1741 # This module is oper-only.
1742 # To use, SETIDENT must be in one of your oper class blocks.
1743 #<module name="setident">
1745 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1746 # SETNAME module: Adds the /SETNAME command.
1747 #<module name="setname">
1749 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1750 # Serverban: Implements extended ban 's', which stops anyone connected
1751 # to a server matching a mask like +b s:server.mask.here from joining.
1752 #<module name="serverban">
1754 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1755 # SHA1 module: Allows other modules to generate SHA1 hashes.
1756 # Required by the WebSocket module.
1757 #<module name="sha1">
1759 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1760 # Showfile: Provides support for showing a text file to users when #
1761 # they enter a command. #
1762 # This module adds one command for each <showfile> tag that shows the #
1763 # given file to the user as a series of messages or numerics. #
1764 #<module name="showfile"> #
1766 #-#-#-#-#-#-#-#-#-#-# SHOWFILE CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#-#
1768 # name - The name of the command which displays this file. This is #
1769 # the only mandatory setting, all others are optional. #
1770 # file - The text file to be shown to the user. #
1771 # By default same as the command name. #
1772 # method - How should the file be shown? #
1773 # * numeric: Send contents using a numeric #
1774 # (similar to /MOTD; the default). #
1775 # * notice: Send contents as a series of notices. #
1776 # * msg: Send contents as a series of private messages. #
1777 # colors - If true, color codes (\c, \b, \u, etc.) will be processed #
1778 # and sent as ANSI colors. If false (default) the file will #
1779 # be displayed as-is. #
1781 # When using the method "numeric", the following extra settings are #
1784 # introtext - Introductory line, "Showing <name>" by default. #
1785 # intronumeric - Numeric used for the introductory line. #
1786 # numeric - Numeric used for sending the text itself. #
1787 # endtext - Ending line, "End of <name>" by default. #
1788 # endnumeric - Numeric used for the ending line. #
1790 #<showfile name="RULES"
1793 # introtext="Server rules:"
1794 # endtext="End of server rules.">
1796 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1797 # Show whois module: Adds the +W usermode which allows opers to see
1798 # when they are /WHOIS'd.
1799 # This module is oper-only by default.
1800 #<module name="showwhois">
1802 # If you wish, you may also let users set this mode. Only opers with the
1803 # users/auspex priv will see real hosts of people, though.
1804 #<showwhois opersonly="yes"
1806 # You may also set whether or not users should receive whois notices,
1807 # should they be /WHOIS'd by an oper.
1808 #showfromopers="yes">
1810 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1811 # Shun module: Provides the /SHUN command, which stops a user from
1812 # executing all except configured commands.
1813 # This module is oper-only.
1814 # To use, SHUN must be in one of your oper class blocks.
1815 #<module name="shun">
1817 # You may also configure which commands you wish a user to be able to
1818 # perform when shunned. It should be noted that if a shunned user
1819 # issues QUIT or PART then their message will be removed, as if they
1820 # did not issue one.
1822 # You can optionally let the user know that their command was blocked.
1824 # You may also let SHUN affect opers (defaults to no).
1825 #<shun enabledcommands="PING PONG QUIT PART JOIN" notifyuser="yes" affectopers="no">
1827 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1828 # SSL channel mode module: Adds support for SSL-only channels via
1829 # channel mode +z and the 'z' extban which matches SSL client
1830 # certificate fingerprints.
1831 # Does not do anything useful without a working SSL module and the
1832 # sslinfo module (see below).
1833 #<module name="sslmodes">
1835 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1836 # GnuTLS SSL module: Adds support for SSL connections using GnuTLS,
1837 # if enabled. You must answer 'yes' in ./configure when asked or
1838 # manually symlink the source for this module from the directory
1839 # src/modules/extra, if you want to enable this, or it will not load.
1840 #<module name="ssl_gnutls">
1842 #-#-#-#-#-#-#-#-#-#-#- GNUTLS CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#
1844 # ssl_gnutls is too complex to describe here, see the wiki: #
1845 # http://wiki.inspircd.org/Modules/ssl_gnutls #
1847 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1848 # SSL info module: Allows users to retrieve information about other
1849 # users' peer SSL certificates and keys. This can be used by client
1850 # scripts to validate users. For this to work, one of ssl_gnutls
1851 # or ssl_openssl must be loaded. This module also adds the
1852 # "* <user> is using a secure connection" whois line, the ability for
1853 # opers to use SSL cert fingerprints to verify their identity and the
1854 # ability to force opers to use SSL connections in order to oper up.
1855 # It is highly recommended to load this module if you use SSL on your
1857 # For how to use the oper features, please see the first example <oper> tag
1858 # in opers.conf.example.
1860 #<module name="sslinfo">
1862 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1863 # mbedTLS SSL module: Adds support for SSL/TLS connections using mbedTLS.
1864 #<module name="ssl_mbedtls">
1866 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1867 # OpenSSL SSL module: Adds support for SSL connections using OpenSSL,
1868 # if enabled. You must answer 'yes' in ./configure when asked or symlink
1869 # the source for this module from the directory src/modules/extra, if
1870 # you want to enable this, or it will not load.
1871 #<module name="ssl_openssl">
1873 #-#-#-#-#-#-#-#-#-#-#- OPENSSL CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#
1875 # ssl_openssl is too complex to describe here, see the wiki: #
1876 # http://wiki.inspircd.org/Modules/ssl_openssl #
1878 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1879 # Strip color module: Adds channel mode +S that strips color codes and
1880 # all control codes except CTCP from all messages sent to the channel.
1881 #<module name="stripcolor">
1883 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1884 # Silence module: Adds support for the /SILENCE command, which allows
1885 # users to have a server-side ignore list for their client.
1886 #<module name="silence">
1888 # Set the maximum number of entries allowed on a user's silence list.
1889 #<silence maxentries="32"
1891 # Whether messages from U-lined servers will bypass silence masks.
1894 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1895 # SQLite3 module: Allows other SQL modules to access SQLite3 #
1896 # databases through a unified API. #
1897 # This module is in extras. Re-run configure with: #
1898 # ./configure --enable-extras=m_sqlite.cpp
1899 # and run make install, then uncomment this module to enable it. #
1901 #<module name="sqlite3">
1903 #-#-#-#-#-#-#-#-#-#-#-#- SQL CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#-#
1905 # sqlite is more complex than described here, see the wiki for more #
1906 # info: http://wiki.inspircd.org/Modules/sqlite3 #
1908 #<database module="sqlite" hostname="/full/path/to/database.db" id="anytext">
1910 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1911 # SQL authentication module: Allows IRCd connections to be tied into
1912 # a database table (for example a forum).
1913 # This module is in extras. Re-run configure with:
1914 # ./configure --enable-extras=m_sqlauth.cpp
1915 # and run make install, then uncomment this module to enable it.
1917 #<module name="sqlauth">
1919 #-#-#-#-#-#-#-#-#-#-#- SQLAUTH CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#
1921 # sqlauth is too complex to describe here, see the wiki: #
1922 # http://wiki.inspircd.org/Modules/sqlauth #
1924 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1925 # SQL oper module: Allows you to store oper credentials in an SQL table
1926 # This module is in extras. Re-run configure with:
1927 # ./configure --enable-extras=m_sqloper.cpp
1928 # and run make install, then uncomment this module to enable it.
1930 #<module name="sqloper">
1932 #-#-#-#-#-#-#-#-#-#-#- SQLOPER CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#
1934 # dbid - Database ID to use (see SQL modules). #
1935 # hash - Hashing provider to use for password hashing. #
1937 # See also: http://wiki.inspircd.org/Modules/sqloper #
1939 #<sqloper dbid="1" hash="bcrypt">
1941 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1942 # StartTLS module: Implements STARTTLS, which allows clients #
1943 # connected to non SSL enabled ports to enable SSL, if a proper SSL #
1944 # module is loaded (either ssl_gnutls or ssl_openssl). #
1945 #<module name="starttls">
1947 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1948 # SVSHold module: Implements SVSHOLD. Like Q:Lines, but can only be #
1949 # added/removed by Services. #
1950 #<module name="svshold">
1951 # SVSHOLD does not generate server notices by default, you can turn
1952 # notices on by uncommenting the next line.
1953 #<svshold silent="false">
1955 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1956 # SWHOIS module: Allows you to add arbitrary lines to user WHOIS.
1957 # This module is oper-only.
1958 # To use, SWHOIS must be in one of your oper class blocks.
1959 #<module name="swhois">
1961 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1962 # Timed bans module: Adds timed channel bans with the /TBAN command.
1963 #<module name="timedbans">
1965 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1966 # Test line module: Adds the /TLINE command, used to test how many
1967 # users a /GLINE or /ZLINE etc. would match.
1968 # This module is oper-only.
1969 # To use, TLINE must be in one of your oper class blocks.
1970 #<module name="tline">
1972 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1973 # Topiclock module: implements server-side topic locking to achieve deeper
1974 # integration with services packages.
1975 #<module name="topiclock">
1977 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1978 # UHNAMES support module: Adds support for the IRCX style UHNAMES
1979 # extension, which displays ident and hostname in the names list for
1980 # each user, saving clients from doing a WHO on the channel.
1981 # If a client does not support UHNAMES it will not enable it, this will
1982 # not break incompatible clients.
1983 #<module name="uhnames">
1985 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1986 # Uninvite module: Adds the /UNINVITE command which lets users remove
1987 # pending invites from channels without waiting for the user to join.
1988 #<module name="uninvite">
1990 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1991 # Userip module: Adds the /USERIP command.
1992 # Allows users to query their own IP, also allows opers to query the IP
1994 #<module name="userip">
1996 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1997 # Vhost module: Adds the VHOST command which allows for adding virtual
1998 # hosts which are accessible using a username and password in the config.
1999 #<module name="vhost">
2001 #-#-#-#-#-#-#-#-#-#-#- VHOST CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#-#
2003 # user - Username for the vhost. #
2005 # pass - Password for the vhost. #
2007 # hash - The hash for the specific user (optional) #
2008 # password_hash and a hashing module must be loaded for #
2011 # host - Vhost to set. #
2013 #<vhost user="some_username" pass="some_password" host="some.host.test.cc">
2014 #<vhost user="foo" password="$2a$10$iTuYLT6BRhRlOgzfsW9oPe62etW.oXwSpyKw5rJit64SGZanLXghO" hash="bcrypt" host="some.other.host.example.com">
2016 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2017 # Watch module: Adds the WATCH command, which is used by clients to
2018 # maintain notify lists.
2019 #<module name="watch">
2021 # Set the maximum number of entries on a user's watch list below.
2022 #<watch maxentries="32">
2024 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2025 # WebSocket module: Adds HTML5 WebSocket support.
2026 # Specify hook="websocket" in a <bind> tag to make that port accept
2027 # WebSocket connections. Compatible with SSL/TLS.
2028 # Requires SHA-1 hash support available in the sha1 module.
2029 #<module name="websocket">
2031 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2032 # XLine database: Stores all *Lines (G/Z/K/R/any added by other modules)
2033 # in a file which is re-loaded on restart. This is useful
2034 # for two reasons: it keeps bans so users may not evade them, and on
2035 # bigger networks, server connections will take less time as there will
2036 # be a lot less bans to apply - as most of them will already be there.
2037 #<module name="xline_db">
2039 # Specify the filename for the xline database here.
2040 #<xlinedb filename="xline.db">
2042 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2043 # ____ _ _____ _ _ ____ _ _ _ #
2044 # | _ \ ___ __ _ __| | |_ _| |__ (_)___ | __ )(_) |_| | #
2045 # | |_) / _ \/ _` |/ _` | | | | '_ \| / __| | _ \| | __| | #
2046 # | _ < __/ (_| | (_| | | | | | | | \__ \ | |_) | | |_|_| #
2047 # |_| \_\___|\__,_|\__,_| |_| |_| |_|_|___/ |____/|_|\__(_) #
2049 # To link servers to InspIRCd, you MUST load the spanningtree module. #
2050 # If you don't do this, server links will NOT work at all. #
2051 # This is by design, to allow for the implementation of other linking #
2052 # protocols in modules in the future. #
2054 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2055 # Spanning tree module: Allows linking of servers using the spanning
2056 # tree protocol (see the READ THIS BIT section above).
2057 # You will almost always want to load this.
2059 #<module name="spanningtree">
projects / user / henk / code / inspircd.git / blob