1 #-#-#-#-#-#-#-#-#-#-#-#-#- MODULE OPTIONS -#-#-#-#-#-#-#-#-#-#-#-#-#
3 # These tags define which modules will be loaded on startup by your #
4 # server. Add modules without any paths. When you make your ircd #
5 # using the 'make' command, all compiled modules will be moved into #
6 # the folder you specified when you ran ./configure. The module tag #
7 # automatically looks for modules in this location. #
8 # If you attempt to load a module outside of this location, either #
9 # in the config, or via /LOADMODULE, you will receive an error. #
11 # By default, ALL modules are commented out. You must uncomment them #
12 # or add lines to your config to load modules. Please refer to #
13 # https://docs.inspircd.org/3/modules for a list of modules and #
14 # each modules link for any additional conf tags they require. #
16 # ____ _ _____ _ _ ____ _ _ _ #
17 # | _ \ ___ __ _ __| | |_ _| |__ (_)___ | __ )(_) |_| | #
18 # | |_) / _ \/ _` |/ _` | | | | '_ \| / __| | _ \| | __| | #
19 # | _ < __/ (_| | (_| | | | | | | | \__ \ | |_) | | |_|_| #
20 # |_| \_\___|\__,_|\__,_| |_| |_| |_|_|___/ |____/|_|\__(_) #
22 # To link servers to InspIRCd, you MUST load the spanningtree module. #
23 # If you don't do this, server links will NOT work at all. #
24 # This is by design, to allow for the implementation of other linking #
25 # protocols in modules in the future. This module is at the bottom of #
29 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
30 # MD5 module: Allows other modules to generate MD5 hashes, usually for
31 # cryptographic uses and security.
34 # Other modules such as cloaking and password_hash may rely on
35 # this module being loaded to function.
39 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
40 # SHA256 module: Allows other modules to generate SHA256 hashes,
41 # usually for cryptographic uses and security.
44 # Other modules such as password_hash may rely on this module being
45 # loaded to function. Certain modules such as spanningtree will
46 # function without this module but when it is loaded their features will
47 # be enhanced (for example the addition of HMAC authentication).
49 #<module name="sha256">
51 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
52 # Abbreviation module: Provides the ability to abbreviate commands a-la
54 #<module name="abbreviation">
56 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
57 # Alias module: Allows you to define server-side command aliases.
58 #<module name="alias">
60 # Set the 'prefix' for in-channel aliases (fantasy commands) to the
61 # specified character. If not set, the default is "!".
62 # If 'allowbots' is disabled, +B clients will not be able to use
63 # fantasy commands. If not set, the default is no.
64 #<fantasy prefix="!" allowbots="no">
66 #-#-#-#-#-#-#-#-#-#-#- ALIAS DEFINITIONS -#-#-#-#-#-#-#-#-#-#-#-#-#-#
68 # If you have the alias module loaded, you may also define aliases as #
69 # shown below. They are commonly used to provide shortcut commands to #
70 # services, however they are not limited to just this use. #
71 # An alias tag requires the following values to be defined in it: #
73 # text - The text to detect as the actual command line. #
74 # Can't contain spaces, but case insensitive. #
75 # You may have multiple aliases with the same #
76 # command name (text="" value), however the first #
77 # found will be executed if its format value is #
78 # matched, or it has no format value. Aliases are #
79 # read from the top of the file to the bottom. #
81 # usercommand - If this is true, the alias can be run simply as #
82 # /ALIASNAME. Defaults to true. #
84 # channelcommand - If this is true, the alias can be used as an #
85 # in-channel alias or 'fantasy command', prefixed #
86 # by the fantasy prefix character, !aliasname by #
87 # default. Defaults to false. #
89 # format - If this is defined, the parameters of the alias #
90 # must match this glob pattern. For example if you #
91 # want the first parameter to start with a # for #
92 # the alias to be executed, set format="#*" in the #
93 # alias definition. Note that the :'s which are #
94 # part of IRC formatted lines will be preserved #
95 # for matching of this text. This value is #
98 # replace - The text to replace 'text' with. Usually this #
99 # will be "PRIVMSG ServiceName :$2-" or similar. #
100 # You may use the variables $1 through $9 in the #
101 # replace string, which refer to the first through #
102 # ninth word in the original string typed by the #
103 # user. You may also use $1- through $9- which #
104 # refer to the first word onwards, through to the #
105 # ninth word onwards, e.g. if the user types the #
106 # command "foo bar baz qux quz" then $3- will hold #
107 # "baz qux quz" and $2 will contain "bar". You may #
108 # also use the special variables: $nick, $ident, #
109 # $host and $vhost, and you may separate multiple #
110 # commands with a newline (which can be written in #
111 # the file literally, or encoded as &nl; or \n #
112 # depending on the config format setting). #
114 # requires - If you provide a value for 'requires' this means #
115 # the given nickname MUST be online for the alias #
116 # to successfully trigger. If they are not, then #
117 # the user receives a 'no such nick' 401 numeric. #
119 # uline - Setting this to true will ensure that the user #
120 # given in 'requires' is also on a U-lined server, #
121 # as well as actually being on the network. If the #
122 # user is online, but not on a U-lined server, #
123 # then an oper alert is sent out as this is #
124 # possibly a sign of a user trying to impersonate #
127 # operonly - If true, this will make the alias oper only. #
128 # If a non-oper attempts to use the alias, it will #
129 # appear to not exist. #
132 # An example of using the format value to create an alias with two
133 # different behaviours depending on the format of the parameters.
135 #<alias text="ID" format="#*" replace="SQUERY ChanServ :IDENTIFY $2 $3"
136 # requires="ChanServ" uline="yes">
138 #<alias text="ID" replace="SQUERY NickServ :IDENTIFY $2"
139 # requires="NickServ" uline="yes">
141 # This alias fixes a glitch in xchat 2.6.x and above and the way it
142 # assumes IDENTIFY must be prefixed by a colon (:) character. It should
143 # be placed ABOVE the default NICKSERV alias.
145 #<alias text="NICKSERV" format=":IDENTIFY *" replace="SQUERY NickServ :IDENTIFY $3-"
146 # requires="NickServ" uline="yes">
148 # You may also add aliases to trigger based on something said in a
149 # channel, aka 'fantasy' commands, configured in the same manner as any
150 # other alias, with usercommand="no" and channelcommand="yes" The
151 # command must be preceded by the fantasy prefix when used.
153 #<alias text="CS" usercommand="no" channelcommand="yes"
154 # replace="SQUERY ChanServ :$1 $chan $2-" requires="ChanServ" uline="yes">
156 # This would be used as "!cs <command> <options>", with the channel
157 # being automatically inserted after the command in the message to
158 # ChanServ, assuming the fantasy prefix is "!".
160 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
161 # Allowinvite module: Gives channel mode +A to allow all users to use
162 # /INVITE, and extban A to deny invite from specific masks.
163 #<module name="allowinvite">
165 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
166 # Alltime module: Shows time on all connected servers at once.
167 # This module is oper-only and provides /ALLTIME.
168 # To use, ALLTIME must be in one of your oper class blocks.
169 #<module name="alltime">
171 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
172 # Anticaps module: Adds channel mode +B which allows you to punish
173 # users that send overly capitalised messages to channels. Unlike the
174 # blockcaps module this module is more flexible as it has more options
175 # for punishment and allows channels to configure their own punishment
177 #<module name="anticaps">
179 # You may also configure the characters which anticaps considers to be
180 # lower case and upper case. Any characters not listed here are assumed
181 # to be punctuation and will be ignored when counting:
182 # <anticaps lowercase="abcdefghijklmnopqrstuvwxyz"
183 # uppercase="ABCDEFGHIJKLMNOPQRSTUVWXYZ">
185 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
186 # Auditorium module: Adds channel mode +u which makes everyone else
187 # except you in the channel invisible, used for large meetings etc.
188 #<module name="auditorium">
190 # Auditorium settings:
192 #<auditorium opvisible="no" opcansee="no" opercansee="yes">
194 # opvisible (auditorium-vis in exemptchanops):
195 # Show channel ops to all users
196 # opcansee (auditorium-see in exemptchanops):
197 # Allow ops to see all joins/parts/kicks in the channel
199 # Allow opers (channels/auspex) to see see all joins/parts/kicks in the channel
201 # Exemptchanops can be used to adjust the level at which users become visible or
202 # the level at which they can see the full member list of the channel.
204 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
205 # Autoop module: Adds basic channel access controls via the +w listmode.
206 # For example +w o:*!Attila@127.0.0.1 will op anyone matching that mask
207 # on join. This can be combined with extbans, for example +w o:R:Brain
208 # will op anyone identified to the account "Brain".
209 # Another useful combination is with SSL client certificate
210 # fingerprints: +w h:z:72db600734bb9546c1bdd02377bc21d2a9690d48 will
211 # give halfop to the user(s) having the given certificate.
212 #<module name="autoop">
214 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
215 # Ban except module: Adds support for channel ban exceptions (+e).
216 #<module name="banexception">
218 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
219 # Ban redirection module: Allows bans which redirect to a specified
220 # channel. e.g. +b nick!ident@host#channelbanneduserissentto
221 #<module name="banredirect">
223 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
224 # bcrypt module: Allows other modules to generate bcrypt hashes,
225 # usually for cryptographic uses and security.
226 #<module name="bcrypt">
228 # rounds: Defines how many rounds the bcrypt function will run when
229 # generating new hashes.
230 #<bcrypt rounds="10">
232 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
233 # Block amsg module: Attempt to block all usage of /amsg and /ame.
234 #<module name="blockamsg">
236 #-#-#-#-#-#-#-#-#-#-#- BLOCKAMSG CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
238 # If you have the blockamsg module loaded, you can configure it with #
239 # the <blockamsg> tag: #
241 # delay - How much time between two messages to force them #
242 # to be recognised as unrelated. #
243 # action - Any of 'notice', 'noticeopers', 'silent', 'kill' #
244 # or 'killopers'. Define how to take action when #
245 # a user uses /amsg or /ame. #
247 #<blockamsg delay="3" action="killopers">
249 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
250 # Block CAPS module: Adds channel mode +B, blocks all-CAPS messages.
252 # NOTE: This module is deprecated and will be removed in a future version
253 # of InspIRCd. You should use the anticaps module shown above instead.
254 #<module name="blockcaps">
256 #-#-#-#-#-#-#-#-#-#-#- BLOCKCAPS CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
258 # percent - The percentage of a message which must be upper #
259 # case before it will be blocked. #
261 # minlen - The minimum length a message must be before it #
264 # lowercase - The characters which will be considered lower #
267 # uppercase - The characters which will be considered upper #
270 #<blockcaps percent="50"
272 # lowercase="abcdefghijklmnopqrstuvwxyz"
273 # uppercase="ABCDEFGHIJKLMNOPQRSTUVWXYZ">
275 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
276 # Block color module: Blocking color-coded messages with chan mode +c.
277 #<module name="blockcolor">
279 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
280 # Botmode module: Adds the user mode +B. If set on a user, it will
281 # show that the user is a bot in /WHOIS.
282 #<module name="botmode">
284 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
285 # CallerID module: Adds user mode +g which activates hybrid-style
286 # callerid: block all private messages unless you /ACCEPT first.
287 #<module name="callerid">
289 #-#-#-#-#-#-#-#-#-#-#- CALLERID CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#
290 # maxaccepts - Maximum number of entries a user can add to their #
291 # /ACCEPT list. Default is 30 entries. #
292 # tracknick - Preserve /ACCEPT entries when a user changes nick? #
293 # If no (the default), the user is removed from #
294 # everyone's accept list if their nickname changes. #
295 # cooldown - Amount of time that must pass since the last #
296 # notification sent to a user before they can be #
297 # sent another. Default is 1 minute. #
298 #<callerid maxaccepts="30"
302 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
303 # CAP module: Provides the CAP negotiation mechanism required by the
304 # sasl, namesx, uhnames, and ircv3 modules.
305 # It is also recommended for STARTTLS support in the starttls module.
308 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
309 # CBAN module: Lets you disallow channels from being used at runtime.
310 # This module is oper-only and provides /CBAN.
311 # To use, CBAN must be in one of your oper class blocks.
312 #<module name="cban">
314 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
315 # Censor module: Adds channel and user mode +G which block phrases that
316 # are listed in the server bad words list.
317 #<module name="censor">
319 #-#-#-#-#-#-#-#-#-#-#- CENSOR CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#
321 # If you have the censor module loaded you should specify one or more #
322 # phrases to replace/block in user messages. The config for this is #
323 # formatted as follows: #
325 # Replaces "eggplant" with "aubergine" within messages: #
326 # <badword text="eggplant" replace="aubergine"> #
328 # Blocks messages that contain "fluffy capybaras": #
329 #<badword text="fluffy capybaras"> #
331 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
332 # CGI:IRC module: Enables forwarding the real IP address of a user from
333 # a gateway to the IRC server.
334 #<module name="cgiirc">
336 #-#-#-#-#-#-#-#-#-#-#-# CGIIRC CONFIGURATION #-#-#-#-#-#-#-#-#-#-#-#-#
338 # If you use the cgiirc module then you must specify the gateways which
339 # are authorised to forward IP/host information to your server. There
340 # are currently two ways to do this:
342 # The webirc method is the recommended way to allow gateways to forward
343 # IP/host information. When using this method the gateway sends a WEBIRC
344 # message to the server on connection. For more details please read the
345 # IRCv3 WebIRC specification at: https://ircv3.net/specs/extensions/webirc.html
347 # When using this method you must specify a wildcard mask or CIDR range
348 # to allow gateway connections from and at least one of either a SSL
349 # client certificate fingerprint for the gateway or a password to be
350 # sent in the WEBIRC command.
352 # <cgihost type="webirc"
353 # fingerprint="bd90547b59c1942b85f382bc059318f4c6ca54c5"
354 # mask="192.0.2.0/24">
355 # <cgihost type="webirc"
356 # password="$2a$10$WEUpX9GweJiEF1WxBDSkeODBstIBMlVPweQTG9cKM8/Vd58BeM5cW"
358 # mask="*.webirc.gateway.example.com">
360 # Alternatively if your gateway does not support sending the WEBIRC
361 # message then you can configure InspIRCd to look for the client IP
362 # address in the ident sent by the user. This is not recommended as it
363 # only works with IPv4 connections.
365 # When using this method you must specify a wildcard mask or CIDR range to allow
366 # gateway connections from. You can also optionally configure the static value
367 # that replaces the IP in the ident to avoid leaking the real IP address of
368 # gateway clients (defaults to "gateway" if not set).
370 # <cgihost type="ident"
371 # mask="198.51.100.0/24"
373 # <cgihost type="ident"
374 # mask="*.ident.gateway.example.com"
377 # By default gateway connections are logged to the +w snomask. If you
378 # do not want this to happen then you can uncomment this to disable it.
379 # <cgiirc opernotice="no">
384 # When you connect gateway clients, there are two connect classes which
385 # apply to these clients. When the client initially connects, the connect
386 # class which matches the gateway site's host is checked. Therefore you
387 # must raise the maximum local/global clients for this IP as high as you
388 # want to allow gateway clients. After the client has connected and is
389 # determined to be a gateway client, the class which matches the client's
390 # real IP is then checked. You may set this class to a lower value, so that
391 # the real IP of the client can still be restricted to, for example, 3
394 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
395 # Channel create module: Adds snomask +j, which will notify opers of
396 # any new channels that are created.
397 # This module is oper-only.
398 #<module name="chancreate">
400 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
401 # Channel filter module: Allows channel-op defined message filtering
402 # using simple string matches (channel mode +g).
403 #<module name="chanfilter">
405 # If hidemask is set to yes, the user will not be shown the mask when
406 # their message is blocked.
408 # If maxlen is set then it defines the maximum length of a filter entry.
410 # If notifyuser is set to no, the user will not be notified when
411 # their message is blocked.
412 #<chanfilter hidemask="yes" maxlen="50" notifyuser="yes">
414 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
415 # Channel history module: Displays the last 'X' lines of chat to a user
416 # joining a channel with +H 'X:T' set; 'T' is the maximum time to keep
417 # lines in the history buffer. Designed so that the new user knows what
418 # the current topic of conversation is when joining the channel.
419 #<module name="chanhistory">
421 # Set the maximum number of lines allowed to be stored per channel below.
422 # This is the hard limit for 'X'.
423 # If notice is set to yes, joining users will get a NOTICE before playback
424 # telling them about the following lines being the pre-join history.
425 # If bots is set to yes, it will also send to users marked with +B
426 #<chanhistory maxlines="50" notice="yes" bots="yes">
428 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
429 # Channel logging module: Used to send snotice output to channels, to
430 # allow staff to centrally monitor and discuss network activity.
432 # The "channel" field is where you want the messages to go, "snomasks"
433 # is what snomasks you want to be sent to that channel. Multiple tags
435 #<module name="chanlog">
436 #<chanlog snomasks="AOcC" channel="#opers">
438 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
439 # Channel names module: Allows disabling channels which have certain
440 # characters in the channel name such as bold, colorcodes, etc. which
441 # can be quite annoying and allow users to on occasion have a channel
442 # that looks like the name of another channel on the network.
443 #<module name="channames">
446 # denyrange: characters or range of characters to deny in channel
450 # allowrange: characters or range of characters to specifically allow
454 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
455 # Channelban: Implements extended ban j:, which stops anyone already
456 # in a channel matching a ban like +b j:#channel from joining.
457 # It is also possible to ban based on their status in that channel,
458 # like so: +b j:@#channel, this example prevents the ops from joining.
459 # Note that by default wildcard characters * and ? are allowed in
460 # channel names. To disallow them, load the channames module and
461 # add characters 42 and 63 to denyrange (see above).
462 #<module name="channelban">
464 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
465 # Check module: Adds the /CHECK command.
466 # Check is useful for looking up information on channels, users,
467 # IP addresses and hosts.
468 # This module is oper-only.
469 # To use, CHECK must be in one of your oper class blocks.
470 #<module name="check">
472 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
473 # CHGHOST module: Adds the /CHGHOST command.
474 # This module is oper-only.
475 # To use, CHGHOST must be in one of your oper class blocks.
476 # NOTE: Services will not be able to set vhosts on users if this module
477 # isn't loaded. If you're planning on running services, you probably
479 #<module name="chghost">
481 #-#-#-#-#-#-#-#-# /CHGHOST - /SETHOST CONFIGURATION #-#-#-#-#-#-#-#-#
482 # Optional - If you want to use special chars for hostnames you can #
483 # specify your own custom list of chars with the <hostname> tag: #
485 # charmap - A list of chars accepted as valid by the /CHGHOST #
486 # and /SETHOST commands. Also note that the list is #
488 #<hostname charmap="abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ.-_/0123456789">
490 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
491 # CHGIDENT module: Adds the /CHGIDENT command.
492 # This module is oper-only.
493 # To use, CHGIDENT must be in one of your oper class blocks.
494 #<module name="chgident">
496 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
497 # CHGNAME module: Adds the /CHGNAME command.
498 # This module is oper-only.
499 # To use, CHGNAME must be in one of your oper class blocks.
500 #<module name="chgname">
502 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
503 # Connection class ban module: Adds support for extban 'n' which
504 # matches against the class name of the user's connection.
505 # This module assumes that connection classes are named in a uniform
506 # way on all servers of the network. Wildcards are accepted.
507 #<module name="classban">
509 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
510 # Clear chan module: Allows opers to masskick, masskill or
511 # mass G/Z-line all users on a channel using /CLEARCHAN.
512 #<module name="clearchan">
514 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
515 # Cloaking module: Adds user mode +x and cloaking support.
516 # Relies on the md5 module being loaded.
517 # To cloak users when they connect, load the conn_umodes module and set
518 # <connect:modes> to include the +x mode. The example <connect> tag
519 # shows this. See the conn_umodes module for more information.
520 #<module name="cloaking">
522 #-#-#-#-#-#-#-#-#-#-#- CLOAKING CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#
524 # To use cloaking, you must define a cloak key, and optionally a #
525 # cloak prefix as shown below. The cloak key must be shared across #
526 # the network for consistent cloaking and must be at least thirty #
529 # There are two methods of cloaking: #
531 # half Cloak only the "unique" portion of a host; by #
532 # default show the last 2 parts of the domain, #
533 # /16 subnet of IPv4 or /48 subnet of the IPv6 #
535 # To change the number of shown parts, modify the #
536 # domainparts option. #
538 # full Cloak the users completely, using three slices for #
539 # common CIDR bans (IPv4: /16, /24; IPv6: /48, /64). #
541 # The methods use a single key that can be any length of text. #
542 # An optional prefix may be specified to mark cloaked hosts. #
544 # IMPORTANT: Changing these details will break all of your existing #
545 # bans. If you do not want this to happen you can define multiple #
546 # cloak tags. The first will be used for cloaking and the rest will #
547 # be used for checking if a user is banned in a channel. #
548 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
559 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
560 # Clones module: Adds an oper command /CLONES for detecting cloned
561 # users. Warning: This command may be resource intensive when it is
562 # issued, use with care.
563 # This module is oper-only.
564 # To use, CLONES must be in one of your oper class blocks.
565 #<module name="clones">
567 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
568 # Common channels module: Adds user mode +c, which, when set, requires
569 # that users must share a common channel with you to PRIVMSG or NOTICE
571 #<module name="commonchans">
573 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
574 # Auto join on connect module: Allows you to force users to join one
575 # or more channels automatically upon connecting to the server, or
576 # join them in case they aren't on any channels after being online
578 #<module name="conn_join">
580 #-#-#-#-#-#-#-#-#-#-#-#- CONNJOIN CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
582 # If you have the conn_join module loaded, you can configure it below
583 # or set autojoin="#chat,#help" in <connect> blocks.
585 # Join users immediately after connection to #one #two and #three.
586 #<autojoin channel="#one,#two,#three">
587 # Join users to #chat after 15 seconds if they aren't on any channels.
588 #<autojoin channel="#chat" delay="15">
590 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
591 # Set modes on connect module: When this module is loaded <connect>
592 # blocks may have an optional modes="" value, which contains modes to
593 # add or remove from users when they connect to the server.
594 #<module name="conn_umodes">
596 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
597 # Wait for PONG on connect module: Send a PING to all connecting users
598 # and don't let them connect until they reply with a PONG.
599 # This is useful to stop certain kinds of bots and proxies.
600 #<module name="conn_waitpong">
602 #-#-#-#-#-#-#-#-#-#-#- WAITPONG CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
604 # If you have the conn_waitpong module loaded, configure it with the #
607 # sendsnotice - Whether to send a helpful notice to users on #
608 # connect telling them how to connect, should #
609 # their client not reply PONG automatically. #
611 # killonbadreply - Whether to kill the user if they send the wrong #
614 #<waitpong sendsnotice="yes" killonbadreply="yes">
616 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
617 # Channel cycle module: Adds the /CYCLE command which is a server-side
618 # /HOP that bypasses restrictive modes.
619 #<module name="cycle">
621 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
622 # Connectban: Provides IP connection throttling. Any IP range that
623 # connects too many times (configurable) in an hour is Z-lined for a
624 # (configurable) duration, and their count resets to 0.
625 #<module name="connectban">
627 # ipv4cidr and ipv6cidr allow you to turn the comparison from
628 # individual IP addresses (32 and 128 bits) into CIDR masks, to allow
629 # for throttling over whole ISPs/blocks of IPs, which may be needed to
632 # This allows for 10 connections in an hour with a 10 minute ban if
634 #<connectban threshold="10" duration="10m" ipv4cidr="32" ipv6cidr="128"
635 # A custom ban message may optionally be specified.
636 # 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.">
638 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
639 # Connection throttle module.
640 #<module name="connflood">
642 #-#-#-#-#-#-#-#-#-#-#- CONNTHROTTLE CONFIGURATION -#-#-#-#-#-#-#-#-#-#
643 # period, maxconns - Amount of connections per <period>.
645 # timeout - Time to wait after the throttle was activated
646 # before deactivating it. Be aware that the time
647 # is seconds + timeout.
649 # quitmsg - The message that users get if they attempt to
650 # connect while the throttle is active.
652 # bootwait - Amount of time in seconds to wait before enforcing
653 # the throttling when the server just booted.
655 #<connflood period="30" maxconns="3" timeout="30"
656 # quitmsg="Throttled" bootwait="10">
658 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
659 # Custom prefixes: Allows for channel prefixes to be configured.
660 #<module name="customprefix">
662 # name The name of the mode, must be unique from other modes.
663 # letter The letter used for this mode. Required.
664 # prefix The prefix used for nicks with this mode. Not required.
665 # rank A numeric rank for this prefix, defining what permissions it gives.
666 # The rank of voice, halfop and op is 10000, 20000, and 30000,
668 # ranktoset The numeric rank required to set this mode. Defaults to rank.
669 # ranktounset The numeric rank required to unset this mode. Defaults to ranktoset.
670 # depriv Can you remove the mode from yourself? Defaults to yes.
671 #<customprefix name="founder" letter="q" prefix="~" rank="50000" ranktoset="50000">
672 #<customprefix name="admin" letter="a" prefix="&" rank="40000" ranktoset="50000">
673 #<customprefix name="halfop" letter="h" prefix="%" rank="20000" ranktoset="30000">
675 # You can also override the configuration of prefix modes added by both the core
676 # and other modules by adding a customprefix tag with change="yes" specified.
677 # <customprefix name="op" change="yes" rank="30000" ranktoset="30000">
678 # <customprefix name="voice" change="yes" rank="10000" ranktoset="10000" depriv="no">
680 # Do /RELOADMODULE customprefix after changing the settings of this module.
682 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
683 # Custom title module: Adds the /TITLE command which allows for trusted
684 # users to gain a custom whois line and an optional vhost can be
686 #<module name="customtitle">
688 #-#-#-#-#-#-#-#-#-#- CUSTOM TITLE CONFIGURATION -#-#-#-#-#-#-#-#-#-#
689 # name - The username used to identify.
690 # password - The password used to identify.
691 # hash - The hash for the specific user's password (optional).
692 # password_hash and a hashing module must be loaded
694 # host - Allowed hostmask (optional).
695 # title - Title shown in whois.
696 # vhost - Displayed host (optional).
698 #<title name="foo" password="bar" title="Official Chat Helper">
699 #<title name="bar" password="foo" host="ident@test.org" title="Official Chat Helper" vhost="helper.test.org">
700 #<title name="foo" password="$2a$10$UYZ4OcO8NNTCCGyCdY9SK.2GHiqGgxZfHFPOPmWuxEVWVQTtoDC7C" hash="bcrypt" title="Official Chat Helper">
702 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
703 # DCCALLOW module: Adds the /DCCALLOW command.
704 #<module name="dccallow">
706 #-#-#-#-#-#-#-#-#-#-#- DCCALLOW CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
707 # blockchat - Whether to block DCC CHAT as well as DCC SEND.
708 # length - Default duration of entries in DCCALLOW list.
709 # action - Default action to take if no action is
710 # specified, can be 'block' or 'allow'.
711 # maxentries - Max number of nicks to allow on a DCCALLOW list.
713 # File configuration:
714 # pattern - The glob pattern to match against.
715 # action - Action to take if a user attempts to send a file
716 # that matches this pattern, can be 'block' or
719 #<dccallow blockchat="yes" length="5m" action="block" maxentries="20">
720 #<banfile pattern="*.exe" action="block">
721 #<banfile pattern="*.txt" action="allow">
723 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
724 # Deaf module: Adds support for user modes +d and +D:
725 # d - deaf to channel messages and notices.
726 # D - deaf to user messages and notices.
727 # The +D user mode is not enabled by default to enable link compatibility
729 #<module name="deaf">
731 #-#-#-#-#-#-#-#-#-#-#-#- DEAF CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#
732 # bypasschars - Characters that bypass deaf to a regular user.
733 # bypasscharsuline - Characters that bypass deaf to a U-lined user (services).
734 # Both of these take a list of characters that must match
735 # the starting character of a message.
736 # If 'bypasscharsuline' is empty, then 'bypasschars' will
737 # match for both regular and U-lined users.
738 # enableprivdeaf - Whether to enable user mode +D (privdeaf).
739 # privdeafuline - Whether U-lined users bypass user mode +D (privdeaf).
741 #<deaf bypasschars="" bypasscharsuline="!" enableprivdeaf="no" privdeafuline="yes">
743 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
744 # Delay join module: Adds the channel mode +D which delays all JOIN
745 # messages from users until they speak. If they quit or part before
746 # speaking, their quit or part message will not be shown to the channel
747 # which helps cut down noise on large channels in a more friendly way
748 # than the auditorium mode. Only channel ops may set the +D mode.
749 #<module name="delayjoin">
751 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
752 # Delay message module: Adds the channel mode +d which disallows a user
753 # from talking in the channel unless they've been joined for X seconds.
754 # Settable using /MODE #chan +d 30
755 #<module name="delaymsg">
756 # Set allownotice to no to disallow NOTICEs too. Defaults to yes.
757 #<delaymsg allownotice="no">
759 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
760 # Deny channels module: Deny channels from being used by users.
761 #<module name="denychans">
763 #-#-#-#-#-#-#-#-#-#-#- DENYCHAN DEFINITIONS -#-#-#-#-#-#-#-#-#-#-#-#
765 # If you have the denychans module loaded, you need to specify the #
766 # channels to deny: #
768 # name - The channel name to deny (glob masks are ok). #
769 # allowopers - If operators are allowed to override the deny. #
770 # reason - Reason given for the deny. #
771 # redirect - Redirect the user to a different channel. #
773 #<badchan name="#gods*" allowopers="yes" reason="Tortoises!"> #
774 #<badchan name="#chan1" redirect="#chan2" reason="Chan1 is closed"> #
776 # Redirects will not work if the target channel is set +L. #
778 # Additionally, you may specify channels which are allowed, even if #
779 # a badchan tag specifies it would be denied: #
780 #<goodchan name="#funtimes"> #
781 # Glob masks are accepted here also. #
783 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
784 # Disable module: Provides support for disabling commands and modes. #
785 #<module name="disable">
787 #-#-#-#-#-#-#-#-#-#-#-#- DISABLE CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#
789 # If you have the disable module loaded then you need to specify the #
790 # commands and modes that you want disabled. Users who have not fully #
791 # connected yet are exempt from this module so you can e.g. disable #
792 # the NICK command but still allow users to connect to the server. #
794 # commands - A space-delimited list of commands that can not be used #
795 # by users. You can exempt server operators from this with #
796 # the servers/use-disabled-commands privilege. #
798 # chanmodes - One or more channel modes that can not be added/removed #
799 # by users. You can exempt server operators from this #
800 # with the servers/use-disabled-modes privilege. #
802 # usermodes - One or more user modes that can not be added/removed by #
803 # users. You can exempt server operators from this with #
804 # the servers/use-disabled-modes privilege. #
806 # fakenonexistent - Whether to pretend that a disabled command/mode #
807 # does not exist when executed/changed by a user. #
810 # notifyopers - Whether to send a notice to snomask `a` when a user #
811 # is prevented from using a disabled command/mode. #
814 #<disabled commands="KICK TOPIC" #
817 # fakenonexistent="yes" #
818 # notifyopers="no"> #
820 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
821 # DNS blacklist module: Provides support for looking up IPs on one or #
823 #<module name="dnsbl">
825 # For configuration options please see the docs page for dnsbl at #
826 # https://docs.inspircd.org/3/modules/dnsbl #
828 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
829 # Exempt channel operators module: Provides support for allowing #
830 # users of a specified channel status to be exempt from some channel #
831 # restriction modes. Supported restrictions are: #
832 # anticaps, auditorium-see, auditorium-vis, blockcaps, blockcolor, #
833 # censor, filter, flood, nickflood, noctcp, nonick, nonotice, #
834 # regmoderated, stripcolor, and topiclock. #
835 # See <options:exemptchanops> in inspircd.conf.example for a more #
836 # detailed list of the restriction modes that can be exempted. #
837 # These are settable using: /MODE #chan +X <restriction>:<status> #
838 #<module name="exemptchanops">
840 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
841 # Filter module: Provides message filtering, similar to SPAMFILTER. #
842 #<module name="filter">
844 # This module depends upon a regex provider such as regex_pcre or #
845 # regex_glob to function. You must specify which of these you want #
846 # the filter module to use via the tag below. #
848 # Valid engines are: #
850 # glob - Glob patterns, provided via regex_glob. #
851 # pcre - PCRE regexps, provided via regex_pcre, needs libpcre. #
852 # tre - TRE regexps, provided via regex_tre, requires libtre. #
853 # posix - POSIX regexps, provided via regex_posix, not available #
854 # on Windows, no dependencies on other operating systems. #
855 # stdlib - stdlib regexps, provided via regex_stdlib, see comment #
856 # at the <module> tag for info on availability. #
858 # If notifyuser is set to no, the user will not be notified when #
859 # their message is blocked. #
861 # If warnonselfmsg is set to yes when a user sends a message to #
862 # themself that matches a filter the filter will be ignored and a #
863 # warning will be sent to opers instead. This stops spambots which #
864 # send their spam message to themselves first to check if it is being #
865 # filtered by the server. #
866 #<filteropts engine="glob" notifyuser="yes" warnonselfmsg="no">
868 # Your choice of regex engine must match on all servers network-wide. #
870 # To learn more about the configuration of this module, read #
871 # examples/filter.conf.example, which covers the various types of #
872 # filters and shows how to add exemptions. #
874 #-#-#-#-#-#-#-#-#-#-#- FILTER CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#
876 # Optional - If you specify to use the filter module, then #
877 # specify below the path to the filter.conf file, or define some #
880 #<include file="examples/filter.conf.example">
882 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
883 # Flash Policy Daemon module: Allows Flash IRC clients (e.g. LightIRC)#
884 # to connect. If no file is specified, it'll serve a default policy #
885 # allowing all IPs to connect to all plaintext IRC ports #
886 #<bind address="" port="8430" type="flashpolicyd"> #
887 #<flashpolicyd timeout="5" file=""> #
888 #<module name="flashpolicyd"> #
890 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
891 # Real name ban: Implements two extended bans: #
892 # 'a', which matches a n!u@h+realname mask like +b a:*!*@host+*real* #
893 # 'r', which matches a realname mask like +b r:*realname?here* #
894 #<module name="gecosban">
896 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
897 # Geolocation ban module: Adds support for extban 'G' which matches #
898 # against the ISO 3166-1 alpha-2 codes for the countries that users #
899 # are connecting from. Users connecting from unknown origins such as #
900 # internal networks can be matched against using the XX alpha-2 code. #
901 # A full list of ISO 3166-1 alpha-2 codes can be found at #
902 # https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2 #
903 #<module name="geoban">
905 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
906 # Geolocation connect class module: Adds support for limiting connect #
907 # classes to users from specific countries. With this module you can #
908 # specify a space-delimited list of two character the ISO 3166-1 #
909 # alpha-2 codes in the "country" field of a connect class. e.g. to #
910 # deny connections from users in Russia or Turkey: #
912 # <connect deny="*" country="TR RU"> #
914 # Users connecting from unknown origins such as internal networks can #
915 # be matched against using the XX alpha-2 code. A full list of ISO #
916 # 3166-1 alpha-2 codes can be found at #
917 # https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2 #
918 #<module name="geoclass">
920 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
921 # MaxMindDB geolocation module: Provides geolocation information for #
922 # other modules that need it using the libMaxMindDB library. #
924 # This module is in extras. Re-run configure with: #
925 # ./configure --enable-extras=m_geo_maxmind.cpp
926 # and run make install, then uncomment this module to enable it. #
928 # This module requires libMaxMindDB to be installed on your system. #
929 # Use your package manager to find the appropriate packages or check #
930 # the InspIRCd documentation page for this module. #
931 #<module name="geo_maxmind">
933 # If you use the geo_maxmind module you MUST provide a database file #
934 # to look up geolocation information in. You can either purchase this #
935 # from MaxMind at https://www.maxmind.com/en/geoip2-country-database #
936 # or use the free CC-BY-SA licensed GeoLite2 Country database which #
937 # can be downloaded at https://dev.maxmind.com/geoip/geoip2/geolite2/ #
938 #<maxmind file="GeoLite2-Country.mmdb">
940 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
941 # Globops module: Provides the /GLOBOPS command and snomask +g.
942 # This module is oper-only.
943 # To use, GLOBOPS must be in one of your oper class blocks.
944 #<module name="globops">
946 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
947 # Global load module: Allows loading and unloading of modules network-
948 # wide (USE WITH EXTREME CAUTION!)
949 # This module is oper-only and provides /GLOADMODULE, /GUNLOADMODULE
950 # and /GRELOADMODULE.
951 # To use, GLOADMODULE, GUNLOADMODULE and GRELOADMODULE
952 # must be in one of your oper class blocks.
953 #<module name="globalload">
955 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
956 # HAProxy module: Adds support for the HAProxy PROXY v2 protocol. To
957 # use this module specify hook="haproxy" in the <bind> tag that HAProxy
958 # has been configured to connect to.
959 #<module name="haproxy">
961 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
962 # HELPOP module: Provides the /HELPOP command
963 #<module name="helpop">
965 #-#-#-#-#-#-#-#-#-#-#-#- HELPOP CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
967 # If you specify to use the helpop module, then specify below the #
968 # path to the helpop.conf file. #
970 #<include file="examples/helpop.conf.example">
972 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
973 # Hide chans module: Allows users to hide their channels list from non-
974 # opers by setting user mode +I on themselves.
975 #<module name="hidechans">
977 # This mode can optionally prevent opers from seeing channels on a +I
978 # user, for more privacy if set to true.
979 # This setting is not recommended for most mainstream networks.
980 #<hidechans affectsopers="false">
982 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
983 # Hide list module: Allows for hiding the list of listmodes from users
984 # who do not have sufficient channel rank.
985 #<module name="hidelist">
987 # Each <hidelist> tag configures one listmode to hide.
988 # mode: Name of the listmode to hide.
989 # rank: Minimum rank required to view the list. If set to 0, all
990 # members of the channel may view the list, but non-members may not.
991 # The rank of the built-in op and voice mode is 30000 and 10000,
992 # respectively; the rank of other prefix modes is configurable.
995 # Hiding the ban list is not recommended because it may break some
998 # Hide filter (+g) list:
999 #<hidelist mode="filter" rank="30000">
1000 # Only show invite exceptions (+I) to channel members:
1001 #<hidelist mode="invex" rank="0">
1003 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1004 # Hide mode module: Allows for hiding mode changes from users who do not
1005 # have sufficient channel privileges.
1006 #<module name="hidemode">
1008 # Hide bans (+b) from people who are not voiced:
1009 #<hidemode mode="ban" rank="10000">
1011 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1012 # Hide oper module: Allows opers to hide their oper status from non-
1013 # opers by setting user mode +H on themselves.
1014 # This module is oper-only.
1015 #<module name="hideoper">
1017 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1018 # Hostchange module: Allows a different style of cloaking.
1019 #<module name="hostchange">
1021 #-#-#-#-#-#-#-#-#-#-#- HOSTCHANGE CONFIGURATION -#-#-#-#-#-#-#-#-#-#
1023 # See https://docs.inspircd.org/3/modules/hostchange for help. #
1025 #<hostchange mask="*@42.theanswer.example.org" action="addaccount" suffix=".users.example.com">
1026 #<hostchange mask="*root@*" action="addnick" prefix="example/users/">
1027 #<hostchange mask="a@example.com" action="set" value="foo.bar.baz">
1028 #<hostchange mask="*@localhost" ports="7000,7001,7005-7007" action="set" value="blahblah.foo">
1030 # hostcycle: If loaded, when a user gets a host or ident set, it will
1031 # cycle them in all their channels. If not loaded it will simply change
1032 # their host/ident without cycling them.
1033 # This module is compatible with the ircv3_chghost module. Clients
1034 # supporting the chghost extension will get the chghost message instead
1035 # of seeing a host cycle.
1036 #<module name="hostcycle">
1038 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1039 # httpd module: Provides HTTP server support for InspIRCd.
1040 #<module name="httpd">
1042 #-#-#-#-#-#-#-#-#-#-#-#- HTTPD CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
1044 # If you choose to use the httpd module, then you will need to add
1045 # a <bind> tag with type "httpd", and load at least one of the other
1046 # httpd_* modules to provide pages to display.
1047 # <bind address="127.0.0.1" port="8067" type="httpd">
1048 # <bind address="127.0.0.1" port="8097" type="httpd" ssl="gnutls">
1050 # You can adjust the timeout for HTTP connections below. All HTTP
1051 # connections will be closed after (roughly) this time period.
1052 #<httpd timeout="20">
1054 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1055 # HTTP ACL module: Provides access control lists for httpd dependent
1056 # modules. Use this module to restrict pages by IP address and by
1058 #<module name="httpd_acl">
1060 #-#-#-#-#-#-#-#-#-#-#-#- HTTPD ACL CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
1062 # Restrict access to the httpd_stats module to all but the local
1063 # network and when the correct password is specified:
1064 # <httpdacl path="/stats*" types="password,whitelist"
1065 # username="secrets" password="mypasshere" whitelist="127.0.0.*,10.*">
1067 # Deny all connections to all but the main index page:
1068 # <httpdacl path="/*" types="blacklist" blacklist="*">
1070 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1071 # HTTP config module: Allows the server configuration to be viewed over
1072 # HTTP via the /config path. Requires the httpd module to be loaded for
1075 # IMPORTANT: This module exposes extremely sensitive information about
1076 # your server and users so you *MUST* protect it using a local-only
1077 # <bind> tag and/or the httpd_acl module. See above for details.
1078 #<module name="httpd_config">
1080 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1081 # HTTP stats module: Provides server statistics over HTTP via the /stats
1082 # path. Requires the httpd module to be loaded for it to function.
1084 # IMPORTANT: This module exposes extremely sensitive information about
1085 # your server and users so you *MUST* protect it using a local-only
1086 # <bind> tag and/or the httpd_acl module. See above for details.
1087 #<module name="httpd_stats">
1089 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1090 # Ident: Provides RFC 1413 ident lookup support.
1091 # When this module is loaded <connect:allow> tags may have an optional
1092 # useident="yes|no" boolean value, determining whether or not to lookup
1093 # ident on users matching that connect tag.
1094 #<module name="ident">
1096 #-#-#-#-#-#-#-#-#-#-#-#- IDENT CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
1098 # Optional - If you are using the ident module, then you can specify #
1099 # the timeout for ident lookups here. If not defined, it will default #
1100 # to 5 seconds. This is a non-blocking timeout which holds the user #
1101 # in a 'connecting' state until the lookup is complete. #
1102 # prefixunqueried: If on, the idents of users being in a connect class#
1103 # with ident lookups disabled (i.e. <connect useident="off">) will be #
1104 # prefixed with a "~". If off, the ident of those users will not be #
1105 # prefixed. Default is off. #
1107 #<ident timeout="5" prefixunqueried="no">
1109 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1110 # Invite exception module: Adds support for channel invite exceptions
1112 #<module name="inviteexception">
1113 # bypasskey: If this is enabled, exceptions will bypass +k as well as +i
1114 #<inviteexception bypasskey="yes">
1116 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1117 # IRCv3 module: Provides the following IRCv3 extensions:
1118 # extended-join, away-notify and account-notify. These are optional
1119 # enhancements to the client-to-server protocol. An extension is only
1120 # active for a client when the client specifically requests it, so this
1121 # module needs the cap module to work.
1123 # Further information on these extensions can be found at the IRCv3
1124 # working group website:
1125 # https://ircv3.net/irc/
1127 #<module name="ircv3">
1128 # The following block can be used to control which extensions are
1129 # enabled. Note that extended-join can be incompatible with delayjoin
1131 #<ircv3 accountnotify="on" awaynotify="on" extendedjoin="on">
1133 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1134 # IRCv3 account-tag module. Adds the 'account' tag which contains the
1135 # services account name of the message sender.
1136 #<module name="ircv3_accounttag">
1138 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1139 # IRCv3 batch module: Provides the batch IRCv3 extension which allows
1140 # the server to inform a client that a group of messages are related to
1142 #<module name="ircv3_batch">
1144 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1145 # IRCv3 cap-notify module: Provides the cap-notify IRCv3 extension.
1146 # Required for IRCv3 conformance.
1147 #<module name="ircv3_capnotify">
1149 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1150 # IRCv3 chghost module: Provides the chghost IRCv3 extension which
1151 # allows capable clients to learn when the host/ident of another user
1152 # changes without cycling the user. This module is compatible with the
1153 # hostcycle module. If both are loaded, clients supporting the chghost
1154 # extension will get the chghost message and won't see host cycling.
1155 #<module name="ircv3_chghost">
1157 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1158 # IRCv3 client-to-client tags module: Provides the message-tags IRCv3
1159 #Â extension which allows clients to add extra data to their messages.
1160 # This is used to support new IRCv3 features such as replies and ids.
1161 #<module name="ircv3_ctctags">
1163 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1164 # IRCv3 echo-message module: Provides the echo-message IRCv3
1165 # extension which allows capable clients to get an acknowledgement when
1166 # their messages are delivered and learn what modifications, if any,
1167 # were applied to them.
1168 #<module name="ircv3_echomessage">
1170 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1171 # IRCv3 invite-notify module: Provides the invite-notify IRCv3
1172 # extension which notifies supporting clients when a user invites
1173 # another user into a channel. This respects <options:announceinvites>.
1174 #<module name="ircv3_invitenotify">
1176 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1177 # IRCv3 message id module: Provides the msgid IRCv3 extension which
1178 # adds a unique identifier to each message when the message-tags cap
1179 # has been requested. This enables support for modern features such as
1180 # reactions and replies.
1181 #<module name="ircv3_msgid">
1183 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1184 # IRCv3 server-time module. Adds the 'time' tag which adds a timestamp
1185 # to all messages received from the server.
1186 #<module name="ircv3_servertime">
1188 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1189 # IRCv3 Strict Transport Security module: Provides the sts IRCv3
1190 # extension which allows clients connecting insecurely to upgrade their
1191 # connections to TLS.
1192 #<module name="ircv3_sts">
1194 # If using the ircv3_sts module you MUST define a STS policy to send
1195 # to clients using the <sts> tag. This tag takes the following
1198 # host - A glob match for the SNI hostname to apply this policy to.
1199 # duration - The amount of time that the policy lasts for. Defaults to
1200 # approximately two months by default.
1201 # port - The port on which TLS connections to the server are being
1202 # accepted. You MUST have a CA-verified certificate on this
1203 # port. Self signed certificates are not acceptable.
1204 # preload - Whether client developers can include your certificate in
1207 # <sts host="*.example.com" duration="60d" port="6697" preload="yes">
1209 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1210 # Join flood module: Adds support for join flood protection +j X:Y.
1211 # Closes the channel for N seconds if X users join in Y seconds.
1212 #<module name="joinflood">
1214 # The number of seconds to close the channel for:
1215 #<joinflood duration="1m">
1217 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1218 # Anti auto rejoin: Adds support for prevention of auto-rejoin (+J).
1219 #<module name="kicknorejoin">
1221 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1222 # Knock module: Adds the /KNOCK command and channel mode +K.
1223 #<module name="knock">
1225 # This setting specifies what to do when someone successfully /KNOCKs.
1226 # If set to "notice", then a NOTICE will be sent to the channel.
1227 # This is the default and the compatible setting, as it requires no
1228 # special support from the clients.
1229 # If set to "numeric" then a 710 numeric will be sent to the channel.
1230 # This allows easier scripting but not all clients support it.
1231 # If set to "both" then (surprise!) both will be sent.
1232 #<knock notify="notice">
1234 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1235 # LDAP module: Allows other SQL modules to access a LDAP database
1236 # through a unified API.
1237 # This modules is in extras. Re-run configure with:
1238 # ./configure --enable-extras=m_ldap.cpp
1239 # and run make install, then uncomment this module to enable it.
1241 #<module name="ldap">
1242 #<database module="ldap" id="ldapdb" server="ldap://localhost" binddn="cn=Manager,dc=inspircd,dc=org" bindauth="mysecretpass" searchscope="subtree">
1243 # The server parameter indicates the LDAP server to connect to. The #
1244 # ldap:// style scheme before the hostname proper is MANDATORY. #
1246 # The binddn and bindauth indicate the DN to bind to for searching, #
1247 # and the password for the distinguished name. Some LDAP servers will #
1248 # allow anonymous searching in which case these two values do not #
1249 # need defining, otherwise they should be set similar to the examples #
1252 # The searchscope value indicates the subtree to search under. On our #
1253 # test system this is 'subtree'. Your mileage may vary. #
1255 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1256 # LDAP authentication module: Adds the ability to authenticate users #
1258 #<module name="ldapauth">
1262 # <ldapauth dbid="ldapdb" #
1263 # baserdn="ou=People,dc=brainbox,dc=cc" #
1265 # allowpattern="Guest* Bot*" #
1266 # killreason="Access denied" #
1268 # host="$uid.$ou.inspircd.org" #
1269 # useusername="no"> #
1271 # <ldapwhitelist cidr="10.42.0.0/16"> #
1273 # <ldaprequire attribute="attr" value="val"> #
1275 # The baserdn indicates the base DN to search in for users. Usually #
1276 # this is 'ou=People,dc=yourdomain,dc=yourtld'. #
1278 # The attribute value indicates the attribute which is used to locate #
1279 # a user account by name. On POSIX systems this is usually 'uid'. #
1281 # The allowpattern value allows you to specify a space separated list #
1282 # of wildcard masks which will always be allowed to connect #
1283 # regardless of if they have an account, for example guest and bot #
1286 # The useusername setting chooses whether the user's username or #
1287 # nickname is used when locating a user account, if a username isn't #
1288 # provided in PASS. #
1290 # Killreason indicates the QUIT reason to give to users if they fail #
1291 # to authenticate. #
1293 # Setting the verbose value causes an oper notice to be sent out for #
1294 # every failed authentication to the server, with an error string. #
1296 # ldapwhitelist indicates that clients connecting from an IP in the #
1297 # provided CIDR do not need to authenticate against LDAP. It can be #
1298 # repeated to whitelist multiple CIDRs. #
1300 # ldaprequire allows further filtering on the LDAP user, by requiring #
1301 # certain LDAP attibutes to have a given value. It can be repeated, #
1302 # in which case the list will act as an OR list, that is, the #
1303 # authentication will succeed if any of the requirements in the list #
1306 # host allows you to change the displayed host of users connecting #
1307 # from ldap. The string supplied takes formatters which are replaced #
1308 # from the DN. For instance, if your DN looks like: #
1309 # uid=w00t,ou=people,dc=inspircd,dc=org, then the formatters uid, ou #
1310 # and dc will be available to you. If a key is given multiple times #
1311 # in the DN, the last appearance will take precedence. #
1313 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1314 # LDAP oper configuration module: Adds the ability to authenticate #
1316 #<module name="ldapoper">
1320 # <ldapoper dbid="ldapdb"
1321 # baserdn="ou=People,dc=brainbox,dc=cc"
1324 # Available configuration items are identical to the same items in #
1325 # ldapauth above (except for the verbose setting, that is only #
1326 # supported in ldapauth). #
1327 # Please always specify a password in your <oper> tags even if the #
1328 # opers are to be authenticated via LDAP, so in case this module is #
1329 # not loaded the oper accounts are still protected by a password. #
1331 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1332 # Lock server module: Adds /LOCKSERV and /UNLOCKSERV commands that #
1333 # are used to temporarily close/open the server for new connections. #
1334 # These commands require that the /LOCKSERV and /UNLOCKSERV commands #
1335 # are specified in a <class> tag that the oper is part of. This is so #
1336 # you can control who has access to this possible dangerous command. #
1337 # If your server is locked and you get disconnected, do a REHASH from #
1338 # shell to open up again. #
1339 # This module is oper-only.
1340 #<module name="lockserv">
1342 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1343 # Map hiding module: replaces /MAP and /LINKS output to users with a #
1344 # message to see a website, set by maphide="https://test.org/map" in #
1345 # the <security> tag, instead. #
1346 #<module name="maphide">
1348 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1349 # Message flood module: Adds message/notice flood protection via
1351 #<module name="messageflood">
1353 # The weight to give each message type. TAGMSGs are considered to be
1354 # 1/5 of a NOTICE or PRIVMSG to avoid users being accidentally flooded
1355 # out of a channel by automatic client features such as typing
1357 #<messageflood notice="1.0" privmsg="1.0" tagmsg="0.2">
1359 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1360 # MLOCK module: Adds support for server-side enforcement of services
1361 # side MLOCKs. Basically, this module suppresses any mode change that
1362 # would likely be immediately bounced by services.
1363 #<module name="mlock">
1365 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1366 # Modenotice module: Adds the /MODENOTICE command that allows opers to
1367 # send notices to all users having the given user mode(s) set.
1368 #<module name="modenotice">
1370 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1371 # Monitor module: Adds support for MONITOR which is used by clients to
1372 # maintain notify lists.
1373 #<module name="monitor">
1375 # Set the maximum number of entries on a user's monitor list below.
1376 #<monitor maxentries="30">
1378 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1379 # MySQL module: Allows other SQL modules to access MySQL databases
1380 # through a unified API.
1381 # This module is in extras. Re-run configure with:
1382 # ./configure --enable-extras=m_mysql.cpp
1383 # and run make install, then uncomment this module to enable it.
1384 #<module name="mysql">
1386 #-#-#-#-#-#-#-#-#-#-#-#- SQL CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#-#
1388 # mysql is more complex than described here, see the docs for more #
1389 # info: https://docs.inspircd.org/3/modules/mysql #
1391 #<database module="mysql" name="mydb" user="myuser" pass="mypass" host="localhost" id="my_database2">
1393 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1394 # Named modes module: Allows for the display and set/unset of channel
1395 # modes via long-form mode names via +Z and the /PROP command.
1396 # For example, to set a ban, do /MODE #channel +Z ban=foo!bar@baz or
1397 # /PROP #channel ban=foo!bar@baz
1398 #<module name="namedmodes">
1400 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1401 # NAMESX module: Provides support for the NAMESX extension which allows
1402 # clients to see all the prefixes set on a user without getting confused.
1403 # This is supported by mIRC, x-chat, klient, and maybe more.
1404 #<module name="namesx">
1406 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1407 # National characters module:
1408 # 1) Allows using national characters in nicknames.
1409 # 2) Allows using custom (national) casemapping over the network.
1410 #<module name="nationalchars">
1412 # file - Location of the file which contains casemapping rules. If this
1413 # is a relative path then it is relative to "<PWD>/../locales"
1414 # on UNIX and "<PWD>/locales" on Windows.
1415 # casemapping - The name of the casemapping sent to clients in the 005
1416 # numeric. If this is not set then it defaults to the name
1417 # of the casemapping file unless the file name contains a
1418 # space in which case you will have to specify it manually.
1419 #<nationalchars file="bynets/russian-w1251-charlink" casemapping="ru_RU.cp1251-charlink">
1421 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1422 # Nickchange flood protection module: Provides channel mode +F X:Y
1423 # which allows up to X nick changes in Y seconds.
1424 #<module name="nickflood">
1426 # The number of seconds to prevent nick changes for:
1427 #<nickflood duration="1m">
1429 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1430 # Nicklock module: Let opers change a user's nick and then stop that
1431 # user from changing their nick again until unlocked.
1432 # This module is oper-only.
1433 # To use, NICKLOCK and NICKUNLOCK must be in one of your oper class blocks.
1434 #<module name="nicklock">
1436 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1437 # No CTCP module: Adds the channel mode +C and user mode +T to block
1438 # CTCPs and extban 'C' to block CTCPs sent by specific users.
1439 #<module name="noctcp">
1441 # The +T user mode is not enabled by default to enable link compatibility
1442 # with 2.0 servers. You can enable it by uncommenting this:
1443 #<noctcp enableumode="yes">
1445 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1446 # No kicks module: Adds the +Q channel mode and the Q: extban to deny
1447 # certain users from kicking.
1448 #<module name="nokicks">
1450 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1451 # No nicks module: Adds the +N channel mode, as well as the 'N' extban.
1452 # +N stops all users from changing their nick, the N extban stops
1453 # anyone from matching a +b N:nick!user@host mask from changing their
1455 #<module name="nonicks">
1457 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1458 # No part message module: Adds extban 'p' to block part messages from #
1460 #<module name="nopartmsg">
1462 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1463 # No notice module: Adds the channel mode +T and the extban 'T' to
1464 # block specific users from noticing the channel.
1465 #<module name="nonotice">
1467 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1468 # Network business join module:
1469 # Allows an oper to join a channel using /OJOIN, giving them +Y on the
1470 # channel which makes them immune to kicks.
1471 #<module name="ojoin">
1473 # Specify the prefix that +Y will grant here.
1474 # Leave 'prefix' empty if you do not wish +Y to grant a prefix.
1475 # If 'notice' is set to on, upon /OJOIN, the server will notice the
1476 # channel saying that the oper is joining on network business.
1477 # If 'op' is set to on, it will give them +o along with +Y.
1478 #<ojoin prefix="!" notice="yes" op="yes">
1480 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1481 # Oper channels mode: Adds the +O channel mode and extban O:<mask>
1482 # to ban, except, etc. specific oper types. For example
1483 # /MODE #channel +iI O:* is equivalent to channel mode +O, but you
1484 # may also set +iI O:AdminTypeOnly to only allow admins.
1485 # Modes +I and +e work in a similar fashion.
1486 #<module name="operchans">
1488 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1489 # Oper join module: Auto-joins opers to a channel upon oper-up.
1490 # This module is oper-only. For the user equivalent, see the conn_join
1492 #<module name="operjoin">
1494 #-#-#-#-#-#-#-#-#-#-# OPERJOIN CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
1496 # If you are using the operjoin module, specify options here: #
1498 # channel - The channel name to join, can also be a comma #
1499 # separated list e.g. "#channel1,#channel2". #
1501 # override - If on, lets the oper join walking thru any modes #
1502 # that might be set, even bans. #
1504 #<operjoin channel="#channel" override="no">
1506 # Alternatively you can use the autojoin="channellist" in a <type> #
1507 # tag to set specific autojoins for a type of oper, for example: #
1509 #<type name="Helper" autojoin="#help" classes="...">
1511 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1512 # Oper log module: Logs all oper commands to the server log (with log
1513 # type "m_operlog" at default loglevel), and optionally to the 'r'
1515 # This module is oper-only.
1516 #<module name="operlog">
1518 # If the following option is on then all oper commands will be sent to
1519 # the snomask 'r'. The default is off.
1520 #<operlog tosnomask="off">
1522 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1523 # Oper prefixing module: Adds a channel prefix mode +y which is given
1524 # to all server operators automatically on all channels they are in.
1525 # This prefix mode is more powerful than channel op and other regular
1528 # Load this module if you want all your server operators to have
1529 # channel operator powers.
1530 #<module name="operprefix">
1532 # You may additionally customise the prefix character.
1533 #<operprefix prefix="!">
1535 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1536 # Oper MOTD module: Provides support for a separate message of the day
1538 # This module is oper-only.
1539 #<module name="opermotd">
1541 #-#-#-#-#-#-#-#-#-#-# OPERMOTD CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
1543 # If you are using the opermotd module, specify the motd file here. #
1545 # onoper - If on, the message is sent on /OPER, otherwise it's #
1546 # only sent when /OPERMOTD is used. #
1548 #<opermotd file="examples/opermotd.txt.example" onoper="yes">
1550 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1551 # Override module: Adds support for oper override.
1552 # This module is oper-only.
1553 #<module name="override">
1555 #-#-#-#-#-#-#-#-#-#-# OVERRIDE CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
1557 # Much of override's configuration relates to your oper blocks. #
1558 # For more information on how to allow opers to override, see: #
1559 # https://docs.inspircd.org/3/modules/override #
1561 # noisy - If enabled, all oper overrides will be announced #
1562 # via channel notice. #
1564 # requirekey - If enabled, overriding on join requires a channel #
1565 # key of "override" to be specified. #
1567 # enableumode - If enabled, user mode +O is required for override. #
1569 #<override noisy="yes" requirekey="no" enableumode="true">
1571 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1572 # Oper levels module: Gives each oper a level and prevents actions
1573 # being taken by lower level opers against higher level opers.
1574 # Specify the level as the 'level' parameter of the <type> tag.
1575 # This module is oper-only.
1576 #<module name="operlevels">
1578 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1579 # Oper modes module: Allows you to specify modes to add/remove on oper.
1580 # Specify the modes as the 'modes' parameter of the <type> tag
1581 # and/or as the 'modes' parameter of the <oper> tag.
1582 # This module is oper-only. For the user equivalent, see the
1583 # conn_umodes module.
1584 #<module name="opermodes">
1586 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1587 # Password forwarding module: Forwards a password users can send on
1588 # connect to the specified client below. The client is usually NickServ
1589 # and this module is usually used to authenticate users with NickServ
1590 # using their connect password.
1591 #<module name="passforward">
1594 # nick: nick to forward connect passwords to.
1597 # forwardmsg: Message to send to users using a connect password.
1598 # $nick will be the users' nick, $nickrequired will be the nick
1599 # of where the password is going (the nick above).
1600 # You can also use $user for the user ident string.
1601 forwardmsg="NOTICE $nick :*** Forwarding PASS to $nickrequired"
1603 # cmd: Command for the user to run when it receives a connect
1605 cmd="SQUERY $nickrequired :IDENTIFY $pass">
1607 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1608 # Password hash module: Allows hashed passwords to be used.
1609 # To be useful, a hashing module like bcrypt also needs to be loaded.
1610 #<module name="password_hash">
1612 #-#-#-#-#-#-#-#-#-# PASSWORD HASH CONFIGURATION #-#-#-#-#-#-#-#-#-#-#-#
1614 # To use this module, you must define a hash type for each oper's
1615 # password you want to hash. For example:
1617 # <oper name="Brain"
1618 # host="ident@dialup15.isp.test.com"
1620 # password="$2a$10$Mss9AtHHslZTLBrXqM0FB.JBwD.UTSu8A48SfrY9exrpxbsRiRTbO"
1623 # If you are using a hash algorithm which does not perform salting you can use
1624 # HMAC to salt your passwords in order to prevent them from being looked up in
1627 # hash="hmac-sha256" password="lkS1Nbtp$CyLd/WPQXizsbxFUTqFRoMvaC+zhOULEeZaQkUJj+Gg"
1629 # Generate hashes using the /MKPASSWD command on the server.
1630 # Don't run it on a server you don't trust with your password.
1632 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1633 # PBKDF2 module: Allows other modules to generate PBKDF2 hashes,
1634 # usually for cryptographic uses and security.
1635 # This module relies on other hash providers (e.g. SHA256).
1636 #<module name="pbkdf2">
1638 # iterations: Iterations the hashing function runs when generating new
1640 # length: Length in bytes of the derived key.
1641 #<pbkdf2 iterations="12288" length="32">
1642 # You can override these values with specific values
1643 # for specific providers if you want to. Example given for SHA256.
1644 #<pbkdf2prov hash="sha256" iterations="24576">
1646 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1647 # Permanent channels module: Channels with the permanent channel mode
1648 # will remain open even after everyone else has left the channel, and
1649 # therefore keep things like modes, ban lists and topic. Permanent
1650 # channels -may- need support from your Services package to function
1651 # properly with them. This adds channel mode +P.
1652 # This module is oper-only.
1653 #<module name="permchannels">
1655 # If you like, this module can write a config file of permanent channels
1656 # whenever +P is set, unset, or the topic/modes on a +P channel is changed.
1657 # If you want to do this, set the filename below, and uncomment the include.
1659 # If 'listmodes' is true then all list modes (+b, +I, +e, +g...) will be
1660 # saved. Defaults to false.
1661 #<permchanneldb filename="permchannels.conf" listmodes="true">
1662 #<include file="permchannels.conf">
1664 # You may also create channels on startup by using the <permchannels> block.
1665 #<permchannels channel="#opers" modes="isP" topic="Opers only.">
1667 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1668 # PostgreSQL module: Allows other SQL modules to access PgSQL databases
1669 # through a unified API.
1670 # This module is in extras. Re-run configure with:
1671 # ./configure --enable-extras=m_pgsql.cpp
1672 # and run make install, then uncomment this module to enable it.
1673 #<module name="pgsql">
1675 #-#-#-#-#-#-#-#-#-#-#-#- SQL CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#-#
1677 # pgsql is more complex than described here, see the docs for #
1678 # more: https://docs.inspircd.org/3/modules/pgsql #
1680 #<database module="pgsql" name="mydb" user="myuser" pass="mypass" host="localhost" id="my_database" ssl="no">
1682 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1683 # Muteban: Implements extended ban 'm', which stops anyone matching
1684 # a mask like +b m:nick!user@host from speaking on channel.
1685 #<module name="muteban">
1687 # If notifyuser is set to no, the user will not be notified when
1688 # their message is blocked.
1689 #<muteban notifyuser="yes">
1691 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1692 # Random quote module: Provides a random quote on connect.
1693 # NOTE: Some of these may mimic fatal errors and confuse users and
1694 # opers alike - BEWARE!
1695 #<module name="randquote">
1697 #-#-#-#-#-#-#-#-#-#- RANDOMQUOTES CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
1699 # Optional - If you specify to use the randquote module, then specify #
1700 # below the path to the quotes file. #
1702 #<randquote file="quotes.txt">
1704 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1705 # Redirect module: Adds channel mode +L which redirects users to #
1706 # another channel when the channel has reached its user limit and #
1707 # user mode +L which stops redirection. #
1708 #<module name="redirect">
1710 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1711 # Regular expression provider for glob or wildcard (?/*) matching.
1712 # You must have at least 1 provider loaded to use the filter or R-line
1713 # modules. This module has no additional requirements, as it uses the
1714 # matching already present in InspIRCd core.
1715 #<module name="regex_glob">
1717 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1718 # Regular expression provider for PCRE (Perl-Compatible Regular
1719 # Expressions). You need libpcre installed to compile and load this
1720 # module. You must have at least 1 provider loaded to use the filter or
1722 #<module name="regex_pcre">
1724 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1725 # Regular Expression Provider for RE2 Regular Expressions.
1726 # You need libre2 installed and in your include/library paths in order
1727 # to compile and load this module.
1728 #<module name="regex_re2">
1730 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1731 # Regular expression provider for POSIX regular expressions.
1732 # You shouldn't need any additional libraries on a POSIX-compatible
1733 # system (i.e.: any Linux, BSD, but not Windows). You must have at
1734 # least 1 provider loaded to use the filter or R-line modules.
1735 # On POSIX-compliant systems, regex syntax can be found by using the
1736 # command: 'man 7 regex'.
1737 #<module name="regex_posix">
1739 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1740 # Regular expression provider for C++11 std::regex regular expressions.
1741 # This module works on any fully compliant implementation of the C++11
1742 # std::regex container. Examples for such are Visual C++ 2010 and newer
1743 # but not libstdc++ (which GCC uses).
1744 # You should verify that std::regex is supported by your setup before
1745 # using this module, as it may compile normally but won't do anything
1746 # on some implementations.
1747 #<module name="regex_stdlib">
1749 # Specify the regular expression engine to use here. Valid settings are
1750 # bre, ere, awk, grep, egrep, ecmascript (default if not specified).
1751 #<stdregex type="ecmascript">
1753 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1754 # Regular expression provider for TRE regular expressions.
1755 # This is the same regular expression engine used by UnrealIRCd, so
1756 # if you are most familiar with the syntax of /SPAMFILTER from there,
1757 # this is the provider you want. You need libtre installed in order
1758 # to compile and load this module.
1759 #<module name="regex_tre">
1761 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1762 # Remove module: Adds the /REMOVE command which is a peaceful
1763 # alternative to /KICK. It also provides the /FPART command which works
1764 # in the same way as /REMOVE.
1765 #<module name="remove">
1767 # supportnokicks: If true, /REMOVE is not allowed on channels where the
1768 # nokicks (+Q) mode is set. Defaults to false.
1769 # protectedrank: Members having this rank or above may not be /REMOVE'd
1770 # by anyone. Set to 0 to disable this feature. Defaults to 50000.
1771 #<remove supportnokicks="true" protectedrank="50000">
1773 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1774 # Repeat module: Allows to block, kick or ban upon similar messages
1775 # being uttered several times. Provides channel mode +E.
1777 # Syntax: [~|*]<lines>:<sec>[:<difference>][:<backlog>]
1778 # ~ is to block, * is to ban, default is kick.
1779 # lines - In mode 1, the amount of lines that has to match consecutively.
1780 # In mode 2, the size of the backlog to keep for matching.
1781 # seconds - How old the message has to be before it's invalidated.
1782 # difference - Edit distance, in percent, between two strings to trigger on.
1783 # backlog - When set, the function goes into mode 2. In this mode the
1784 # function will trigger if this many of the last <lines> matches.
1786 # As this module can be rather CPU-intensive, it comes with some options.
1787 # maxbacklog - Maximum size that can be specified for backlog. 0 disables
1788 # multiline matching.
1789 # maxdistance - Max percentage of difference between two lines we'll allow
1790 # to match. Set to 0 to disable edit-distance matching.
1791 # maxlines - Max lines of backlog to match against.
1792 # maxtime - Maximum period of time a user can set. 0 to allow any.
1793 # size - Maximum number of characters to check for, can be used to
1794 # truncate messages before they are checked, resulting in
1795 # less CPU usage. Increasing this beyond 512 doesn't have
1796 # any effect, as the maximum length of a message on IRC
1797 # cannot exceed that.
1798 #<repeat maxbacklog="20" maxdistance="50" maxlines="20" maxtime="0" size="512">
1799 #<module name="repeat">
1801 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1802 # Restricted channels module: Allows only opers with the
1803 # channels/restricted-create priv and/or registered users to
1806 # You probably *DO NOT* want to load this module on a public network.
1808 #<module name="restrictchans">
1810 # allowregistered: should registered users be allowed to bypass the restrictions?
1811 #<restrictchans allowregistered="no">
1813 # Allow any channel matching #user-* to be created, bypassing restrictchans checks
1814 #<allowchannel name="#user-*">
1816 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1817 # Restrict message module: Allows users to only message opers.
1819 # You probably *DO NOT* want to load this module on a public network.
1821 #<module name="restrictmsg">
1823 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1824 # R-line module: Ban users through regular expression patterns.
1825 #<module name="rline">
1827 #-#-#-#-#-#-#-#-#-#-#-#- RLINE CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#-#
1829 # If you wish to re-check a user when they change nickname (can be
1830 # useful under some situations, but *can* also use CPU with more users
1831 # on a server) then set 'matchonnickchange' to yes.
1832 # If you additionally want Z-lines to be added on matches, then
1833 # set 'zlineonmatch' to yes.
1834 # Also, this is where you set what Regular Expression engine is to be
1835 # used. If you ever change it while running, all of your R-lines will
1836 # be wiped. This is the regex engine used by all R-lines set, and
1837 # regex_<engine> must be loaded, or rline will be non-functional
1838 # until you load it or change the engine to one that is loaded.
1840 #<rline matchonnickchange="yes" zlineonmatch="no" engine="pcre">
1842 # Generally, you will NOT want to use 'glob' here, as this turns an
1843 # R-line into just another G-line. The exceptions are that R-lines will
1844 # always use the full "nick!user@host realname" string, rather than only
1845 # user@host, but beware that only the ? and * wildcards are available,
1846 # and are the only way to specify where the space can occur if you do
1847 # use glob. For this reason, is recommended to use a real regex engine
1848 # so that at least \s or [[:space:]] is available.
1850 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1851 # RMODE module: Adds the /RMODE command.
1852 # Allows channel operators to remove list modes en masse, optionally
1853 # matching a glob-based pattern.
1854 # Syntax: /RMODE <channel> <mode> [<pattern>]
1855 # E.g. '/RMODE #channel b m:*' will remove all mute extbans on the channel.
1856 #<module name="rmode">
1858 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1859 # SAJOIN module: Adds the /SAJOIN command which forcibly joins a user
1860 # to the given channel.
1861 # This module is oper-only.
1862 # To use, SAJOIN must be in one of your oper class blocks.
1863 # Opers need the users/sajoin-others priv to be able to /SAJOIN users
1864 # other than themselves.
1865 #<module name="sajoin">
1867 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1868 # SAKICK module: Adds the /SAKICK command which kicks a user from the
1870 # This module is oper-only.
1871 # To use, SAKICK must be in one of your oper class blocks.
1872 #<module name="sakick">
1874 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1875 # SAMODE module: Adds the /SAMODE command which allows server operators
1876 # to change modes on a channel without requiring them to have any
1877 # channel priviliges. Also allows changing user modes for any user.
1878 # This module is oper-only.
1879 # To use, SAMODE must be in one of your oper class blocks.
1880 #<module name="samode">
1882 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1883 # SANICK module: Adds the /SANICK command which allows opers to change
1885 # This module is oper-only.
1886 # To use, SANICK must be in one of your oper class blocks.
1887 #<module name="sanick">
1889 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1890 # SAPART module: Adds the /SAPART command which forcibly parts a user
1892 # This module is oper-only.
1893 # To use, SAPART must be in one of your oper class blocks.
1894 #<module name="sapart">
1896 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1897 # SAQUIT module: Adds the /SAQUIT command which forcibly quits a user.
1898 # This module is oper-only.
1899 # To use, SAQUIT must be in one of your oper class blocks.
1900 #<module name="saquit">
1902 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1903 # SATOPIC module: Adds the /SATOPIC command which allows changing the
1904 # topic on a channel without requiring any channel priviliges.
1905 # This module is oper-only.
1906 # To use, SATOPIC must be in one of your oper class blocks.
1907 #<module name="satopic">
1909 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1910 # SASL authentication module: Provides support for IRC Authentication
1911 # Layer via AUTHENTICATE. Note: You also need to have cap loaded
1913 #<module name="sasl">
1914 # Define the following to your services server name to improve security
1915 # by ensuring the SASL messages are only sent to the services server
1916 # and not to all connected servers. This prevents a rogue server from
1917 # capturing SASL messages and disables the SASL cap when services is
1919 #<sasl target="services.mynetwork.com">
1921 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1922 # Secure list module: Prevent /LIST in the first minute of connection,
1923 # crippling most spambots and trojan spreader bots.
1924 #<module name="securelist">
1926 #-#-#-#-#-#-#-#-#-# SECURELIST CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#-#
1928 # Securelist can be harmful to some IRC search engines. To prevent #
1929 # securelist blocking these sites from listing, define exception tags #
1931 #<securehost exception="*@*.netsplit.de">
1932 #<securehost exception="*@*.ircdriven.com">
1933 #<securehost exception="*@*.ircs.me">
1935 # Define the following variable to change how long a user must wait #
1936 # before issuing a LIST. If not defined, defaults to 60 seconds. #
1938 #<securelist waittime="1m"> #
1940 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1941 # Servprotect module: Provides support for Austhex style +k /
1942 # UnrealIRCD +S services mode.
1943 #<module name="servprotect">
1945 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1946 # See nicks module: Adds snomask +n and +N which show local and remote
1948 # This module is oper-only.
1949 #<module name="seenicks">
1951 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1952 # Set idle module: Adds a command for opers to change their idle time.
1953 # This module is oper-only.
1954 # To use, SETIDLE must be in one of your oper class blocks.
1955 #<module name="setidle">
1957 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1958 # Services support module: Adds several user modes such as +R and +M.
1959 # This module implements the 'identified' state via account names,
1960 # and is similar in operation to the way asuka and ircu handle services.
1962 # At the same time, this offers +r for users and channels to mark them
1963 # as identified separately from the idea of a master account, which
1964 # can be useful for services which are heavily nick-as-account centric.
1966 # Also of note is that this module implements two extbans:
1967 # +b R: (stop matching account names from joining)
1968 # +b U:n!u@h (blocks matching unregistered users)
1970 #<module name="services_account">
1972 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1973 # Sethost module: Adds the /SETHOST command.
1974 # This module is oper-only.
1975 # To use, SETHOST must be in one of your oper class blocks.
1976 # See the chghost module for how to customise valid chars for hostnames.
1977 #<module name="sethost">
1979 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1980 # Setident module: Adds the /SETIDENT command.
1981 # This module is oper-only.
1982 # To use, SETIDENT must be in one of your oper class blocks.
1983 #<module name="setident">
1985 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1986 # SETNAME module: Adds the /SETNAME command.
1987 #<module name="setname">
1989 #-#-#-#-#-#-#-#-#-#-#-#- SETNAME CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#
1991 # operonly - Whether the SETNAME command should only be usable by #
1992 # server operators. Defaults to no. #
1994 # notifyopers - Whether to send a snotice to snomask `a` when a user #
1995 # changes their real name. Defaults to to yes if #
1996 # oper-only and no if usable by everyone. #
1998 #<setname notifyopers="yes"
2001 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2002 # Serverban: Implements extended ban 's', which stops anyone connected
2003 # to a server matching a mask like +b s:server.mask.here from joining.
2004 # Wildcards are accepted.
2005 #<module name="serverban">
2007 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2008 # SHA1 module: Allows other modules to generate SHA1 hashes.
2009 # Required by the WebSocket module.
2010 #<module name="sha1">
2012 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2013 # Showfile: Provides support for showing a text file to users when #
2014 # they enter a command. #
2015 # This module adds one command for each <showfile> tag that shows the #
2016 # given file to the user as a series of messages or numerics. #
2017 #<module name="showfile">
2019 #-#-#-#-#-#-#-#-#-#-# SHOWFILE CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#-#
2021 # name - The name of the command which displays this file. This is #
2022 # the only mandatory setting, all others are optional. #
2023 # file - The text file to be shown to the user. #
2024 # By default same as the command name. #
2025 # method - How should the file be shown? #
2026 # * numeric: Send contents using a numeric #
2027 # (similar to /MOTD; the default). #
2028 # * notice: Send contents as a series of notices. #
2029 # * msg: Send contents as a series of private messages. #
2031 # When using the method "numeric", the following extra settings are #
2034 # introtext - Introductory line, "Showing <name>" by default. #
2035 # intronumeric - Numeric used for the introductory line. #
2036 # numeric - Numeric used for sending the text itself. #
2037 # endtext - Ending line, "End of <name>" by default. #
2038 # endnumeric - Numeric used for the ending line. #
2040 #<showfile name="RULES"
2042 # introtext="Server rules:"
2043 # endtext="End of server rules.">
2045 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2046 # Show whois module: Adds the +W user mode which allows opers to see
2047 # when they are /WHOIS'd.
2048 # This module is oper-only by default.
2049 #<module name="showwhois">
2051 # If you wish, you may also let users set this mode. Only opers with the
2052 # users/auspex priv will see real hosts of people, though.
2053 #<showwhois opersonly="yes"
2055 # You may also set whether or not users should receive whois notices,
2056 # should they be /WHOIS'd by an oper.
2057 #showfromopers="yes">
2059 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2060 # Shun module: Provides the /SHUN command, which stops a user from
2061 # executing all except configured commands.
2062 # This module is oper-only.
2063 # To use, SHUN must be in one of your oper class blocks.
2064 #<module name="shun">
2066 # You may also configure which commands you wish a user to be able to
2067 # perform when shunned. It should be noted that if a shunned user
2068 # issues QUIT or PART then their message will be removed, as if they
2069 # did not issue one.
2071 # You can optionally let the user know that their command was blocked.
2073 # You may also let SHUN affect opers (defaults to no).
2074 #<shun enabledcommands="ADMIN PING PONG QUIT PART JOIN" notifyuser="yes" affectopers="no">
2076 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2077 # SSL mode module: Adds support for SSL-only channels via the '+z'
2078 # channel mode, SSL-only private messages via the '+z' user mode and
2079 # the 'z:' extban which matches SSL client certificate fingerprints.
2081 # Does not do anything useful without a working SSL module and the
2082 # sslinfo module (see below).
2083 #<module name="sslmodes">
2085 # The +z user mode is not enabled by default to enable link compatibility
2086 # with 2.0 servers. You can enable it by uncommenting this:
2087 #<sslmodes enableumode="yes">
2089 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2090 # SSL rehash signal module: Allows the SSL modules to be rehashed by
2091 # sending SIGUSR1 to a running InspIRCd process.
2092 # This modules is in extras. Re-run configure with:
2093 # ./configure --enable-extras=m_sslrehashsignal.cpp
2094 # and run make install, then uncomment this module to enable it.
2095 #<module name="sslrehashsignal">
2097 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2098 # GnuTLS SSL module: Adds support for SSL/TLS connections using GnuTLS,
2099 # if enabled. You must answer 'yes' in ./configure when asked or
2100 # manually symlink the source for this module from the directory
2101 # src/modules/extra, if you want to enable this, or it will not load.
2102 #<module name="ssl_gnutls">
2104 #-#-#-#-#-#-#-#-#-#-#- GNUTLS CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#
2106 # ssl_gnutls is too complex to describe here, see the docs: #
2107 # https://docs.inspircd.org/3/modules/ssl_gnutls #
2109 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2110 # SSL info module: Allows users to retrieve information about other
2111 # users' peer SSL certificates and keys via the SSLINFO command.
2112 # This can be used by client scripts to validate users. For this to
2113 # work, one of ssl_gnutls, ssl_mbedtls or ssl_openssl must be loaded.
2114 # This module also adds the "<user> is using a secure connection"
2115 # and "<user> has client certificate fingerprint <fingerprint>"
2116 # WHOIS lines, the ability for opers to use SSL cert fingerprints to
2117 # verify their identity and the ability to force opers to use SSL
2118 # connections in order to oper up. It is highly recommended to load
2119 # this module if you use SSL on your network.
2120 # For how to use the oper features, please see the first
2121 # example <oper> tag in opers.conf.example.
2123 #<module name="sslinfo">
2125 # If you want to prevent users from viewing SSL certificate information
2126 # and fingerprints of other users, set operonly to yes.
2127 #<sslinfo operonly="no">
2129 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2130 # mbedTLS SSL module: Adds support for SSL/TLS connections using mbedTLS.
2131 #<module name="ssl_mbedtls">
2133 #-#-#-#-#-#-#-#-#-#-#- MBEDTLS CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#
2135 # ssl_mbedtls is too complex to describe here, see the docs: #
2136 # https://docs.inspircd.org/3/modules/ssl_mbedtls #
2138 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2139 # OpenSSL SSL module: Adds support for SSL/TLS connections using OpenSSL,
2140 # if enabled. You must answer 'yes' in ./configure when asked or symlink
2141 # the source for this module from the directory src/modules/extra, if
2142 # you want to enable this, or it will not load.
2143 #<module name="ssl_openssl">
2145 #-#-#-#-#-#-#-#-#-#-#- OPENSSL CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#
2147 # ssl_openssl is too complex to describe here, see the docs: #
2148 # https://docs.inspircd.org/3/modules/ssl_openssl #
2150 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2151 # Strip color module: Adds channel mode +S that strips color codes and
2152 # all control codes except CTCP from all messages sent to the channel.
2153 #<module name="stripcolor">
2155 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2156 # Silence module: Adds support for the /SILENCE command, which allows
2157 # users to have a server-side ignore list for their client.
2158 #<module name="silence">
2160 # Set the maximum number of entries allowed on a user's silence list.
2161 #<silence maxentries="32"
2163 # Whether messages from U-lined servers will bypass silence masks.
2166 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2167 # SQLite3 module: Allows other SQL modules to access SQLite3 #
2168 # databases through a unified API. #
2169 # This module is in extras. Re-run configure with: #
2170 # ./configure --enable-extras=m_sqlite3.cpp
2171 # and run make install, then uncomment this module to enable it. #
2173 #<module name="sqlite3">
2175 #-#-#-#-#-#-#-#-#-#-#-#- SQL CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#-#
2177 # sqlite is more complex than described here, see the docs for more #
2178 # info: https://docs.inspircd.org/3/modules/sqlite3 #
2180 #<database module="sqlite" hostname="/full/path/to/database.db" id="anytext">
2182 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2183 # SQL authentication module: Allows IRCd connections to be tied into
2184 # a database table (for example a forum).
2186 #<module name="sqlauth">
2188 #-#-#-#-#-#-#-#-#-#-#- SQLAUTH CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#
2190 # sqlauth is too complex to describe here, see the docs: #
2191 # https://docs.inspircd.org/3/modules/sqlauth #
2193 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2194 # SQL oper module: Allows you to store oper credentials in an SQL
2195 # table. You can add additional table columns like you would config
2196 # tags in opers.conf. Opers in opers.conf will override opers from
2199 #<module name="sqloper">
2201 #-#-#-#-#-#-#-#-#-#-#- SQLOPER CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#
2203 # dbid - Database ID to use (see SQL modules). #
2205 # See also: https://docs.inspircd.org/3/modules/sqloper #
2209 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2210 # StartTLS module: Implements STARTTLS, which allows clients #
2211 # connected to non SSL enabled ports to enable SSL, if a proper SSL #
2212 # module is loaded (either ssl_gnutls, ssl_mbedtls or ssl_openssl). #
2213 #<module name="starttls">
2215 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2216 # SVSHold module: Implements SVSHOLD. Like Q-lines, but can only be #
2217 # added/removed by Services. #
2218 #<module name="svshold">
2219 # SVSHOLD does not generate server notices by default, you can turn
2220 # notices on by uncommenting the next line.
2221 #<svshold silent="false">
2223 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2224 # SWHOIS module: Allows you to add arbitrary lines to user WHOIS.
2225 # This module is oper-only.
2226 # To use, SWHOIS must be in one of your oper class blocks.
2227 #<module name="swhois">
2229 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2230 # Timed bans module: Adds timed channel bans with the /TBAN command.
2231 #<module name="timedbans">
2233 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2234 # Test line module: Adds the /TLINE command, used to test how many
2235 # users a /GLINE or /ZLINE etc. would match.
2236 # This module is oper-only.
2237 # To use, TLINE must be in one of your oper class blocks.
2238 #<module name="tline">
2240 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2241 # Topiclock module: implements server-side topic locking to achieve deeper
2242 # integration with services packages.
2243 #<module name="topiclock">
2245 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2246 # UHNAMES support module: Adds support for the IRCX style UHNAMES
2247 # extension, which displays ident and hostname in the names list for
2248 # each user, saving clients from doing a WHO on the channel.
2249 # If a client does not support UHNAMES it will not enable it, this will
2250 # not break incompatible clients.
2251 #<module name="uhnames">
2253 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2254 # Uninvite module: Adds the /UNINVITE command which lets users remove
2255 # pending invites from channels without waiting for the user to join.
2256 #<module name="uninvite">
2258 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2259 # Userip module: Adds the /USERIP command.
2260 # Allows users to query their own IP, also allows opers to query the IP
2262 #<module name="userip">
2264 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2265 # Vhost module: Adds the VHOST command which allows for adding virtual
2266 # hosts which are accessible using a username and password in the config.
2267 #<module name="vhost">
2269 #-#-#-#-#-#-#-#-#-#-#- VHOST CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#-#
2271 # user - Username for the vhost. #
2273 # pass - Password for the vhost. #
2275 # hash - The hash for the specific user (optional) #
2276 # password_hash and a hashing module must be loaded for #
2279 # host - Vhost to set. #
2281 #<vhost user="some_username" pass="some_password" host="some.host.test.cc">
2282 #<vhost user="foo" password="$2a$10$iTuYLT6BRhRlOgzfsW9oPe62etW.oXwSpyKw5rJit64SGZanLXghO" hash="bcrypt" host="some.other.host.example.com">
2284 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2285 # Watch module: Adds the WATCH command, which is used by clients to
2286 # maintain notify lists.
2287 #<module name="watch">
2289 # Set the maximum number of entries on a user's watch list below.
2290 #<watch maxentries="32">
2292 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2293 # WebSocket module: Adds HTML5 WebSocket support.
2294 # Specify hook="websocket" in a <bind> tag to make that port accept
2295 # WebSocket connections. Compatible with SSL/TLS.
2296 # Requires SHA-1 hash support available in the sha1 module.
2297 #<module name="websocket">
2299 # Whether to re-encode messages as UTF-8 before sending to WebSocket
2300 # clients. This is recommended as the WebSocket protocol requires all
2301 # text frames to be sent as UTF-8. If you do not have this enabled
2302 # messages will be sent as binary frames instead.
2303 #<websocket sendastext="yes">
2305 # If you use the websocket module you MUST specify one or more origins
2306 # which are allowed to connect to the server. You should set this as
2307 # strict as possible to prevent malicious webpages from connecting to
2309 # <wsorigin allow="https://*.example.com">
2311 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2312 # X-line database: Stores all *-lines (G/Z/K/R/any added by other modules)
2313 # in a file which is re-loaded on restart. This is useful
2314 # for two reasons: it keeps bans so users may not evade them, and on
2315 # bigger networks, server connections will take less time as there will
2316 # be a lot less bans to apply - as most of them will already be there.
2317 #<module name="xline_db">
2319 # Specify the filename for the xline database here.
2320 #<xlinedb filename="xline.db">
2322 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2323 # ____ _ _____ _ _ ____ _ _ _ #
2324 # | _ \ ___ __ _ __| | |_ _| |__ (_)___ | __ )(_) |_| | #
2325 # | |_) / _ \/ _` |/ _` | | | | '_ \| / __| | _ \| | __| | #
2326 # | _ < __/ (_| | (_| | | | | | | | \__ \ | |_) | | |_|_| #
2327 # |_| \_\___|\__,_|\__,_| |_| |_| |_|_|___/ |____/|_|\__(_) #
2329 # To link servers to InspIRCd, you MUST load the spanningtree module. #
2330 # If you don't do this, server links will NOT work at all. #
2331 # This is by design, to allow for the implementation of other linking #
2332 # protocols in modules in the future. #
2334 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2335 # Spanning tree module: Allows linking of servers using the spanning
2336 # tree protocol (see the READ THIS BIT section above).
2337 # You will almost always want to load this.
2339 #<module name="spanningtree">
projects / user / henk / code / inspircd.git / blob