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 set to yes, the alias can be run simply as #
82 # /ALIASNAME. Defaults to yes. #
84 # channelcommand - If set to yes, 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 no. #
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 set to yes, the text from the user will be #
120 # stripped of color and format codes before #
121 # matching against 'text'. #
123 # uline - Setting this to yes 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 yes, this will make the alias oper only. #
132 # If a non-oper attempts to use the alias, it will #
133 # appear to not exist. #
136 # An example of using the format value to create an alias with two
137 # different behaviours depending on the format of the parameters.
139 #<alias text="ID" format="#*" replace="SQUERY ChanServ :IDENTIFY $2 $3"
140 # requires="ChanServ" uline="yes">
142 #<alias text="ID" replace="SQUERY NickServ :IDENTIFY $2"
143 # requires="NickServ" uline="yes">
145 # This alias fixes a glitch in xchat 2.6.x and above and the way it
146 # assumes IDENTIFY must be prefixed by a colon (:) character. It should
147 # be placed ABOVE the default NICKSERV alias.
149 #<alias text="NICKSERV" format=":IDENTIFY *" replace="SQUERY NickServ :IDENTIFY $3-"
150 # requires="NickServ" uline="yes">
152 # You may also add aliases to trigger based on something said in a
153 # channel, aka 'fantasy' commands, configured in the same manner as any
154 # other alias, with usercommand="no" and channelcommand="yes" The
155 # command must be preceded by the fantasy prefix when used.
157 #<alias text="CS" usercommand="no" channelcommand="yes"
158 # replace="SQUERY ChanServ :$1 $chan $2-" requires="ChanServ" uline="yes">
160 # This would be used as "!cs <command> <options>", with the channel
161 # being automatically inserted after the command in the message to
162 # ChanServ, assuming the fantasy prefix is "!".
164 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
165 # Allowinvite module: Gives channel mode +A to allow all users to use
166 # /INVITE, and extban A to deny invite from specific masks.
167 #<module name="allowinvite">
169 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
170 # Alltime module: Shows time on all connected servers at once.
171 # This module is oper-only and provides /ALLTIME.
172 # To use, ALLTIME must be in one of your oper class blocks.
173 #<module name="alltime">
175 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
176 # Anticaps module: Adds channel mode +B which allows you to punish
177 # users that send overly capitalised messages to channels. Unlike the
178 # blockcaps module this module is more flexible as it has more options
179 # for punishment and allows channels to configure their own punishment
181 #<module name="anticaps">
183 # You may also configure the characters which anticaps considers to be
184 # lower case and upper case. Any characters not listed here are assumed
185 # to be punctuation and will be ignored when counting:
186 # <anticaps lowercase="abcdefghijklmnopqrstuvwxyz"
187 # uppercase="ABCDEFGHIJKLMNOPQRSTUVWXYZ">
189 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
190 # Argon2 module: Allows other modules to generate Argon2 hashes,
191 # usually for cryptographic uses and security.
192 # This module makes the algorithms argon2i, argon2d and argon2id
194 # Note that this module is extra, and must be enabled explicitly
195 # to build. It depends on libargon2.
196 #<module name="argon2">
198 # memory: Memory hardness, in KiB. E.g. 131072 KiB = 128 MiB.
199 # iterations: Time hardness in iterations. (def. 3)
200 # lanes: How many parallel chains can be run. (def. 1)
201 # threads: Maximum amount of threads each invocation can spawn. (def. 1)
202 # length: Output length in bytes. (def. 32)
203 # saltlength: Salt length in bytes. (def. 16)
204 # version: Algorithm version, 10 or 13. (def. 13)
205 # The parameters can be customized as follows:
206 #<argon2 iterations="3" memory="131074" length="32" saltlength="16">
207 # Defines the parameters that are common for all the variants (i/d/id).
208 # Can be overridden on individual basis, e.g.
209 #<argon2i iterations="4">
210 #<argon2d memory="131074"
211 #<argon2id iterations="5" memory="262144" length="64" saltlength="32">
213 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
214 # Auditorium module: Adds channel mode +u which makes everyone else
215 # except you in the channel invisible, used for large meetings etc.
216 #<module name="auditorium">
218 # Auditorium settings:
220 #<auditorium opvisible="no" opcansee="no" opercansee="yes">
222 # opvisible (auditorium-vis in exemptchanops):
223 # Show channel ops to all users
224 # opcansee (auditorium-see in exemptchanops):
225 # Allow ops to see all joins/parts/kicks in the channel
227 # Allow opers (channels/auspex) to see see all joins/parts/kicks in the channel
229 # Exemptchanops can be used to adjust the level at which users become visible or
230 # the level at which they can see the full member list of the channel.
232 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
233 # Autoop module: Adds basic channel access controls via the +w listmode.
234 # For example +w o:*!Attila@127.0.0.1 will op anyone matching that mask
235 # on join. This can be combined with extbans, for example +w o:R:Brain
236 # will op anyone identified to the account "Brain".
237 # Another useful combination is with TLS (SSL) client certificate
238 # fingerprints: +w h:z:72db600734bb9546c1bdd02377bc21d2a9690d48 will
239 # give halfop to the user(s) having the given certificate.
240 #<module name="autoop">
242 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
243 # Ban except module: Adds support for channel ban exceptions (+e).
244 #<module name="banexception">
246 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
247 # Ban redirection module: Allows bans which redirect to a specified
248 # channel. e.g. +b nick!ident@host#channelbanneduserissentto
249 #<module name="banredirect">
251 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
252 # bcrypt module: Allows other modules to generate bcrypt hashes,
253 # usually for cryptographic uses and security.
254 #<module name="bcrypt">
256 # rounds: Defines how many rounds the bcrypt function will run when
257 # generating new hashes.
258 #<bcrypt rounds="10">
260 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
261 # Block amsg module: Attempt to block all usage of /amsg and /ame.
262 #<module name="blockamsg">
264 #-#-#-#-#-#-#-#-#-#-#- BLOCKAMSG CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
266 # If you have the blockamsg module loaded, you can configure it with #
267 # the <blockamsg> tag: #
269 # delay - How much time between two messages to force them #
270 # to be recognised as unrelated. #
271 # action - Any of 'notice', 'noticeopers', 'silent', 'kill' #
272 # or 'killopers'. Define how to take action when #
273 # a user uses /amsg or /ame. #
275 #<blockamsg delay="3" action="killopers">
277 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
278 # Block CAPS module: Adds channel mode +B, blocks all-CAPS messages.
280 # NOTE: This module is deprecated and will be removed in a future version
281 # of InspIRCd. You should use the anticaps module shown above instead.
282 #<module name="blockcaps">
284 #-#-#-#-#-#-#-#-#-#-#- BLOCKCAPS CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
286 # percent - The percentage of a message which must be upper #
287 # case before it will be blocked. #
289 # minlen - The minimum length a message must be before it #
292 # lowercase - The characters which will be considered lower #
295 # uppercase - The characters which will be considered upper #
298 #<blockcaps percent="50"
300 # lowercase="abcdefghijklmnopqrstuvwxyz"
301 # uppercase="ABCDEFGHIJKLMNOPQRSTUVWXYZ">
303 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
304 # Block color module: Blocking color-coded messages with chan mode +c.
305 #<module name="blockcolor">
307 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
308 # Botmode module: Adds the user mode +B. If set on a user, it will
309 # show that the user is a bot in /WHOIS.
310 #<module name="botmode">
312 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
313 # CallerID module: Adds user mode +g which activates hybrid-style
314 # callerid: block all private messages unless you /ACCEPT first.
315 #<module name="callerid">
317 #-#-#-#-#-#-#-#-#-#-#- CALLERID CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#
318 # maxaccepts - Maximum number of entries a user can add to their #
319 # /ACCEPT list. Default is 30 entries. #
320 # tracknick - Preserve /ACCEPT entries when a user changes nick? #
321 # If no (the default), the user is removed from #
322 # everyone's accept list if their nickname changes. #
323 # cooldown - Amount of time that must pass since the last #
324 # notification sent to a user before they can be #
325 # sent another. Default is 1 minute. #
326 #<callerid maxaccepts="30"
330 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
331 # CAP module: Provides the CAP negotiation mechanism required by the
332 # sasl, namesx, uhnames, and ircv3 modules.
333 # It is also recommended for STARTTLS support in the starttls module.
336 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
337 # CBAN module: Lets you disallow channels from being used at runtime.
338 # This module is oper-only and provides /CBAN.
339 # To use, CBAN must be in one of your oper class blocks.
340 #<module name="cban">
341 # CBAN does not allow glob channelmasks by default for compatibility
342 # reasons. You can enable glob support by uncommenting the next line.
345 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
346 # Censor module: Adds channel and user mode +G which block phrases that
347 # are listed in the server bad words list.
348 #<module name="censor">
350 #-#-#-#-#-#-#-#-#-#-#- CENSOR CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#
352 # If you have the censor module loaded you should specify one or more #
353 # phrases to replace/block in user messages. The config for this is #
354 # formatted as follows: #
356 # Replaces "eggplant" with "aubergine" within messages: #
357 # <badword text="eggplant" replace="aubergine"> #
359 # Blocks messages that contain "fluffy capybaras": #
360 #<badword text="fluffy capybaras"> #
362 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
363 # CGI:IRC module: Enables forwarding the real IP address of a user from
364 # a gateway to the IRC server.
365 #<module name="cgiirc">
367 #-#-#-#-#-#-#-#-#-#-#-# CGIIRC CONFIGURATION #-#-#-#-#-#-#-#-#-#-#-#-#
369 # If you use the cgiirc module then you must specify the gateways which
370 # are authorised to forward IP/host information to your server. There
371 # are currently two ways to do this:
373 # The webirc method is the recommended way to allow gateways to forward
374 # IP/host information. When using this method the gateway sends a WEBIRC
375 # message to the server on connection. For more details please read the
376 # IRCv3 WebIRC specification at: https://ircv3.net/specs/extensions/webirc.html
378 # When using this method you must specify one or more wildcard masks
379 # or CIDR ranges to allow gateway connections from and at least one of
380 # either a TLS (SSL) client certificate fingerprint for the gateway or
381 # a password to be sent in the WEBIRC command.
383 # <cgihost type="webirc"
384 # fingerprint="bd90547b59c1942b85f382bc059318f4c6ca54c5"
385 # mask="192.0.2.0/24 198.51.100.*">
386 # <cgihost type="webirc"
387 # password="$2a$10$WEUpX9GweJiEF1WxBDSkeODBstIBMlVPweQTG9cKM8/Vd58BeM5cW"
389 # mask="*.webirc.gateway.example.com">
391 # Alternatively if your gateway does not support sending the WEBIRC
392 # message then you can configure InspIRCd to look for the client IP
393 # address in the ident sent by the user. This is not recommended as it
394 # only works with IPv4 connections.
396 # When using this method you must specify one or more wildcard masks
397 # or CIDR ranges to allow gateway connections from. You can also
398 # optionally configure the static value that replaces the IP in the
399 # ident to avoid leaking the real IP address of gateway clients
400 # (defaults to "gateway" if not set).
402 # <cgihost type="ident"
403 # mask="198.51.100.0/24 203.0.113.*"
405 # <cgihost type="ident"
406 # mask="*.ident.gateway.example.com"
409 # By default gateway connections are logged to the +w snomask. If you
410 # do not want this to happen then you can uncomment this to disable it.
411 # <cgiirc opernotice="no">
416 # When you connect gateway clients, there are two connect classes which
417 # apply to these clients. When the client initially connects, the connect
418 # class which matches the gateway site's host is checked. Therefore you
419 # must raise the maximum local/global clients for this IP as high as you
420 # want to allow gateway clients. After the client has connected and is
421 # determined to be a gateway client, the class which matches the client's
422 # real IP is then checked. You may set this class to a lower value, so that
423 # the real IP of the client can still be restricted to, for example, 3
426 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
427 # Channel create module: Adds snomask +j, which will notify opers of
428 # any new channels that are created.
429 # This module is oper-only.
430 #<module name="chancreate">
432 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
433 # Channel filter module: Allows channel-op defined message filtering
434 # using simple string matches (channel mode +g).
435 #<module name="chanfilter">
437 # If hidemask is set to yes, the user will not be shown the mask when
438 # their message is blocked.
440 # If maxlen is set then it defines the maximum length of a filter entry.
442 # If notifyuser is set to no, the user will not be notified when
443 # their message is blocked.
444 #<chanfilter hidemask="yes" maxlen="50" notifyuser="yes">
446 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
447 # Channel history module: Displays the last 'X' lines of chat to a user
448 # joining a channel with +H 'X:T' set; 'T' is the maximum time to keep
449 # lines in the history buffer. Designed so that the new user knows what
450 # the current topic of conversation is when joining the channel.
451 #<module name="chanhistory">
453 # Set the maximum number of lines allowed to be stored per channel below.
454 # This is the hard limit for 'X'.
455 # If prefixmsg is set to yes, joining users without batch support will get
456 # a NOTICE before playback telling them about the following lines being
457 # the pre-join history.
458 # If bots is set to yes, it will also send to users marked with +B
459 #<chanhistory maxlines="50" prefixmsg="yes" bots="yes">
461 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
462 # Channel logging module: Used to send snotice output to channels, to
463 # allow staff to centrally monitor and discuss network activity.
465 # The "channel" field is where you want the messages to go, "snomasks"
466 # is what snomasks you want to be sent to that channel. Multiple tags
468 #<module name="chanlog">
469 #<chanlog snomasks="AOcC" channel="#opers">
471 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
472 # Channel names module: Allows disabling channels which have certain
473 # characters in the channel name such as bold, colorcodes, etc. which
474 # can be quite annoying and allow users to on occasion have a channel
475 # that looks like the name of another channel on the network.
476 #<module name="channames">
479 # denyrange: characters or range of characters to deny in channel
483 # allowrange: characters or range of characters to specifically allow
487 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
488 # Channelban: Implements extended ban j:, which stops anyone already
489 # in a channel matching a ban like +b j:#channel from joining.
490 # It is also possible to ban based on their status in that channel,
491 # like so: +b j:@#channel, this example prevents the ops from joining.
492 # Note that by default wildcard characters * and ? are allowed in
493 # channel names. To disallow them, load the channames module and
494 # add characters 42 and 63 to denyrange (see above).
495 #<module name="channelban">
497 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
498 # Check module: Adds the /CHECK command.
499 # Check is useful for looking up information on channels, users,
500 # IP addresses and hosts.
501 # This module is oper-only.
502 # To use, CHECK must be in one of your oper class blocks.
503 #<module name="check">
505 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
506 # CHGHOST module: Adds the /CHGHOST command.
507 # This module is oper-only.
508 # To use, CHGHOST must be in one of your oper class blocks.
509 # NOTE: Services will not be able to set vhosts on users if this module
510 # isn't loaded. If you're planning on running services, you probably
512 #<module name="chghost">
514 #-#-#-#-#-#-#-#-# /CHGHOST - /SETHOST CONFIGURATION #-#-#-#-#-#-#-#-#
515 # Optional - If you want to use special chars for hostnames you can #
516 # specify your own custom list of chars with the <hostname> tag: #
518 # charmap - A list of chars accepted as valid by the /CHGHOST #
519 # and /SETHOST commands. Also note that the list is #
521 #<hostname charmap="abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ.-_/0123456789">
523 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
524 # CHGIDENT module: Adds the /CHGIDENT command.
525 # This module is oper-only.
526 # To use, CHGIDENT must be in one of your oper class blocks.
527 #<module name="chgident">
529 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
530 # CHGNAME module: Adds the /CHGNAME command.
531 # This module is oper-only.
532 # To use, CHGNAME must be in one of your oper class blocks.
533 #<module name="chgname">
535 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
536 # Connection class ban module: Adds support for extban 'n' which
537 # matches against the class name of the user's connection.
538 # This module assumes that connection classes are named in a uniform
539 # way on all servers of the network. Wildcards are accepted.
540 #<module name="classban">
542 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
543 # Clear chan module: Allows opers to masskick, masskill or
544 # mass G/Z-line all users on a channel using /CLEARCHAN.
545 #<module name="clearchan">
547 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
548 # Cloaking module: Adds user mode +x and cloaking support.
549 # Relies on the md5 module being loaded.
550 # To cloak users when they connect, load the conn_umodes module and set
551 # <connect:modes> to include the +x mode. The example <connect> tag
552 # shows this. See the conn_umodes module for more information.
553 #<module name="cloaking">
555 #-#-#-#-#-#-#-#-#-#-#- CLOAKING CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#
557 # To use cloaking, you must define a cloak key, and optionally a #
558 # cloak prefix as shown below. The cloak key must be shared across #
559 # the network for consistent cloaking and must be at least thirty #
562 # There are two methods of cloaking: #
564 # half Cloak only the "unique" portion of a host; by #
565 # default show the last 2 parts of the domain, #
566 # /16 subnet of IPv4 or /48 subnet of the IPv6 #
568 # To change the number of shown parts, modify the #
569 # domainparts option. #
571 # full Cloak the users completely, using three slices for #
572 # common CIDR bans (IPv4: /16, /24; IPv6: /48, /64). #
574 # The methods use a single key that can be any length of text. #
575 # An optional prefix may be specified to mark cloaked hosts. #
577 # IMPORTANT: Changing these details will break all of your existing #
578 # bans. If you do not want this to happen you can define multiple #
579 # cloak tags. The first will be used for cloaking and the rest will #
580 # be used for checking if a user is banned in a channel. #
581 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
594 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
595 # Clones module: Adds an oper command /CLONES for detecting cloned
596 # users. Warning: This command may be resource intensive when it is
597 # issued, use with care.
598 # This module is oper-only.
599 # To use, CLONES must be in one of your oper class blocks.
600 #<module name="clones">
602 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
603 # Codepage module: Allows using a custom 8-bit codepage for nicknames
606 # You should include one of the following files to set your codepage:
607 #<include file="examples/codepages/ascii.conf.example">
608 #<include file="examples/codepages/latin1.conf.example">
609 #<include file="examples/codepages/rfc1459.conf.example">
610 #<include file="examples/codepages/strict-rfc1459.conf.example">
612 # You can also define a custom codepage. For details on how to do this
613 # please refer to the docs site:
614 # https://docs.inspircd.org/3/modules/codepage
616 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
617 # Common channels module: Adds user mode +c, which, when set, requires
618 # that users must share a common channel with you to PRIVMSG or NOTICE
620 #<module name="commonchans">
622 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
623 # Auto join on connect module: Allows you to force users to join one
624 # or more channels automatically upon connecting to the server, or
625 # join them in case they aren't on any channels after being online
627 #<module name="conn_join">
629 #-#-#-#-#-#-#-#-#-#-#-#- CONNJOIN CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
631 # If you have the conn_join module loaded, you can configure it below
632 # or set autojoin="#chat,#help" in <connect> blocks.
634 # Join users immediately after connection to #one #two and #three.
635 #<autojoin channel="#one,#two,#three">
636 # Join users to #chat after 15 seconds if they aren't on any channels.
637 #<autojoin channel="#chat" delay="15">
639 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
640 # Set modes on connect module: When this module is loaded <connect>
641 # blocks may have an optional modes="" value, which contains modes to
642 # add or remove from users when they connect to the server.
643 #<module name="conn_umodes">
645 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
646 # Wait for PONG on connect module: Send a PING to all connecting users
647 # and don't let them connect until they reply with a PONG.
648 # This is useful to stop certain kinds of bots and proxies.
649 #<module name="conn_waitpong">
651 #-#-#-#-#-#-#-#-#-#-#- WAITPONG CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
653 # If you have the conn_waitpong module loaded, configure it with the #
656 # sendsnotice - Whether to send a helpful notice to users on #
657 # connect telling them how to connect, should #
658 # their client not reply PONG automatically. #
660 # killonbadreply - Whether to kill the user if they send the wrong #
663 #<waitpong sendsnotice="no" killonbadreply="yes">
665 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
666 # Channel cycle module: Adds the /CYCLE command which is a server-side
667 # /HOP that bypasses restrictive modes.
668 #<module name="cycle">
670 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
671 # Connectban: Provides IP connection throttling. Any IP range that
672 # connects too many times (configurable) in an hour is Z-lined for a
673 # (configurable) duration, and their count resets to 0.
674 #<module name="connectban">
676 # ipv4cidr and ipv6cidr allow you to turn the comparison from
677 # individual IP addresses (32 and 128 bits) into CIDR masks, to allow
678 # for throttling over whole ISPs/blocks of IPs, which may be needed to
681 # This allows for 10 connections in an hour with a 10 minute ban if
683 #<connectban threshold="10" duration="10m" ipv4cidr="32" ipv6cidr="128"
684 # A custom ban message may optionally be specified.
685 # 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.">
687 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
688 # Connection throttle module.
689 #<module name="connflood">
691 #-#-#-#-#-#-#-#-#-#-#- CONNTHROTTLE CONFIGURATION -#-#-#-#-#-#-#-#-#-#
692 # period, maxconns - Amount of connections per <period>.
694 # timeout - Time to wait after the throttle was activated
695 # before deactivating it. Be aware that the time
696 # is seconds + timeout.
698 # quitmsg - The message that users get if they attempt to
699 # connect while the throttle is active.
701 # bootwait - Amount of time in seconds to wait before enforcing
702 # the throttling when the server just booted.
704 #<connflood period="30" maxconns="3" timeout="30"
705 # quitmsg="Throttled" bootwait="2m">
707 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
708 # Custom prefixes: Allows for channel prefixes to be configured.
709 #<module name="customprefix">
711 # name The name of the mode, must be unique from other modes.
712 # letter The letter used for this mode. Required.
713 # prefix The prefix used for nicks with this mode. Not required.
714 # rank A numeric rank for this prefix, defining what permissions it gives.
715 # The rank of voice, halfop and op is 10000, 20000, and 30000,
717 # ranktoset The numeric rank required to set this mode. Defaults to rank.
718 # ranktounset The numeric rank required to unset this mode. Defaults to ranktoset.
719 # depriv Can you remove the mode from yourself? Defaults to yes.
720 #<customprefix name="founder" letter="q" prefix="~" rank="50000" ranktoset="50000">
721 #<customprefix name="admin" letter="a" prefix="&" rank="40000" ranktoset="50000">
722 #<customprefix name="halfop" letter="h" prefix="%" rank="20000" ranktoset="30000">
724 # You can also override the configuration of prefix modes added by both the core
725 # and other modules by adding a customprefix tag with change="yes" specified.
726 # <customprefix name="op" change="yes" rank="30000" ranktoset="30000">
727 # <customprefix name="voice" change="yes" rank="10000" ranktoset="20000" depriv="no">
729 # Do /RELOADMODULE customprefix after changing the settings of this module.
731 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
732 # Custom title module: Adds the /TITLE command which allows for trusted
733 # users to gain a custom whois line and an optional vhost can be
735 #<module name="customtitle">
737 #-#-#-#-#-#-#-#-#-#- CUSTOM TITLE CONFIGURATION -#-#-#-#-#-#-#-#-#-#
738 # name - The username used to identify.
739 # password - The password used to identify.
740 # hash - The hash for the specific user's password (optional).
741 # password_hash and a hashing module must be loaded
743 # host - Allowed hostmask (optional).
744 # title - Title shown in whois.
745 # vhost - Displayed host (optional).
747 #<title name="foo" password="bar" title="Official Chat Helper">
748 #<title name="bar" password="foo" host="ident@test.org" title="Official Chat Helper" vhost="helper.test.org">
749 #<title name="foo" password="$2a$10$UYZ4OcO8NNTCCGyCdY9SK.2GHiqGgxZfHFPOPmWuxEVWVQTtoDC7C" hash="bcrypt" title="Official Chat Helper">
751 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
752 # DCCALLOW module: Adds the /DCCALLOW command.
753 #<module name="dccallow">
755 #-#-#-#-#-#-#-#-#-#-#- DCCALLOW CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
756 # blockchat - Whether to block DCC CHAT as well as DCC SEND.
757 # length - Default duration of entries in DCCALLOW list.
758 # action - Default action to take if no action is
759 # specified, can be 'block' or 'allow'.
760 # maxentries - Max number of nicks to allow on a DCCALLOW list.
762 # File configuration:
763 # pattern - The glob pattern to match against.
764 # action - Action to take if a user attempts to send a file
765 # that matches this pattern, can be 'block' or
768 #<dccallow blockchat="yes" length="5m" action="block" maxentries="20">
769 #<banfile pattern="*.exe" action="block">
770 #<banfile pattern="*.txt" action="allow">
772 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
773 # Deaf module: Adds support for user modes +d and +D:
774 # d - deaf to channel messages and notices.
775 # D - deaf to user messages and notices.
776 # The +D user mode is not enabled by default to enable link compatibility
778 #<module name="deaf">
780 #-#-#-#-#-#-#-#-#-#-#-#- DEAF CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#
781 # bypasschars - Characters that bypass deaf to a regular user.
782 # bypasscharsuline - Characters that bypass deaf to a U-lined user (services).
783 # Both of these take a list of characters that must match
784 # the starting character of a message.
785 # If 'bypasscharsuline' is empty, then 'bypasschars' will
786 # match for both regular and U-lined users.
787 # enableprivdeaf - Whether to enable user mode +D (privdeaf).
788 # privdeafuline - Whether U-lined users bypass user mode +D (privdeaf).
790 #<deaf bypasschars="" bypasscharsuline="!" enableprivdeaf="no" privdeafuline="yes">
792 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
793 # Delay join module: Adds the channel mode +D which delays all JOIN
794 # messages from users until they speak. If they quit or part before
795 # speaking, their quit or part message will not be shown to the channel
796 # which helps cut down noise on large channels in a more friendly way
797 # than the auditorium mode. Only channel ops may set the +D mode.
798 #<module name="delayjoin">
800 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
801 # Delay message module: Adds the channel mode +d which disallows a user
802 # from talking in the channel unless they've been joined for X seconds.
803 # Settable using /MODE #chan +d 30
804 #<module name="delaymsg">
805 # Set allownotice to no to disallow NOTICEs too. Defaults to yes.
806 #<delaymsg allownotice="no">
808 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
809 # Deny channels module: Deny channels from being used by users.
810 #<module name="denychans">
812 #-#-#-#-#-#-#-#-#-#-#- DENYCHAN DEFINITIONS -#-#-#-#-#-#-#-#-#-#-#-#
814 # If you have the denychans module loaded, you need to specify the #
815 # channels to deny: #
817 # name - The channel name to deny (glob masks are ok). #
818 # allowopers - If operators are allowed to override the deny. #
819 # reason - Reason given for the deny. #
820 # redirect - Redirect the user to a different channel. #
822 #<badchan name="#gods*" allowopers="yes" reason="Tortoises!"> #
823 #<badchan name="#chan1" redirect="#chan2" reason="Chan1 is closed"> #
825 # Redirects will not work if the target channel is set +L. #
827 # Additionally, you may specify channels which are allowed, even if #
828 # a badchan tag specifies it would be denied: #
829 #<goodchan name="#funtimes"> #
830 # Glob masks are accepted here also. #
832 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
833 # Disable module: Provides support for disabling commands and modes. #
834 #<module name="disable">
836 #-#-#-#-#-#-#-#-#-#-#-#- DISABLE CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#
838 # If you have the disable module loaded then you need to specify the #
839 # commands and modes that you want disabled. Users who have not fully #
840 # connected yet are exempt from this module so you can e.g. disable #
841 # the NICK command but still allow users to connect to the server. #
843 # commands - A space-delimited list of commands that can not be used #
844 # by users. You can exempt server operators from this with #
845 # the servers/use-disabled-commands privilege. #
847 # chanmodes - One or more channel modes that can not be added/removed #
848 # by users. You can exempt server operators from this #
849 # with the servers/use-disabled-modes privilege. #
851 # usermodes - One or more user modes that can not be added/removed by #
852 # users. You can exempt server operators from this with #
853 # the servers/use-disabled-modes privilege. #
855 # fakenonexistent - Whether to pretend that a disabled command/mode #
856 # does not exist when executed/changed by a user. #
859 # notifyopers - Whether to send a notice to snomask `a` when a user #
860 # is prevented from using a disabled command/mode. #
863 #<disabled commands="KICK TOPIC" #
866 # fakenonexistent="yes" #
867 # notifyopers="no"> #
869 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
870 # DNS blacklist module: Provides support for looking up IPs on one or #
872 #<module name="dnsbl">
874 # For configuration options please see the docs page for dnsbl at #
875 # https://docs.inspircd.org/3/modules/dnsbl. You can also use one or #
876 # more of the following example configs for popular DNSBLs: #
878 # DroneBL (https://dronebl.org) #
879 #<include file="examples/providers/dronebl.conf.example">
881 # EFnet RBL (https://rbl.efnetrbl.org) #
882 #<include file="examples/providers/efnet-rbl.conf.example">
884 # dan.me.uk Tor exit node DNSBL (https://www.dan.me.uk/dnsbl) #
885 #<include file="examples/providers/torexit.conf.example">
887 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
888 # Exempt channel operators module: Provides support for allowing #
889 # users of a specified channel status to be exempt from some channel #
890 # restriction modes. Supported restrictions are: #
891 # anticaps, auditorium-see, auditorium-vis, blockcaps, blockcolor, #
892 # censor, filter, flood, nickflood, noctcp, nonick, nonotice, #
893 # regmoderated, stripcolor, and topiclock. #
894 # See <options:exemptchanops> in inspircd.conf.example for a more #
895 # detailed list of the restriction modes that can be exempted. #
896 # These are settable using: /MODE #chan +X <restriction>:<status> #
897 # Furthermore, the exemptions configured in <options:exemptchanops> #
898 # can also be negated by using: /MODE #chan +X <restriction>:* #
899 #<module name="exemptchanops">
901 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
902 # Filter module: Provides message filtering, similar to SPAMFILTER. #
903 #<module name="filter">
905 # This module depends upon a regex provider such as regex_pcre or #
906 # regex_glob to function. You must specify which of these you want #
907 # the filter module to use via the tag below. #
909 # Valid engines are: #
911 # glob - Glob patterns, provided via regex_glob. #
912 # pcre - PCRE regexps, provided via regex_pcre, needs libpcre. #
913 # tre - TRE regexps, provided via regex_tre, requires libtre. #
914 # posix - POSIX regexps, provided via regex_posix, not available #
915 # on Windows, no dependencies on other operating systems. #
916 # stdlib - stdlib regexps, provided via regex_stdlib, see comment #
917 # at the <module> tag for info on availability. #
919 # If notifyuser is set to no, the user will not be notified when #
920 # their message is blocked. #
922 # If warnonselfmsg is set to yes when a user sends a message to #
923 # themself that matches a filter the filter will be ignored and a #
924 # warning will be sent to opers instead. This stops spambots which #
925 # send their spam message to themselves first to check if it is being #
926 # filtered by the server. #
927 #<filteropts engine="glob" notifyuser="yes" warnonselfmsg="no">
929 # Your choice of regex engine must match on all servers network-wide. #
931 # To learn more about the configuration of this module, read #
932 # examples/filter.conf.example, which covers the various types of #
933 # filters and shows how to add exemptions. #
935 #-#-#-#-#-#-#-#-#-#-#- FILTER CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#
937 # Optional - If you specify to use the filter module, then #
938 # specify below the path to the filter.conf file, or define some #
941 #<include file="examples/filter.conf.example">
943 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
944 # Flash Policy Daemon module: Allows Flash IRC clients (e.g. LightIRC)#
945 # to connect. If no file is specified, it'll serve a default policy #
946 # allowing all IPs to connect to all plaintext IRC ports #
947 #<bind address="" port="8430" type="flashpolicyd"> #
948 #<flashpolicyd timeout="5" file=""> #
949 #<module name="flashpolicyd"> #
951 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
952 # Real name ban: Implements two extended bans: #
953 # 'a', which matches a n!u@h+realname mask like +b a:*!*@host+*real* #
954 # 'r', which matches a realname mask like +b r:*realname?here* #
955 #<module name="gecosban">
957 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
958 # Geolocation ban module: Adds support for extban 'G' which matches #
959 # against the ISO 3166-1 alpha-2 codes for the countries that users #
960 # are connecting from. Users connecting from unknown origins such as #
961 # internal networks can be matched against using the XX alpha-2 code. #
962 # A full list of ISO 3166-1 alpha-2 codes can be found at #
963 # https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2 #
964 #<module name="geoban">
966 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
967 # Geolocation connect class module: Adds support for limiting connect #
968 # classes to users from specific countries. With this module you can #
969 # specify a space-delimited list of two character the ISO 3166-1 #
970 # alpha-2 codes in the "country" field of a connect class. e.g. to #
971 # deny connections from users in Russia or Turkey: #
973 # <connect deny="*" country="TR RU"> #
975 # Users connecting from unknown origins such as internal networks can #
976 # be matched against using the XX alpha-2 code. A full list of ISO #
977 # 3166-1 alpha-2 codes can be found at #
978 # https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2 #
979 #<module name="geoclass">
981 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
982 # MaxMindDB geolocation module: Provides geolocation information for #
983 # other modules that need it using the libMaxMindDB library. #
985 # This module is in extras. Re-run configure with: #
986 # ./configure --enable-extras geo_maxmind
987 # and run make install, then uncomment this module to enable it. #
989 # This module requires libMaxMindDB to be installed on your system. #
990 # Use your package manager to find the appropriate packages or check #
991 # the InspIRCd documentation page for this module. #
992 #<module name="geo_maxmind">
994 # If you use the geo_maxmind module you MUST provide a database file #
995 # to look up geolocation information in. You can either purchase this #
996 # from MaxMind at https://www.maxmind.com/en/geoip2-country-database #
997 # or use the free CC-BY-SA licensed GeoLite2 Country database which #
998 # can be downloaded at https://dev.maxmind.com/geoip/geoip2/geolite2/ #
999 #<maxmind file="GeoLite2-Country.mmdb">
1001 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1002 # Globops module: Provides the /GLOBOPS command and snomask +g.
1003 # This module is oper-only.
1004 # To use, GLOBOPS must be in one of your oper class blocks.
1005 #<module name="globops">
1007 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1008 # Global load module: Allows loading and unloading of modules network-
1009 # wide (USE WITH EXTREME CAUTION!)
1010 # This module is oper-only and provides /GLOADMODULE, /GUNLOADMODULE
1011 # and /GRELOADMODULE.
1012 # To use, GLOADMODULE, GUNLOADMODULE and GRELOADMODULE
1013 # must be in one of your oper class blocks.
1014 #<module name="globalload">
1016 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1017 # HAProxy module: Adds support for the HAProxy PROXY v2 protocol. To
1018 # use this module specify hook="haproxy" in the <bind> tag that HAProxy
1019 # has been configured to connect to.
1020 #<module name="haproxy">
1022 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1023 # HELPOP module: Provides the /HELPOP command
1024 #<module name="helpop">
1026 #-#-#-#-#-#-#-#-#-#-#-#- HELPOP CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
1028 # If you specify to use the helpop module, then specify below the #
1029 # path to the helpop.conf file. #
1031 #<include file="examples/helpop.conf.example">
1033 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1034 # Hide chans module: Allows users to hide their channels list from non-
1035 # opers by setting user mode +I on themselves.
1036 #<module name="hidechans">
1038 # This mode can optionally prevent opers from seeing channels on a +I
1039 # user, for more privacy if set to yes.
1040 # This setting is not recommended for most mainstream networks.
1041 #<hidechans affectsopers="no">
1043 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1044 # Hide list module: Allows for hiding the list of listmodes from users
1045 # who do not have sufficient channel rank.
1046 #<module name="hidelist">
1048 # Each <hidelist> tag configures one listmode to hide.
1049 # mode: Name of the listmode to hide.
1050 # rank: Minimum rank required to view the list. If set to 0, all
1051 # members of the channel may view the list, but non-members may not.
1052 # The rank of the built-in op and voice mode is 30000 and 10000,
1053 # respectively; the rank of other prefix modes is configurable.
1054 # Defaults to 20000.
1056 # Hiding the ban list is not recommended because it may break some
1059 # Hide filter (+g) list:
1060 #<hidelist mode="filter" rank="30000">
1061 # Only show invite exceptions (+I) to channel members:
1062 #<hidelist mode="invex" rank="0">
1064 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1065 # Hide mode module: Allows for hiding mode changes from users who do not
1066 # have sufficient channel privileges.
1067 #<module name="hidemode">
1069 # Hide bans (+b) from people who are not voiced:
1070 #<hidemode mode="ban" rank="10000">
1072 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1073 # Hide oper module: Allows opers to hide their oper status from non-
1074 # opers by setting user mode +H on themselves.
1075 # This module is oper-only.
1076 #<module name="hideoper">
1078 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1079 # Hostchange module: Allows a different style of cloaking.
1080 #<module name="hostchange">
1082 #-#-#-#-#-#-#-#-#-#-#- HOSTCHANGE CONFIGURATION -#-#-#-#-#-#-#-#-#-#
1084 # See https://docs.inspircd.org/3/modules/hostchange for help. #
1086 #<hostchange mask="*@42.theanswer.example.org" action="addaccount" suffix=".users.example.com">
1087 #<hostchange mask="*root@*" action="addnick" prefix="example/users/">
1088 #<hostchange mask="a@example.com" action="set" value="foo.bar.baz">
1089 #<hostchange mask="*@localhost" ports="7000,7001,7005-7007" action="set" value="blahblah.foo">
1091 # hostcycle: If loaded, when a user gets a host or ident set, it will
1092 # cycle them in all their channels. If not loaded it will simply change
1093 # their host/ident without cycling them.
1094 # This module is compatible with the ircv3_chghost module. Clients
1095 # supporting the chghost extension will get the chghost message instead
1096 # of seeing a host cycle.
1097 #<module name="hostcycle">
1099 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1100 # httpd module: Provides HTTP server support for InspIRCd.
1101 #<module name="httpd">
1103 #-#-#-#-#-#-#-#-#-#-#-#- HTTPD CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
1105 # If you choose to use the httpd module, then you will need to add
1106 # a <bind> tag with type "httpd", and load at least one of the other
1107 # httpd_* modules to provide pages to display.
1108 # <bind address="127.0.0.1" port="8067" type="httpd">
1109 # <bind address="127.0.0.1" port="8097" type="httpd" ssl="gnutls">
1111 # You can adjust the timeout for HTTP connections below. All HTTP
1112 # connections will be closed after (roughly) this time period.
1113 #<httpd timeout="20">
1115 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1116 # HTTP ACL module: Provides access control lists for httpd dependent
1117 # modules. Use this module to restrict pages by IP address and by
1119 #<module name="httpd_acl">
1121 #-#-#-#-#-#-#-#-#-#-#-#- HTTPD ACL CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
1123 # Restrict access to the httpd_stats module to all but the local
1124 # network and when the correct password is specified:
1125 # <httpdacl path="/stats*" types="password,whitelist"
1126 # username="secrets" password="mypasshere" whitelist="127.0.0.*,10.*">
1128 # Deny all connections to all but the main index page:
1129 # <httpdacl path="/*" types="blacklist" blacklist="*">
1131 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1132 # HTTP config module: Allows the server configuration to be viewed over
1133 # HTTP via the /config path. Requires the httpd module to be loaded for
1136 # IMPORTANT: This module exposes extremely sensitive information about
1137 # your server and users so you *MUST* protect it using a local-only
1138 # <bind> tag and/or the httpd_acl module. See above for details.
1139 #<module name="httpd_config">
1141 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1142 # HTTP stats module: Provides server statistics over HTTP via the /stats
1143 # path. Requires the httpd module to be loaded for it to function.
1145 # IMPORTANT: This module exposes extremely sensitive information about
1146 # your server and users so you *MUST* protect it using a local-only
1147 # <bind> tag and/or the httpd_acl module. See above for details.
1148 #<module name="httpd_stats">
1150 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1151 # Ident: Provides RFC 1413 ident lookup support.
1152 # When this module is loaded <connect:allow> tags may have an optional
1153 # useident="yes|no" boolean value, determining whether or not to lookup
1154 # ident on users matching that connect tag.
1155 #<module name="ident">
1157 #-#-#-#-#-#-#-#-#-#-#-#- IDENT CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
1159 # Optional - If you are using the ident module, then you can specify #
1160 # the timeout for ident lookups here. If not defined, it will default #
1161 # to 5 seconds. This is a non-blocking timeout which holds the user #
1162 # in a 'connecting' state until the lookup is complete. #
1163 # prefixunqueried: If yes, the idents of users in a connect class #
1164 # with ident lookups disabled (i.e. <connect useident="no">) will be #
1165 # prefixed with a "~". If no, the ident of those users will not be #
1166 # prefixed. Default is no. #
1168 #<ident timeout="5" prefixunqueried="no">
1170 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1171 # Invite exception module: Adds support for channel invite exceptions
1173 #<module name="inviteexception">
1174 # bypasskey: If this is enabled, exceptions will bypass +k as well as +i
1175 #<inviteexception bypasskey="yes">
1177 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1178 # IRCv3 module: Provides the following IRCv3 extensions:
1179 # extended-join, away-notify and account-notify. These are optional
1180 # enhancements to the client-to-server protocol. An extension is only
1181 # active for a client when the client specifically requests it, so this
1182 # module needs the cap module to work.
1184 # Further information on these extensions can be found at the IRCv3
1185 # working group website:
1186 # https://ircv3.net/irc/
1188 #<module name="ircv3">
1189 # The following block can be used to control which extensions are
1190 # enabled. Note that extended-join can be incompatible with delayjoin
1192 #<ircv3 accountnotify="yes" awaynotify="yes" extendedjoin="yes">
1194 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1195 # IRCv3 account-tag module. Adds the 'account' tag which contains the
1196 # services account name of the message sender.
1197 #<module name="ircv3_accounttag">
1199 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1200 # IRCv3 batch module: Provides the batch IRCv3 extension which allows
1201 # the server to inform a client that a group of messages are related to
1203 #<module name="ircv3_batch">
1205 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1206 # IRCv3 cap-notify module: Provides the cap-notify IRCv3 extension.
1207 # Required for IRCv3 conformance.
1208 #<module name="ircv3_capnotify">
1210 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1211 # IRCv3 chghost module: Provides the chghost IRCv3 extension which
1212 # allows capable clients to learn when the host/ident of another user
1213 # changes without cycling the user. This module is compatible with the
1214 # hostcycle module. If both are loaded, clients supporting the chghost
1215 # extension will get the chghost message and won't see host cycling.
1216 #<module name="ircv3_chghost">
1218 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1219 # IRCv3 client-to-client tags module: Provides the message-tags IRCv3
1220 # extension which allows clients to add extra data to their messages.
1221 # This is used to support new IRCv3 features such as replies and ids.
1222 #<module name="ircv3_ctctags">
1224 # If you want to only allow client tags that are intended for processing
1225 # by the server you can disable the following setting. Doing this is not
1226 # recommended though as it may break clients.
1227 #<ctctags allowclientonlytags="yes">
1229 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1230 # IRCv3 echo-message module: Provides the echo-message IRCv3
1231 # extension which allows capable clients to get an acknowledgement when
1232 # their messages are delivered and learn what modifications, if any,
1233 # were applied to them.
1234 #<module name="ircv3_echomessage">
1236 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1237 # IRCv3 invite-notify module: Provides the invite-notify IRCv3
1238 # extension which notifies supporting clients when a user invites
1239 # another user into a channel. This respects <options:announceinvites>.
1240 #<module name="ircv3_invitenotify">
1242 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1243 # IRCv3 labeled-response module: Provides the labeled-response IRCv3
1244 # extension which allows server responses to be associated with the
1245 # client message which caused them to be sent.
1246 #<module name="ircv3_labeledresponse">
1248 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1249 # IRCv3 message id module: Provides the msgid IRCv3 extension which
1250 # adds a unique identifier to each message when the message-tags cap
1251 # has been requested. This enables support for modern features such as
1252 # reactions and replies.
1253 #<module name="ircv3_msgid">
1255 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1256 # IRCv3 server-time module. Adds the 'time' tag which adds a timestamp
1257 # to all messages received from the server.
1258 #<module name="ircv3_servertime">
1260 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1261 # IRCv3 Strict Transport Security module: Provides the sts IRCv3
1262 # extension which allows clients connecting insecurely to upgrade their
1263 # connections to TLS.
1264 #<module name="ircv3_sts">
1266 # If using the ircv3_sts module you MUST define a STS policy to send
1267 # to clients using the <sts> tag. This tag takes the following
1270 # host - A glob match for the SNI hostname to apply this policy to.
1271 # duration - The amount of time that the policy lasts for. Defaults to
1272 # five minutes by default. You should raise this to a month
1273 # or two once you know that your config is valid.
1274 # port - The port on which TLS connections to the server are being
1275 # accepted. You MUST have a CA-verified certificate on this
1276 # port. Self signed certificates are not acceptable.
1277 # preload - Whether client developers can include your certificate in
1280 # <sts host="*.example.com" duration="5m" port="6697" preload="yes">
1282 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1283 # Join flood module: Adds support for join flood protection +j X:Y.
1284 # Closes the channel for N seconds if X users join in Y seconds.
1285 #<module name="joinflood">
1287 # duration: The number of seconds to close a channel for when it is
1288 # being flooded with joins.
1290 # bootwait: The number of seconds to disengage joinflood for after
1291 # a server boots. This allows users to reconnect without
1292 # being throttled by joinflood.
1294 # splitwait: The number of seconds to disengage joinflood for after
1295 # a server splits. This allows users to reconnect without
1296 # being throttled by joinflood.
1298 #<joinflood duration="1m"
1302 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1303 # Anti auto rejoin: Adds support for prevention of auto-rejoin (+J).
1304 #<module name="kicknorejoin">
1306 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1307 # Knock module: Adds the /KNOCK command and channel mode +K.
1308 #<module name="knock">
1310 # This setting specifies what to do when someone successfully /KNOCKs.
1311 # If set to "notice", then a NOTICE will be sent to the channel.
1312 # This is the default and the compatible setting, as it requires no
1313 # special support from the clients.
1314 # If set to "numeric" then a 710 numeric will be sent to the channel.
1315 # This allows easier scripting but not all clients support it.
1316 # If set to "both" then (surprise!) both will be sent.
1317 #<knock notify="notice">
1319 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1320 # LDAP module: Allows other SQL modules to access a LDAP database
1321 # through a unified API.
1322 # This modules is in extras. Re-run configure with:
1323 # ./configure --enable-extras ldap
1324 # and run make install, then uncomment this module to enable it.
1326 #<module name="ldap">
1327 #<database module="ldap" id="ldapdb" server="ldap://localhost" binddn="cn=Manager,dc=inspircd,dc=org" bindauth="mysecretpass" searchscope="subtree">
1328 # The server parameter indicates the LDAP server to connect to. The #
1329 # ldap:// style scheme before the hostname proper is MANDATORY. #
1331 # The binddn and bindauth indicate the DN to bind to for searching, #
1332 # and the password for the distinguished name. Some LDAP servers will #
1333 # allow anonymous searching in which case these two values do not #
1334 # need defining, otherwise they should be set similar to the examples #
1337 # The searchscope value indicates the subtree to search under. On our #
1338 # test system this is 'subtree'. Your mileage may vary. #
1340 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1341 # LDAP authentication module: Adds the ability to authenticate users #
1343 #<module name="ldapauth">
1347 # <ldapauth dbid="ldapdb" #
1348 # baserdn="ou=People,dc=brainbox,dc=cc" #
1350 # allowpattern="Guest* Bot*" #
1351 # killreason="Access denied" #
1353 # host="$uid.$ou.inspircd.org" #
1354 # useusername="no"> #
1356 # <ldapwhitelist cidr="10.42.0.0/16"> #
1358 # <ldaprequire attribute="attr" value="val"> #
1360 # The baserdn indicates the base DN to search in for users. Usually #
1361 # this is 'ou=People,dc=yourdomain,dc=yourtld'. #
1363 # The attribute value indicates the attribute which is used to locate #
1364 # a user account by name. On POSIX systems this is usually 'uid'. #
1366 # The allowpattern value allows you to specify a space separated list #
1367 # of wildcard masks which will always be allowed to connect #
1368 # regardless of if they have an account, for example guest and bot #
1371 # The useusername setting chooses whether the user's username or #
1372 # nickname is used when locating a user account, if a username isn't #
1373 # provided in PASS. #
1375 # Killreason indicates the QUIT reason to give to users if they fail #
1376 # to authenticate. #
1378 # Setting the verbose value causes an oper notice to be sent out for #
1379 # every failed authentication to the server, with an error string. #
1381 # ldapwhitelist indicates that clients connecting from an IP in the #
1382 # provided CIDR do not need to authenticate against LDAP. It can be #
1383 # repeated to whitelist multiple CIDRs. #
1385 # ldaprequire allows further filtering on the LDAP user, by requiring #
1386 # certain LDAP attributes to have a given value. It can be repeated, #
1387 # in which case the list will act as an OR list, that is, the #
1388 # authentication will succeed if any of the requirements in the list #
1391 # host allows you to change the displayed host of users connecting #
1392 # from ldap. The string supplied takes formatters which are replaced #
1393 # from the DN. For instance, if your DN looks like: #
1394 # uid=w00t,ou=people,dc=inspircd,dc=org, then the formatters uid, ou #
1395 # and dc will be available to you. If a key is given multiple times #
1396 # in the DN, the last appearance will take precedence. #
1398 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1399 # LDAP oper configuration module: Adds the ability to authenticate #
1401 #<module name="ldapoper">
1405 # <ldapoper dbid="ldapdb"
1406 # baserdn="ou=People,dc=brainbox,dc=cc"
1409 # Available configuration items are identical to the same items in #
1410 # ldapauth above (except for the verbose setting, that is only #
1411 # supported in ldapauth). #
1412 # Please always specify a password in your <oper> tags even if the #
1413 # opers are to be authenticated via LDAP, so in case this module is #
1414 # not loaded the oper accounts are still protected by a password. #
1416 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1417 # Lock server module: Adds /LOCKSERV and /UNLOCKSERV commands that #
1418 # are used to temporarily close/open the server for new connections. #
1419 # These commands require that the /LOCKSERV and /UNLOCKSERV commands #
1420 # are specified in a <class> tag that the oper is part of. This is so #
1421 # you can control who has access to this possible dangerous command. #
1422 # If your server is locked and you get disconnected, do a REHASH from #
1423 # shell to open up again. #
1424 # This module is oper-only.
1425 #<module name="lockserv">
1427 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1428 # Map hiding module: replaces /MAP and /LINKS output to users with a #
1429 # message to see a website, set by maphide="https://test.org/map" in #
1430 # the <security> tag, instead. #
1431 #<module name="maphide">
1433 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1434 # Message flood module: Adds message/notice flood protection via
1436 #<module name="messageflood">
1438 # The weight to give each message type. TAGMSGs are considered to be
1439 # 1/5 of a NOTICE or PRIVMSG to avoid users being accidentally flooded
1440 # out of a channel by automatic client features such as typing
1442 #<messageflood notice="1.0" privmsg="1.0" tagmsg="0.2">
1444 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1445 # MLOCK module: Adds support for server-side enforcement of services
1446 # side MLOCKs. Basically, this module suppresses any mode change that
1447 # would likely be immediately bounced by services.
1448 #<module name="mlock">
1450 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1451 # Modenotice module: Adds the /MODENOTICE command that allows opers to
1452 # send notices to all users having the given user mode(s) set.
1453 #<module name="modenotice">
1455 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1456 # Monitor module: Adds support for MONITOR which is used by clients to
1457 # maintain notify lists.
1458 #<module name="monitor">
1460 # Set the maximum number of entries on a user's monitor list below.
1461 #<monitor maxentries="30">
1463 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1464 # MySQL module: Allows other SQL modules to access MySQL databases
1465 # through a unified API.
1466 # This module is in extras. Re-run configure with:
1467 # ./configure --enable-extras mysql
1468 # and run make install, then uncomment this module to enable it.
1469 #<module name="mysql">
1471 #-#-#-#-#-#-#-#-#-#-#-#- SQL CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#-#
1473 # mysql is more complex than described here, see the docs for more #
1474 # info: https://docs.inspircd.org/3/modules/mysql #
1476 #<database module="mysql" name="mydb" user="myuser" pass="mypass" host="localhost" id="my_database2">
1478 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1479 # Named modes module: Allows for the display and set/unset of channel
1480 # modes via long-form mode names via +Z and the /PROP command.
1481 # For example, to set a ban, do /MODE #channel +Z ban=foo!bar@baz or
1482 # /PROP #channel ban=foo!bar@baz
1483 #<module name="namedmodes">
1485 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1486 # NAMESX module: Provides support for the IRCv3 multi-prefix capability
1487 # and legacy NAMESX extension which allow clients to see all the prefix
1488 # modes set on a user.
1489 #<module name="namesx">
1491 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1492 # National characters module:
1493 # 1) Allows using national characters in nicknames.
1494 # 2) Allows using custom (national) casemapping over the network.
1496 # This module is incredibly poorly written and documented. You should
1497 # probably use the codepage module instead for 8-bit codepages.
1498 #<module name="nationalchars">
1500 # file - Location of the file which contains casemapping rules. If this
1501 # is a relative path then it is relative to "<PWD>/../locales"
1502 # on UNIX and "<PWD>/locales" on Windows.
1503 # casemapping - The name of the casemapping sent to clients in the 005
1504 # numeric. If this is not set then it defaults to the name
1505 # of the casemapping file unless the file name contains a
1506 # space in which case you will have to specify it manually.
1507 #<nationalchars file="bynets/russian-w1251-charlink" casemapping="ru_RU.cp1251-charlink">
1509 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1510 # Nickchange flood protection module: Provides channel mode +F X:Y
1511 # which allows up to X nick changes in Y seconds.
1512 #<module name="nickflood">
1514 # The time period to prevent nick changes for:
1515 #<nickflood duration="1m">
1517 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1518 # Nicklock module: Let opers change a user's nick and then stop that
1519 # user from changing their nick again until unlocked.
1520 # This module is oper-only.
1521 # To use, NICKLOCK and NICKUNLOCK must be in one of your oper class blocks.
1522 #<module name="nicklock">
1524 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1525 # No CTCP module: Adds the channel mode +C and user mode +T to block
1526 # CTCPs and extban 'C' to block CTCPs sent by specific users.
1527 #<module name="noctcp">
1529 # The +T user mode is not enabled by default to enable link compatibility
1530 # with 2.0 servers. You can enable it by uncommenting this:
1531 #<noctcp enableumode="yes">
1533 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1534 # No kicks module: Adds the +Q channel mode and the Q: extban to deny
1535 # certain users from kicking.
1536 #<module name="nokicks">
1538 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1539 # No nicks module: Adds the +N channel mode, as well as the 'N' extban.
1540 # +N stops all users from changing their nick, the N extban stops
1541 # anyone from matching a +b N:nick!user@host mask from changing their
1543 #<module name="nonicks">
1545 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1546 # No part message module: Adds extban 'p' to block part messages from #
1548 #<module name="nopartmsg">
1550 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1551 # No notice module: Adds the channel mode +T and the extban 'T' to
1552 # block specific users from noticing the channel.
1553 #<module name="nonotice">
1555 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1556 # Network business join module:
1557 # Allows an oper to join a channel using /OJOIN, giving them +Y on the
1558 # channel which makes them immune to kicks.
1559 #<module name="ojoin">
1561 # Specify the prefix that +Y will grant here.
1562 # Leave 'prefix' empty if you do not wish +Y to grant a prefix.
1563 # If 'notice' is set to on, upon /OJOIN, the server will notice the
1564 # channel saying that the oper is joining on network business.
1565 # If 'op' is set to on, it will give them +o along with +Y.
1566 #<ojoin prefix="!" notice="yes" op="yes">
1568 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1569 # Oper channels mode: Adds the +O channel mode and extban O:<mask>
1570 # to ban, except, etc. specific oper types. For example
1571 # /MODE #channel +iI O:* is equivalent to channel mode +O, but you
1572 # may also set +iI O:AdminTypeOnly to only allow admins.
1573 # Modes +I and +e work in a similar fashion.
1574 #<module name="operchans">
1576 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1577 # Oper join module: Auto-joins opers to a channel upon oper-up.
1578 # This module is oper-only. For the user equivalent, see the conn_join
1580 #<module name="operjoin">
1582 #-#-#-#-#-#-#-#-#-#-# OPERJOIN CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
1584 # If you are using the operjoin module, specify options here: #
1586 # channel - The channel name to join, can also be a comma #
1587 # separated list e.g. "#channel1,#channel2". #
1589 # override - If on, lets the oper join walking thru any modes #
1590 # that might be set, even bans. #
1592 #<operjoin channel="#channel" override="no">
1594 # Alternatively you can use the autojoin="channellist" in a <type> #
1595 # tag to set specific autojoins for a type of oper, for example: #
1597 #<type name="Helper" autojoin="#help" classes="...">
1599 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1600 # Oper log module: Logs all oper commands to the server log (with log
1601 # type "m_operlog" at default loglevel), and optionally to the 'r'
1603 # This module is oper-only.
1604 #<module name="operlog">
1606 # If the following option is on then all oper commands will be sent to
1607 # the snomask 'r'. The default is no.
1608 #<operlog tosnomask="no">
1610 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1611 # Oper prefixing module: Adds a channel prefix mode +y which is given
1612 # to all server operators automatically on all channels they are in.
1613 # This prefix mode is more powerful than channel op and other regular
1616 # Load this module if you want all your server operators to have
1617 # channel operator powers.
1618 #<module name="operprefix">
1620 # You may additionally customise the prefix character.
1621 #<operprefix prefix="!">
1623 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1624 # Oper MOTD module: Provides support for a separate message of the day
1626 # This module is oper-only.
1627 #<module name="opermotd">
1629 #-#-#-#-#-#-#-#-#-#-# OPERMOTD CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
1631 # If you are using the opermotd module, specify the motd file here. #
1633 # onoper - If on, the message is sent on /OPER, otherwise it's #
1634 # only sent when /OPERMOTD is used. #
1636 #<opermotd file="examples/opermotd.txt.example" onoper="yes">
1638 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1639 # Override module: Adds support for oper override.
1640 # This module is oper-only.
1641 #<module name="override">
1643 #-#-#-#-#-#-#-#-#-#-# OVERRIDE CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
1645 # Much of override's configuration relates to your oper blocks. #
1646 # For more information on how to allow opers to override, see: #
1647 # https://docs.inspircd.org/3/modules/override #
1649 # noisy - If enabled, all oper overrides will be announced #
1650 # via channel notice. #
1652 # requirekey - If enabled, overriding on join requires a channel #
1653 # key of "override" to be specified. #
1655 # enableumode - If enabled, user mode +O is required for override. #
1657 #<override noisy="yes" requirekey="no" enableumode="yes">
1659 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1660 # Oper levels module: Gives each oper a level and prevents actions
1661 # being taken by lower level opers against higher level opers.
1662 # Specify the level as the 'level' parameter of the <type> tag.
1663 # This module is oper-only.
1664 #<module name="operlevels">
1666 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1667 # Oper modes module: Allows you to specify modes to add/remove on oper.
1668 # Specify the modes as the 'modes' parameter of the <type> tag
1669 # and/or as the 'modes' parameter of the <oper> tag.
1670 # This module is oper-only. For the user equivalent, see the
1671 # conn_umodes module.
1672 #<module name="opermodes">
1674 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1675 # Password forwarding module: Forwards a password users can send on
1676 # connect to the specified client below. The client is usually NickServ
1677 # and this module is usually used to authenticate users with NickServ
1678 # using their connect password.
1679 #<module name="passforward">
1682 # nick: nick to forward connect passwords to.
1685 # forwardmsg: Message to send to users using a connect password.
1686 # $nick will be the users' nick, $nickrequired will be the nick
1687 # of where the password is going (the nick above).
1688 # You can also use $user for the user ident string.
1689 forwardmsg="NOTICE $nick :*** Forwarding PASS to $nickrequired"
1691 # cmd: Command for the user to run when it receives a connect
1693 cmd="SQUERY $nickrequired :IDENTIFY $pass">
1695 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1696 # Password hash module: Allows hashed passwords to be used.
1697 # To be useful, a hashing module like bcrypt also needs to be loaded.
1698 #<module name="password_hash">
1700 #-#-#-#-#-#-#-#-#-# PASSWORD HASH CONFIGURATION #-#-#-#-#-#-#-#-#-#-#-#
1702 # To use this module, you must define a hash type for each oper's
1703 # password you want to hash. For example:
1705 # <oper name="Brain"
1706 # host="ident@dialup15.isp.test.com"
1708 # password="$2a$10$Mss9AtHHslZTLBrXqM0FB.JBwD.UTSu8A48SfrY9exrpxbsRiRTbO"
1711 # If you are using a hash algorithm which does not perform salting you can use
1712 # HMAC to salt your passwords in order to prevent them from being looked up in
1715 # hash="hmac-sha256" password="lkS1Nbtp$CyLd/WPQXizsbxFUTqFRoMvaC+zhOULEeZaQkUJj+Gg"
1717 # Generate hashes using the /MKPASSWD command on the server.
1718 # Don't run it on a server you don't trust with your password.
1720 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1721 # PBKDF2 module: Allows other modules to generate PBKDF2 hashes,
1722 # usually for cryptographic uses and security.
1723 # This module relies on other hash providers (e.g. SHA256).
1724 #<module name="pbkdf2">
1726 # iterations: Iterations the hashing function runs when generating new
1728 # length: Length in bytes of the derived key.
1729 #<pbkdf2 iterations="12288" length="32">
1730 # You can override these values with specific values
1731 # for specific providers if you want to. Example given for SHA256.
1732 #<pbkdf2prov hash="sha256" iterations="24576">
1734 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1735 # Permanent channels module: Channels with the permanent channel mode
1736 # will remain open even after everyone else has left the channel, and
1737 # therefore keep things like modes, ban lists and topic. Permanent
1738 # channels -may- need support from your Services package to function
1739 # properly with them. This adds channel mode +P.
1740 # This module is oper-only.
1741 #<module name="permchannels">
1743 # If you like, this module can write a config file of permanent channels
1744 # whenever +P is set, unset, or the topic/modes on a +P channel is changed.
1745 # If you want to do this, set the filename below, and uncomment the include.
1747 # If 'listmodes' is yes then all list modes (+b, +I, +e, +g...) will be
1748 # saved. Defaults to no.
1750 # 'saveperiod' determines how often to check if the database needs to be
1751 # saved to disk. Defaults to every five seconds.
1752 #<permchanneldb filename="permchannels.conf"
1755 #<include file="permchannels.conf">
1757 # You may also create channels on startup by using the <permchannels> block.
1758 #<permchannels channel="#opers" modes="isP" topic="Opers only.">
1760 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1761 # PostgreSQL module: Allows other SQL modules to access PgSQL databases
1762 # through a unified API.
1763 # This module is in extras. Re-run configure with:
1764 # ./configure --enable-extras pgsql
1765 # and run make install, then uncomment this module to enable it.
1766 #<module name="pgsql">
1768 #-#-#-#-#-#-#-#-#-#-#-#- SQL CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#-#
1770 # pgsql is more complex than described here, see the docs for #
1771 # more: https://docs.inspircd.org/3/modules/pgsql #
1773 #<database module="pgsql" name="mydb" user="myuser" pass="mypass" host="localhost" id="my_database" ssl="no">
1775 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1776 # Muteban: Implements extended ban 'm', which stops anyone matching
1777 # a mask like +b m:nick!user@host from speaking on channel.
1778 #<module name="muteban">
1780 # If notifyuser is set to no, the user will not be notified when
1781 # their message is blocked.
1782 #<muteban notifyuser="yes">
1784 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1785 # Random quote module: Provides a random quote on connect.
1786 # NOTE: Some of these may mimic fatal errors and confuse users and
1787 # opers alike - BEWARE!
1788 #<module name="randquote">
1790 #-#-#-#-#-#-#-#-#-#- RANDOMQUOTES CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
1792 # Optional - If you specify to use the randquote module, then specify #
1793 # below the path to the quotes file. #
1795 #<randquote file="quotes.txt">
1797 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1798 # Redirect module: Adds channel mode +L which redirects users to #
1799 # another channel when the channel has reached its user limit and #
1800 # user mode +L which stops redirection. #
1801 #<module name="redirect">
1803 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1804 # Regular expression provider for glob or wildcard (?/*) matching.
1805 # You must have at least 1 provider loaded to use the filter or R-line
1806 # modules. This module has no additional requirements, as it uses the
1807 # matching already present in InspIRCd core.
1808 #<module name="regex_glob">
1810 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1811 # Regular expression provider for PCRE (Perl-Compatible Regular
1812 # Expressions). You need libpcre installed to compile and load this
1813 # module. You must have at least 1 provider loaded to use the filter or
1815 #<module name="regex_pcre">
1817 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1818 # Regular Expression Provider for RE2 Regular Expressions.
1819 # You need libre2 installed and in your include/library paths in order
1820 # to compile and load this module.
1821 #<module name="regex_re2">
1823 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1824 # Regular expression provider for POSIX regular expressions.
1825 # You shouldn't need any additional libraries on a POSIX-compatible
1826 # system (i.e.: any Linux, BSD, but not Windows). You must have at
1827 # least 1 provider loaded to use the filter or R-line modules.
1828 # On POSIX-compliant systems, regex syntax can be found by using the
1829 # command: 'man 7 regex'.
1830 #<module name="regex_posix">
1832 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1833 # Regular expression provider for C++11 std::regex regular expressions.
1834 # This module works on any fully compliant implementation of the C++11
1835 # std::regex container. Examples for such are Visual C++ 2010 and newer
1836 # but not libstdc++ (which GCC uses).
1837 # You should verify that std::regex is supported by your setup before
1838 # using this module, as it may compile normally but won't do anything
1839 # on some implementations.
1840 #<module name="regex_stdlib">
1842 # Specify the regular expression engine to use here. Valid settings are
1843 # bre, ere, awk, grep, egrep, ecmascript (default if not specified).
1844 #<stdregex type="ecmascript">
1846 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1847 # Regular expression provider for TRE regular expressions.
1848 # This is the same regular expression engine used by UnrealIRCd, so
1849 # if you are most familiar with the syntax of /SPAMFILTER from there,
1850 # this is the provider you want. You need libtre installed in order
1851 # to compile and load this module.
1852 #<module name="regex_tre">
1854 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1855 # Remove module: Adds the /REMOVE command which is a peaceful
1856 # alternative to /KICK. It also provides the /FPART command which works
1857 # in the same way as /REMOVE.
1858 #<module name="remove">
1860 # supportnokicks: If yes, /REMOVE is not allowed on channels where the
1861 # nokicks (+Q) mode is set. Defaults to no.
1862 # protectedrank: Members having this rank or above may not be /REMOVE'd
1863 # by anyone. Set to 0 to disable this feature. Defaults to 50000.
1864 #<remove supportnokicks="yes" protectedrank="50000">
1866 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1867 # Repeat module: Allows to block, kick or ban upon similar messages
1868 # being uttered several times. Provides channel mode +E.
1870 # Syntax: [~|*]<lines>:<sec>[:<difference>][:<backlog>]
1871 # ~ is to block, * is to ban, default is kick.
1872 # lines - In mode 1, the amount of lines that has to match consecutively.
1873 # In mode 2, the size of the backlog to keep for matching.
1874 # seconds - How old the message has to be before it's invalidated.
1875 # difference - Edit distance, in percent, between two strings to trigger on.
1876 # backlog - When set, the function goes into mode 2. In this mode the
1877 # function will trigger if this many of the last <lines> matches.
1879 # As this module can be rather CPU-intensive, it comes with some options.
1880 # maxbacklog - Maximum size that can be specified for backlog. 0 disables
1881 # multiline matching.
1882 # maxdistance - Max percentage of difference between two lines we'll allow
1883 # to match. Set to 0 to disable edit-distance matching.
1884 # maxlines - Max lines of backlog to match against.
1885 # maxtime - Maximum period of time a user can set. 0 to allow any.
1886 # size - Maximum number of characters to check for, can be used to
1887 # truncate messages before they are checked, resulting in
1888 # less CPU usage. Increasing this beyond 512 doesn't have
1889 # any effect, as the maximum length of a message on IRC
1890 # cannot exceed that.
1891 #<repeat maxbacklog="20" maxdistance="50" maxlines="20" maxtime="0" size="512">
1892 #<module name="repeat">
1894 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1895 # Restricted channels module: Allows only opers with the
1896 # channels/restricted-create priv and/or registered users to
1899 # You probably *DO NOT* want to load this module on a public network.
1901 #<module name="restrictchans">
1903 # allowregistered: should registered users be allowed to bypass the restrictions?
1904 #<restrictchans allowregistered="no">
1906 # Allow any channel matching #user-* to be created, bypassing restrictchans checks
1907 #<allowchannel name="#user-*">
1909 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1910 # Restrict message module: Allows users to only message opers.
1912 # You probably *DO NOT* want to load this module on a public network.
1914 #<module name="restrictmsg">
1916 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1917 # R-line module: Ban users through regular expression patterns.
1918 #<module name="rline">
1920 #-#-#-#-#-#-#-#-#-#-#-#- RLINE CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#-#
1922 # If you wish to re-check a user when they change nickname (can be
1923 # useful under some situations, but *can* also use CPU with more users
1924 # on a server) then set 'matchonnickchange' to yes.
1925 # If you additionally want Z-lines to be added on matches, then
1926 # set 'zlineonmatch' to yes.
1927 # Also, this is where you set what Regular Expression engine is to be
1928 # used. If you ever change it while running, all of your R-lines will
1929 # be wiped. This is the regex engine used by all R-lines set, and
1930 # regex_<engine> must be loaded, or rline will be non-functional
1931 # until you load it or change the engine to one that is loaded.
1933 #<rline matchonnickchange="yes" zlineonmatch="no" engine="pcre">
1935 # Generally, you will NOT want to use 'glob' here, as this turns an
1936 # R-line into just another G-line. The exceptions are that R-lines will
1937 # always use the full "nick!user@host realname" string, rather than only
1938 # user@host, but beware that only the ? and * wildcards are available,
1939 # and are the only way to specify where the space can occur if you do
1940 # use glob. For this reason, is recommended to use a real regex engine
1941 # so that at least \s or [[:space:]] is available.
1943 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1944 # RMODE module: Adds the /RMODE command.
1945 # Allows channel operators to remove list modes en masse, optionally
1946 # matching a glob-based pattern.
1947 # Syntax: /RMODE <channel> <mode> [<pattern>]
1948 # E.g. '/RMODE #channel b m:*' will remove all mute extbans on the channel.
1949 #<module name="rmode">
1951 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1952 # SAJOIN module: Adds the /SAJOIN command which forcibly joins a user
1953 # to the given channel.
1954 # This module is oper-only.
1955 # To use, SAJOIN must be in one of your oper class blocks.
1956 # Opers need the users/sajoin-others priv to be able to /SAJOIN users
1957 # other than themselves.
1958 #<module name="sajoin">
1960 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1961 # SAKICK module: Adds the /SAKICK command which kicks a user from the
1963 # This module is oper-only.
1964 # To use, SAKICK must be in one of your oper class blocks.
1965 #<module name="sakick">
1967 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1968 # SAMODE module: Adds the /SAMODE command which allows server operators
1969 # to change modes on a channel without requiring them to have any
1970 # channel privileges. Also allows changing user modes for any user.
1971 # This module is oper-only.
1972 # To use, SAMODE must be in one of your oper class blocks.
1973 #<module name="samode">
1975 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1976 # SANICK module: Adds the /SANICK command which allows opers to change
1978 # This module is oper-only.
1979 # To use, SANICK must be in one of your oper class blocks.
1980 #<module name="sanick">
1982 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1983 # SAPART module: Adds the /SAPART command which forcibly parts a user
1985 # This module is oper-only.
1986 # To use, SAPART must be in one of your oper class blocks.
1987 #<module name="sapart">
1989 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1990 # SAQUIT module: Adds the /SAQUIT command which forcibly quits a user.
1991 # This module is oper-only.
1992 # To use, SAQUIT must be in one of your oper class blocks.
1993 #<module name="saquit">
1995 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1996 # SATOPIC module: Adds the /SATOPIC command which allows changing the
1997 # topic on a channel without requiring any channel privileges.
1998 # This module is oper-only.
1999 # To use, SATOPIC must be in one of your oper class blocks.
2000 #<module name="satopic">
2002 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2003 # SASL authentication module: Provides support for IRC Authentication
2004 # Layer via AUTHENTICATE. Note: You also need to have cap loaded
2006 #<module name="sasl">
2008 # You must define <sasl:target> to the name of your services server so
2009 # that InspIRCd knows where to send SASL authentication messages and
2010 #Â when it should enable the SASL capability.
2011 # You can also define <sasl:requiressl> to require users to use TLS (SSL)
2012 # in order to be able to use SASL.
2013 #<sasl target="services.mynetwork.com"
2016 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2017 # Secure list module: Prevent /LIST in the first minute of connection,
2018 # crippling most spambots and trojan spreader bots.
2019 #<module name="securelist">
2021 #-#-#-#-#-#-#-#-#-# SECURELIST CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#-#
2023 # Securelist can be harmful to some IRC search engines. To prevent #
2024 # securelist blocking these sites from listing, define exception tags #
2026 #<securehost exception="*@*.netsplit.de">
2028 # exemptregistered - Whether the waiting period applies to users who #
2029 # are logged in to a services account. #
2032 # showmsg - Whether to tell users that they need to wait for a while #
2033 # before they can use the /LIST command. #
2036 # waittime - The time period that a user must be connected for before #
2037 # they can use the /LIST command. #
2038 # Defaults to 1 minute. #
2040 #<securelist exemptregistered="yes"
2044 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2045 # Servprotect module: Provides support for Austhex style +k /
2046 # UnrealIRCD +S services mode.
2047 #<module name="servprotect">
2049 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2050 # See nicks module: Adds snomask +n and +N which show local and remote
2052 # This module is oper-only.
2053 #<module name="seenicks">
2055 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2056 # Set idle module: Adds a command for opers to change their idle time.
2057 # This module is oper-only.
2058 # To use, SETIDLE must be in one of your oper class blocks.
2059 #<module name="setidle">
2061 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2062 # Services support module: Adds several user modes such as +R and +M.
2063 # This module implements the 'identified' state via account names,
2064 # and is similar in operation to the way asuka and ircu handle services.
2066 # At the same time, this offers +r for users and channels to mark them
2067 # as identified separately from the idea of a master account, which
2068 # can be useful for services which are heavily nick-as-account centric.
2070 # Also of note is that this module implements two extbans:
2071 # +b R: (stop matching account names from joining)
2072 # +b U:n!u@h (blocks matching unregistered users)
2074 #<module name="services_account">
2076 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2077 # Sethost module: Adds the /SETHOST command.
2078 # This module is oper-only.
2079 # To use, SETHOST must be in one of your oper class blocks.
2080 # See the chghost module for how to customise valid chars for hostnames.
2081 #<module name="sethost">
2083 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2084 # Setident module: Adds the /SETIDENT command.
2085 # This module is oper-only.
2086 # To use, SETIDENT must be in one of your oper class blocks.
2087 #<module name="setident">
2089 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2090 # SETNAME module: Adds the /SETNAME command.
2091 #<module name="setname">
2093 #-#-#-#-#-#-#-#-#-#-#-#- SETNAME CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#
2095 # operonly - Whether the SETNAME command should only be usable by #
2096 # server operators. Defaults to no. #
2098 # notifyopers - Whether to send a snotice to snomask `a` when a user #
2099 # changes their real name. Defaults to to yes if #
2100 # oper-only and no if usable by everyone. #
2102 #<setname notifyopers="yes"
2105 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2106 # Serverban: Implements extended ban 's', which stops anyone connected
2107 # to a server matching a mask like +b s:server.mask.here from joining.
2108 # Wildcards are accepted.
2109 #<module name="serverban">
2111 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2112 # SHA1 module: Allows other modules to generate SHA1 hashes.
2113 # Required by the WebSocket module.
2114 #<module name="sha1">
2116 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2117 # Showfile: Provides support for showing a text file to users when #
2118 # they enter a command. #
2119 # This module adds one command for each <showfile> tag that shows the #
2120 # given file to the user as a series of messages or numerics. #
2121 #<module name="showfile">
2123 #-#-#-#-#-#-#-#-#-#-# SHOWFILE CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#-#
2125 # name - The name of the command which displays this file. This is #
2126 # the only mandatory setting, all others are optional. #
2127 # file - The text file to be shown to the user. #
2128 # By default same as the command name. #
2129 # method - How should the file be shown? #
2130 # * numeric: Send contents using a numeric #
2131 # (similar to /MOTD; the default). #
2132 # * notice: Send contents as a series of notices. #
2133 # * msg: Send contents as a series of private messages. #
2135 # When using the method "numeric", the following extra settings are #
2138 # introtext - Introductory line, "Showing <name>" by default. #
2139 # intronumeric - Numeric used for the introductory line. #
2140 # numeric - Numeric used for sending the text itself. #
2141 # endtext - Ending line, "End of <name>" by default. #
2142 # endnumeric - Numeric used for the ending line. #
2144 #<showfile name="RULES"
2146 # introtext="Server rules:"
2147 # endtext="End of server rules.">
2149 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2150 # Show whois module: Adds the +W user mode which allows opers to see
2151 # when they are /WHOIS'd.
2152 # This module is oper-only by default.
2153 #<module name="showwhois">
2155 # If you wish, you may also let users set this mode. Only opers with the
2156 # users/auspex priv will see real hosts of people, though.
2157 #<showwhois opersonly="yes"
2159 # You may also set whether or not users should receive whois notices,
2160 # should they be /WHOIS'd by an oper.
2161 #showfromopers="yes">
2163 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2164 # Shun module: Provides the /SHUN command, which stops a user from
2165 # executing all except configured commands.
2166 # This module is oper-only.
2167 # To use, SHUN must be in one of your oper class blocks.
2168 #<module name="shun">
2172 # affectopers: Whether server operators are exempt from shuns. This
2173 # option is deprecated; you should instead give exempt
2174 # server operators the servers/ignore-shun privilege.
2176 # allowtags: Whether to allow client tags to be attached to enabled
2179 # cleanedcommands: The commands that, if enabled, should be cleaned
2180 # of any message content if a shunned user tries to
2183 # enabledcommands: The commands that a shunned user is allowed to
2186 # notifyuser: Whether to notify shunned users that a command they tried
2187 # to execute has been blocked.
2189 #<shun enabledcommands="ADMIN OPER PING PONG QUIT PART JOIN"
2190 # cleanedcommands="AWAY PART QUIT"
2195 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2196 # SSL mode module: Adds support for TLS (SSL)-only channels via the '+z'
2197 # channel mode, TLS (SSL)-only private messages via the '+z' user mode and
2198 # the 'z:' extban which matches TLS (SSL) client certificate fingerprints.
2200 # Does not do anything useful without a working TLS (SSL) module and the
2201 # sslinfo module (see below).
2202 #<module name="sslmodes">
2204 # The +z user mode is not enabled by default to enable link compatibility
2205 # with 2.0 servers. You can enable it by uncommenting this:
2206 #<sslmodes enableumode="yes">
2208 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2209 # SSL rehash signal module: Allows the TLS (SSL) modules to be rehashed by
2210 # sending SIGUSR1 to a running InspIRCd process.
2211 # This module is in extras. Re-run configure with:
2212 # ./configure --enable-extras sslrehashsignal
2213 # and run make install, then uncomment this module to enable it.
2214 #<module name="sslrehashsignal">
2216 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2217 # GnuTLS SSL module: Adds support for TLS (SSL) connections using GnuTLS,
2218 # if enabled. You must answer 'yes' in ./configure when asked or
2219 # manually symlink the source for this module from the directory
2220 # src/modules/extra, if you want to enable this, or it will not load.
2221 #<module name="ssl_gnutls">
2223 #-#-#-#-#-#-#-#-#-#-#- GNUTLS CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#
2225 # ssl_gnutls is too complex to describe here, see the docs: #
2226 # https://docs.inspircd.org/3/modules/ssl_gnutls #
2228 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2229 # SSL info module: Allows users to retrieve information about other
2230 # users' peer TLS (SSL) certificates and keys via the SSLINFO command.
2231 # This can be used by client scripts to validate users. For this to
2232 # work, one of ssl_gnutls, ssl_mbedtls or ssl_openssl must be loaded.
2233 # This module also adds the "<user> is using a secure connection"
2234 # and "<user> has TLS (SSL) client certificate fingerprint <fingerprint>"
2235 # WHOIS lines, the ability for opers to use TLS (SSL) cert fingerprints to
2236 # verify their identity and the ability to force opers to use TLS (SSL)
2237 # connections in order to oper up. It is highly recommended to load
2238 # this module if you use TLS (SSL) on your network.
2239 # For how to use the oper features, please see the first
2240 # example <oper> tag in opers.conf.example.
2242 #<module name="sslinfo">
2244 # If you want to prevent users from viewing TLS (SSL) certificate information
2245 # and fingerprints of other users, set operonly to yes.
2246 #<sslinfo operonly="no">
2248 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2249 # mbedTLS TLS (SSL) module: Adds support for TLS (SSL) connections using mbedTLS.
2250 #<module name="ssl_mbedtls">
2252 #-#-#-#-#-#-#-#-#-#-#- MBEDTLS CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#
2254 # ssl_mbedtls is too complex to describe here, see the docs: #
2255 # https://docs.inspircd.org/3/modules/ssl_mbedtls #
2257 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2258 # OpenSSL TLS (SSL) module: Adds support for TLS (SSL) connections using OpenSSL,
2259 # if enabled. You must answer 'yes' in ./configure when asked or symlink
2260 # the source for this module from the directory src/modules/extra, if
2261 # you want to enable this, or it will not load.
2262 #<module name="ssl_openssl">
2264 #-#-#-#-#-#-#-#-#-#-#- OPENSSL CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#
2266 # ssl_openssl is too complex to describe here, see the docs: #
2267 # https://docs.inspircd.org/3/modules/ssl_openssl #
2269 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2270 # Strip color module: Adds channel mode +S that strips color codes and
2271 # all control codes except CTCP from all messages sent to the channel.
2272 #<module name="stripcolor">
2274 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2275 # Silence module: Adds support for the /SILENCE command, which allows
2276 # users to have a server-side ignore list for their client.
2277 #<module name="silence">
2279 # Set the maximum number of entries allowed on a user's silence list.
2280 #<silence maxentries="32"
2282 # Whether messages from U-lined servers will bypass silence masks.
2285 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2286 # SQLite3 module: Allows other SQL modules to access SQLite3 #
2287 # databases through a unified API. #
2288 # This module is in extras. Re-run configure with: #
2289 # ./configure --enable-extras sqlite3
2290 # and run make install, then uncomment this module to enable it. #
2292 #<module name="sqlite3">
2294 #-#-#-#-#-#-#-#-#-#-#-#- SQL CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#-#
2296 # sqlite is more complex than described here, see the docs for more #
2297 # info: https://docs.inspircd.org/3/modules/sqlite3 #
2299 #<database module="sqlite" hostname="/full/path/to/database.db" id="anytext">
2301 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2302 # SQL authentication module: Allows IRCd connections to be tied into
2303 # a database table (for example a forum).
2305 #<module name="sqlauth">
2307 #-#-#-#-#-#-#-#-#-#-#- SQLAUTH CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#
2309 # sqlauth is too complex to describe here, see the docs: #
2310 # https://docs.inspircd.org/3/modules/sqlauth #
2312 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2313 # SQL oper module: Allows you to store oper credentials in an SQL
2314 # table. You can add additional table columns like you would config
2315 # tags in opers.conf. Opers in opers.conf will override opers from
2318 #<module name="sqloper">
2320 #-#-#-#-#-#-#-#-#-#-#- SQLOPER CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#
2322 # dbid - Database ID to use (see SQL modules). #
2324 # See also: https://docs.inspircd.org/3/modules/sqloper #
2328 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2329 # StartTLS module: Implements STARTTLS, which allows clients #
2330 # connected to non TLS (SSL) enabled ports to enable TLS (SSL), if #
2331 # a proper TLS (SSL) module is loaded (either ssl_gnutls, #
2332 # ssl_mbedtls or ssl_openssl). #
2333 #<module name="starttls">
2335 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2336 # SVSHold module: Implements SVSHOLD. Like Q-lines, but can only be #
2337 # added/removed by Services. #
2338 #<module name="svshold">
2339 # SVSHOLD does not generate server notices by default, you can turn
2340 # notices on by uncommenting the next line.
2341 #<svshold silent="no">
2343 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2344 # SWHOIS module: Allows you to add arbitrary lines to user WHOIS.
2345 # This module is oper-only.
2346 # To use, SWHOIS must be in one of your oper class blocks.
2347 #<module name="swhois">
2349 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2350 # Timed bans module: Adds timed channel bans with the /TBAN command.
2351 #<module name="timedbans">
2352 # By default, it sends a notice to channel operators when timed ban is
2353 # set and when it is removed by server.
2354 #<timedbans sendnotice="yes">
2356 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2357 # Test line module: Adds the /TLINE command, used to test how many
2358 # users a /GLINE or /ZLINE etc. would match.
2359 # This module is oper-only.
2360 # To use, TLINE must be in one of your oper class blocks.
2361 #<module name="tline">
2363 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2364 # Topiclock module: implements server-side topic locking to achieve deeper
2365 # integration with services packages.
2366 #<module name="topiclock">
2368 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2369 # UHNAMES support module: Adds support for the IRCv3 userhost-in-names
2370 # capability and legacy UHNAMES extension which display the ident and
2371 # hostname of users in the NAMES list.
2372 #<module name="uhnames">
2374 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2375 # Uninvite module: Adds the /UNINVITE command which lets users remove
2376 # pending invites from channels without waiting for the user to join.
2377 #<module name="uninvite">
2379 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2380 # Userip module: Adds the /USERIP command.
2381 # Allows users to query their own IP, also allows opers to query the IP
2383 #<module name="userip">
2385 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2386 # Vhost module: Adds the VHOST command which allows for adding virtual
2387 # hosts which are accessible using a username and password in the config.
2388 #<module name="vhost">
2390 #-#-#-#-#-#-#-#-#-#-#- VHOST CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#-#
2392 # user - Username for the vhost. #
2394 # pass - Password for the vhost. #
2396 # hash - The hash for the specific user (optional) #
2397 # password_hash and a hashing module must be loaded for #
2400 # host - Vhost to set. #
2402 #<vhost user="some_username" pass="some_password" host="some.host.test.cc">
2403 #<vhost user="foo" password="$2a$10$iTuYLT6BRhRlOgzfsW9oPe62etW.oXwSpyKw5rJit64SGZanLXghO" hash="bcrypt" host="some.other.host.example.com">
2405 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2406 # Watch module: Adds the WATCH command, which is used by clients to
2407 # maintain notify lists.
2408 #<module name="watch">
2410 # Set the maximum number of entries on a user's watch list below.
2411 #<watch maxwatch="32">
2413 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2414 # WebSocket module: Adds HTML5 WebSocket support.
2415 # Specify hook="websocket" in a <bind> tag to make that port accept
2416 # WebSocket connections. Compatible with TLS (SSL).
2417 # Requires SHA-1 hash support available in the sha1 module.
2418 #<module name="websocket">
2420 # proxyranges: A space-delimited list of glob or CIDR matches to trust
2421 # the X-Real-IP or X-Forwarded-For headers from. If enabled
2422 # the server will use the IP address specified by those HTTP
2423 # headers. You should NOT enable this unless you are using
2424 # a HTTP proxy like nginx as it will allow IP spoofing.
2425 # sendastext: Whether to re-encode messages as UTF-8 before sending to
2426 # WebSocket clients. This is recommended as the WebSocket
2427 # protocol requires all text frames to be sent as UTF-8.
2428 # If you do not have this enabled messages will be sent as
2429 # binary frames instead.
2430 #<websocket proxyranges="192.0.2.0/24 198.51.100.*"
2433 # If you use the websocket module you MUST specify one or more origins
2434 # which are allowed to connect to the server. You should set this as
2435 # strict as possible to prevent malicious webpages from connecting to
2437 # <wsorigin allow="https://*.example.com">
2439 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2440 # X-line database: Stores all *-lines (G/Z/K/R/any added by other modules)
2441 # in a file which is re-loaded on restart. This is useful
2442 # for two reasons: it keeps bans so users may not evade them, and on
2443 # bigger networks, server connections will take less time as there will
2444 # be a lot less bans to apply - as most of them will already be there.
2445 #<module name="xline_db">
2447 # Specify the filename for the xline database and how often to check whether
2448 # the database needs to be saved here.
2449 #<xlinedb filename="xline.db" saveperiod="5s">
2451 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2452 # ____ _ _____ _ _ ____ _ _ _ #
2453 # | _ \ ___ __ _ __| | |_ _| |__ (_)___ | __ )(_) |_| | #
2454 # | |_) / _ \/ _` |/ _` | | | | '_ \| / __| | _ \| | __| | #
2455 # | _ < __/ (_| | (_| | | | | | | | \__ \ | |_) | | |_|_| #
2456 # |_| \_\___|\__,_|\__,_| |_| |_| |_|_|___/ |____/|_|\__(_) #
2458 # To link servers to InspIRCd, you MUST load the spanningtree module. #
2459 # If you don't do this, server links will NOT work at all. #
2460 # This is by design, to allow for the implementation of other linking #
2461 # protocols in modules in the future. #
2463 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2464 # Spanning tree module: Allows linking of servers using the spanning
2465 # tree protocol (see the READ THIS BIT section above).
2466 # You will almost always want to load this.
2468 #<module name="spanningtree">
projects / user / henk / code / inspircd.git / blob