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