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">
342 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
343 # Censor module: Adds channel and user mode +G which block phrases that
344 # are listed in the server bad words list.
345 #<module name="censor">
347 #-#-#-#-#-#-#-#-#-#-#- CENSOR CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#
349 # If you have the censor module loaded you should specify one or more #
350 # phrases to replace/block in user messages. The config for this is #
351 # formatted as follows: #
353 # Replaces "eggplant" with "aubergine" within messages: #
354 # <badword text="eggplant" replace="aubergine"> #
356 # Blocks messages that contain "fluffy capybaras": #
357 #<badword text="fluffy capybaras"> #
359 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
360 # CGI:IRC module: Enables forwarding the real IP address of a user from
361 # a gateway to the IRC server.
362 #<module name="cgiirc">
364 #-#-#-#-#-#-#-#-#-#-#-# CGIIRC CONFIGURATION #-#-#-#-#-#-#-#-#-#-#-#-#
366 # If you use the cgiirc module then you must specify the gateways which
367 # are authorised to forward IP/host information to your server. There
368 # are currently two ways to do this:
370 # The webirc method is the recommended way to allow gateways to forward
371 # IP/host information. When using this method the gateway sends a WEBIRC
372 # message to the server on connection. For more details please read the
373 # IRCv3 WebIRC specification at: https://ircv3.net/specs/extensions/webirc.html
375 # When using this method you must specify a wildcard mask or CIDR range
376 # to allow gateway connections from and at least one of either a TLS (SSL)
377 # client certificate fingerprint for the gateway or a password to be
378 # sent in the WEBIRC command.
380 # <cgihost type="webirc"
381 # fingerprint="bd90547b59c1942b85f382bc059318f4c6ca54c5"
382 # mask="192.0.2.0/24">
383 # <cgihost type="webirc"
384 # password="$2a$10$WEUpX9GweJiEF1WxBDSkeODBstIBMlVPweQTG9cKM8/Vd58BeM5cW"
386 # mask="*.webirc.gateway.example.com">
388 # Alternatively if your gateway does not support sending the WEBIRC
389 # message then you can configure InspIRCd to look for the client IP
390 # address in the ident sent by the user. This is not recommended as it
391 # only works with IPv4 connections.
393 # When using this method you must specify a wildcard mask or CIDR range to allow
394 # gateway connections from. You can also optionally configure the static value
395 # that replaces the IP in the ident to avoid leaking the real IP address of
396 # gateway clients (defaults to "gateway" if not set).
398 # <cgihost type="ident"
399 # mask="198.51.100.0/24"
401 # <cgihost type="ident"
402 # mask="*.ident.gateway.example.com"
405 # By default gateway connections are logged to the +w snomask. If you
406 # do not want this to happen then you can uncomment this to disable it.
407 # <cgiirc opernotice="no">
412 # When you connect gateway clients, there are two connect classes which
413 # apply to these clients. When the client initially connects, the connect
414 # class which matches the gateway site's host is checked. Therefore you
415 # must raise the maximum local/global clients for this IP as high as you
416 # want to allow gateway clients. After the client has connected and is
417 # determined to be a gateway client, the class which matches the client's
418 # real IP is then checked. You may set this class to a lower value, so that
419 # the real IP of the client can still be restricted to, for example, 3
422 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
423 # Channel create module: Adds snomask +j, which will notify opers of
424 # any new channels that are created.
425 # This module is oper-only.
426 #<module name="chancreate">
428 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
429 # Channel filter module: Allows channel-op defined message filtering
430 # using simple string matches (channel mode +g).
431 #<module name="chanfilter">
433 # If hidemask is set to yes, the user will not be shown the mask when
434 # their message is blocked.
436 # If maxlen is set then it defines the maximum length of a filter entry.
438 # If notifyuser is set to no, the user will not be notified when
439 # their message is blocked.
440 #<chanfilter hidemask="yes" maxlen="50" notifyuser="yes">
442 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
443 # Channel history module: Displays the last 'X' lines of chat to a user
444 # joining a channel with +H 'X:T' set; 'T' is the maximum time to keep
445 # lines in the history buffer. Designed so that the new user knows what
446 # the current topic of conversation is when joining the channel.
447 #<module name="chanhistory">
449 # Set the maximum number of lines allowed to be stored per channel below.
450 # This is the hard limit for 'X'.
451 # If prefixmsg is set to yes, joining users without batch support will get
452 # a NOTICE before playback telling them about the following lines being
453 # the pre-join history.
454 # If bots is set to yes, it will also send to users marked with +B
455 #<chanhistory maxlines="50" prefixmsg="yes" bots="yes">
457 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
458 # Channel logging module: Used to send snotice output to channels, to
459 # allow staff to centrally monitor and discuss network activity.
461 # The "channel" field is where you want the messages to go, "snomasks"
462 # is what snomasks you want to be sent to that channel. Multiple tags
464 #<module name="chanlog">
465 #<chanlog snomasks="AOcC" channel="#opers">
467 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
468 # Channel names module: Allows disabling channels which have certain
469 # characters in the channel name such as bold, colorcodes, etc. which
470 # can be quite annoying and allow users to on occasion have a channel
471 # that looks like the name of another channel on the network.
472 #<module name="channames">
475 # denyrange: characters or range of characters to deny in channel
479 # allowrange: characters or range of characters to specifically allow
483 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
484 # Channelban: Implements extended ban j:, which stops anyone already
485 # in a channel matching a ban like +b j:#channel from joining.
486 # It is also possible to ban based on their status in that channel,
487 # like so: +b j:@#channel, this example prevents the ops from joining.
488 # Note that by default wildcard characters * and ? are allowed in
489 # channel names. To disallow them, load the channames module and
490 # add characters 42 and 63 to denyrange (see above).
491 #<module name="channelban">
493 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
494 # Check module: Adds the /CHECK command.
495 # Check is useful for looking up information on channels, users,
496 # IP addresses and hosts.
497 # This module is oper-only.
498 # To use, CHECK must be in one of your oper class blocks.
499 #<module name="check">
501 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
502 # CHGHOST module: Adds the /CHGHOST command.
503 # This module is oper-only.
504 # To use, CHGHOST must be in one of your oper class blocks.
505 # NOTE: Services will not be able to set vhosts on users if this module
506 # isn't loaded. If you're planning on running services, you probably
508 #<module name="chghost">
510 #-#-#-#-#-#-#-#-# /CHGHOST - /SETHOST CONFIGURATION #-#-#-#-#-#-#-#-#
511 # Optional - If you want to use special chars for hostnames you can #
512 # specify your own custom list of chars with the <hostname> tag: #
514 # charmap - A list of chars accepted as valid by the /CHGHOST #
515 # and /SETHOST commands. Also note that the list is #
517 #<hostname charmap="abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ.-_/0123456789">
519 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
520 # CHGIDENT module: Adds the /CHGIDENT command.
521 # This module is oper-only.
522 # To use, CHGIDENT must be in one of your oper class blocks.
523 #<module name="chgident">
525 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
526 # CHGNAME module: Adds the /CHGNAME command.
527 # This module is oper-only.
528 # To use, CHGNAME must be in one of your oper class blocks.
529 #<module name="chgname">
531 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
532 # Connection class ban module: Adds support for extban 'n' which
533 # matches against the class name of the user's connection.
534 # This module assumes that connection classes are named in a uniform
535 # way on all servers of the network. Wildcards are accepted.
536 #<module name="classban">
538 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
539 # Clear chan module: Allows opers to masskick, masskill or
540 # mass G/Z-line all users on a channel using /CLEARCHAN.
541 #<module name="clearchan">
543 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
544 # Cloaking module: Adds user mode +x and cloaking support.
545 # Relies on the md5 module being loaded.
546 # To cloak users when they connect, load the conn_umodes module and set
547 # <connect:modes> to include the +x mode. The example <connect> tag
548 # shows this. See the conn_umodes module for more information.
549 #<module name="cloaking">
551 #-#-#-#-#-#-#-#-#-#-#- CLOAKING CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#
553 # To use cloaking, you must define a cloak key, and optionally a #
554 # cloak prefix as shown below. The cloak key must be shared across #
555 # the network for consistent cloaking and must be at least thirty #
558 # There are two methods of cloaking: #
560 # half Cloak only the "unique" portion of a host; by #
561 # default show the last 2 parts of the domain, #
562 # /16 subnet of IPv4 or /48 subnet of the IPv6 #
564 # To change the number of shown parts, modify the #
565 # domainparts option. #
567 # full Cloak the users completely, using three slices for #
568 # common CIDR bans (IPv4: /16, /24; IPv6: /48, /64). #
570 # The methods use a single key that can be any length of text. #
571 # An optional prefix may be specified to mark cloaked hosts. #
573 # IMPORTANT: Changing these details will break all of your existing #
574 # bans. If you do not want this to happen you can define multiple #
575 # cloak tags. The first will be used for cloaking and the rest will #
576 # be used for checking if a user is banned in a channel. #
577 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
590 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
591 # Clones module: Adds an oper command /CLONES for detecting cloned
592 # users. Warning: This command may be resource intensive when it is
593 # issued, use with care.
594 # This module is oper-only.
595 # To use, CLONES must be in one of your oper class blocks.
596 #<module name="clones">
598 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
599 # Codepage module: Allows using a custom 8-bit codepage for nicknames
602 # You should include one of the following files to set your codepage:
603 #<include file="examples/codepages/ascii.conf.example">
604 #<include file="examples/codepages/latin1.conf.example">
605 #<include file="examples/codepages/rfc1459.conf.example">
606 #<include file="examples/codepages/strict-rfc1459.conf.example">
608 # You can also define a custom codepage. For details on how to do this
609 # please refer to the docs site:
610 # https://docs.inspircd.org/3/modules/codepage
612 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
613 # Common channels module: Adds user mode +c, which, when set, requires
614 # that users must share a common channel with you to PRIVMSG or NOTICE
616 #<module name="commonchans">
618 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
619 # Auto join on connect module: Allows you to force users to join one
620 # or more channels automatically upon connecting to the server, or
621 # join them in case they aren't on any channels after being online
623 #<module name="conn_join">
625 #-#-#-#-#-#-#-#-#-#-#-#- CONNJOIN CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
627 # If you have the conn_join module loaded, you can configure it below
628 # or set autojoin="#chat,#help" in <connect> blocks.
630 # Join users immediately after connection to #one #two and #three.
631 #<autojoin channel="#one,#two,#three">
632 # Join users to #chat after 15 seconds if they aren't on any channels.
633 #<autojoin channel="#chat" delay="15">
635 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
636 # Set modes on connect module: When this module is loaded <connect>
637 # blocks may have an optional modes="" value, which contains modes to
638 # add or remove from users when they connect to the server.
639 #<module name="conn_umodes">
641 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
642 # Wait for PONG on connect module: Send a PING to all connecting users
643 # and don't let them connect until they reply with a PONG.
644 # This is useful to stop certain kinds of bots and proxies.
645 #<module name="conn_waitpong">
647 #-#-#-#-#-#-#-#-#-#-#- WAITPONG CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
649 # If you have the conn_waitpong module loaded, configure it with the #
652 # sendsnotice - Whether to send a helpful notice to users on #
653 # connect telling them how to connect, should #
654 # their client not reply PONG automatically. #
656 # killonbadreply - Whether to kill the user if they send the wrong #
659 #<waitpong sendsnotice="no" killonbadreply="yes">
661 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
662 # Channel cycle module: Adds the /CYCLE command which is a server-side
663 # /HOP that bypasses restrictive modes.
664 #<module name="cycle">
666 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
667 # Connectban: Provides IP connection throttling. Any IP range that
668 # connects too many times (configurable) in an hour is Z-lined for a
669 # (configurable) duration, and their count resets to 0.
670 #<module name="connectban">
672 # ipv4cidr and ipv6cidr allow you to turn the comparison from
673 # individual IP addresses (32 and 128 bits) into CIDR masks, to allow
674 # for throttling over whole ISPs/blocks of IPs, which may be needed to
677 # This allows for 10 connections in an hour with a 10 minute ban if
679 #<connectban threshold="10" duration="10m" ipv4cidr="32" ipv6cidr="128"
680 # A custom ban message may optionally be specified.
681 # 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.">
683 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
684 # Connection throttle module.
685 #<module name="connflood">
687 #-#-#-#-#-#-#-#-#-#-#- CONNTHROTTLE CONFIGURATION -#-#-#-#-#-#-#-#-#-#
688 # period, maxconns - Amount of connections per <period>.
690 # timeout - Time to wait after the throttle was activated
691 # before deactivating it. Be aware that the time
692 # is seconds + timeout.
694 # quitmsg - The message that users get if they attempt to
695 # connect while the throttle is active.
697 # bootwait - Amount of time in seconds to wait before enforcing
698 # the throttling when the server just booted.
700 #<connflood period="30" maxconns="3" timeout="30"
701 # quitmsg="Throttled" bootwait="2m">
703 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
704 # Custom prefixes: Allows for channel prefixes to be configured.
705 #<module name="customprefix">
707 # name The name of the mode, must be unique from other modes.
708 # letter The letter used for this mode. Required.
709 # prefix The prefix used for nicks with this mode. Not required.
710 # rank A numeric rank for this prefix, defining what permissions it gives.
711 # The rank of voice, halfop and op is 10000, 20000, and 30000,
713 # ranktoset The numeric rank required to set this mode. Defaults to rank.
714 # ranktounset The numeric rank required to unset this mode. Defaults to ranktoset.
715 # depriv Can you remove the mode from yourself? Defaults to yes.
716 #<customprefix name="founder" letter="q" prefix="~" rank="50000" ranktoset="50000">
717 #<customprefix name="admin" letter="a" prefix="&" rank="40000" ranktoset="50000">
718 #<customprefix name="halfop" letter="h" prefix="%" rank="20000" ranktoset="30000">
720 # You can also override the configuration of prefix modes added by both the core
721 # and other modules by adding a customprefix tag with change="yes" specified.
722 # <customprefix name="op" change="yes" rank="30000" ranktoset="30000">
723 # <customprefix name="voice" change="yes" rank="10000" ranktoset="20000" depriv="no">
725 # Do /RELOADMODULE customprefix after changing the settings of this module.
727 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
728 # Custom title module: Adds the /TITLE command which allows for trusted
729 # users to gain a custom whois line and an optional vhost can be
731 #<module name="customtitle">
733 #-#-#-#-#-#-#-#-#-#- CUSTOM TITLE CONFIGURATION -#-#-#-#-#-#-#-#-#-#
734 # name - The username used to identify.
735 # password - The password used to identify.
736 # hash - The hash for the specific user's password (optional).
737 # password_hash and a hashing module must be loaded
739 # host - Allowed hostmask (optional).
740 # title - Title shown in whois.
741 # vhost - Displayed host (optional).
743 #<title name="foo" password="bar" title="Official Chat Helper">
744 #<title name="bar" password="foo" host="ident@test.org" title="Official Chat Helper" vhost="helper.test.org">
745 #<title name="foo" password="$2a$10$UYZ4OcO8NNTCCGyCdY9SK.2GHiqGgxZfHFPOPmWuxEVWVQTtoDC7C" hash="bcrypt" title="Official Chat Helper">
747 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
748 # DCCALLOW module: Adds the /DCCALLOW command.
749 #<module name="dccallow">
751 #-#-#-#-#-#-#-#-#-#-#- DCCALLOW CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
752 # blockchat - Whether to block DCC CHAT as well as DCC SEND.
753 # length - Default duration of entries in DCCALLOW list.
754 # action - Default action to take if no action is
755 # specified, can be 'block' or 'allow'.
756 # maxentries - Max number of nicks to allow on a DCCALLOW list.
758 # File configuration:
759 # pattern - The glob pattern to match against.
760 # action - Action to take if a user attempts to send a file
761 # that matches this pattern, can be 'block' or
764 #<dccallow blockchat="yes" length="5m" action="block" maxentries="20">
765 #<banfile pattern="*.exe" action="block">
766 #<banfile pattern="*.txt" action="allow">
768 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
769 # Deaf module: Adds support for user modes +d and +D:
770 # d - deaf to channel messages and notices.
771 # D - deaf to user messages and notices.
772 # The +D user mode is not enabled by default to enable link compatibility
774 #<module name="deaf">
776 #-#-#-#-#-#-#-#-#-#-#-#- DEAF CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#
777 # bypasschars - Characters that bypass deaf to a regular user.
778 # bypasscharsuline - Characters that bypass deaf to a U-lined user (services).
779 # Both of these take a list of characters that must match
780 # the starting character of a message.
781 # If 'bypasscharsuline' is empty, then 'bypasschars' will
782 # match for both regular and U-lined users.
783 # enableprivdeaf - Whether to enable user mode +D (privdeaf).
784 # privdeafuline - Whether U-lined users bypass user mode +D (privdeaf).
786 #<deaf bypasschars="" bypasscharsuline="!" enableprivdeaf="no" privdeafuline="yes">
788 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
789 # Delay join module: Adds the channel mode +D which delays all JOIN
790 # messages from users until they speak. If they quit or part before
791 # speaking, their quit or part message will not be shown to the channel
792 # which helps cut down noise on large channels in a more friendly way
793 # than the auditorium mode. Only channel ops may set the +D mode.
794 #<module name="delayjoin">
796 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
797 # Delay message module: Adds the channel mode +d which disallows a user
798 # from talking in the channel unless they've been joined for X seconds.
799 # Settable using /MODE #chan +d 30
800 #<module name="delaymsg">
801 # Set allownotice to no to disallow NOTICEs too. Defaults to yes.
802 #<delaymsg allownotice="no">
804 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
805 # Deny channels module: Deny channels from being used by users.
806 #<module name="denychans">
808 #-#-#-#-#-#-#-#-#-#-#- DENYCHAN DEFINITIONS -#-#-#-#-#-#-#-#-#-#-#-#
810 # If you have the denychans module loaded, you need to specify the #
811 # channels to deny: #
813 # name - The channel name to deny (glob masks are ok). #
814 # allowopers - If operators are allowed to override the deny. #
815 # reason - Reason given for the deny. #
816 # redirect - Redirect the user to a different channel. #
818 #<badchan name="#gods*" allowopers="yes" reason="Tortoises!"> #
819 #<badchan name="#chan1" redirect="#chan2" reason="Chan1 is closed"> #
821 # Redirects will not work if the target channel is set +L. #
823 # Additionally, you may specify channels which are allowed, even if #
824 # a badchan tag specifies it would be denied: #
825 #<goodchan name="#funtimes"> #
826 # Glob masks are accepted here also. #
828 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
829 # Disable module: Provides support for disabling commands and modes. #
830 #<module name="disable">
832 #-#-#-#-#-#-#-#-#-#-#-#- DISABLE CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#
834 # If you have the disable module loaded then you need to specify the #
835 # commands and modes that you want disabled. Users who have not fully #
836 # connected yet are exempt from this module so you can e.g. disable #
837 # the NICK command but still allow users to connect to the server. #
839 # commands - A space-delimited list of commands that can not be used #
840 # by users. You can exempt server operators from this with #
841 # the servers/use-disabled-commands privilege. #
843 # chanmodes - One or more channel modes that can not be added/removed #
844 # by users. You can exempt server operators from this #
845 # with the servers/use-disabled-modes privilege. #
847 # usermodes - One or more user modes that can not be added/removed by #
848 # users. You can exempt server operators from this with #
849 # the servers/use-disabled-modes privilege. #
851 # fakenonexistent - Whether to pretend that a disabled command/mode #
852 # does not exist when executed/changed by a user. #
855 # notifyopers - Whether to send a notice to snomask `a` when a user #
856 # is prevented from using a disabled command/mode. #
859 #<disabled commands="KICK TOPIC" #
862 # fakenonexistent="yes" #
863 # notifyopers="no"> #
865 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
866 # DNS blacklist module: Provides support for looking up IPs on one or #
868 #<module name="dnsbl">
870 # For configuration options please see the docs page for dnsbl at #
871 # https://docs.inspircd.org/3/modules/dnsbl #
873 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
874 # Exempt channel operators module: Provides support for allowing #
875 # users of a specified channel status to be exempt from some channel #
876 # restriction modes. Supported restrictions are: #
877 # anticaps, auditorium-see, auditorium-vis, blockcaps, blockcolor, #
878 # censor, filter, flood, nickflood, noctcp, nonick, nonotice, #
879 # regmoderated, stripcolor, and topiclock. #
880 # See <options:exemptchanops> in inspircd.conf.example for a more #
881 # detailed list of the restriction modes that can be exempted. #
882 # These are settable using: /MODE #chan +X <restriction>:<status> #
883 #<module name="exemptchanops">
885 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
886 # Filter module: Provides message filtering, similar to SPAMFILTER. #
887 #<module name="filter">
889 # This module depends upon a regex provider such as regex_pcre or #
890 # regex_glob to function. You must specify which of these you want #
891 # the filter module to use via the tag below. #
893 # Valid engines are: #
895 # glob - Glob patterns, provided via regex_glob. #
896 # pcre - PCRE regexps, provided via regex_pcre, needs libpcre. #
897 # tre - TRE regexps, provided via regex_tre, requires libtre. #
898 # posix - POSIX regexps, provided via regex_posix, not available #
899 # on Windows, no dependencies on other operating systems. #
900 # stdlib - stdlib regexps, provided via regex_stdlib, see comment #
901 # at the <module> tag for info on availability. #
903 # If notifyuser is set to no, the user will not be notified when #
904 # their message is blocked. #
906 # If warnonselfmsg is set to yes when a user sends a message to #
907 # themself that matches a filter the filter will be ignored and a #
908 # warning will be sent to opers instead. This stops spambots which #
909 # send their spam message to themselves first to check if it is being #
910 # filtered by the server. #
911 #<filteropts engine="glob" notifyuser="yes" warnonselfmsg="no">
913 # Your choice of regex engine must match on all servers network-wide. #
915 # To learn more about the configuration of this module, read #
916 # examples/filter.conf.example, which covers the various types of #
917 # filters and shows how to add exemptions. #
919 #-#-#-#-#-#-#-#-#-#-#- FILTER CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#
921 # Optional - If you specify to use the filter module, then #
922 # specify below the path to the filter.conf file, or define some #
925 #<include file="examples/filter.conf.example">
927 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
928 # Flash Policy Daemon module: Allows Flash IRC clients (e.g. LightIRC)#
929 # to connect. If no file is specified, it'll serve a default policy #
930 # allowing all IPs to connect to all plaintext IRC ports #
931 #<bind address="" port="8430" type="flashpolicyd"> #
932 #<flashpolicyd timeout="5" file=""> #
933 #<module name="flashpolicyd"> #
935 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
936 # Real name ban: Implements two extended bans: #
937 # 'a', which matches a n!u@h+realname mask like +b a:*!*@host+*real* #
938 # 'r', which matches a realname mask like +b r:*realname?here* #
939 #<module name="gecosban">
941 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
942 # Geolocation ban module: Adds support for extban 'G' which matches #
943 # against the ISO 3166-1 alpha-2 codes for the countries that users #
944 # are connecting from. Users connecting from unknown origins such as #
945 # internal networks can be matched against using the XX alpha-2 code. #
946 # A full list of ISO 3166-1 alpha-2 codes can be found at #
947 # https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2 #
948 #<module name="geoban">
950 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
951 # Geolocation connect class module: Adds support for limiting connect #
952 # classes to users from specific countries. With this module you can #
953 # specify a space-delimited list of two character the ISO 3166-1 #
954 # alpha-2 codes in the "country" field of a connect class. e.g. to #
955 # deny connections from users in Russia or Turkey: #
957 # <connect deny="*" country="TR RU"> #
959 # Users connecting from unknown origins such as internal networks can #
960 # be matched against using the XX alpha-2 code. A full list of ISO #
961 # 3166-1 alpha-2 codes can be found at #
962 # https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2 #
963 #<module name="geoclass">
965 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
966 # MaxMindDB geolocation module: Provides geolocation information for #
967 # other modules that need it using the libMaxMindDB library. #
969 # This module is in extras. Re-run configure with: #
970 # ./configure --enable-extras geo_maxmind
971 # and run make install, then uncomment this module to enable it. #
973 # This module requires libMaxMindDB to be installed on your system. #
974 # Use your package manager to find the appropriate packages or check #
975 # the InspIRCd documentation page for this module. #
976 #<module name="geo_maxmind">
978 # If you use the geo_maxmind module you MUST provide a database file #
979 # to look up geolocation information in. You can either purchase this #
980 # from MaxMind at https://www.maxmind.com/en/geoip2-country-database #
981 # or use the free CC-BY-SA licensed GeoLite2 Country database which #
982 # can be downloaded at https://dev.maxmind.com/geoip/geoip2/geolite2/ #
983 #<maxmind file="GeoLite2-Country.mmdb">
985 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
986 # Globops module: Provides the /GLOBOPS command and snomask +g.
987 # This module is oper-only.
988 # To use, GLOBOPS must be in one of your oper class blocks.
989 #<module name="globops">
991 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
992 # Global load module: Allows loading and unloading of modules network-
993 # wide (USE WITH EXTREME CAUTION!)
994 # This module is oper-only and provides /GLOADMODULE, /GUNLOADMODULE
995 # and /GRELOADMODULE.
996 # To use, GLOADMODULE, GUNLOADMODULE and GRELOADMODULE
997 # must be in one of your oper class blocks.
998 #<module name="globalload">
1000 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1001 # HAProxy module: Adds support for the HAProxy PROXY v2 protocol. To
1002 # use this module specify hook="haproxy" in the <bind> tag that HAProxy
1003 # has been configured to connect to.
1004 #<module name="haproxy">
1006 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1007 # HELPOP module: Provides the /HELPOP command
1008 #<module name="helpop">
1010 #-#-#-#-#-#-#-#-#-#-#-#- HELPOP CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
1012 # If you specify to use the helpop module, then specify below the #
1013 # path to the helpop.conf file. #
1015 #<include file="examples/helpop.conf.example">
1017 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1018 # Hide chans module: Allows users to hide their channels list from non-
1019 # opers by setting user mode +I on themselves.
1020 #<module name="hidechans">
1022 # This mode can optionally prevent opers from seeing channels on a +I
1023 # user, for more privacy if set to true.
1024 # This setting is not recommended for most mainstream networks.
1025 #<hidechans affectsopers="false">
1027 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1028 # Hide list module: Allows for hiding the list of listmodes from users
1029 # who do not have sufficient channel rank.
1030 #<module name="hidelist">
1032 # Each <hidelist> tag configures one listmode to hide.
1033 # mode: Name of the listmode to hide.
1034 # rank: Minimum rank required to view the list. If set to 0, all
1035 # members of the channel may view the list, but non-members may not.
1036 # The rank of the built-in op and voice mode is 30000 and 10000,
1037 # respectively; the rank of other prefix modes is configurable.
1038 # Defaults to 20000.
1040 # Hiding the ban list is not recommended because it may break some
1043 # Hide filter (+g) list:
1044 #<hidelist mode="filter" rank="30000">
1045 # Only show invite exceptions (+I) to channel members:
1046 #<hidelist mode="invex" rank="0">
1048 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1049 # Hide mode module: Allows for hiding mode changes from users who do not
1050 # have sufficient channel privileges.
1051 #<module name="hidemode">
1053 # Hide bans (+b) from people who are not voiced:
1054 #<hidemode mode="ban" rank="10000">
1056 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1057 # Hide oper module: Allows opers to hide their oper status from non-
1058 # opers by setting user mode +H on themselves.
1059 # This module is oper-only.
1060 #<module name="hideoper">
1062 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1063 # Hostchange module: Allows a different style of cloaking.
1064 #<module name="hostchange">
1066 #-#-#-#-#-#-#-#-#-#-#- HOSTCHANGE CONFIGURATION -#-#-#-#-#-#-#-#-#-#
1068 # See https://docs.inspircd.org/3/modules/hostchange for help. #
1070 #<hostchange mask="*@42.theanswer.example.org" action="addaccount" suffix=".users.example.com">
1071 #<hostchange mask="*root@*" action="addnick" prefix="example/users/">
1072 #<hostchange mask="a@example.com" action="set" value="foo.bar.baz">
1073 #<hostchange mask="*@localhost" ports="7000,7001,7005-7007" action="set" value="blahblah.foo">
1075 # hostcycle: If loaded, when a user gets a host or ident set, it will
1076 # cycle them in all their channels. If not loaded it will simply change
1077 # their host/ident without cycling them.
1078 # This module is compatible with the ircv3_chghost module. Clients
1079 # supporting the chghost extension will get the chghost message instead
1080 # of seeing a host cycle.
1081 #<module name="hostcycle">
1083 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1084 # httpd module: Provides HTTP server support for InspIRCd.
1085 #<module name="httpd">
1087 #-#-#-#-#-#-#-#-#-#-#-#- HTTPD CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
1089 # If you choose to use the httpd module, then you will need to add
1090 # a <bind> tag with type "httpd", and load at least one of the other
1091 # httpd_* modules to provide pages to display.
1092 # <bind address="127.0.0.1" port="8067" type="httpd">
1093 # <bind address="127.0.0.1" port="8097" type="httpd" ssl="gnutls">
1095 # You can adjust the timeout for HTTP connections below. All HTTP
1096 # connections will be closed after (roughly) this time period.
1097 #<httpd timeout="20">
1099 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1100 # HTTP ACL module: Provides access control lists for httpd dependent
1101 # modules. Use this module to restrict pages by IP address and by
1103 #<module name="httpd_acl">
1105 #-#-#-#-#-#-#-#-#-#-#-#- HTTPD ACL CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
1107 # Restrict access to the httpd_stats module to all but the local
1108 # network and when the correct password is specified:
1109 # <httpdacl path="/stats*" types="password,whitelist"
1110 # username="secrets" password="mypasshere" whitelist="127.0.0.*,10.*">
1112 # Deny all connections to all but the main index page:
1113 # <httpdacl path="/*" types="blacklist" blacklist="*">
1115 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1116 # HTTP config module: Allows the server configuration to be viewed over
1117 # HTTP via the /config path. Requires the httpd module to be loaded for
1120 # IMPORTANT: This module exposes extremely sensitive information about
1121 # your server and users so you *MUST* protect it using a local-only
1122 # <bind> tag and/or the httpd_acl module. See above for details.
1123 #<module name="httpd_config">
1125 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1126 # HTTP stats module: Provides server statistics over HTTP via the /stats
1127 # path. Requires the httpd module to be loaded for it to function.
1129 # IMPORTANT: This module exposes extremely sensitive information about
1130 # your server and users so you *MUST* protect it using a local-only
1131 # <bind> tag and/or the httpd_acl module. See above for details.
1132 #<module name="httpd_stats">
1134 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1135 # Ident: Provides RFC 1413 ident lookup support.
1136 # When this module is loaded <connect:allow> tags may have an optional
1137 # useident="yes|no" boolean value, determining whether or not to lookup
1138 # ident on users matching that connect tag.
1139 #<module name="ident">
1141 #-#-#-#-#-#-#-#-#-#-#-#- IDENT CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
1143 # Optional - If you are using the ident module, then you can specify #
1144 # the timeout for ident lookups here. If not defined, it will default #
1145 # to 5 seconds. This is a non-blocking timeout which holds the user #
1146 # in a 'connecting' state until the lookup is complete. #
1147 # prefixunqueried: If on, the idents of users being in a connect class#
1148 # with ident lookups disabled (i.e. <connect useident="off">) will be #
1149 # prefixed with a "~". If off, the ident of those users will not be #
1150 # prefixed. Default is off. #
1152 #<ident timeout="5" prefixunqueried="no">
1154 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1155 # Invite exception module: Adds support for channel invite exceptions
1157 #<module name="inviteexception">
1158 # bypasskey: If this is enabled, exceptions will bypass +k as well as +i
1159 #<inviteexception bypasskey="yes">
1161 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1162 # IRCv3 module: Provides the following IRCv3 extensions:
1163 # extended-join, away-notify and account-notify. These are optional
1164 # enhancements to the client-to-server protocol. An extension is only
1165 # active for a client when the client specifically requests it, so this
1166 # module needs the cap module to work.
1168 # Further information on these extensions can be found at the IRCv3
1169 # working group website:
1170 # https://ircv3.net/irc/
1172 #<module name="ircv3">
1173 # The following block can be used to control which extensions are
1174 # enabled. Note that extended-join can be incompatible with delayjoin
1176 #<ircv3 accountnotify="on" awaynotify="on" extendedjoin="on">
1178 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1179 # IRCv3 account-tag module. Adds the 'account' tag which contains the
1180 # services account name of the message sender.
1181 #<module name="ircv3_accounttag">
1183 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1184 # IRCv3 batch module: Provides the batch IRCv3 extension which allows
1185 # the server to inform a client that a group of messages are related to
1187 #<module name="ircv3_batch">
1189 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1190 # IRCv3 cap-notify module: Provides the cap-notify IRCv3 extension.
1191 # Required for IRCv3 conformance.
1192 #<module name="ircv3_capnotify">
1194 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1195 # IRCv3 chghost module: Provides the chghost IRCv3 extension which
1196 # allows capable clients to learn when the host/ident of another user
1197 # changes without cycling the user. This module is compatible with the
1198 # hostcycle module. If both are loaded, clients supporting the chghost
1199 # extension will get the chghost message and won't see host cycling.
1200 #<module name="ircv3_chghost">
1202 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1203 # IRCv3 client-to-client tags module: Provides the message-tags IRCv3
1204 # extension which allows clients to add extra data to their messages.
1205 # This is used to support new IRCv3 features such as replies and ids.
1206 #<module name="ircv3_ctctags">
1208 # If you want to only allow client tags that are intended for processing
1209 # by the server you can disable the following setting. Doing this is not
1210 # recommended though as it may break clients.
1211 #<ctctags allowclientonlytags="yes">
1213 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1214 # IRCv3 echo-message module: Provides the echo-message IRCv3
1215 # extension which allows capable clients to get an acknowledgement when
1216 # their messages are delivered and learn what modifications, if any,
1217 # were applied to them.
1218 #<module name="ircv3_echomessage">
1220 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1221 # IRCv3 invite-notify module: Provides the invite-notify IRCv3
1222 # extension which notifies supporting clients when a user invites
1223 # another user into a channel. This respects <options:announceinvites>.
1224 #<module name="ircv3_invitenotify">
1226 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1227 # IRCv3 labeled-response module: Provides the labeled-response IRCv3
1228 # extension which allows server responses to be associated with the
1229 # client message which caused them to be sent.
1230 #<module name="ircv3_labeledresponse">
1232 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1233 # IRCv3 message id module: Provides the msgid IRCv3 extension which
1234 # adds a unique identifier to each message when the message-tags cap
1235 # has been requested. This enables support for modern features such as
1236 # reactions and replies.
1237 #<module name="ircv3_msgid">
1239 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1240 # IRCv3 server-time module. Adds the 'time' tag which adds a timestamp
1241 # to all messages received from the server.
1242 #<module name="ircv3_servertime">
1244 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1245 # IRCv3 Strict Transport Security module: Provides the sts IRCv3
1246 # extension which allows clients connecting insecurely to upgrade their
1247 # connections to TLS.
1248 #<module name="ircv3_sts">
1250 # If using the ircv3_sts module you MUST define a STS policy to send
1251 # to clients using the <sts> tag. This tag takes the following
1254 # host - A glob match for the SNI hostname to apply this policy to.
1255 # duration - The amount of time that the policy lasts for. Defaults to
1256 # five minutes by default. You should raise this to a month
1257 # or two once you know that your config is valid.
1258 # port - The port on which TLS connections to the server are being
1259 # accepted. You MUST have a CA-verified certificate on this
1260 # port. Self signed certificates are not acceptable.
1261 # preload - Whether client developers can include your certificate in
1264 # <sts host="*.example.com" duration="5m" port="6697" preload="yes">
1266 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1267 # Join flood module: Adds support for join flood protection +j X:Y.
1268 # Closes the channel for N seconds if X users join in Y seconds.
1269 #<module name="joinflood">
1271 # duration: The number of seconds to close a channel for when it is
1272 # being flooded with joins.
1274 # bootwait: The number of seconds to disengage joinflood for after
1275 # a server boots. This allows users to reconnect without
1276 # being throttled by joinflood.
1278 # splitwait: The number of seconds to disengage joinflood for after
1279 # a server splits. This allows users to reconnect without
1280 # being throttled by joinflood.
1282 #<joinflood duration="1m"
1286 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1287 # Anti auto rejoin: Adds support for prevention of auto-rejoin (+J).
1288 #<module name="kicknorejoin">
1290 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1291 # Knock module: Adds the /KNOCK command and channel mode +K.
1292 #<module name="knock">
1294 # This setting specifies what to do when someone successfully /KNOCKs.
1295 # If set to "notice", then a NOTICE will be sent to the channel.
1296 # This is the default and the compatible setting, as it requires no
1297 # special support from the clients.
1298 # If set to "numeric" then a 710 numeric will be sent to the channel.
1299 # This allows easier scripting but not all clients support it.
1300 # If set to "both" then (surprise!) both will be sent.
1301 #<knock notify="notice">
1303 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1304 # LDAP module: Allows other SQL modules to access a LDAP database
1305 # through a unified API.
1306 # This modules is in extras. Re-run configure with:
1307 # ./configure --enable-extras ldap
1308 # and run make install, then uncomment this module to enable it.
1310 #<module name="ldap">
1311 #<database module="ldap" id="ldapdb" server="ldap://localhost" binddn="cn=Manager,dc=inspircd,dc=org" bindauth="mysecretpass" searchscope="subtree">
1312 # The server parameter indicates the LDAP server to connect to. The #
1313 # ldap:// style scheme before the hostname proper is MANDATORY. #
1315 # The binddn and bindauth indicate the DN to bind to for searching, #
1316 # and the password for the distinguished name. Some LDAP servers will #
1317 # allow anonymous searching in which case these two values do not #
1318 # need defining, otherwise they should be set similar to the examples #
1321 # The searchscope value indicates the subtree to search under. On our #
1322 # test system this is 'subtree'. Your mileage may vary. #
1324 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1325 # LDAP authentication module: Adds the ability to authenticate users #
1327 #<module name="ldapauth">
1331 # <ldapauth dbid="ldapdb" #
1332 # baserdn="ou=People,dc=brainbox,dc=cc" #
1334 # allowpattern="Guest* Bot*" #
1335 # killreason="Access denied" #
1337 # host="$uid.$ou.inspircd.org" #
1338 # useusername="no"> #
1340 # <ldapwhitelist cidr="10.42.0.0/16"> #
1342 # <ldaprequire attribute="attr" value="val"> #
1344 # The baserdn indicates the base DN to search in for users. Usually #
1345 # this is 'ou=People,dc=yourdomain,dc=yourtld'. #
1347 # The attribute value indicates the attribute which is used to locate #
1348 # a user account by name. On POSIX systems this is usually 'uid'. #
1350 # The allowpattern value allows you to specify a space separated list #
1351 # of wildcard masks which will always be allowed to connect #
1352 # regardless of if they have an account, for example guest and bot #
1355 # The useusername setting chooses whether the user's username or #
1356 # nickname is used when locating a user account, if a username isn't #
1357 # provided in PASS. #
1359 # Killreason indicates the QUIT reason to give to users if they fail #
1360 # to authenticate. #
1362 # Setting the verbose value causes an oper notice to be sent out for #
1363 # every failed authentication to the server, with an error string. #
1365 # ldapwhitelist indicates that clients connecting from an IP in the #
1366 # provided CIDR do not need to authenticate against LDAP. It can be #
1367 # repeated to whitelist multiple CIDRs. #
1369 # ldaprequire allows further filtering on the LDAP user, by requiring #
1370 # certain LDAP attributes to have a given value. It can be repeated, #
1371 # in which case the list will act as an OR list, that is, the #
1372 # authentication will succeed if any of the requirements in the list #
1375 # host allows you to change the displayed host of users connecting #
1376 # from ldap. The string supplied takes formatters which are replaced #
1377 # from the DN. For instance, if your DN looks like: #
1378 # uid=w00t,ou=people,dc=inspircd,dc=org, then the formatters uid, ou #
1379 # and dc will be available to you. If a key is given multiple times #
1380 # in the DN, the last appearance will take precedence. #
1382 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1383 # LDAP oper configuration module: Adds the ability to authenticate #
1385 #<module name="ldapoper">
1389 # <ldapoper dbid="ldapdb"
1390 # baserdn="ou=People,dc=brainbox,dc=cc"
1393 # Available configuration items are identical to the same items in #
1394 # ldapauth above (except for the verbose setting, that is only #
1395 # supported in ldapauth). #
1396 # Please always specify a password in your <oper> tags even if the #
1397 # opers are to be authenticated via LDAP, so in case this module is #
1398 # not loaded the oper accounts are still protected by a password. #
1400 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1401 # Lock server module: Adds /LOCKSERV and /UNLOCKSERV commands that #
1402 # are used to temporarily close/open the server for new connections. #
1403 # These commands require that the /LOCKSERV and /UNLOCKSERV commands #
1404 # are specified in a <class> tag that the oper is part of. This is so #
1405 # you can control who has access to this possible dangerous command. #
1406 # If your server is locked and you get disconnected, do a REHASH from #
1407 # shell to open up again. #
1408 # This module is oper-only.
1409 #<module name="lockserv">
1411 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1412 # Map hiding module: replaces /MAP and /LINKS output to users with a #
1413 # message to see a website, set by maphide="https://test.org/map" in #
1414 # the <security> tag, instead. #
1415 #<module name="maphide">
1417 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1418 # Message flood module: Adds message/notice flood protection via
1420 #<module name="messageflood">
1422 # The weight to give each message type. TAGMSGs are considered to be
1423 # 1/5 of a NOTICE or PRIVMSG to avoid users being accidentally flooded
1424 # out of a channel by automatic client features such as typing
1426 #<messageflood notice="1.0" privmsg="1.0" tagmsg="0.2">
1428 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1429 # MLOCK module: Adds support for server-side enforcement of services
1430 # side MLOCKs. Basically, this module suppresses any mode change that
1431 # would likely be immediately bounced by services.
1432 #<module name="mlock">
1434 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1435 # Modenotice module: Adds the /MODENOTICE command that allows opers to
1436 # send notices to all users having the given user mode(s) set.
1437 #<module name="modenotice">
1439 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1440 # Monitor module: Adds support for MONITOR which is used by clients to
1441 # maintain notify lists.
1442 #<module name="monitor">
1444 # Set the maximum number of entries on a user's monitor list below.
1445 #<monitor maxentries="30">
1447 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1448 # MySQL module: Allows other SQL modules to access MySQL databases
1449 # through a unified API.
1450 # This module is in extras. Re-run configure with:
1451 # ./configure --enable-extras mysql
1452 # and run make install, then uncomment this module to enable it.
1453 #<module name="mysql">
1455 #-#-#-#-#-#-#-#-#-#-#-#- SQL CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#-#
1457 # mysql is more complex than described here, see the docs for more #
1458 # info: https://docs.inspircd.org/3/modules/mysql #
1460 #<database module="mysql" name="mydb" user="myuser" pass="mypass" host="localhost" id="my_database2">
1462 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1463 # Named modes module: Allows for the display and set/unset of channel
1464 # modes via long-form mode names via +Z and the /PROP command.
1465 # For example, to set a ban, do /MODE #channel +Z ban=foo!bar@baz or
1466 # /PROP #channel ban=foo!bar@baz
1467 #<module name="namedmodes">
1469 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1470 # NAMESX module: Provides support for the NAMESX extension which allows
1471 # clients to see all the prefixes set on a user without getting confused.
1472 # This is supported by mIRC, x-chat, klient, and maybe more.
1473 #<module name="namesx">
1475 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1476 # National characters module:
1477 # 1) Allows using national characters in nicknames.
1478 # 2) Allows using custom (national) casemapping over the network.
1480 # This module is incredibly poorly written and documented. You should
1481 # probably use the codepage module instead for 8-bit codepages.
1482 #<module name="nationalchars">
1484 # file - Location of the file which contains casemapping rules. If this
1485 # is a relative path then it is relative to "<PWD>/../locales"
1486 # on UNIX and "<PWD>/locales" on Windows.
1487 # casemapping - The name of the casemapping sent to clients in the 005
1488 # numeric. If this is not set then it defaults to the name
1489 # of the casemapping file unless the file name contains a
1490 # space in which case you will have to specify it manually.
1491 #<nationalchars file="bynets/russian-w1251-charlink" casemapping="ru_RU.cp1251-charlink">
1493 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1494 # Nickchange flood protection module: Provides channel mode +F X:Y
1495 # which allows up to X nick changes in Y seconds.
1496 #<module name="nickflood">
1498 # The number of seconds to prevent nick changes for:
1499 #<nickflood duration="1m">
1501 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1502 # Nicklock module: Let opers change a user's nick and then stop that
1503 # user from changing their nick again until unlocked.
1504 # This module is oper-only.
1505 # To use, NICKLOCK and NICKUNLOCK must be in one of your oper class blocks.
1506 #<module name="nicklock">
1508 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1509 # No CTCP module: Adds the channel mode +C and user mode +T to block
1510 # CTCPs and extban 'C' to block CTCPs sent by specific users.
1511 #<module name="noctcp">
1513 # The +T user mode is not enabled by default to enable link compatibility
1514 # with 2.0 servers. You can enable it by uncommenting this:
1515 #<noctcp enableumode="yes">
1517 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1518 # No kicks module: Adds the +Q channel mode and the Q: extban to deny
1519 # certain users from kicking.
1520 #<module name="nokicks">
1522 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1523 # No nicks module: Adds the +N channel mode, as well as the 'N' extban.
1524 # +N stops all users from changing their nick, the N extban stops
1525 # anyone from matching a +b N:nick!user@host mask from changing their
1527 #<module name="nonicks">
1529 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1530 # No part message module: Adds extban 'p' to block part messages from #
1532 #<module name="nopartmsg">
1534 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1535 # No notice module: Adds the channel mode +T and the extban 'T' to
1536 # block specific users from noticing the channel.
1537 #<module name="nonotice">
1539 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1540 # Network business join module:
1541 # Allows an oper to join a channel using /OJOIN, giving them +Y on the
1542 # channel which makes them immune to kicks.
1543 #<module name="ojoin">
1545 # Specify the prefix that +Y will grant here.
1546 # Leave 'prefix' empty if you do not wish +Y to grant a prefix.
1547 # If 'notice' is set to on, upon /OJOIN, the server will notice the
1548 # channel saying that the oper is joining on network business.
1549 # If 'op' is set to on, it will give them +o along with +Y.
1550 #<ojoin prefix="!" notice="yes" op="yes">
1552 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1553 # Oper channels mode: Adds the +O channel mode and extban O:<mask>
1554 # to ban, except, etc. specific oper types. For example
1555 # /MODE #channel +iI O:* is equivalent to channel mode +O, but you
1556 # may also set +iI O:AdminTypeOnly to only allow admins.
1557 # Modes +I and +e work in a similar fashion.
1558 #<module name="operchans">
1560 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1561 # Oper join module: Auto-joins opers to a channel upon oper-up.
1562 # This module is oper-only. For the user equivalent, see the conn_join
1564 #<module name="operjoin">
1566 #-#-#-#-#-#-#-#-#-#-# OPERJOIN CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
1568 # If you are using the operjoin module, specify options here: #
1570 # channel - The channel name to join, can also be a comma #
1571 # separated list e.g. "#channel1,#channel2". #
1573 # override - If on, lets the oper join walking thru any modes #
1574 # that might be set, even bans. #
1576 #<operjoin channel="#channel" override="no">
1578 # Alternatively you can use the autojoin="channellist" in a <type> #
1579 # tag to set specific autojoins for a type of oper, for example: #
1581 #<type name="Helper" autojoin="#help" classes="...">
1583 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1584 # Oper log module: Logs all oper commands to the server log (with log
1585 # type "m_operlog" at default loglevel), and optionally to the 'r'
1587 # This module is oper-only.
1588 #<module name="operlog">
1590 # If the following option is on then all oper commands will be sent to
1591 # the snomask 'r'. The default is off.
1592 #<operlog tosnomask="off">
1594 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1595 # Oper prefixing module: Adds a channel prefix mode +y which is given
1596 # to all server operators automatically on all channels they are in.
1597 # This prefix mode is more powerful than channel op and other regular
1600 # Load this module if you want all your server operators to have
1601 # channel operator powers.
1602 #<module name="operprefix">
1604 # You may additionally customise the prefix character.
1605 #<operprefix prefix="!">
1607 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1608 # Oper MOTD module: Provides support for a separate message of the day
1610 # This module is oper-only.
1611 #<module name="opermotd">
1613 #-#-#-#-#-#-#-#-#-#-# OPERMOTD CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
1615 # If you are using the opermotd module, specify the motd file here. #
1617 # onoper - If on, the message is sent on /OPER, otherwise it's #
1618 # only sent when /OPERMOTD is used. #
1620 #<opermotd file="examples/opermotd.txt.example" onoper="yes">
1622 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1623 # Override module: Adds support for oper override.
1624 # This module is oper-only.
1625 #<module name="override">
1627 #-#-#-#-#-#-#-#-#-#-# OVERRIDE CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
1629 # Much of override's configuration relates to your oper blocks. #
1630 # For more information on how to allow opers to override, see: #
1631 # https://docs.inspircd.org/3/modules/override #
1633 # noisy - If enabled, all oper overrides will be announced #
1634 # via channel notice. #
1636 # requirekey - If enabled, overriding on join requires a channel #
1637 # key of "override" to be specified. #
1639 # enableumode - If enabled, user mode +O is required for override. #
1641 #<override noisy="yes" requirekey="no" enableumode="yes">
1643 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1644 # Oper levels module: Gives each oper a level and prevents actions
1645 # being taken by lower level opers against higher level opers.
1646 # Specify the level as the 'level' parameter of the <type> tag.
1647 # This module is oper-only.
1648 #<module name="operlevels">
1650 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1651 # Oper modes module: Allows you to specify modes to add/remove on oper.
1652 # Specify the modes as the 'modes' parameter of the <type> tag
1653 # and/or as the 'modes' parameter of the <oper> tag.
1654 # This module is oper-only. For the user equivalent, see the
1655 # conn_umodes module.
1656 #<module name="opermodes">
1658 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1659 # Password forwarding module: Forwards a password users can send on
1660 # connect to the specified client below. The client is usually NickServ
1661 # and this module is usually used to authenticate users with NickServ
1662 # using their connect password.
1663 #<module name="passforward">
1666 # nick: nick to forward connect passwords to.
1669 # forwardmsg: Message to send to users using a connect password.
1670 # $nick will be the users' nick, $nickrequired will be the nick
1671 # of where the password is going (the nick above).
1672 # You can also use $user for the user ident string.
1673 forwardmsg="NOTICE $nick :*** Forwarding PASS to $nickrequired"
1675 # cmd: Command for the user to run when it receives a connect
1677 cmd="SQUERY $nickrequired :IDENTIFY $pass">
1679 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1680 # Password hash module: Allows hashed passwords to be used.
1681 # To be useful, a hashing module like bcrypt also needs to be loaded.
1682 #<module name="password_hash">
1684 #-#-#-#-#-#-#-#-#-# PASSWORD HASH CONFIGURATION #-#-#-#-#-#-#-#-#-#-#-#
1686 # To use this module, you must define a hash type for each oper's
1687 # password you want to hash. For example:
1689 # <oper name="Brain"
1690 # host="ident@dialup15.isp.test.com"
1692 # password="$2a$10$Mss9AtHHslZTLBrXqM0FB.JBwD.UTSu8A48SfrY9exrpxbsRiRTbO"
1695 # If you are using a hash algorithm which does not perform salting you can use
1696 # HMAC to salt your passwords in order to prevent them from being looked up in
1699 # hash="hmac-sha256" password="lkS1Nbtp$CyLd/WPQXizsbxFUTqFRoMvaC+zhOULEeZaQkUJj+Gg"
1701 # Generate hashes using the /MKPASSWD command on the server.
1702 # Don't run it on a server you don't trust with your password.
1704 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1705 # PBKDF2 module: Allows other modules to generate PBKDF2 hashes,
1706 # usually for cryptographic uses and security.
1707 # This module relies on other hash providers (e.g. SHA256).
1708 #<module name="pbkdf2">
1710 # iterations: Iterations the hashing function runs when generating new
1712 # length: Length in bytes of the derived key.
1713 #<pbkdf2 iterations="12288" length="32">
1714 # You can override these values with specific values
1715 # for specific providers if you want to. Example given for SHA256.
1716 #<pbkdf2prov hash="sha256" iterations="24576">
1718 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1719 # Permanent channels module: Channels with the permanent channel mode
1720 # will remain open even after everyone else has left the channel, and
1721 # therefore keep things like modes, ban lists and topic. Permanent
1722 # channels -may- need support from your Services package to function
1723 # properly with them. This adds channel mode +P.
1724 # This module is oper-only.
1725 #<module name="permchannels">
1727 # If you like, this module can write a config file of permanent channels
1728 # whenever +P is set, unset, or the topic/modes on a +P channel is changed.
1729 # If you want to do this, set the filename below, and uncomment the include.
1731 # If 'listmodes' is true then all list modes (+b, +I, +e, +g...) will be
1732 # saved. Defaults to false.
1734 # 'saveperiod' determines how often to check if the database needs to be
1735 # saved to disk. Defaults to every five seconds.
1736 #<permchanneldb filename="permchannels.conf"
1739 #<include file="permchannels.conf">
1741 # You may also create channels on startup by using the <permchannels> block.
1742 #<permchannels channel="#opers" modes="isP" topic="Opers only.">
1744 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1745 # PostgreSQL module: Allows other SQL modules to access PgSQL databases
1746 # through a unified API.
1747 # This module is in extras. Re-run configure with:
1748 # ./configure --enable-extras pgsql
1749 # and run make install, then uncomment this module to enable it.
1750 #<module name="pgsql">
1752 #-#-#-#-#-#-#-#-#-#-#-#- SQL CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#-#
1754 # pgsql is more complex than described here, see the docs for #
1755 # more: https://docs.inspircd.org/3/modules/pgsql #
1757 #<database module="pgsql" name="mydb" user="myuser" pass="mypass" host="localhost" id="my_database" ssl="no">
1759 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1760 # Muteban: Implements extended ban 'm', which stops anyone matching
1761 # a mask like +b m:nick!user@host from speaking on channel.
1762 #<module name="muteban">
1764 # If notifyuser is set to no, the user will not be notified when
1765 # their message is blocked.
1766 #<muteban notifyuser="yes">
1768 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1769 # Random quote module: Provides a random quote on connect.
1770 # NOTE: Some of these may mimic fatal errors and confuse users and
1771 # opers alike - BEWARE!
1772 #<module name="randquote">
1774 #-#-#-#-#-#-#-#-#-#- RANDOMQUOTES CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
1776 # Optional - If you specify to use the randquote module, then specify #
1777 # below the path to the quotes file. #
1779 #<randquote file="quotes.txt">
1781 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1782 # Redirect module: Adds channel mode +L which redirects users to #
1783 # another channel when the channel has reached its user limit and #
1784 # user mode +L which stops redirection. #
1785 #<module name="redirect">
1787 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1788 # Regular expression provider for glob or wildcard (?/*) matching.
1789 # You must have at least 1 provider loaded to use the filter or R-line
1790 # modules. This module has no additional requirements, as it uses the
1791 # matching already present in InspIRCd core.
1792 #<module name="regex_glob">
1794 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1795 # Regular expression provider for PCRE (Perl-Compatible Regular
1796 # Expressions). You need libpcre installed to compile and load this
1797 # module. You must have at least 1 provider loaded to use the filter or
1799 #<module name="regex_pcre">
1801 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1802 # Regular Expression Provider for RE2 Regular Expressions.
1803 # You need libre2 installed and in your include/library paths in order
1804 # to compile and load this module.
1805 #<module name="regex_re2">
1807 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1808 # Regular expression provider for POSIX regular expressions.
1809 # You shouldn't need any additional libraries on a POSIX-compatible
1810 # system (i.e.: any Linux, BSD, but not Windows). You must have at
1811 # least 1 provider loaded to use the filter or R-line modules.
1812 # On POSIX-compliant systems, regex syntax can be found by using the
1813 # command: 'man 7 regex'.
1814 #<module name="regex_posix">
1816 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1817 # Regular expression provider for C++11 std::regex regular expressions.
1818 # This module works on any fully compliant implementation of the C++11
1819 # std::regex container. Examples for such are Visual C++ 2010 and newer
1820 # but not libstdc++ (which GCC uses).
1821 # You should verify that std::regex is supported by your setup before
1822 # using this module, as it may compile normally but won't do anything
1823 # on some implementations.
1824 #<module name="regex_stdlib">
1826 # Specify the regular expression engine to use here. Valid settings are
1827 # bre, ere, awk, grep, egrep, ecmascript (default if not specified).
1828 #<stdregex type="ecmascript">
1830 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1831 # Regular expression provider for TRE regular expressions.
1832 # This is the same regular expression engine used by UnrealIRCd, so
1833 # if you are most familiar with the syntax of /SPAMFILTER from there,
1834 # this is the provider you want. You need libtre installed in order
1835 # to compile and load this module.
1836 #<module name="regex_tre">
1838 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1839 # Remove module: Adds the /REMOVE command which is a peaceful
1840 # alternative to /KICK. It also provides the /FPART command which works
1841 # in the same way as /REMOVE.
1842 #<module name="remove">
1844 # supportnokicks: If true, /REMOVE is not allowed on channels where the
1845 # nokicks (+Q) mode is set. Defaults to false.
1846 # protectedrank: Members having this rank or above may not be /REMOVE'd
1847 # by anyone. Set to 0 to disable this feature. Defaults to 50000.
1848 #<remove supportnokicks="yes" protectedrank="50000">
1850 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1851 # Repeat module: Allows to block, kick or ban upon similar messages
1852 # being uttered several times. Provides channel mode +E.
1854 # Syntax: [~|*]<lines>:<sec>[:<difference>][:<backlog>]
1855 # ~ is to block, * is to ban, default is kick.
1856 # lines - In mode 1, the amount of lines that has to match consecutively.
1857 # In mode 2, the size of the backlog to keep for matching.
1858 # seconds - How old the message has to be before it's invalidated.
1859 # difference - Edit distance, in percent, between two strings to trigger on.
1860 # backlog - When set, the function goes into mode 2. In this mode the
1861 # function will trigger if this many of the last <lines> matches.
1863 # As this module can be rather CPU-intensive, it comes with some options.
1864 # maxbacklog - Maximum size that can be specified for backlog. 0 disables
1865 # multiline matching.
1866 # maxdistance - Max percentage of difference between two lines we'll allow
1867 # to match. Set to 0 to disable edit-distance matching.
1868 # maxlines - Max lines of backlog to match against.
1869 # maxtime - Maximum period of time a user can set. 0 to allow any.
1870 # size - Maximum number of characters to check for, can be used to
1871 # truncate messages before they are checked, resulting in
1872 # less CPU usage. Increasing this beyond 512 doesn't have
1873 # any effect, as the maximum length of a message on IRC
1874 # cannot exceed that.
1875 #<repeat maxbacklog="20" maxdistance="50" maxlines="20" maxtime="0" size="512">
1876 #<module name="repeat">
1878 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1879 # Restricted channels module: Allows only opers with the
1880 # channels/restricted-create priv and/or registered users to
1883 # You probably *DO NOT* want to load this module on a public network.
1885 #<module name="restrictchans">
1887 # allowregistered: should registered users be allowed to bypass the restrictions?
1888 #<restrictchans allowregistered="no">
1890 # Allow any channel matching #user-* to be created, bypassing restrictchans checks
1891 #<allowchannel name="#user-*">
1893 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1894 # Restrict message module: Allows users to only message opers.
1896 # You probably *DO NOT* want to load this module on a public network.
1898 #<module name="restrictmsg">
1900 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1901 # R-line module: Ban users through regular expression patterns.
1902 #<module name="rline">
1904 #-#-#-#-#-#-#-#-#-#-#-#- RLINE CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#-#
1906 # If you wish to re-check a user when they change nickname (can be
1907 # useful under some situations, but *can* also use CPU with more users
1908 # on a server) then set 'matchonnickchange' to yes.
1909 # If you additionally want Z-lines to be added on matches, then
1910 # set 'zlineonmatch' to yes.
1911 # Also, this is where you set what Regular Expression engine is to be
1912 # used. If you ever change it while running, all of your R-lines will
1913 # be wiped. This is the regex engine used by all R-lines set, and
1914 # regex_<engine> must be loaded, or rline will be non-functional
1915 # until you load it or change the engine to one that is loaded.
1917 #<rline matchonnickchange="yes" zlineonmatch="no" engine="pcre">
1919 # Generally, you will NOT want to use 'glob' here, as this turns an
1920 # R-line into just another G-line. The exceptions are that R-lines will
1921 # always use the full "nick!user@host realname" string, rather than only
1922 # user@host, but beware that only the ? and * wildcards are available,
1923 # and are the only way to specify where the space can occur if you do
1924 # use glob. For this reason, is recommended to use a real regex engine
1925 # so that at least \s or [[:space:]] is available.
1927 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1928 # RMODE module: Adds the /RMODE command.
1929 # Allows channel operators to remove list modes en masse, optionally
1930 # matching a glob-based pattern.
1931 # Syntax: /RMODE <channel> <mode> [<pattern>]
1932 # E.g. '/RMODE #channel b m:*' will remove all mute extbans on the channel.
1933 #<module name="rmode">
1935 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1936 # SAJOIN module: Adds the /SAJOIN command which forcibly joins a user
1937 # to the given channel.
1938 # This module is oper-only.
1939 # To use, SAJOIN must be in one of your oper class blocks.
1940 # Opers need the users/sajoin-others priv to be able to /SAJOIN users
1941 # other than themselves.
1942 #<module name="sajoin">
1944 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1945 # SAKICK module: Adds the /SAKICK command which kicks a user from the
1947 # This module is oper-only.
1948 # To use, SAKICK must be in one of your oper class blocks.
1949 #<module name="sakick">
1951 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1952 # SAMODE module: Adds the /SAMODE command which allows server operators
1953 # to change modes on a channel without requiring them to have any
1954 # channel privileges. Also allows changing user modes for any user.
1955 # This module is oper-only.
1956 # To use, SAMODE must be in one of your oper class blocks.
1957 #<module name="samode">
1959 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1960 # SANICK module: Adds the /SANICK command which allows opers to change
1962 # This module is oper-only.
1963 # To use, SANICK must be in one of your oper class blocks.
1964 #<module name="sanick">
1966 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1967 # SAPART module: Adds the /SAPART command which forcibly parts a user
1969 # This module is oper-only.
1970 # To use, SAPART must be in one of your oper class blocks.
1971 #<module name="sapart">
1973 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1974 # SAQUIT module: Adds the /SAQUIT command which forcibly quits a user.
1975 # This module is oper-only.
1976 # To use, SAQUIT must be in one of your oper class blocks.
1977 #<module name="saquit">
1979 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1980 # SATOPIC module: Adds the /SATOPIC command which allows changing the
1981 # topic on a channel without requiring any channel privileges.
1982 # This module is oper-only.
1983 # To use, SATOPIC must be in one of your oper class blocks.
1984 #<module name="satopic">
1986 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1987 # SASL authentication module: Provides support for IRC Authentication
1988 # Layer via AUTHENTICATE. Note: You also need to have cap loaded
1990 #<module name="sasl">
1992 # You must define <sasl:target> to the name of your services server so
1993 # that InspIRCd knows where to send SASL authentication messages and
1994 #Â when it should enable the SASL capability.
1995 # You can also define <sasl:requiressl> to require users to use TLS (SSL)
1996 # in order to be able to use SASL.
1997 #<sasl target="services.mynetwork.com"
2000 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2001 # Secure list module: Prevent /LIST in the first minute of connection,
2002 # crippling most spambots and trojan spreader bots.
2003 #<module name="securelist">
2005 #-#-#-#-#-#-#-#-#-# SECURELIST CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#-#
2007 # Securelist can be harmful to some IRC search engines. To prevent #
2008 # securelist blocking these sites from listing, define exception tags #
2010 #<securehost exception="*@*.netsplit.de">
2011 #<securehost exception="*@*.ircdriven.com">
2012 #<securehost exception="*@*.ircs.me">
2014 # exemptregistered - Whether the waiting period applies to users who #
2015 # are logged in to a services account. #
2018 # showmsg - Whether to tell users that they need to wait for a while #
2019 # before they can use the /LIST command. #
2022 # waittime - The time period that a user must be connected for before #
2023 # they can use the /LIST command. #
2024 # Defaults to 1 minute. #
2026 #<securelist exemptregistered="yes"
2030 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2031 # Servprotect module: Provides support for Austhex style +k /
2032 # UnrealIRCD +S services mode.
2033 #<module name="servprotect">
2035 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2036 # See nicks module: Adds snomask +n and +N which show local and remote
2038 # This module is oper-only.
2039 #<module name="seenicks">
2041 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2042 # Set idle module: Adds a command for opers to change their idle time.
2043 # This module is oper-only.
2044 # To use, SETIDLE must be in one of your oper class blocks.
2045 #<module name="setidle">
2047 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2048 # Services support module: Adds several user modes such as +R and +M.
2049 # This module implements the 'identified' state via account names,
2050 # and is similar in operation to the way asuka and ircu handle services.
2052 # At the same time, this offers +r for users and channels to mark them
2053 # as identified separately from the idea of a master account, which
2054 # can be useful for services which are heavily nick-as-account centric.
2056 # Also of note is that this module implements two extbans:
2057 # +b R: (stop matching account names from joining)
2058 # +b U:n!u@h (blocks matching unregistered users)
2060 #<module name="services_account">
2062 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2063 # Sethost module: Adds the /SETHOST command.
2064 # This module is oper-only.
2065 # To use, SETHOST must be in one of your oper class blocks.
2066 # See the chghost module for how to customise valid chars for hostnames.
2067 #<module name="sethost">
2069 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2070 # Setident module: Adds the /SETIDENT command.
2071 # This module is oper-only.
2072 # To use, SETIDENT must be in one of your oper class blocks.
2073 #<module name="setident">
2075 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2076 # SETNAME module: Adds the /SETNAME command.
2077 #<module name="setname">
2079 #-#-#-#-#-#-#-#-#-#-#-#- SETNAME CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#
2081 # operonly - Whether the SETNAME command should only be usable by #
2082 # server operators. Defaults to no. #
2084 # notifyopers - Whether to send a snotice to snomask `a` when a user #
2085 # changes their real name. Defaults to to yes if #
2086 # oper-only and no if usable by everyone. #
2088 #<setname notifyopers="yes"
2091 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2092 # Serverban: Implements extended ban 's', which stops anyone connected
2093 # to a server matching a mask like +b s:server.mask.here from joining.
2094 # Wildcards are accepted.
2095 #<module name="serverban">
2097 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2098 # SHA1 module: Allows other modules to generate SHA1 hashes.
2099 # Required by the WebSocket module.
2100 #<module name="sha1">
2102 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2103 # Showfile: Provides support for showing a text file to users when #
2104 # they enter a command. #
2105 # This module adds one command for each <showfile> tag that shows the #
2106 # given file to the user as a series of messages or numerics. #
2107 #<module name="showfile">
2109 #-#-#-#-#-#-#-#-#-#-# SHOWFILE CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#-#
2111 # name - The name of the command which displays this file. This is #
2112 # the only mandatory setting, all others are optional. #
2113 # file - The text file to be shown to the user. #
2114 # By default same as the command name. #
2115 # method - How should the file be shown? #
2116 # * numeric: Send contents using a numeric #
2117 # (similar to /MOTD; the default). #
2118 # * notice: Send contents as a series of notices. #
2119 # * msg: Send contents as a series of private messages. #
2121 # When using the method "numeric", the following extra settings are #
2124 # introtext - Introductory line, "Showing <name>" by default. #
2125 # intronumeric - Numeric used for the introductory line. #
2126 # numeric - Numeric used for sending the text itself. #
2127 # endtext - Ending line, "End of <name>" by default. #
2128 # endnumeric - Numeric used for the ending line. #
2130 #<showfile name="RULES"
2132 # introtext="Server rules:"
2133 # endtext="End of server rules.">
2135 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2136 # Show whois module: Adds the +W user mode which allows opers to see
2137 # when they are /WHOIS'd.
2138 # This module is oper-only by default.
2139 #<module name="showwhois">
2141 # If you wish, you may also let users set this mode. Only opers with the
2142 # users/auspex priv will see real hosts of people, though.
2143 #<showwhois opersonly="yes"
2145 # You may also set whether or not users should receive whois notices,
2146 # should they be /WHOIS'd by an oper.
2147 #showfromopers="yes">
2149 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2150 # Shun module: Provides the /SHUN command, which stops a user from
2151 # executing all except configured commands.
2152 # This module is oper-only.
2153 # To use, SHUN must be in one of your oper class blocks.
2154 #<module name="shun">
2158 # affectopers: Whether server operators are exempt from shuns. This
2159 # option is deprecated; you should instead give exempt
2160 # server operators the servers/ignore-shun privilege.
2162 # allowtags: Whether to allow client tags to be attached to enabled
2165 # cleanedcommands: The commands that, if enabled, should be cleaned
2166 # of any message content if a shunned user tries to
2169 # enabledcommands: The commands that a shunned user is allowed to
2172 # notifyuser: Whether to notify shunned users that a command they tried
2173 # to execute has been blocked.
2175 #<shun enabledcommands="ADMIN OPER PING PONG QUIT PART JOIN"
2176 # cleanedcommands="AWAY PART QUIT"
2181 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2182 # SSL mode module: Adds support for TLS (SSL)-only channels via the '+z'
2183 # channel mode, TLS (SSL)-only private messages via the '+z' user mode and
2184 # the 'z:' extban which matches TLS (SSL) client certificate fingerprints.
2186 # Does not do anything useful without a working TLS (SSL) module and the
2187 # sslinfo module (see below).
2188 #<module name="sslmodes">
2190 # The +z user mode is not enabled by default to enable link compatibility
2191 # with 2.0 servers. You can enable it by uncommenting this:
2192 #<sslmodes enableumode="yes">
2194 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2195 # SSL rehash signal module: Allows the TLS (SSL) modules to be rehashed by
2196 # sending SIGUSR1 to a running InspIRCd process.
2197 # This module is in extras. Re-run configure with:
2198 # ./configure --enable-extras sslrehashsignal
2199 # and run make install, then uncomment this module to enable it.
2200 #<module name="sslrehashsignal">
2202 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2203 # GnuTLS SSL module: Adds support for TLS (SSL) connections using GnuTLS,
2204 # if enabled. You must answer 'yes' in ./configure when asked or
2205 # manually symlink the source for this module from the directory
2206 # src/modules/extra, if you want to enable this, or it will not load.
2207 #<module name="ssl_gnutls">
2209 #-#-#-#-#-#-#-#-#-#-#- GNUTLS CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#
2211 # ssl_gnutls is too complex to describe here, see the docs: #
2212 # https://docs.inspircd.org/3/modules/ssl_gnutls #
2214 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2215 # SSL info module: Allows users to retrieve information about other
2216 # users' peer TLS (SSL) certificates and keys via the SSLINFO command.
2217 # This can be used by client scripts to validate users. For this to
2218 # work, one of ssl_gnutls, ssl_mbedtls or ssl_openssl must be loaded.
2219 # This module also adds the "<user> is using a secure connection"
2220 # and "<user> has TLS (SSL) client certificate fingerprint <fingerprint>"
2221 # WHOIS lines, the ability for opers to use TLS (SSL) cert fingerprints to
2222 # verify their identity and the ability to force opers to use TLS (SSL)
2223 # connections in order to oper up. It is highly recommended to load
2224 # this module if you use TLS (SSL) on your network.
2225 # For how to use the oper features, please see the first
2226 # example <oper> tag in opers.conf.example.
2228 #<module name="sslinfo">
2230 # If you want to prevent users from viewing TLS (SSL) certificate information
2231 # and fingerprints of other users, set operonly to yes.
2232 #<sslinfo operonly="no">
2234 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2235 # mbedTLS TLS (SSL) module: Adds support for TLS (SSL) connections using mbedTLS.
2236 #<module name="ssl_mbedtls">
2238 #-#-#-#-#-#-#-#-#-#-#- MBEDTLS CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#
2240 # ssl_mbedtls is too complex to describe here, see the docs: #
2241 # https://docs.inspircd.org/3/modules/ssl_mbedtls #
2243 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2244 # OpenSSL TLS (SSL) module: Adds support for TLS (SSL) connections using OpenSSL,
2245 # if enabled. You must answer 'yes' in ./configure when asked or symlink
2246 # the source for this module from the directory src/modules/extra, if
2247 # you want to enable this, or it will not load.
2248 #<module name="ssl_openssl">
2250 #-#-#-#-#-#-#-#-#-#-#- OPENSSL CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#
2252 # ssl_openssl is too complex to describe here, see the docs: #
2253 # https://docs.inspircd.org/3/modules/ssl_openssl #
2255 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2256 # Strip color module: Adds channel mode +S that strips color codes and
2257 # all control codes except CTCP from all messages sent to the channel.
2258 #<module name="stripcolor">
2260 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2261 # Silence module: Adds support for the /SILENCE command, which allows
2262 # users to have a server-side ignore list for their client.
2263 #<module name="silence">
2265 # Set the maximum number of entries allowed on a user's silence list.
2266 #<silence maxentries="32"
2268 # Whether messages from U-lined servers will bypass silence masks.
2271 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2272 # SQLite3 module: Allows other SQL modules to access SQLite3 #
2273 # databases through a unified API. #
2274 # This module is in extras. Re-run configure with: #
2275 # ./configure --enable-extras sqlite3
2276 # and run make install, then uncomment this module to enable it. #
2278 #<module name="sqlite3">
2280 #-#-#-#-#-#-#-#-#-#-#-#- SQL CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#-#
2282 # sqlite is more complex than described here, see the docs for more #
2283 # info: https://docs.inspircd.org/3/modules/sqlite3 #
2285 #<database module="sqlite" hostname="/full/path/to/database.db" id="anytext">
2287 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2288 # SQL authentication module: Allows IRCd connections to be tied into
2289 # a database table (for example a forum).
2291 #<module name="sqlauth">
2293 #-#-#-#-#-#-#-#-#-#-#- SQLAUTH CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#
2295 # sqlauth is too complex to describe here, see the docs: #
2296 # https://docs.inspircd.org/3/modules/sqlauth #
2298 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2299 # SQL oper module: Allows you to store oper credentials in an SQL
2300 # table. You can add additional table columns like you would config
2301 # tags in opers.conf. Opers in opers.conf will override opers from
2304 #<module name="sqloper">
2306 #-#-#-#-#-#-#-#-#-#-#- SQLOPER CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#
2308 # dbid - Database ID to use (see SQL modules). #
2310 # See also: https://docs.inspircd.org/3/modules/sqloper #
2314 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2315 # StartTLS module: Implements STARTTLS, which allows clients #
2316 # connected to non TLS (SSL) enabled ports to enable TLS (SSL), if #
2317 # a proper TLS (SSL) module is loaded (either ssl_gnutls, #
2318 # ssl_mbedtls or ssl_openssl). #
2319 #<module name="starttls">
2321 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2322 # SVSHold module: Implements SVSHOLD. Like Q-lines, but can only be #
2323 # added/removed by Services. #
2324 #<module name="svshold">
2325 # SVSHOLD does not generate server notices by default, you can turn
2326 # notices on by uncommenting the next line.
2327 #<svshold silent="false">
2329 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2330 # SWHOIS module: Allows you to add arbitrary lines to user WHOIS.
2331 # This module is oper-only.
2332 # To use, SWHOIS must be in one of your oper class blocks.
2333 #<module name="swhois">
2335 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2336 # Timed bans module: Adds timed channel bans with the /TBAN command.
2337 #<module name="timedbans">
2338 # By default, it sends a notice to channel operators when timed ban is
2339 # set and when it is removed by server.
2340 #<timedbans sendnotice="yes">
2342 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2343 # Test line module: Adds the /TLINE command, used to test how many
2344 # users a /GLINE or /ZLINE etc. would match.
2345 # This module is oper-only.
2346 # To use, TLINE must be in one of your oper class blocks.
2347 #<module name="tline">
2349 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2350 # Topiclock module: implements server-side topic locking to achieve deeper
2351 # integration with services packages.
2352 #<module name="topiclock">
2354 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2355 # UHNAMES support module: Adds support for the IRCX style UHNAMES
2356 # extension, which displays ident and hostname in the names list for
2357 # each user, saving clients from doing a WHO on the channel.
2358 # If a client does not support UHNAMES it will not enable it, this will
2359 # not break incompatible clients.
2360 #<module name="uhnames">
2362 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2363 # Uninvite module: Adds the /UNINVITE command which lets users remove
2364 # pending invites from channels without waiting for the user to join.
2365 #<module name="uninvite">
2367 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2368 # Userip module: Adds the /USERIP command.
2369 # Allows users to query their own IP, also allows opers to query the IP
2371 #<module name="userip">
2373 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2374 # Vhost module: Adds the VHOST command which allows for adding virtual
2375 # hosts which are accessible using a username and password in the config.
2376 #<module name="vhost">
2378 #-#-#-#-#-#-#-#-#-#-#- VHOST CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#-#
2380 # user - Username for the vhost. #
2382 # pass - Password for the vhost. #
2384 # hash - The hash for the specific user (optional) #
2385 # password_hash and a hashing module must be loaded for #
2388 # host - Vhost to set. #
2390 #<vhost user="some_username" pass="some_password" host="some.host.test.cc">
2391 #<vhost user="foo" password="$2a$10$iTuYLT6BRhRlOgzfsW9oPe62etW.oXwSpyKw5rJit64SGZanLXghO" hash="bcrypt" host="some.other.host.example.com">
2393 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2394 # Watch module: Adds the WATCH command, which is used by clients to
2395 # maintain notify lists.
2396 #<module name="watch">
2398 # Set the maximum number of entries on a user's watch list below.
2399 #<watch maxwatch="32">
2401 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2402 # WebSocket module: Adds HTML5 WebSocket support.
2403 # Specify hook="websocket" in a <bind> tag to make that port accept
2404 # WebSocket connections. Compatible with TLS (SSL).
2405 # Requires SHA-1 hash support available in the sha1 module.
2406 #<module name="websocket">
2408 # proxyranges: A space-delimited list of glob or CIDR matches to trust
2409 # the X-Real-IP or X-Forwarded-For headers from. If enabled
2410 # the server will use the IP address specified by those HTTP
2411 # headers. You should NOT enable this unless you are using
2412 # a HTTP proxy like nginx as it will allow IP spoofing.
2413 # sendastext: Whether to re-encode messages as UTF-8 before sending to
2414 # WebSocket clients. This is recommended as the WebSocket
2415 # protocol requires all text frames to be sent as UTF-8.
2416 # If you do not have this enabled messages will be sent as
2417 # binary frames instead.
2418 #<websocket proxyranges="192.0.2.0/24 198.51.100.*"
2421 # If you use the websocket module you MUST specify one or more origins
2422 # which are allowed to connect to the server. You should set this as
2423 # strict as possible to prevent malicious webpages from connecting to
2425 # <wsorigin allow="https://*.example.com">
2427 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2428 # X-line database: Stores all *-lines (G/Z/K/R/any added by other modules)
2429 # in a file which is re-loaded on restart. This is useful
2430 # for two reasons: it keeps bans so users may not evade them, and on
2431 # bigger networks, server connections will take less time as there will
2432 # be a lot less bans to apply - as most of them will already be there.
2433 #<module name="xline_db">
2435 # Specify the filename for the xline database and how often to check whether
2436 # the database needs to be saved here.
2437 #<xlinedb filename="xline.db" saveperiod="5s">
2439 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2440 # ____ _ _____ _ _ ____ _ _ _ #
2441 # | _ \ ___ __ _ __| | |_ _| |__ (_)___ | __ )(_) |_| | #
2442 # | |_) / _ \/ _` |/ _` | | | | '_ \| / __| | _ \| | __| | #
2443 # | _ < __/ (_| | (_| | | | | | | | \__ \ | |_) | | |_|_| #
2444 # |_| \_\___|\__,_|\__,_| |_| |_| |_|_|___/ |____/|_|\__(_) #
2446 # To link servers to InspIRCd, you MUST load the spanningtree module. #
2447 # If you don't do this, server links will NOT work at all. #
2448 # This is by design, to allow for the implementation of other linking #
2449 # protocols in modules in the future. #
2451 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2452 # Spanning tree module: Allows linking of servers using the spanning
2453 # tree protocol (see the READ THIS BIT section above).
2454 # You will almost always want to load this.
2456 #<module name="spanningtree">
projects / user / henk / code / inspircd.git / blob