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://docs.inspircd.org/3/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">
51 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
52 # Abbreviation module: Provides the ability to abbreviate commands a-la
54 #<module name="abbreviation">
56 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
57 # Alias module: Allows you to define server-side command aliases.
58 #<module name="alias">
60 # Set the 'prefix' for in-channel aliases (fantasy commands) to the
61 # specified character. If not set, the default is "!".
62 # If 'allowbots' is disabled, +B clients will not be able to use
63 # fantasy commands. If not set, the default is no.
64 #<fantasy prefix="!" allowbots="no">
66 #-#-#-#-#-#-#-#-#-#-#- ALIAS DEFINITIONS -#-#-#-#-#-#-#-#-#-#-#-#-#-#
68 # If you have the alias module loaded, you may also define aliases as #
69 # shown below. They are commonly used to provide shortcut commands to #
70 # services, however they are not limited to just this use. #
71 # An alias tag requires the following values to be defined in it: #
73 # text - The text to detect as the actual command line. #
74 # Can't contain spaces, but case insensitive. #
75 # You may have multiple aliases with the same #
76 # command name (text="" value), however the first #
77 # found will be executed if its format value is #
78 # matched, or it has no format value. Aliases are #
79 # read from the top of the file to the bottom. #
81 # usercommand - If this is true, the alias can be run simply as #
82 # /ALIASNAME. Defaults to true. #
84 # channelcommand - If this is true, the alias can be used as an #
85 # in-channel alias or 'fantasy command', prefixed #
86 # by the fantasy prefix character, !aliasname by #
87 # default. Defaults to false. #
89 # format - If this is defined, the parameters of the alias #
90 # must match this glob pattern. For example if you #
91 # want the first parameter to start with a # for #
92 # the alias to be executed, set format="#*" in the #
93 # alias definition. Note that the :'s which are #
94 # part of IRC formatted lines will be preserved #
95 # for matching of this text. This value is #
98 # replace - The text to replace 'text' with. Usually this #
99 # will be "PRIVMSG ServiceName :$2-" or similar. #
100 # You may use the variables $1 through $9 in the #
101 # replace string, which refer to the first through #
102 # ninth word in the original string typed by the #
103 # user. You may also use $1- through $9- which #
104 # refer to the first word onwards, through to the #
105 # ninth word onwards, e.g. if the user types the #
106 # command "foo bar baz qux quz" then $3- will hold #
107 # "baz qux quz" and $2 will contain "bar". You may #
108 # also use the special variables: $nick, $ident, #
109 # $host and $vhost, and you may separate multiple #
110 # commands with a newline (which can be written in #
111 # the file literally, or encoded as &nl; or \n #
112 # depending on the config format setting). #
114 # requires - If you provide a value for 'requires' this means #
115 # the given nickname MUST be online for the alias #
116 # to successfully trigger. If they are not, then #
117 # the user receives a 'no such nick' 401 numeric. #
119 # stripcolor - If this is true, the text from the user will be #
120 # stripped of color and format codes before #
121 # matching against 'text'. #
123 # uline - Setting this to true will ensure that the user #
124 # given in 'requires' is also on a U-lined server, #
125 # as well as actually being on the network. If the #
126 # user is online, but not on a U-lined server, #
127 # then an oper alert is sent out as this is #
128 # possibly a sign of a user trying to impersonate #
131 # operonly - If true, this will make the alias oper only. #
132 # If a non-oper attempts to use the alias, it will #
133 # appear to not exist. #
136 # An example of using the format value to create an alias with two
137 # different behaviours depending on the format of the parameters.
139 #<alias text="ID" format="#*" replace="SQUERY ChanServ :IDENTIFY $2 $3"
140 # requires="ChanServ" uline="yes">
142 #<alias text="ID" replace="SQUERY NickServ :IDENTIFY $2"
143 # requires="NickServ" uline="yes">
145 # This alias fixes a glitch in xchat 2.6.x and above and the way it
146 # assumes IDENTIFY must be prefixed by a colon (:) character. It should
147 # be placed ABOVE the default NICKSERV alias.
149 #<alias text="NICKSERV" format=":IDENTIFY *" replace="SQUERY NickServ :IDENTIFY $3-"
150 # requires="NickServ" uline="yes">
152 # You may also add aliases to trigger based on something said in a
153 # channel, aka 'fantasy' commands, configured in the same manner as any
154 # other alias, with usercommand="no" and channelcommand="yes" The
155 # command must be preceded by the fantasy prefix when used.
157 #<alias text="CS" usercommand="no" channelcommand="yes"
158 # replace="SQUERY ChanServ :$1 $chan $2-" requires="ChanServ" uline="yes">
160 # This would be used as "!cs <command> <options>", with the channel
161 # being automatically inserted after the command in the message to
162 # ChanServ, assuming the fantasy prefix is "!".
164 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
165 # Allowinvite module: Gives channel mode +A to allow all users to use
166 # /INVITE, and extban A to deny invite from specific masks.
167 #<module name="allowinvite">
169 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
170 # Alltime module: Shows time on all connected servers at once.
171 # This module is oper-only and provides /ALLTIME.
172 # To use, ALLTIME must be in one of your oper class blocks.
173 #<module name="alltime">
175 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
176 # Anticaps module: Adds channel mode +B which allows you to punish
177 # users that send overly capitalised messages to channels. Unlike the
178 # blockcaps module this module is more flexible as it has more options
179 # for punishment and allows channels to configure their own punishment
181 #<module name="anticaps">
183 # You may also configure the characters which anticaps considers to be
184 # lower case and upper case. Any characters not listed here are assumed
185 # to be punctuation and will be ignored when counting:
186 # <anticaps lowercase="abcdefghijklmnopqrstuvwxyz"
187 # uppercase="ABCDEFGHIJKLMNOPQRSTUVWXYZ">
189 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
190 # Argon2 module: Allows other modules to generate Argon2 hashes,
191 # usually for cryptographic uses and security.
192 # This module makes the algorithms argon2i, argon2d and argon2id
194 # Note that this module is extra, and must be enabled explicitly
195 # to build. It depends on libargon2.
196 #<module name="argon2">
198 # memory: Memory hardness, in KiB. E.g. 131072 KiB = 128 MiB.
199 # iterations: Time hardness in iterations. (def. 3)
200 # lanes: How many parallel chains can be run. (def. 1)
201 # threads: Maximum amount of threads each invocation can spawn. (def. 1)
202 # length: Output length in bytes. (def. 32)
203 # saltlength: Salt length in bytes. (def. 16)
204 # version: Algorithm version, 10 or 13. (def. 13)
205 # The parameters can be customized as follows:
206 #<argon2 iterations="3" memory="131074" length="32" saltlength="16">
207 # Defines the parameters that are common for all the variants (i/d/id).
208 # Can be overridden on individual basis, e.g.
209 #<argon2i iterations="4">
210 #<argon2d memory="131074"
211 #<argon2id iterations="5" memory="262144" length="64" saltlength="32">
213 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
214 # Auditorium module: Adds channel mode +u which makes everyone else
215 # except you in the channel invisible, used for large meetings etc.
216 #<module name="auditorium">
218 # Auditorium settings:
220 #<auditorium opvisible="no" opcansee="no" opercansee="yes">
222 # opvisible (auditorium-vis in exemptchanops):
223 # Show channel ops to all users
224 # opcansee (auditorium-see in exemptchanops):
225 # Allow ops to see all joins/parts/kicks in the channel
227 # Allow opers (channels/auspex) to see see all joins/parts/kicks in the channel
229 # Exemptchanops can be used to adjust the level at which users become visible or
230 # the level at which they can see the full member list of the channel.
232 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
233 # Autoop module: Adds basic channel access controls via the +w listmode.
234 # For example +w o:*!Attila@127.0.0.1 will op anyone matching that mask
235 # on join. This can be combined with extbans, for example +w o:R:Brain
236 # will op anyone identified to the account "Brain".
237 # Another useful combination is with TLS (SSL) client certificate
238 # fingerprints: +w h:z:72db600734bb9546c1bdd02377bc21d2a9690d48 will
239 # give halfop to the user(s) having the given certificate.
240 #<module name="autoop">
242 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
243 # Ban except module: Adds support for channel ban exceptions (+e).
244 #<module name="banexception">
246 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
247 # Ban redirection module: Allows bans which redirect to a specified
248 # channel. e.g. +b nick!ident@host#channelbanneduserissentto
249 #<module name="banredirect">
251 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
252 # bcrypt module: Allows other modules to generate bcrypt hashes,
253 # usually for cryptographic uses and security.
254 #<module name="bcrypt">
256 # rounds: Defines how many rounds the bcrypt function will run when
257 # generating new hashes.
258 #<bcrypt rounds="10">
260 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
261 # Block amsg module: Attempt to block all usage of /amsg and /ame.
262 #<module name="blockamsg">
264 #-#-#-#-#-#-#-#-#-#-#- BLOCKAMSG CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
266 # If you have the blockamsg module loaded, you can configure it with #
267 # the <blockamsg> tag: #
269 # delay - How much time between two messages to force them #
270 # to be recognised as unrelated. #
271 # action - Any of 'notice', 'noticeopers', 'silent', 'kill' #
272 # or 'killopers'. Define how to take action when #
273 # a user uses /amsg or /ame. #
275 #<blockamsg delay="3" action="killopers">
277 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
278 # Block CAPS module: Adds channel mode +B, blocks all-CAPS messages.
280 # NOTE: This module is deprecated and will be removed in a future version
281 # of InspIRCd. You should use the anticaps module shown above instead.
282 #<module name="blockcaps">
284 #-#-#-#-#-#-#-#-#-#-#- BLOCKCAPS CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
286 # percent - The percentage of a message which must be upper #
287 # case before it will be blocked. #
289 # minlen - The minimum length a message must be before it #
292 # lowercase - The characters which will be considered lower #
295 # uppercase - The characters which will be considered upper #
298 #<blockcaps percent="50"
300 # lowercase="abcdefghijklmnopqrstuvwxyz"
301 # uppercase="ABCDEFGHIJKLMNOPQRSTUVWXYZ">
303 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
304 # Block color module: Blocking color-coded messages with chan mode +c.
305 #<module name="blockcolor">
307 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
308 # Botmode module: Adds the user mode +B. If set on a user, it will
309 # show that the user is a bot in /WHOIS.
310 #<module name="botmode">
312 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
313 # CallerID module: Adds user mode +g which activates hybrid-style
314 # callerid: block all private messages unless you /ACCEPT first.
315 #<module name="callerid">
317 #-#-#-#-#-#-#-#-#-#-#- CALLERID CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#
318 # maxaccepts - Maximum number of entries a user can add to their #
319 # /ACCEPT list. Default is 30 entries. #
320 # tracknick - Preserve /ACCEPT entries when a user changes nick? #
321 # If no (the default), the user is removed from #
322 # everyone's accept list if their nickname changes. #
323 # cooldown - Amount of time that must pass since the last #
324 # notification sent to a user before they can be #
325 # sent another. Default is 1 minute. #
326 #<callerid maxaccepts="30"
330 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
331 # CAP module: Provides the CAP negotiation mechanism required by the
332 # sasl, namesx, uhnames, and ircv3 modules.
333 # It is also recommended for STARTTLS support in the starttls module.
336 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
337 # CBAN module: Lets you disallow channels from being used at runtime.
338 # This module is oper-only and provides /CBAN.
339 # To use, CBAN must be in one of your oper class blocks.
340 #<module name="cban">
341 # CBAN does not allow glob channelmasks by default for compatibility
342 # reasons. You can enable glob support by uncommenting the next line.
345 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
346 # Censor module: Adds channel and user mode +G which block phrases that
347 # are listed in the server bad words list.
348 #<module name="censor">
350 #-#-#-#-#-#-#-#-#-#-#- CENSOR CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#
352 # If you have the censor module loaded you should specify one or more #
353 # phrases to replace/block in user messages. The config for this is #
354 # formatted as follows: #
356 # Replaces "eggplant" with "aubergine" within messages: #
357 # <badword text="eggplant" replace="aubergine"> #
359 # Blocks messages that contain "fluffy capybaras": #
360 #<badword text="fluffy capybaras"> #
362 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
363 # CGI:IRC module: Enables forwarding the real IP address of a user from
364 # a gateway to the IRC server.
365 #<module name="cgiirc">
367 #-#-#-#-#-#-#-#-#-#-#-# CGIIRC CONFIGURATION #-#-#-#-#-#-#-#-#-#-#-#-#
369 # If you use the cgiirc module then you must specify the gateways which
370 # are authorised to forward IP/host information to your server. There
371 # are currently two ways to do this:
373 # The webirc method is the recommended way to allow gateways to forward
374 # IP/host information. When using this method the gateway sends a WEBIRC
375 # message to the server on connection. For more details please read the
376 # IRCv3 WebIRC specification at: https://ircv3.net/specs/extensions/webirc.html
378 # When using this method you must specify a wildcard mask or CIDR range
379 # to allow gateway connections from and at least one of either a TLS (SSL)
380 # client certificate fingerprint for the gateway or a password to be
381 # sent in the WEBIRC command.
383 # <cgihost type="webirc"
384 # fingerprint="bd90547b59c1942b85f382bc059318f4c6ca54c5"
385 # mask="192.0.2.0/24">
386 # <cgihost type="webirc"
387 # password="$2a$10$WEUpX9GweJiEF1WxBDSkeODBstIBMlVPweQTG9cKM8/Vd58BeM5cW"
389 # mask="*.webirc.gateway.example.com">
391 # Alternatively if your gateway does not support sending the WEBIRC
392 # message then you can configure InspIRCd to look for the client IP
393 # address in the ident sent by the user. This is not recommended as it
394 # only works with IPv4 connections.
396 # When using this method you must specify a wildcard mask or CIDR range to allow
397 # gateway connections from. You can also optionally configure the static value
398 # that replaces the IP in the ident to avoid leaking the real IP address of
399 # gateway clients (defaults to "gateway" if not set).
401 # <cgihost type="ident"
402 # mask="198.51.100.0/24"
404 # <cgihost type="ident"
405 # mask="*.ident.gateway.example.com"
408 # By default gateway connections are logged to the +w snomask. If you
409 # do not want this to happen then you can uncomment this to disable it.
410 # <cgiirc opernotice="no">
415 # When you connect gateway clients, there are two connect classes which
416 # apply to these clients. When the client initially connects, the connect
417 # class which matches the gateway site's host is checked. Therefore you
418 # must raise the maximum local/global clients for this IP as high as you
419 # want to allow gateway clients. After the client has connected and is
420 # determined to be a gateway client, the class which matches the client's
421 # real IP is then checked. You may set this class to a lower value, so that
422 # the real IP of the client can still be restricted to, for example, 3
425 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
426 # Channel create module: Adds snomask +j, which will notify opers of
427 # any new channels that are created.
428 # This module is oper-only.
429 #<module name="chancreate">
431 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
432 # Channel filter module: Allows channel-op defined message filtering
433 # using simple string matches (channel mode +g).
434 #<module name="chanfilter">
436 # If hidemask is set to yes, the user will not be shown the mask when
437 # their message is blocked.
439 # If maxlen is set then it defines the maximum length of a filter entry.
441 # If notifyuser is set to no, the user will not be notified when
442 # their message is blocked.
443 #<chanfilter hidemask="yes" maxlen="50" notifyuser="yes">
445 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
446 # Channel history module: Displays the last 'X' lines of chat to a user
447 # joining a channel with +H 'X:T' set; 'T' is the maximum time to keep
448 # lines in the history buffer. Designed so that the new user knows what
449 # the current topic of conversation is when joining the channel.
450 #<module name="chanhistory">
452 # Set the maximum number of lines allowed to be stored per channel below.
453 # This is the hard limit for 'X'.
454 # If prefixmsg is set to yes, joining users without batch support will get
455 # a NOTICE before playback telling them about the following lines being
456 # the pre-join history.
457 # If bots is set to yes, it will also send to users marked with +B
458 #<chanhistory maxlines="50" prefixmsg="yes" bots="yes">
460 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
461 # Channel logging module: Used to send snotice output to channels, to
462 # allow staff to centrally monitor and discuss network activity.
464 # The "channel" field is where you want the messages to go, "snomasks"
465 # is what snomasks you want to be sent to that channel. Multiple tags
467 #<module name="chanlog">
468 #<chanlog snomasks="AOcC" channel="#opers">
470 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
471 # Channel names module: Allows disabling channels which have certain
472 # characters in the channel name such as bold, colorcodes, etc. which
473 # can be quite annoying and allow users to on occasion have a channel
474 # that looks like the name of another channel on the network.
475 #<module name="channames">
478 # denyrange: characters or range of characters to deny in channel
482 # allowrange: characters or range of characters to specifically allow
486 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
487 # Channelban: Implements extended ban j:, which stops anyone already
488 # in a channel matching a ban like +b j:#channel from joining.
489 # It is also possible to ban based on their status in that channel,
490 # like so: +b j:@#channel, this example prevents the ops from joining.
491 # Note that by default wildcard characters * and ? are allowed in
492 # channel names. To disallow them, load the channames module and
493 # add characters 42 and 63 to denyrange (see above).
494 #<module name="channelban">
496 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
497 # Check module: Adds the /CHECK command.
498 # Check is useful for looking up information on channels, users,
499 # IP addresses and hosts.
500 # This module is oper-only.
501 # To use, CHECK must be in one of your oper class blocks.
502 #<module name="check">
504 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
505 # CHGHOST module: Adds the /CHGHOST command.
506 # This module is oper-only.
507 # To use, CHGHOST must be in one of your oper class blocks.
508 # NOTE: Services will not be able to set vhosts on users if this module
509 # isn't loaded. If you're planning on running services, you probably
511 #<module name="chghost">
513 #-#-#-#-#-#-#-#-# /CHGHOST - /SETHOST CONFIGURATION #-#-#-#-#-#-#-#-#
514 # Optional - If you want to use special chars for hostnames you can #
515 # specify your own custom list of chars with the <hostname> tag: #
517 # charmap - A list of chars accepted as valid by the /CHGHOST #
518 # and /SETHOST commands. Also note that the list is #
520 #<hostname charmap="abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ.-_/0123456789">
522 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
523 # CHGIDENT module: Adds the /CHGIDENT command.
524 # This module is oper-only.
525 # To use, CHGIDENT must be in one of your oper class blocks.
526 #<module name="chgident">
528 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
529 # CHGNAME module: Adds the /CHGNAME command.
530 # This module is oper-only.
531 # To use, CHGNAME must be in one of your oper class blocks.
532 #<module name="chgname">
534 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
535 # Connection class ban module: Adds support for extban 'n' which
536 # matches against the class name of the user's connection.
537 # This module assumes that connection classes are named in a uniform
538 # way on all servers of the network. Wildcards are accepted.
539 #<module name="classban">
541 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
542 # Clear chan module: Allows opers to masskick, masskill or
543 # mass G/Z-line all users on a channel using /CLEARCHAN.
544 #<module name="clearchan">
546 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
547 # Cloaking module: Adds user mode +x and cloaking support.
548 # Relies on the md5 module being loaded.
549 # To cloak users when they connect, load the conn_umodes module and set
550 # <connect:modes> to include the +x mode. The example <connect> tag
551 # shows this. See the conn_umodes module for more information.
552 #<module name="cloaking">
554 #-#-#-#-#-#-#-#-#-#-#- CLOAKING CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#
556 # To use cloaking, you must define a cloak key, and optionally a #
557 # cloak prefix as shown below. The cloak key must be shared across #
558 # the network for consistent cloaking and must be at least thirty #
561 # There are two methods of cloaking: #
563 # half Cloak only the "unique" portion of a host; by #
564 # default show the last 2 parts of the domain, #
565 # /16 subnet of IPv4 or /48 subnet of the IPv6 #
567 # To change the number of shown parts, modify the #
568 # domainparts option. #
570 # full Cloak the users completely, using three slices for #
571 # common CIDR bans (IPv4: /16, /24; IPv6: /48, /64). #
573 # The methods use a single key that can be any length of text. #
574 # An optional prefix may be specified to mark cloaked hosts. #
576 # IMPORTANT: Changing these details will break all of your existing #
577 # bans. If you do not want this to happen you can define multiple #
578 # cloak tags. The first will be used for cloaking and the rest will #
579 # be used for checking if a user is banned in a channel. #
580 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
593 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
594 # Clones module: Adds an oper command /CLONES for detecting cloned
595 # users. Warning: This command may be resource intensive when it is
596 # issued, use with care.
597 # This module is oper-only.
598 # To use, CLONES must be in one of your oper class blocks.
599 #<module name="clones">
601 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
602 # Codepage module: Allows using a custom 8-bit codepage for nicknames
605 # You should include one of the following files to set your codepage:
606 #<include file="examples/codepages/ascii.conf.example">
607 #<include file="examples/codepages/latin1.conf.example">
608 #<include file="examples/codepages/rfc1459.conf.example">
609 #<include file="examples/codepages/strict-rfc1459.conf.example">
611 # You can also define a custom codepage. For details on how to do this
612 # please refer to the docs site:
613 # https://docs.inspircd.org/3/modules/codepage
615 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
616 # Common channels module: Adds user mode +c, which, when set, requires
617 # that users must share a common channel with you to PRIVMSG or NOTICE
619 #<module name="commonchans">
621 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
622 # Auto join on connect module: Allows you to force users to join one
623 # or more channels automatically upon connecting to the server, or
624 # join them in case they aren't on any channels after being online
626 #<module name="conn_join">
628 #-#-#-#-#-#-#-#-#-#-#-#- CONNJOIN CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
630 # If you have the conn_join module loaded, you can configure it below
631 # or set autojoin="#chat,#help" in <connect> blocks.
633 # Join users immediately after connection to #one #two and #three.
634 #<autojoin channel="#one,#two,#three">
635 # Join users to #chat after 15 seconds if they aren't on any channels.
636 #<autojoin channel="#chat" delay="15">
638 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
639 # Set modes on connect module: When this module is loaded <connect>
640 # blocks may have an optional modes="" value, which contains modes to
641 # add or remove from users when they connect to the server.
642 #<module name="conn_umodes">
644 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
645 # Wait for PONG on connect module: Send a PING to all connecting users
646 # and don't let them connect until they reply with a PONG.
647 # This is useful to stop certain kinds of bots and proxies.
648 #<module name="conn_waitpong">
650 #-#-#-#-#-#-#-#-#-#-#- WAITPONG CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
652 # If you have the conn_waitpong module loaded, configure it with the #
655 # sendsnotice - Whether to send a helpful notice to users on #
656 # connect telling them how to connect, should #
657 # their client not reply PONG automatically. #
659 # killonbadreply - Whether to kill the user if they send the wrong #
662 #<waitpong sendsnotice="no" killonbadreply="yes">
664 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
665 # Channel cycle module: Adds the /CYCLE command which is a server-side
666 # /HOP that bypasses restrictive modes.
667 #<module name="cycle">
669 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
670 # Connectban: Provides IP connection throttling. Any IP range that
671 # connects too many times (configurable) in an hour is Z-lined for a
672 # (configurable) duration, and their count resets to 0.
673 #<module name="connectban">
675 # ipv4cidr and ipv6cidr allow you to turn the comparison from
676 # individual IP addresses (32 and 128 bits) into CIDR masks, to allow
677 # for throttling over whole ISPs/blocks of IPs, which may be needed to
680 # This allows for 10 connections in an hour with a 10 minute ban if
682 #<connectban threshold="10" duration="10m" ipv4cidr="32" ipv6cidr="128"
683 # A custom ban message may optionally be specified.
684 # 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.">
686 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
687 # Connection throttle module.
688 #<module name="connflood">
690 #-#-#-#-#-#-#-#-#-#-#- CONNTHROTTLE CONFIGURATION -#-#-#-#-#-#-#-#-#-#
691 # period, maxconns - Amount of connections per <period>.
693 # timeout - Time to wait after the throttle was activated
694 # before deactivating it. Be aware that the time
695 # is seconds + timeout.
697 # quitmsg - The message that users get if they attempt to
698 # connect while the throttle is active.
700 # bootwait - Amount of time in seconds to wait before enforcing
701 # the throttling when the server just booted.
703 #<connflood period="30" maxconns="3" timeout="30"
704 # quitmsg="Throttled" bootwait="2m">
706 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
707 # Custom prefixes: Allows for channel prefixes to be configured.
708 #<module name="customprefix">
710 # name The name of the mode, must be unique from other modes.
711 # letter The letter used for this mode. Required.
712 # prefix The prefix used for nicks with this mode. Not required.
713 # rank A numeric rank for this prefix, defining what permissions it gives.
714 # The rank of voice, halfop and op is 10000, 20000, and 30000,
716 # ranktoset The numeric rank required to set this mode. Defaults to rank.
717 # ranktounset The numeric rank required to unset this mode. Defaults to ranktoset.
718 # depriv Can you remove the mode from yourself? Defaults to yes.
719 #<customprefix name="founder" letter="q" prefix="~" rank="50000" ranktoset="50000">
720 #<customprefix name="admin" letter="a" prefix="&" rank="40000" ranktoset="50000">
721 #<customprefix name="halfop" letter="h" prefix="%" rank="20000" ranktoset="30000">
723 # You can also override the configuration of prefix modes added by both the core
724 # and other modules by adding a customprefix tag with change="yes" specified.
725 # <customprefix name="op" change="yes" rank="30000" ranktoset="30000">
726 # <customprefix name="voice" change="yes" rank="10000" ranktoset="20000" depriv="no">
728 # Do /RELOADMODULE customprefix after changing the settings of this module.
730 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
731 # Custom title module: Adds the /TITLE command which allows for trusted
732 # users to gain a custom whois line and an optional vhost can be
734 #<module name="customtitle">
736 #-#-#-#-#-#-#-#-#-#- CUSTOM TITLE CONFIGURATION -#-#-#-#-#-#-#-#-#-#
737 # name - The username used to identify.
738 # password - The password used to identify.
739 # hash - The hash for the specific user's password (optional).
740 # password_hash and a hashing module must be loaded
742 # host - Allowed hostmask (optional).
743 # title - Title shown in whois.
744 # vhost - Displayed host (optional).
746 #<title name="foo" password="bar" title="Official Chat Helper">
747 #<title name="bar" password="foo" host="ident@test.org" title="Official Chat Helper" vhost="helper.test.org">
748 #<title name="foo" password="$2a$10$UYZ4OcO8NNTCCGyCdY9SK.2GHiqGgxZfHFPOPmWuxEVWVQTtoDC7C" hash="bcrypt" title="Official Chat Helper">
750 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
751 # DCCALLOW module: Adds the /DCCALLOW command.
752 #<module name="dccallow">
754 #-#-#-#-#-#-#-#-#-#-#- DCCALLOW CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
755 # blockchat - Whether to block DCC CHAT as well as DCC SEND.
756 # length - Default duration of entries in DCCALLOW list.
757 # action - Default action to take if no action is
758 # specified, can be 'block' or 'allow'.
759 # maxentries - Max number of nicks to allow on a DCCALLOW list.
761 # File configuration:
762 # pattern - The glob pattern to match against.
763 # action - Action to take if a user attempts to send a file
764 # that matches this pattern, can be 'block' or
767 #<dccallow blockchat="yes" length="5m" action="block" maxentries="20">
768 #<banfile pattern="*.exe" action="block">
769 #<banfile pattern="*.txt" action="allow">
771 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
772 # Deaf module: Adds support for user modes +d and +D:
773 # d - deaf to channel messages and notices.
774 # D - deaf to user messages and notices.
775 # The +D user mode is not enabled by default to enable link compatibility
777 #<module name="deaf">
779 #-#-#-#-#-#-#-#-#-#-#-#- DEAF CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#
780 # bypasschars - Characters that bypass deaf to a regular user.
781 # bypasscharsuline - Characters that bypass deaf to a U-lined user (services).
782 # Both of these take a list of characters that must match
783 # the starting character of a message.
784 # If 'bypasscharsuline' is empty, then 'bypasschars' will
785 # match for both regular and U-lined users.
786 # enableprivdeaf - Whether to enable user mode +D (privdeaf).
787 # privdeafuline - Whether U-lined users bypass user mode +D (privdeaf).
789 #<deaf bypasschars="" bypasscharsuline="!" enableprivdeaf="no" privdeafuline="yes">
791 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
792 # Delay join module: Adds the channel mode +D which delays all JOIN
793 # messages from users until they speak. If they quit or part before
794 # speaking, their quit or part message will not be shown to the channel
795 # which helps cut down noise on large channels in a more friendly way
796 # than the auditorium mode. Only channel ops may set the +D mode.
797 #<module name="delayjoin">
799 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
800 # Delay message module: Adds the channel mode +d which disallows a user
801 # from talking in the channel unless they've been joined for X seconds.
802 # Settable using /MODE #chan +d 30
803 #<module name="delaymsg">
804 # Set allownotice to no to disallow NOTICEs too. Defaults to yes.
805 #<delaymsg allownotice="no">
807 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
808 # Deny channels module: Deny channels from being used by users.
809 #<module name="denychans">
811 #-#-#-#-#-#-#-#-#-#-#- DENYCHAN DEFINITIONS -#-#-#-#-#-#-#-#-#-#-#-#
813 # If you have the denychans module loaded, you need to specify the #
814 # channels to deny: #
816 # name - The channel name to deny (glob masks are ok). #
817 # allowopers - If operators are allowed to override the deny. #
818 # reason - Reason given for the deny. #
819 # redirect - Redirect the user to a different channel. #
821 #<badchan name="#gods*" allowopers="yes" reason="Tortoises!"> #
822 #<badchan name="#chan1" redirect="#chan2" reason="Chan1 is closed"> #
824 # Redirects will not work if the target channel is set +L. #
826 # Additionally, you may specify channels which are allowed, even if #
827 # a badchan tag specifies it would be denied: #
828 #<goodchan name="#funtimes"> #
829 # Glob masks are accepted here also. #
831 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
832 # Disable module: Provides support for disabling commands and modes. #
833 #<module name="disable">
835 #-#-#-#-#-#-#-#-#-#-#-#- DISABLE CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#
837 # If you have the disable module loaded then you need to specify the #
838 # commands and modes that you want disabled. Users who have not fully #
839 # connected yet are exempt from this module so you can e.g. disable #
840 # the NICK command but still allow users to connect to the server. #
842 # commands - A space-delimited list of commands that can not be used #
843 # by users. You can exempt server operators from this with #
844 # the servers/use-disabled-commands privilege. #
846 # chanmodes - One or more channel modes that can not be added/removed #
847 # by users. You can exempt server operators from this #
848 # with the servers/use-disabled-modes privilege. #
850 # usermodes - One or more user modes that can not be added/removed by #
851 # users. You can exempt server operators from this with #
852 # the servers/use-disabled-modes privilege. #
854 # fakenonexistent - Whether to pretend that a disabled command/mode #
855 # does not exist when executed/changed by a user. #
858 # notifyopers - Whether to send a notice to snomask `a` when a user #
859 # is prevented from using a disabled command/mode. #
862 #<disabled commands="KICK TOPIC" #
865 # fakenonexistent="yes" #
866 # notifyopers="no"> #
868 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
869 # DNS blacklist module: Provides support for looking up IPs on one or #
871 #<module name="dnsbl">
873 # For configuration options please see the docs page for dnsbl at #
874 # https://docs.inspircd.org/3/modules/dnsbl #
876 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
877 # Exempt channel operators module: Provides support for allowing #
878 # users of a specified channel status to be exempt from some channel #
879 # restriction modes. Supported restrictions are: #
880 # anticaps, auditorium-see, auditorium-vis, blockcaps, blockcolor, #
881 # censor, filter, flood, nickflood, noctcp, nonick, nonotice, #
882 # regmoderated, stripcolor, and topiclock. #
883 # See <options:exemptchanops> in inspircd.conf.example for a more #
884 # detailed list of the restriction modes that can be exempted. #
885 # These are settable using: /MODE #chan +X <restriction>:<status> #
886 #<module name="exemptchanops">
888 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
889 # Filter module: Provides message filtering, similar to SPAMFILTER. #
890 #<module name="filter">
892 # This module depends upon a regex provider such as regex_pcre or #
893 # regex_glob to function. You must specify which of these you want #
894 # the filter module to use via the tag below. #
896 # Valid engines are: #
898 # glob - Glob patterns, provided via regex_glob. #
899 # pcre - PCRE regexps, provided via regex_pcre, needs libpcre. #
900 # tre - TRE regexps, provided via regex_tre, requires libtre. #
901 # posix - POSIX regexps, provided via regex_posix, not available #
902 # on Windows, no dependencies on other operating systems. #
903 # stdlib - stdlib regexps, provided via regex_stdlib, see comment #
904 # at the <module> tag for info on availability. #
906 # If notifyuser is set to no, the user will not be notified when #
907 # their message is blocked. #
909 # If warnonselfmsg is set to yes when a user sends a message to #
910 # themself that matches a filter the filter will be ignored and a #
911 # warning will be sent to opers instead. This stops spambots which #
912 # send their spam message to themselves first to check if it is being #
913 # filtered by the server. #
914 #<filteropts engine="glob" notifyuser="yes" warnonselfmsg="no">
916 # Your choice of regex engine must match on all servers network-wide. #
918 # To learn more about the configuration of this module, read #
919 # examples/filter.conf.example, which covers the various types of #
920 # filters and shows how to add exemptions. #
922 #-#-#-#-#-#-#-#-#-#-#- FILTER CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#
924 # Optional - If you specify to use the filter module, then #
925 # specify below the path to the filter.conf file, or define some #
928 #<include file="examples/filter.conf.example">
930 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
931 # Flash Policy Daemon module: Allows Flash IRC clients (e.g. LightIRC)#
932 # to connect. If no file is specified, it'll serve a default policy #
933 # allowing all IPs to connect to all plaintext IRC ports #
934 #<bind address="" port="8430" type="flashpolicyd"> #
935 #<flashpolicyd timeout="5" file=""> #
936 #<module name="flashpolicyd"> #
938 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
939 # Real name ban: Implements two extended bans: #
940 # 'a', which matches a n!u@h+realname mask like +b a:*!*@host+*real* #
941 # 'r', which matches a realname mask like +b r:*realname?here* #
942 #<module name="gecosban">
944 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
945 # Geolocation ban module: Adds support for extban 'G' which matches #
946 # against the ISO 3166-1 alpha-2 codes for the countries that users #
947 # are connecting from. Users connecting from unknown origins such as #
948 # internal networks can be matched against using the XX alpha-2 code. #
949 # A full list of ISO 3166-1 alpha-2 codes can be found at #
950 # https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2 #
951 #<module name="geoban">
953 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
954 # Geolocation connect class module: Adds support for limiting connect #
955 # classes to users from specific countries. With this module you can #
956 # specify a space-delimited list of two character the ISO 3166-1 #
957 # alpha-2 codes in the "country" field of a connect class. e.g. to #
958 # deny connections from users in Russia or Turkey: #
960 # <connect deny="*" country="TR RU"> #
962 # Users connecting from unknown origins such as internal networks can #
963 # be matched against using the XX alpha-2 code. A full list of ISO #
964 # 3166-1 alpha-2 codes can be found at #
965 # https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2 #
966 #<module name="geoclass">
968 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
969 # MaxMindDB geolocation module: Provides geolocation information for #
970 # other modules that need it using the libMaxMindDB library. #
972 # This module is in extras. Re-run configure with: #
973 # ./configure --enable-extras geo_maxmind
974 # and run make install, then uncomment this module to enable it. #
976 # This module requires libMaxMindDB to be installed on your system. #
977 # Use your package manager to find the appropriate packages or check #
978 # the InspIRCd documentation page for this module. #
979 #<module name="geo_maxmind">
981 # If you use the geo_maxmind module you MUST provide a database file #
982 # to look up geolocation information in. You can either purchase this #
983 # from MaxMind at https://www.maxmind.com/en/geoip2-country-database #
984 # or use the free CC-BY-SA licensed GeoLite2 Country database which #
985 # can be downloaded at https://dev.maxmind.com/geoip/geoip2/geolite2/ #
986 #<maxmind file="GeoLite2-Country.mmdb">
988 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
989 # Globops module: Provides the /GLOBOPS command and snomask +g.
990 # This module is oper-only.
991 # To use, GLOBOPS must be in one of your oper class blocks.
992 #<module name="globops">
994 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
995 # Global load module: Allows loading and unloading of modules network-
996 # wide (USE WITH EXTREME CAUTION!)
997 # This module is oper-only and provides /GLOADMODULE, /GUNLOADMODULE
998 # and /GRELOADMODULE.
999 # To use, GLOADMODULE, GUNLOADMODULE and GRELOADMODULE
1000 # must be in one of your oper class blocks.
1001 #<module name="globalload">
1003 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1004 # HAProxy module: Adds support for the HAProxy PROXY v2 protocol. To
1005 # use this module specify hook="haproxy" in the <bind> tag that HAProxy
1006 # has been configured to connect to.
1007 #<module name="haproxy">
1009 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1010 # HELPOP module: Provides the /HELPOP command
1011 #<module name="helpop">
1013 #-#-#-#-#-#-#-#-#-#-#-#- HELPOP CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
1015 # If you specify to use the helpop module, then specify below the #
1016 # path to the helpop.conf file. #
1018 #<include file="examples/helpop.conf.example">
1020 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1021 # Hide chans module: Allows users to hide their channels list from non-
1022 # opers by setting user mode +I on themselves.
1023 #<module name="hidechans">
1025 # This mode can optionally prevent opers from seeing channels on a +I
1026 # user, for more privacy if set to true.
1027 # This setting is not recommended for most mainstream networks.
1028 #<hidechans affectsopers="false">
1030 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1031 # Hide list module: Allows for hiding the list of listmodes from users
1032 # who do not have sufficient channel rank.
1033 #<module name="hidelist">
1035 # Each <hidelist> tag configures one listmode to hide.
1036 # mode: Name of the listmode to hide.
1037 # rank: Minimum rank required to view the list. If set to 0, all
1038 # members of the channel may view the list, but non-members may not.
1039 # The rank of the built-in op and voice mode is 30000 and 10000,
1040 # respectively; the rank of other prefix modes is configurable.
1041 # Defaults to 20000.
1043 # Hiding the ban list is not recommended because it may break some
1046 # Hide filter (+g) list:
1047 #<hidelist mode="filter" rank="30000">
1048 # Only show invite exceptions (+I) to channel members:
1049 #<hidelist mode="invex" rank="0">
1051 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1052 # Hide mode module: Allows for hiding mode changes from users who do not
1053 # have sufficient channel privileges.
1054 #<module name="hidemode">
1056 # Hide bans (+b) from people who are not voiced:
1057 #<hidemode mode="ban" rank="10000">
1059 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1060 # Hide oper module: Allows opers to hide their oper status from non-
1061 # opers by setting user mode +H on themselves.
1062 # This module is oper-only.
1063 #<module name="hideoper">
1065 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1066 # Hostchange module: Allows a different style of cloaking.
1067 #<module name="hostchange">
1069 #-#-#-#-#-#-#-#-#-#-#- HOSTCHANGE CONFIGURATION -#-#-#-#-#-#-#-#-#-#
1071 # See https://docs.inspircd.org/3/modules/hostchange for help. #
1073 #<hostchange mask="*@42.theanswer.example.org" action="addaccount" suffix=".users.example.com">
1074 #<hostchange mask="*root@*" action="addnick" prefix="example/users/">
1075 #<hostchange mask="a@example.com" action="set" value="foo.bar.baz">
1076 #<hostchange mask="*@localhost" ports="7000,7001,7005-7007" action="set" value="blahblah.foo">
1078 # hostcycle: If loaded, when a user gets a host or ident set, it will
1079 # cycle them in all their channels. If not loaded it will simply change
1080 # their host/ident without cycling them.
1081 # This module is compatible with the ircv3_chghost module. Clients
1082 # supporting the chghost extension will get the chghost message instead
1083 # of seeing a host cycle.
1084 #<module name="hostcycle">
1086 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1087 # httpd module: Provides HTTP server support for InspIRCd.
1088 #<module name="httpd">
1090 #-#-#-#-#-#-#-#-#-#-#-#- HTTPD CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
1092 # If you choose to use the httpd module, then you will need to add
1093 # a <bind> tag with type "httpd", and load at least one of the other
1094 # httpd_* modules to provide pages to display.
1095 # <bind address="127.0.0.1" port="8067" type="httpd">
1096 # <bind address="127.0.0.1" port="8097" type="httpd" ssl="gnutls">
1098 # You can adjust the timeout for HTTP connections below. All HTTP
1099 # connections will be closed after (roughly) this time period.
1100 #<httpd timeout="20">
1102 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1103 # HTTP ACL module: Provides access control lists for httpd dependent
1104 # modules. Use this module to restrict pages by IP address and by
1106 #<module name="httpd_acl">
1108 #-#-#-#-#-#-#-#-#-#-#-#- HTTPD ACL CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
1110 # Restrict access to the httpd_stats module to all but the local
1111 # network and when the correct password is specified:
1112 # <httpdacl path="/stats*" types="password,whitelist"
1113 # username="secrets" password="mypasshere" whitelist="127.0.0.*,10.*">
1115 # Deny all connections to all but the main index page:
1116 # <httpdacl path="/*" types="blacklist" blacklist="*">
1118 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1119 # HTTP config module: Allows the server configuration to be viewed over
1120 # HTTP via the /config path. Requires the httpd module to be loaded for
1123 # IMPORTANT: This module exposes extremely sensitive information about
1124 # your server and users so you *MUST* protect it using a local-only
1125 # <bind> tag and/or the httpd_acl module. See above for details.
1126 #<module name="httpd_config">
1128 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1129 # HTTP stats module: Provides server statistics over HTTP via the /stats
1130 # path. Requires the httpd module to be loaded for it to function.
1132 # IMPORTANT: This module exposes extremely sensitive information about
1133 # your server and users so you *MUST* protect it using a local-only
1134 # <bind> tag and/or the httpd_acl module. See above for details.
1135 #<module name="httpd_stats">
1137 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1138 # Ident: Provides RFC 1413 ident lookup support.
1139 # When this module is loaded <connect:allow> tags may have an optional
1140 # useident="yes|no" boolean value, determining whether or not to lookup
1141 # ident on users matching that connect tag.
1142 #<module name="ident">
1144 #-#-#-#-#-#-#-#-#-#-#-#- IDENT CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
1146 # Optional - If you are using the ident module, then you can specify #
1147 # the timeout for ident lookups here. If not defined, it will default #
1148 # to 5 seconds. This is a non-blocking timeout which holds the user #
1149 # in a 'connecting' state until the lookup is complete. #
1150 # prefixunqueried: If on, the idents of users being in a connect class#
1151 # with ident lookups disabled (i.e. <connect useident="off">) will be #
1152 # prefixed with a "~". If off, the ident of those users will not be #
1153 # prefixed. Default is off. #
1155 #<ident timeout="5" prefixunqueried="no">
1157 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1158 # Invite exception module: Adds support for channel invite exceptions
1160 #<module name="inviteexception">
1161 # bypasskey: If this is enabled, exceptions will bypass +k as well as +i
1162 #<inviteexception bypasskey="yes">
1164 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1165 # IRCv3 module: Provides the following IRCv3 extensions:
1166 # extended-join, away-notify and account-notify. These are optional
1167 # enhancements to the client-to-server protocol. An extension is only
1168 # active for a client when the client specifically requests it, so this
1169 # module needs the cap module to work.
1171 # Further information on these extensions can be found at the IRCv3
1172 # working group website:
1173 # https://ircv3.net/irc/
1175 #<module name="ircv3">
1176 # The following block can be used to control which extensions are
1177 # enabled. Note that extended-join can be incompatible with delayjoin
1179 #<ircv3 accountnotify="on" awaynotify="on" extendedjoin="on">
1181 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1182 # IRCv3 account-tag module. Adds the 'account' tag which contains the
1183 # services account name of the message sender.
1184 #<module name="ircv3_accounttag">
1186 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1187 # IRCv3 batch module: Provides the batch IRCv3 extension which allows
1188 # the server to inform a client that a group of messages are related to
1190 #<module name="ircv3_batch">
1192 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1193 # IRCv3 cap-notify module: Provides the cap-notify IRCv3 extension.
1194 # Required for IRCv3 conformance.
1195 #<module name="ircv3_capnotify">
1197 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1198 # IRCv3 chghost module: Provides the chghost IRCv3 extension which
1199 # allows capable clients to learn when the host/ident of another user
1200 # changes without cycling the user. This module is compatible with the
1201 # hostcycle module. If both are loaded, clients supporting the chghost
1202 # extension will get the chghost message and won't see host cycling.
1203 #<module name="ircv3_chghost">
1205 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1206 # IRCv3 client-to-client tags module: Provides the message-tags IRCv3
1207 # extension which allows clients to add extra data to their messages.
1208 # This is used to support new IRCv3 features such as replies and ids.
1209 #<module name="ircv3_ctctags">
1211 # If you want to only allow client tags that are intended for processing
1212 # by the server you can disable the following setting. Doing this is not
1213 # recommended though as it may break clients.
1214 #<ctctags allowclientonlytags="yes">
1216 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1217 # IRCv3 echo-message module: Provides the echo-message IRCv3
1218 # extension which allows capable clients to get an acknowledgement when
1219 # their messages are delivered and learn what modifications, if any,
1220 # were applied to them.
1221 #<module name="ircv3_echomessage">
1223 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1224 # IRCv3 invite-notify module: Provides the invite-notify IRCv3
1225 # extension which notifies supporting clients when a user invites
1226 # another user into a channel. This respects <options:announceinvites>.
1227 #<module name="ircv3_invitenotify">
1229 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1230 # IRCv3 labeled-response module: Provides the labeled-response IRCv3
1231 # extension which allows server responses to be associated with the
1232 # client message which caused them to be sent.
1233 #<module name="ircv3_labeledresponse">
1235 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1236 # IRCv3 message id module: Provides the msgid IRCv3 extension which
1237 # adds a unique identifier to each message when the message-tags cap
1238 # has been requested. This enables support for modern features such as
1239 # reactions and replies.
1240 #<module name="ircv3_msgid">
1242 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1243 # IRCv3 server-time module. Adds the 'time' tag which adds a timestamp
1244 # to all messages received from the server.
1245 #<module name="ircv3_servertime">
1247 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1248 # IRCv3 Strict Transport Security module: Provides the sts IRCv3
1249 # extension which allows clients connecting insecurely to upgrade their
1250 # connections to TLS.
1251 #<module name="ircv3_sts">
1253 # If using the ircv3_sts module you MUST define a STS policy to send
1254 # to clients using the <sts> tag. This tag takes the following
1257 # host - A glob match for the SNI hostname to apply this policy to.
1258 # duration - The amount of time that the policy lasts for. Defaults to
1259 # five minutes by default. You should raise this to a month
1260 # or two once you know that your config is valid.
1261 # port - The port on which TLS connections to the server are being
1262 # accepted. You MUST have a CA-verified certificate on this
1263 # port. Self signed certificates are not acceptable.
1264 # preload - Whether client developers can include your certificate in
1267 # <sts host="*.example.com" duration="5m" port="6697" preload="yes">
1269 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1270 # Join flood module: Adds support for join flood protection +j X:Y.
1271 # Closes the channel for N seconds if X users join in Y seconds.
1272 #<module name="joinflood">
1274 # duration: The number of seconds to close a channel for when it is
1275 # being flooded with joins.
1277 # bootwait: The number of seconds to disengage joinflood for after
1278 # a server boots. This allows users to reconnect without
1279 # being throttled by joinflood.
1281 # splitwait: The number of seconds to disengage joinflood for after
1282 # a server splits. This allows users to reconnect without
1283 # being throttled by joinflood.
1285 #<joinflood duration="1m"
1289 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1290 # Anti auto rejoin: Adds support for prevention of auto-rejoin (+J).
1291 #<module name="kicknorejoin">
1293 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1294 # Knock module: Adds the /KNOCK command and channel mode +K.
1295 #<module name="knock">
1297 # This setting specifies what to do when someone successfully /KNOCKs.
1298 # If set to "notice", then a NOTICE will be sent to the channel.
1299 # This is the default and the compatible setting, as it requires no
1300 # special support from the clients.
1301 # If set to "numeric" then a 710 numeric will be sent to the channel.
1302 # This allows easier scripting but not all clients support it.
1303 # If set to "both" then (surprise!) both will be sent.
1304 #<knock notify="notice">
1306 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1307 # LDAP module: Allows other SQL modules to access a LDAP database
1308 # through a unified API.
1309 # This modules is in extras. Re-run configure with:
1310 # ./configure --enable-extras ldap
1311 # and run make install, then uncomment this module to enable it.
1313 #<module name="ldap">
1314 #<database module="ldap" id="ldapdb" server="ldap://localhost" binddn="cn=Manager,dc=inspircd,dc=org" bindauth="mysecretpass" searchscope="subtree">
1315 # The server parameter indicates the LDAP server to connect to. The #
1316 # ldap:// style scheme before the hostname proper is MANDATORY. #
1318 # The binddn and bindauth indicate the DN to bind to for searching, #
1319 # and the password for the distinguished name. Some LDAP servers will #
1320 # allow anonymous searching in which case these two values do not #
1321 # need defining, otherwise they should be set similar to the examples #
1324 # The searchscope value indicates the subtree to search under. On our #
1325 # test system this is 'subtree'. Your mileage may vary. #
1327 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1328 # LDAP authentication module: Adds the ability to authenticate users #
1330 #<module name="ldapauth">
1334 # <ldapauth dbid="ldapdb" #
1335 # baserdn="ou=People,dc=brainbox,dc=cc" #
1337 # allowpattern="Guest* Bot*" #
1338 # killreason="Access denied" #
1340 # host="$uid.$ou.inspircd.org" #
1341 # useusername="no"> #
1343 # <ldapwhitelist cidr="10.42.0.0/16"> #
1345 # <ldaprequire attribute="attr" value="val"> #
1347 # The baserdn indicates the base DN to search in for users. Usually #
1348 # this is 'ou=People,dc=yourdomain,dc=yourtld'. #
1350 # The attribute value indicates the attribute which is used to locate #
1351 # a user account by name. On POSIX systems this is usually 'uid'. #
1353 # The allowpattern value allows you to specify a space separated list #
1354 # of wildcard masks which will always be allowed to connect #
1355 # regardless of if they have an account, for example guest and bot #
1358 # The useusername setting chooses whether the user's username or #
1359 # nickname is used when locating a user account, if a username isn't #
1360 # provided in PASS. #
1362 # Killreason indicates the QUIT reason to give to users if they fail #
1363 # to authenticate. #
1365 # Setting the verbose value causes an oper notice to be sent out for #
1366 # every failed authentication to the server, with an error string. #
1368 # ldapwhitelist indicates that clients connecting from an IP in the #
1369 # provided CIDR do not need to authenticate against LDAP. It can be #
1370 # repeated to whitelist multiple CIDRs. #
1372 # ldaprequire allows further filtering on the LDAP user, by requiring #
1373 # certain LDAP attributes to have a given value. It can be repeated, #
1374 # in which case the list will act as an OR list, that is, the #
1375 # authentication will succeed if any of the requirements in the list #
1378 # host allows you to change the displayed host of users connecting #
1379 # from ldap. The string supplied takes formatters which are replaced #
1380 # from the DN. For instance, if your DN looks like: #
1381 # uid=w00t,ou=people,dc=inspircd,dc=org, then the formatters uid, ou #
1382 # and dc will be available to you. If a key is given multiple times #
1383 # in the DN, the last appearance will take precedence. #
1385 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1386 # LDAP oper configuration module: Adds the ability to authenticate #
1388 #<module name="ldapoper">
1392 # <ldapoper dbid="ldapdb"
1393 # baserdn="ou=People,dc=brainbox,dc=cc"
1396 # Available configuration items are identical to the same items in #
1397 # ldapauth above (except for the verbose setting, that is only #
1398 # supported in ldapauth). #
1399 # Please always specify a password in your <oper> tags even if the #
1400 # opers are to be authenticated via LDAP, so in case this module is #
1401 # not loaded the oper accounts are still protected by a password. #
1403 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1404 # Lock server module: Adds /LOCKSERV and /UNLOCKSERV commands that #
1405 # are used to temporarily close/open the server for new connections. #
1406 # These commands require that the /LOCKSERV and /UNLOCKSERV commands #
1407 # are specified in a <class> tag that the oper is part of. This is so #
1408 # you can control who has access to this possible dangerous command. #
1409 # If your server is locked and you get disconnected, do a REHASH from #
1410 # shell to open up again. #
1411 # This module is oper-only.
1412 #<module name="lockserv">
1414 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1415 # Map hiding module: replaces /MAP and /LINKS output to users with a #
1416 # message to see a website, set by maphide="https://test.org/map" in #
1417 # the <security> tag, instead. #
1418 #<module name="maphide">
1420 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1421 # Message flood module: Adds message/notice flood protection via
1423 #<module name="messageflood">
1425 # The weight to give each message type. TAGMSGs are considered to be
1426 # 1/5 of a NOTICE or PRIVMSG to avoid users being accidentally flooded
1427 # out of a channel by automatic client features such as typing
1429 #<messageflood notice="1.0" privmsg="1.0" tagmsg="0.2">
1431 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1432 # MLOCK module: Adds support for server-side enforcement of services
1433 # side MLOCKs. Basically, this module suppresses any mode change that
1434 # would likely be immediately bounced by services.
1435 #<module name="mlock">
1437 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1438 # Modenotice module: Adds the /MODENOTICE command that allows opers to
1439 # send notices to all users having the given user mode(s) set.
1440 #<module name="modenotice">
1442 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1443 # Monitor module: Adds support for MONITOR which is used by clients to
1444 # maintain notify lists.
1445 #<module name="monitor">
1447 # Set the maximum number of entries on a user's monitor list below.
1448 #<monitor maxentries="30">
1450 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1451 # MySQL module: Allows other SQL modules to access MySQL databases
1452 # through a unified API.
1453 # This module is in extras. Re-run configure with:
1454 # ./configure --enable-extras mysql
1455 # and run make install, then uncomment this module to enable it.
1456 #<module name="mysql">
1458 #-#-#-#-#-#-#-#-#-#-#-#- SQL CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#-#
1460 # mysql is more complex than described here, see the docs for more #
1461 # info: https://docs.inspircd.org/3/modules/mysql #
1463 #<database module="mysql" name="mydb" user="myuser" pass="mypass" host="localhost" id="my_database2">
1465 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1466 # Named modes module: Allows for the display and set/unset of channel
1467 # modes via long-form mode names via +Z and the /PROP command.
1468 # For example, to set a ban, do /MODE #channel +Z ban=foo!bar@baz or
1469 # /PROP #channel ban=foo!bar@baz
1470 #<module name="namedmodes">
1472 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1473 # NAMESX module: Provides support for the NAMESX extension which allows
1474 # clients to see all the prefixes set on a user without getting confused.
1475 # This is supported by mIRC, x-chat, klient, and maybe more.
1476 #<module name="namesx">
1478 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1479 # National characters module:
1480 # 1) Allows using national characters in nicknames.
1481 # 2) Allows using custom (national) casemapping over the network.
1483 # This module is incredibly poorly written and documented. You should
1484 # probably use the codepage module instead for 8-bit codepages.
1485 #<module name="nationalchars">
1487 # file - Location of the file which contains casemapping rules. If this
1488 # is a relative path then it is relative to "<PWD>/../locales"
1489 # on UNIX and "<PWD>/locales" on Windows.
1490 # casemapping - The name of the casemapping sent to clients in the 005
1491 # numeric. If this is not set then it defaults to the name
1492 # of the casemapping file unless the file name contains a
1493 # space in which case you will have to specify it manually.
1494 #<nationalchars file="bynets/russian-w1251-charlink" casemapping="ru_RU.cp1251-charlink">
1496 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1497 # Nickchange flood protection module: Provides channel mode +F X:Y
1498 # which allows up to X nick changes in Y seconds.
1499 #<module name="nickflood">
1501 # The number of seconds to prevent nick changes for:
1502 #<nickflood duration="1m">
1504 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1505 # Nicklock module: Let opers change a user's nick and then stop that
1506 # user from changing their nick again until unlocked.
1507 # This module is oper-only.
1508 # To use, NICKLOCK and NICKUNLOCK must be in one of your oper class blocks.
1509 #<module name="nicklock">
1511 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1512 # No CTCP module: Adds the channel mode +C and user mode +T to block
1513 # CTCPs and extban 'C' to block CTCPs sent by specific users.
1514 #<module name="noctcp">
1516 # The +T user mode is not enabled by default to enable link compatibility
1517 # with 2.0 servers. You can enable it by uncommenting this:
1518 #<noctcp enableumode="yes">
1520 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1521 # No kicks module: Adds the +Q channel mode and the Q: extban to deny
1522 # certain users from kicking.
1523 #<module name="nokicks">
1525 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1526 # No nicks module: Adds the +N channel mode, as well as the 'N' extban.
1527 # +N stops all users from changing their nick, the N extban stops
1528 # anyone from matching a +b N:nick!user@host mask from changing their
1530 #<module name="nonicks">
1532 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1533 # No part message module: Adds extban 'p' to block part messages from #
1535 #<module name="nopartmsg">
1537 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1538 # No notice module: Adds the channel mode +T and the extban 'T' to
1539 # block specific users from noticing the channel.
1540 #<module name="nonotice">
1542 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1543 # Network business join module:
1544 # Allows an oper to join a channel using /OJOIN, giving them +Y on the
1545 # channel which makes them immune to kicks.
1546 #<module name="ojoin">
1548 # Specify the prefix that +Y will grant here.
1549 # Leave 'prefix' empty if you do not wish +Y to grant a prefix.
1550 # If 'notice' is set to on, upon /OJOIN, the server will notice the
1551 # channel saying that the oper is joining on network business.
1552 # If 'op' is set to on, it will give them +o along with +Y.
1553 #<ojoin prefix="!" notice="yes" op="yes">
1555 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1556 # Oper channels mode: Adds the +O channel mode and extban O:<mask>
1557 # to ban, except, etc. specific oper types. For example
1558 # /MODE #channel +iI O:* is equivalent to channel mode +O, but you
1559 # may also set +iI O:AdminTypeOnly to only allow admins.
1560 # Modes +I and +e work in a similar fashion.
1561 #<module name="operchans">
1563 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1564 # Oper join module: Auto-joins opers to a channel upon oper-up.
1565 # This module is oper-only. For the user equivalent, see the conn_join
1567 #<module name="operjoin">
1569 #-#-#-#-#-#-#-#-#-#-# OPERJOIN CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
1571 # If you are using the operjoin module, specify options here: #
1573 # channel - The channel name to join, can also be a comma #
1574 # separated list e.g. "#channel1,#channel2". #
1576 # override - If on, lets the oper join walking thru any modes #
1577 # that might be set, even bans. #
1579 #<operjoin channel="#channel" override="no">
1581 # Alternatively you can use the autojoin="channellist" in a <type> #
1582 # tag to set specific autojoins for a type of oper, for example: #
1584 #<type name="Helper" autojoin="#help" classes="...">
1586 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1587 # Oper log module: Logs all oper commands to the server log (with log
1588 # type "m_operlog" at default loglevel), and optionally to the 'r'
1590 # This module is oper-only.
1591 #<module name="operlog">
1593 # If the following option is on then all oper commands will be sent to
1594 # the snomask 'r'. The default is off.
1595 #<operlog tosnomask="off">
1597 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1598 # Oper prefixing module: Adds a channel prefix mode +y which is given
1599 # to all server operators automatically on all channels they are in.
1600 # This prefix mode is more powerful than channel op and other regular
1603 # Load this module if you want all your server operators to have
1604 # channel operator powers.
1605 #<module name="operprefix">
1607 # You may additionally customise the prefix character.
1608 #<operprefix prefix="!">
1610 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1611 # Oper MOTD module: Provides support for a separate message of the day
1613 # This module is oper-only.
1614 #<module name="opermotd">
1616 #-#-#-#-#-#-#-#-#-#-# OPERMOTD CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
1618 # If you are using the opermotd module, specify the motd file here. #
1620 # onoper - If on, the message is sent on /OPER, otherwise it's #
1621 # only sent when /OPERMOTD is used. #
1623 #<opermotd file="examples/opermotd.txt.example" onoper="yes">
1625 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1626 # Override module: Adds support for oper override.
1627 # This module is oper-only.
1628 #<module name="override">
1630 #-#-#-#-#-#-#-#-#-#-# OVERRIDE CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
1632 # Much of override's configuration relates to your oper blocks. #
1633 # For more information on how to allow opers to override, see: #
1634 # https://docs.inspircd.org/3/modules/override #
1636 # noisy - If enabled, all oper overrides will be announced #
1637 # via channel notice. #
1639 # requirekey - If enabled, overriding on join requires a channel #
1640 # key of "override" to be specified. #
1642 # enableumode - If enabled, user mode +O is required for override. #
1644 #<override noisy="yes" requirekey="no" enableumode="yes">
1646 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1647 # Oper levels module: Gives each oper a level and prevents actions
1648 # being taken by lower level opers against higher level opers.
1649 # Specify the level as the 'level' parameter of the <type> tag.
1650 # This module is oper-only.
1651 #<module name="operlevels">
1653 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1654 # Oper modes module: Allows you to specify modes to add/remove on oper.
1655 # Specify the modes as the 'modes' parameter of the <type> tag
1656 # and/or as the 'modes' parameter of the <oper> tag.
1657 # This module is oper-only. For the user equivalent, see the
1658 # conn_umodes module.
1659 #<module name="opermodes">
1661 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1662 # Password forwarding module: Forwards a password users can send on
1663 # connect to the specified client below. The client is usually NickServ
1664 # and this module is usually used to authenticate users with NickServ
1665 # using their connect password.
1666 #<module name="passforward">
1669 # nick: nick to forward connect passwords to.
1672 # forwardmsg: Message to send to users using a connect password.
1673 # $nick will be the users' nick, $nickrequired will be the nick
1674 # of where the password is going (the nick above).
1675 # You can also use $user for the user ident string.
1676 forwardmsg="NOTICE $nick :*** Forwarding PASS to $nickrequired"
1678 # cmd: Command for the user to run when it receives a connect
1680 cmd="SQUERY $nickrequired :IDENTIFY $pass">
1682 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1683 # Password hash module: Allows hashed passwords to be used.
1684 # To be useful, a hashing module like bcrypt also needs to be loaded.
1685 #<module name="password_hash">
1687 #-#-#-#-#-#-#-#-#-# PASSWORD HASH CONFIGURATION #-#-#-#-#-#-#-#-#-#-#-#
1689 # To use this module, you must define a hash type for each oper's
1690 # password you want to hash. For example:
1692 # <oper name="Brain"
1693 # host="ident@dialup15.isp.test.com"
1695 # password="$2a$10$Mss9AtHHslZTLBrXqM0FB.JBwD.UTSu8A48SfrY9exrpxbsRiRTbO"
1698 # If you are using a hash algorithm which does not perform salting you can use
1699 # HMAC to salt your passwords in order to prevent them from being looked up in
1702 # hash="hmac-sha256" password="lkS1Nbtp$CyLd/WPQXizsbxFUTqFRoMvaC+zhOULEeZaQkUJj+Gg"
1704 # Generate hashes using the /MKPASSWD command on the server.
1705 # Don't run it on a server you don't trust with your password.
1707 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1708 # PBKDF2 module: Allows other modules to generate PBKDF2 hashes,
1709 # usually for cryptographic uses and security.
1710 # This module relies on other hash providers (e.g. SHA256).
1711 #<module name="pbkdf2">
1713 # iterations: Iterations the hashing function runs when generating new
1715 # length: Length in bytes of the derived key.
1716 #<pbkdf2 iterations="12288" length="32">
1717 # You can override these values with specific values
1718 # for specific providers if you want to. Example given for SHA256.
1719 #<pbkdf2prov hash="sha256" iterations="24576">
1721 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1722 # Permanent channels module: Channels with the permanent channel mode
1723 # will remain open even after everyone else has left the channel, and
1724 # therefore keep things like modes, ban lists and topic. Permanent
1725 # channels -may- need support from your Services package to function
1726 # properly with them. This adds channel mode +P.
1727 # This module is oper-only.
1728 #<module name="permchannels">
1730 # If you like, this module can write a config file of permanent channels
1731 # whenever +P is set, unset, or the topic/modes on a +P channel is changed.
1732 # If you want to do this, set the filename below, and uncomment the include.
1734 # If 'listmodes' is true then all list modes (+b, +I, +e, +g...) will be
1735 # saved. Defaults to false.
1737 # 'saveperiod' determines how often to check if the database needs to be
1738 # saved to disk. Defaults to every five seconds.
1739 #<permchanneldb filename="permchannels.conf"
1742 #<include file="permchannels.conf">
1744 # You may also create channels on startup by using the <permchannels> block.
1745 #<permchannels channel="#opers" modes="isP" topic="Opers only.">
1747 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1748 # PostgreSQL module: Allows other SQL modules to access PgSQL databases
1749 # through a unified API.
1750 # This module is in extras. Re-run configure with:
1751 # ./configure --enable-extras pgsql
1752 # and run make install, then uncomment this module to enable it.
1753 #<module name="pgsql">
1755 #-#-#-#-#-#-#-#-#-#-#-#- SQL CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#-#
1757 # pgsql is more complex than described here, see the docs for #
1758 # more: https://docs.inspircd.org/3/modules/pgsql #
1760 #<database module="pgsql" name="mydb" user="myuser" pass="mypass" host="localhost" id="my_database" ssl="no">
1762 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1763 # Muteban: Implements extended ban 'm', which stops anyone matching
1764 # a mask like +b m:nick!user@host from speaking on channel.
1765 #<module name="muteban">
1767 # If notifyuser is set to no, the user will not be notified when
1768 # their message is blocked.
1769 #<muteban notifyuser="yes">
1771 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1772 # Random quote module: Provides a random quote on connect.
1773 # NOTE: Some of these may mimic fatal errors and confuse users and
1774 # opers alike - BEWARE!
1775 #<module name="randquote">
1777 #-#-#-#-#-#-#-#-#-#- RANDOMQUOTES CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
1779 # Optional - If you specify to use the randquote module, then specify #
1780 # below the path to the quotes file. #
1782 #<randquote file="quotes.txt">
1784 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1785 # Redirect module: Adds channel mode +L which redirects users to #
1786 # another channel when the channel has reached its user limit and #
1787 # user mode +L which stops redirection. #
1788 #<module name="redirect">
1790 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1791 # Regular expression provider for glob or wildcard (?/*) matching.
1792 # You must have at least 1 provider loaded to use the filter or R-line
1793 # modules. This module has no additional requirements, as it uses the
1794 # matching already present in InspIRCd core.
1795 #<module name="regex_glob">
1797 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1798 # Regular expression provider for PCRE (Perl-Compatible Regular
1799 # Expressions). You need libpcre installed to compile and load this
1800 # module. You must have at least 1 provider loaded to use the filter or
1802 #<module name="regex_pcre">
1804 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1805 # Regular Expression Provider for RE2 Regular Expressions.
1806 # You need libre2 installed and in your include/library paths in order
1807 # to compile and load this module.
1808 #<module name="regex_re2">
1810 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1811 # Regular expression provider for POSIX regular expressions.
1812 # You shouldn't need any additional libraries on a POSIX-compatible
1813 # system (i.e.: any Linux, BSD, but not Windows). You must have at
1814 # least 1 provider loaded to use the filter or R-line modules.
1815 # On POSIX-compliant systems, regex syntax can be found by using the
1816 # command: 'man 7 regex'.
1817 #<module name="regex_posix">
1819 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1820 # Regular expression provider for C++11 std::regex regular expressions.
1821 # This module works on any fully compliant implementation of the C++11
1822 # std::regex container. Examples for such are Visual C++ 2010 and newer
1823 # but not libstdc++ (which GCC uses).
1824 # You should verify that std::regex is supported by your setup before
1825 # using this module, as it may compile normally but won't do anything
1826 # on some implementations.
1827 #<module name="regex_stdlib">
1829 # Specify the regular expression engine to use here. Valid settings are
1830 # bre, ere, awk, grep, egrep, ecmascript (default if not specified).
1831 #<stdregex type="ecmascript">
1833 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1834 # Regular expression provider for TRE regular expressions.
1835 # This is the same regular expression engine used by UnrealIRCd, so
1836 # if you are most familiar with the syntax of /SPAMFILTER from there,
1837 # this is the provider you want. You need libtre installed in order
1838 # to compile and load this module.
1839 #<module name="regex_tre">
1841 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1842 # Remove module: Adds the /REMOVE command which is a peaceful
1843 # alternative to /KICK. It also provides the /FPART command which works
1844 # in the same way as /REMOVE.
1845 #<module name="remove">
1847 # supportnokicks: If true, /REMOVE is not allowed on channels where the
1848 # nokicks (+Q) mode is set. Defaults to false.
1849 # protectedrank: Members having this rank or above may not be /REMOVE'd
1850 # by anyone. Set to 0 to disable this feature. Defaults to 50000.
1851 #<remove supportnokicks="yes" protectedrank="50000">
1853 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1854 # Repeat module: Allows to block, kick or ban upon similar messages
1855 # being uttered several times. Provides channel mode +E.
1857 # Syntax: [~|*]<lines>:<sec>[:<difference>][:<backlog>]
1858 # ~ is to block, * is to ban, default is kick.
1859 # lines - In mode 1, the amount of lines that has to match consecutively.
1860 # In mode 2, the size of the backlog to keep for matching.
1861 # seconds - How old the message has to be before it's invalidated.
1862 # difference - Edit distance, in percent, between two strings to trigger on.
1863 # backlog - When set, the function goes into mode 2. In this mode the
1864 # function will trigger if this many of the last <lines> matches.
1866 # As this module can be rather CPU-intensive, it comes with some options.
1867 # maxbacklog - Maximum size that can be specified for backlog. 0 disables
1868 # multiline matching.
1869 # maxdistance - Max percentage of difference between two lines we'll allow
1870 # to match. Set to 0 to disable edit-distance matching.
1871 # maxlines - Max lines of backlog to match against.
1872 # maxtime - Maximum period of time a user can set. 0 to allow any.
1873 # size - Maximum number of characters to check for, can be used to
1874 # truncate messages before they are checked, resulting in
1875 # less CPU usage. Increasing this beyond 512 doesn't have
1876 # any effect, as the maximum length of a message on IRC
1877 # cannot exceed that.
1878 #<repeat maxbacklog="20" maxdistance="50" maxlines="20" maxtime="0" size="512">
1879 #<module name="repeat">
1881 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1882 # Restricted channels module: Allows only opers with the
1883 # channels/restricted-create priv and/or registered users to
1886 # You probably *DO NOT* want to load this module on a public network.
1888 #<module name="restrictchans">
1890 # allowregistered: should registered users be allowed to bypass the restrictions?
1891 #<restrictchans allowregistered="no">
1893 # Allow any channel matching #user-* to be created, bypassing restrictchans checks
1894 #<allowchannel name="#user-*">
1896 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1897 # Restrict message module: Allows users to only message opers.
1899 # You probably *DO NOT* want to load this module on a public network.
1901 #<module name="restrictmsg">
1903 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1904 # R-line module: Ban users through regular expression patterns.
1905 #<module name="rline">
1907 #-#-#-#-#-#-#-#-#-#-#-#- RLINE CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#-#
1909 # If you wish to re-check a user when they change nickname (can be
1910 # useful under some situations, but *can* also use CPU with more users
1911 # on a server) then set 'matchonnickchange' to yes.
1912 # If you additionally want Z-lines to be added on matches, then
1913 # set 'zlineonmatch' to yes.
1914 # Also, this is where you set what Regular Expression engine is to be
1915 # used. If you ever change it while running, all of your R-lines will
1916 # be wiped. This is the regex engine used by all R-lines set, and
1917 # regex_<engine> must be loaded, or rline will be non-functional
1918 # until you load it or change the engine to one that is loaded.
1920 #<rline matchonnickchange="yes" zlineonmatch="no" engine="pcre">
1922 # Generally, you will NOT want to use 'glob' here, as this turns an
1923 # R-line into just another G-line. The exceptions are that R-lines will
1924 # always use the full "nick!user@host realname" string, rather than only
1925 # user@host, but beware that only the ? and * wildcards are available,
1926 # and are the only way to specify where the space can occur if you do
1927 # use glob. For this reason, is recommended to use a real regex engine
1928 # so that at least \s or [[:space:]] is available.
1930 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1931 # RMODE module: Adds the /RMODE command.
1932 # Allows channel operators to remove list modes en masse, optionally
1933 # matching a glob-based pattern.
1934 # Syntax: /RMODE <channel> <mode> [<pattern>]
1935 # E.g. '/RMODE #channel b m:*' will remove all mute extbans on the channel.
1936 #<module name="rmode">
1938 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1939 # SAJOIN module: Adds the /SAJOIN command which forcibly joins a user
1940 # to the given channel.
1941 # This module is oper-only.
1942 # To use, SAJOIN must be in one of your oper class blocks.
1943 # Opers need the users/sajoin-others priv to be able to /SAJOIN users
1944 # other than themselves.
1945 #<module name="sajoin">
1947 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1948 # SAKICK module: Adds the /SAKICK command which kicks a user from the
1950 # This module is oper-only.
1951 # To use, SAKICK must be in one of your oper class blocks.
1952 #<module name="sakick">
1954 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1955 # SAMODE module: Adds the /SAMODE command which allows server operators
1956 # to change modes on a channel without requiring them to have any
1957 # channel privileges. Also allows changing user modes for any user.
1958 # This module is oper-only.
1959 # To use, SAMODE must be in one of your oper class blocks.
1960 #<module name="samode">
1962 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1963 # SANICK module: Adds the /SANICK command which allows opers to change
1965 # This module is oper-only.
1966 # To use, SANICK must be in one of your oper class blocks.
1967 #<module name="sanick">
1969 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1970 # SAPART module: Adds the /SAPART command which forcibly parts a user
1972 # This module is oper-only.
1973 # To use, SAPART must be in one of your oper class blocks.
1974 #<module name="sapart">
1976 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1977 # SAQUIT module: Adds the /SAQUIT command which forcibly quits a user.
1978 # This module is oper-only.
1979 # To use, SAQUIT must be in one of your oper class blocks.
1980 #<module name="saquit">
1982 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1983 # SATOPIC module: Adds the /SATOPIC command which allows changing the
1984 # topic on a channel without requiring any channel privileges.
1985 # This module is oper-only.
1986 # To use, SATOPIC must be in one of your oper class blocks.
1987 #<module name="satopic">
1989 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1990 # SASL authentication module: Provides support for IRC Authentication
1991 # Layer via AUTHENTICATE. Note: You also need to have cap loaded
1993 #<module name="sasl">
1995 # You must define <sasl:target> to the name of your services server so
1996 # that InspIRCd knows where to send SASL authentication messages and
1997 #Â when it should enable the SASL capability.
1998 # You can also define <sasl:requiressl> to require users to use TLS (SSL)
1999 # in order to be able to use SASL.
2000 #<sasl target="services.mynetwork.com"
2003 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2004 # Secure list module: Prevent /LIST in the first minute of connection,
2005 # crippling most spambots and trojan spreader bots.
2006 #<module name="securelist">
2008 #-#-#-#-#-#-#-#-#-# SECURELIST CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#-#
2010 # Securelist can be harmful to some IRC search engines. To prevent #
2011 # securelist blocking these sites from listing, define exception tags #
2013 #<securehost exception="*@*.netsplit.de">
2014 #<securehost exception="*@*.ircdriven.com">
2015 #<securehost exception="*@*.ircs.me">
2017 # exemptregistered - Whether the waiting period applies to users who #
2018 # are logged in to a services account. #
2021 # showmsg - Whether to tell users that they need to wait for a while #
2022 # before they can use the /LIST command. #
2025 # waittime - The time period that a user must be connected for before #
2026 # they can use the /LIST command. #
2027 # Defaults to 1 minute. #
2029 #<securelist exemptregistered="yes"
2033 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2034 # Servprotect module: Provides support for Austhex style +k /
2035 # UnrealIRCD +S services mode.
2036 #<module name="servprotect">
2038 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2039 # See nicks module: Adds snomask +n and +N which show local and remote
2041 # This module is oper-only.
2042 #<module name="seenicks">
2044 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2045 # Set idle module: Adds a command for opers to change their idle time.
2046 # This module is oper-only.
2047 # To use, SETIDLE must be in one of your oper class blocks.
2048 #<module name="setidle">
2050 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2051 # Services support module: Adds several user modes such as +R and +M.
2052 # This module implements the 'identified' state via account names,
2053 # and is similar in operation to the way asuka and ircu handle services.
2055 # At the same time, this offers +r for users and channels to mark them
2056 # as identified separately from the idea of a master account, which
2057 # can be useful for services which are heavily nick-as-account centric.
2059 # Also of note is that this module implements two extbans:
2060 # +b R: (stop matching account names from joining)
2061 # +b U:n!u@h (blocks matching unregistered users)
2063 #<module name="services_account">
2065 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2066 # Sethost module: Adds the /SETHOST command.
2067 # This module is oper-only.
2068 # To use, SETHOST must be in one of your oper class blocks.
2069 # See the chghost module for how to customise valid chars for hostnames.
2070 #<module name="sethost">
2072 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2073 # Setident module: Adds the /SETIDENT command.
2074 # This module is oper-only.
2075 # To use, SETIDENT must be in one of your oper class blocks.
2076 #<module name="setident">
2078 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2079 # SETNAME module: Adds the /SETNAME command.
2080 #<module name="setname">
2082 #-#-#-#-#-#-#-#-#-#-#-#- SETNAME CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#
2084 # operonly - Whether the SETNAME command should only be usable by #
2085 # server operators. Defaults to no. #
2087 # notifyopers - Whether to send a snotice to snomask `a` when a user #
2088 # changes their real name. Defaults to to yes if #
2089 # oper-only and no if usable by everyone. #
2091 #<setname notifyopers="yes"
2094 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2095 # Serverban: Implements extended ban 's', which stops anyone connected
2096 # to a server matching a mask like +b s:server.mask.here from joining.
2097 # Wildcards are accepted.
2098 #<module name="serverban">
2100 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2101 # SHA1 module: Allows other modules to generate SHA1 hashes.
2102 # Required by the WebSocket module.
2103 #<module name="sha1">
2105 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2106 # Showfile: Provides support for showing a text file to users when #
2107 # they enter a command. #
2108 # This module adds one command for each <showfile> tag that shows the #
2109 # given file to the user as a series of messages or numerics. #
2110 #<module name="showfile">
2112 #-#-#-#-#-#-#-#-#-#-# SHOWFILE CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#-#
2114 # name - The name of the command which displays this file. This is #
2115 # the only mandatory setting, all others are optional. #
2116 # file - The text file to be shown to the user. #
2117 # By default same as the command name. #
2118 # method - How should the file be shown? #
2119 # * numeric: Send contents using a numeric #
2120 # (similar to /MOTD; the default). #
2121 # * notice: Send contents as a series of notices. #
2122 # * msg: Send contents as a series of private messages. #
2124 # When using the method "numeric", the following extra settings are #
2127 # introtext - Introductory line, "Showing <name>" by default. #
2128 # intronumeric - Numeric used for the introductory line. #
2129 # numeric - Numeric used for sending the text itself. #
2130 # endtext - Ending line, "End of <name>" by default. #
2131 # endnumeric - Numeric used for the ending line. #
2133 #<showfile name="RULES"
2135 # introtext="Server rules:"
2136 # endtext="End of server rules.">
2138 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2139 # Show whois module: Adds the +W user mode which allows opers to see
2140 # when they are /WHOIS'd.
2141 # This module is oper-only by default.
2142 #<module name="showwhois">
2144 # If you wish, you may also let users set this mode. Only opers with the
2145 # users/auspex priv will see real hosts of people, though.
2146 #<showwhois opersonly="yes"
2148 # You may also set whether or not users should receive whois notices,
2149 # should they be /WHOIS'd by an oper.
2150 #showfromopers="yes">
2152 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2153 # Shun module: Provides the /SHUN command, which stops a user from
2154 # executing all except configured commands.
2155 # This module is oper-only.
2156 # To use, SHUN must be in one of your oper class blocks.
2157 #<module name="shun">
2161 # affectopers: Whether server operators are exempt from shuns. This
2162 # option is deprecated; you should instead give exempt
2163 # server operators the servers/ignore-shun privilege.
2165 # allowtags: Whether to allow client tags to be attached to enabled
2168 # cleanedcommands: The commands that, if enabled, should be cleaned
2169 # of any message content if a shunned user tries to
2172 # enabledcommands: The commands that a shunned user is allowed to
2175 # notifyuser: Whether to notify shunned users that a command they tried
2176 # to execute has been blocked.
2178 #<shun enabledcommands="ADMIN OPER PING PONG QUIT PART JOIN"
2179 # cleanedcommands="AWAY PART QUIT"
2184 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2185 # SSL mode module: Adds support for TLS (SSL)-only channels via the '+z'
2186 # channel mode, TLS (SSL)-only private messages via the '+z' user mode and
2187 # the 'z:' extban which matches TLS (SSL) client certificate fingerprints.
2189 # Does not do anything useful without a working TLS (SSL) module and the
2190 # sslinfo module (see below).
2191 #<module name="sslmodes">
2193 # The +z user mode is not enabled by default to enable link compatibility
2194 # with 2.0 servers. You can enable it by uncommenting this:
2195 #<sslmodes enableumode="yes">
2197 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2198 # SSL rehash signal module: Allows the TLS (SSL) modules to be rehashed by
2199 # sending SIGUSR1 to a running InspIRCd process.
2200 # This module is in extras. Re-run configure with:
2201 # ./configure --enable-extras sslrehashsignal
2202 # and run make install, then uncomment this module to enable it.
2203 #<module name="sslrehashsignal">
2205 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2206 # GnuTLS SSL module: Adds support for TLS (SSL) connections using GnuTLS,
2207 # if enabled. You must answer 'yes' in ./configure when asked or
2208 # manually symlink the source for this module from the directory
2209 # src/modules/extra, if you want to enable this, or it will not load.
2210 #<module name="ssl_gnutls">
2212 #-#-#-#-#-#-#-#-#-#-#- GNUTLS CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#
2214 # ssl_gnutls is too complex to describe here, see the docs: #
2215 # https://docs.inspircd.org/3/modules/ssl_gnutls #
2217 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2218 # SSL info module: Allows users to retrieve information about other
2219 # users' peer TLS (SSL) certificates and keys via the SSLINFO command.
2220 # This can be used by client scripts to validate users. For this to
2221 # work, one of ssl_gnutls, ssl_mbedtls or ssl_openssl must be loaded.
2222 # This module also adds the "<user> is using a secure connection"
2223 # and "<user> has TLS (SSL) client certificate fingerprint <fingerprint>"
2224 # WHOIS lines, the ability for opers to use TLS (SSL) cert fingerprints to
2225 # verify their identity and the ability to force opers to use TLS (SSL)
2226 # connections in order to oper up. It is highly recommended to load
2227 # this module if you use TLS (SSL) on your network.
2228 # For how to use the oper features, please see the first
2229 # example <oper> tag in opers.conf.example.
2231 #<module name="sslinfo">
2233 # If you want to prevent users from viewing TLS (SSL) certificate information
2234 # and fingerprints of other users, set operonly to yes.
2235 #<sslinfo operonly="no">
2237 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2238 # mbedTLS TLS (SSL) module: Adds support for TLS (SSL) connections using mbedTLS.
2239 #<module name="ssl_mbedtls">
2241 #-#-#-#-#-#-#-#-#-#-#- MBEDTLS CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#
2243 # ssl_mbedtls is too complex to describe here, see the docs: #
2244 # https://docs.inspircd.org/3/modules/ssl_mbedtls #
2246 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2247 # OpenSSL TLS (SSL) module: Adds support for TLS (SSL) connections using OpenSSL,
2248 # if enabled. You must answer 'yes' in ./configure when asked or symlink
2249 # the source for this module from the directory src/modules/extra, if
2250 # you want to enable this, or it will not load.
2251 #<module name="ssl_openssl">
2253 #-#-#-#-#-#-#-#-#-#-#- OPENSSL CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#
2255 # ssl_openssl is too complex to describe here, see the docs: #
2256 # https://docs.inspircd.org/3/modules/ssl_openssl #
2258 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2259 # Strip color module: Adds channel mode +S that strips color codes and
2260 # all control codes except CTCP from all messages sent to the channel.
2261 #<module name="stripcolor">
2263 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2264 # Silence module: Adds support for the /SILENCE command, which allows
2265 # users to have a server-side ignore list for their client.
2266 #<module name="silence">
2268 # Set the maximum number of entries allowed on a user's silence list.
2269 #<silence maxentries="32"
2271 # Whether messages from U-lined servers will bypass silence masks.
2274 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2275 # SQLite3 module: Allows other SQL modules to access SQLite3 #
2276 # databases through a unified API. #
2277 # This module is in extras. Re-run configure with: #
2278 # ./configure --enable-extras sqlite3
2279 # and run make install, then uncomment this module to enable it. #
2281 #<module name="sqlite3">
2283 #-#-#-#-#-#-#-#-#-#-#-#- SQL CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#-#
2285 # sqlite is more complex than described here, see the docs for more #
2286 # info: https://docs.inspircd.org/3/modules/sqlite3 #
2288 #<database module="sqlite" hostname="/full/path/to/database.db" id="anytext">
2290 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2291 # SQL authentication module: Allows IRCd connections to be tied into
2292 # a database table (for example a forum).
2294 #<module name="sqlauth">
2296 #-#-#-#-#-#-#-#-#-#-#- SQLAUTH CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#
2298 # sqlauth is too complex to describe here, see the docs: #
2299 # https://docs.inspircd.org/3/modules/sqlauth #
2301 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2302 # SQL oper module: Allows you to store oper credentials in an SQL
2303 # table. You can add additional table columns like you would config
2304 # tags in opers.conf. Opers in opers.conf will override opers from
2307 #<module name="sqloper">
2309 #-#-#-#-#-#-#-#-#-#-#- SQLOPER CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#
2311 # dbid - Database ID to use (see SQL modules). #
2313 # See also: https://docs.inspircd.org/3/modules/sqloper #
2317 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2318 # StartTLS module: Implements STARTTLS, which allows clients #
2319 # connected to non TLS (SSL) enabled ports to enable TLS (SSL), if #
2320 # a proper TLS (SSL) module is loaded (either ssl_gnutls, #
2321 # ssl_mbedtls or ssl_openssl). #
2322 #<module name="starttls">
2324 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2325 # SVSHold module: Implements SVSHOLD. Like Q-lines, but can only be #
2326 # added/removed by Services. #
2327 #<module name="svshold">
2328 # SVSHOLD does not generate server notices by default, you can turn
2329 # notices on by uncommenting the next line.
2330 #<svshold silent="false">
2332 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2333 # SWHOIS module: Allows you to add arbitrary lines to user WHOIS.
2334 # This module is oper-only.
2335 # To use, SWHOIS must be in one of your oper class blocks.
2336 #<module name="swhois">
2338 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2339 # Timed bans module: Adds timed channel bans with the /TBAN command.
2340 #<module name="timedbans">
2341 # By default, it sends a notice to channel operators when timed ban is
2342 # set and when it is removed by server.
2343 #<timedbans sendnotice="yes">
2345 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2346 # Test line module: Adds the /TLINE command, used to test how many
2347 # users a /GLINE or /ZLINE etc. would match.
2348 # This module is oper-only.
2349 # To use, TLINE must be in one of your oper class blocks.
2350 #<module name="tline">
2352 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2353 # Topiclock module: implements server-side topic locking to achieve deeper
2354 # integration with services packages.
2355 #<module name="topiclock">
2357 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2358 # UHNAMES support module: Adds support for the IRCX style UHNAMES
2359 # extension, which displays ident and hostname in the names list for
2360 # each user, saving clients from doing a WHO on the channel.
2361 # If a client does not support UHNAMES it will not enable it, this will
2362 # not break incompatible clients.
2363 #<module name="uhnames">
2365 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2366 # Uninvite module: Adds the /UNINVITE command which lets users remove
2367 # pending invites from channels without waiting for the user to join.
2368 #<module name="uninvite">
2370 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2371 # Userip module: Adds the /USERIP command.
2372 # Allows users to query their own IP, also allows opers to query the IP
2374 #<module name="userip">
2376 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2377 # Vhost module: Adds the VHOST command which allows for adding virtual
2378 # hosts which are accessible using a username and password in the config.
2379 #<module name="vhost">
2381 #-#-#-#-#-#-#-#-#-#-#- VHOST CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#-#
2383 # user - Username for the vhost. #
2385 # pass - Password for the vhost. #
2387 # hash - The hash for the specific user (optional) #
2388 # password_hash and a hashing module must be loaded for #
2391 # host - Vhost to set. #
2393 #<vhost user="some_username" pass="some_password" host="some.host.test.cc">
2394 #<vhost user="foo" password="$2a$10$iTuYLT6BRhRlOgzfsW9oPe62etW.oXwSpyKw5rJit64SGZanLXghO" hash="bcrypt" host="some.other.host.example.com">
2396 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2397 # Watch module: Adds the WATCH command, which is used by clients to
2398 # maintain notify lists.
2399 #<module name="watch">
2401 # Set the maximum number of entries on a user's watch list below.
2402 #<watch maxwatch="32">
2404 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2405 # WebSocket module: Adds HTML5 WebSocket support.
2406 # Specify hook="websocket" in a <bind> tag to make that port accept
2407 # WebSocket connections. Compatible with TLS (SSL).
2408 # Requires SHA-1 hash support available in the sha1 module.
2409 #<module name="websocket">
2411 # proxyranges: A space-delimited list of glob or CIDR matches to trust
2412 # the X-Real-IP or X-Forwarded-For headers from. If enabled
2413 # the server will use the IP address specified by those HTTP
2414 # headers. You should NOT enable this unless you are using
2415 # a HTTP proxy like nginx as it will allow IP spoofing.
2416 # sendastext: Whether to re-encode messages as UTF-8 before sending to
2417 # WebSocket clients. This is recommended as the WebSocket
2418 # protocol requires all text frames to be sent as UTF-8.
2419 # If you do not have this enabled messages will be sent as
2420 # binary frames instead.
2421 #<websocket proxyranges="192.0.2.0/24 198.51.100.*"
2424 # If you use the websocket module you MUST specify one or more origins
2425 # which are allowed to connect to the server. You should set this as
2426 # strict as possible to prevent malicious webpages from connecting to
2428 # <wsorigin allow="https://*.example.com">
2430 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2431 # X-line database: Stores all *-lines (G/Z/K/R/any added by other modules)
2432 # in a file which is re-loaded on restart. This is useful
2433 # for two reasons: it keeps bans so users may not evade them, and on
2434 # bigger networks, server connections will take less time as there will
2435 # be a lot less bans to apply - as most of them will already be there.
2436 #<module name="xline_db">
2438 # Specify the filename for the xline database and how often to check whether
2439 # the database needs to be saved here.
2440 #<xlinedb filename="xline.db" saveperiod="5s">
2442 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2443 # ____ _ _____ _ _ ____ _ _ _ #
2444 # | _ \ ___ __ _ __| | |_ _| |__ (_)___ | __ )(_) |_| | #
2445 # | |_) / _ \/ _` |/ _` | | | | '_ \| / __| | _ \| | __| | #
2446 # | _ < __/ (_| | (_| | | | | | | | \__ \ | |_) | | |_|_| #
2447 # |_| \_\___|\__,_|\__,_| |_| |_| |_|_|___/ |____/|_|\__(_) #
2449 # To link servers to InspIRCd, you MUST load the spanningtree module. #
2450 # If you don't do this, server links will NOT work at all. #
2451 # This is by design, to allow for the implementation of other linking #
2452 # protocols in modules in the future. #
2454 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2455 # Spanning tree module: Allows linking of servers using the spanning
2456 # tree protocol (see the READ THIS BIT section above).
2457 # You will almost always want to load this.
2459 #<module name="spanningtree">
projects / user / henk / code / inspircd.git / blob