2 ################################################
3 ### Managed by someone's ansible provisioner ###
4 ################################################
5 # Part of: https://git.somenet.org/root/pub/somesible.git
6 # 2017-2024 by someone <someone@somenet.org>
8 #-#-#-#-#-#-#-#-#-#-#-#-#- MODULE OPTIONS -#-#-#-#-#-#-#-#-#-#-#-#-#
10 # These tags define which modules will be loaded on startup by your #
11 # server. Add modules without any paths. When you make your ircd #
12 # using the 'make' command, all compiled modules will be moved into #
13 # the folder you specified when you ran ./configure. The module tag #
14 # automatically looks for modules in this location. #
15 # If you attempt to load a module outside of this location, either #
16 # in the config, or via /LOADMODULE, you will receive an error. #
18 # By default, ALL modules are commented out. You must uncomment them #
19 # or add lines to your config to load modules. Please refer to #
20 # https://docs.inspircd.org/3/modules for a list of modules and #
21 # each modules link for any additional conf tags they require. #
23 # ____ _ _____ _ _ ____ _ _ _ #
24 # | _ \ ___ __ _ __| | |_ _| |__ (_)___ | __ )(_) |_| | #
25 # | |_) / _ \/ _` |/ _` | | | | '_ \| / __| | _ \| | __| | #
26 # | _ < __/ (_| | (_| | | | | | | | \__ \ | |_) | | |_|_| #
27 # |_| \_\___|\__,_|\__,_| |_| |_| |_|_|___/ |____/|_|\__(_) #
29 # To link servers to InspIRCd, you MUST load the spanningtree module. #
30 # If you don't do this, server links will NOT work at all. #
31 # This is by design, to allow for the implementation of other linking #
32 # protocols in modules in the future. This module is at the bottom of #
36 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
37 # MD5 module: Allows other modules to generate MD5 hashes, usually for
38 # cryptographic uses and security.
41 # Other modules such as cloaking and password_hash may rely on
42 # this module being loaded to function.
46 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
47 # SHA256 module: Allows other modules to generate SHA256 hashes,
48 # usually for cryptographic uses and security.
51 # Other modules such as password_hash may rely on this module being
52 # loaded to function. Certain modules such as spanningtree will
53 # function without this module but when it is loaded their features will
54 # be enhanced (for example the addition of HMAC authentication).
56 <module name="sha256">
58 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
59 # Abbreviation module: Provides the ability to abbreviate commands a-la
61 <module name="abbreviation">
63 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
64 # Alias module: Allows you to define server-side command aliases.
67 # Set the 'prefix' for in-channel aliases (fantasy commands) to the
68 # specified character. If not set, the default is "!".
69 # If 'allowbots' is disabled, +B clients will not be able to use
70 # fantasy commands. If not set, the default is no.
71 #<fantasy prefix="!" allowbots="no">
73 #-#-#-#-#-#-#-#-#-#-#- ALIAS DEFINITIONS -#-#-#-#-#-#-#-#-#-#-#-#-#-#
75 # If you have the alias module loaded, you may also define aliases as #
76 # shown below. They are commonly used to provide shortcut commands to #
77 # services, however they are not limited to just this use. #
78 # An alias tag requires the following values to be defined in it: #
80 # text - The text to detect as the actual command line. #
81 # Can't contain spaces, but case insensitive. #
82 # You may have multiple aliases with the same #
83 # command name (text="" value), however the first #
84 # found will be executed if its format value is #
85 # matched, or it has no format value. Aliases are #
86 # read from the top of the file to the bottom. #
88 # usercommand - If this is true, the alias can be run simply as #
89 # /ALIASNAME. Defaults to true. #
91 # channelcommand - If this is true, the alias can be used as an #
92 # in-channel alias or 'fantasy command', prefixed #
93 # by the fantasy prefix character, !aliasname by #
94 # default. Defaults to false. #
96 # format - If this is defined, the parameters of the alias #
97 # must match this glob pattern. For example if you #
98 # want the first parameter to start with a # for #
99 # the alias to be executed, set format="#*" in the #
100 # alias definition. Note that the :'s which are #
101 # part of IRC formatted lines will be preserved #
102 # for matching of this text. This value is #
105 # replace - The text to replace 'text' with. Usually this #
106 # will be "PRIVMSG ServiceName :$2-" or similar. #
107 # You may use the variables $1 through $9 in the #
108 # replace string, which refer to the first through #
109 # ninth word in the original string typed by the #
110 # user. You may also use $1- through $9- which #
111 # refer to the first word onwards, through to the #
112 # ninth word onwards, e.g. if the user types the #
113 # command "foo bar baz qux quz" then $3- will hold #
114 # "baz qux quz" and $2 will contain "bar". You may #
115 # also use the special variables: $nick, $ident, #
116 # $host and $vhost, and you may separate multiple #
117 # commands with a newline (which can be written in #
118 # the file literally, or encoded as &nl; or \n #
119 # depending on the config format setting). #
121 # requires - If you provide a value for 'requires' this means #
122 # the given nickname MUST be online for the alias #
123 # to successfully trigger. If they are not, then #
124 # the user receives a 'no such nick' 401 numeric. #
126 # stripcolor - If this is true, the text from the user will be #
127 # stripped of color and format codes before #
128 # matching against 'text'. #
130 # uline - Setting this to true will ensure that the user #
131 # given in 'requires' is also on a U-lined server, #
132 # as well as actually being on the network. If the #
133 # user is online, but not on a U-lined server, #
134 # then an oper alert is sent out as this is #
135 # possibly a sign of a user trying to impersonate #
138 # operonly - If true, this will make the alias oper only. #
139 # If a non-oper attempts to use the alias, it will #
140 # appear to not exist. #
144 # Long hand aliases for services pseudoclients.
145 <alias text="BOTSERV" replace="SQUERY $requirement :$2-" requires="BotServ" uline="yes">
146 <alias text="CHANSERV" replace="SQUERY $requirement :$2-" requires="ChanServ" uline="yes">
147 <alias text="HOSTSERV" replace="SQUERY $requirement :$2-" requires="HostServ" uline="yes">
148 <alias text="MEMOSERV" replace="SQUERY $requirement :$2-" requires="MemoServ" uline="yes">
149 <alias text="NICKSERV" replace="SQUERY $requirement :$2-" requires="NickServ" uline="yes">
150 <alias text="OPERSERV" replace="SQUERY $requirement :$2-" requires="OperServ" uline="yes" operonly="yes">
151 <alias text="STATSERV" replace="SQUERY $requirement :$2-" requires="StatServ" uline="yes">
153 # Short hand aliases for services pseudoclients.
154 <alias text="BS" replace="SQUERY $requirement :$2-" requires="BotServ" uline="yes">
155 <alias text="CS" replace="SQUERY $requirement :$2-" requires="ChanServ" uline="yes">
156 <alias text="HS" replace="SQUERY $requirement :$2-" requires="HostServ" uline="yes">
157 <alias text="MS" replace="SQUERY $requirement :$2-" requires="MemoServ" uline="yes">
158 <alias text="NS" replace="SQUERY $requirement :$2-" requires="NickServ" uline="yes">
159 <alias text="OS" replace="SQUERY $requirement :$2-" requires="OperServ" uline="yes" operonly="yes">
160 <alias text="SS" replace="SQUERY $requirement :$2-" requires="StatServ" uline="yes">
162 # /ID [account] <password>
163 # Identifies to a services account.
164 <alias text="ID" format="*" replace="SQUERY $requirement :IDENTIFY $2-" requires="NickServ" uline="yes">
165 <alias text="IDENTIFY" format="*" replace="SQUERY $requirement :IDENTIFY $2-" requires="NickServ" uline="yes">
167 <alias text="GLOBAL" format="*" replace="SQUERY $requirement :GLOBAL $2-" requires="Global" uline="yes" operonly="yes">
170 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
171 # Allowinvite module: Gives channel mode +A to allow all users to use
172 # /INVITE, and extban A to deny invite from specific masks.
173 <module name="allowinvite">
175 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
176 # Alltime module: Shows time on all connected servers at once.
177 # This module is oper-only and provides /ALLTIME.
178 # To use, ALLTIME must be in one of your oper class blocks.
179 <module name="alltime">
181 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
182 # Anticaps module: Adds channel mode +B which allows you to punish
183 # users that send overly capitalised messages to channels. Unlike the
184 # blockcaps module this module is more flexible as it has more options
185 # for punishment and allows channels to configure their own punishment
187 <module name="anticaps">
189 # You may also configure the characters which anticaps considers to be
190 # lower case and upper case. Any characters not listed here are assumed
191 # to be punctuation and will be ignored when counting:
192 <anticaps lowercase="abcdefghijklmnopqrstuvwxyz"
193 uppercase="ABCDEFGHIJKLMNOPQRSTUVWXYZ">
195 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
196 # Argon2 module: Allows other modules to generate Argon2 hashes,
197 # usually for cryptographic uses and security.
198 # This module makes the algorithms argon2i, argon2d and argon2id
200 # Note that this module is extra, and must be enabled explicitly
201 # to build. It depends on libargon2.
202 #<module name="argon2">
204 # memory: Memory hardness, in KiB. E.g. 131072 KiB = 128 MiB.
205 # iterations: Time hardness in iterations. (def. 3)
206 # lanes: How many parallel chains can be run. (def. 1)
207 # threads: Maximum amount of threads each invocation can spawn. (def. 1)
208 # length: Output length in bytes. (def. 32)
209 # saltlength: Salt length in bytes. (def. 16)
210 # version: Algorithm version, 10 or 13. (def. 13)
211 # The parameters can be customized as follows:
212 #<argon2 iterations="3" memory="131074" length="32" saltlength="16">
213 # Defines the parameters that are common for all the variants (i/d/id).
214 # Can be overridden on individual basis, e.g.
215 #<argon2i iterations="4">
216 #<argon2d memory="131074"
217 #<argon2id iterations="5" memory="262144" length="64" saltlength="32">
219 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
220 # Auditorium module: Adds channel mode +u which makes everyone else
221 # except you in the channel invisible, used for large meetings etc.
222 <module name="auditorium">
224 # Auditorium settings:
226 <auditorium opvisible="yes" opcansee="yes" opercansee="yes">
228 # opvisible (auditorium-vis in exemptchanops):
229 # Show channel ops to all users
230 # opcansee (auditorium-see in exemptchanops):
231 # Allow ops to see all joins/parts/kicks in the channel
233 # Allow opers (channels/auspex) to see see all joins/parts/kicks in the channel
235 # Exemptchanops can be used to adjust the level at which users become visible or
236 # the level at which they can see the full member list of the channel.
238 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
239 # Autoop module: Adds basic channel access controls via the +w listmode.
240 # For example +w o:*!Attila@127.0.0.1 will op anyone matching that mask
241 # on join. This can be combined with extbans, for example +w o:R:Brain
242 # will op anyone identified to the account "Brain".
243 # Another useful combination is with TLS (SSL) client certificate
244 # fingerprints: +w h:z:72db600734bb9546c1bdd02377bc21d2a9690d48 will
245 # give halfop to the user(s) having the given certificate.
246 <module name="autoop">
248 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
249 # Ban except module: Adds support for channel ban exceptions (+e).
250 <module name="banexception">
252 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
253 # Ban redirection module: Allows bans which redirect to a specified
254 # channel. e.g. +b nick!ident@host#channelbanneduserissentto
255 <module name="banredirect">
257 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
258 # bcrypt module: Allows other modules to generate bcrypt hashes,
259 # usually for cryptographic uses and security.
260 <module name="bcrypt">
262 # rounds: Defines how many rounds the bcrypt function will run when
263 # generating new hashes.
266 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
267 # Block amsg module: Attempt to block all usage of /amsg and /ame.
268 <module name="blockamsg">
270 #-#-#-#-#-#-#-#-#-#-#- BLOCKAMSG CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
272 # If you have the blockamsg module loaded, you can configure it with #
273 # the <blockamsg> tag: #
275 # delay - How much time between two messages to force them #
276 # to be recognised as unrelated. #
277 # action - Any of 'notice', 'noticeopers', 'silent', 'kill' #
278 # or 'killopers'. Define how to take action when #
279 # a user uses /amsg or /ame. #
281 <blockamsg delay="3" action="killopers">
283 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
284 # Block CAPS module: Adds channel mode +B, blocks all-CAPS messages.
286 # NOTE: This module is deprecated and will be removed in a future version
287 # of InspIRCd. You should use the anticaps module shown above instead.
288 #<module name="blockcaps">
290 #-#-#-#-#-#-#-#-#-#-#- BLOCKCAPS CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
292 # percent - The percentage of a message which must be upper #
293 # case before it will be blocked. #
295 # minlen - The minimum length a message must be before it #
298 # lowercase - The characters which will be considered lower #
301 # uppercase - The characters which will be considered upper #
304 #<blockcaps percent="50"
306 # lowercase="abcdefghijklmnopqrstuvwxyz"
307 # uppercase="ABCDEFGHIJKLMNOPQRSTUVWXYZ">
309 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
310 # Block color module: Blocking color-coded messages with chan mode +c.
311 <module name="blockcolor">
313 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
314 # Botmode module: Adds the user mode +B. If set on a user, it will
315 # show that the user is a bot in /WHOIS.
316 <module name="botmode">
318 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
319 # CallerID module: Adds user mode +g which activates hybrid-style
320 # callerid: block all private messages unless you /ACCEPT first.
321 <module name="callerid">
323 #-#-#-#-#-#-#-#-#-#-#- CALLERID CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#
324 # maxaccepts - Maximum number of entries a user can add to their #
325 # /ACCEPT list. Default is 30 entries. #
326 # tracknick - Preserve /ACCEPT entries when a user changes nick? #
327 # If no (the default), the user is removed from #
328 # everyone's accept list if their nickname changes. #
329 # cooldown - Amount of time that must pass since the last #
330 # notification sent to a user before they can be #
331 # sent another. Default is 1 minute. #
332 <callerid maxaccepts="64"
336 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
337 # CAP module: Provides the CAP negotiation mechanism required by the
338 # sasl, namesx, uhnames, and ircv3 modules.
339 # It is also recommended for STARTTLS support in the starttls module.
342 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
343 # CBAN module: Lets you disallow channels from being used at runtime.
344 # This module is oper-only and provides /CBAN.
345 # To use, CBAN must be in one of your oper class blocks.
347 # CBAN does not allow glob channelmasks by default for compatibility
348 # reasons. You can enable glob support by uncommenting the next line.
351 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
352 # Censor module: Adds channel and user mode +G which block phrases that
353 # are listed in the server bad words list.
354 #<module name="censor">
356 #-#-#-#-#-#-#-#-#-#-#- CENSOR CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#
358 # If you have the censor module loaded you should specify one or more #
359 # phrases to replace/block in user messages. The config for this is #
360 # formatted as follows: #
362 # Replaces "eggplant" with "aubergine" within messages: #
363 # <badword text="eggplant" replace="aubergine"> #
365 # Blocks messages that contain "fluffy capybaras": #
366 #<badword text="fluffy capybaras"> #
368 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
369 # CGI:IRC module: Enables forwarding the real IP address of a user from
370 # a gateway to the IRC server.
371 <module name="cgiirc">
373 #-#-#-#-#-#-#-#-#-#-#-# CGIIRC CONFIGURATION #-#-#-#-#-#-#-#-#-#-#-#-#
375 # If you use the cgiirc module then you must specify the gateways which
376 # are authorised to forward IP/host information to your server. There
377 # are currently two ways to do this:
379 # The webirc method is the recommended way to allow gateways to forward
380 # IP/host information. When using this method the gateway sends a WEBIRC
381 # message to the server on connection. For more details please read the
382 # IRCv3 WebIRC specification at: https://ircv3.net/specs/extensions/webirc.html
384 # When using this method you must specify a wildcard mask or CIDR range
385 # to allow gateway connections from and at least one of either a TLS (SSL)
386 # client certificate fingerprint for the gateway or a password to be
387 # sent in the WEBIRC command.
389 # <cgihost type="webirc"
390 # fingerprint="bd90547b59c1942b85f382bc059318f4c6ca54c5"
391 # mask="192.0.2.0/24">
392 # <cgihost type="webirc"
393 # password="$2a$10$WEUpX9GweJiEF1WxBDSkeODBstIBMlVPweQTG9cKM8/Vd58BeM5cW"
395 # mask="*.webirc.gateway.example.com">
397 # Alternatively if your gateway does not support sending the WEBIRC
398 # message then you can configure InspIRCd to look for the client IP
399 # address in the ident sent by the user. This is not recommended as it
400 # only works with IPv4 connections.
402 # When using this method you must specify a wildcard mask or CIDR range to allow
403 # gateway connections from. You can also optionally configure the static value
404 # that replaces the IP in the ident to avoid leaking the real IP address of
405 # gateway clients (defaults to "gateway" if not set).
407 # <cgihost type="ident"
408 # mask="198.51.100.0/24"
410 # <cgihost type="ident"
411 # mask="*.ident.gateway.example.com"
414 # By default gateway connections are logged to the +w snomask. If you
415 # do not want this to happen then you can uncomment this to disable it.
416 # <cgiirc opernotice="no">
421 # When you connect gateway clients, there are two connect classes which
422 # apply to these clients. When the client initially connects, the connect
423 # class which matches the gateway site's host is checked. Therefore you
424 # must raise the maximum local/global clients for this IP as high as you
425 # want to allow gateway clients. After the client has connected and is
426 # determined to be a gateway client, the class which matches the client's
427 # real IP is then checked. You may set this class to a lower value, so that
428 # the real IP of the client can still be restricted to, for example, 3
431 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
432 # Channel create module: Adds snomask +j, which will notify opers of
433 # any new channels that are created.
434 # This module is oper-only.
435 <module name="chancreate">
437 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
438 # Channel filter module: Allows channel-op defined message filtering
439 # using simple string matches (channel mode +g).
440 <module name="chanfilter">
442 # If hidemask is set to yes, the user will not be shown the mask when
443 # their message is blocked.
445 # If maxlen is set then it defines the maximum length of a filter entry.
447 # If notifyuser is set to no, the user will not be notified when
448 # their message is blocked.
449 <chanfilter hidemask="yes" notifyuser="yes">
451 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
452 # Channel history module: Displays the last 'X' lines of chat to a user
453 # joining a channel with +H 'X:T' set; 'T' is the maximum time to keep
454 # lines in the history buffer. Designed so that the new user knows what
455 # the current topic of conversation is when joining the channel.
456 <module name="chanhistory">
458 # Set the maximum number of lines allowed to be stored per channel below.
459 # This is the hard limit for 'X'.
460 # If prefixmsg is set to yes, joining users without batch support will get
461 # a NOTICE before playback telling them about the following lines being
462 # the pre-join history.
463 # If bots is set to yes, it will also send to users marked with +B
464 <chanhistory maxlines="50">
466 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
467 # Channel logging module: Used to send snotice output to channels, to
468 # allow staff to centrally monitor and discuss network activity.
470 # The "channel" field is where you want the messages to go, "snomasks"
471 # is what snomasks you want to be sent to that channel. Multiple tags
473 #<module name="chanlog">
474 #<chanlog snomasks="AOcC" channel="#opers">
476 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
477 # Channel names module: Allows disabling channels which have certain
478 # characters in the channel name such as bold, colorcodes, etc. which
479 # can be quite annoying and allow users to on occasion have a channel
480 # that looks like the name of another channel on the network.
481 <module name="channames">
484 # denyrange: characters or range of characters to deny in channel
488 # allowrange: characters or range of characters to specifically allow
492 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
493 # Channelban: Implements extended ban j:, which stops anyone already
494 # in a channel matching a ban like +b j:#channel from joining.
495 # It is also possible to ban based on their status in that channel,
496 # like so: +b j:@#channel, this example prevents the ops from joining.
497 # Note that by default wildcard characters * and ? are allowed in
498 # channel names. To disallow them, load the channames module and
499 # add characters 42 and 63 to denyrange (see above).
500 <module name="channelban">
502 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
503 # Check module: Adds the /CHECK command.
504 # Check is useful for looking up information on channels, users,
505 # IP addresses and hosts.
506 # This module is oper-only.
507 # To use, CHECK must be in one of your oper class blocks.
508 <module name="check">
510 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
511 # CHGHOST module: Adds the /CHGHOST command.
512 # This module is oper-only.
513 # To use, CHGHOST must be in one of your oper class blocks.
514 # NOTE: Services will not be able to set vhosts on users if this module
515 # isn't loaded. If you're planning on running services, you probably
517 <module name="chghost">
519 #-#-#-#-#-#-#-#-# /CHGHOST - /SETHOST CONFIGURATION #-#-#-#-#-#-#-#-#
520 # Optional - If you want to use special chars for hostnames you can #
521 # specify your own custom list of chars with the <hostname> tag: #
523 # charmap - A list of chars accepted as valid by the /CHGHOST #
524 # and /SETHOST commands. Also note that the list is #
526 #<hostname charmap="abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ.-_/0123456789">
528 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
529 # CHGIDENT module: Adds the /CHGIDENT command.
530 # This module is oper-only.
531 # To use, CHGIDENT must be in one of your oper class blocks.
532 <module name="chgident">
534 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
535 # CHGNAME module: Adds the /CHGNAME command.
536 # This module is oper-only.
537 # To use, CHGNAME must be in one of your oper class blocks.
538 <module name="chgname">
540 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
541 # Connection class ban module: Adds support for extban 'n' which
542 # matches against the class name of the user's connection.
543 # This module assumes that connection classes are named in a uniform
544 # way on all servers of the network. Wildcards are accepted.
545 #<module name="classban">
547 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
548 # Clear chan module: Allows opers to masskick, masskill or
549 # mass G/Z-line all users on a channel using /CLEARCHAN.
550 #<module name="clearchan">
552 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
553 # Cloaking module: Adds user mode +x and cloaking support.
554 # Relies on the md5 module being loaded.
555 # To cloak users when they connect, load the conn_umodes module and set
556 # <connect:modes> to include the +x mode. The example <connect> tag
557 # shows this. See the conn_umodes module for more information.
558 <module name="cloaking">
560 #-#-#-#-#-#-#-#-#-#-#- CLOAKING CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#
562 # To use cloaking, you must define a cloak key, and optionally a #
563 # cloak prefix as shown below. The cloak key must be shared across #
564 # the network for consistent cloaking and must be at least thirty #
567 # There are two methods of cloaking: #
569 # half Cloak only the "unique" portion of a host; by #
570 # default show the last 2 parts of the domain, #
571 # /16 subnet of IPv4 or /48 subnet of the IPv6 #
573 # To change the number of shown parts, modify the #
574 # domainparts option. #
576 # full Cloak the users completely, using three slices for #
577 # common CIDR bans (IPv4: /16, /24; IPv6: /48, /64). #
579 # The methods use a single key that can be any length of text. #
580 # An optional prefix may be specified to mark cloaked hosts. #
582 # IMPORTANT: Changing these details will break all of your existing #
583 # bans. If you do not want this to happen you can define multiple #
584 # cloak tags. The first will be used for cloaking and the rest will #
585 # be used for checking if a user is banned in a channel. #
586 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
599 #<cloak mode="half" key="OVERRIDE ME IN SECRETS" prefix="tuwien-">
601 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
602 # Clones module: Adds an oper command /CLONES for detecting cloned
603 # users. Warning: This command may be resource intensive when it is
604 # issued, use with care.
605 # This module is oper-only.
606 # To use, CLONES must be in one of your oper class blocks.
607 <module name="clones">
609 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
610 # Codepage module: Allows using a custom 8-bit codepage for nicknames
613 # You should include one of the following files to set your codepage:
614 #<include file="examples/codepages/ascii.conf.example">
615 #<include file="examples/codepages/latin1.conf.example">
616 #<include file="examples/codepages/rfc1459.conf.example">
617 #<include file="examples/codepages/strict-rfc1459.conf.example">
619 # You can also define a custom codepage. For details on how to do this
620 # please refer to the docs site:
621 # https://docs.inspircd.org/3/modules/codepage
623 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
624 # Common channels module: Adds user mode +c, which, when set, requires
625 # that users must share a common channel with you to PRIVMSG or NOTICE
627 <module name="commonchans">
629 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
630 # Auto join on connect module: Allows you to force users to join one
631 # or more channels automatically upon connecting to the server, or
632 # join them in case they aren't on any channels after being online
634 <module name="conn_join">
636 #-#-#-#-#-#-#-#-#-#-#-#- CONNJOIN CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
638 # If you have the conn_join module loaded, you can configure it below
639 # or set autojoin="#chat,#help" in <connect> blocks.
641 # Join users immediately after connection to #one #two and #three.
642 #<autojoin channel="#one,#two,#three">
643 # Join users to #chat after 15 seconds if they aren't on any channels.
644 <autojoin channel="#tuwien" delay="90">
646 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
647 # Set modes on connect module: When this module is loaded <connect>
648 # blocks may have an optional modes="" value, which contains modes to
649 # add or remove from users when they connect to the server.
650 <module name="conn_umodes">
652 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
653 # Wait for PONG on connect module: Send a PING to all connecting users
654 # and don't let them connect until they reply with a PONG.
655 # This is useful to stop certain kinds of bots and proxies.
656 #<module name="conn_waitpong">
658 #-#-#-#-#-#-#-#-#-#-#- WAITPONG CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
660 # If you have the conn_waitpong module loaded, configure it with the #
663 # sendsnotice - Whether to send a helpful notice to users on #
664 # connect telling them how to connect, should #
665 # their client not reply PONG automatically. #
667 # killonbadreply - Whether to kill the user if they send the wrong #
670 #<waitpong sendsnotice="no" killonbadreply="yes">
672 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
673 # Channel cycle module: Adds the /CYCLE command which is a server-side
674 # /HOP that bypasses restrictive modes.
675 #<module name="cycle">
677 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
678 # Connectban: Provides IP connection throttling. Any IP range that
679 # connects too many times (configurable) in an hour is Z-lined for a
680 # (configurable) duration, and their count resets to 0.
681 #<module name="connectban">
683 # ipv4cidr and ipv6cidr allow you to turn the comparison from
684 # individual IP addresses (32 and 128 bits) into CIDR masks, to allow
685 # for throttling over whole ISPs/blocks of IPs, which may be needed to
688 # This allows for 10 connections in an hour with a 10 minute ban if
690 #<connectban threshold="10" duration="10m" ipv4cidr="32" ipv6cidr="128"
691 # A custom ban message may optionally be specified.
692 # 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.">
694 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
695 # Connection throttle module.
696 #<module name="connflood">
698 #-#-#-#-#-#-#-#-#-#-#- CONNTHROTTLE CONFIGURATION -#-#-#-#-#-#-#-#-#-#
699 # period, maxconns - Amount of connections per <period>.
701 # timeout - Time to wait after the throttle was activated
702 # before deactivating it. Be aware that the time
703 # is seconds + timeout.
705 # quitmsg - The message that users get if they attempt to
706 # connect while the throttle is active.
708 # bootwait - Amount of time in seconds to wait before enforcing
709 # the throttling when the server just booted.
711 #<connflood period="30" maxconns="3" timeout="30"
712 # quitmsg="Throttled" bootwait="2m">
714 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
715 # Custom prefixes: Allows for channel prefixes to be configured.
716 <module name="customprefix">
718 # name The name of the mode, must be unique from other modes.
719 # letter The letter used for this mode. Required.
720 # prefix The prefix used for nicks with this mode. Not required.
721 # rank A numeric rank for this prefix, defining what permissions it gives.
722 # The rank of voice, halfop and op is 10000, 20000, and 30000,
724 # ranktoset The numeric rank required to set this mode. Defaults to rank.
725 # ranktounset The numeric rank required to unset this mode. Defaults to ranktoset.
726 # depriv Can you remove the mode from yourself? Defaults to yes.
727 <customprefix name="founder" letter="q" prefix="~" rank="50000" ranktoset="50000">
728 <customprefix name="admin" letter="a" prefix="&" rank="40000" ranktoset="50000">
729 <customprefix name="halfop" letter="h" prefix="%" rank="20000" ranktoset="30000">
731 # You can also override the configuration of prefix modes added by both the core
732 # and other modules by adding a customprefix tag with change="yes" specified.
733 # <customprefix name="op" change="yes" rank="30000" ranktoset="30000">
734 # <customprefix name="voice" change="yes" rank="10000" ranktoset="20000" depriv="no">
736 # Do /RELOADMODULE customprefix after changing the settings of this module.
738 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
739 # Custom title module: Adds the /TITLE command which allows for trusted
740 # users to gain a custom whois line and an optional vhost can be
742 #<module name="customtitle">
744 #-#-#-#-#-#-#-#-#-#- CUSTOM TITLE CONFIGURATION -#-#-#-#-#-#-#-#-#-#
745 # name - The username used to identify.
746 # password - The password used to identify.
747 # hash - The hash for the specific user's password (optional).
748 # password_hash and a hashing module must be loaded
750 # host - Allowed hostmask (optional).
751 # title - Title shown in whois.
752 # vhost - Displayed host (optional).
754 #<title name="foo" password="bar" title="Official Chat Helper">
755 #<title name="bar" password="foo" host="ident@test.org" title="Official Chat Helper" vhost="helper.test.org">
756 #<title name="foo" password="$2a$10$UYZ4OcO8NNTCCGyCdY9SK.2GHiqGgxZfHFPOPmWuxEVWVQTtoDC7C" hash="bcrypt" title="Official Chat Helper">
758 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
759 # DCCALLOW module: Adds the /DCCALLOW command.
760 #<module name="dccallow">
762 #-#-#-#-#-#-#-#-#-#-#- DCCALLOW CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
763 # blockchat - Whether to block DCC CHAT as well as DCC SEND.
764 # length - Default duration of entries in DCCALLOW list.
765 # action - Default action to take if no action is
766 # specified, can be 'block' or 'allow'.
767 # maxentries - Max number of nicks to allow on a DCCALLOW list.
769 # File configuration:
770 # pattern - The glob pattern to match against.
771 # action - Action to take if a user attempts to send a file
772 # that matches this pattern, can be 'block' or
775 #<dccallow blockchat="yes" length="5m" action="block" maxentries="20">
776 #<banfile pattern="*.exe" action="block">
777 #<banfile pattern="*.txt" action="allow">
779 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
780 # Deaf module: Adds support for user modes +d and +D:
781 # d - deaf to channel messages and notices.
782 # D - deaf to user messages and notices.
783 # The +D user mode is not enabled by default to enable link compatibility
787 #-#-#-#-#-#-#-#-#-#-#-#- DEAF CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#
788 # bypasschars - Characters that bypass deaf to a regular user.
789 # bypasscharsuline - Characters that bypass deaf to a U-lined user (services).
790 # Both of these take a list of characters that must match
791 # the starting character of a message.
792 # If 'bypasscharsuline' is empty, then 'bypasschars' will
793 # match for both regular and U-lined users.
794 # enableprivdeaf - Whether to enable user mode +D (privdeaf).
795 # privdeafuline - Whether U-lined users bypass user mode +D (privdeaf).
797 <deaf bypasschars="" bypasscharsuline="!" enableprivdeaf="no" privdeafuline="yes">
799 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
800 # Delay join module: Adds the channel mode +D which delays all JOIN
801 # messages from users until they speak. If they quit or part before
802 # speaking, their quit or part message will not be shown to the channel
803 # which helps cut down noise on large channels in a more friendly way
804 # than the auditorium mode. Only channel ops may set the +D mode.
805 <module name="delayjoin">
807 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
808 # Delay message module: Adds the channel mode +d which disallows a user
809 # from talking in the channel unless they've been joined for X seconds.
810 # Settable using /MODE #chan +d 30
811 <module name="delaymsg">
812 # Set allownotice to no to disallow NOTICEs too. Defaults to yes.
813 <delaymsg allownotice="no">
815 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
816 # Deny channels module: Deny channels from being used by users.
817 #<module name="denychans">
819 #-#-#-#-#-#-#-#-#-#-#- DENYCHAN DEFINITIONS -#-#-#-#-#-#-#-#-#-#-#-#
821 # If you have the denychans module loaded, you need to specify the #
822 # channels to deny: #
824 # name - The channel name to deny (glob masks are ok). #
825 # allowopers - If operators are allowed to override the deny. #
826 # reason - Reason given for the deny. #
827 # redirect - Redirect the user to a different channel. #
829 #<badchan name="#gods*" allowopers="yes" reason="Tortoises!"> #
830 #<badchan name="#chan1" redirect="#chan2" reason="Chan1 is closed"> #
832 # Redirects will not work if the target channel is set +L. #
834 # Additionally, you may specify channels which are allowed, even if #
835 # a badchan tag specifies it would be denied: #
836 #<goodchan name="#funtimes"> #
837 # Glob masks are accepted here also. #
839 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
840 # Disable module: Provides support for disabling commands and modes. #
841 #<module name="disable">
843 #-#-#-#-#-#-#-#-#-#-#-#- DISABLE CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#
845 # If you have the disable module loaded then you need to specify the #
846 # commands and modes that you want disabled. Users who have not fully #
847 # connected yet are exempt from this module so you can e.g. disable #
848 # the NICK command but still allow users to connect to the server. #
850 # commands - A space-delimited list of commands that can not be used #
851 # by users. You can exempt server operators from this with #
852 # the servers/use-disabled-commands privilege. #
854 # chanmodes - One or more channel modes that can not be added/removed #
855 # by users. You can exempt server operators from this #
856 # with the servers/use-disabled-modes privilege. #
858 # usermodes - One or more user modes that can not be added/removed by #
859 # users. You can exempt server operators from this with #
860 # the servers/use-disabled-modes privilege. #
862 # fakenonexistent - Whether to pretend that a disabled command/mode #
863 # does not exist when executed/changed by a user. #
866 # notifyopers - Whether to send a notice to snomask `a` when a user #
867 # is prevented from using a disabled command/mode. #
870 #<disabled commands="KICK TOPIC" #
873 # fakenonexistent="yes" #
874 # notifyopers="no"> #
876 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
877 # DNS blacklist module: Provides support for looking up IPs on one or #
879 #<module name="dnsbl">
881 # For configuration options please see the docs page for dnsbl at #
882 # https://docs.inspircd.org/3/modules/dnsbl #
884 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
885 # Exempt channel operators module: Provides support for allowing #
886 # users of a specified channel status to be exempt from some channel #
887 # restriction modes. Supported restrictions are: #
888 # anticaps, auditorium-see, auditorium-vis, blockcaps, blockcolor, #
889 # censor, filter, flood, nickflood, noctcp, nonick, nonotice, #
890 # regmoderated, stripcolor, and topiclock. #
891 # See <options:exemptchanops> in inspircd.conf.example for a more #
892 # detailed list of the restriction modes that can be exempted. #
893 # These are settable using: /MODE #chan +X <restriction>:<status> #
894 #<module name="exemptchanops">
896 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
897 # Filter module: Provides message filtering, similar to SPAMFILTER. #
898 <module name="filter">
900 # This module depends upon a regex provider such as regex_pcre or #
901 # regex_glob to function. You must specify which of these you want #
902 # the filter module to use via the tag below. #
904 # Valid engines are: #
906 # glob - Glob patterns, provided via regex_glob. #
907 # pcre - PCRE regexps, provided via regex_pcre, needs libpcre. #
908 # tre - TRE regexps, provided via regex_tre, requires libtre. #
909 # posix - POSIX regexps, provided via regex_posix, not available #
910 # on Windows, no dependencies on other operating systems. #
911 # stdlib - stdlib regexps, provided via regex_stdlib, see comment #
912 # at the <module> tag for info on availability. #
914 # If notifyuser is set to no, the user will not be notified when #
915 # their message is blocked. #
917 # If warnonselfmsg is set to yes when a user sends a message to #
918 # themself that matches a filter the filter will be ignored and a #
919 # warning will be sent to opers instead. This stops spambots which #
920 # send their spam message to themselves first to check if it is being #
921 # filtered by the server. #
922 <filteropts engine="posix" notifyuser="no" warnonselfmsg="no">
924 # Your choice of regex engine must match on all servers network-wide. #
926 # To learn more about the configuration of this module, read #
927 # examples/filter.conf.example, which covers the various types of #
928 # filters and shows how to add exemptions. #
930 #-#-#-#-#-#-#-#-#-#-#- FILTER CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#
932 # Optional - If you specify to use the filter module, then #
933 # specify below the path to the filter.conf file, or define some #
936 # this is inside global.secrets now.
937 #<include file="/etc/inspircd/global.filter.conf">
939 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
940 # Flash Policy Daemon module: Allows Flash IRC clients (e.g. LightIRC)#
941 # to connect. If no file is specified, it'll serve a default policy #
942 # allowing all IPs to connect to all plaintext IRC ports #
943 #<bind address="" port="8430" type="flashpolicyd"> #
944 #<flashpolicyd timeout="5" file=""> #
945 #<module name="flashpolicyd"> #
947 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
948 # Real name ban: Implements two extended bans: #
949 # 'a', which matches a n!u@h+realname mask like +b a:*!*@host+*real* #
950 # 'r', which matches a realname mask like +b r:*realname?here* #
951 #<module name="gecosban">
953 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
954 # Geolocation ban module: Adds support for extban 'G' which matches #
955 # against the ISO 3166-1 alpha-2 codes for the countries that users #
956 # are connecting from. Users connecting from unknown origins such as #
957 # internal networks can be matched against using the XX alpha-2 code. #
958 # A full list of ISO 3166-1 alpha-2 codes can be found at #
959 # https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2 #
960 #<module name="geoban">
962 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
963 # Geolocation connect class module: Adds support for limiting connect #
964 # classes to users from specific countries. With this module you can #
965 # specify a space-delimited list of two character the ISO 3166-1 #
966 # alpha-2 codes in the "country" field of a connect class. e.g. to #
967 # deny connections from users in Russia or Turkey: #
969 # <connect deny="*" country="TR RU"> #
971 # Users connecting from unknown origins such as internal networks can #
972 # be matched against using the XX alpha-2 code. A full list of ISO #
973 # 3166-1 alpha-2 codes can be found at #
974 # https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2 #
975 #<module name="geoclass">
977 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
978 # MaxMindDB geolocation module: Provides geolocation information for #
979 # other modules that need it using the libMaxMindDB library. #
981 # This module is in extras. Re-run configure with: #
982 # ./configure --enable-extras geo_maxmind
983 # and run make install, then uncomment this module to enable it. #
985 # This module requires libMaxMindDB to be installed on your system. #
986 # Use your package manager to find the appropriate packages or check #
987 # the InspIRCd documentation page for this module. #
988 #<module name="geo_maxmind">
990 # If you use the geo_maxmind module you MUST provide a database file #
991 # to look up geolocation information in. You can either purchase this #
992 # from MaxMind at https://www.maxmind.com/en/geoip2-country-database #
993 # or use the free CC-BY-SA licensed GeoLite2 Country database which #
994 # can be downloaded at https://dev.maxmind.com/geoip/geoip2/geolite2/ #
995 #<maxmind file="GeoLite2-Country.mmdb">
997 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
998 # Globops module: Provides the /GLOBOPS command and snomask +g.
999 # This module is oper-only.
1000 # To use, GLOBOPS must be in one of your oper class blocks.
1001 <module name="globops">
1003 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1004 # Global load module: Allows loading and unloading of modules network-
1005 # wide (USE WITH EXTREME CAUTION!)
1006 # This module is oper-only and provides /GLOADMODULE, /GUNLOADMODULE
1007 # and /GRELOADMODULE.
1008 # To use, GLOADMODULE, GUNLOADMODULE and GRELOADMODULE
1009 # must be in one of your oper class blocks.
1010 #<module name="globalload">
1012 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1013 # HAProxy module: Adds support for the HAProxy PROXY v2 protocol. To
1014 # use this module specify hook="haproxy" in the <bind> tag that HAProxy
1015 # has been configured to connect to.
1016 #<module name="haproxy">
1018 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1019 # HELPOP module: Provides the /HELPOP command
1020 <module name="helpop">
1022 #-#-#-#-#-#-#-#-#-#-#-#- HELPOP CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
1024 # If you specify to use the helpop module, then specify below the #
1025 # path to the helpop.conf file. #
1027 <include file="/etc/inspircd/global.helpop.conf">
1029 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1030 # Hide chans module: Allows users to hide their channels list from non-
1031 # opers by setting user mode +I on themselves.
1032 <module name="hidechans">
1034 # This mode can optionally prevent opers from seeing channels on a +I
1035 # user, for more privacy if set to true.
1036 # This setting is not recommended for most mainstream networks.
1037 <hidechans affectsopers="false">
1039 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1040 # Hide list module: Allows for hiding the list of listmodes from users
1041 # who do not have sufficient channel rank.
1042 <module name="hidelist">
1044 # Each <hidelist> tag configures one listmode to hide.
1045 # mode: Name of the listmode to hide.
1046 # rank: Minimum rank required to view the list. If set to 0, all
1047 # members of the channel may view the list, but non-members may not.
1048 # The rank of the built-in op and voice mode is 30000 and 10000,
1049 # respectively; the rank of other prefix modes is configurable.
1050 # Defaults to 20000.
1052 # Hiding the ban list is not recommended because it may break some
1055 # Hide filter (+g) list:
1056 <hidelist mode="filter" rank="30000">
1057 # Only show invite exceptions (+I) to channel members:
1058 <hidelist mode="invex" rank="0">
1060 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1061 # Hide mode module: Allows for hiding mode changes from users who do not
1062 # have sufficient channel privileges.
1063 <module name="hidemode">
1065 # Hide bans (+b) from people who are not voiced:
1066 <hidemode mode="ban" rank="10000">
1068 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1069 # Hide oper module: Allows opers to hide their oper status from non-
1070 # opers by setting user mode +H on themselves.
1071 # This module is oper-only.
1072 <module name="hideoper">
1074 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1075 # Hostchange module: Allows a different style of cloaking.
1076 #<module name="hostchange">
1078 #-#-#-#-#-#-#-#-#-#-#- HOSTCHANGE CONFIGURATION -#-#-#-#-#-#-#-#-#-#
1080 # See https://docs.inspircd.org/3/modules/hostchange for help. #
1082 #<hostchange mask="*@42.theanswer.example.org" action="addaccount" suffix=".users.example.com">
1083 #<hostchange mask="*root@*" action="addnick" prefix="example/users/">
1084 #<hostchange mask="a@example.com" action="set" value="foo.bar.baz">
1085 #<hostchange mask="*@localhost" ports="7000,7001,7005-7007" action="set" value="blahblah.foo">
1087 # hostcycle: If loaded, when a user gets a host or ident set, it will
1088 # cycle them in all their channels. If not loaded it will simply change
1089 # their host/ident without cycling them.
1090 # This module is compatible with the ircv3_chghost module. Clients
1091 # supporting the chghost extension will get the chghost message instead
1092 # of seeing a host cycle.
1093 #<module name="hostcycle">
1095 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1096 # httpd module: Provides HTTP server support for InspIRCd.
1097 #<module name="httpd">
1099 #-#-#-#-#-#-#-#-#-#-#-#- HTTPD CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
1101 # If you choose to use the httpd module, then you will need to add
1102 # a <bind> tag with type "httpd", and load at least one of the other
1103 # httpd_* modules to provide pages to display.
1104 # <bind address="127.0.0.1" port="8067" type="httpd">
1105 # <bind address="127.0.0.1" port="8097" type="httpd" ssl="gnutls">
1107 # You can adjust the timeout for HTTP connections below. All HTTP
1108 # connections will be closed after (roughly) this time period.
1109 #<httpd timeout="20">
1111 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1112 # HTTP ACL module: Provides access control lists for httpd dependent
1113 # modules. Use this module to restrict pages by IP address and by
1115 #<module name="httpd_acl">
1117 #-#-#-#-#-#-#-#-#-#-#-#- HTTPD ACL CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
1119 # Restrict access to the httpd_stats module to all but the local
1120 # network and when the correct password is specified:
1121 # <httpdacl path="/stats*" types="password,whitelist"
1122 # username="secrets" password="mypasshere" whitelist="127.0.0.*,10.*">
1124 # Deny all connections to all but the main index page:
1125 # <httpdacl path="/*" types="blacklist" blacklist="*">
1127 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1128 # HTTP config module: Allows the server configuration to be viewed over
1129 # HTTP via the /config path. Requires the httpd module to be loaded for
1132 # IMPORTANT: This module exposes extremely sensitive information about
1133 # your server and users so you *MUST* protect it using a local-only
1134 # <bind> tag and/or the httpd_acl module. See above for details.
1135 #<module name="httpd_config">
1137 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1138 # HTTP stats module: Provides server statistics over HTTP via the /stats
1139 # path. Requires the httpd module to be loaded for it to function.
1141 # IMPORTANT: This module exposes extremely sensitive information about
1142 # your server and users so you *MUST* protect it using a local-only
1143 # <bind> tag and/or the httpd_acl module. See above for details.
1144 #<module name="httpd_stats">
1146 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1147 # Ident: Provides RFC 1413 ident lookup support.
1148 # When this module is loaded <connect:allow> tags may have an optional
1149 # useident="yes|no" boolean value, determining whether or not to lookup
1150 # ident on users matching that connect tag.
1151 #<module name="ident">
1153 #-#-#-#-#-#-#-#-#-#-#-#- IDENT CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
1155 # Optional - If you are using the ident module, then you can specify #
1156 # the timeout for ident lookups here. If not defined, it will default #
1157 # to 5 seconds. This is a non-blocking timeout which holds the user #
1158 # in a 'connecting' state until the lookup is complete. #
1159 # prefixunqueried: If on, the idents of users being in a connect class#
1160 # with ident lookups disabled (i.e. <connect useident="off">) will be #
1161 # prefixed with a "~". If off, the ident of those users will not be #
1162 # prefixed. Default is off. #
1164 #<ident timeout="5" prefixunqueried="no">
1166 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1167 # Invite exception module: Adds support for channel invite exceptions
1169 #<module name="inviteexception">
1170 # bypasskey: If this is enabled, exceptions will bypass +k as well as +i
1171 <inviteexception bypasskey="yes">
1173 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1174 # IRCv3 module: Provides the following IRCv3 extensions:
1175 # extended-join, away-notify and account-notify. These are optional
1176 # enhancements to the client-to-server protocol. An extension is only
1177 # active for a client when the client specifically requests it, so this
1178 # module needs the cap module to work.
1180 # Further information on these extensions can be found at the IRCv3
1181 # working group website:
1182 # https://ircv3.net/irc/
1184 <module name="ircv3">
1185 # The following block can be used to control which extensions are
1186 # enabled. Note that extended-join can be incompatible with delayjoin
1188 <ircv3 accountnotify="on" awaynotify="on" extendedjoin="on">
1190 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1191 # IRCv3 account-tag module. Adds the 'account' tag which contains the
1192 # services account name of the message sender.
1193 <module name="ircv3_accounttag">
1195 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1196 # IRCv3 batch module: Provides the batch IRCv3 extension which allows
1197 # the server to inform a client that a group of messages are related to
1199 <module name="ircv3_batch">
1201 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1202 # IRCv3 cap-notify module: Provides the cap-notify IRCv3 extension.
1203 # Required for IRCv3 conformance.
1204 <module name="ircv3_capnotify">
1206 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1207 # IRCv3 chghost module: Provides the chghost IRCv3 extension which
1208 # allows capable clients to learn when the host/ident of another user
1209 # changes without cycling the user. This module is compatible with the
1210 # hostcycle module. If both are loaded, clients supporting the chghost
1211 # extension will get the chghost message and won't see host cycling.
1212 <module name="ircv3_chghost">
1214 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1215 # IRCv3 client-to-client tags module: Provides the message-tags IRCv3
1216 # extension which allows clients to add extra data to their messages.
1217 # This is used to support new IRCv3 features such as replies and ids.
1218 <module name="ircv3_ctctags">
1220 # If you want to only allow client tags that are intended for processing
1221 # by the server you can disable the following setting. Doing this is not
1222 # recommended though as it may break clients.
1223 <ctctags allowclientonlytags="yes">
1225 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1226 # IRCv3 echo-message module: Provides the echo-message IRCv3
1227 # extension which allows capable clients to get an acknowledgement when
1228 # their messages are delivered and learn what modifications, if any,
1229 # were applied to them.
1230 <module name="ircv3_echomessage">
1232 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1233 # IRCv3 invite-notify module: Provides the invite-notify IRCv3
1234 # extension which notifies supporting clients when a user invites
1235 # another user into a channel. This respects <options:announceinvites>.
1236 <module name="ircv3_invitenotify">
1238 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1239 # IRCv3 labeled-response module: Provides the labeled-response IRCv3
1240 # extension which allows server responses to be associated with the
1241 # client message which caused them to be sent.
1242 <module name="ircv3_labeledresponse">
1244 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1245 # IRCv3 message id module: Provides the msgid IRCv3 extension which
1246 # adds a unique identifier to each message when the message-tags cap
1247 # has been requested. This enables support for modern features such as
1248 # reactions and replies.
1249 <module name="ircv3_msgid">
1251 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1252 # IRCv3 server-time module. Adds the 'time' tag which adds a timestamp
1253 # to all messages received from the server.
1254 <module name="ircv3_servertime">
1256 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1257 # IRCv3 Strict Transport Security module: Provides the sts IRCv3
1258 # extension which allows clients connecting insecurely to upgrade their
1259 # connections to TLS.
1260 #<module name="ircv3_sts">
1262 # If using the ircv3_sts module you MUST define a STS policy to send
1263 # to clients using the <sts> tag. This tag takes the following
1266 # host - A glob match for the SNI hostname to apply this policy to.
1267 # duration - The amount of time that the policy lasts for. Defaults to
1268 # five minutes by default. You should raise this to a month
1269 # or two once you know that your config is valid.
1270 # port - The port on which TLS connections to the server are being
1271 # accepted. You MUST have a CA-verified certificate on this
1272 # port. Self signed certificates are not acceptable.
1273 # preload - Whether client developers can include your certificate in
1276 # <sts host="*.example.com" duration="5m" port="6697" preload="yes">
1278 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1279 # Join flood module: Adds support for join flood protection +j X:Y.
1280 # Closes the channel for N seconds if X users join in Y seconds.
1281 <module name="joinflood">
1283 # duration: The number of seconds to close a channel for when it is
1284 # being flooded with joins.
1286 # bootwait: The number of seconds to disengage joinflood for after
1287 # a server boots. This allows users to reconnect without
1288 # being throttled by joinflood.
1290 # splitwait: The number of seconds to disengage joinflood for after
1291 # a server splits. This allows users to reconnect without
1292 # being throttled by joinflood.
1294 <joinflood duration="1m"
1298 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1299 # Anti auto rejoin: Adds support for prevention of auto-rejoin (+J).
1300 <module name="kicknorejoin">
1302 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1303 # Knock module: Adds the /KNOCK command and channel mode +K.
1304 <module name="knock">
1306 # This setting specifies what to do when someone successfully /KNOCKs.
1307 # If set to "notice", then a NOTICE will be sent to the channel.
1308 # This is the default and the compatible setting, as it requires no
1309 # special support from the clients.
1310 # If set to "numeric" then a 710 numeric will be sent to the channel.
1311 # This allows easier scripting but not all clients support it.
1312 # If set to "both" then (surprise!) both will be sent.
1313 <knock notify="notice">
1315 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1316 # LDAP module: Allows other SQL modules to access a LDAP database
1317 # through a unified API.
1318 # This modules is in extras. Re-run configure with:
1319 # ./configure --enable-extras ldap
1320 # and run make install, then uncomment this module to enable it.
1322 #<module name="ldap">
1323 #<database module="ldap" id="ldapdb" server="ldap://localhost" binddn="cn=Manager,dc=inspircd,dc=org" bindauth="mysecretpass" searchscope="subtree">
1324 # The server parameter indicates the LDAP server to connect to. The #
1325 # ldap:// style scheme before the hostname proper is MANDATORY. #
1327 # The binddn and bindauth indicate the DN to bind to for searching, #
1328 # and the password for the distinguished name. Some LDAP servers will #
1329 # allow anonymous searching in which case these two values do not #
1330 # need defining, otherwise they should be set similar to the examples #
1333 # The searchscope value indicates the subtree to search under. On our #
1334 # test system this is 'subtree'. Your mileage may vary. #
1336 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1337 # LDAP authentication module: Adds the ability to authenticate users #
1339 #<module name="ldapauth">
1343 # <ldapauth dbid="ldapdb" #
1344 # baserdn="ou=People,dc=brainbox,dc=cc" #
1346 # allowpattern="Guest* Bot*" #
1347 # killreason="Access denied" #
1349 # host="$uid.$ou.inspircd.org" #
1350 # useusername="no"> #
1352 # <ldapwhitelist cidr="10.42.0.0/16"> #
1354 # <ldaprequire attribute="attr" value="val"> #
1356 # The baserdn indicates the base DN to search in for users. Usually #
1357 # this is 'ou=People,dc=yourdomain,dc=yourtld'. #
1359 # The attribute value indicates the attribute which is used to locate #
1360 # a user account by name. On POSIX systems this is usually 'uid'. #
1362 # The allowpattern value allows you to specify a space separated list #
1363 # of wildcard masks which will always be allowed to connect #
1364 # regardless of if they have an account, for example guest and bot #
1367 # The useusername setting chooses whether the user's username or #
1368 # nickname is used when locating a user account, if a username isn't #
1369 # provided in PASS. #
1371 # Killreason indicates the QUIT reason to give to users if they fail #
1372 # to authenticate. #
1374 # Setting the verbose value causes an oper notice to be sent out for #
1375 # every failed authentication to the server, with an error string. #
1377 # ldapwhitelist indicates that clients connecting from an IP in the #
1378 # provided CIDR do not need to authenticate against LDAP. It can be #
1379 # repeated to whitelist multiple CIDRs. #
1381 # ldaprequire allows further filtering on the LDAP user, by requiring #
1382 # certain LDAP attributes to have a given value. It can be repeated, #
1383 # in which case the list will act as an OR list, that is, the #
1384 # authentication will succeed if any of the requirements in the list #
1387 # host allows you to change the displayed host of users connecting #
1388 # from ldap. The string supplied takes formatters which are replaced #
1389 # from the DN. For instance, if your DN looks like: #
1390 # uid=w00t,ou=people,dc=inspircd,dc=org, then the formatters uid, ou #
1391 # and dc will be available to you. If a key is given multiple times #
1392 # in the DN, the last appearance will take precedence. #
1394 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1395 # LDAP oper configuration module: Adds the ability to authenticate #
1397 #<module name="ldapoper">
1401 # <ldapoper dbid="ldapdb"
1402 # baserdn="ou=People,dc=brainbox,dc=cc"
1405 # Available configuration items are identical to the same items in #
1406 # ldapauth above (except for the verbose setting, that is only #
1407 # supported in ldapauth). #
1408 # Please always specify a password in your <oper> tags even if the #
1409 # opers are to be authenticated via LDAP, so in case this module is #
1410 # not loaded the oper accounts are still protected by a password. #
1412 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1413 # Lock server module: Adds /LOCKSERV and /UNLOCKSERV commands that #
1414 # are used to temporarily close/open the server for new connections. #
1415 # These commands require that the /LOCKSERV and /UNLOCKSERV commands #
1416 # are specified in a <class> tag that the oper is part of. This is so #
1417 # you can control who has access to this possible dangerous command. #
1418 # If your server is locked and you get disconnected, do a REHASH from #
1419 # shell to open up again. #
1420 # This module is oper-only.
1421 #<module name="lockserv">
1423 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1424 # Map hiding module: replaces /MAP and /LINKS output to users with a #
1425 # message to see a website, set by maphide="https://test.org/map" in #
1426 # the <security> tag, instead. #
1427 #<module name="maphide">
1429 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1430 # Message flood module: Adds message/notice flood protection via
1432 <module name="messageflood">
1434 # The weight to give each message type. TAGMSGs are considered to be
1435 # 1/5 of a NOTICE or PRIVMSG to avoid users being accidentally flooded
1436 # out of a channel by automatic client features such as typing
1438 <messageflood notice="1.0" privmsg="1.0" tagmsg="0.2">
1440 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1441 # MLOCK module: Adds support for server-side enforcement of services
1442 # side MLOCKs. Basically, this module suppresses any mode change that
1443 # would likely be immediately bounced by services.
1444 <module name="mlock">
1446 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1447 # Modenotice module: Adds the /MODENOTICE command that allows opers to
1448 # send notices to all users having the given user mode(s) set.
1449 <module name="modenotice">
1451 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1452 # Monitor module: Adds support for MONITOR which is used by clients to
1453 # maintain notify lists.
1454 <module name="monitor">
1456 # Set the maximum number of entries on a user's monitor list below.
1457 <monitor maxentries="64">
1459 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1460 # MySQL module: Allows other SQL modules to access MySQL databases
1461 # through a unified API.
1462 # This module is in extras. Re-run configure with:
1463 # ./configure --enable-extras mysql
1464 # and run make install, then uncomment this module to enable it.
1465 #<module name="mysql">
1467 #-#-#-#-#-#-#-#-#-#-#-#- SQL CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#-#
1469 # mysql is more complex than described here, see the docs for more #
1470 # info: https://docs.inspircd.org/3/modules/mysql #
1472 #<database module="mysql" name="mydb" user="myuser" pass="mypass" host="localhost" id="my_database2">
1474 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1475 # Named modes module: Allows for the display and set/unset of channel
1476 # modes via long-form mode names via +Z and the /PROP command.
1477 # For example, to set a ban, do /MODE #channel +Z ban=foo!bar@baz or
1478 # /PROP #channel ban=foo!bar@baz
1479 <module name="namedmodes">
1481 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1482 # NAMESX module: Provides support for the NAMESX extension which allows
1483 # clients to see all the prefixes set on a user without getting confused.
1484 # This is supported by mIRC, x-chat, klient, and maybe more.
1485 <module name="namesx">
1487 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1488 # National characters module:
1489 # 1) Allows using national characters in nicknames.
1490 # 2) Allows using custom (national) casemapping over the network.
1492 # This module is incredibly poorly written and documented. You should
1493 # probably use the codepage module instead for 8-bit codepages.
1494 <module name="nationalchars">
1496 # file - Location of the file which contains casemapping rules. If this
1497 # is a relative path then it is relative to "<PWD>/../locales"
1498 # on UNIX and "<PWD>/locales" on Windows.
1499 # casemapping - The name of the casemapping sent to clients in the 005
1500 # numeric. If this is not set then it defaults to the name
1501 # of the casemapping file unless the file name contains a
1502 # space in which case you will have to specify it manually.
1503 <nationalchars file="/etc/inspircd/global.cjk-utf8" casemapping="utf8">
1505 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1506 # Nickchange flood protection module: Provides channel mode +F X:Y
1507 # which allows up to X nick changes in Y seconds.
1508 <module name="nickflood">
1510 # The number of seconds to prevent nick changes for:
1511 <nickflood duration="1m">
1513 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1514 # Nicklock module: Let opers change a user's nick and then stop that
1515 # user from changing their nick again until unlocked.
1516 # This module is oper-only.
1517 # To use, NICKLOCK and NICKUNLOCK must be in one of your oper class blocks.
1518 <module name="nicklock">
1520 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1521 # No CTCP module: Adds the channel mode +C and user mode +T to block
1522 # CTCPs and extban 'C' to block CTCPs sent by specific users.
1523 <module name="noctcp">
1525 # The +T user mode is not enabled by default to enable link compatibility
1526 # with 2.0 servers. You can enable it by uncommenting this:
1527 <noctcp enableumode="yes">
1529 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1530 # No kicks module: Adds the +Q channel mode and the Q: extban to deny
1531 # certain users from kicking.
1532 <module name="nokicks">
1534 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1535 # No nicks module: Adds the +N channel mode, as well as the 'N' extban.
1536 # +N stops all users from changing their nick, the N extban stops
1537 # anyone from matching a +b N:nick!user@host mask from changing their
1539 <module name="nonicks">
1541 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1542 # No part message module: Adds extban 'p' to block part messages from #
1544 <module name="nopartmsg">
1546 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1547 # No notice module: Adds the channel mode +T and the extban 'T' to
1548 # block specific users from noticing the channel.
1549 <module name="nonotice">
1551 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1552 # Network business join module:
1553 # Allows an oper to join a channel using /OJOIN, giving them +Y on the
1554 # channel which makes them immune to kicks.
1555 <module name="ojoin">
1557 # Specify the prefix that +Y will grant here.
1558 # Leave 'prefix' empty if you do not wish +Y to grant a prefix.
1559 # If 'notice' is set to on, upon /OJOIN, the server will notice the
1560 # channel saying that the oper is joining on network business.
1561 # If 'op' is set to on, it will give them +o along with +Y.
1562 <ojoin prefix="!" notice="yes" op="yes">
1564 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1565 # Oper channels mode: Adds the +O channel mode and extban O:<mask>
1566 # to ban, except, etc. specific oper types. For example
1567 # /MODE #channel +iI O:* is equivalent to channel mode +O, but you
1568 # may also set +iI O:AdminTypeOnly to only allow admins.
1569 # Modes +I and +e work in a similar fashion.
1570 #<module name="operchans">
1572 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1573 # Oper join module: Auto-joins opers to a channel upon oper-up.
1574 # This module is oper-only. For the user equivalent, see the conn_join
1576 #<module name="operjoin">
1578 #-#-#-#-#-#-#-#-#-#-# OPERJOIN CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
1580 # If you are using the operjoin module, specify options here: #
1582 # channel - The channel name to join, can also be a comma #
1583 # separated list e.g. "#channel1,#channel2". #
1585 # override - If on, lets the oper join walking thru any modes #
1586 # that might be set, even bans. #
1588 #<operjoin channel="#channel" override="no">
1590 # Alternatively you can use the autojoin="channellist" in a <type> #
1591 # tag to set specific autojoins for a type of oper, for example: #
1593 #<type name="Helper" autojoin="#help" classes="...">
1595 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1596 # Oper log module: Logs all oper commands to the server log (with log
1597 # type "m_operlog" at default loglevel), and optionally to the 'r'
1599 # This module is oper-only.
1600 <module name="operlog">
1602 # If the following option is on then all oper commands will be sent to
1603 # the snomask 'r'. The default is off.
1604 <operlog tosnomask="off">
1606 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1607 # Oper prefixing module: Adds a channel prefix mode +y which is given
1608 # to all server operators automatically on all channels they are in.
1609 # This prefix mode is more powerful than channel op and other regular
1612 # Load this module if you want all your server operators to have
1613 # channel operator powers.
1614 #<module name="operprefix">
1616 # You may additionally customise the prefix character.
1617 #<operprefix prefix="!">
1619 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1620 # Oper MOTD module: Provides support for a separate message of the day
1622 # This module is oper-only.
1623 <module name="opermotd">
1625 #-#-#-#-#-#-#-#-#-#-# OPERMOTD CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
1627 # If you are using the opermotd module, specify the motd file here. #
1629 # onoper - If on, the message is sent on /OPER, otherwise it's #
1630 # only sent when /OPERMOTD is used. #
1632 <opermotd file="/etc/inspircd/global.opermotd.txt" onoper="yes">
1634 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1635 # Override module: Adds support for oper override.
1636 # This module is oper-only.
1637 #<module name="override">
1639 #-#-#-#-#-#-#-#-#-#-# OVERRIDE CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
1641 # Much of override's configuration relates to your oper blocks. #
1642 # For more information on how to allow opers to override, see: #
1643 # https://docs.inspircd.org/3/modules/override #
1645 # noisy - If enabled, all oper overrides will be announced #
1646 # via channel notice. #
1648 # requirekey - If enabled, overriding on join requires a channel #
1649 # key of "override" to be specified. #
1651 # enableumode - If enabled, user mode +O is required for override. #
1653 #<override noisy="yes" requirekey="no" enableumode="yes">
1655 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1656 # Oper levels module: Gives each oper a level and prevents actions
1657 # being taken by lower level opers against higher level opers.
1658 # Specify the level as the 'level' parameter of the <type> tag.
1659 # This module is oper-only.
1660 #<module name="operlevels">
1662 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1663 # Oper modes module: Allows you to specify modes to add/remove on oper.
1664 # Specify the modes as the 'modes' parameter of the <type> tag
1665 # and/or as the 'modes' parameter of the <oper> tag.
1666 # This module is oper-only. For the user equivalent, see the
1667 # conn_umodes module.
1668 <module name="opermodes">
1670 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1671 # Password forwarding module: Forwards a password users can send on
1672 # connect to the specified client below. The client is usually NickServ
1673 # and this module is usually used to authenticate users with NickServ
1674 # using their connect password.
1675 <module name="passforward">
1678 # nick: nick to forward connect passwords to.
1681 # forwardmsg: Message to send to users using a connect password.
1682 # $nick will be the users' nick, $nickrequired will be the nick
1683 # of where the password is going (the nick above).
1684 # You can also use $user for the user ident string.
1685 forwardmsg="NOTICE $nick :*** Forwarding PASS to $nickrequired"
1687 # cmd: Command for the user to run when it receives a connect
1689 cmd="SQUERY $nickrequired :IDENTIFY $pass">
1691 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1692 # Password hash module: Allows hashed passwords to be used.
1693 # To be useful, a hashing module like bcrypt also needs to be loaded.
1694 <module name="password_hash">
1696 #-#-#-#-#-#-#-#-#-# PASSWORD HASH CONFIGURATION #-#-#-#-#-#-#-#-#-#-#-#
1698 # To use this module, you must define a hash type for each oper's
1699 # password you want to hash. For example:
1701 # <oper name="Brain"
1702 # host="ident@dialup15.isp.test.com"
1704 # password="$2a$10$Mss9AtHHslZTLBrXqM0FB.JBwD.UTSu8A48SfrY9exrpxbsRiRTbO"
1707 # If you are using a hash algorithm which does not perform salting you can use
1708 # HMAC to salt your passwords in order to prevent them from being looked up in
1711 # hash="hmac-sha256" password="lkS1Nbtp$CyLd/WPQXizsbxFUTqFRoMvaC+zhOULEeZaQkUJj+Gg"
1713 # Generate hashes using the /MKPASSWD command on the server.
1714 # Don't run it on a server you don't trust with your password.
1716 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1717 # PBKDF2 module: Allows other modules to generate PBKDF2 hashes,
1718 # usually for cryptographic uses and security.
1719 # This module relies on other hash providers (e.g. SHA256).
1720 <module name="pbkdf2">
1722 # iterations: Iterations the hashing function runs when generating new
1724 # length: Length in bytes of the derived key.
1725 <pbkdf2 iterations="12288" length="32">
1726 # You can override these values with specific values
1727 # for specific providers if you want to. Example given for SHA256.
1728 <pbkdf2prov hash="sha256" iterations="24576">
1730 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1731 # Permanent channels module: Channels with the permanent channel mode
1732 # will remain open even after everyone else has left the channel, and
1733 # therefore keep things like modes, ban lists and topic. Permanent
1734 # channels -may- need support from your Services package to function
1735 # properly with them. This adds channel mode +P.
1736 # This module is oper-only.
1737 #<module name="permchannels">
1739 # If you like, this module can write a config file of permanent channels
1740 # whenever +P is set, unset, or the topic/modes on a +P channel is changed.
1741 # If you want to do this, set the filename below, and uncomment the include.
1743 # If 'listmodes' is true then all list modes (+b, +I, +e, +g...) will be
1744 # saved. Defaults to false.
1746 # 'saveperiod' determines how often to check if the database needs to be
1747 # saved to disk. Defaults to every five seconds.
1748 #<permchanneldb filename="permchannels.conf"
1751 #<include file="permchannels.conf">
1753 # You may also create channels on startup by using the <permchannels> block.
1754 #<permchannels channel="#opers" modes="isP" topic="Opers only.">
1756 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1757 # PostgreSQL module: Allows other SQL modules to access PgSQL databases
1758 # through a unified API.
1759 # This module is in extras. Re-run configure with:
1760 # ./configure --enable-extras pgsql
1761 # and run make install, then uncomment this module to enable it.
1762 #<module name="pgsql">
1764 #-#-#-#-#-#-#-#-#-#-#-#- SQL CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#-#
1766 # pgsql is more complex than described here, see the docs for #
1767 # more: https://docs.inspircd.org/3/modules/pgsql #
1769 #<database module="pgsql" name="mydb" user="myuser" pass="mypass" host="localhost" id="my_database" ssl="no">
1771 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1772 # Muteban: Implements extended ban 'm', which stops anyone matching
1773 # a mask like +b m:nick!user@host from speaking on channel.
1774 #<module name="muteban">
1776 # If notifyuser is set to no, the user will not be notified when
1777 # their message is blocked.
1778 #<muteban notifyuser="yes">
1780 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1781 # Random quote module: Provides a random quote on connect.
1782 # NOTE: Some of these may mimic fatal errors and confuse users and
1783 # opers alike - BEWARE!
1784 #<module name="randquote">
1786 #-#-#-#-#-#-#-#-#-#- RANDOMQUOTES CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
1788 # Optional - If you specify to use the randquote module, then specify #
1789 # below the path to the quotes file. #
1791 #<randquote file="quotes.txt">
1793 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1794 # Redirect module: Adds channel mode +L which redirects users to #
1795 # another channel when the channel has reached its user limit and #
1796 # user mode +L which stops redirection. #
1797 #<module name="redirect">
1799 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1800 # Regular expression provider for glob or wildcard (?/*) matching.
1801 # You must have at least 1 provider loaded to use the filter or R-line
1802 # modules. This module has no additional requirements, as it uses the
1803 # matching already present in InspIRCd core.
1804 <module name="regex_glob">
1806 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1807 # Regular expression provider for PCRE (Perl-Compatible Regular
1808 # Expressions). You need libpcre installed to compile and load this
1809 # module. You must have at least 1 provider loaded to use the filter or
1811 #<module name="regex_pcre">
1813 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1814 # Regular Expression Provider for RE2 Regular Expressions.
1815 # You need libre2 installed and in your include/library paths in order
1816 # to compile and load this module.
1817 #<module name="regex_re2">
1819 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1820 # Regular expression provider for POSIX regular expressions.
1821 # You shouldn't need any additional libraries on a POSIX-compatible
1822 # system (i.e.: any Linux, BSD, but not Windows). You must have at
1823 # least 1 provider loaded to use the filter or R-line modules.
1824 # On POSIX-compliant systems, regex syntax can be found by using the
1825 # command: 'man 7 regex'.
1826 <module name="regex_posix">
1828 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1829 # Regular expression provider for C++11 std::regex regular expressions.
1830 # This module works on any fully compliant implementation of the C++11
1831 # std::regex container. Examples for such are Visual C++ 2010 and newer
1832 # but not libstdc++ (which GCC uses).
1833 # You should verify that std::regex is supported by your setup before
1834 # using this module, as it may compile normally but won't do anything
1835 # on some implementations.
1836 #<module name="regex_stdlib">
1838 # Specify the regular expression engine to use here. Valid settings are
1839 # bre, ere, awk, grep, egrep, ecmascript (default if not specified).
1840 #<stdregex type="ecmascript">
1842 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1843 # Regular expression provider for TRE regular expressions.
1844 # This is the same regular expression engine used by UnrealIRCd, so
1845 # if you are most familiar with the syntax of /SPAMFILTER from there,
1846 # this is the provider you want. You need libtre installed in order
1847 # to compile and load this module.
1848 #<module name="regex_tre">
1850 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1851 # Remove module: Adds the /REMOVE command which is a peaceful
1852 # alternative to /KICK. It also provides the /FPART command which works
1853 # in the same way as /REMOVE.
1854 <module name="remove">
1856 # supportnokicks: If true, /REMOVE is not allowed on channels where the
1857 # nokicks (+Q) mode is set. Defaults to false.
1858 # protectedrank: Members having this rank or above may not be /REMOVE'd
1859 # by anyone. Set to 0 to disable this feature. Defaults to 50000.
1860 <remove supportnokicks="yes" protectedrank="50000">
1862 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1863 # Repeat module: Allows to block, kick or ban upon similar messages
1864 # being uttered several times. Provides channel mode +E.
1866 # Syntax: [~|*]<lines>:<sec>[:<difference>][:<backlog>]
1867 # ~ is to block, * is to ban, default is kick.
1868 # lines - In mode 1, the amount of lines that has to match consecutively.
1869 # In mode 2, the size of the backlog to keep for matching.
1870 # seconds - How old the message has to be before it's invalidated.
1871 # difference - Edit distance, in percent, between two strings to trigger on.
1872 # backlog - When set, the function goes into mode 2. In this mode the
1873 # function will trigger if this many of the last <lines> matches.
1875 # As this module can be rather CPU-intensive, it comes with some options.
1876 # maxbacklog - Maximum size that can be specified for backlog. 0 disables
1877 # multiline matching.
1878 # maxdistance - Max percentage of difference between two lines we'll allow
1879 # to match. Set to 0 to disable edit-distance matching.
1880 # maxlines - Max lines of backlog to match against.
1881 # maxtime - Maximum period of time a user can set. 0 to allow any.
1882 # size - Maximum number of characters to check for, can be used to
1883 # truncate messages before they are checked, resulting in
1884 # less CPU usage. Increasing this beyond 512 doesn't have
1885 # any effect, as the maximum length of a message on IRC
1886 # cannot exceed that.
1887 #<repeat maxbacklog="20" maxdistance="50" maxlines="20" maxtime="0" size="512">
1888 #<module name="repeat">
1890 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1891 # Restricted channels module: Allows only opers with the
1892 # channels/restricted-create priv and/or registered users to
1895 # You probably *DO NOT* want to load this module on a public network.
1897 #<module name="restrictchans">
1899 # allowregistered: should registered users be allowed to bypass the restrictions?
1900 #<restrictchans allowregistered="no">
1902 # Allow any channel matching #user-* to be created, bypassing restrictchans checks
1903 #<allowchannel name="#user-*">
1905 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1906 # Restrict message module: Allows users to only message opers.
1908 # You probably *DO NOT* want to load this module on a public network.
1910 #<module name="restrictmsg">
1912 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1913 # R-line module: Ban users through regular expression patterns.
1914 <module name="rline">
1916 #-#-#-#-#-#-#-#-#-#-#-#- RLINE CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#-#
1918 # If you wish to re-check a user when they change nickname (can be
1919 # useful under some situations, but *can* also use CPU with more users
1920 # on a server) then set 'matchonnickchange' to yes.
1921 # If you additionally want Z-lines to be added on matches, then
1922 # set 'zlineonmatch' to yes.
1923 # Also, this is where you set what Regular Expression engine is to be
1924 # used. If you ever change it while running, all of your R-lines will
1925 # be wiped. This is the regex engine used by all R-lines set, and
1926 # regex_<engine> must be loaded, or rline will be non-functional
1927 # until you load it or change the engine to one that is loaded.
1929 <rline matchonnickchange="yes" zlineonmatch="no" engine="posix">
1931 # Generally, you will NOT want to use 'glob' here, as this turns an
1932 # R-line into just another G-line. The exceptions are that R-lines will
1933 # always use the full "nick!user@host realname" string, rather than only
1934 # user@host, but beware that only the ? and * wildcards are available,
1935 # and are the only way to specify where the space can occur if you do
1936 # use glob. For this reason, is recommended to use a real regex engine
1937 # so that at least \s or [[:space:]] is available.
1939 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1940 # RMODE module: Adds the /RMODE command.
1941 # Allows channel operators to remove list modes en masse, optionally
1942 # matching a glob-based pattern.
1943 # Syntax: /RMODE <channel> <mode> [<pattern>]
1944 # E.g. '/RMODE #channel b m:*' will remove all mute extbans on the channel.
1945 <module name="rmode">
1947 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1948 # SAJOIN module: Adds the /SAJOIN command which forcibly joins a user
1949 # to the given channel.
1950 # This module is oper-only.
1951 # To use, SAJOIN must be in one of your oper class blocks.
1952 # Opers need the users/sajoin-others priv to be able to /SAJOIN users
1953 # other than themselves.
1954 <module name="sajoin">
1956 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1957 # SAKICK module: Adds the /SAKICK command which kicks a user from the
1959 # This module is oper-only.
1960 # To use, SAKICK must be in one of your oper class blocks.
1961 <module name="sakick">
1963 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1964 # SAMODE module: Adds the /SAMODE command which allows server operators
1965 # to change modes on a channel without requiring them to have any
1966 # channel privileges. Also allows changing user modes for any user.
1967 # This module is oper-only.
1968 # To use, SAMODE must be in one of your oper class blocks.
1969 <module name="samode">
1971 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1972 # SANICK module: Adds the /SANICK command which allows opers to change
1974 # This module is oper-only.
1975 # To use, SANICK must be in one of your oper class blocks.
1976 <module name="sanick">
1978 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1979 # SAPART module: Adds the /SAPART command which forcibly parts a user
1981 # This module is oper-only.
1982 # To use, SAPART must be in one of your oper class blocks.
1983 <module name="sapart">
1985 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1986 # SAQUIT module: Adds the /SAQUIT command which forcibly quits a user.
1987 # This module is oper-only.
1988 # To use, SAQUIT must be in one of your oper class blocks.
1989 <module name="saquit">
1991 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1992 # SATOPIC module: Adds the /SATOPIC command which allows changing the
1993 # topic on a channel without requiring any channel privileges.
1994 # This module is oper-only.
1995 # To use, SATOPIC must be in one of your oper class blocks.
1996 <module name="satopic">
1998 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1999 # SASL authentication module: Provides support for IRC Authentication
2000 # Layer via AUTHENTICATE. Note: You also need to have cap loaded
2002 <module name="sasl">
2004 # You must define <sasl:target> to the name of your services server so
2005 # that InspIRCd knows where to send SASL authentication messages and
2006 #Â when it should enable the SASL capability.
2007 # You can also define <sasl:requiressl> to require users to use TLS (SSL)
2008 # in order to be able to use SASL.
2009 <sasl target="services.somenet.org" requiressl="yes">
2011 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2012 # Secure list module: Prevent /LIST in the first minute of connection,
2013 # crippling most spambots and trojan spreader bots.
2014 #<module name="securelist">
2016 #-#-#-#-#-#-#-#-#-# SECURELIST CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#-#
2018 # Securelist can be harmful to some IRC search engines. To prevent #
2019 # securelist blocking these sites from listing, define exception tags #
2021 #<securehost exception="*@*.netsplit.de">
2022 #<securehost exception="*@*.ircdriven.com">
2023 #<securehost exception="*@*.ircs.me">
2025 # exemptregistered - Whether the waiting period applies to users who #
2026 # are logged in to a services account. #
2029 # showmsg - Whether to tell users that they need to wait for a while #
2030 # before they can use the /LIST command. #
2033 # waittime - The time period that a user must be connected for before #
2034 # they can use the /LIST command. #
2035 # Defaults to 1 minute. #
2037 #<securelist exemptregistered="yes"
2041 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2042 # Servprotect module: Provides support for Austhex style +k /
2043 # UnrealIRCD +S services mode.
2044 <module name="servprotect">
2046 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2047 # See nicks module: Adds snomask +n and +N which show local and remote
2049 # This module is oper-only.
2050 #<module name="seenicks">
2052 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2053 # Set idle module: Adds a command for opers to change their idle time.
2054 # This module is oper-only.
2055 # To use, SETIDLE must be in one of your oper class blocks.
2056 #<module name="setidle">
2058 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2059 # Services support module: Adds several user modes such as +R and +M.
2060 # This module implements the 'identified' state via account names,
2061 # and is similar in operation to the way asuka and ircu handle services.
2063 # At the same time, this offers +r for users and channels to mark them
2064 # as identified separately from the idea of a master account, which
2065 # can be useful for services which are heavily nick-as-account centric.
2067 # Also of note is that this module implements two extbans:
2068 # +b R: (stop matching account names from joining)
2069 # +b U:n!u@h (blocks matching unregistered users)
2071 <module name="services_account">
2073 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2074 # Sethost module: Adds the /SETHOST command.
2075 # This module is oper-only.
2076 # To use, SETHOST must be in one of your oper class blocks.
2077 # See the chghost module for how to customise valid chars for hostnames.
2078 <module name="sethost">
2080 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2081 # Setident module: Adds the /SETIDENT command.
2082 # This module is oper-only.
2083 # To use, SETIDENT must be in one of your oper class blocks.
2084 <module name="setident">
2086 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2087 # SETNAME module: Adds the /SETNAME command.
2088 <module name="setname">
2090 #-#-#-#-#-#-#-#-#-#-#-#- SETNAME CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#
2092 # operonly - Whether the SETNAME command should only be usable by #
2093 # server operators. Defaults to no. #
2095 # notifyopers - Whether to send a snotice to snomask `a` when a user #
2096 # changes their real name. Defaults to to yes if #
2097 # oper-only and no if usable by everyone. #
2099 #<setname notifyopers="yes"
2102 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2103 # Serverban: Implements extended ban 's', which stops anyone connected
2104 # to a server matching a mask like +b s:server.mask.here from joining.
2105 # Wildcards are accepted.
2106 <module name="serverban">
2108 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2109 # SHA1 module: Allows other modules to generate SHA1 hashes.
2110 # Required by the WebSocket module.
2111 #<module name="sha1">
2113 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2114 # Showfile: Provides support for showing a text file to users when #
2115 # they enter a command. #
2116 # This module adds one command for each <showfile> tag that shows the #
2117 # given file to the user as a series of messages or numerics. #
2118 #<module name="showfile">
2120 #-#-#-#-#-#-#-#-#-#-# SHOWFILE CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#-#
2122 # name - The name of the command which displays this file. This is #
2123 # the only mandatory setting, all others are optional. #
2124 # file - The text file to be shown to the user. #
2125 # By default same as the command name. #
2126 # method - How should the file be shown? #
2127 # * numeric: Send contents using a numeric #
2128 # (similar to /MOTD; the default). #
2129 # * notice: Send contents as a series of notices. #
2130 # * msg: Send contents as a series of private messages. #
2132 # When using the method "numeric", the following extra settings are #
2135 # introtext - Introductory line, "Showing <name>" by default. #
2136 # intronumeric - Numeric used for the introductory line. #
2137 # numeric - Numeric used for sending the text itself. #
2138 # endtext - Ending line, "End of <name>" by default. #
2139 # endnumeric - Numeric used for the ending line. #
2141 #<showfile name="RULES"
2143 # introtext="Server rules:"
2144 # endtext="End of server rules.">
2146 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2147 # Show whois module: Adds the +W user mode which allows opers to see
2148 # when they are /WHOIS'd.
2149 # This module is oper-only by default.
2150 <module name="showwhois">
2152 # If you wish, you may also let users set this mode. Only opers with the
2153 # users/auspex priv will see real hosts of people, though.
2154 <showwhois opersonly="no"
2156 # You may also set whether or not users should receive whois notices,
2157 # should they be /WHOIS'd by an oper.
2160 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2161 # Shun module: Provides the /SHUN command, which stops a user from
2162 # executing all except configured commands.
2163 # This module is oper-only.
2164 # To use, SHUN must be in one of your oper class blocks.
2165 #<module name="shun">
2169 # affectopers: Whether server operators are exempt from shuns. This
2170 # option is deprecated; you should instead give exempt
2171 # server operators the servers/ignore-shun privilege.
2173 # allowtags: Whether to allow client tags to be attached to enabled
2176 # cleanedcommands: The commands that, if enabled, should be cleaned
2177 # of any message content if a shunned user tries to
2180 # enabledcommands: The commands that a shunned user is allowed to
2183 # notifyuser: Whether to notify shunned users that a command they tried
2184 # to execute has been blocked.
2186 #<shun enabledcommands="ADMIN OPER PING PONG QUIT PART JOIN"
2187 # cleanedcommands="AWAY PART QUIT"
2192 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2193 # SSL mode module: Adds support for TLS (SSL)-only channels via the '+z'
2194 # channel mode, TLS (SSL)-only private messages via the '+z' user mode and
2195 # the 'z:' extban which matches TLS (SSL) client certificate fingerprints.
2197 # Does not do anything useful without a working TLS (SSL) module and the
2198 # sslinfo module (see below).
2199 <module name="sslmodes">
2201 # The +z user mode is not enabled by default to enable link compatibility
2202 # with 2.0 servers. You can enable it by uncommenting this:
2203 <sslmodes enableumode="yes">
2205 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2206 # SSL rehash signal module: Allows the TLS (SSL) modules to be rehashed by
2207 # sending SIGUSR1 to a running InspIRCd process.
2208 # This module is in extras. Re-run configure with:
2209 # ./configure --enable-extras sslrehashsignal
2210 # and run make install, then uncomment this module to enable it.
2211 <module name="sslrehashsignal">
2213 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2214 # GnuTLS SSL module: Adds support for TLS (SSL) connections using GnuTLS,
2215 # if enabled. You must answer 'yes' in ./configure when asked or
2216 # manually symlink the source for this module from the directory
2217 # src/modules/extra, if you want to enable this, or it will not load.
2218 <module name="ssl_gnutls">
2219 <gnutls onrehash="yes">
2221 #-#-#-#-#-#-#-#-#-#-#- GNUTLS CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#
2223 # ssl_gnutls is too complex to describe here, see the docs: #
2224 # https://docs.inspircd.org/3/modules/ssl_gnutls #
2226 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2227 # SSL info module: Allows users to retrieve information about other
2228 # users' peer TLS (SSL) certificates and keys via the SSLINFO command.
2229 # This can be used by client scripts to validate users. For this to
2230 # work, one of ssl_gnutls, ssl_mbedtls or ssl_openssl must be loaded.
2231 # This module also adds the "<user> is using a secure connection"
2232 # and "<user> has TLS (SSL) client certificate fingerprint <fingerprint>"
2233 # WHOIS lines, the ability for opers to use TLS (SSL) cert fingerprints to
2234 # verify their identity and the ability to force opers to use TLS (SSL)
2235 # connections in order to oper up. It is highly recommended to load
2236 # this module if you use TLS (SSL) on your network.
2237 # For how to use the oper features, please see the first
2238 # example <oper> tag in opers.conf.example.
2240 <module name="sslinfo">
2242 # If you want to prevent users from viewing TLS (SSL) certificate information
2243 # and fingerprints of other users, set operonly to yes.
2244 <sslinfo operonly="yes">
2246 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2247 # mbedTLS TLS (SSL) module: Adds support for TLS (SSL) connections using mbedTLS.
2248 #<module name="ssl_mbedtls">
2250 #-#-#-#-#-#-#-#-#-#-#- MBEDTLS CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#
2252 # ssl_mbedtls is too complex to describe here, see the docs: #
2253 # https://docs.inspircd.org/3/modules/ssl_mbedtls #
2255 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2256 # OpenSSL TLS (SSL) module: Adds support for TLS (SSL) connections using OpenSSL,
2257 # if enabled. You must answer 'yes' in ./configure when asked or symlink
2258 # the source for this module from the directory src/modules/extra, if
2259 # you want to enable this, or it will not load.
2260 #<module name="ssl_openssl">
2262 #-#-#-#-#-#-#-#-#-#-#- OPENSSL CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#
2264 # ssl_openssl is too complex to describe here, see the docs: #
2265 # https://docs.inspircd.org/3/modules/ssl_openssl #
2267 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2268 # Strip color module: Adds channel mode +S that strips color codes and
2269 # all control codes except CTCP from all messages sent to the channel.
2270 <module name="stripcolor">
2272 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2273 # Silence module: Adds support for the /SILENCE command, which allows
2274 # users to have a server-side ignore list for their client.
2275 <module name="silence">
2277 # Set the maximum number of entries allowed on a user's silence list.
2278 <silence maxentries="64"
2280 # Whether messages from U-lined servers will bypass silence masks.
2283 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2284 # SQLite3 module: Allows other SQL modules to access SQLite3 #
2285 # databases through a unified API. #
2286 # This module is in extras. Re-run configure with: #
2287 # ./configure --enable-extras sqlite3
2288 # and run make install, then uncomment this module to enable it. #
2290 #<module name="sqlite3">
2292 #-#-#-#-#-#-#-#-#-#-#-#- SQL CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#-#
2294 # sqlite is more complex than described here, see the docs for more #
2295 # info: https://docs.inspircd.org/3/modules/sqlite3 #
2297 #<database module="sqlite" hostname="/full/path/to/database.db" id="anytext">
2299 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2300 # SQL authentication module: Allows IRCd connections to be tied into
2301 # a database table (for example a forum).
2303 #<module name="sqlauth">
2305 #-#-#-#-#-#-#-#-#-#-#- SQLAUTH CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#
2307 # sqlauth is too complex to describe here, see the docs: #
2308 # https://docs.inspircd.org/3/modules/sqlauth #
2310 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2311 # SQL oper module: Allows you to store oper credentials in an SQL
2312 # table. You can add additional table columns like you would config
2313 # tags in opers.conf. Opers in opers.conf will override opers from
2316 #<module name="sqloper">
2318 #-#-#-#-#-#-#-#-#-#-#- SQLOPER CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#
2320 # dbid - Database ID to use (see SQL modules). #
2322 # See also: https://docs.inspircd.org/3/modules/sqloper #
2326 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2327 # StartTLS module: Implements STARTTLS, which allows clients #
2328 # connected to non TLS (SSL) enabled ports to enable TLS (SSL), if #
2329 # a proper TLS (SSL) module is loaded (either ssl_gnutls, #
2330 # ssl_mbedtls or ssl_openssl). #
2331 <module name="starttls">
2333 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2334 # SVSHold module: Implements SVSHOLD. Like Q-lines, but can only be #
2335 # added/removed by Services. #
2336 <module name="svshold">
2337 # SVSHOLD does not generate server notices by default, you can turn
2338 # notices on by uncommenting the next line.
2339 <svshold silent="false">
2341 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2342 # SWHOIS module: Allows you to add arbitrary lines to user WHOIS.
2343 # This module is oper-only.
2344 # To use, SWHOIS must be in one of your oper class blocks.
2345 <module name="swhois">
2347 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2348 # Timed bans module: Adds timed channel bans with the /TBAN command.
2349 <module name="timedbans">
2350 # By default, it sends a notice to channel operators when timed ban is
2351 # set and when it is removed by server.
2352 <timedbans sendnotice="yes">
2354 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2355 # Test line module: Adds the /TLINE command, used to test how many
2356 # users a /GLINE or /ZLINE etc. would match.
2357 # This module is oper-only.
2358 # To use, TLINE must be in one of your oper class blocks.
2359 <module name="tline">
2361 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2362 # Topiclock module: implements server-side topic locking to achieve deeper
2363 # integration with services packages.
2364 <module name="topiclock">
2366 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2367 # UHNAMES support module: Adds support for the IRCX style UHNAMES
2368 # extension, which displays ident and hostname in the names list for
2369 # each user, saving clients from doing a WHO on the channel.
2370 # If a client does not support UHNAMES it will not enable it, this will
2371 # not break incompatible clients.
2372 <module name="uhnames">
2374 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2375 # Uninvite module: Adds the /UNINVITE command which lets users remove
2376 # pending invites from channels without waiting for the user to join.
2377 <module name="uninvite">
2379 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2380 # Userip module: Adds the /USERIP command.
2381 # Allows users to query their own IP, also allows opers to query the IP
2383 <module name="userip">
2385 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2386 # Vhost module: Adds the VHOST command which allows for adding virtual
2387 # hosts which are accessible using a username and password in the config.
2388 #<module name="vhost">
2390 #-#-#-#-#-#-#-#-#-#-#- VHOST CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#-#
2392 # user - Username for the vhost. #
2394 # pass - Password for the vhost. #
2396 # hash - The hash for the specific user (optional) #
2397 # password_hash and a hashing module must be loaded for #
2400 # host - Vhost to set. #
2402 #<vhost user="some_username" pass="some_password" host="some.host.test.cc">
2403 #<vhost user="foo" password="$2a$10$iTuYLT6BRhRlOgzfsW9oPe62etW.oXwSpyKw5rJit64SGZanLXghO" hash="bcrypt" host="some.other.host.example.com">
2405 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2406 # Watch module: Adds the WATCH command, which is used by clients to
2407 # maintain notify lists.
2408 <module name="watch">
2410 # Set the maximum number of entries on a user's watch list below.
2411 <watch maxwatch="32">
2413 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2414 # WebSocket module: Adds HTML5 WebSocket support.
2415 # Specify hook="websocket" in a <bind> tag to make that port accept
2416 # WebSocket connections. Compatible with TLS (SSL).
2417 # Requires SHA-1 hash support available in the sha1 module.
2418 #<module name="websocket">
2420 # proxyranges: A space-delimited list of glob or CIDR matches to trust
2421 # the X-Real-IP or X-Forwarded-For headers from. If enabled
2422 # the server will use the IP address specified by those HTTP
2423 # headers. You should NOT enable this unless you are using
2424 # a HTTP proxy like nginx as it will allow IP spoofing.
2425 # sendastext: Whether to re-encode messages as UTF-8 before sending to
2426 # WebSocket clients. This is recommended as the WebSocket
2427 # protocol requires all text frames to be sent as UTF-8.
2428 # If you do not have this enabled messages will be sent as
2429 # binary frames instead.
2430 #<websocket proxyranges="192.0.2.0/24 198.51.100.*"
2433 # If you use the websocket module you MUST specify one or more origins
2434 # which are allowed to connect to the server. You should set this as
2435 # strict as possible to prevent malicious webpages from connecting to
2437 # <wsorigin allow="https://*.example.com">
2439 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2440 # X-line database: Stores all *-lines (G/Z/K/R/any added by other modules)
2441 # in a file which is re-loaded on restart. This is useful
2442 # for two reasons: it keeps bans so users may not evade them, and on
2443 # bigger networks, server connections will take less time as there will
2444 # be a lot less bans to apply - as most of them will already be there.
2445 <module name="xline_db">
2447 # Specify the filename for the xline database and how often to check whether
2448 # the database needs to be saved here.
2449 <xlinedb filename="xline.db" saveperiod="15s">
2451 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2452 # ____ _ _____ _ _ ____ _ _ _ #
2453 # | _ \ ___ __ _ __| | |_ _| |__ (_)___ | __ )(_) |_| | #
2454 # | |_) / _ \/ _` |/ _` | | | | '_ \| / __| | _ \| | __| | #
2455 # | _ < __/ (_| | (_| | | | | | | | \__ \ | |_) | | |_|_| #
2456 # |_| \_\___|\__,_|\__,_| |_| |_| |_|_|___/ |____/|_|\__(_) #
2458 # To link servers to InspIRCd, you MUST load the spanningtree module. #
2459 # If you don't do this, server links will NOT work at all. #
2460 # This is by design, to allow for the implementation of other linking #
2461 # protocols in modules in the future. #
2463 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2464 # Spanning tree module: Allows linking of servers using the spanning
2465 # tree protocol (see the READ THIS BIT section above).
2466 # You will almost always want to load this.
2468 <module name="spanningtree">