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; by #
485 # default show the last 2 parts of the domain, #
486 # /16 subnet of IPv4 or /48 subnet of the IPv6 #
488 # To change the number of shown parts, modify the #
489 # domainparts option. #
491 # full Cloak the users completely, using three slices for #
492 # common CIDR bans (IPv4: /16, /24; IPv6: /48, /64). #
494 # The methods use a single key that can be any length of text. #
495 # An optional prefix may be specified to mark cloaked hosts. #
496 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
503 #-#-#-#-#-#-#-#-#-#-#-#- CLOSE MODULE #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
504 # Close module: Allows an oper to close all unregistered connections.
505 # This module is oper-only and provides the /CLOSE command.
506 # To use, CLOSE must be in one of your oper class blocks.
507 #<module name="close">
509 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
510 # Clones module: Adds an oper command /CLONES for detecting cloned
511 # users. Warning: This command may be resource intensive when it is
512 # issued, use with care.
513 # This module is oper-only.
514 # To use, CLONES must be in one of your oper class blocks.
515 #<module name="clones">
517 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
518 # Common channels module: Adds user mode +c, which, when set, requires
519 # that users must share a common channel with you to PRIVMSG or NOTICE
521 #<module name="commonchans">
523 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
524 # Auto join on connect module: Allows you to force users to join one
525 # or more channels automatically upon connecting to the server, or
526 # join them in case they aren't on any channels after being online
528 #<module name="conn_join">
530 #-#-#-#-#-#-#-#-#-#-#-#- CONNJOIN CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
532 # If you have the conn_join module loaded, you can configure it below
533 # or set autojoin="#chat,#help" in <connect> blocks.
535 # Join users immediately after connection to #one #two and #three.
536 #<autojoin channel="#one,#two,#three">
537 # Join users to #chat after 15 seconds if they aren't on any channels.
538 #<autojoin channel="#chat" delay="15">
540 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
541 # Set modes on connect module: When this module is loaded <connect>
542 # blocks may have an optional modes="" value, which contains modes to
543 # add or remove from users when they connect to the server.
544 #<module name="conn_umodes">
546 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
547 # Wait for PONG on connect module: Send a PING to all connecting users
548 # and don't let them connect until they reply with a PONG.
549 # This is useful to stop certain kinds of bots and proxies.
550 #<module name="conn_waitpong">
552 #-#-#-#-#-#-#-#-#-#-#- WAITPONG CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
554 # If you have the conn_waitpong module loaded, configure it with the #
557 # sendsnotice - Whether to send a helpful notice to users on #
558 # connect telling them how to connect, should #
559 # their client not reply PONG automatically. #
561 # killonbadreply - Whether to kill the user if they send the wrong #
564 #<waitpong sendsnotice="yes" killonbadreply="yes">
566 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
567 # Channel cycle module: Adds the /CYCLE command which is a server-side
568 # /HOP that bypasses restrictive modes.
569 #<module name="cycle">
571 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
572 # Connectban: Provides IP connection throttling. Any IP range that
573 # connects too many times (configurable) in an hour is Z-Lined for a
574 # (configurable) duration, and their count resets to 0.
575 #<module name="connectban">
577 # ipv4cidr and ipv6cidr allow you to turn the comparison from
578 # individual IP addresses (32 and 128 bits) into CIDR masks, to allow
579 # for throttling over whole ISPs/blocks of IPs, which may be needed to
582 # This allows for 10 connections in an hour with a 10 minute ban if
584 #<connectban threshold="10" duration="10m" ipv4cidr="32" ipv6cidr="128"
585 # A custom ban message may optionally be specified.
586 # 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.">
588 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
589 # Connection throttle module.
590 #<module name="connflood">
592 #-#-#-#-#-#-#-#-#-#-#- CONNTHROTTLE CONFIGURATION -#-#-#-#-#-#-#-#-#-#
593 # period, maxconns - Amount of connections per <period>.
595 # timeout - Time to wait after the throttle was activated
596 # before deactivating it. Be aware that the time
597 # is seconds + timeout.
599 # quitmsg - The message that users get if they attempt to
600 # connect while the throttle is active.
602 # bootwait - Amount of time in seconds to wait before enforcing
603 # the throttling when the server just booted.
605 #<connflood seconds="30" maxconns="3" timeout="30"
606 # quitmsg="Throttled" bootwait="10">
608 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
609 # Custom prefixes: Allows for channel prefixes to be added.
610 #<module name="customprefix">
612 # name The name of the mode, must be unique from other modes.
613 # letter The letter used for this mode. Required.
614 # prefix The prefix used for nicks with this mode. Not required.
615 # rank A numeric rank for this prefix, defining what permissions it gives.
616 # The rank of voice, halfop and op is 10000, 20000, and 30000,
618 # ranktoset The numeric rank required to set/unset this mode. Defaults to rank.
619 # depriv Can you remove the mode from yourself? Defaults to yes.
620 #<customprefix name="founder" letter="q" prefix="~" rank="50000" ranktoset="50000">
621 #<customprefix name="admin" letter="a" prefix="&" rank="40000" ranktoset="50000">
622 #<customprefix name="halfop" letter="h" prefix="%" rank="20000" ranktoset="30000">
623 #<customprefix name="halfvoice" letter="V" prefix="-" rank="1" ranktoset="20000">
625 # Do /RELOADMODULE customprefix after changing the settings of this module.
627 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
628 # Custom title module: Adds the /TITLE command which allows for trusted
629 # users to gain a custom whois line and an optional vhost can be
631 #<module name="customtitle">
633 #-#-#-#-#-#-#-#-#-#- CUSTOM TITLE CONFIGURATION -#-#-#-#-#-#-#-#-#-#
634 # name - The username used to identify.
635 # password - The password used to identify.
636 # hash - The hash for the specific user's password (optional).
637 # password_hash and a hashing module must be loaded
639 # host - Allowed hostmask (optional).
640 # title - Title shown in whois.
641 # vhost - Displayed host (optional).
643 #<title name="foo" password="bar" title="Official Chat Helper">
644 #<title name="bar" password="foo" host="ident@test.org" title="Official Chat Helper" vhost="helper.test.org">
645 #<title name="foo" password="$2a$10$UYZ4OcO8NNTCCGyCdY9SK.2GHiqGgxZfHFPOPmWuxEVWVQTtoDC7C" hash="bcrypt" title="Official Chat Helper">
647 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
648 # DCCALLOW module: Adds the /DCCALLOW command.
649 #<module name="dccallow">
651 #-#-#-#-#-#-#-#-#-#-#- DCCALLOW CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
652 # blockchat - Whether to block DCC CHAT as well as DCC SEND.
653 # length - Default duration of entries in DCCALLOW list.
654 # action - Default action to take if no action is
655 # specified, can be 'block' or 'allow'.
656 # maxentries - Max number of nicks to allow on a DCCALLOW list.
658 # File configuration:
659 # pattern - The glob pattern to match against.
660 # action - Action to take if a user attempts to send a file
661 # that matches this pattern, can be 'block' or
664 #<dccallow blockchat="yes" length="5m" action="block" maxentries="20">
665 #<banfile pattern="*.exe" action="block">
666 #<banfile pattern="*.txt" action="allow">
668 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
669 # Deaf module: Adds support for the usermode +d - deaf to channel
670 # messages and channel notices.
671 #<module name="deaf">
673 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
674 # Delay join module: Adds the channel mode +D which delays all JOIN
675 # messages from users until they speak. If they quit or part before
676 # speaking, their quit or part message will not be shown to the channel
677 # which helps cut down noise on large channels in a more friendly way
678 # than the auditorium mode. Only channel ops may set the +D mode.
679 #<module name="delayjoin">
681 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
682 # Delay message module: Adds the channel mode +d which disallows a user
683 # from talking in the channel unless they've been joined for X seconds.
684 # Settable using /MODE #chan +d 30
685 #<module name="delaymsg">
686 # Set allownotice to no to disallow NOTICEs too. Defaults to yes.
687 #<delaymsg allownotice="no">
689 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
690 # Deny channels module: Deny channels from being used by users.
691 #<module name="denychans">
693 #-#-#-#-#-#-#-#-#-#-#- DENYCHAN DEFINITIONS -#-#-#-#-#-#-#-#-#-#-#-#
695 # If you have the denychans module loaded, you need to specify the #
696 # channels to deny: #
698 # name - The channel name to deny (glob masks are ok). #
699 # allowopers - If operators are allowed to override the deny. #
700 # reason - Reason given for the deny. #
701 # redirect - Redirect the user to a different channel. #
703 #<badchan name="#gods*" allowopers="yes" reason="Tortoises!"> #
704 #<badchan name="#chan1" redirect="#chan2" reason="Chan1 is closed"> #
706 # Redirects will not work if the target channel is set +L. #
708 # Additionally, you may specify channels which are allowed, even if #
709 # a badchan tag specifies it would be denied: #
710 #<goodchan name="#funtimes"> #
711 # Glob masks are accepted here also. #
713 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
714 # Devoice module: Let users devoice themselves using /DEVOICE #chan.
715 #<module name="devoice">
717 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
718 # DNS blacklist module: Provides support for looking up IPs on one or #
720 #<module name="dnsbl"> #
722 # For configuration options please see the wiki page for dnsbl at #
723 # http://wiki.inspircd.org/Modules/dnsbl #
725 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
726 # Exempt channel operators module: Provides support for allowing #
727 # channel operators to be exempt from some channel modes. Supported #
728 # modes are blockcaps, noctcp, blockcolor, nickflood, flood, censor, #
729 # filter, regmoderated, nonick, nonotice, and stripcolor. #
730 #<module name="exemptchanops"> #
732 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
733 # Filter module: Provides message filtering, similar to SPAMFILTER. #
734 #<module name="filter">
736 # This module depends upon a regex provider such as regex_pcre or #
737 # regex_glob to function. You must specify which of these you want #
738 # the filter module to use via the tag below. #
740 # Valid engines are: #
742 # glob - Glob patterns, provided via regex_glob. #
743 # pcre - PCRE regexps, provided via regex_pcre, needs libpcre. #
744 # tre - TRE regexps, provided via regex_tre, requires libtre. #
745 # posix - POSIX regexps, provided via regex_posix, not available #
746 # on Windows, no dependencies on other operating systems. #
747 # stdlib - stdlib regexps, provided via regex_stdlib, see comment #
748 # at the <module> tag for info on availability. #
750 #<filteropts engine="glob"> #
752 # Your choice of regex engine must match on all servers network-wide.
754 # To learn more about the configuration of this module, read #
755 # examples/filter.conf.example, which covers the various types of #
756 # filters and shows how to add exemptions. #
758 #-#-#-#-#-#-#-#-#-#-#- FILTER CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#
760 # Optional - If you specify to use the filter module, then #
761 # specify below the path to the filter.conf file, or define some #
764 #<include file="examples/filter.conf.example">
766 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
767 # Flash Policy Daemon module: Allows Flash IRC clients (e.g. LightIRC)#
768 # to connect. If no file is specified, it'll serve a default policy #
769 # allowing all IPs to connect to all plaintext IRC ports #
770 #<bind address="" port="8430" type="flashpolicyd"> #
771 #<flashpolicyd timeout="5" file=""> #
772 #<module name="flashpolicyd"> #
774 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
775 # Gecos ban: Implements extended ban 'r', which stops anyone matching
776 # a mask like +b r:*realname?here* from joining a channel.
777 #<module name="gecosban">
779 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
780 # GeoIP module: Allows the server admin to match users by country code.
781 # This module is in extras. Re-run configure with:
782 # ./configure --enable-extras=m_geoip.cpp
783 # and run make install, then uncomment this module to enable it.
784 # This module requires GeoIP to be installed on your system,
785 # use your package manager to find the appropriate packages
786 # or check the InspIRCd wiki page for this module.
787 #<module name="geoip">
789 # The actual allow/ban actions are done by connect classes, not by the
790 # GeoIP module. An example connect class to ban people from russia or
793 # <connect deny="*" geoip="TR,RU">
795 # The country code must be in capitals and should be an ISO country
796 # code such as TR, GB, or US. Unknown IPs (localhost, LAN IPs, etc)
797 # will be assigned the country code "UNK". Since connect classes are
798 # matched from top down, your deny classes must be above your allow
799 # classes for them to match.
801 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
802 # Globops module: Provides the /GLOBOPS command and snomask +g.
803 # This module is oper-only.
804 # To use, GLOBOPS must be in one of your oper class blocks.
805 #<module name="globops">
807 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
808 # Global load module: Allows loading and unloading of modules network-
809 # wide (USE WITH EXTREME CAUTION!)
810 # This module is oper-only and provides /GLOADMODULE, /GUNLOADMODULE
811 # and /GRELOADMODULE.
812 # To use, GLOADMODULE, GUNLOADMODULE and GRELOADMODULE
813 # must be in one of your oper class blocks.
814 #<module name="globalload">
816 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
817 # HELPOP module: Provides the /HELPOP command
818 #<module name="helpop">
820 #-#-#-#-#-#-#-#-#-#-#-#- HELPOP CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
822 # If you specify to use the helpop module, then specify below the #
823 # path to the helpop.conf file. #
825 #<include file="examples/inspircd.helpop-full.example">
827 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
828 # Hide chans module: Allows users to hide their channels list from non-
829 # opers by setting user mode +I on themselves.
830 #<module name="hidechans">
832 # This mode can optionally prevent opers from seeing channels on a +I
833 # user, for more privacy if set to true.
834 # This setting is not recommended for most mainstream networks.
835 #<hidechans affectsopers="false">
837 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
838 # Hide list module: Allows for hiding the list of listmodes from users
839 # who do not have sufficient channel rank.
840 #<module name="hidelist">
842 # Each <hidelist> tag configures one listmode to hide.
843 # mode: Name of the listmode to hide.
844 # rank: Minimum rank required to view the list. If set to 0, all
845 # members of the channel may view the list, but non-members may not.
846 # The rank of the built-in op and voice mode is 30000 and 10000,
847 # respectively; the rank of other prefix modes is configurable.
850 # Hiding the ban list is not recommended because it may break some
853 # Hide filter (+g) list:
854 #<hidelist mode="filter" rank="30000">
855 # Only show invite exceptions (+I) to channel members:
856 #<hidelist mode="invex" rank="0">
858 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
859 # Hide oper module: Allows opers to hide their oper status from non-
860 # opers by setting user mode +H on themselves.
861 # This module is oper-only.
862 #<module name="hideoper">
864 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
865 # Hostchange module: Allows a different style of cloaking.
866 #<module name="hostchange">
868 #-#-#-#-#-#-#-#-#-#-#- HOSTCHANGE CONFIGURATION -#-#-#-#-#-#-#-#-#-#
870 # See http://wiki.inspircd.org/Modules/hostchange for help. #
872 #<host suffix="invalid.org" separator="." prefix="">
873 #<hostchange mask="*@42.theanswer.example.org" action="addnick">
874 #<hostchange mask="*root@*" action="suffix">
875 #<hostchange mask="a@example.com" action="set" value="foo.bar.baz">
876 #<hostchange mask="localhost" ports="7000,7001,7005-7007" action="set" value="blahblah.foo">
878 # hostcycle: If loaded, when a user gets a host or ident set, it will
879 # cycle them in all their channels. If not loaded it will simply change
880 # their host/ident without cycling them.
881 # This module is compatible with the ircv3_chghost module. Clients
882 # supporting the chghost extension will get the chghost message instead
883 # of seeing a host cycle.
884 #<module name="hostcycle">
886 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
887 # httpd module: Provides HTTP server support for InspIRCd.
888 #<module name="httpd">
890 #-#-#-#-#-#-#-#-#-#-#-#- HTTPD CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
892 # If you choose to use the httpd module, then you will need to add
893 # a <bind> tag with type "httpd", and load at least one of the other
894 # httpd_* modules to provide pages to display.
896 # You can adjust the timeout for HTTP connections below. All HTTP
897 # connections will be closed after (roughly) this time period.
898 #<httpd timeout="20">
900 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
901 # HTTP ACL module: Provides access control lists for httpd dependent
902 # modules. Use this module to restrict pages by IP address and by
904 #<module name="httpd_acl">
906 #-#-#-#-#-#-#-#-#-#-#-#- HTTPD ACL CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
908 # Restrict access to the httpd_stats module to all but the local
909 # network and when the correct password is specified:
910 # <httpdacl path="/stats*" types="password,whitelist"
911 # username="secrets" password="mypasshere" whitelist="127.0.0.*,10.*">
913 # Deny all connections to all but the main index page:
914 # <httpdacl path="/*" types="blacklist" blacklist="*">
916 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
917 # HTTP config module: Allows the configuration of the server to be
918 # viewed over HTTP. Requires httpd to be loaded for it to function.
919 #<module name="httpd_config">
921 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
922 # HTTP stats module: Provides basic stats pages over HTTP.
923 # Requires httpd to be loaded for it to function.
924 #<module name="httpd_stats">
926 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
927 # Ident: Provides RFC 1413 ident lookup support.
928 # When this module is loaded <connect:allow> tags may have an optional
929 # useident="yes|no" boolean value, determining whether or not to lookup
930 # ident on users matching that connect tag.
931 #<module name="ident">
933 #-#-#-#-#-#-#-#-#-#-#-#- IDENT CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
935 # Optional - If you are using the ident module, then you can specify #
936 # the timeout for ident lookups here. If not defined, it will default #
937 # to 5 seconds. This is a non-blocking timeout which holds the user #
938 # in a 'connecting' state until the lookup is complete. #
939 # The bind value indicates which IP to bind outbound requests to. #
940 # nolookupprefix: If on, the idents of users being in a connect class #
941 # with ident lookups disabled (i.e. <connect useident="off">) will be #
942 # prefixed with a "~". If off, the ident of those users will not be #
943 # prefixed. Default is off. #
945 #<ident timeout="5" nolookupprefix="no">
947 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
948 # Invite exception module: Adds support for channel invite exceptions
950 #<module name="inviteexception">
951 # bypasskey: If this is enabled, exceptions will bypass +k as well as +i
952 #<inviteexception bypasskey="yes">
954 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
955 # IRCv3 module: Provides the following IRCv3.1 extensions:
956 # extended-join, away-notify and account-notify. These are optional
957 # enhancements to the client-to-server protocol. An extension is only
958 # active for a client when the client specifically requests it, so this
959 # module needs the cap module to work.
961 # Further information on these extensions can be found at the IRCv3
962 # working group website:
963 # http://ircv3.org/extensions/
965 #<module name="ircv3">
966 # The following block can be used to control which extensions are
967 # enabled. Note that extended-join can be incompatible with delayjoin
969 #<ircv3 accountnotify="on" awaynotify="on" extendedjoin="on">
971 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
972 # IRCv3 cap-notify module: Provides the cap-notify IRCv3.2 extension.
973 # Required for IRCv3.2 conformance.
974 #<module name="ircv3_capnotify">
976 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
977 # IRCv3 chghost module: Provides the chghost IRCv3.2 extension which
978 # allows capable clients to learn when the host/ident of another user
979 # changes without cycling the user. This module is compatible with the
980 # hostcycle module. If both are loaded, clients supporting the chghost
981 # extension will get the chghost message and won't see host cycling.
982 #<module name="ircv3_chghost">
984 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
985 # IRCv3 echo-message module: Provides the echo-message IRCv3.2
986 # extension which allows capable clients to get an acknowledgement when
987 # their messages are delivered and learn what modifications, if any,
988 # were applied to them.
989 #<module name="ircv3_echomessage">
991 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
992 # IRCv3 invite-notify module: Provides the invite-notify IRCv3.2
993 # extension which notifies supporting clients when a user invites
994 # another user into a channel. This respects <options:announceinvites>.
995 #<module name="ircv3_invitenotify">
997 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
998 # Join flood module: Adds support for join flood protection +j X:Y.
999 # Closes the channel for N seconds if X users join in Y seconds.
1000 #<module name="joinflood">
1002 # The number of seconds to close the channel for:
1003 #<joinflood duration="1m">
1005 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1006 # Jump server module: Adds support for the RPL_REDIR numeric.
1007 # This module is oper-only.
1008 # To use, JUMPSERVER must be in one of your oper class blocks.
1009 # If your server is redirecting new clients and you get disconnected,
1010 # do a REHASH from shell to open up again.
1011 #<module name="jumpserver">
1013 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1014 # Anti auto rejoin: Adds support for prevention of auto-rejoin (+J).
1015 #<module name="kicknorejoin">
1017 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1018 # Knock module: Adds the /KNOCK command and channel mode +K.
1019 #<module name="knock">
1021 # This setting specifies what to do when someone successfully /KNOCKs.
1022 # If set to "notice", then a NOTICE will be sent to the channel.
1023 # This is the default and the compatible setting, as it requires no
1024 # special support from the clients.
1025 # If set to "numeric" then a 710 numeric will be sent to the channel.
1026 # This allows easier scripting but not all clients support it.
1027 # If set to "both" then (surprise!) both will be sent.
1028 #<knock notify="notice">
1030 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1031 # LDAP module: Allows other SQL modules to access a LDAP database
1032 # through a unified API.
1033 # This modules is in extras. Re-run configure with:
1034 # ./configure --enable-extras=m_ldap.cpp
1035 # and run make install, then uncomment this module to enable it.
1037 #<module name="ldap">
1038 #<database module="ldap" id="ldapdb" server="ldap://localhost" binddn="cn=Manager,dc=inspircd,dc=org" bindauth="mysecretpass" searchscope="subtree">
1039 # The server parameter indicates the LDAP server to connect to. The #
1040 # ldap:// style scheme before the hostname proper is MANDATORY. #
1042 # The binddn and bindauth indicate the DN to bind to for searching, #
1043 # and the password for the distinguished name. Some LDAP servers will #
1044 # allow anonymous searching in which case these two values do not #
1045 # need defining, otherwise they should be set similar to the examples #
1048 # The searchscope value indicates the subtree to search under. On our #
1049 # test system this is 'subtree'. Your mileage may vary. #
1051 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1052 # LDAP authentication module: Adds the ability to authenticate users #
1054 #<module name="ldapauth">
1058 # <ldapauth dbid="ldapdb" #
1059 # baserdn="ou=People,dc=brainbox,dc=cc" #
1061 # allowpattern="Guest* Bot*" #
1062 # killreason="Access denied" #
1064 # host="$uid.$ou.inspircd.org" #
1065 # useusername="no"> #
1067 # <ldapwhitelist cidr="10.42.0.0/16"> #
1069 # <ldaprequire attribute="attr" value="val"> #
1071 # The baserdn indicates the base DN to search in for users. Usually #
1072 # this is 'ou=People,dc=yourdomain,dc=yourtld'. #
1074 # The attribute value indicates the attribute which is used to locate #
1075 # a user account by name. On POSIX systems this is usually 'uid'. #
1077 # The allowpattern value allows you to specify a space separated list #
1078 # of wildcard masks which will always be allowed to connect #
1079 # regardless of if they have an account, for example guest and bot #
1082 # The useusername setting chooses whether the user's username or #
1083 # nickname is used when locating a user account, if a username isn't #
1084 # provided in PASS. #
1086 # Killreason indicates the QUIT reason to give to users if they fail #
1087 # to authenticate. #
1089 # Setting the verbose value causes an oper notice to be sent out for #
1090 # every failed authentication to the server, with an error string. #
1092 # ldapwhitelist indicates that clients connecting from an IP in the #
1093 # provided CIDR do not need to authenticate against LDAP. It can be #
1094 # repeated to whitelist multiple CIDRs. #
1096 # ldaprequire allows further filtering on the LDAP user, by requiring #
1097 # certain LDAP attibutes to have a given value. It can be repeated, #
1098 # in which case the list will act as an OR list, that is, the #
1099 # authentication will succeed if any of the requirements in the list #
1102 # host allows you to change the displayed host of users connecting #
1103 # from ldap. The string supplied takes formatters which are replaced #
1104 # from the DN. For instance, if your DN looks like: #
1105 # uid=w00t,ou=people,dc=inspircd,dc=org, then the formatters uid, ou #
1106 # and dc will be available to you. If a key is given multiple times #
1107 # in the DN, the last appearance will take precedence. #
1109 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1110 # LDAP oper configuration module: Adds the ability to authenticate #
1112 #<module name="ldapoper">
1116 # <ldapoper dbid="ldapdb"
1117 # baserdn="ou=People,dc=brainbox,dc=cc"
1120 # Available configuration items are identical to the same items in #
1121 # ldapauth above (except for the verbose setting, that is only #
1122 # supported in ldapauth). #
1123 # Please always specify a password in your <oper> tags even if the #
1124 # opers are to be authenticated via LDAP, so in case this module is #
1125 # not loaded the oper accounts are still protected by a password. #
1127 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1128 # Lock server module: Adds /LOCKSERV and /UNLOCKSERV commands that #
1129 # are used to temporarily close/open the server for new connections. #
1130 # These commands require that the /LOCKSERV and /UNLOCKSERV commands #
1131 # are specified in a <class> tag that the oper is part of. This is so #
1132 # you can control who has access to this possible dangerous command. #
1133 # If your server is locked and you get disconnected, do a REHASH from #
1134 # shell to open up again. #
1135 # This module is oper-only.
1136 #<module name="lockserv">
1138 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1139 # Map hiding module: replaces /MAP and /LINKS output to users with a #
1140 # message to see a website, set by maphide="http://test.org/map" in #
1141 # the <security> tag, instead. #
1142 #<module name="maphide">
1144 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1145 # Message flood module: Adds message/notice flood protection via
1147 #<module name="messageflood">
1149 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1150 # MLOCK module: Adds support for server-side enforcement of services
1151 # side MLOCKs. Basically, this module suppresses any mode change that
1152 # would likely be immediately bounced by services.
1153 #<module name="mlock">
1155 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1156 # Modenotice module: Adds the /MODENOTICE command that allows opers to
1157 # send notices to all users having the given user mode(s) set.
1158 #<module name="modenotice">
1160 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1161 # Monitor module: Adds support for MONITOR which is used by clients to
1162 # maintain notify lists.
1163 #<module name="monitor">
1165 # Set the maximum number of entries on a user's monitor list below.
1166 #<monitor maxentries="30">
1168 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1169 # MySQL module: Allows other SQL modules to access MySQL databases
1170 # through a unified API.
1171 # This module is in extras. Re-run configure with:
1172 # ./configure --enable-extras=m_mysql.cpp
1173 # and run make install, then uncomment this module to enable it.
1174 #<module name="mysql">
1176 #-#-#-#-#-#-#-#-#-#-#-#- SQL CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#-#
1178 # mysql is more complex than described here, see the wiki for more #
1179 # info: http://wiki.inspircd.org/Modules/mysql #
1181 #<database module="mysql" name="mydb" user="myuser" pass="mypass" host="localhost" id="my_database2">
1183 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1184 # Named modes module: Allows for the display and set/unset of channel
1185 # modes via long-form mode names via +Z and the /PROP command.
1186 # For example, to set a ban, do /mode #channel +Z ban=foo!bar@baz or
1187 # /PROP #channel ban=foo!bar@baz
1188 #<module name="namedmodes">
1190 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1191 # NAMESX module: Provides support for the NAMESX extension which allows
1192 # clients to see all the prefixes set on a user without getting confused.
1193 # This is supported by mIRC, x-chat, klient, and maybe more.
1194 #<module name="namesx">
1196 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1197 # National characters module:
1198 # 1) Allows using national characters in nicknames.
1199 # 2) Allows using custom (national) casemapping over the network.
1200 #<module name="nationalchars">
1202 # file - Location of the file which contains casemapping rules. If this
1203 # is a relative path then it is relative to "<PWD>/../locales"
1204 # on UNIX and "<PWD>/locales" on Windows.
1205 # casemapping - The name of the casemapping sent to clients in the 005
1206 # numeric. If this is not set then it defaults to the name
1207 # of the casemapping file unless the file name contains a
1208 # space in which case you will have to specify it manually.
1209 #<nationalchars file="bynets/russian-w1251-charlink" casemapping="ru_RU.cp1251-charlink">
1211 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1212 # Nickchange flood protection module: Provides channel mode +F X:Y
1213 # which allows up to X nick changes in Y seconds.
1214 #<module name="nickflood">
1216 # The number of seconds to prevent nick changes for:
1217 #<nickflood duration="1m">
1219 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1220 # Nicklock module: Let opers change a user's nick and then stop that
1221 # user from changing their nick again until unlocked.
1222 # This module is oper-only.
1223 # To use, NICKLOCK and NICKUNLOCK must be in one of your oper class blocks.
1224 #<module name="nicklock">
1226 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1227 # No CTCP module: Adds the channel mode +C to block CTCPs and extban
1228 # 'C' to block CTCPs sent by specific users.
1229 #<module name="noctcp">
1231 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1232 # No kicks module: Adds the +Q channel mode and the Q: extban to deny
1233 # certain users from kicking.
1234 #<module name="nokicks">
1236 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1237 # No nicks module: Adds the +N channel mode, as well as the 'N' extban.
1238 # +N stops all users from changing their nick, the N extban stops
1239 # anyone from matching a +b N:nick!user@host mask from changing their
1241 #<module name="nonicks">
1243 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1244 # No part message module: Adds extban 'p' to block part messages from #
1246 #<module name="nopartmsg">
1248 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1249 # No notice module: Adds the channel mode +T and the extban 'T' to
1250 # block specific users from noticing the channel.
1251 #<module name="nonotice">
1253 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1254 # Network business join module:
1255 # Allows an oper to join a channel using /OJOIN, giving them +Y on the
1256 # channel which makes them immune to kick/deop/etc.
1257 #<module name="ojoin">
1259 # Specify the prefix that +Y will grant here.
1260 # Leave 'prefix' empty if you do not wish +Y to grant a prefix.
1261 # If 'notice' is set to on, upon /OJOIN, the server will notice the
1262 # channel saying that the oper is joining on network business.
1263 # If 'op' is set to on, it will give them +o along with +Y.
1264 #<ojoin prefix="!" notice="yes" op="yes">
1266 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1267 # Oper channels mode: Adds the +O channel mode and extban O:<mask>
1268 # to ban, except, etc. specific oper types. For example
1269 # /mode #channel +iI O:* is equivalent to channel mode +O, but you
1270 # may also set +iI O:AdminTypeOnly to only allow admins.
1271 # Modes +I and +e work in a similar fashion.
1272 #<module name="operchans">
1274 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1275 # Oper join module: Auto-joins opers to a channel upon oper-up.
1276 # This module is oper-only. For the user equivalent, see the conn_join
1278 #<module name="operjoin">
1280 #-#-#-#-#-#-#-#-#-#-# OPERJOIN CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
1282 # If you are using the operjoin module, specify options here: #
1284 # channel - The channel name to join, can also be a comma #
1285 # separated list e.g. "#channel1,#channel2". #
1287 # override - If on, lets the oper join walking thru any modes #
1288 # that might be set, even bans. #
1290 #<operjoin channel="#channel" override="no">
1292 # Alternatively you can use the autojoin="channellist" in a <type> #
1293 # tag to set specific autojoins for a type of oper, for example: #
1295 #<type name="Helper" autojoin="#help" classes="...">
1297 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1298 # Oper log module: Logs all oper commands to the server log (with log
1299 # type "m_operlog" at default loglevel), and optionally to the 'r'
1301 # This module is oper-only.
1302 #<module name="operlog">
1304 # If the following option is on then all oper commands will be sent to
1305 # the snomask 'r'. The default is off.
1306 #<operlog tosnomask="off">
1308 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1309 # Oper prefixing module: Adds a channel prefix mode +y which is given
1310 # to all IRC operators automatically on all channels they are in.
1311 # This prefix mode is more powerful than channel op and other regular
1314 # Load this module if you want all your IRC operators to have channel
1316 #<module name="operprefix">
1318 # You may additionally customise the prefix character.
1319 #<operprefix prefix="!">
1321 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1322 # Oper MOTD module: Provides support for separate message of the day
1324 # This module is oper-only.
1325 #<module name="opermotd">
1327 #-#-#-#-#-#-#-#-#-#-# OPERMOTD CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
1329 # If you are using the opermotd module, specify the motd here. #
1331 # onoper - If on, the message is sent on /OPER, otherwise it's #
1332 # only sent when /OPERMOTD is used. #
1334 # processcolors - Allow color codes to be processed in the opermotd. #
1335 # Read the comment above <connect:allowmotdcolors> in #
1336 # inspircd.conf.example for details. #
1338 #<opermotd file="examples/opermotd.txt.example" onoper="yes" processcolors="false">
1340 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1341 # Override module: Adds support for oper override.
1342 # This module is oper-only.
1343 #<module name="override">
1345 #-#-#-#-#-#-#-#-#-#-# OVERRIDE CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
1347 # override is too complex it describe here, see the wiki: #
1348 # http://wiki.inspircd.org/Modules/override #
1350 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1351 # Oper levels module: Gives each oper a level and prevents actions
1352 # being taken by lower level opers against higher level opers.
1353 # Specify the level as the 'level' parameter of the <type> tag.
1354 # This module is oper-only.
1355 #<module name="operlevels">
1357 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1358 # Oper modes module: Allows you to specify modes to add/remove on oper.
1359 # Specify the modes as the 'modes' parameter of the <type> tag
1360 # and/or as the 'modes' parameter of the <oper> tag.
1361 # This module is oper-only. For the user equivalent, see the
1362 # conn_umodes module.
1363 #<module name="opermodes">
1365 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1366 # Password forwarding module: Forwards a password users can send on
1367 # connect to the specified client below. The client is usually NickServ
1368 # and this module is usually used to authenticate users with NickServ
1369 # using their connect password.
1370 #<module name="passforward">
1373 # nick: nick to forward connect passwords to.
1376 # forwardmsg: Message to send to users using a connect password.
1377 # $nick will be the users' nick, $nickrequired will be the nick
1378 # of where the password is going (the nick above).
1379 # You can also use $user for the user ident string.
1380 forwardmsg="NOTICE $nick :*** Forwarding PASS to $nickrequired"
1382 # cmd: Command for the user to run when it receives a connect
1384 cmd="PRIVMSG $nickrequired :IDENTIFY $pass">
1386 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1387 # Password hash module: Allows hashed passwords to be used.
1388 # To be useful, a hashing module like bcrypt also needs to be loaded.
1389 #<module name="password_hash">
1391 #-#-#-#-#-#-#-#-#-# PASSWORD HASH CONFIGURATION #-#-#-#-#-#-#-#-#-#-#-#
1393 # To use this module, you must define a hash type for each oper's
1394 # password you want to hash. For example:
1396 # <oper name="Brain"
1397 # host="ident@dialup15.isp.test.com"
1399 # password="$2a$10$Mss9AtHHslZTLBrXqM0FB.JBwD.UTSu8A48SfrY9exrpxbsRiRTbO"
1402 # If you are using a hash algorithm which does not perform salting you can use
1403 # HMAC to salt your passwords in order to prevent them from being looked up in
1406 # hash="hmac-sha256" password="lkS1Nbtp$CyLd/WPQXizsbxFUTqFRoMvaC+zhOULEeZaQkUJj+Gg"
1408 # Generate hashes using the /MKPASSWD command on the server.
1409 # Don't run it on a server you don't trust with your password.
1411 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1412 # PBKDF2 module: Allows other modules to generate PBKDF2 hashes,
1413 # usually for cryptographic uses and security.
1414 # This module relies on other hash providers (e.g. SHA256).
1415 #<module name="pbkdf2">
1417 # iterations: Iterations the hashing function runs when generating new
1419 # length: Length in bytes of the derived key.
1420 #<pbkdf2 iterations="12288" length="32">
1421 # You can override these values with specific values
1422 # for specific providers if you want to. Example given for SHA256.
1423 #<pbkdf2prov hash="sha256" iterations="24576">
1425 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1426 # Permanent channels module: Channels with the permanent channel mode
1427 # will remain open even after everyone else has left the channel, and
1428 # therefore keep things like modes, ban lists and topic. Permanent
1429 # channels -may- need support from your Services package to function
1430 # properly with them. This adds channel mode +P.
1431 # This module is oper-only.
1432 #<module name="permchannels">
1434 # If you like, this module can write a config file of permanent channels
1435 # whenever +P is set, unset, or the topic/modes on a +P channel is changed.
1436 # If you want to do this, set the filename below, and uncomment the include.
1438 # If 'listmodes' is true then all list modes (+b, +I, +e, +g...) will be
1439 # saved. Defaults to false.
1440 #<permchanneldb filename="permchannels.conf" listmodes="true">
1441 #<include file="permchannels.conf">
1443 # You may also create channels on startup by using the <permchannels> block.
1444 #<permchannels channel="#opers" modes="isP" topic="Opers only.">
1446 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1447 # PostgreSQL module: Allows other SQL modules to access PgSQL databases
1448 # through a unified API.
1449 # This module is in extras. Re-run configure with:
1450 # ./configure --enable-extras=m_pgsql.cpp
1451 # and run make install, then uncomment this module to enable it.
1452 #<module name="pgsql">
1454 #-#-#-#-#-#-#-#-#-#-#-#- SQL CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#-#
1456 # pgsql is more complex than described here, see the wiki for #
1457 # more: http://wiki.inspircd.org/Modules/pgsql #
1459 #<database module="pgsql" name="mydb" user="myuser" pass="mypass" host="localhost" id="my_database" ssl="no">
1461 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1462 # Muteban: Implements extended ban 'm', which stops anyone matching
1463 # a mask like +b m:nick!user@host from speaking on channel.
1464 #<module name="muteban">
1466 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1467 # Random quote module: Provides a random quote on connect.
1468 # NOTE: Some of these may mimic fatal errors and confuse users and
1469 # opers alike - BEWARE!
1470 #<module name="randquote">
1472 #-#-#-#-#-#-#-#-#-#- RANDOMQUOTES CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
1474 # Optional - If you specify to use the randquote module, then specify #
1475 # below the path to the quotes file. #
1477 #<randquote file="quotes.txt">
1479 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1480 # Redirect module: Adds channel redirection mode +L. #
1481 # Optional: <redirect:antiredirect> to add usermode +L to stop forced #
1482 # redirection and instead print an error. #
1484 # Note: You can not update this with a simple rehash, it requires #
1485 # reloading the module for it to take effect. #
1486 # This also breaks linking to servers that do not have the option. #
1487 # This defaults to false for the 2.0 version, it will be enabled in #
1488 # all the future versions. #
1489 #<module name="redirect">
1490 #<redirect antiredirect="true">
1492 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1493 # Regular expression provider for glob or wildcard (?/*) matching.
1494 # You must have at least 1 provider loaded to use the filter or rline
1495 # modules. This module has no additional requirements, as it uses the
1496 # matching already present in InspIRCd core.
1497 #<module name="regex_glob">
1499 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1500 # Regular expression provider for PCRE (Perl-Compatible Regular
1501 # Expressions). You need libpcre installed to compile and load this
1502 # module. You must have at least 1 provider loaded to use the filter or
1504 #<module name="regex_pcre">
1506 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1507 # Regular Expression Provider for RE2 Regular Expressions.
1508 # You need libre2 installed and in your include/library paths in order
1509 # to compile and load this module.
1510 #<module name="regex_re2">
1512 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1513 # Regular expression provider for POSIX regular expressions.
1514 # You shouldn't need any additional libraries on a POSIX-compatible
1515 # system (i.e.: any Linux, BSD, but not Windows). You must have at
1516 # least 1 provider loaded to use filter or rline.
1517 # On POSIX-compliant systems, regex syntax can be found by using the
1518 # command: 'man 7 regex'.
1519 #<module name="regex_posix">
1521 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1522 # Regular expression provider for C++11 std::regex regular expressions.
1523 # This module works on any fully compliant implementation of the C++11
1524 # std::regex container. Examples for such are Visual C++ 2010 and newer
1525 # but not libstdc++ (which GCC uses).
1526 # You should verify that std::regex is supported by your setup before
1527 # using this module, as it may compile normally but won't do anything
1528 # on some implementations.
1529 #<module name="regex_stdlib">
1531 # Specify the regular expression engine to use here. Valid settings are
1532 # bre, ere, awk, grep, egrep, ecmascript (default if not specified).
1533 #<stdregex type="ecmascript">
1535 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1536 # Regular expression provider for TRE regular expressions.
1537 # This is the same regular expression engine used by UnrealIRCd, so
1538 # if you are most familiar with the syntax of /SPAMFILTER from there,
1539 # this is the provider you want. You need libtre installed in order
1540 # to compile and load this module.
1541 #<module name="regex_tre">
1543 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1544 # Registered users only channel creation module. If enabled, only
1545 # registered users and opers can create new channels.
1547 # You probably *DO NOT* want to load this module on a public network.
1549 #<module name="regonlycreate">
1551 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1552 # Remove module: Adds the /REMOVE command which is a peaceful
1553 # alternative to /KICK.
1554 #<module name="remove">
1556 # supportnokicks: If true, /REMOVE is not allowed on channels where the
1557 # nokicks (+Q) mode is set. Defaults to false.
1558 # protectedrank: Members having this rank or above may not be /REMOVE'd
1559 # by anyone. Set to 0 to disable this feature. Defaults to 50000.
1560 #<remove supportnokicks="true" protectedrank="50000">
1562 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1563 # A module to block, kick or ban upon similar messages being uttered several times.
1564 # Syntax [~*][lines]:[sec]{[:difference]}{[:matchlines]}
1565 # ~ is to block, * is to ban, default is kick.
1566 # 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
1567 # seconds - How old the message has to be before it's invalidated.
1568 # distance - Edit distance, in percent, between two strings to trigger on.
1569 # matchlines - When set, the function goes into mode 2. In this mode the function will trigger if this many of the last <lines> matches.
1571 # As this module can be rather CPU-intensive, it comes with some options.
1572 # maxbacklog - Maximum size that can be specified for backlog. 0 disables multiline matching.
1573 # maxdistance - Max percentage of difference between two lines we'll allow to match. Set to 0 to disable edit-distance matching.
1574 # maxlines - Max lines of backlog to match against.
1575 # maxtime - Maximum period of time a user can set. 0 to allow any.
1576 # size - Maximum number of characters to check for, can be used to truncate messages
1577 # before they are checked, resulting in less CPU usage. Increasing this beyond 512
1578 # doesn't have any effect, as the maximum length of a message on IRC cannot exceed that.
1579 #<repeat maxbacklog="20" maxlines="20" maxdistance="50" maxtime="0" size="512">
1580 #<module name="repeat">
1582 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1583 # Restricted channels module: Allows only opers to create channels.
1585 # You probably *DO NOT* want to load this module on a public network.
1587 #<module name="restrictchans">
1589 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1590 # Restrict message module: Allows users to only message opers.
1592 # You probably *DO NOT* want to load this module on a public network.
1594 #<module name="restrictmsg">
1596 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1597 # R-Line module: Ban users through regular expression patterns.
1598 #<module name="rline">
1600 #-#-#-#-#-#-#-#-#-#-#-#- RLINE CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#-#
1602 # If you wish to re-check a user when they change nickname (can be
1603 # useful under some situations, but *can* also use CPU with more users
1604 # on a server) then set 'matchonnickchange' to yes.
1605 # Also, this is where you set what Regular Expression engine is to be
1606 # used. If you ever change it while running, all of your R-Lines will
1607 # be wiped. This is the regex engine used by all R-Lines set, and
1608 # regex_<engine> must be loaded, or rline will be non-functional
1609 # until you load it or change the engine to one that is loaded.
1611 #<rline matchonnickchange="yes" engine="pcre">
1613 # Generally, you will NOT want to use 'glob' here, as this turns
1614 # rline into just another gline. The exceptions are that rline will
1615 # always use the full "nick!user@host realname" string, rather than only
1616 # user@host, but beware that only the ? and * wildcards are available,
1617 # and are the only way to specify where the space can occur if you do
1618 # use glob. For this reason, is recommended to use a real regex engine
1619 # so that at least \s or [[:space:]] is available.
1621 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1622 # RMODE module: Adds the /RMODE command
1623 # Allows channel mods to remove list modes en masse.
1624 # Syntax: /rmode <channel> <mode> [pattern]
1625 # E.g. '/rmode #Channel b m:*' will remove all mute-extbans on the channel.
1626 #<module name="rmode">
1628 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1629 # SAJOIN module: Adds the /SAJOIN command which forcibly joins a user
1630 # to the given channel.
1631 # This module is oper-only.
1632 # To use, SAJOIN must be in one of your oper class blocks.
1633 # Opers need the users/sajoin-others priv to be able to /SAJOIN users
1634 # other than themselves.
1635 #<module name="sajoin">
1637 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1638 # SAKICK module: Adds the /SAKICK command which kicks a user from the
1640 # This module is oper-only.
1641 # To use, SAKICK must be in one of your oper class blocks.
1642 #<module name="sakick">
1644 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1645 # SAMODE module: Adds the /SAMODE command which allows server operators
1646 # to change modes on a channel without requiring them to have any
1647 # channel priviliges. Also allows changing user modes for any user.
1648 # This module is oper-only.
1649 # To use, SAMODE must be in one of your oper class blocks.
1650 #<module name="samode">
1652 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1653 # SANICK module: Adds the /SANICK command which allows opers to change
1655 # This module is oper-only.
1656 # To use, SANICK must be in one of your oper class blocks.
1657 #<module name="sanick">
1659 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1660 # SAPART module: Adds the /SAPART command which forcibly parts a user
1662 # This module is oper-only.
1663 # To use, SAPART must be in one of your oper class blocks.
1664 #<module name="sapart">
1666 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1667 # SAQUIT module: Adds the /SAQUIT command which forcibly quits a user.
1668 # This module is oper-only.
1669 # To use, SAQUIT must be in one of your oper class blocks.
1670 #<module name="saquit">
1672 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1673 # SATOPIC module: Adds the /SATOPIC command which allows changing the
1674 # topic on a channel without requiring any channel priviliges.
1675 # This module is oper-only.
1676 # To use, SATOPIC must be in one of your oper class blocks.
1677 #<module name="satopic">
1679 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1680 # SASL authentication module: Provides support for IRC Authentication
1681 # Layer via AUTHENTICATE. Note: You also need to have cap loaded
1683 #<module name="sasl">
1685 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1686 # Secure list module: Prevent /LIST in the first minute of connection,
1687 # crippling most spambots and trojan spreader bots.
1688 #<module name="securelist">
1690 #-#-#-#-#-#-#-#-#-# SECURELIST CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#-#
1692 # Securelist can be harmful to some IRC search engines. To prevent #
1693 # securelist blocking these sites from listing, define exception tags #
1695 #<securehost exception="*@*.netsplit.de">
1696 #<securehost exception="*@*.ircdriven.com">
1697 #<securehost exception="*@*.irc-source.com">
1699 # Define the following variable to change how long a user must wait #
1700 # before issuing a LIST. If not defined, defaults to 60 seconds. #
1702 #<securelist waittime="1m"> #
1704 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1705 # Servprotect module: Provides support for Austhex style +k /
1706 # UnrealIRCD +S services mode.
1707 #<module name="servprotect">
1709 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1710 # See nicks module: Adds snomask +n and +N which show local and remote
1712 # This module is oper-only.
1713 #<module name="seenicks">
1715 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1716 # Set idle module: Adds a command for opers to change their idle time.
1717 # This module is oper-only.
1718 # To use, SETIDLE must be in one of your oper class blocks.
1719 #<module name="setidle">
1721 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1722 # Services support module: Adds several usermodes such as +R and +M.
1723 # This module implements the 'identified' state via account names,
1724 # and is similar in operation to the way asuka and ircu handle services.
1726 # At the same time, this offers +r for users and channels to mark them
1727 # as identified separately from the idea of a master account, which
1728 # can be useful for services which are heavily nick-as-account centric.
1730 # Also of note is that this module implements two extbans:
1731 # +b R: (stop matching account names from joining)
1732 # +b U:n!u@h (blocks matching unregistered users)
1734 #<module name="services_account">
1736 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1737 # Sethost module: Adds the /SETHOST command.
1738 # This module is oper-only.
1739 # To use, SETHOST must be in one of your oper class blocks.
1740 # See the chghost module for how to customise valid chars for hostnames.
1741 #<module name="sethost">
1743 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1744 # Setident module: Adds the /SETIDENT command.
1745 # This module is oper-only.
1746 # To use, SETIDENT must be in one of your oper class blocks.
1747 #<module name="setident">
1749 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1750 # SETNAME module: Adds the /SETNAME command.
1751 #<module name="setname">
1753 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1754 # Serverban: Implements extended ban 's', which stops anyone connected
1755 # to a server matching a mask like +b s:server.mask.here from joining.
1756 #<module name="serverban">
1758 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1759 # SHA1 module: Allows other modules to generate SHA1 hashes.
1760 # Required by the WebSocket module.
1761 #<module name="sha1">
1763 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1764 # Showfile: Provides support for showing a text file to users when #
1765 # they enter a command. #
1766 # This module adds one command for each <showfile> tag that shows the #
1767 # given file to the user as a series of messages or numerics. #
1768 #<module name="showfile"> #
1770 #-#-#-#-#-#-#-#-#-#-# SHOWFILE CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#-#
1772 # name - The name of the command which displays this file. This is #
1773 # the only mandatory setting, all others are optional. #
1774 # file - The text file to be shown to the user. #
1775 # By default same as the command name. #
1776 # method - How should the file be shown? #
1777 # * numeric: Send contents using a numeric #
1778 # (similar to /MOTD; the default). #
1779 # * notice: Send contents as a series of notices. #
1780 # * msg: Send contents as a series of private messages. #
1781 # colors - If true, color codes (\c, \b, \u, etc.) will be processed #
1782 # and sent as ANSI colors. If false (default) the file will #
1783 # be displayed as-is. #
1785 # When using the method "numeric", the following extra settings are #
1788 # introtext - Introductory line, "Showing <name>" by default. #
1789 # intronumeric - Numeric used for the introductory line. #
1790 # numeric - Numeric used for sending the text itself. #
1791 # endtext - Ending line, "End of <name>" by default. #
1792 # endnumeric - Numeric used for the ending line. #
1794 #<showfile name="RULES"
1797 # introtext="Server rules:"
1798 # endtext="End of server rules.">
1800 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1801 # Show whois module: Adds the +W usermode which allows opers to see
1802 # when they are /WHOIS'd.
1803 # This module is oper-only by default.
1804 #<module name="showwhois">
1806 # If you wish, you may also let users set this mode. Only opers with the
1807 # users/auspex priv will see real hosts of people, though.
1808 #<showwhois opersonly="yes"
1810 # You may also set whether or not users should receive whois notices,
1811 # should they be /WHOIS'd by an oper.
1812 #showfromopers="yes">
1814 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1815 # Shun module: Provides the /SHUN command, which stops a user from
1816 # executing all except configured commands.
1817 # This module is oper-only.
1818 # To use, SHUN must be in one of your oper class blocks.
1819 #<module name="shun">
1821 # You may also configure which commands you wish a user to be able to
1822 # perform when shunned. It should be noted that if a shunned user
1823 # issues QUIT or PART then their message will be removed, as if they
1824 # did not issue one.
1826 # You can optionally let the user know that their command was blocked.
1828 # You may also let SHUN affect opers (defaults to no).
1829 #<shun enabledcommands="PING PONG QUIT PART JOIN" notifyuser="yes" affectopers="no">
1831 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1832 # SSL channel mode module: Adds support for SSL-only channels via
1833 # channel mode +z and the 'z' extban which matches SSL client
1834 # certificate fingerprints.
1835 # Does not do anything useful without a working SSL module and the
1836 # sslinfo module (see below).
1837 #<module name="sslmodes">
1839 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1840 # GnuTLS SSL module: Adds support for SSL connections using GnuTLS,
1841 # if enabled. You must answer 'yes' in ./configure when asked or
1842 # manually symlink the source for this module from the directory
1843 # src/modules/extra, if you want to enable this, or it will not load.
1844 #<module name="ssl_gnutls">
1846 #-#-#-#-#-#-#-#-#-#-#- GNUTLS CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#
1848 # ssl_gnutls is too complex to describe here, see the wiki: #
1849 # http://wiki.inspircd.org/Modules/ssl_gnutls #
1851 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1852 # SSL info module: Allows users to retrieve information about other
1853 # users' peer SSL certificates and keys. This can be used by client
1854 # scripts to validate users. For this to work, one of ssl_gnutls
1855 # or ssl_openssl must be loaded. This module also adds the
1856 # "* <user> is using a secure connection" whois line, the ability for
1857 # opers to use SSL cert fingerprints to verify their identity and the
1858 # ability to force opers to use SSL connections in order to oper up.
1859 # It is highly recommended to load this module if you use SSL on your
1861 # For how to use the oper features, please see the first example <oper> tag
1862 # in opers.conf.example.
1864 #<module name="sslinfo">
1866 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1867 # mbedTLS SSL module: Adds support for SSL/TLS connections using mbedTLS.
1868 #<module name="ssl_mbedtls">
1870 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1871 # OpenSSL SSL module: Adds support for SSL connections using OpenSSL,
1872 # if enabled. You must answer 'yes' in ./configure when asked or symlink
1873 # the source for this module from the directory src/modules/extra, if
1874 # you want to enable this, or it will not load.
1875 #<module name="ssl_openssl">
1877 #-#-#-#-#-#-#-#-#-#-#- OPENSSL CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#
1879 # ssl_openssl is too complex to describe here, see the wiki: #
1880 # http://wiki.inspircd.org/Modules/ssl_openssl #
1882 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1883 # Strip color module: Adds channel mode +S that strips color codes and
1884 # all control codes except CTCP from all messages sent to the channel.
1885 #<module name="stripcolor">
1887 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1888 # Silence module: Adds support for the /SILENCE command, which allows
1889 # users to have a server-side ignore list for their client.
1890 #<module name="silence">
1892 # Set the maximum number of entries allowed on a user's silence list.
1893 #<silence maxentries="32"
1895 # Whether messages from U-lined servers will bypass silence masks.
1898 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1899 # SQLite3 module: Allows other SQL modules to access SQLite3 #
1900 # databases through a unified API. #
1901 # This module is in extras. Re-run configure with: #
1902 # ./configure --enable-extras=m_sqlite.cpp
1903 # and run make install, then uncomment this module to enable it. #
1905 #<module name="sqlite3">
1907 #-#-#-#-#-#-#-#-#-#-#-#- SQL CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#-#
1909 # sqlite is more complex than described here, see the wiki for more #
1910 # info: http://wiki.inspircd.org/Modules/sqlite3 #
1912 #<database module="sqlite" hostname="/full/path/to/database.db" id="anytext">
1914 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1915 # SQL authentication module: Allows IRCd connections to be tied into
1916 # a database table (for example a forum).
1917 # This module is in extras. Re-run configure with:
1918 # ./configure --enable-extras=m_sqlauth.cpp
1919 # and run make install, then uncomment this module to enable it.
1921 #<module name="sqlauth">
1923 #-#-#-#-#-#-#-#-#-#-#- SQLAUTH CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#
1925 # sqlauth is too complex to describe here, see the wiki: #
1926 # http://wiki.inspircd.org/Modules/sqlauth #
1928 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1929 # SQL oper module: Allows you to store oper credentials in an SQL table
1930 # This module is in extras. Re-run configure with:
1931 # ./configure --enable-extras=m_sqloper.cpp
1932 # and run make install, then uncomment this module to enable it.
1934 #<module name="sqloper">
1936 #-#-#-#-#-#-#-#-#-#-#- SQLOPER CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#
1938 # dbid - Database ID to use (see SQL modules). #
1939 # hash - Hashing provider to use for password hashing. #
1941 # See also: http://wiki.inspircd.org/Modules/sqloper #
1943 #<sqloper dbid="1" hash="bcrypt">
1945 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1946 # StartTLS module: Implements STARTTLS, which allows clients #
1947 # connected to non SSL enabled ports to enable SSL, if a proper SSL #
1948 # module is loaded (either ssl_gnutls or ssl_openssl). #
1949 #<module name="starttls">
1951 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1952 # SVSHold module: Implements SVSHOLD. Like Q:Lines, but can only be #
1953 # added/removed by Services. #
1954 #<module name="svshold">
1955 # SVSHOLD does not generate server notices by default, you can turn
1956 # notices on by uncommenting the next line.
1957 #<svshold silent="false">
1959 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1960 # SWHOIS module: Allows you to add arbitrary lines to user WHOIS.
1961 # This module is oper-only.
1962 # To use, SWHOIS must be in one of your oper class blocks.
1963 #<module name="swhois">
1965 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1966 # Timed bans module: Adds timed channel bans with the /TBAN command.
1967 #<module name="timedbans">
1969 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1970 # Test line module: Adds the /TLINE command, used to test how many
1971 # users a /GLINE or /ZLINE etc. would match.
1972 # This module is oper-only.
1973 # To use, TLINE must be in one of your oper class blocks.
1974 #<module name="tline">
1976 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1977 # Topiclock module: implements server-side topic locking to achieve deeper
1978 # integration with services packages.
1979 #<module name="topiclock">
1981 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1982 # UHNAMES support module: Adds support for the IRCX style UHNAMES
1983 # extension, which displays ident and hostname in the names list for
1984 # each user, saving clients from doing a WHO on the channel.
1985 # If a client does not support UHNAMES it will not enable it, this will
1986 # not break incompatible clients.
1987 #<module name="uhnames">
1989 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1990 # Uninvite module: Adds the /UNINVITE command which lets users remove
1991 # pending invites from channels without waiting for the user to join.
1992 #<module name="uninvite">
1994 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1995 # Userip module: Adds the /USERIP command.
1996 # Allows users to query their own IP, also allows opers to query the IP
1998 #<module name="userip">
2000 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2001 # Vhost module: Adds the VHOST command which allows for adding virtual
2002 # hosts which are accessible using a username and password in the config.
2003 #<module name="vhost">
2005 #-#-#-#-#-#-#-#-#-#-#- VHOST CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#-#
2007 # user - Username for the vhost. #
2009 # pass - Password for the vhost. #
2011 # hash - The hash for the specific user (optional) #
2012 # password_hash and a hashing module must be loaded for #
2015 # host - Vhost to set. #
2017 #<vhost user="some_username" pass="some_password" host="some.host.test.cc">
2018 #<vhost user="foo" password="$2a$10$iTuYLT6BRhRlOgzfsW9oPe62etW.oXwSpyKw5rJit64SGZanLXghO" hash="bcrypt" host="some.other.host.example.com">
2020 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2021 # Watch module: Adds the WATCH command, which is used by clients to
2022 # maintain notify lists.
2023 #<module name="watch">
2025 # Set the maximum number of entries on a user's watch list below.
2026 #<watch maxentries="32">
2028 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2029 # WebSocket module: Adds HTML5 WebSocket support.
2030 # Specify hook="websocket" in a <bind> tag to make that port accept
2031 # WebSocket connections. Compatible with SSL/TLS.
2032 # Requires SHA-1 hash support available in the sha1 module.
2033 #<module name="websocket">
2035 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2036 # XLine database: Stores all *Lines (G/Z/K/R/any added by other modules)
2037 # in a file which is re-loaded on restart. This is useful
2038 # for two reasons: it keeps bans so users may not evade them, and on
2039 # bigger networks, server connections will take less time as there will
2040 # be a lot less bans to apply - as most of them will already be there.
2041 #<module name="xline_db">
2043 # Specify the filename for the xline database here.
2044 #<xlinedb filename="xline.db">
2046 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2047 # ____ _ _____ _ _ ____ _ _ _ #
2048 # | _ \ ___ __ _ __| | |_ _| |__ (_)___ | __ )(_) |_| | #
2049 # | |_) / _ \/ _` |/ _` | | | | '_ \| / __| | _ \| | __| | #
2050 # | _ < __/ (_| | (_| | | | | | | | \__ \ | |_) | | |_|_| #
2051 # |_| \_\___|\__,_|\__,_| |_| |_| |_|_|___/ |____/|_|\__(_) #
2053 # To link servers to InspIRCd, you MUST load the spanningtree module. #
2054 # If you don't do this, server links will NOT work at all. #
2055 # This is by design, to allow for the implementation of other linking #
2056 # protocols in modules in the future. #
2058 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2059 # Spanning tree module: Allows linking of servers using the spanning
2060 # tree protocol (see the READ THIS BIT section above).
2061 # You will almost always want to load this.
2063 #<module name="spanningtree">
projects / user / henk / code / inspircd.git / blob