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