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 many seconds between two messages to force #
235 # them 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 (in seconds) that must pass since #
285 # the last notification sent to a user before he can #
286 # be sent another. Default is 60 (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="pass" mask="www.example.com"> # Get IP from PASS
338 # <cgihost type="ident" mask="otherbox.example.com"> # Get IP from ident
339 # <cgihost type="passfirst" mask="www.example.com"> # See the docs
341 # <cgihost type="webirc" password="foobar"
342 # mask="somebox.example.com"> # Get IP from WEBIRC
347 # When you connect CGI:IRC clients, there are two connect classes which
348 # apply to these clients. When the client initially connects, the connect
349 # class which matches the CGI:IRC site's host is checked. Therefore you
350 # must raise the maximum local/global clients for this ip as high as you
351 # want to allow cgi clients. After the client has connected and is
352 # determined to be a cgi:irc client, the class which matches the client's
353 # real IP is then checked. You may set this class to a lower value, so that
354 # the real IP of the client can still be restricted to, for example, 3
357 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
358 # Channel create module: Adds snomask +j, which will notify opers of
359 # any new channels that are created.
360 # This module is oper-only.
361 #<module name="chancreate">
363 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
364 # Channel filter module: Allows channel-op defined message filtering
365 # using simple string matches (channel mode +g).
366 #<module name="chanfilter">
368 # If hidemask is set to yes, the user will not be shown the mask when
369 # his/her message is blocked.
370 #<chanfilter hidemask="yes">
372 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
373 # Channel history module: Displays the last 'X' lines of chat to a user
374 # joining a channel with +H 'X:T' set; 'T' is the maximum time to keep
375 # lines in the history buffer. Designed so that the new user knows what
376 # the current topic of conversation is when joining the channel.
377 #<module name="chanhistory">
379 # Set the maximum number of lines allowed to be stored per channel below.
380 # This is the hard limit for 'X'.
381 # If notice is set to yes, joining users will get a NOTICE before playback
382 # telling them about the following lines being the pre-join history.
383 # If bots is set to yes, it will also send to users marked with +B
384 #<chanhistory maxlines="20" notice="yes" bots="yes">
386 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
387 # Channel logging module: Used to send snotice output to channels, to
388 # allow staff to centrally monitor and discuss network activity.
390 # The "channel" field is where you want the messages to go, "snomasks"
391 # is what snomasks you want to be sent to that channel. Multiple tags
393 #<module name="chanlog">
394 #<chanlog snomasks="AOcC" channel="#opers">
396 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
397 # Channel names module: Allows disabling channels which have certain
398 # characters in the channel name such as bold, colorcodes, etc. which
399 # can be quite annoying and allow users to on occasion have a channel
400 # that looks like the name of another channel on the network.
401 #<module name="channames">
404 # denyrange: characters or range of characters to deny in channel
408 # allowrange: characters or range of characters to specifically allow
412 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
413 # Channelban: Implements extended ban j:, which stops anyone already
414 # in a channel matching a ban like +b j:#channel*mask from joining.
415 # Note that by default wildcard characters * and ? are allowed in
416 # channel names. To disallow them, load m_channames and add characters
417 # 42 and 63 to denyrange (see above).
418 #<module name="channelban">
420 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
421 # Check module: Adds the /CHECK command.
422 # Check is useful for looking up information on channels, users,
423 # IP addresses and hosts.
424 # This module is oper-only.
425 # To use, CHECK must be in one of your oper class blocks.
426 #<module name="check">
428 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
429 # CHGHOST module: Adds the /CHGHOST command.
430 # This module is oper-only.
431 # To use, CHGHOST must be in one of your oper class blocks.
432 # NOTE: Services will not be able to set vhosts on users if this module
433 # isn't loaded. If you're planning on running services, you probably
435 #<module name="chghost">
437 #-#-#-#-#-#-#-#-# /CHGHOST - /SETHOST CONFIGURATION #-#-#-#-#-#-#-#-#
438 # Optional - If you want to use special chars for hostnames you can #
439 # specify your own custom list of chars with the <hostname> tag: #
441 # charmap - A list of chars accepted as valid by the /CHGHOST #
442 # and /SETHOST commands. Also note that the list is #
444 #<hostname charmap="abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ.-_/0123456789">
446 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
447 # CHGIDENT module: Adds the /CHGIDENT command.
448 # This module is oper-only.
449 # To use, CHGIDENT must be in one of your oper class blocks.
450 #<module name="chgident">
452 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
453 # CHGNAME module: Adds the /CHGNAME command.
454 # This module is oper-only.
455 # To use, CHGNAME must be in one of your oper class blocks.
456 #<module name="chgname">
458 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
459 # Connection class ban module: Adds support for extban 'n' which
460 # matches against the class name of the user's connection.
461 # This module assumes that connection classes are named in a uniform
462 # way on all servers of the network.
463 #<module name="classban">
465 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
466 # Clear chan module: Allows opers to masskick, masskill or mass-G/ZLine
467 # all users on a channel using /CLEARCHAN.
468 #<module name="clearchan">
470 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
471 # Cloaking module: Adds usermode +x and cloaking support.
472 # Relies on the md5 module being loaded.
473 # To cloak users when they connect, load the conn_umodes module and set
474 # <connect:modes> to include the +x mode. The example <connect> tag
475 # shows this. See the conn_umodes module for more information.
476 #<module name="cloaking">
478 #-#-#-#-#-#-#-#-#-#-#- CLOAKING CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#
480 # To use cloaking, you must define a cloak key, and optionally a #
481 # cloak prefix as shown below. The cloak key must be shared across #
482 # the network for correct cloaking. #
484 # There are two methods of cloaking: #
486 # half Cloak only the "unique" portion of a host; show #
487 # the last 2 parts of the domain, /16 subnet of IPv4 #
488 # or /48 subnet of the IPv6 address. #
490 # full Cloak the users completely, using three slices for #
491 # common CIDR bans (IPv4: /16, /24; IPv6: /48, /64). #
493 # The methods use a single key that can be any length of text. #
494 # An optional prefix may be specified to mark cloaked hosts. #
495 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
501 #-#-#-#-#-#-#-#-#-#-#-#- CLOSE MODULE #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
502 # Close module: Allows an oper to close all unregistered connections.
503 # This module is oper-only and provides the /CLOSE command.
504 # To use, CLOSE must be in one of your oper class blocks.
505 #<module name="close">
507 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
508 # Clones module: Adds an oper command /CLONES for detecting cloned
509 # users. Warning: This command may be resource intensive when it is
510 # issued, use with care.
511 # This module is oper-only.
512 # To use, CLONES must be in one of your oper class blocks.
513 #<module name="clones">
515 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
516 # Common channels module: Adds user mode +c, which, when set, requires
517 # that users must share a common channel with you to PRIVMSG or NOTICE
519 #<module name="commonchans">
521 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
522 # Auto join on connect module: Allows you to force users to join one
523 # or more channels automatically upon connecting to the server, or
524 # join them in case they aren't on any channels after being online
526 #<module name="conn_join">
528 #-#-#-#-#-#-#-#-#-#-#-#- CONNJOIN CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
530 # If you have the conn_join module loaded, you can configure it below
531 # or set autojoin="#chat,#help" in <connect> blocks.
533 # Join users immediately after connection to #one #two and #three.
534 #<autojoin channel="#one,#two,#three">
535 # Join users to #chat after 15 seconds if they aren't on any channels.
536 #<autojoin channel="#chat" delay="15">
538 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
539 # Set modes on connect module: When this module is loaded <connect>
540 # blocks may have an optional modes="" value, which contains modes to
541 # add or remove from users when they connect to the server.
542 #<module name="conn_umodes">
544 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
545 # Wait for PONG on connect module: Send a PING to all connecting users
546 # and don't let them connect until they reply with a PONG.
547 # This is useful to stop certain kinds of bots and proxies.
548 #<module name="conn_waitpong">
550 #-#-#-#-#-#-#-#-#-#-#- WAITPONG CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
552 # If you have the conn_waitpong module loaded, configure it with the #
555 # sendsnotice - Whether to send a helpful notice to users on #
556 # connect telling them how to connect, should #
557 # their client not reply PONG automatically. #
559 # killonbadreply - Whether to kill the user if they send the wrong #
562 #<waitpong sendsnotice="yes" killonbadreply="yes">
564 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
565 # Channel cycle module: Adds the /CYCLE command which is a server-side
566 # /HOP that bypasses restrictive modes.
567 #<module name="cycle">
569 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
570 # Connectban: Provides IP connection throttling. Any IP range that
571 # connects too many times (configurable) in an hour is Z-Lined for a
572 # (configurable) duration, and their count resets to 0.
573 #<module name="connectban">
575 # ipv4cidr and ipv6cidr allow you to turn the comparison from
576 # individual IP addresses (32 and 128 bits) into CIDR masks, to allow
577 # for throttling over whole ISPs/blocks of IPs, which may be needed to
580 # This allows for 10 connections in an hour with a 10 minute ban if
582 #<connectban threshold="10" duration="10m" ipv4cidr="32" ipv6cidr="128"
583 # A custom ban message may optionally be specified.
584 # 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.">
586 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
587 # Connection throttle module.
588 #<module name="connflood">
590 #-#-#-#-#-#-#-#-#-#-#- CONNTHROTTLE CONFIGURATION -#-#-#-#-#-#-#-#-#-#
591 # seconds, maxconns - Amount of connections per <seconds>.
593 # timeout - Time to wait after the throttle was activated
594 # before deactivating it. Be aware that the time
595 # is seconds + timeout.
597 # quitmsg - The message that users get if they attempt to
598 # connect while the throttle is active.
600 # bootwait - Amount of time in seconds to wait before enforcing
601 # the throttling when the server just booted.
603 #<connflood seconds="30" maxconns="3" timeout="30"
604 # quitmsg="Throttled" bootwait="10">
606 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
607 # Custom prefixes: Allows for channel prefixes to be added.
608 #<module name="customprefix">
610 # name The name of the mode, must be unique from other modes.
611 # letter The letter used for this mode. Required.
612 # prefix The prefix used for nicks with this mode. Not required.
613 # rank A numeric rank for this prefix, defining what permissions it gives.
614 # The rank of voice, halfop and op is 10000, 20000, and 30000,
616 # ranktoset The numeric rank required to set/unset this mode. Defaults to rank.
617 # depriv Can you remove the mode from yourself? Defaults to yes.
618 #<customprefix name="founder" letter="q" prefix="~" rank="50000" ranktoset="50000">
619 #<customprefix name="admin" letter="a" prefix="&" rank="40000" ranktoset="50000">
620 #<customprefix name="halfop" letter="h" prefix="%" rank="20000" ranktoset="30000">
621 #<customprefix name="halfvoice" letter="V" prefix="-" rank="1" ranktoset="20000">
623 # Do /RELOADMODULE customprefix after changing the settings of this module.
625 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
626 # Custom title module: Adds the /TITLE command which allows for trusted
627 # users to gain a custom whois line and an optional vhost can be
629 #<module name="customtitle">
631 #-#-#-#-#-#-#-#-#-#- CUSTOM TITLE CONFIGURATION -#-#-#-#-#-#-#-#-#-#
632 # name - The username used to identify.
633 # password - The password used to identify.
634 # hash - The hash for the specific user's password (optional).
635 # password_hash and a hashing module must be loaded
637 # host - Allowed hostmask (optional).
638 # title - Title shown in whois.
639 # vhost - Displayed host (optional).
641 #<title name="foo" password="bar" title="Official Chat Helper">
642 #<title name="bar" password="foo" host="ident@test.org" title="Official Chat Helper" vhost="helper.test.org">
643 #<title name="foo" password="$2a$10$UYZ4OcO8NNTCCGyCdY9SK.2GHiqGgxZfHFPOPmWuxEVWVQTtoDC7C" hash="bcrypt" title="Official Chat Helper">
645 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
646 # DCCALLOW module: Adds the /DCCALLOW command.
647 #<module name="dccallow">
649 #-#-#-#-#-#-#-#-#-#-#- DCCALLOW CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
650 # blockchat - Whether to block DCC CHAT as well as DCC SEND.
651 # length - Default duration of entries in DCCALLOW list.
652 # action - Default action to take if no action is
653 # specified, can be 'block' or 'allow'.
654 # maxentries - Max number of nicks to allow on a DCCALLOW list.
656 # File configuration:
657 # pattern - The glob pattern to match against.
658 # action - Action to take if a user attempts to send a file
659 # that matches this pattern, can be 'block' or
662 #<dccallow blockchat="yes" length="5m" action="block" maxentries="20">
663 #<banfile pattern="*.exe" action="block">
664 #<banfile pattern="*.txt" action="allow">
666 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
667 # Deaf module: Adds support for the usermode +d - deaf to channel
668 # messages and channel notices.
669 #<module name="deaf">
671 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
672 # Delay join module: Adds the channel mode +D which delays all JOIN
673 # messages from users until they speak. If they quit or part before
674 # speaking, their quit or part message will not be shown to the channel
675 # which helps cut down noise on large channels in a more friendly way
676 # than the auditorium mode. Only channel ops may set the +D mode.
677 #<module name="delayjoin">
679 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
680 # Delay message module: Adds the channel mode +d which disallows a user
681 # from talking in the channel unless they've been joined for X seconds.
682 # Settable using /MODE #chan +d 30
683 #<module name="delaymsg">
684 # Set allownotice to no to disallow NOTICEs too. Defaults to yes.
685 #<delaymsg allownotice="no">
687 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
688 # Deny channels module: Deny channels from being used by users.
689 #<module name="denychans">
691 #-#-#-#-#-#-#-#-#-#-#- DENYCHAN DEFINITIONS -#-#-#-#-#-#-#-#-#-#-#-#
693 # If you have the denychans module loaded, you need to specify the #
694 # channels to deny: #
696 # name - The channel name to deny (glob masks are ok). #
697 # allowopers - If operators are allowed to override the deny. #
698 # reason - Reason given for the deny. #
699 # redirect - Redirect the user to a different channel. #
701 #<badchan name="#gods*" allowopers="yes" reason="Tortoises!"> #
702 #<badchan name="#chan1" redirect="#chan2" reason="Chan1 is closed"> #
704 # Redirects will not work if the target channel is set +L. #
706 # Additionally, you may specify channels which are allowed, even if #
707 # a badchan tag specifies it would be denied: #
708 #<goodchan name="#funtimes"> #
709 # Glob masks are accepted here also. #
711 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
712 # Devoice module: Let users devoice themselves using /DEVOICE #chan.
713 #<module name="devoice">
715 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
716 # DNS blacklist module: Provides support for looking up IPs on one or #
718 #<module name="dnsbl"> #
720 # For configuration options please see the wiki page for dnsbl at #
721 # http://wiki.inspircd.org/Modules/dnsbl #
723 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
724 # Exempt channel operators module: Provides support for allowing #
725 # channel operators to be exempt from some channel modes. Supported #
726 # modes are blockcaps, noctcp, blockcolor, nickflood, flood, censor, #
727 # filter, regmoderated, nonick, nonotice, and stripcolor. #
728 #<module name="exemptchanops"> #
730 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
731 # Filter module: Provides message filtering, similar to SPAMFILTER. #
732 #<module name="filter">
734 # This module depends upon a regex provider such as regex_pcre or #
735 # regex_glob to function. You must specify which of these you want #
736 # the filter module to use via the tag below. #
738 # Valid engines are: #
740 # glob - Glob patterns, provided via regex_glob. #
741 # pcre - PCRE regexps, provided via regex_pcre, needs libpcre. #
742 # tre - TRE regexps, provided via regex_tre, requires libtre. #
743 # posix - POSIX regexps, provided via regex_posix, not available #
744 # on Windows, no dependencies on other operating systems. #
745 # stdlib - stdlib regexps, provided via regex_stdlib, see comment #
746 # at the <module> tag for info on availability. #
748 #<filteropts engine="glob"> #
750 # Your choice of regex engine must match on all servers network-wide.
752 # To learn more about the configuration of this module, read #
753 # examples/filter.conf.example, which covers the various types of #
754 # filters and shows how to add exemptions. #
756 #-#-#-#-#-#-#-#-#-#-#- FILTER CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#
758 # Optional - If you specify to use the filter module, then #
759 # specify below the path to the filter.conf file, or define some #
762 #<include file="examples/filter.conf.example">
764 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
765 # Flash Policy Daemon module: Allows Flash IRC clients (e.g. LightIRC)#
766 # to connect. If no file is specified, it'll serve a default policy #
767 # allowing all IPs to connect to all plaintext IRC ports #
768 #<bind address="" port="8430" type="flashpolicyd"> #
769 #<flashpolicyd timeout="5" file=""> #
770 #<module name="flashpolicyd"> #
772 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
773 # Gecos ban: Implements extended ban 'r', which stops anyone matching
774 # a mask like +b r:*realname?here* from joining a channel.
775 #<module name="gecosban">
777 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
778 # GeoIP module: Allows the server admin to match users by country code.
779 # This module is in extras. Re-run configure with:
780 # ./configure --enable-extras=m_geoip.cpp
781 # and run make install, then uncomment this module to enable it.
782 # This module requires GeoIP to be installed on your system,
783 # use your package manager to find the appropriate packages
784 # or check the InspIRCd wiki page for this module.
785 #<module name="geoip">
787 # The actual allow/ban actions are done by connect classes, not by the
788 # GeoIP module. An example connect class to ban people from russia or
791 # <connect deny="*" geoip="TR,RU">
793 # The country code must be in capitals and should be an ISO country
794 # code such as TR, GB, or US. Unknown IPs (localhost, LAN IPs, etc)
795 # will be assigned the country code "UNK". Since connect classes are
796 # matched from top down, your deny classes must be above your allow
797 # classes for them to match.
799 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
800 # Globops module: Provides the /GLOBOPS command and snomask +g.
801 # This module is oper-only.
802 # To use, GLOBOPS must be in one of your oper class blocks.
803 #<module name="globops">
805 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
806 # Global load module: Allows loading and unloading of modules network-
807 # wide (USE WITH EXTREME CAUTION!)
808 # This module is oper-only and provides /GLOADMODULE, /GUNLOADMODULE
809 # and /GRELOADMODULE.
810 # To use, GLOADMODULE, GUNLOADMODULE and GRELOADMODULE
811 # must be in one of your oper class blocks.
812 #<module name="globalload">
814 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
815 # HELPOP module: Provides the /HELPOP command
816 #<module name="helpop">
818 #-#-#-#-#-#-#-#-#-#-#-#- HELPOP CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
820 # If you specify to use the helpop module, then specify below the #
821 # path to the helpop.conf file. #
823 #<include file="examples/inspircd.helpop-full.example">
825 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
826 # Hide chans module: Allows users to hide their channels list from non-
827 # opers by setting user mode +I on themselves.
828 #<module name="hidechans">
830 # This mode can optionally prevent opers from seeing channels on a +I
831 # user, for more privacy if set to true.
832 # This setting is not recommended for most mainstream networks.
833 #<hidechans affectsopers="false">
835 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
836 # Hide list module: Allows for hiding the list of listmodes from users
837 # who do not have sufficient channel rank.
838 #<module name="hidelist">
840 # Each <hidelist> tag configures one listmode to hide.
841 # mode: Name of the listmode to hide.
842 # rank: Minimum rank required to view the list. If set to 0, all
843 # members of the channel may view the list, but non-members may not.
844 # The rank of the built-in op and voice mode is 30000 and 10000,
845 # respectively; the rank of other prefix modes is configurable.
848 # Hiding the ban list is not recommended because it may break some
851 # Hide filter (+g) list:
852 #<hidelist mode="filter" rank="30000">
853 # Only show invite exceptions (+I) to channel members:
854 #<hidelist mode="invex" rank="0">
856 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
857 # Hide oper module: Allows opers to hide their oper status from non-
858 # opers by setting user mode +H on themselves.
859 # This module is oper-only.
860 #<module name="hideoper">
862 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
863 # Hostchange module: Allows a different style of cloaking.
864 #<module name="hostchange">
866 #-#-#-#-#-#-#-#-#-#-#- HOSTCHANGE CONFIGURATION -#-#-#-#-#-#-#-#-#-#
868 # See http://wiki.inspircd.org/Modules/hostchange for help. #
870 #<host suffix="invalid.org" separator="." prefix="">
871 #<hostchange mask="*@42.theanswer.example.org" action="addnick">
872 #<hostchange mask="*root@*" action="suffix">
873 #<hostchange mask="a@example.com" action="set" value="foo.bar.baz">
874 #<hostchange mask="localhost" ports="7000,7001,7005-7007" action="set" value="blahblah.foo">
876 # hostcycle: If loaded, when a user gets a host or ident set, it will
877 # cycle them in all their channels. If not loaded it will simply change
878 # their host/ident without cycling them.
879 # This module is compatible with the ircv3_chghost module. Clients
880 # supporting the chghost extension will get the chghost message instead
881 # of seeing a host cycle.
882 #<module name="hostcycle">
884 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
885 # httpd module: Provides HTTP server support for InspIRCd.
886 #<module name="httpd">
888 #-#-#-#-#-#-#-#-#-#-#-#- HTTPD CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
890 # If you choose to use the httpd module, then you will need to add
891 # a <bind> tag with type "httpd", and load at least one of the other
892 # httpd_* modules to provide pages to display.
894 # You can adjust the timeout for HTTP connections below. All HTTP
895 # connections will be closed after (roughly) this many seconds.
896 #<httpd timeout="20">
898 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
899 # HTTP ACL module: Provides access control lists for httpd dependent
900 # modules. Use this module to restrict pages by IP address and by
902 #<module name="httpd_acl">
904 #-#-#-#-#-#-#-#-#-#-#-#- HTTPD ACL CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
906 # Restrict access to the httpd_stats module to all but the local
907 # network and when the correct password is specified:
908 # <httpdacl path="/stats*" types="password,whitelist"
909 # username="secrets" password="mypasshere" whitelist="127.0.0.*,10.*">
911 # Deny all connections to all but the main index page:
912 # <httpdacl path="/*" types="blacklist" blacklist="*">
914 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
915 # HTTP config module: Allows the configuration of the server to be
916 # viewed over HTTP. Requires httpd to be loaded for it to function.
917 #<module name="httpd_config">
919 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
920 # HTTP stats module: Provides basic stats pages over HTTP.
921 # Requires httpd to be loaded for it to function.
922 #<module name="httpd_stats">
924 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
925 # Ident: Provides RFC 1413 ident lookup support.
926 # When this module is loaded <connect:allow> tags may have an optional
927 # useident="yes|no" boolean value, determining whether or not to lookup
928 # ident on users matching that connect tag.
929 #<module name="ident">
931 #-#-#-#-#-#-#-#-#-#-#-#- IDENT CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
933 # Optional - If you are using the ident module, then you can specify #
934 # the timeout for ident lookups here. If not defined, it will default #
935 # to 5 seconds. This is a non-blocking timeout which holds the user #
936 # in a 'connecting' state until the lookup is complete. #
937 # The bind value indicates which IP to bind outbound requests to. #
938 # nolookupprefix: If on, the idents of users being in a connect class #
939 # with ident lookups disabled (i.e. <connect useident="off">) will be #
940 # prefixed with a "~". If off, the ident of those users will not be #
941 # prefixed. Default is off. #
943 #<ident timeout="5" nolookupprefix="no">
945 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
946 # Invite exception module: Adds support for channel invite exceptions
948 #<module name="inviteexception">
949 # bypasskey: If this is enabled, exceptions will bypass +k as well as +i
950 #<inviteexception bypasskey="yes">
952 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
953 # IRCv3 module: Provides the following IRCv3.1 extensions:
954 # extended-join, away-notify and account-notify. These are optional
955 # enhancements to the client-to-server protocol. An extension is only
956 # active for a client when the client specifically requests it, so this
957 # module needs the cap module to work.
959 # Further information on these extensions can be found at the IRCv3
960 # working group website:
961 # http://ircv3.org/extensions/
963 #<module name="ircv3">
964 # The following block can be used to control which extensions are
965 # enabled. Note that extended-join can be incompatible with delayjoin
967 #<ircv3 accountnotify="on" awaynotify="on" extendedjoin="on">
969 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
970 # IRCv3 cap-notify module: Provides the cap-notify IRCv3.2 extension.
971 # Required for IRCv3.2 conformance.
972 #<module name="ircv3_capnotify">
974 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
975 # IRCv3 chghost module: Provides the chghost IRCv3.2 extension which
976 # allows capable clients to learn when the host/ident of another user
977 # changes without cycling the user. This module is compatible with the
978 # hostcycle module. If both are loaded, clients supporting the chghost
979 # extension will get the chghost message and won't see host cycling.
980 #<module name="ircv3_chghost">
982 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
983 # IRCv3 echo-message module: Provides the echo-message IRCv3.2
984 # extension which allows capable clients to get an acknowledgement when
985 # their messages are delivered and learn what modifications, if any,
986 # were applied to them.
987 #<module name="ircv3_echomessage">
989 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
990 # IRCv3 invite-notify module: Provides the invite-notify IRCv3.2
991 # extension which notifies supporting clients when a user invites
992 # another user into a channel. This respects <options:announceinvites>.
993 #<module name="ircv3_invitenotify">
995 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
996 # Join flood module: Adds support for join flood protection +j X:Y.
997 # Closes the channel for N seconds if X users join in Y seconds.
998 #<module name="joinflood">
1000 # The number of seconds to close the channel for:
1001 #<joinflood duration="1m">
1003 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1004 # Jump server module: Adds support for the RPL_REDIR numeric.
1005 # This module is oper-only.
1006 # To use, JUMPSERVER must be in one of your oper class blocks.
1007 # If your server is redirecting new clients and you get disconnected,
1008 # do a REHASH from shell to open up again.
1009 #<module name="jumpserver">
1011 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1012 # Anti auto rejoin: Adds support for prevention of auto-rejoin (+J).
1013 #<module name="kicknorejoin">
1015 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1016 # Knock module: Adds the /KNOCK command and channel mode +K.
1017 #<module name="knock">
1019 # This setting specifies what to do when someone successfully /KNOCKs.
1020 # If set to "notice", then a NOTICE will be sent to the channel.
1021 # This is the default and the compatible setting, as it requires no
1022 # special support from the clients.
1023 # If set to "numeric" then a 710 numeric will be sent to the channel.
1024 # This allows easier scripting but not all clients support it.
1025 # If set to "both" then (surprise!) both will be sent.
1026 #<knock notify="notice">
1028 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1029 # LDAP module: Allows other SQL modules to access a LDAP database
1030 # through a unified API.
1031 # This modules is in extras. Re-run configure with:
1032 # ./configure --enable-extras=m_ldap.cpp
1033 # and run make install, then uncomment this module to enable it.
1035 #<module name="ldap">
1036 #<database module="ldap" id="ldapdb" server="ldap://localhost" binddn="cn=Manager,dc=inspircd,dc=org" bindauth="mysecretpass" searchscope="subtree">
1037 # The server parameter indicates the LDAP server to connect to. The #
1038 # ldap:// style scheme before the hostname proper is MANDATORY. #
1040 # The binddn and bindauth indicate the DN to bind to for searching, #
1041 # and the password for the distinguished name. Some LDAP servers will #
1042 # allow anonymous searching in which case these two values do not #
1043 # need defining, otherwise they should be set similar to the examples #
1046 # The searchscope value indicates the subtree to search under. On our #
1047 # test system this is 'subtree'. Your mileage may vary. #
1049 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1050 # LDAP authentication module: Adds the ability to authenticate users #
1052 #<module name="ldapauth">
1056 # <ldapauth dbid="ldapdb" #
1057 # baserdn="ou=People,dc=brainbox,dc=cc" #
1059 # allowpattern="Guest* Bot*" #
1060 # killreason="Access denied" #
1062 # host="$uid.$ou.inspircd.org"> #
1064 # <ldapwhitelist cidr="10.42.0.0/16"> #
1066 # <ldaprequire attribute="attr" value="val"> #
1068 # The baserdn indicates the base DN to search in for users. Usually #
1069 # this is 'ou=People,dc=yourdomain,dc=yourtld'. #
1071 # The attribute value indicates the attribute which is used to locate #
1072 # a user account by name. On POSIX systems this is usually 'uid'. #
1074 # The allowpattern value allows you to specify a space separated list #
1075 # of wildcard masks which will always be allowed to connect #
1076 # regardless of if they have an account, for example guest and bot #
1079 # Killreason indicates the QUIT reason to give to users if they fail #
1080 # to authenticate. #
1082 # Setting the verbose value causes an oper notice to be sent out for #
1083 # every failed authentication to the server, with an error string. #
1085 # ldapwhitelist indicates that clients connecting from an IP in the #
1086 # provided CIDR do not need to authenticate against LDAP. It can be #
1087 # repeated to whitelist multiple CIDRs. #
1089 # ldaprequire allows further filtering on the LDAP user, by requiring #
1090 # certain LDAP attibutes to have a given value. It can be repeated, #
1091 # in which case the list will act as an OR list, that is, the #
1092 # authentication will succeed if any of the requirements in the list #
1095 # host allows you to change the displayed host of users connecting #
1096 # from ldap. The string supplied takes formatters which are replaced #
1097 # from the DN. For instance, if your DN looks like: #
1098 # uid=w00t,ou=people,dc=inspircd,dc=org, then the formatters uid, ou #
1099 # and dc will be available to you. If a key is given multiple times #
1100 # in the DN, the last appearance will take precedence. #
1102 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1103 # LDAP oper configuration module: Adds the ability to authenticate #
1105 #<module name="ldapoper">
1109 # <ldapoper dbid="ldapdb"
1110 # baserdn="ou=People,dc=brainbox,dc=cc"
1113 # Available configuration items are identical to the same items in #
1114 # ldapauth above (except for the verbose setting, that is only #
1115 # supported in ldapauth). #
1116 # Please always specify a password in your <oper> tags even if the #
1117 # opers are to be authenticated via LDAP, so in case this module is #
1118 # not loaded the oper accounts are still protected by a password. #
1120 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1121 # Lock server module: Adds /LOCKSERV and /UNLOCKSERV commands that #
1122 # are used to temporarily close/open the server for new connections. #
1123 # These commands require that the /LOCKSERV and /UNLOCKSERV commands #
1124 # are specified in a <class> tag that the oper is part of. This is so #
1125 # you can control who has access to this possible dangerous command. #
1126 # If your server is locked and you get disconnected, do a REHASH from #
1127 # shell to open up again. #
1128 # This module is oper-only.
1129 #<module name="lockserv">
1131 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1132 # Map hiding module: replaces /MAP and /LINKS output to users with a #
1133 # message to see a website, set by maphide="http://test.org/map" in #
1134 # the <security> tag, instead. #
1135 #<module name="maphide">
1137 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1138 # Message flood module: Adds message/notice flood protection via
1140 #<module name="messageflood">
1142 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1143 # MLOCK module: Adds support for server-side enforcement of services
1144 # side MLOCKs. Basically, this module suppresses any mode change that
1145 # would likely be immediately bounced by services.
1146 #<module name="mlock">
1148 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1149 # Modenotice module: Adds the /MODENOTICE command that allows opers to
1150 # send notices to all users having the given user mode(s) set.
1151 #<module name="modenotice">
1153 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1154 # Monitor module: Adds support for MONITOR which is used by clients to
1155 # maintain notify lists.
1156 #<module name="monitor">
1158 # Set the maximum number of entries on a user's monitor list below.
1159 #<monitor maxentries="30">
1161 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1162 # MySQL module: Allows other SQL modules to access MySQL databases
1163 # through a unified API.
1164 # This module is in extras. Re-run configure with:
1165 # ./configure --enable-extras=m_mysql.cpp
1166 # and run make install, then uncomment this module to enable it.
1167 #<module name="mysql">
1169 #-#-#-#-#-#-#-#-#-#-#-#- SQL CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#-#
1171 # mysql is more complex than described here, see the wiki for more #
1172 # info: http://wiki.inspircd.org/Modules/mysql #
1174 #<database module="mysql" name="mydb" user="myuser" pass="mypass" host="localhost" id="my_database2">
1176 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1177 # Named modes module: Allows for the display and set/unset of channel
1178 # modes via long-form mode names via +Z and the /PROP command.
1179 # For example, to set a ban, do /mode #channel +Z ban=foo!bar@baz or
1180 # /PROP #channel ban=foo!bar@baz
1181 #<module name="namedmodes">
1183 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1184 # NAMESX module: Provides support for the NAMESX extension which allows
1185 # clients to see all the prefixes set on a user without getting confused.
1186 # This is supported by mIRC, x-chat, klient, and maybe more.
1187 #<module name="namesx">
1189 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1190 # National characters module:
1191 # 1) Allows using national characters in nicknames.
1192 # 2) Allows using custom (national) casemapping over the network.
1193 #<module name="nationalchars">
1195 # file - Location of the file which contains casemapping rules. If this
1196 # is a relative path then it is relative to "<PWD>/../locales"
1197 # on UNIX and "<PWD>/locales" on Windows.
1198 # casemapping - The name of the casemapping sent to clients in the 005
1199 # numeric. If this is not set then it defaults to the name
1200 # of the casemapping file unless the file name contains a
1201 # space in which case you will have to specify it manually.
1202 #<nationalchars file="bynets/russian-w1251-charlink" casemapping="ru_RU.cp1251-charlink">
1204 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1205 # Nickchange flood protection module: Provides channel mode +F X:Y
1206 # which allows up to X nick changes in Y seconds.
1207 #<module name="nickflood">
1209 # The number of seconds to prevent nick changes for:
1210 #<nickflood duration="1m">
1212 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1213 # Nicklock module: Let opers change a user's nick and then stop that
1214 # user from changing their nick again until unlocked.
1215 # This module is oper-only.
1216 # To use, NICKLOCK and NICKUNLOCK must be in one of your oper class blocks.
1217 #<module name="nicklock">
1219 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1220 # No CTCP module: Adds the channel mode +C to block CTCPs and extban
1221 # 'C' to block CTCPs sent by specific users.
1222 #<module name="noctcp">
1224 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1225 # No kicks module: Adds the +Q channel mode and the Q: extban to deny
1226 # certain users from kicking.
1227 #<module name="nokicks">
1229 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1230 # No nicks module: Adds the +N channel mode, as well as the 'N' extban.
1231 # +N stops all users from changing their nick, the N extban stops
1232 # anyone from matching a +b N:nick!user@host mask from changing their
1234 #<module name="nonicks">
1236 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1237 # No part message module: Adds extban 'p' to block part messages from #
1239 #<module name="nopartmsg">
1241 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1242 # No notice module: Adds the channel mode +T and the extban 'T' to
1243 # block specific users from noticing the channel.
1244 #<module name="nonotice">
1246 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1247 # Network business join module:
1248 # Allows an oper to join a channel using /OJOIN, giving them +Y on the
1249 # channel which makes them immune to kick/deop/etc.
1250 #<module name="ojoin">
1252 # Specify the prefix that +Y will grant here.
1253 # Leave 'prefix' empty if you do not wish +Y to grant a prefix.
1254 # If 'notice' is set to on, upon /OJOIN, the server will notice the
1255 # channel saying that the oper is joining on network business.
1256 # If 'op' is set to on, it will give them +o along with +Y.
1257 #<ojoin prefix="!" notice="yes" op="yes">
1259 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1260 # Oper channels mode: Adds the +O channel mode and extban O:<mask>
1261 # to ban, except, etc. specific oper types. For example
1262 # /mode #channel +iI O:* is equivalent to channel mode +O, but you
1263 # may also set +iI O:AdminTypeOnly to only allow admins.
1264 # Modes +I and +e work in a similar fashion.
1265 #<module name="operchans">
1267 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1268 # Oper join module: Auto-joins opers to a channel upon oper-up.
1269 # This module is oper-only. For the user equivalent, see the conn_join
1271 #<module name="operjoin">
1273 #-#-#-#-#-#-#-#-#-#-# OPERJOIN CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
1275 # If you are using the operjoin module, specify options here: #
1277 # channel - The channel name to join, can also be a comma #
1278 # separated list e.g. "#channel1,#channel2". #
1280 # override - If on, lets the oper join walking thru any modes #
1281 # that might be set, even bans. #
1283 #<operjoin channel="#channel" override="no">
1285 # Alternatively you can use the autojoin="channellist" in a <type> #
1286 # tag to set specific autojoins for a type of oper, for example: #
1288 #<type name="Helper" autojoin="#help" classes="...">
1290 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1291 # Oper log module: Logs all oper commands to the server log (with log
1292 # type "m_operlog" at default loglevel), and optionally to the 'r'
1294 # This module is oper-only.
1295 #<module name="operlog">
1297 # If the following option is on then all oper commands will be sent to
1298 # the snomask 'r'. The default is off.
1299 #<operlog tosnomask="off">
1301 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1302 # Oper prefixing module: Adds a channel prefix mode +y which is given
1303 # to all IRC operators automatically on all channels they are in.
1304 # This prefix mode is more powerful than channel op and other regular
1307 # Load this module if you want all your IRC operators to have channel
1309 #<module name="operprefix">
1311 # You may additionally customise the prefix character.
1312 #<operprefix prefix="!">
1314 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1315 # Oper MOTD module: Provides support for separate message of the day
1317 # This module is oper-only.
1318 #<module name="opermotd">
1320 #-#-#-#-#-#-#-#-#-#-# OPERMOTD CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
1322 # If you are using the opermotd module, specify the motd here. #
1324 # onoper - If on, the message is sent on /OPER, otherwise it's #
1325 # only sent when /OPERMOTD is used. #
1327 # processcolors - Allow color codes to be processed in the opermotd. #
1328 # Read the comment above <connect:allowmotdcolors> in #
1329 # inspircd.conf.example for details. #
1331 #<opermotd file="examples/opermotd.txt.example" onoper="yes" processcolors="false">
1333 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1334 # Override module: Adds support for oper override.
1335 # This module is oper-only.
1336 #<module name="override">
1338 #-#-#-#-#-#-#-#-#-#-# OVERRIDE CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
1340 # override is too complex it describe here, see the wiki: #
1341 # http://wiki.inspircd.org/Modules/override #
1343 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1344 # Oper levels module: Gives each oper a level and prevents actions
1345 # being taken by lower level opers against higher level opers.
1346 # Specify the level as the 'level' parameter of the <type> tag.
1347 # This module is oper-only.
1348 #<module name="operlevels">
1350 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1351 # Oper modes module: Allows you to specify modes to add/remove on oper.
1352 # Specify the modes as the 'modes' parameter of the <type> tag
1353 # and/or as the 'modes' parameter of the <oper> tag.
1354 # This module is oper-only. For the user equivalent, see the
1355 # conn_umodes module.
1356 #<module name="opermodes">
1358 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1359 # Password forwarding module: Forwards a password users can send on
1360 # connect to the specified client below. The client is usually NickServ
1361 # and this module is usually used to authenticate users with NickServ
1362 # using their connect password.
1363 #<module name="passforward">
1366 # nick: nick to forward connect passwords to.
1369 # forwardmsg: Message to send to users using a connect password.
1370 # $nick will be the users' nick, $nickrequired will be the nick
1371 # of where the password is going (the nick above).
1372 # You can also use $user for the user ident string.
1373 forwardmsg="NOTICE $nick :*** Forwarding PASS to $nickrequired"
1375 # cmd: Command for the user to run when it receives a connect
1377 cmd="PRIVMSG $nickrequired :IDENTIFY $pass">
1379 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1380 # Password hash module: Allows hashed passwords to be used.
1381 # To be useful, a hashing module like bcrypt also needs to be loaded.
1382 #<module name="password_hash">
1384 #-#-#-#-#-#-#-#-#-# PASSWORD HASH CONFIGURATION #-#-#-#-#-#-#-#-#-#-#-#
1386 # To use this module, you must define a hash type for each oper's
1387 # password you want to hash. For example:
1389 # <oper name="Brain"
1390 # host="ident@dialup15.isp.test.com"
1392 # password="$2a$10$Mss9AtHHslZTLBrXqM0FB.JBwD.UTSu8A48SfrY9exrpxbsRiRTbO"
1395 # If you are using a hash algorithm which does not perform salting you can use
1396 # HMAC to salt your passwords in order to prevent them from being looked up in
1399 # hash="hmac-sha256" password="lkS1Nbtp$CyLd/WPQXizsbxFUTqFRoMvaC+zhOULEeZaQkUJj+Gg"
1401 # Generate hashes using the /MKPASSWD command on the server.
1402 # Don't run it on a server you don't trust with your password.
1404 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1405 # PBKDF2 module: Allows other modules to generate PBKDF2 hashes,
1406 # usually for cryptographic uses and security.
1407 # This module relies on other hash providers (e.g. SHA256).
1408 #<module name="pbkdf2">
1410 # iterations: Iterations the hashing function runs when generating new
1412 # length: Length in bytes of the derived key.
1413 #<pbkdf2 iterations="12288" length="32">
1414 # You can override these values with specific values
1415 # for specific providers if you want to. Example given for SHA256.
1416 #<pbkdf2prov hash="sha256" iterations="24576">
1418 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1419 # Permanent channels module: Channels with the permanent channel mode
1420 # will remain open even after everyone else has left the channel, and
1421 # therefore keep things like modes, ban lists and topic. Permanent
1422 # channels -may- need support from your Services package to function
1423 # properly with them. This adds channel mode +P.
1424 # This module is oper-only.
1425 #<module name="permchannels">
1427 # If you like, this module can write a config file of permanent channels
1428 # whenever +P is set, unset, or the topic/modes on a +P channel is changed.
1429 # If you want to do this, set the filename below, and uncomment the include.
1431 # If 'listmodes' is true then all list modes (+b, +I, +e, +g...) will be
1432 # saved. Defaults to false.
1433 #<permchanneldb filename="permchannels.conf" listmodes="true">
1434 #<include file="permchannels.conf">
1436 # You may also create channels on startup by using the <permchannels> block.
1437 # Don't forget to set them +P in the modes, or they won't stay permanent.
1438 #<permchannels channel="#opers" modes="isP" topic="Opers only.">
1440 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1441 # PostgreSQL module: Allows other SQL modules to access PgSQL databases
1442 # through a unified API.
1443 # This module is in extras. Re-run configure with:
1444 # ./configure --enable-extras=m_pgsql.cpp
1445 # and run make install, then uncomment this module to enable it.
1446 #<module name="pgsql">
1448 #-#-#-#-#-#-#-#-#-#-#-#- SQL CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#-#
1450 # pgsql is more complex than described here, see the wiki for #
1451 # more: http://wiki.inspircd.org/Modules/pgsql #
1453 #<database module="pgsql" name="mydb" user="myuser" pass="mypass" host="localhost" id="my_database" ssl="no">
1455 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1456 # Muteban: Implements extended ban 'm', which stops anyone matching
1457 # a mask like +b m:nick!user@host from speaking on channel.
1458 #<module name="muteban">
1460 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1461 # Random quote module: Provides a random quote on connect.
1462 # NOTE: Some of these may mimic fatal errors and confuse users and
1463 # opers alike - BEWARE!
1464 #<module name="randquote">
1466 #-#-#-#-#-#-#-#-#-#- RANDOMQUOTES CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
1468 # Optional - If you specify to use the randquote module, then specify #
1469 # below the path to the quotes file. #
1471 #<randquote file="quotes.txt">
1473 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1474 # Redirect module: Adds channel redirection mode +L. #
1475 # Optional: <redirect:antiredirect> to add usermode +L to stop forced #
1476 # redirection and instead print an error. #
1478 # Note: You can not update this with a simple rehash, it requires #
1479 # reloading the module for it to take effect. #
1480 # This also breaks linking to servers that do not have the option. #
1481 # This defaults to false for the 2.0 version, it will be enabled in #
1482 # all the future versions. #
1483 #<module name="redirect">
1484 #<redirect antiredirect="true">
1486 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1487 # Regular expression provider for glob or wildcard (?/*) matching.
1488 # You must have at least 1 provider loaded to use the filter or rline
1489 # modules. This module has no additional requirements, as it uses the
1490 # matching already present in InspIRCd core.
1491 #<module name="regex_glob">
1493 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1494 # Regular expression provider for PCRE (Perl-Compatible Regular
1495 # Expressions). You need libpcre installed to compile and load this
1496 # module. You must have at least 1 provider loaded to use the filter or
1498 #<module name="regex_pcre">
1500 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1501 # Regular Expression Provider for RE2 Regular Expressions.
1502 # You need libre2 installed and in your include/library paths in order
1503 # to compile and load this module.
1504 #<module name="regex_re2">
1506 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1507 # Regular expression provider for POSIX regular expressions.
1508 # You shouldn't need any additional libraries on a POSIX-compatible
1509 # system (i.e.: any Linux, BSD, but not Windows). You must have at
1510 # least 1 provider loaded to use filter or rline.
1511 # On POSIX-compliant systems, regex syntax can be found by using the
1512 # command: 'man 7 regex'.
1513 #<module name="regex_posix">
1515 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1516 # Regular expression provider for C++11 std::regex regular expressions.
1517 # This module works on any fully compliant implementation of the C++11
1518 # std::regex container. Examples for such are Visual C++ 2010 and newer
1519 # but not libstdc++ (which GCC uses).
1520 # You should verify that std::regex is supported by your setup before
1521 # using this module, as it may compile normally but won't do anything
1522 # on some implementations.
1523 #<module name="regex_stdlib">
1525 # Specify the regular expression engine to use here. Valid settings are
1526 # bre, ere, awk, grep, egrep, ecmascript (default if not specified).
1527 #<stdregex type="ecmascript">
1529 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1530 # Regular expression provider for TRE regular expressions.
1531 # This is the same regular expression engine used by UnrealIRCd, so
1532 # if you are most familiar with the syntax of /SPAMFILTER from there,
1533 # this is the provider you want. You need libtre installed in order
1534 # to compile and load this module.
1535 #<module name="regex_tre">
1537 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1538 # Registered users only channel creation module. If enabled, only
1539 # registered users and opers can create new channels.
1541 # You probably *DO NOT* want to load this module on a public network.
1543 #<module name="regonlycreate">
1545 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1546 # Remove module: Adds the /REMOVE command which is a peaceful
1547 # alternative to /KICK.
1548 #<module name="remove">
1550 # supportnokicks: If true, /REMOVE is not allowed on channels where the
1551 # nokicks (+Q) mode is set. Defaults to false.
1552 # protectedrank: Members having this rank or above may not be /REMOVE'd
1553 # by anyone. Set to 0 to disable this feature. Defaults to 50000.
1554 #<remove supportnokicks="true" protectedrank="50000">
1556 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1557 # A module to block, kick or ban upon similar messages being uttered several times.
1558 # Syntax [~*][lines]:[sec]{[:difference]}{[:matchlines]}
1559 # ~ is to block, * is to ban, default is kick.
1560 # 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
1561 # seconds - How old the message has to be before it's invalidated.
1562 # distance - Edit distance, in percent, between two strings to trigger on.
1563 # matchlines - When set, the function goes into mode 2. In this mode the function will trigger if this many of the last <lines> matches.
1565 # As this module can be rather CPU-intensive, it comes with some options.
1566 # maxbacklog - Maximum size that can be specified for backlog. 0 disables multiline matching.
1567 # maxdistance - Max percentage of difference between two lines we'll allow to match. Set to 0 to disable edit-distance matching.
1568 # maxlines - Max lines of backlog to match against.
1569 # maxsecs - Maximum value of seconds a user can set. 0 to allow any.
1570 # size - Maximum number of characters to check for, can be used to truncate messages
1571 # before they are checked, resulting in less CPU usage. Increasing this beyond 512
1572 # doesn't have any effect, as the maximum length of a message on IRC cannot exceed that.
1573 #<repeat maxbacklog="20" maxlines="20" maxdistance="50" maxsecs="0" size="512">
1574 #<module name="repeat">
1576 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1577 # Restricted channels module: Allows only opers to create channels.
1579 # You probably *DO NOT* want to load this module on a public network.
1581 #<module name="restrictchans">
1583 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1584 # Restrict message module: Allows users to only message opers.
1586 # You probably *DO NOT* want to load this module on a public network.
1588 #<module name="restrictmsg">
1590 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1591 # R-Line module: Ban users through regular expression patterns.
1592 #<module name="rline">
1594 #-#-#-#-#-#-#-#-#-#-#-#- RLINE CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#-#
1596 # If you wish to re-check a user when they change nickname (can be
1597 # useful under some situations, but *can* also use CPU with more users
1598 # on a server) then set 'matchonnickchange' to yes.
1599 # Also, this is where you set what Regular Expression engine is to be
1600 # used. If you ever change it while running, all of your R-Lines will
1601 # be wiped. This is the regex engine used by all R-Lines set, and
1602 # regex_<engine> must be loaded, or rline will be non-functional
1603 # until you load it or change the engine to one that is loaded.
1605 #<rline matchonnickchange="yes" engine="pcre">
1607 # Generally, you will NOT want to use 'glob' here, as this turns
1608 # rline into just another gline. The exceptions are that rline will
1609 # always use the full "nick!user@host realname" string, rather than only
1610 # user@host, but beware that only the ? and * wildcards are available,
1611 # and are the only way to specify where the space can occur if you do
1612 # use glob. For this reason, is recommended to use a real regex engine
1613 # so that at least \s or [[:space:]] is available.
1615 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1616 # RMODE module: Adds the /RMODE command
1617 # Allows channel mods to remove list modes en masse.
1618 # Syntax: /rmode <channel> <mode> [pattern]
1619 # E.g. '/rmode #Channel b m:*' will remove all mute-extbans on the channel.
1620 #<module name="rmode">
1622 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1623 # SAJOIN module: Adds the /SAJOIN command which forcibly joins a user
1624 # to the given channel.
1625 # This module is oper-only.
1626 # To use, SAJOIN must be in one of your oper class blocks.
1627 # Opers need the users/sajoin-others priv to be able to /SAJOIN users
1628 # other than themselves.
1629 #<module name="sajoin">
1631 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1632 # SAKICK module: Adds the /SAKICK command which kicks a user from the
1634 # This module is oper-only.
1635 # To use, SAKICK must be in one of your oper class blocks.
1636 #<module name="sakick">
1638 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1639 # SAMODE module: Adds the /SAMODE command which allows server operators
1640 # to change modes on a channel without requiring them to have any
1641 # channel priviliges. Also allows changing user modes for any user.
1642 # This module is oper-only.
1643 # To use, SAMODE must be in one of your oper class blocks.
1644 #<module name="samode">
1646 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1647 # SANICK module: Adds the /SANICK command which allows opers to change
1649 # This module is oper-only.
1650 # To use, SANICK must be in one of your oper class blocks.
1651 #<module name="sanick">
1653 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1654 # SAPART module: Adds the /SAPART command which forcibly parts a user
1656 # This module is oper-only.
1657 # To use, SAPART must be in one of your oper class blocks.
1658 #<module name="sapart">
1660 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1661 # SAQUIT module: Adds the /SAQUIT command which forcibly quits a user.
1662 # This module is oper-only.
1663 # To use, SAQUIT must be in one of your oper class blocks.
1664 #<module name="saquit">
1666 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1667 # SATOPIC module: Adds the /SATOPIC command which allows changing the
1668 # topic on a channel without requiring any channel priviliges.
1669 # This module is oper-only.
1670 # To use, SATOPIC must be in one of your oper class blocks.
1671 #<module name="satopic">
1673 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1674 # SASL authentication module: Provides support for IRC Authentication
1675 # Layer via AUTHENTICATE. Note: You also need to have cap loaded
1677 #<module name="sasl">
1679 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1680 # Secure list module: Prevent /LIST in the first minute of connection,
1681 # crippling most spambots and trojan spreader bots.
1682 #<module name="securelist">
1684 #-#-#-#-#-#-#-#-#-# SECURELIST CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#-#
1686 # Securelist can be harmful to some IRC search engines such as #
1687 # netsplit.de and searchirc.com. To prevent securelist blocking these #
1688 # sites from listing, define exception tags as shown below: #
1689 #<securehost exception="*@*.searchirc.org">
1690 #<securehost exception="*@*.netsplit.de">
1691 #<securehost exception="*@echo940.server4you.de">
1692 #<securehost exception="*@*.ircdriven.com">
1694 # Define the following variable to change how long a user must wait #
1695 # before issuing a LIST. If not defined, defaults to 60 seconds. #
1697 #<securelist waittime="60"> #
1699 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1700 # Servprotect module: Provides support for Austhex style +k /
1701 # UnrealIRCD +S services mode.
1702 #<module name="servprotect">
1704 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1705 # See nicks module: Adds snomask +n and +N which show local and remote
1707 # This module is oper-only.
1708 #<module name="seenicks">
1710 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1711 # Set idle module: Adds a command for opers to change their idle time.
1712 # This module is oper-only.
1713 # To use, SETIDLE must be in one of your oper class blocks.
1714 #<module name="setidle">
1716 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1717 # Services support module: Adds several usermodes such as +R and +M.
1718 # This module implements the 'identified' state via account names,
1719 # and is similar in operation to the way asuka and ircu handle services.
1721 # At the same time, this offers +r for users and channels to mark them
1722 # as identified separately from the idea of a master account, which
1723 # can be useful for services which are heavily nick-as-account centric.
1725 # Also of note is that this module implements two extbans:
1726 # +b R: (stop matching account names from joining)
1727 # +b U:n!u@h (blocks matching unregistered users)
1729 #<module name="services_account">
1731 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1732 # Sethost module: Adds the /SETHOST command.
1733 # This module is oper-only.
1734 # To use, SETHOST must be in one of your oper class blocks.
1735 # See the chghost module for how to customise valid chars for hostnames.
1736 #<module name="sethost">
1738 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1739 # Setident module: Adds the /SETIDENT command.
1740 # This module is oper-only.
1741 # To use, SETIDENT must be in one of your oper class blocks.
1742 #<module name="setident">
1744 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1745 # SETNAME module: Adds the /SETNAME command.
1746 #<module name="setname">
1748 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1749 # Serverban: Implements extended ban 's', which stops anyone connected
1750 # to a server matching a mask like +b s:server.mask.here from joining.
1751 #<module name="serverban">
1753 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1754 # SHA1 module: Allows other modules to generate SHA1 hashes.
1755 # Required by the WebSocket module.
1756 #<module name="sha1">
1758 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1759 # Showfile: Provides support for showing a text file to users when #
1760 # they enter a command. #
1761 # This module adds one command for each <showfile> tag that shows the #
1762 # given file to the user as a series of messages or numerics. #
1763 #<module name="showfile"> #
1765 #-#-#-#-#-#-#-#-#-#-# SHOWFILE CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#-#
1767 # name - The name of the command which displays this file. This is #
1768 # the only mandatory setting, all others are optional. #
1769 # file - The text file to be shown to the user. #
1770 # By default same as the command name. #
1771 # method - How should the file be shown? #
1772 # * numeric: Send contents using a numeric #
1773 # (similar to /MOTD; the default). #
1774 # * notice: Send contents as a series of notices. #
1775 # * msg: Send contents as a series of private messages. #
1776 # colors - If true, color codes (\c, \b, \u, etc.) will be processed #
1777 # and sent as ANSI colors. If false (default) the file will #
1778 # be displayed as-is. #
1780 # When using the method "numeric", the following extra settings are #
1783 # introtext - Introductory line, "Showing <name>" by default. #
1784 # intronumeric - Numeric used for the introductory line. #
1785 # numeric - Numeric used for sending the text itself. #
1786 # endtext - Ending line, "End of <name>" by default. #
1787 # endnumeric - Numeric used for the ending line. #
1789 #<showfile name="RULES"
1792 # introtext="Server rules:"
1793 # endtext="End of server rules.">
1795 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1796 # Show whois module: Adds the +W usermode which allows opers to see
1797 # when they are /WHOIS'd.
1798 # This module is oper-only by default.
1799 #<module name="showwhois">
1801 # If you wish, you may also let users set this mode. Only opers with the
1802 # users/auspex priv will see real hosts of people, though.
1803 #<showwhois opersonly="yes"
1805 # You may also set whether or not users should receive whois notices,
1806 # should they be /WHOIS'd by an oper.
1807 #showfromopers="yes">
1809 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1810 # Shun module: Provides the /SHUN command, which stops a user from
1811 # executing all except configured commands.
1812 # This module is oper-only.
1813 # To use, SHUN must be in one of your oper class blocks.
1814 #<module name="shun">
1816 # You may also configure which commands you wish a user to be able to
1817 # perform when shunned. It should be noted that if a shunned user
1818 # issues QUIT or PART then their message will be removed, as if they
1819 # did not issue one.
1821 # You can optionally let the user know that their command was blocked.
1823 # You may also let SHUN affect opers (defaults to no).
1824 #<shun enabledcommands="PING PONG QUIT PART JOIN" notifyuser="yes" affectopers="no">
1826 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1827 # SSL channel mode module: Adds support for SSL-only channels via
1828 # channel mode +z and the 'z' extban which matches SSL client
1829 # certificate fingerprints.
1830 # Does not do anything useful without a working SSL module (see below).
1831 #<module name="sslmodes">
1833 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1834 # GnuTLS SSL module: Adds support for SSL connections using GnuTLS,
1835 # if enabled. You must answer 'yes' in ./configure when asked or
1836 # manually symlink the source for this module from the directory
1837 # src/modules/extra, if you want to enable this, or it will not load.
1838 #<module name="ssl_gnutls">
1840 #-#-#-#-#-#-#-#-#-#-#- GNUTLS CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#
1842 # ssl_gnutls is too complex to describe here, see the wiki: #
1843 # http://wiki.inspircd.org/Modules/ssl_gnutls #
1845 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1846 # SSL info module: Allows users to retrieve information about other
1847 # users' peer SSL certificates and keys. This can be used by client
1848 # scripts to validate users. For this to work, one of ssl_gnutls
1849 # or ssl_openssl must be loaded. This module also adds the
1850 # "* <user> is using a secure connection" whois line, the ability for
1851 # opers to use SSL cert fingerprints to verify their identity and the
1852 # ability to force opers to use SSL connections in order to oper up.
1853 # It is highly recommended to load this module if you use SSL on your
1855 # For how to use the oper features, please see the first example <oper> tag
1856 # in opers.conf.example.
1858 #<module name="sslinfo">
1860 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1861 # mbedTLS SSL module: Adds support for SSL/TLS connections using mbedTLS.
1862 #<module name="ssl_mbedtls">
1864 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1865 # OpenSSL SSL module: Adds support for SSL connections using OpenSSL,
1866 # if enabled. You must answer 'yes' in ./configure when asked or symlink
1867 # the source for this module from the directory src/modules/extra, if
1868 # you want to enable this, or it will not load.
1869 #<module name="ssl_openssl">
1871 #-#-#-#-#-#-#-#-#-#-#- OPENSSL CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#
1873 # ssl_openssl is too complex to describe here, see the wiki: #
1874 # http://wiki.inspircd.org/Modules/ssl_openssl #
1876 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1877 # Strip color module: Adds channel mode +S that strips color codes and
1878 # all control codes except CTCP from all messages sent to the channel.
1879 #<module name="stripcolor">
1881 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1882 # Silence module: Adds support for the /SILENCE command, which allows
1883 # users to have a server-side ignore list for their client.
1884 #<module name="silence">
1886 # Set the maximum number of entries allowed on a user's silence list.
1887 #<silence maxentries="32"
1889 # Whether messages from U-lined servers will bypass silence masks.
1892 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1893 # SQLite3 module: Allows other SQL modules to access SQLite3 #
1894 # databases through a unified API. #
1895 # This module is in extras. Re-run configure with: #
1896 # ./configure --enable-extras=m_sqlite.cpp
1897 # and run make install, then uncomment this module to enable it. #
1899 #<module name="sqlite3">
1901 #-#-#-#-#-#-#-#-#-#-#-#- SQL CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#-#
1903 # sqlite is more complex than described here, see the wiki for more #
1904 # info: http://wiki.inspircd.org/Modules/sqlite3 #
1906 #<database module="sqlite" hostname="/full/path/to/database.db" id="anytext">
1908 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1909 # SQL authentication module: Allows IRCd connections to be tied into
1910 # a database table (for example a forum).
1911 # This module is in extras. Re-run configure with:
1912 # ./configure --enable-extras=m_sqlauth.cpp
1913 # and run make install, then uncomment this module to enable it.
1915 #<module name="sqlauth">
1917 #-#-#-#-#-#-#-#-#-#-#- SQLAUTH CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#
1919 # sqlauth is too complex to describe here, see the wiki: #
1920 # http://wiki.inspircd.org/Modules/sqlauth #
1922 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1923 # SQL oper module: Allows you to store oper credentials in an SQL table
1924 # This module is in extras. Re-run configure with:
1925 # ./configure --enable-extras=m_sqloper.cpp
1926 # and run make install, then uncomment this module to enable it.
1928 #<module name="sqloper">
1930 #-#-#-#-#-#-#-#-#-#-#- SQLOPER CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#
1932 # dbid - Database ID to use (see SQL modules). #
1933 # hash - Hashing provider to use for password hashing. #
1935 # See also: http://wiki.inspircd.org/Modules/sqloper #
1937 #<sqloper dbid="1" hash="bcrypt">
1939 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1940 # StartTLS module: Implements STARTTLS, which allows clients #
1941 # connected to non SSL enabled ports to enable SSL, if a proper SSL #
1942 # module is loaded (either ssl_gnutls or ssl_openssl). #
1943 #<module name="starttls">
1945 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1946 # SVSHold module: Implements SVSHOLD. Like Q:Lines, but can only be #
1947 # added/removed by Services. #
1948 #<module name="svshold">
1949 # SVSHOLD does not generate server notices by default, you can turn
1950 # notices on by uncommenting the next line.
1951 #<svshold silent="false">
1953 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1954 # SWHOIS module: Allows you to add arbitrary lines to user WHOIS.
1955 # This module is oper-only.
1956 # To use, SWHOIS must be in one of your oper class blocks.
1957 #<module name="swhois">
1959 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1960 # Timed bans module: Adds timed channel bans with the /TBAN command.
1961 #<module name="timedbans">
1963 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1964 # Test line module: Adds the /TLINE command, used to test how many
1965 # users a /GLINE or /ZLINE etc. would match.
1966 # This module is oper-only.
1967 # To use, TLINE must be in one of your oper class blocks.
1968 #<module name="tline">
1970 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1971 # Topiclock module: implements server-side topic locking to achieve deeper
1972 # integration with services packages.
1973 #<module name="topiclock">
1975 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1976 # UHNAMES support module: Adds support for the IRCX style UHNAMES
1977 # extension, which displays ident and hostname in the names list for
1978 # each user, saving clients from doing a WHO on the channel.
1979 # If a client does not support UHNAMES it will not enable it, this will
1980 # not break incompatible clients.
1981 #<module name="uhnames">
1983 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1984 # Uninvite module: Adds the /UNINVITE command which lets users remove
1985 # pending invites from channels without waiting for the user to join.
1986 #<module name="uninvite">
1988 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1989 # Userip module: Adds the /USERIP command.
1990 # Allows users to query their own IP, also allows opers to query the IP
1992 #<module name="userip">
1994 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1995 # Vhost module: Adds the VHOST command which allows for adding virtual
1996 # hosts which are accessible using a username and password in the config.
1997 #<module name="vhost">
1999 #-#-#-#-#-#-#-#-#-#-#- VHOST CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#-#
2001 # user - Username for the vhost. #
2003 # pass - Password for the vhost. #
2005 # hash - The hash for the specific user (optional) #
2006 # password_hash and a hashing module must be loaded for #
2009 # host - Vhost to set. #
2011 #<vhost user="some_username" pass="some_password" host="some.host.test.cc">
2012 #<vhost user="foo" password="$2a$10$iTuYLT6BRhRlOgzfsW9oPe62etW.oXwSpyKw5rJit64SGZanLXghO" hash="bcrypt" host="some.other.host.example.com">
2014 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2015 # Watch module: Adds the WATCH command, which is used by clients to
2016 # maintain notify lists.
2017 #<module name="watch">
2019 # Set the maximum number of entries on a user's watch list below.
2020 #<watch maxentries="32">
2022 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2023 # WebSocket module: Adds HTML5 WebSocket support.
2024 # Specify hook="websocket" in a <bind> tag to make that port accept
2025 # WebSocket connections. Compatible with SSL/TLS.
2026 # Requires SHA-1 hash support available in the sha1 module.
2027 #<module name="websocket">
2029 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2030 # XLine database: Stores all *Lines (G/Z/K/R/any added by other modules)
2031 # in a file which is re-loaded on restart. This is useful
2032 # for two reasons: it keeps bans so users may not evade them, and on
2033 # bigger networks, server connections will take less time as there will
2034 # be a lot less bans to apply - as most of them will already be there.
2035 #<module name="xline_db">
2037 # Specify the filename for the xline database here.
2038 #<xlinedb filename="data/xline.db">
2040 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2041 # ____ _ _____ _ _ ____ _ _ _ #
2042 # | _ \ ___ __ _ __| | |_ _| |__ (_)___ | __ )(_) |_| | #
2043 # | |_) / _ \/ _` |/ _` | | | | '_ \| / __| | _ \| | __| | #
2044 # | _ < __/ (_| | (_| | | | | | | | \__ \ | |_) | | |_|_| #
2045 # |_| \_\___|\__,_|\__,_| |_| |_| |_|_|___/ |____/|_|\__(_) #
2047 # To link servers to InspIRCd, you MUST load the spanningtree module. #
2048 # If you don't do this, server links will NOT work at all. #
2049 # This is by design, to allow for the implementation of other linking #
2050 # protocols in modules in the future. #
2052 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2053 # Spanning tree module: Allows linking of servers using the spanning
2054 # tree protocol (see the READ THIS BIT section above).
2055 # You will almost always want to load this.
2057 #<module name="spanningtree">
projects / user / henk / code / inspircd.git / blob