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