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 # https://wiki.inspircd.org/3.0/Modules for a list of modules and #
14 # each modules link for any additional conf tags they require. #
16 # ____ _ _____ _ _ ____ _ _ _ #
17 # | _ \ ___ __ _ __| | |_ _| |__ (_)___ | __ )(_) |_| | #
18 # | |_) / _ \/ _` |/ _` | | | | '_ \| / __| | _ \| | __| | #
19 # | _ < __/ (_| | (_| | | | | | | | \__ \ | |_) | | |_|_| #
20 # |_| \_\___|\__,_|\__,_| |_| |_| |_|_|___/ |____/|_|\__(_) #
22 # To link servers to InspIRCd, you MUST load the spanningtree module. #
23 # If you don't do this, server links will NOT work at all. #
24 # This is by design, to allow for the implementation of other linking #
25 # protocols in modules in the future. This module is at the bottom of #
29 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
30 # MD5 module: Allows other modules to generate MD5 hashes, usually for
31 # cryptographic uses and security.
34 # Other modules such as cloaking and password_hash may rely on
35 # this module being loaded to function.
39 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
40 # SHA256 module: Allows other modules to generate SHA256 hashes,
41 # usually for cryptographic uses and security.
44 # Other modules such as password_hash may rely on this module being
45 # loaded to function. Certain modules such as spanningtree will
46 # function without this module but when it is loaded their features will
47 # be enhanced (for example the addition of HMAC authentication).
49 #<module name="sha256">
50 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
51 # RIPEMD160 module: Allows other modules to generate RIPEMD160 hashes,
52 # usually for cryptographic uses and security.
55 # Other modules may rely on this module being loaded to function.
56 #<module name="ripemd160">
58 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
59 # Abbreviation module: Provides the ability to abbreviate commands a-la
61 #<module name="abbreviation">
63 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
64 # Alias module: Allows you to define server-side command aliases.
65 #<module name="alias">
67 # Set the 'prefix' for in-channel aliases (fantasy commands) to the
68 # specified character. If not set, the default is "!".
69 # If 'allowbots' is disabled, +B clients will not be able to use
70 # fantasy commands. If not set, the default is no.
71 #<fantasy prefix="!" allowbots="no">
73 #-#-#-#-#-#-#-#-#-#-#- ALIAS DEFINITIONS -#-#-#-#-#-#-#-#-#-#-#-#-#-#
75 # If you have the alias module loaded, you may also define aliases as #
76 # shown below. They are commonly used to provide shortcut commands to #
77 # services, however they are not limited to just this use. #
78 # An alias tag requires the following values to be defined in it: #
80 # text - The text to detect as the actual command line. #
81 # Can't contain spaces, but case insensitive. #
82 # You may have multiple aliases with the same #
83 # command name (text="" value), however the first #
84 # found will be executed if its format value is #
85 # matched, or it has no format value. Aliases are #
86 # read from the top of the file to the bottom. #
88 # usercommand - If this is true, the alias can be run simply as #
89 # /aliasname. Defaults to true. #
91 # channelcommand - If this is true, the alias can be used as an #
92 # in-channel alias or 'fantasy command', prefixed #
93 # by the fantasy prefix character, !aliasname by #
94 # default. Defaults to false. #
96 # format - If this is defined, the parameters of the alias #
97 # must match this glob pattern. For example if you #
98 # want the first parameter to start with a # for #
99 # the alias to be executed, set format="#*" in the #
100 # alias definition. Note that the :'s which are #
101 # part of IRC formatted lines will be preserved #
102 # for matching of this text. This value is #
105 # replace - The text to replace 'text' with. Usually this #
106 # will be "PRIVMSG ServiceName :$2-" or similar. #
107 # You may use the variables $1 through $9 in the #
108 # replace string, which refer to the first through #
109 # ninth word in the original string typed by the #
110 # user. You may also use $1- through $9- which #
111 # refer to the first word onwards, through to the #
112 # ninth word onwards, e.g. if the user types the #
113 # command "foo bar baz qux quz" then $3- will hold #
114 # "baz qux quz" and $2 will contain "bar". You may #
115 # also use the special variables: $nick, $ident, #
116 # $host and $vhost, and you may separate multiple #
117 # commands with a newline (which can be written in #
118 # the file literally, or encoded as &nl; or \n #
119 # depending on the config format setting). #
121 # requires - If you provide a value for 'requires' this means #
122 # the given nickname MUST be online for the alias #
123 # to successfully trigger. If they are not, then #
124 # the user receives a 'no such nick' 401 numeric. #
126 # uline - Setting this to true will ensure that the user #
127 # given in 'requires' is also on a u-lined server, #
128 # as well as actually being on the network. If the #
129 # user is online, but not on a u-lined server, #
130 # then an oper alert is sent out as this is #
131 # possibly a sign of a user trying to impersonate #
134 # operonly - If true, this will make the alias oper only. #
135 # If a non-oper attempts to use the alias, it will #
136 # appear to not exist. #
139 # An example of using the format value to create an alias with two
140 # different behaviours depending on the format of the parameters.
142 #<alias text="ID" format="#*" replace="PRIVMSG ChanServ :IDENTIFY $2 $3"
143 # requires="ChanServ" uline="yes">
145 #<alias text="ID" replace="PRIVMSG NickServ :IDENTIFY $2"
146 # requires="NickServ" uline="yes">
148 # This alias fixes a glitch in xchat 2.6.x and above and the way it
149 # assumes IDENTIFY must be prefixed by a colon (:) character. It should
150 # be placed ABOVE the default NICKSERV alias.
152 #<alias text="NICKSERV" format=":IDENTIFY *" replace="PRIVMSG NickServ :IDENTIFY $3-"
153 # requires="NickServ" uline="yes">
155 # You may also add aliases to trigger based on something said in a
156 # channel, aka 'fantasy' commands, configured in the same manner as any
157 # other alias, with usercommand="no" and channelcommand="yes" The
158 # command must be preceded by the fantasy prefix when used.
160 #<alias text="CS" usercommand="no" channelcommand="yes"
161 # replace="PRIVMSG ChanServ :$1 $chan $2-" requires="ChanServ" uline="yes">
163 # This would be used as "!cs <command> <options>", with the channel
164 # being automatically inserted after the command in the message to
165 # ChanServ, assuming the fantasy prefix is "!".
167 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
168 # Allowinvite module: Gives channel mode +A to allow all users to use
169 # /INVITE, and extban A to deny invite from specific masks.
170 #<module name="allowinvite">
172 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
173 # Alltime module: Shows time on all connected servers at once.
174 # This module is oper-only and provides /ALLTIME.
175 # To use, ALLTIME must be in one of your oper class blocks.
176 #<module name="alltime">
178 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
179 # Auditorium module: Adds channel mode +u which makes everyone else
180 # except you in the channel invisible, used for large meetings etc.
181 #<module name="auditorium">
183 # Auditorium settings:
185 #<auditorium opvisible="no" opcansee="no" opercansee="yes">
187 # opvisible (auditorium-vis in exemptchanops):
188 # Show channel ops to all users
189 # opcansee (auditorium-see in exemptchanops):
190 # Allow ops to see all joins/parts/kicks in the channel
192 # Allow opers (channels/auspex) to see see all joins/parts/kicks in the channel
194 # Exemptchanops can be used to adjust the level at which users become visible or
195 # the level at which they can see the full member list of the channel.
197 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
198 # Autoop module: Adds basic channel access controls via the +w listmode.
199 # For example +w o:*!Attila@127.0.0.1 will op anyone matching that mask
200 # on join. This can be combined with extbans, for example +w o:R:Brain
201 # will op anyone identified to the account "Brain".
202 # Another useful combination is with SSL client certificate
203 # fingerprints: +w h:z:72db600734bb9546c1bdd02377bc21d2a9690d48 will
204 # give halfop to the user(s) having the given certificate.
205 #<module name="autoop">
207 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
208 # Ban except module: Adds support for channel ban exceptions (+e).
209 #<module name="banexception">
211 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
212 # Ban redirection module: Allows bans which redirect to a specified
213 # channel. e.g. +b nick!ident@host#channelbanneduserissentto
214 #<module name="banredirect">
216 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
217 # bcrypt module: Allows other modules to generate bcrypt hashes,
218 # usually for cryptographic uses and security.
219 #<module name="bcrypt">
221 # rounds: Defines how many rounds the bcrypt function will run when
222 # generating new hashes.
223 #<bcrypt rounds="10">
225 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
226 # Block amsg module: Attempt to block all usage of /amsg and /ame.
227 #<module name="blockamsg">
229 #-#-#-#-#-#-#-#-#-#-#- BLOCKAMSG CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
231 # If you have the blockamsg module loaded, you can configure it with #
232 # the <blockamsg> tag: #
234 # delay - How much time between two messages to force them #
235 # to be recognised as unrelated. #
236 # action - Any of 'notice', 'noticeopers', 'silent', 'kill' #
237 # or 'killopers'. Define how to take action when #
238 # a user uses /amsg or /ame. #
240 #<blockamsg delay="3" action="killopers">
242 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
243 # Block CAPS module: Adds channel mode +B, blocks all-CAPS messages.
244 #<module name="blockcaps">
246 #-#-#-#-#-#-#-#-#-#-#- BLOCKCAPS CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
248 # percent - The percentage of a message which must be upper #
249 # case before it will be blocked. #
251 # minlen - The minimum length a message must be before it #
254 # lowercase - The characters which will be considered lower #
257 # uppercase - The characters which will be considered upper #
260 #<blockcaps percent="50"
262 # lowercase="abcdefghijklmnopqrstuvwxyz"
263 # uppercase="ABCDEFGHIJKLMNOPQRSTUVWXYZ">
265 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
266 # Block color module: Blocking color-coded messages with chan mode +c.
267 #<module name="blockcolor">
269 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
270 # Botmode module: Adds the user mode +B. If set on a user, it will
271 # show that the user is a bot in /WHOIS.
272 #<module name="botmode">
274 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
275 # CallerID module: Adds usermode +g which activates hybrid-style
276 # callerid: block all private messages unless you /ACCEPT first.
277 #<module name="callerid">
279 #-#-#-#-#-#-#-#-#-#-#- CALLERID CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#
280 # maxaccepts - Maximum number of entries a user can add to his #
281 # /ACCEPT list. Default is 16 entries. #
282 # operoverride - Can opers (note: ALL opers) override callerid? #
284 # tracknick - Preserve /accept entries when a user changes nick? #
285 # If no (the default), the user is removed from #
286 # everyone's accept list if he changes nickname. #
287 # cooldown - Amount of time that must pass since the last #
288 # notification sent to a user before he can be sent #
289 # another. Default is 1 minute. #
290 #<callerid maxaccepts="16"
295 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
296 # CAP module: Provides the CAP negotiation mechanism required by the
297 # sasl, namesx, uhnames, and ircv3 modules.
298 # It is also recommended for STARTTLS support in the starttls module.
301 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
302 # CBAN module: Lets you disallow channels from being used at runtime.
303 # This module is oper-only and provides /CBAN.
304 # To use, CBAN must be in one of your oper class blocks.
305 #<module name="cban">
307 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
308 # Censor module: Adds channel and user mode +G.
309 #<module name="censor">
311 #-#-#-#-#-#-#-#-#-#-#- CENSOR CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#
313 # Optional - If you specify to use the censor module, then you must #
314 # specify some censor tags. See also: #
315 # https://wiki.inspircd.org/Modules/3.0/censor #
317 #<include file="examples/censor.conf.example">
319 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
320 # CGI:IRC module: Enables forwarding the real IP address of a user from
321 # a gateway to the IRC server.
322 #<module name="cgiirc">
324 #-#-#-#-#-#-#-#-#-#-#-# CGIIRC CONFIGURATION #-#-#-#-#-#-#-#-#-#-#-#-#
326 # If you use the cgiirc module then you must specify the gateways which
327 # are authorised to forward IP/host information to your server. There
328 # are currently two ways to do this:
330 # The webirc method is the recommended way to allow gateways to forward
331 # IP/host information. When using this method the gateway sends a WEBIRC
332 # message to the server on connection. For more details please read the
333 # IRCv3 WebIRC specification at http://ircv3.net/specs/extensions/webirc.html.
335 # When using this method you must specify a wildcard mask or CIDR range
336 # to allow gateway connections from and at least one of either a SSL
337 # client certificate fingerprint for the gateway or a password to be
338 # sent in the WEBIRC command.
340 # <cgihost type="webirc"
341 # fingerprint="bd90547b59c1942b85f382bc059318f4c6ca54c5"
342 # mask="192.0.2.0/24">
343 # <cgihost type="webirc"
344 # password="$2a$10$WEUpX9GweJiEF1WxBDSkeODBstIBMlVPweQTG9cKM8/Vd58BeM5cW"
346 # mask="*.webirc.gateway.example.com">
348 # Alternatively if your gateway does not support sending the WEBIRC
349 # message then you can configure InspIRCd to look for the client IP
350 # address in the ident sent by the user. This is not recommended as it
351 # only works with IPv4 connections.
353 # When using this method you must specify a wildcard mask or CIDR range to
354 # allow gateway connections from.
356 # <cgihost type="ident" mask="198.51.100.0/24">
357 # <cgihost type="ident" mask="*.ident.gateway.example.com">
359 # By default gateway connections are logged to the +w snomask. If you
360 # do not want this to happen then you can uncomment this to disable it.
361 # <cgiirc opernotice="no">
366 # When you connect gateway clients, there are two connect classes which
367 # apply to these clients. When the client initially connects, the connect
368 # class which matches the gateway site's host is checked. Therefore you
369 # must raise the maximum local/global clients for this IP as high as you
370 # want to allow gateway clients. After the client has connected and is
371 # determined to be a gateway client, the class which matches the client's
372 # real IP is then checked. You may set this class to a lower value, so that
373 # the real IP of the client can still be restricted to, for example, 3
376 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
377 # Channel create module: Adds snomask +j, which will notify opers of
378 # any new channels that are created.
379 # This module is oper-only.
380 #<module name="chancreate">
382 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
383 # Channel filter module: Allows channel-op defined message filtering
384 # using simple string matches (channel mode +g).
385 #<module name="chanfilter">
387 # If hidemask is set to yes, the user will not be shown the mask when
388 # his/her message is blocked.
389 #<chanfilter hidemask="yes">
391 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
392 # Channel history module: Displays the last 'X' lines of chat to a user
393 # joining a channel with +H 'X:T' set; 'T' is the maximum time to keep
394 # lines in the history buffer. Designed so that the new user knows what
395 # the current topic of conversation is when joining the channel.
396 #<module name="chanhistory">
398 # Set the maximum number of lines allowed to be stored per channel below.
399 # This is the hard limit for 'X'.
400 # If notice is set to yes, joining users will get a NOTICE before playback
401 # telling them about the following lines being the pre-join history.
402 # If bots is set to yes, it will also send to users marked with +B
403 #<chanhistory maxlines="50" notice="yes" bots="yes">
405 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
406 # Channel logging module: Used to send snotice output to channels, to
407 # allow staff to centrally monitor and discuss network activity.
409 # The "channel" field is where you want the messages to go, "snomasks"
410 # is what snomasks you want to be sent to that channel. Multiple tags
412 #<module name="chanlog">
413 #<chanlog snomasks="AOcC" channel="#opers">
415 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
416 # Channel names module: Allows disabling channels which have certain
417 # characters in the channel name such as bold, colorcodes, etc. which
418 # can be quite annoying and allow users to on occasion have a channel
419 # that looks like the name of another channel on the network.
420 #<module name="channames">
423 # denyrange: characters or range of characters to deny in channel
427 # allowrange: characters or range of characters to specifically allow
431 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
432 # Channelban: Implements extended ban j:, which stops anyone already
433 # in a channel matching a ban like +b j:#channel*mask from joining.
434 # Note that by default wildcard characters * and ? are allowed in
435 # channel names. To disallow them, load m_channames and add characters
436 # 42 and 63 to denyrange (see above).
437 #<module name="channelban">
439 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
440 # Check module: Adds the /CHECK command.
441 # Check is useful for looking up information on channels, users,
442 # IP addresses and hosts.
443 # This module is oper-only.
444 # To use, CHECK must be in one of your oper class blocks.
445 #<module name="check">
447 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
448 # CHGHOST module: Adds the /CHGHOST command.
449 # This module is oper-only.
450 # To use, CHGHOST must be in one of your oper class blocks.
451 # NOTE: Services will not be able to set vhosts on users if this module
452 # isn't loaded. If you're planning on running services, you probably
454 #<module name="chghost">
456 #-#-#-#-#-#-#-#-# /CHGHOST - /SETHOST CONFIGURATION #-#-#-#-#-#-#-#-#
457 # Optional - If you want to use special chars for hostnames you can #
458 # specify your own custom list of chars with the <hostname> tag: #
460 # charmap - A list of chars accepted as valid by the /CHGHOST #
461 # and /SETHOST commands. Also note that the list is #
463 #<hostname charmap="abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ.-_/0123456789">
465 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
466 # CHGIDENT module: Adds the /CHGIDENT command.
467 # This module is oper-only.
468 # To use, CHGIDENT must be in one of your oper class blocks.
469 #<module name="chgident">
471 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
472 # CHGNAME module: Adds the /CHGNAME command.
473 # This module is oper-only.
474 # To use, CHGNAME must be in one of your oper class blocks.
475 #<module name="chgname">
477 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
478 # Connection class ban module: Adds support for extban 'n' which
479 # matches against the class name of the user's connection.
480 # This module assumes that connection classes are named in a uniform
481 # way on all servers of the network.
482 #<module name="classban">
484 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
485 # Clear chan module: Allows opers to masskick, masskill or mass-G/ZLine
486 # all users on a channel using /CLEARCHAN.
487 #<module name="clearchan">
489 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
490 # Cloaking module: Adds usermode +x and cloaking support.
491 # Relies on the md5 module being loaded.
492 # To cloak users when they connect, load the conn_umodes module and set
493 # <connect:modes> to include the +x mode. The example <connect> tag
494 # shows this. See the conn_umodes module for more information.
495 #<module name="cloaking">
497 #-#-#-#-#-#-#-#-#-#-#- CLOAKING CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#
499 # To use cloaking, you must define a cloak key, and optionally a #
500 # cloak prefix as shown below. The cloak key must be shared across #
501 # the network for correct cloaking. #
503 # There are two methods of cloaking: #
505 # half Cloak only the "unique" portion of a host; by #
506 # default show the last 2 parts of the domain, #
507 # /16 subnet of IPv4 or /48 subnet of the IPv6 #
509 # To change the number of shown parts, modify the #
510 # domainparts option. #
512 # full Cloak the users completely, using three slices for #
513 # common CIDR bans (IPv4: /16, /24; IPv6: /48, /64). #
515 # The methods use a single key that can be any length of text. #
516 # An optional prefix may be specified to mark cloaked hosts. #
517 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
524 #-#-#-#-#-#-#-#-#-#-#-#- CLOSE MODULE #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
525 # Close module: Allows an oper to close all unregistered connections.
526 # This module is oper-only and provides the /CLOSE command.
527 # To use, CLOSE must be in one of your oper class blocks.
528 #<module name="close">
530 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
531 # Clones module: Adds an oper command /CLONES for detecting cloned
532 # users. Warning: This command may be resource intensive when it is
533 # issued, use with care.
534 # This module is oper-only.
535 # To use, CLONES must be in one of your oper class blocks.
536 #<module name="clones">
538 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
539 # Common channels module: Adds user mode +c, which, when set, requires
540 # that users must share a common channel with you to PRIVMSG or NOTICE
542 #<module name="commonchans">
544 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
545 # Auto join on connect module: Allows you to force users to join one
546 # or more channels automatically upon connecting to the server, or
547 # join them in case they aren't on any channels after being online
549 #<module name="conn_join">
551 #-#-#-#-#-#-#-#-#-#-#-#- CONNJOIN CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
553 # If you have the conn_join module loaded, you can configure it below
554 # or set autojoin="#chat,#help" in <connect> blocks.
556 # Join users immediately after connection to #one #two and #three.
557 #<autojoin channel="#one,#two,#three">
558 # Join users to #chat after 15 seconds if they aren't on any channels.
559 #<autojoin channel="#chat" delay="15">
561 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
562 # Set modes on connect module: When this module is loaded <connect>
563 # blocks may have an optional modes="" value, which contains modes to
564 # add or remove from users when they connect to the server.
565 #<module name="conn_umodes">
567 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
568 # Wait for PONG on connect module: Send a PING to all connecting users
569 # and don't let them connect until they reply with a PONG.
570 # This is useful to stop certain kinds of bots and proxies.
571 #<module name="conn_waitpong">
573 #-#-#-#-#-#-#-#-#-#-#- WAITPONG CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
575 # If you have the conn_waitpong module loaded, configure it with the #
578 # sendsnotice - Whether to send a helpful notice to users on #
579 # connect telling them how to connect, should #
580 # their client not reply PONG automatically. #
582 # killonbadreply - Whether to kill the user if they send the wrong #
585 #<waitpong sendsnotice="yes" killonbadreply="yes">
587 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
588 # Channel cycle module: Adds the /CYCLE command which is a server-side
589 # /HOP that bypasses restrictive modes.
590 #<module name="cycle">
592 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
593 # Connectban: Provides IP connection throttling. Any IP range that
594 # connects too many times (configurable) in an hour is Z-Lined for a
595 # (configurable) duration, and their count resets to 0.
596 #<module name="connectban">
598 # ipv4cidr and ipv6cidr allow you to turn the comparison from
599 # individual IP addresses (32 and 128 bits) into CIDR masks, to allow
600 # for throttling over whole ISPs/blocks of IPs, which may be needed to
603 # This allows for 10 connections in an hour with a 10 minute ban if
605 #<connectban threshold="10" duration="10m" ipv4cidr="32" ipv6cidr="128"
606 # A custom ban message may optionally be specified.
607 # 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.">
609 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
610 # Connection throttle module.
611 #<module name="connflood">
613 #-#-#-#-#-#-#-#-#-#-#- CONNTHROTTLE CONFIGURATION -#-#-#-#-#-#-#-#-#-#
614 # period, maxconns - Amount of connections per <period>.
616 # timeout - Time to wait after the throttle was activated
617 # before deactivating it. Be aware that the time
618 # is seconds + timeout.
620 # quitmsg - The message that users get if they attempt to
621 # connect while the throttle is active.
623 # bootwait - Amount of time in seconds to wait before enforcing
624 # the throttling when the server just booted.
626 #<connflood seconds="30" maxconns="3" timeout="30"
627 # quitmsg="Throttled" bootwait="10">
629 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
630 # Custom prefixes: Allows for channel prefixes to be configured.
631 #<module name="customprefix">
633 # name The name of the mode, must be unique from other modes.
634 # letter The letter used for this mode. Required.
635 # prefix The prefix used for nicks with this mode. Not required.
636 # rank A numeric rank for this prefix, defining what permissions it gives.
637 # The rank of voice, halfop and op is 10000, 20000, and 30000,
639 # ranktoset The numeric rank required to set this mode. Defaults to rank.
640 # ranktounset The numeric rank required to unset this mode. Defaults to ranktoset.
641 # depriv Can you remove the mode from yourself? Defaults to yes.
642 #<customprefix name="founder" letter="q" prefix="~" rank="50000" ranktoset="50000">
643 #<customprefix name="admin" letter="a" prefix="&" rank="40000" ranktoset="50000">
644 #<customprefix name="halfop" letter="h" prefix="%" rank="20000" ranktoset="30000">
646 # You can also override the configuration of prefix modes added by both the core
647 # and other modules by adding a customprefix tag with change="yes" specified.
648 # <customprefix name="op" change="yes" rank="30000" ranktoset="30000">
649 # <customprefix name="voice" change="yes" rank="10000" ranktoset="10000" depriv="no">
651 # Do /RELOADMODULE customprefix after changing the settings of this module.
653 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
654 # Custom title module: Adds the /TITLE command which allows for trusted
655 # users to gain a custom whois line and an optional vhost can be
657 #<module name="customtitle">
659 #-#-#-#-#-#-#-#-#-#- CUSTOM TITLE CONFIGURATION -#-#-#-#-#-#-#-#-#-#
660 # name - The username used to identify.
661 # password - The password used to identify.
662 # hash - The hash for the specific user's password (optional).
663 # password_hash and a hashing module must be loaded
665 # host - Allowed hostmask (optional).
666 # title - Title shown in whois.
667 # vhost - Displayed host (optional).
669 #<title name="foo" password="bar" title="Official Chat Helper">
670 #<title name="bar" password="foo" host="ident@test.org" title="Official Chat Helper" vhost="helper.test.org">
671 #<title name="foo" password="$2a$10$UYZ4OcO8NNTCCGyCdY9SK.2GHiqGgxZfHFPOPmWuxEVWVQTtoDC7C" hash="bcrypt" title="Official Chat Helper">
673 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
674 # DCCALLOW module: Adds the /DCCALLOW command.
675 #<module name="dccallow">
677 #-#-#-#-#-#-#-#-#-#-#- DCCALLOW CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
678 # blockchat - Whether to block DCC CHAT as well as DCC SEND.
679 # length - Default duration of entries in DCCALLOW list.
680 # action - Default action to take if no action is
681 # specified, can be 'block' or 'allow'.
682 # maxentries - Max number of nicks to allow on a DCCALLOW list.
684 # File configuration:
685 # pattern - The glob pattern to match against.
686 # action - Action to take if a user attempts to send a file
687 # that matches this pattern, can be 'block' or
690 #<dccallow blockchat="yes" length="5m" action="block" maxentries="20">
691 #<banfile pattern="*.exe" action="block">
692 #<banfile pattern="*.txt" action="allow">
694 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
695 # Deaf module: Adds support for the usermode +d - deaf to channel
696 # messages and channel notices.
697 #<module name="deaf">
699 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
700 # Delay join module: Adds the channel mode +D which delays all JOIN
701 # messages from users until they speak. If they quit or part before
702 # speaking, their quit or part message will not be shown to the channel
703 # which helps cut down noise on large channels in a more friendly way
704 # than the auditorium mode. Only channel ops may set the +D mode.
705 #<module name="delayjoin">
707 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
708 # Delay message module: Adds the channel mode +d which disallows a user
709 # from talking in the channel unless they've been joined for X seconds.
710 # Settable using /MODE #chan +d 30
711 #<module name="delaymsg">
712 # Set allownotice to no to disallow NOTICEs too. Defaults to yes.
713 #<delaymsg allownotice="no">
715 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
716 # Deny channels module: Deny channels from being used by users.
717 #<module name="denychans">
719 #-#-#-#-#-#-#-#-#-#-#- DENYCHAN DEFINITIONS -#-#-#-#-#-#-#-#-#-#-#-#
721 # If you have the denychans module loaded, you need to specify the #
722 # channels to deny: #
724 # name - The channel name to deny (glob masks are ok). #
725 # allowopers - If operators are allowed to override the deny. #
726 # reason - Reason given for the deny. #
727 # redirect - Redirect the user to a different channel. #
729 #<badchan name="#gods*" allowopers="yes" reason="Tortoises!"> #
730 #<badchan name="#chan1" redirect="#chan2" reason="Chan1 is closed"> #
732 # Redirects will not work if the target channel is set +L. #
734 # Additionally, you may specify channels which are allowed, even if #
735 # a badchan tag specifies it would be denied: #
736 #<goodchan name="#funtimes"> #
737 # Glob masks are accepted here also. #
739 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
740 # DNS blacklist module: Provides support for looking up IPs on one or #
742 #<module name="dnsbl"> #
744 # For configuration options please see the wiki page for dnsbl at #
745 # https://wiki.inspircd.org/Modules/3.0/dnsbl #
747 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
748 # Exempt channel operators module: Provides support for allowing #
749 # channel operators to be exempt from some channel modes. Supported #
750 # modes are blockcaps, noctcp, blockcolor, nickflood, flood, censor, #
751 # filter, regmoderated, nonick, nonotice, and stripcolor. #
752 #<module name="exemptchanops"> #
754 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
755 # Filter module: Provides message filtering, similar to SPAMFILTER. #
756 #<module name="filter">
758 # This module depends upon a regex provider such as regex_pcre or #
759 # regex_glob to function. You must specify which of these you want #
760 # the filter module to use via the tag below. #
762 # Valid engines are: #
764 # glob - Glob patterns, provided via regex_glob. #
765 # pcre - PCRE regexps, provided via regex_pcre, needs libpcre. #
766 # tre - TRE regexps, provided via regex_tre, requires libtre. #
767 # posix - POSIX regexps, provided via regex_posix, not available #
768 # on Windows, no dependencies on other operating systems. #
769 # stdlib - stdlib regexps, provided via regex_stdlib, see comment #
770 # at the <module> tag for info on availability. #
772 #<filteropts engine="glob"> #
774 # Your choice of regex engine must match on all servers network-wide.
776 # To learn more about the configuration of this module, read #
777 # examples/filter.conf.example, which covers the various types of #
778 # filters and shows how to add exemptions. #
780 #-#-#-#-#-#-#-#-#-#-#- FILTER CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#
782 # Optional - If you specify to use the filter module, then #
783 # specify below the path to the filter.conf file, or define some #
786 #<include file="examples/filter.conf.example">
788 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
789 # Flash Policy Daemon module: Allows Flash IRC clients (e.g. LightIRC)#
790 # to connect. If no file is specified, it'll serve a default policy #
791 # allowing all IPs to connect to all plaintext IRC ports #
792 #<bind address="" port="8430" type="flashpolicyd"> #
793 #<flashpolicyd timeout="5" file=""> #
794 #<module name="flashpolicyd"> #
796 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
797 # Gecos ban: Implements extended ban 'r', which stops anyone matching
798 # a mask like +b r:*realname?here* from joining a channel.
799 #<module name="gecosban">
801 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
802 # GeoIP module: Allows the server admin to match users by country code.
803 # This module is in extras. Re-run configure with:
804 # ./configure --enable-extras=m_geoip.cpp
805 # and run make install, then uncomment this module to enable it.
806 # This module requires GeoIP to be installed on your system,
807 # use your package manager to find the appropriate packages
808 # or check the InspIRCd wiki page for this module.
809 #<module name="geoip">
811 # The actual allow/ban actions are done by connect classes, not by the
812 # GeoIP module. An example connect class to ban people from russia or
815 # <connect deny="*" geoip="TR,RU">
817 # The country code must be in capitals and should be an ISO country
818 # code such as TR, GB, or US. Unknown IPs (localhost, LAN IPs, etc)
819 # will be assigned the country code "UNK". Since connect classes are
820 # matched from top down, your deny classes must be above your allow
821 # classes for them to match.
823 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
824 # Globops module: Provides the /GLOBOPS command and snomask +g.
825 # This module is oper-only.
826 # To use, GLOBOPS must be in one of your oper class blocks.
827 #<module name="globops">
829 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
830 # Global load module: Allows loading and unloading of modules network-
831 # wide (USE WITH EXTREME CAUTION!)
832 # This module is oper-only and provides /GLOADMODULE, /GUNLOADMODULE
833 # and /GRELOADMODULE.
834 # To use, GLOADMODULE, GUNLOADMODULE and GRELOADMODULE
835 # must be in one of your oper class blocks.
836 #<module name="globalload">
838 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
839 # HELPOP module: Provides the /HELPOP command
840 #<module name="helpop">
842 #-#-#-#-#-#-#-#-#-#-#-#- HELPOP CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
844 # If you specify to use the helpop module, then specify below the #
845 # path to the helpop.conf file. #
847 #<include file="examples/inspircd.helpop-full.example">
849 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
850 # Hide chans module: Allows users to hide their channels list from non-
851 # opers by setting user mode +I on themselves.
852 #<module name="hidechans">
854 # This mode can optionally prevent opers from seeing channels on a +I
855 # user, for more privacy if set to true.
856 # This setting is not recommended for most mainstream networks.
857 #<hidechans affectsopers="false">
859 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
860 # Hide list module: Allows for hiding the list of listmodes from users
861 # who do not have sufficient channel rank.
862 #<module name="hidelist">
864 # Each <hidelist> tag configures one listmode to hide.
865 # mode: Name of the listmode to hide.
866 # rank: Minimum rank required to view the list. If set to 0, all
867 # members of the channel may view the list, but non-members may not.
868 # The rank of the built-in op and voice mode is 30000 and 10000,
869 # respectively; the rank of other prefix modes is configurable.
872 # Hiding the ban list is not recommended because it may break some
875 # Hide filter (+g) list:
876 #<hidelist mode="filter" rank="30000">
877 # Only show invite exceptions (+I) to channel members:
878 #<hidelist mode="invex" rank="0">
880 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
881 # Hide oper module: Allows opers to hide their oper status from non-
882 # opers by setting user mode +H on themselves.
883 # This module is oper-only.
884 #<module name="hideoper">
886 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
887 # Hostchange module: Allows a different style of cloaking.
888 #<module name="hostchange">
890 #-#-#-#-#-#-#-#-#-#-#- HOSTCHANGE CONFIGURATION -#-#-#-#-#-#-#-#-#-#
892 # See https://wiki.inspircd.org/Modules/3.0/hostchange for help. #
894 #<host suffix="invalid.org" separator="." prefix="">
895 #<hostchange mask="*@42.theanswer.example.org" action="addnick">
896 #<hostchange mask="*root@*" action="suffix">
897 #<hostchange mask="a@example.com" action="set" value="foo.bar.baz">
898 #<hostchange mask="localhost" ports="7000,7001,7005-7007" action="set" value="blahblah.foo">
900 # hostcycle: If loaded, when a user gets a host or ident set, it will
901 # cycle them in all their channels. If not loaded it will simply change
902 # their host/ident without cycling them.
903 # This module is compatible with the ircv3_chghost module. Clients
904 # supporting the chghost extension will get the chghost message instead
905 # of seeing a host cycle.
906 #<module name="hostcycle">
908 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
909 # httpd module: Provides HTTP server support for InspIRCd.
910 #<module name="httpd">
912 #-#-#-#-#-#-#-#-#-#-#-#- HTTPD CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
914 # If you choose to use the httpd module, then you will need to add
915 # a <bind> tag with type "httpd", and load at least one of the other
916 # httpd_* modules to provide pages to display.
918 # You can adjust the timeout for HTTP connections below. All HTTP
919 # connections will be closed after (roughly) this time period.
920 #<httpd timeout="20">
922 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
923 # HTTP ACL module: Provides access control lists for httpd dependent
924 # modules. Use this module to restrict pages by IP address and by
926 #<module name="httpd_acl">
928 #-#-#-#-#-#-#-#-#-#-#-#- HTTPD ACL CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
930 # Restrict access to the httpd_stats module to all but the local
931 # network and when the correct password is specified:
932 # <httpdacl path="/stats*" types="password,whitelist"
933 # username="secrets" password="mypasshere" whitelist="127.0.0.*,10.*">
935 # Deny all connections to all but the main index page:
936 # <httpdacl path="/*" types="blacklist" blacklist="*">
938 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
939 # HTTP config module: Allows the configuration of the server to be
940 # viewed over HTTP. Requires httpd to be loaded for it to function.
941 #<module name="httpd_config">
943 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
944 # HTTP stats module: Provides basic stats pages over HTTP.
945 # Requires httpd to be loaded for it to function.
946 #<module name="httpd_stats">
948 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
949 # Ident: Provides RFC 1413 ident lookup support.
950 # When this module is loaded <connect:allow> tags may have an optional
951 # useident="yes|no" boolean value, determining whether or not to lookup
952 # ident on users matching that connect tag.
953 #<module name="ident">
955 #-#-#-#-#-#-#-#-#-#-#-#- IDENT CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
957 # Optional - If you are using the ident module, then you can specify #
958 # the timeout for ident lookups here. If not defined, it will default #
959 # to 5 seconds. This is a non-blocking timeout which holds the user #
960 # in a 'connecting' state until the lookup is complete. #
961 # The bind value indicates which IP to bind outbound requests to. #
962 # nolookupprefix: If on, the idents of users being in a connect class #
963 # with ident lookups disabled (i.e. <connect useident="off">) will be #
964 # prefixed with a "~". If off, the ident of those users will not be #
965 # prefixed. Default is off. #
967 #<ident timeout="5" nolookupprefix="no">
969 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
970 # Invite exception module: Adds support for channel invite exceptions
972 #<module name="inviteexception">
973 # bypasskey: If this is enabled, exceptions will bypass +k as well as +i
974 #<inviteexception bypasskey="yes">
976 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
977 # IRCv3 module: Provides the following IRCv3 extensions:
978 # extended-join, away-notify and account-notify. These are optional
979 # enhancements to the client-to-server protocol. An extension is only
980 # active for a client when the client specifically requests it, so this
981 # module needs the cap module to work.
983 # Further information on these extensions can be found at the IRCv3
984 # working group website:
985 # http://ircv3.net/irc/
987 #<module name="ircv3">
988 # The following block can be used to control which extensions are
989 # enabled. Note that extended-join can be incompatible with delayjoin
991 #<ircv3 accountnotify="on" awaynotify="on" extendedjoin="on">
993 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
994 # IRCv3 cap-notify module: Provides the cap-notify IRCv3.2 extension.
995 # Required for IRCv3.2 conformance.
996 #<module name="ircv3_capnotify">
998 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
999 # IRCv3 chghost module: Provides the chghost IRCv3.2 extension which
1000 # allows capable clients to learn when the host/ident of another user
1001 # changes without cycling the user. This module is compatible with the
1002 # hostcycle module. If both are loaded, clients supporting the chghost
1003 # extension will get the chghost message and won't see host cycling.
1004 #<module name="ircv3_chghost">
1006 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1007 # IRCv3 echo-message module: Provides the echo-message IRCv3.2
1008 # extension which allows capable clients to get an acknowledgement when
1009 # their messages are delivered and learn what modifications, if any,
1010 # were applied to them.
1011 #<module name="ircv3_echomessage">
1013 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1014 # IRCv3 invite-notify module: Provides the invite-notify IRCv3.2
1015 # extension which notifies supporting clients when a user invites
1016 # another user into a channel. This respects <options:announceinvites>.
1017 #<module name="ircv3_invitenotify">
1019 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1020 # IRCv3 Strict Transport Security module: Provides the sts IRCv3.2
1021 # extension which allows clients connecting insecurely to upgrade their
1022 # connections to TLS.
1023 #<module name="ircv3_sts">
1025 # If using the ircv3_sts module you MUST define a STS policy to send
1026 # to clients using the <sts> tag. This tag takes the following
1029 # host - A glob match for the SNI hostname to apply this policy to.
1030 # duration - The amount of time that the policy lasts for. Defaults to
1031 # approximately two months by default.
1032 # port - The port on which TLS connections to the server are being
1033 # accepted. You MUST have a CA-verified certificate on this
1034 # port. Self signed certificates are not acceptable.
1035 # preload - Whether client developers can include your certificate in
1038 # <sts host="*.example.com" duration="60d" port="6697" preload="yes">
1040 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1041 # Join flood module: Adds support for join flood protection +j X:Y.
1042 # Closes the channel for N seconds if X users join in Y seconds.
1043 #<module name="joinflood">
1045 # The number of seconds to close the channel for:
1046 #<joinflood duration="1m">
1048 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1049 # Jump server module: Adds support for the RPL_REDIR numeric.
1050 # This module is oper-only.
1051 # To use, JUMPSERVER must be in one of your oper class blocks.
1052 # If your server is redirecting new clients and you get disconnected,
1053 # do a REHASH from shell to open up again.
1054 #<module name="jumpserver">
1056 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1057 # Anti auto rejoin: Adds support for prevention of auto-rejoin (+J).
1058 #<module name="kicknorejoin">
1060 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1061 # Knock module: Adds the /KNOCK command and channel mode +K.
1062 #<module name="knock">
1064 # This setting specifies what to do when someone successfully /KNOCKs.
1065 # If set to "notice", then a NOTICE will be sent to the channel.
1066 # This is the default and the compatible setting, as it requires no
1067 # special support from the clients.
1068 # If set to "numeric" then a 710 numeric will be sent to the channel.
1069 # This allows easier scripting but not all clients support it.
1070 # If set to "both" then (surprise!) both will be sent.
1071 #<knock notify="notice">
1073 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1074 # LDAP module: Allows other SQL modules to access a LDAP database
1075 # through a unified API.
1076 # This modules is in extras. Re-run configure with:
1077 # ./configure --enable-extras=m_ldap.cpp
1078 # and run make install, then uncomment this module to enable it.
1080 #<module name="ldap">
1081 #<database module="ldap" id="ldapdb" server="ldap://localhost" binddn="cn=Manager,dc=inspircd,dc=org" bindauth="mysecretpass" searchscope="subtree">
1082 # The server parameter indicates the LDAP server to connect to. The #
1083 # ldap:// style scheme before the hostname proper is MANDATORY. #
1085 # The binddn and bindauth indicate the DN to bind to for searching, #
1086 # and the password for the distinguished name. Some LDAP servers will #
1087 # allow anonymous searching in which case these two values do not #
1088 # need defining, otherwise they should be set similar to the examples #
1091 # The searchscope value indicates the subtree to search under. On our #
1092 # test system this is 'subtree'. Your mileage may vary. #
1094 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1095 # LDAP authentication module: Adds the ability to authenticate users #
1097 #<module name="ldapauth">
1101 # <ldapauth dbid="ldapdb" #
1102 # baserdn="ou=People,dc=brainbox,dc=cc" #
1104 # allowpattern="Guest* Bot*" #
1105 # killreason="Access denied" #
1107 # host="$uid.$ou.inspircd.org" #
1108 # useusername="no"> #
1110 # <ldapwhitelist cidr="10.42.0.0/16"> #
1112 # <ldaprequire attribute="attr" value="val"> #
1114 # The baserdn indicates the base DN to search in for users. Usually #
1115 # this is 'ou=People,dc=yourdomain,dc=yourtld'. #
1117 # The attribute value indicates the attribute which is used to locate #
1118 # a user account by name. On POSIX systems this is usually 'uid'. #
1120 # The allowpattern value allows you to specify a space separated list #
1121 # of wildcard masks which will always be allowed to connect #
1122 # regardless of if they have an account, for example guest and bot #
1125 # The useusername setting chooses whether the user's username or #
1126 # nickname is used when locating a user account, if a username isn't #
1127 # provided in PASS. #
1129 # Killreason indicates the QUIT reason to give to users if they fail #
1130 # to authenticate. #
1132 # Setting the verbose value causes an oper notice to be sent out for #
1133 # every failed authentication to the server, with an error string. #
1135 # ldapwhitelist indicates that clients connecting from an IP in the #
1136 # provided CIDR do not need to authenticate against LDAP. It can be #
1137 # repeated to whitelist multiple CIDRs. #
1139 # ldaprequire allows further filtering on the LDAP user, by requiring #
1140 # certain LDAP attibutes to have a given value. It can be repeated, #
1141 # in which case the list will act as an OR list, that is, the #
1142 # authentication will succeed if any of the requirements in the list #
1145 # host allows you to change the displayed host of users connecting #
1146 # from ldap. The string supplied takes formatters which are replaced #
1147 # from the DN. For instance, if your DN looks like: #
1148 # uid=w00t,ou=people,dc=inspircd,dc=org, then the formatters uid, ou #
1149 # and dc will be available to you. If a key is given multiple times #
1150 # in the DN, the last appearance will take precedence. #
1152 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1153 # LDAP oper configuration module: Adds the ability to authenticate #
1155 #<module name="ldapoper">
1159 # <ldapoper dbid="ldapdb"
1160 # baserdn="ou=People,dc=brainbox,dc=cc"
1163 # Available configuration items are identical to the same items in #
1164 # ldapauth above (except for the verbose setting, that is only #
1165 # supported in ldapauth). #
1166 # Please always specify a password in your <oper> tags even if the #
1167 # opers are to be authenticated via LDAP, so in case this module is #
1168 # not loaded the oper accounts are still protected by a password. #
1170 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1171 # Lock server module: Adds /LOCKSERV and /UNLOCKSERV commands that #
1172 # are used to temporarily close/open the server for new connections. #
1173 # These commands require that the /LOCKSERV and /UNLOCKSERV commands #
1174 # are specified in a <class> tag that the oper is part of. This is so #
1175 # you can control who has access to this possible dangerous command. #
1176 # If your server is locked and you get disconnected, do a REHASH from #
1177 # shell to open up again. #
1178 # This module is oper-only.
1179 #<module name="lockserv">
1181 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1182 # Map hiding module: replaces /MAP and /LINKS output to users with a #
1183 # message to see a website, set by maphide="http://test.org/map" in #
1184 # the <security> tag, instead. #
1185 #<module name="maphide">
1187 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1188 # Message flood module: Adds message/notice flood protection via
1190 #<module name="messageflood">
1192 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1193 # MLOCK module: Adds support for server-side enforcement of services
1194 # side MLOCKs. Basically, this module suppresses any mode change that
1195 # would likely be immediately bounced by services.
1196 #<module name="mlock">
1198 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1199 # Modenotice module: Adds the /MODENOTICE command that allows opers to
1200 # send notices to all users having the given user mode(s) set.
1201 #<module name="modenotice">
1203 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1204 # Monitor module: Adds support for MONITOR which is used by clients to
1205 # maintain notify lists.
1206 #<module name="monitor">
1208 # Set the maximum number of entries on a user's monitor list below.
1209 #<monitor maxentries="30">
1211 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1212 # MySQL module: Allows other SQL modules to access MySQL databases
1213 # through a unified API.
1214 # This module is in extras. Re-run configure with:
1215 # ./configure --enable-extras=m_mysql.cpp
1216 # and run make install, then uncomment this module to enable it.
1217 #<module name="mysql">
1219 #-#-#-#-#-#-#-#-#-#-#-#- SQL CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#-#
1221 # mysql is more complex than described here, see the wiki for more #
1222 # info: https://wiki.inspircd.org/Modules/3.0/mysql #
1224 #<database module="mysql" name="mydb" user="myuser" pass="mypass" host="localhost" id="my_database2">
1226 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1227 # Named modes module: Allows for the display and set/unset of channel
1228 # modes via long-form mode names via +Z and the /PROP command.
1229 # For example, to set a ban, do /mode #channel +Z ban=foo!bar@baz or
1230 # /PROP #channel ban=foo!bar@baz
1231 #<module name="namedmodes">
1233 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1234 # NAMESX module: Provides support for the NAMESX extension which allows
1235 # clients to see all the prefixes set on a user without getting confused.
1236 # This is supported by mIRC, x-chat, klient, and maybe more.
1237 #<module name="namesx">
1239 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1240 # National characters module:
1241 # 1) Allows using national characters in nicknames.
1242 # 2) Allows using custom (national) casemapping over the network.
1243 #<module name="nationalchars">
1245 # file - Location of the file which contains casemapping rules. If this
1246 # is a relative path then it is relative to "<PWD>/../locales"
1247 # on UNIX and "<PWD>/locales" on Windows.
1248 # casemapping - The name of the casemapping sent to clients in the 005
1249 # numeric. If this is not set then it defaults to the name
1250 # of the casemapping file unless the file name contains a
1251 # space in which case you will have to specify it manually.
1252 #<nationalchars file="bynets/russian-w1251-charlink" casemapping="ru_RU.cp1251-charlink">
1254 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1255 # Nickchange flood protection module: Provides channel mode +F X:Y
1256 # which allows up to X nick changes in Y seconds.
1257 #<module name="nickflood">
1259 # The number of seconds to prevent nick changes for:
1260 #<nickflood duration="1m">
1262 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1263 # Nicklock module: Let opers change a user's nick and then stop that
1264 # user from changing their nick again until unlocked.
1265 # This module is oper-only.
1266 # To use, NICKLOCK and NICKUNLOCK must be in one of your oper class blocks.
1267 #<module name="nicklock">
1269 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1270 # No CTCP module: Adds the channel mode +C to block CTCPs and extban
1271 # 'C' to block CTCPs sent by specific users.
1272 #<module name="noctcp">
1274 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1275 # No kicks module: Adds the +Q channel mode and the Q: extban to deny
1276 # certain users from kicking.
1277 #<module name="nokicks">
1279 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1280 # No nicks module: Adds the +N channel mode, as well as the 'N' extban.
1281 # +N stops all users from changing their nick, the N extban stops
1282 # anyone from matching a +b N:nick!user@host mask from changing their
1284 #<module name="nonicks">
1286 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1287 # No part message module: Adds extban 'p' to block part messages from #
1289 #<module name="nopartmsg">
1291 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1292 # No notice module: Adds the channel mode +T and the extban 'T' to
1293 # block specific users from noticing the channel.
1294 #<module name="nonotice">
1296 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1297 # Network business join module:
1298 # Allows an oper to join a channel using /OJOIN, giving them +Y on the
1299 # channel which makes them immune to kick/deop/etc.
1300 #<module name="ojoin">
1302 # Specify the prefix that +Y will grant here.
1303 # Leave 'prefix' empty if you do not wish +Y to grant a prefix.
1304 # If 'notice' is set to on, upon /OJOIN, the server will notice the
1305 # channel saying that the oper is joining on network business.
1306 # If 'op' is set to on, it will give them +o along with +Y.
1307 #<ojoin prefix="!" notice="yes" op="yes">
1309 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1310 # Oper channels mode: Adds the +O channel mode and extban O:<mask>
1311 # to ban, except, etc. specific oper types. For example
1312 # /mode #channel +iI O:* is equivalent to channel mode +O, but you
1313 # may also set +iI O:AdminTypeOnly to only allow admins.
1314 # Modes +I and +e work in a similar fashion.
1315 #<module name="operchans">
1317 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1318 # Oper join module: Auto-joins opers to a channel upon oper-up.
1319 # This module is oper-only. For the user equivalent, see the conn_join
1321 #<module name="operjoin">
1323 #-#-#-#-#-#-#-#-#-#-# OPERJOIN CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
1325 # If you are using the operjoin module, specify options here: #
1327 # channel - The channel name to join, can also be a comma #
1328 # separated list e.g. "#channel1,#channel2". #
1330 # override - If on, lets the oper join walking thru any modes #
1331 # that might be set, even bans. #
1333 #<operjoin channel="#channel" override="no">
1335 # Alternatively you can use the autojoin="channellist" in a <type> #
1336 # tag to set specific autojoins for a type of oper, for example: #
1338 #<type name="Helper" autojoin="#help" classes="...">
1340 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1341 # Oper log module: Logs all oper commands to the server log (with log
1342 # type "m_operlog" at default loglevel), and optionally to the 'r'
1344 # This module is oper-only.
1345 #<module name="operlog">
1347 # If the following option is on then all oper commands will be sent to
1348 # the snomask 'r'. The default is off.
1349 #<operlog tosnomask="off">
1351 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1352 # Oper prefixing module: Adds a channel prefix mode +y which is given
1353 # to all IRC operators automatically on all channels they are in.
1354 # This prefix mode is more powerful than channel op and other regular
1357 # Load this module if you want all your IRC operators to have channel
1359 #<module name="operprefix">
1361 # You may additionally customise the prefix character.
1362 #<operprefix prefix="!">
1364 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1365 # Oper MOTD module: Provides support for separate message of the day
1367 # This module is oper-only.
1368 #<module name="opermotd">
1370 #-#-#-#-#-#-#-#-#-#-# OPERMOTD CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
1372 # If you are using the opermotd module, specify the motd here. #
1374 # onoper - If on, the message is sent on /OPER, otherwise it's #
1375 # only sent when /OPERMOTD is used. #
1377 # processcolors - Allow color codes to be processed in the opermotd. #
1378 # Read the comment above <connect:allowmotdcolors> in #
1379 # inspircd.conf.example for details. #
1381 #<opermotd file="examples/opermotd.txt.example" onoper="yes" processcolors="false">
1383 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1384 # Override module: Adds support for oper override.
1385 # This module is oper-only.
1386 #<module name="override">
1388 #-#-#-#-#-#-#-#-#-#-# OVERRIDE CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
1390 # Much of override's configuration relates to your oper blocks. #
1391 # For more information on how to allow opers to override, see: #
1392 # https://wiki.inspircd.org/Modules/3.0/override #
1394 # noisy - If enabled, all oper overrides will be announced #
1395 # via channel notice. #
1397 # requirekey - If enabled, overriding on join requires a channel #
1398 # key of "override" to be specified #
1400 # enableumode - If enabled, usermode +O is required for override. #
1402 #<override noisy="yes" requirekey="no" enableumode="true">
1404 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1405 # Oper levels module: Gives each oper a level and prevents actions
1406 # being taken by lower level opers against higher level opers.
1407 # Specify the level as the 'level' parameter of the <type> tag.
1408 # This module is oper-only.
1409 #<module name="operlevels">
1411 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1412 # Oper modes module: Allows you to specify modes to add/remove on oper.
1413 # Specify the modes as the 'modes' parameter of the <type> tag
1414 # and/or as the 'modes' parameter of the <oper> tag.
1415 # This module is oper-only. For the user equivalent, see the
1416 # conn_umodes module.
1417 #<module name="opermodes">
1419 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1420 # Password forwarding module: Forwards a password users can send on
1421 # connect to the specified client below. The client is usually NickServ
1422 # and this module is usually used to authenticate users with NickServ
1423 # using their connect password.
1424 #<module name="passforward">
1427 # nick: nick to forward connect passwords to.
1430 # forwardmsg: Message to send to users using a connect password.
1431 # $nick will be the users' nick, $nickrequired will be the nick
1432 # of where the password is going (the nick above).
1433 # You can also use $user for the user ident string.
1434 forwardmsg="NOTICE $nick :*** Forwarding PASS to $nickrequired"
1436 # cmd: Command for the user to run when it receives a connect
1438 cmd="PRIVMSG $nickrequired :IDENTIFY $pass">
1440 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1441 # Password hash module: Allows hashed passwords to be used.
1442 # To be useful, a hashing module like bcrypt also needs to be loaded.
1443 #<module name="password_hash">
1445 #-#-#-#-#-#-#-#-#-# PASSWORD HASH CONFIGURATION #-#-#-#-#-#-#-#-#-#-#-#
1447 # To use this module, you must define a hash type for each oper's
1448 # password you want to hash. For example:
1450 # <oper name="Brain"
1451 # host="ident@dialup15.isp.test.com"
1453 # password="$2a$10$Mss9AtHHslZTLBrXqM0FB.JBwD.UTSu8A48SfrY9exrpxbsRiRTbO"
1456 # If you are using a hash algorithm which does not perform salting you can use
1457 # HMAC to salt your passwords in order to prevent them from being looked up in
1460 # hash="hmac-sha256" password="lkS1Nbtp$CyLd/WPQXizsbxFUTqFRoMvaC+zhOULEeZaQkUJj+Gg"
1462 # Generate hashes using the /MKPASSWD command on the server.
1463 # Don't run it on a server you don't trust with your password.
1465 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1466 # PBKDF2 module: Allows other modules to generate PBKDF2 hashes,
1467 # usually for cryptographic uses and security.
1468 # This module relies on other hash providers (e.g. SHA256).
1469 #<module name="pbkdf2">
1471 # iterations: Iterations the hashing function runs when generating new
1473 # length: Length in bytes of the derived key.
1474 #<pbkdf2 iterations="12288" length="32">
1475 # You can override these values with specific values
1476 # for specific providers if you want to. Example given for SHA256.
1477 #<pbkdf2prov hash="sha256" iterations="24576">
1479 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1480 # Permanent channels module: Channels with the permanent channel mode
1481 # will remain open even after everyone else has left the channel, and
1482 # therefore keep things like modes, ban lists and topic. Permanent
1483 # channels -may- need support from your Services package to function
1484 # properly with them. This adds channel mode +P.
1485 # This module is oper-only.
1486 #<module name="permchannels">
1488 # If you like, this module can write a config file of permanent channels
1489 # whenever +P is set, unset, or the topic/modes on a +P channel is changed.
1490 # If you want to do this, set the filename below, and uncomment the include.
1492 # If 'listmodes' is true then all list modes (+b, +I, +e, +g...) will be
1493 # saved. Defaults to false.
1494 #<permchanneldb filename="permchannels.conf" listmodes="true">
1495 #<include file="permchannels.conf">
1497 # You may also create channels on startup by using the <permchannels> block.
1498 #<permchannels channel="#opers" modes="isP" topic="Opers only.">
1500 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1501 # PostgreSQL module: Allows other SQL modules to access PgSQL databases
1502 # through a unified API.
1503 # This module is in extras. Re-run configure with:
1504 # ./configure --enable-extras=m_pgsql.cpp
1505 # and run make install, then uncomment this module to enable it.
1506 #<module name="pgsql">
1508 #-#-#-#-#-#-#-#-#-#-#-#- SQL CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#-#
1510 # pgsql is more complex than described here, see the wiki for #
1511 # more: https://wiki.inspircd.org/Modules/3.0/pgsql #
1513 #<database module="pgsql" name="mydb" user="myuser" pass="mypass" host="localhost" id="my_database" ssl="no">
1515 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1516 # Muteban: Implements extended ban 'm', which stops anyone matching
1517 # a mask like +b m:nick!user@host from speaking on channel.
1518 #<module name="muteban">
1520 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1521 # Random quote module: Provides a random quote on connect.
1522 # NOTE: Some of these may mimic fatal errors and confuse users and
1523 # opers alike - BEWARE!
1524 #<module name="randquote">
1526 #-#-#-#-#-#-#-#-#-#- RANDOMQUOTES CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
1528 # Optional - If you specify to use the randquote module, then specify #
1529 # below the path to the quotes file. #
1531 #<randquote file="quotes.txt">
1533 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1534 # Redirect module: Adds channel mode +L which redirects users to #
1535 # another channel when the channel has reached its user limit and #
1536 # user mode +L which stops redirection. #
1537 #<module name="redirect">
1539 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1540 # Regular expression provider for glob or wildcard (?/*) matching.
1541 # You must have at least 1 provider loaded to use the filter or rline
1542 # modules. This module has no additional requirements, as it uses the
1543 # matching already present in InspIRCd core.
1544 #<module name="regex_glob">
1546 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1547 # Regular expression provider for PCRE (Perl-Compatible Regular
1548 # Expressions). You need libpcre installed to compile and load this
1549 # module. You must have at least 1 provider loaded to use the filter or
1551 #<module name="regex_pcre">
1553 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1554 # Regular Expression Provider for RE2 Regular Expressions.
1555 # You need libre2 installed and in your include/library paths in order
1556 # to compile and load this module.
1557 #<module name="regex_re2">
1559 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1560 # Regular expression provider for POSIX regular expressions.
1561 # You shouldn't need any additional libraries on a POSIX-compatible
1562 # system (i.e.: any Linux, BSD, but not Windows). You must have at
1563 # least 1 provider loaded to use filter or rline.
1564 # On POSIX-compliant systems, regex syntax can be found by using the
1565 # command: 'man 7 regex'.
1566 #<module name="regex_posix">
1568 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1569 # Regular expression provider for C++11 std::regex regular expressions.
1570 # This module works on any fully compliant implementation of the C++11
1571 # std::regex container. Examples for such are Visual C++ 2010 and newer
1572 # but not libstdc++ (which GCC uses).
1573 # You should verify that std::regex is supported by your setup before
1574 # using this module, as it may compile normally but won't do anything
1575 # on some implementations.
1576 #<module name="regex_stdlib">
1578 # Specify the regular expression engine to use here. Valid settings are
1579 # bre, ere, awk, grep, egrep, ecmascript (default if not specified).
1580 #<stdregex type="ecmascript">
1582 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1583 # Regular expression provider for TRE regular expressions.
1584 # This is the same regular expression engine used by UnrealIRCd, so
1585 # if you are most familiar with the syntax of /SPAMFILTER from there,
1586 # this is the provider you want. You need libtre installed in order
1587 # to compile and load this module.
1588 #<module name="regex_tre">
1590 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1591 # Registered users only channel creation module. If enabled, only
1592 # registered users and opers can create new channels.
1594 # You probably *DO NOT* want to load this module on a public network.
1596 #<module name="regonlycreate">
1598 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1599 # Remove module: Adds the /REMOVE command which is a peaceful
1600 # alternative to /KICK.
1601 #<module name="remove">
1603 # supportnokicks: If true, /REMOVE is not allowed on channels where the
1604 # nokicks (+Q) mode is set. Defaults to false.
1605 # protectedrank: Members having this rank or above may not be /REMOVE'd
1606 # by anyone. Set to 0 to disable this feature. Defaults to 50000.
1607 #<remove supportnokicks="true" protectedrank="50000">
1609 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1610 # A module to block, kick or ban upon similar messages being uttered several times.
1611 # Syntax [~*][lines]:[sec]{[:difference]}{[:matchlines]}
1612 # ~ is to block, * is to ban, default is kick.
1613 # 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
1614 # seconds - How old the message has to be before it's invalidated.
1615 # distance - Edit distance, in percent, between two strings to trigger on.
1616 # matchlines - When set, the function goes into mode 2. In this mode the function will trigger if this many of the last <lines> matches.
1618 # As this module can be rather CPU-intensive, it comes with some options.
1619 # maxbacklog - Maximum size that can be specified for backlog. 0 disables multiline matching.
1620 # maxdistance - Max percentage of difference between two lines we'll allow to match. Set to 0 to disable edit-distance matching.
1621 # maxlines - Max lines of backlog to match against.
1622 # maxtime - Maximum period of time a user can set. 0 to allow any.
1623 # size - Maximum number of characters to check for, can be used to truncate messages
1624 # before they are checked, resulting in less CPU usage. Increasing this beyond 512
1625 # doesn't have any effect, as the maximum length of a message on IRC cannot exceed that.
1626 #<repeat maxbacklog="20" maxlines="20" maxdistance="50" maxtime="0" size="512">
1627 #<module name="repeat">
1629 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1630 # Restricted channels module: Allows only opers to create channels.
1632 # You probably *DO NOT* want to load this module on a public network.
1634 #<module name="restrictchans">
1636 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1637 # Restrict message module: Allows users to only message opers.
1639 # You probably *DO NOT* want to load this module on a public network.
1641 #<module name="restrictmsg">
1643 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1644 # R-Line module: Ban users through regular expression patterns.
1645 #<module name="rline">
1647 #-#-#-#-#-#-#-#-#-#-#-#- RLINE CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#-#
1649 # If you wish to re-check a user when they change nickname (can be
1650 # useful under some situations, but *can* also use CPU with more users
1651 # on a server) then set 'matchonnickchange' to yes.
1652 # Also, this is where you set what Regular Expression engine is to be
1653 # used. If you ever change it while running, all of your R-Lines will
1654 # be wiped. This is the regex engine used by all R-Lines set, and
1655 # regex_<engine> must be loaded, or rline will be non-functional
1656 # until you load it or change the engine to one that is loaded.
1658 #<rline matchonnickchange="yes" engine="pcre">
1660 # Generally, you will NOT want to use 'glob' here, as this turns
1661 # rline into just another gline. The exceptions are that rline will
1662 # always use the full "nick!user@host realname" string, rather than only
1663 # user@host, but beware that only the ? and * wildcards are available,
1664 # and are the only way to specify where the space can occur if you do
1665 # use glob. For this reason, is recommended to use a real regex engine
1666 # so that at least \s or [[:space:]] is available.
1668 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1669 # RMODE module: Adds the /RMODE command
1670 # Allows channel mods to remove list modes en masse.
1671 # Syntax: /rmode <channel> <mode> [pattern]
1672 # E.g. '/rmode #Channel b m:*' will remove all mute-extbans on the channel.
1673 #<module name="rmode">
1675 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1676 # SAJOIN module: Adds the /SAJOIN command which forcibly joins a user
1677 # to the given channel.
1678 # This module is oper-only.
1679 # To use, SAJOIN must be in one of your oper class blocks.
1680 # Opers need the users/sajoin-others priv to be able to /SAJOIN users
1681 # other than themselves.
1682 #<module name="sajoin">
1684 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1685 # SAKICK module: Adds the /SAKICK command which kicks a user from the
1687 # This module is oper-only.
1688 # To use, SAKICK must be in one of your oper class blocks.
1689 #<module name="sakick">
1691 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1692 # SAMODE module: Adds the /SAMODE command which allows server operators
1693 # to change modes on a channel without requiring them to have any
1694 # channel priviliges. Also allows changing user modes for any user.
1695 # This module is oper-only.
1696 # To use, SAMODE must be in one of your oper class blocks.
1697 #<module name="samode">
1699 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1700 # SANICK module: Adds the /SANICK command which allows opers to change
1702 # This module is oper-only.
1703 # To use, SANICK must be in one of your oper class blocks.
1704 #<module name="sanick">
1706 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1707 # SAPART module: Adds the /SAPART command which forcibly parts a user
1709 # This module is oper-only.
1710 # To use, SAPART must be in one of your oper class blocks.
1711 #<module name="sapart">
1713 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1714 # SAQUIT module: Adds the /SAQUIT command which forcibly quits a user.
1715 # This module is oper-only.
1716 # To use, SAQUIT must be in one of your oper class blocks.
1717 #<module name="saquit">
1719 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1720 # SATOPIC module: Adds the /SATOPIC command which allows changing the
1721 # topic on a channel without requiring any channel priviliges.
1722 # This module is oper-only.
1723 # To use, SATOPIC must be in one of your oper class blocks.
1724 #<module name="satopic">
1726 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1727 # SASL authentication module: Provides support for IRC Authentication
1728 # Layer via AUTHENTICATE. Note: You also need to have cap loaded
1730 #<module name="sasl">
1731 # Define the following to your services server name to improve security
1732 # by ensuring the SASL messages are only sent to the services server
1733 # and not to all connected servers. This prevents a rogue server from
1734 # capturing SASL messages and disables the SASL cap when services is
1736 #<sasl target="services.mynetwork.com">
1738 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1739 # Secure list module: Prevent /LIST in the first minute of connection,
1740 # crippling most spambots and trojan spreader bots.
1741 #<module name="securelist">
1743 #-#-#-#-#-#-#-#-#-# SECURELIST CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#-#
1745 # Securelist can be harmful to some IRC search engines. To prevent #
1746 # securelist blocking these sites from listing, define exception tags #
1748 #<securehost exception="*@*.netsplit.de">
1749 #<securehost exception="*@*.ircdriven.com">
1750 #<securehost exception="*@*.ircs.me">
1752 # Define the following variable to change how long a user must wait #
1753 # before issuing a LIST. If not defined, defaults to 60 seconds. #
1755 #<securelist waittime="1m"> #
1757 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1758 # Servprotect module: Provides support for Austhex style +k /
1759 # UnrealIRCD +S services mode.
1760 #<module name="servprotect">
1762 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1763 # See nicks module: Adds snomask +n and +N which show local and remote
1765 # This module is oper-only.
1766 #<module name="seenicks">
1768 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1769 # Set idle module: Adds a command for opers to change their idle time.
1770 # This module is oper-only.
1771 # To use, SETIDLE must be in one of your oper class blocks.
1772 #<module name="setidle">
1774 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1775 # Services support module: Adds several usermodes such as +R and +M.
1776 # This module implements the 'identified' state via account names,
1777 # and is similar in operation to the way asuka and ircu handle services.
1779 # At the same time, this offers +r for users and channels to mark them
1780 # as identified separately from the idea of a master account, which
1781 # can be useful for services which are heavily nick-as-account centric.
1783 # Also of note is that this module implements two extbans:
1784 # +b R: (stop matching account names from joining)
1785 # +b U:n!u@h (blocks matching unregistered users)
1787 #<module name="services_account">
1789 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1790 # Sethost module: Adds the /SETHOST command.
1791 # This module is oper-only.
1792 # To use, SETHOST must be in one of your oper class blocks.
1793 # See the chghost module for how to customise valid chars for hostnames.
1794 #<module name="sethost">
1796 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1797 # Setident module: Adds the /SETIDENT command.
1798 # This module is oper-only.
1799 # To use, SETIDENT must be in one of your oper class blocks.
1800 #<module name="setident">
1802 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1803 # SETNAME module: Adds the /SETNAME command.
1804 #<module name="setname">
1806 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1807 # Serverban: Implements extended ban 's', which stops anyone connected
1808 # to a server matching a mask like +b s:server.mask.here from joining.
1809 #<module name="serverban">
1811 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1812 # SHA1 module: Allows other modules to generate SHA1 hashes.
1813 # Required by the WebSocket module.
1814 #<module name="sha1">
1816 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1817 # Showfile: Provides support for showing a text file to users when #
1818 # they enter a command. #
1819 # This module adds one command for each <showfile> tag that shows the #
1820 # given file to the user as a series of messages or numerics. #
1821 #<module name="showfile"> #
1823 #-#-#-#-#-#-#-#-#-#-# SHOWFILE CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#-#
1825 # name - The name of the command which displays this file. This is #
1826 # the only mandatory setting, all others are optional. #
1827 # file - The text file to be shown to the user. #
1828 # By default same as the command name. #
1829 # method - How should the file be shown? #
1830 # * numeric: Send contents using a numeric #
1831 # (similar to /MOTD; the default). #
1832 # * notice: Send contents as a series of notices. #
1833 # * msg: Send contents as a series of private messages. #
1834 # colors - If true, color codes (\c, \b, \u, etc.) will be processed #
1835 # and sent as ANSI colors. If false (default) the file will #
1836 # be displayed as-is. #
1838 # When using the method "numeric", the following extra settings are #
1841 # introtext - Introductory line, "Showing <name>" by default. #
1842 # intronumeric - Numeric used for the introductory line. #
1843 # numeric - Numeric used for sending the text itself. #
1844 # endtext - Ending line, "End of <name>" by default. #
1845 # endnumeric - Numeric used for the ending line. #
1847 #<showfile name="RULES"
1850 # introtext="Server rules:"
1851 # endtext="End of server rules.">
1853 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1854 # Show whois module: Adds the +W usermode which allows opers to see
1855 # when they are /WHOIS'd.
1856 # This module is oper-only by default.
1857 #<module name="showwhois">
1859 # If you wish, you may also let users set this mode. Only opers with the
1860 # users/auspex priv will see real hosts of people, though.
1861 #<showwhois opersonly="yes"
1863 # You may also set whether or not users should receive whois notices,
1864 # should they be /WHOIS'd by an oper.
1865 #showfromopers="yes">
1867 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1868 # Shun module: Provides the /SHUN command, which stops a user from
1869 # executing all except configured commands.
1870 # This module is oper-only.
1871 # To use, SHUN must be in one of your oper class blocks.
1872 #<module name="shun">
1874 # You may also configure which commands you wish a user to be able to
1875 # perform when shunned. It should be noted that if a shunned user
1876 # issues QUIT or PART then their message will be removed, as if they
1877 # did not issue one.
1879 # You can optionally let the user know that their command was blocked.
1881 # You may also let SHUN affect opers (defaults to no).
1882 #<shun enabledcommands="ADMIN PING PONG QUIT PART JOIN" notifyuser="yes" affectopers="no">
1884 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1885 # SSL mode module: Adds support for SSL-only channels via the '+z'
1886 # channel mode, SSL-only private messages via the '+z' user mode and
1887 # the 'z:' extban which matches SSL client certificate fingerprints.
1889 # Does not do anything useful without a working SSL module and the
1890 # sslinfo module (see below).
1891 #<module name="sslmodes">
1893 # The +z user mode is not enabled by default to enable link compatibility
1894 # with 2.0 servers. You can enable it by uncommenting this:
1895 #<sslmodes enableumode="yes">
1897 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1898 # GnuTLS SSL module: Adds support for SSL connections using GnuTLS,
1899 # if enabled. You must answer 'yes' in ./configure when asked or
1900 # manually symlink the source for this module from the directory
1901 # src/modules/extra, if you want to enable this, or it will not load.
1902 #<module name="ssl_gnutls">
1904 #-#-#-#-#-#-#-#-#-#-#- GNUTLS CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#
1906 # ssl_gnutls is too complex to describe here, see the wiki: #
1907 # https://wiki.inspircd.org/Modules/3.0/ssl_gnutls #
1909 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1910 # SSL info module: Allows users to retrieve information about other
1911 # users' peer SSL certificates and keys. This can be used by client
1912 # scripts to validate users. For this to work, one of ssl_gnutls
1913 # or ssl_openssl must be loaded. This module also adds the
1914 # "* <user> is using a secure connection" whois line, the ability for
1915 # opers to use SSL cert fingerprints to verify their identity and the
1916 # ability to force opers to use SSL connections in order to oper up.
1917 # It is highly recommended to load this module if you use SSL on your
1919 # For how to use the oper features, please see the first example <oper> tag
1920 # in opers.conf.example.
1922 #<module name="sslinfo">
1924 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1925 # mbedTLS SSL module: Adds support for SSL/TLS connections using mbedTLS.
1926 #<module name="ssl_mbedtls">
1928 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1929 # OpenSSL SSL module: Adds support for SSL connections using OpenSSL,
1930 # if enabled. You must answer 'yes' in ./configure when asked or symlink
1931 # the source for this module from the directory src/modules/extra, if
1932 # you want to enable this, or it will not load.
1933 #<module name="ssl_openssl">
1935 #-#-#-#-#-#-#-#-#-#-#- OPENSSL CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#
1937 # ssl_openssl is too complex to describe here, see the wiki: #
1938 # https://wiki.inspircd.org/Modules/3.0/ssl_openssl #
1940 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1941 # Strip color module: Adds channel mode +S that strips color codes and
1942 # all control codes except CTCP from all messages sent to the channel.
1943 #<module name="stripcolor">
1945 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1946 # Silence module: Adds support for the /SILENCE command, which allows
1947 # users to have a server-side ignore list for their client.
1948 #<module name="silence">
1950 # Set the maximum number of entries allowed on a user's silence list.
1951 #<silence maxentries="32"
1953 # Whether messages from U-lined servers will bypass silence masks.
1956 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1957 # SQLite3 module: Allows other SQL modules to access SQLite3 #
1958 # databases through a unified API. #
1959 # This module is in extras. Re-run configure with: #
1960 # ./configure --enable-extras=m_sqlite3.cpp
1961 # and run make install, then uncomment this module to enable it. #
1963 #<module name="sqlite3">
1965 #-#-#-#-#-#-#-#-#-#-#-#- SQL CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#-#
1967 # sqlite is more complex than described here, see the wiki for more #
1968 # info: https://wiki.inspircd.org/Modules/3.0/sqlite3 #
1970 #<database module="sqlite" hostname="/full/path/to/database.db" id="anytext">
1972 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1973 # SQL authentication module: Allows IRCd connections to be tied into
1974 # a database table (for example a forum).
1976 #<module name="sqlauth">
1978 #-#-#-#-#-#-#-#-#-#-#- SQLAUTH CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#
1980 # sqlauth is too complex to describe here, see the wiki: #
1981 # https://wiki.inspircd.org/Modules/3.0/sqlauth #
1983 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1984 # SQL oper module: Allows you to store oper credentials in an SQL table
1986 #<module name="sqloper">
1988 #-#-#-#-#-#-#-#-#-#-#- SQLOPER CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#
1990 # dbid - Database ID to use (see SQL modules). #
1991 # hash - Hashing provider to use for password hashing. #
1993 # See also: https://wiki.inspircd.org/Modules/3.0/sqloper #
1995 #<sqloper dbid="1" hash="bcrypt">
1997 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1998 # StartTLS module: Implements STARTTLS, which allows clients #
1999 # connected to non SSL enabled ports to enable SSL, if a proper SSL #
2000 # module is loaded (either ssl_gnutls or ssl_openssl). #
2001 #<module name="starttls">
2003 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2004 # SVSHold module: Implements SVSHOLD. Like Q:Lines, but can only be #
2005 # added/removed by Services. #
2006 #<module name="svshold">
2007 # SVSHOLD does not generate server notices by default, you can turn
2008 # notices on by uncommenting the next line.
2009 #<svshold silent="false">
2011 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2012 # SWHOIS module: Allows you to add arbitrary lines to user WHOIS.
2013 # This module is oper-only.
2014 # To use, SWHOIS must be in one of your oper class blocks.
2015 #<module name="swhois">
2017 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2018 # Timed bans module: Adds timed channel bans with the /TBAN command.
2019 #<module name="timedbans">
2021 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2022 # Test line module: Adds the /TLINE command, used to test how many
2023 # users a /GLINE or /ZLINE etc. would match.
2024 # This module is oper-only.
2025 # To use, TLINE must be in one of your oper class blocks.
2026 #<module name="tline">
2028 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2029 # Topiclock module: implements server-side topic locking to achieve deeper
2030 # integration with services packages.
2031 #<module name="topiclock">
2033 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2034 # UHNAMES support module: Adds support for the IRCX style UHNAMES
2035 # extension, which displays ident and hostname in the names list for
2036 # each user, saving clients from doing a WHO on the channel.
2037 # If a client does not support UHNAMES it will not enable it, this will
2038 # not break incompatible clients.
2039 #<module name="uhnames">
2041 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2042 # Uninvite module: Adds the /UNINVITE command which lets users remove
2043 # pending invites from channels without waiting for the user to join.
2044 #<module name="uninvite">
2046 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2047 # Userip module: Adds the /USERIP command.
2048 # Allows users to query their own IP, also allows opers to query the IP
2050 #<module name="userip">
2052 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2053 # Vhost module: Adds the VHOST command which allows for adding virtual
2054 # hosts which are accessible using a username and password in the config.
2055 #<module name="vhost">
2057 #-#-#-#-#-#-#-#-#-#-#- VHOST CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#-#
2059 # user - Username for the vhost. #
2061 # pass - Password for the vhost. #
2063 # hash - The hash for the specific user (optional) #
2064 # password_hash and a hashing module must be loaded for #
2067 # host - Vhost to set. #
2069 #<vhost user="some_username" pass="some_password" host="some.host.test.cc">
2070 #<vhost user="foo" password="$2a$10$iTuYLT6BRhRlOgzfsW9oPe62etW.oXwSpyKw5rJit64SGZanLXghO" hash="bcrypt" host="some.other.host.example.com">
2072 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2073 # Watch module: Adds the WATCH command, which is used by clients to
2074 # maintain notify lists.
2075 #<module name="watch">
2077 # Set the maximum number of entries on a user's watch list below.
2078 #<watch maxentries="32">
2080 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2081 # WebSocket module: Adds HTML5 WebSocket support.
2082 # Specify hook="websocket" in a <bind> tag to make that port accept
2083 # WebSocket connections. Compatible with SSL/TLS.
2084 # Requires SHA-1 hash support available in the sha1 module.
2085 #<module name="websocket">
2087 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2088 # XLine database: Stores all *Lines (G/Z/K/R/any added by other modules)
2089 # in a file which is re-loaded on restart. This is useful
2090 # for two reasons: it keeps bans so users may not evade them, and on
2091 # bigger networks, server connections will take less time as there will
2092 # be a lot less bans to apply - as most of them will already be there.
2093 #<module name="xline_db">
2095 # Specify the filename for the xline database here.
2096 #<xlinedb filename="xline.db">
2098 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2099 # ____ _ _____ _ _ ____ _ _ _ #
2100 # | _ \ ___ __ _ __| | |_ _| |__ (_)___ | __ )(_) |_| | #
2101 # | |_) / _ \/ _` |/ _` | | | | '_ \| / __| | _ \| | __| | #
2102 # | _ < __/ (_| | (_| | | | | | | | \__ \ | |_) | | |_|_| #
2103 # |_| \_\___|\__,_|\__,_| |_| |_| |_|_|___/ |____/|_|\__(_) #
2105 # To link servers to InspIRCd, you MUST load the spanningtree module. #
2106 # If you don't do this, server links will NOT work at all. #
2107 # This is by design, to allow for the implementation of other linking #
2108 # protocols in modules in the future. #
2110 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2111 # Spanning tree module: Allows linking of servers using the spanning
2112 # tree protocol (see the READ THIS BIT section above).
2113 # You will almost always want to load this.
2115 #<module name="spanningtree">
projects / user / henk / code / inspircd.git / blob