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">
50 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
51 # RIPEMD160 module: Allows other modules to generate RIPEMD160 hashes,
52 # usually for cryptographic uses and security.
55 # Other modules may rely on this module being loaded to function.
56 #<module name="ripemd160">
58 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
59 # Abbreviation module: Provides the ability to abbreviate commands a-la
61 #<module name="abbreviation">
63 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
64 # Alias module: Allows you to define server-side command aliases.
65 #<module name="alias">
67 # Set the 'prefix' for in-channel aliases (fantasy commands) to the
68 # specified character. If not set, the default is "!".
69 # If 'allowbots' is disabled, +B clients will not be able to use
70 # fantasy commands. If not set, the default is no.
71 #<fantasy prefix="!" allowbots="no">
73 #-#-#-#-#-#-#-#-#-#-#- ALIAS DEFINITIONS -#-#-#-#-#-#-#-#-#-#-#-#-#-#
75 # If you have the alias module loaded, you may also define aliases as #
76 # shown below. They are commonly used to provide shortcut commands to #
77 # services, however they are not limited to just this use. #
78 # An alias tag requires the following values to be defined in it: #
80 # text - The text to detect as the actual command line. #
81 # Can't contain spaces, but case insensitive. #
82 # You may have multiple aliases with the same #
83 # command name (text="" value), however the first #
84 # found will be executed if its format value is #
85 # matched, or it has no format value. Aliases are #
86 # read from the top of the file to the bottom. #
88 # usercommand - If this is true, the alias can be run simply as #
89 # /aliasname. Defaults to true. #
91 # channelcommand - If this is true, the alias can be used as an #
92 # in-channel alias or 'fantasy command', prefixed #
93 # by the fantasy prefix character, !aliasname by #
94 # default. Defaults to false. #
96 # format - If this is defined, the parameters of the alias #
97 # must match this glob pattern. For example if you #
98 # want the first parameter to start with a # for #
99 # the alias to be executed, set format="#*" in the #
100 # alias definition. Note that the :'s which are #
101 # part of IRC formatted lines will be preserved #
102 # for matching of this text. This value is #
105 # replace - The text to replace 'text' with. Usually this #
106 # will be "PRIVMSG ServiceName :$2-" or similar. #
107 # You may use the variables $1 through $9 in the #
108 # replace string, which refer to the first through #
109 # ninth word in the original string typed by the #
110 # user. You may also use $1- through $9- which #
111 # refer to the first word onwards, through to the #
112 # ninth word onwards, e.g. if the user types the #
113 # command "foo bar baz qux quz" then $3- will hold #
114 # "baz qux quz" and $2 will contain "bar". You may #
115 # also use the special variables: $nick, $ident, #
116 # $host and $vhost, and you may separate multiple #
117 # commands with a newline (which can be written in #
118 # the file literally, or encoded as &nl; or \n #
119 # depending on the config format setting). #
121 # requires - If you provide a value for 'requires' this means #
122 # the given nickname MUST be online for the alias #
123 # to successfully trigger. If they are not, then #
124 # the user receives a 'no such nick' 401 numeric. #
126 # uline - Setting this to true will ensure that the user #
127 # given in 'requires' is also on a u-lined server, #
128 # as well as actually being on the network. If the #
129 # user is online, but not on a u-lined server, #
130 # then an oper alert is sent out as this is #
131 # possibly a sign of a user trying to impersonate #
134 # operonly - If true, this will make the alias oper only. #
135 # If a non-oper attempts to use the alias, it will #
136 # appear to not exist. #
139 # An example of using the format value to create an alias with two
140 # different behaviours depending on the format of the parameters.
142 #<alias text="ID" format="#*" replace="PRIVMSG ChanServ :IDENTIFY $2 $3"
143 # requires="ChanServ" uline="yes">
145 #<alias text="ID" replace="PRIVMSG NickServ :IDENTIFY $2"
146 # requires="NickServ" uline="yes">
148 # This alias fixes a glitch in xchat 2.6.x and above and the way it
149 # assumes IDENTIFY must be prefixed by a colon (:) character. It should
150 # be placed ABOVE the default NICKSERV alias.
152 #<alias text="NICKSERV" format=":IDENTIFY *" replace="PRIVMSG NickServ :IDENTIFY $3-"
153 # requires="NickServ" uline="yes">
155 # You may also add aliases to trigger based on something said in a
156 # channel, aka 'fantasy' commands, configured in the same manner as any
157 # other alias, with usercommand="no" and channelcommand="yes" The
158 # command must be preceded by the fantasy prefix when used.
160 #<alias text="CS" usercommand="no" channelcommand="yes"
161 # replace="PRIVMSG ChanServ :$1 $chan $2-" requires="ChanServ" uline="yes">
163 # This would be used as "!cs <command> <options>", with the channel
164 # being automatically inserted after the command in the message to
165 # ChanServ, assuming the fantasy prefix is "!".
167 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
168 # Allowinvite module: Gives channel mode +A to allow all users to use
169 # /INVITE, and extban A to deny invite from specific masks.
170 #<module name="allowinvite">
172 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
173 # Alltime module: Shows time on all connected servers at once.
174 # This module is oper-only and provides /ALLTIME.
175 # To use, ALLTIME must be in one of your oper class blocks.
176 #<module name="alltime">
178 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
179 # Anticaps module: Adds channel mode +B which allows you to punish
180 # users that send overly capitalised messages to channels. Unlike the
181 # blockcaps module this module is more flexible as it has more options
182 # for punishment and allows channels to configure their own punishment
184 #<module name="anticaps">
186 # You may also configure the characters which anticaps considers to be
187 # lower case and upper case. Any characters not listed here are assumed
188 # to be punctuation and will be ignored when counting:
189 # <anticaps lowercase="abcdefghijklmnopqrstuvwxyz"
190 # uppercase="ABCDEFGHIJKLMNOPQRSTUVWXYZ">
192 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
193 # Auditorium module: Adds channel mode +u which makes everyone else
194 # except you in the channel invisible, used for large meetings etc.
195 #<module name="auditorium">
197 # Auditorium settings:
199 #<auditorium opvisible="no" opcansee="no" opercansee="yes">
201 # opvisible (auditorium-vis in exemptchanops):
202 # Show channel ops to all users
203 # opcansee (auditorium-see in exemptchanops):
204 # Allow ops to see all joins/parts/kicks in the channel
206 # Allow opers (channels/auspex) to see see all joins/parts/kicks in the channel
208 # Exemptchanops can be used to adjust the level at which users become visible or
209 # the level at which they can see the full member list of the channel.
211 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
212 # Autoop module: Adds basic channel access controls via the +w listmode.
213 # For example +w o:*!Attila@127.0.0.1 will op anyone matching that mask
214 # on join. This can be combined with extbans, for example +w o:R:Brain
215 # will op anyone identified to the account "Brain".
216 # Another useful combination is with SSL client certificate
217 # fingerprints: +w h:z:72db600734bb9546c1bdd02377bc21d2a9690d48 will
218 # give halfop to the user(s) having the given certificate.
219 #<module name="autoop">
221 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
222 # Ban except module: Adds support for channel ban exceptions (+e).
223 #<module name="banexception">
225 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
226 # Ban redirection module: Allows bans which redirect to a specified
227 # channel. e.g. +b nick!ident@host#channelbanneduserissentto
228 #<module name="banredirect">
230 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
231 # bcrypt module: Allows other modules to generate bcrypt hashes,
232 # usually for cryptographic uses and security.
233 #<module name="bcrypt">
235 # rounds: Defines how many rounds the bcrypt function will run when
236 # generating new hashes.
237 #<bcrypt rounds="10">
239 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
240 # Block amsg module: Attempt to block all usage of /amsg and /ame.
241 #<module name="blockamsg">
243 #-#-#-#-#-#-#-#-#-#-#- BLOCKAMSG CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
245 # If you have the blockamsg module loaded, you can configure it with #
246 # the <blockamsg> tag: #
248 # delay - How much time between two messages to force them #
249 # to be recognised as unrelated. #
250 # action - Any of 'notice', 'noticeopers', 'silent', 'kill' #
251 # or 'killopers'. Define how to take action when #
252 # a user uses /amsg or /ame. #
254 #<blockamsg delay="3" action="killopers">
256 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
257 # Block CAPS module: Adds channel mode +B, blocks all-CAPS messages.
259 # NOTE: This module is deprecated and will be removed in a future version
260 # of InspIRCd. You should use the anticaps module shown above instead.
261 #<module name="blockcaps">
263 #-#-#-#-#-#-#-#-#-#-#- BLOCKCAPS CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
265 # percent - The percentage of a message which must be upper #
266 # case before it will be blocked. #
268 # minlen - The minimum length a message must be before it #
271 # lowercase - The characters which will be considered lower #
274 # uppercase - The characters which will be considered upper #
277 #<blockcaps percent="50"
279 # lowercase="abcdefghijklmnopqrstuvwxyz"
280 # uppercase="ABCDEFGHIJKLMNOPQRSTUVWXYZ">
282 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
283 # Block color module: Blocking color-coded messages with chan mode +c.
284 #<module name="blockcolor">
286 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
287 # Botmode module: Adds the user mode +B. If set on a user, it will
288 # show that the user is a bot in /WHOIS.
289 #<module name="botmode">
291 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
292 # CallerID module: Adds usermode +g which activates hybrid-style
293 # callerid: block all private messages unless you /ACCEPT first.
294 #<module name="callerid">
296 #-#-#-#-#-#-#-#-#-#-#- CALLERID CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#
297 # maxaccepts - Maximum number of entries a user can add to his #
298 # /ACCEPT list. Default is 16 entries. #
299 # tracknick - Preserve /accept entries when a user changes nick? #
300 # If no (the default), the user is removed from #
301 # everyone's accept list if he changes nickname. #
302 # cooldown - Amount of time that must pass since the last #
303 # notification sent to a user before he can be sent #
304 # another. Default is 1 minute. #
305 #<callerid maxaccepts="16"
309 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
310 # CAP module: Provides the CAP negotiation mechanism required by the
311 # sasl, namesx, uhnames, and ircv3 modules.
312 # It is also recommended for STARTTLS support in the starttls module.
315 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
316 # CBAN module: Lets you disallow channels from being used at runtime.
317 # This module is oper-only and provides /CBAN.
318 # To use, CBAN must be in one of your oper class blocks.
319 #<module name="cban">
321 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
322 # Censor module: Adds channel and user mode +G.
323 #<module name="censor">
325 #-#-#-#-#-#-#-#-#-#-#- CENSOR CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#
327 # Optional - If you specify to use the censor module, then you must #
328 # specify some censor tags. See also: #
329 # https://wiki.inspircd.org/Modules/3.0/censor #
331 #<include file="examples/censor.conf.example">
333 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
334 # CGI:IRC module: Enables forwarding the real IP address of a user from
335 # a gateway to the IRC server.
336 #<module name="cgiirc">
338 #-#-#-#-#-#-#-#-#-#-#-# CGIIRC CONFIGURATION #-#-#-#-#-#-#-#-#-#-#-#-#
340 # If you use the cgiirc module then you must specify the gateways which
341 # are authorised to forward IP/host information to your server. There
342 # are currently two ways to do this:
344 # The webirc method is the recommended way to allow gateways to forward
345 # IP/host information. When using this method the gateway sends a WEBIRC
346 # message to the server on connection. For more details please read the
347 # IRCv3 WebIRC specification at http://ircv3.net/specs/extensions/webirc.html.
349 # When using this method you must specify a wildcard mask or CIDR range
350 # to allow gateway connections from and at least one of either a SSL
351 # client certificate fingerprint for the gateway or a password to be
352 # sent in the WEBIRC command.
354 # <cgihost type="webirc"
355 # fingerprint="bd90547b59c1942b85f382bc059318f4c6ca54c5"
356 # mask="192.0.2.0/24">
357 # <cgihost type="webirc"
358 # password="$2a$10$WEUpX9GweJiEF1WxBDSkeODBstIBMlVPweQTG9cKM8/Vd58BeM5cW"
360 # mask="*.webirc.gateway.example.com">
362 # Alternatively if your gateway does not support sending the WEBIRC
363 # message then you can configure InspIRCd to look for the client IP
364 # address in the ident sent by the user. This is not recommended as it
365 # only works with IPv4 connections.
367 # When using this method you must specify a wildcard mask or CIDR range to
368 # allow gateway connections from.
370 # <cgihost type="ident" mask="198.51.100.0/24">
371 # <cgihost type="ident" mask="*.ident.gateway.example.com">
373 # By default gateway connections are logged to the +w snomask. If you
374 # do not want this to happen then you can uncomment this to disable it.
375 # <cgiirc opernotice="no">
380 # When you connect gateway clients, there are two connect classes which
381 # apply to these clients. When the client initially connects, the connect
382 # class which matches the gateway site's host is checked. Therefore you
383 # must raise the maximum local/global clients for this IP as high as you
384 # want to allow gateway clients. After the client has connected and is
385 # determined to be a gateway client, the class which matches the client's
386 # real IP is then checked. You may set this class to a lower value, so that
387 # the real IP of the client can still be restricted to, for example, 3
390 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
391 # Channel create module: Adds snomask +j, which will notify opers of
392 # any new channels that are created.
393 # This module is oper-only.
394 #<module name="chancreate">
396 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
397 # Channel filter module: Allows channel-op defined message filtering
398 # using simple string matches (channel mode +g).
399 #<module name="chanfilter">
401 # If hidemask is set to yes, the user will not be shown the mask when
402 # his/her message is blocked.
404 # If maxlen is set then it defines the maximum length of a filter entry.
406 # If notifyuser is set to no, the user will not be notified when
407 # his/her message is blocked.
408 #<chanfilter hidemask="yes" maxlen="50" notifyuser="yes">
410 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
411 # Channel history module: Displays the last 'X' lines of chat to a user
412 # joining a channel with +H 'X:T' set; 'T' is the maximum time to keep
413 # lines in the history buffer. Designed so that the new user knows what
414 # the current topic of conversation is when joining the channel.
415 #<module name="chanhistory">
417 # Set the maximum number of lines allowed to be stored per channel below.
418 # This is the hard limit for 'X'.
419 # If notice is set to yes, joining users will get a NOTICE before playback
420 # telling them about the following lines being the pre-join history.
421 # If bots is set to yes, it will also send to users marked with +B
422 #<chanhistory maxlines="50" notice="yes" bots="yes">
424 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
425 # Channel logging module: Used to send snotice output to channels, to
426 # allow staff to centrally monitor and discuss network activity.
428 # The "channel" field is where you want the messages to go, "snomasks"
429 # is what snomasks you want to be sent to that channel. Multiple tags
431 #<module name="chanlog">
432 #<chanlog snomasks="AOcC" channel="#opers">
434 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
435 # Channel names module: Allows disabling channels which have certain
436 # characters in the channel name such as bold, colorcodes, etc. which
437 # can be quite annoying and allow users to on occasion have a channel
438 # that looks like the name of another channel on the network.
439 #<module name="channames">
442 # denyrange: characters or range of characters to deny in channel
446 # allowrange: characters or range of characters to specifically allow
450 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
451 # Channelban: Implements extended ban j:, which stops anyone already
452 # in a channel matching a ban like +b j:#channel*mask from joining.
453 # Note that by default wildcard characters * and ? are allowed in
454 # channel names. To disallow them, load m_channames and add characters
455 # 42 and 63 to denyrange (see above).
456 #<module name="channelban">
458 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
459 # Check module: Adds the /CHECK command.
460 # Check is useful for looking up information on channels, users,
461 # IP addresses and hosts.
462 # This module is oper-only.
463 # To use, CHECK must be in one of your oper class blocks.
464 #<module name="check">
466 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
467 # CHGHOST module: Adds the /CHGHOST command.
468 # This module is oper-only.
469 # To use, CHGHOST must be in one of your oper class blocks.
470 # NOTE: Services will not be able to set vhosts on users if this module
471 # isn't loaded. If you're planning on running services, you probably
473 #<module name="chghost">
475 #-#-#-#-#-#-#-#-# /CHGHOST - /SETHOST CONFIGURATION #-#-#-#-#-#-#-#-#
476 # Optional - If you want to use special chars for hostnames you can #
477 # specify your own custom list of chars with the <hostname> tag: #
479 # charmap - A list of chars accepted as valid by the /CHGHOST #
480 # and /SETHOST commands. Also note that the list is #
482 #<hostname charmap="abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ.-_/0123456789">
484 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
485 # CHGIDENT module: Adds the /CHGIDENT command.
486 # This module is oper-only.
487 # To use, CHGIDENT must be in one of your oper class blocks.
488 #<module name="chgident">
490 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
491 # CHGNAME module: Adds the /CHGNAME command.
492 # This module is oper-only.
493 # To use, CHGNAME must be in one of your oper class blocks.
494 #<module name="chgname">
496 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
497 # Connection class ban module: Adds support for extban 'n' which
498 # matches against the class name of the user's connection.
499 # This module assumes that connection classes are named in a uniform
500 # way on all servers of the network.
501 #<module name="classban">
503 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
504 # Clear chan module: Allows opers to masskick, masskill or mass-G/ZLine
505 # all users on a channel using /CLEARCHAN.
506 #<module name="clearchan">
508 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
509 # Cloaking module: Adds usermode +x and cloaking support.
510 # Relies on the md5 module being loaded.
511 # To cloak users when they connect, load the conn_umodes module and set
512 # <connect:modes> to include the +x mode. The example <connect> tag
513 # shows this. See the conn_umodes module for more information.
514 #<module name="cloaking">
516 #-#-#-#-#-#-#-#-#-#-#- CLOAKING CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#
518 # To use cloaking, you must define a cloak key, and optionally a #
519 # cloak prefix as shown below. The cloak key must be shared across #
520 # the network for correct cloaking. #
522 # There are two methods of cloaking: #
524 # half Cloak only the "unique" portion of a host; by #
525 # default show the last 2 parts of the domain, #
526 # /16 subnet of IPv4 or /48 subnet of the IPv6 #
528 # To change the number of shown parts, modify the #
529 # domainparts option. #
531 # full Cloak the users completely, using three slices for #
532 # common CIDR bans (IPv4: /16, /24; IPv6: /48, /64). #
534 # The methods use a single key that can be any length of text. #
535 # An optional prefix may be specified to mark cloaked hosts. #
536 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
543 #-#-#-#-#-#-#-#-#-#-#-#- CLOSE MODULE #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
544 # Close module: Allows an oper to close all unregistered connections.
545 # This module is oper-only and provides the /CLOSE command.
546 # To use, CLOSE must be in one of your oper class blocks.
547 #<module name="close">
549 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
550 # Clones module: Adds an oper command /CLONES for detecting cloned
551 # users. Warning: This command may be resource intensive when it is
552 # issued, use with care.
553 # This module is oper-only.
554 # To use, CLONES must be in one of your oper class blocks.
555 #<module name="clones">
557 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
558 # Common channels module: Adds user mode +c, which, when set, requires
559 # that users must share a common channel with you to PRIVMSG or NOTICE
561 #<module name="commonchans">
563 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
564 # Auto join on connect module: Allows you to force users to join one
565 # or more channels automatically upon connecting to the server, or
566 # join them in case they aren't on any channels after being online
568 #<module name="conn_join">
570 #-#-#-#-#-#-#-#-#-#-#-#- CONNJOIN CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
572 # If you have the conn_join module loaded, you can configure it below
573 # or set autojoin="#chat,#help" in <connect> blocks.
575 # Join users immediately after connection to #one #two and #three.
576 #<autojoin channel="#one,#two,#three">
577 # Join users to #chat after 15 seconds if they aren't on any channels.
578 #<autojoin channel="#chat" delay="15">
580 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
581 # Set modes on connect module: When this module is loaded <connect>
582 # blocks may have an optional modes="" value, which contains modes to
583 # add or remove from users when they connect to the server.
584 #<module name="conn_umodes">
586 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
587 # Wait for PONG on connect module: Send a PING to all connecting users
588 # and don't let them connect until they reply with a PONG.
589 # This is useful to stop certain kinds of bots and proxies.
590 #<module name="conn_waitpong">
592 #-#-#-#-#-#-#-#-#-#-#- WAITPONG CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
594 # If you have the conn_waitpong module loaded, configure it with the #
597 # sendsnotice - Whether to send a helpful notice to users on #
598 # connect telling them how to connect, should #
599 # their client not reply PONG automatically. #
601 # killonbadreply - Whether to kill the user if they send the wrong #
604 #<waitpong sendsnotice="yes" killonbadreply="yes">
606 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
607 # Channel cycle module: Adds the /CYCLE command which is a server-side
608 # /HOP that bypasses restrictive modes.
609 #<module name="cycle">
611 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
612 # Connectban: Provides IP connection throttling. Any IP range that
613 # connects too many times (configurable) in an hour is Z-Lined for a
614 # (configurable) duration, and their count resets to 0.
615 #<module name="connectban">
617 # ipv4cidr and ipv6cidr allow you to turn the comparison from
618 # individual IP addresses (32 and 128 bits) into CIDR masks, to allow
619 # for throttling over whole ISPs/blocks of IPs, which may be needed to
622 # This allows for 10 connections in an hour with a 10 minute ban if
624 #<connectban threshold="10" duration="10m" ipv4cidr="32" ipv6cidr="128"
625 # A custom ban message may optionally be specified.
626 # 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.">
628 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
629 # Connection throttle module.
630 #<module name="connflood">
632 #-#-#-#-#-#-#-#-#-#-#- CONNTHROTTLE CONFIGURATION -#-#-#-#-#-#-#-#-#-#
633 # period, maxconns - Amount of connections per <period>.
635 # timeout - Time to wait after the throttle was activated
636 # before deactivating it. Be aware that the time
637 # is seconds + timeout.
639 # quitmsg - The message that users get if they attempt to
640 # connect while the throttle is active.
642 # bootwait - Amount of time in seconds to wait before enforcing
643 # the throttling when the server just booted.
645 #<connflood seconds="30" maxconns="3" timeout="30"
646 # quitmsg="Throttled" bootwait="10">
648 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
649 # Custom prefixes: Allows for channel prefixes to be configured.
650 #<module name="customprefix">
652 # name The name of the mode, must be unique from other modes.
653 # letter The letter used for this mode. Required.
654 # prefix The prefix used for nicks with this mode. Not required.
655 # rank A numeric rank for this prefix, defining what permissions it gives.
656 # The rank of voice, halfop and op is 10000, 20000, and 30000,
658 # ranktoset The numeric rank required to set this mode. Defaults to rank.
659 # ranktounset The numeric rank required to unset this mode. Defaults to ranktoset.
660 # depriv Can you remove the mode from yourself? Defaults to yes.
661 #<customprefix name="founder" letter="q" prefix="~" rank="50000" ranktoset="50000">
662 #<customprefix name="admin" letter="a" prefix="&" rank="40000" ranktoset="50000">
663 #<customprefix name="halfop" letter="h" prefix="%" rank="20000" ranktoset="30000">
665 # You can also override the configuration of prefix modes added by both the core
666 # and other modules by adding a customprefix tag with change="yes" specified.
667 # <customprefix name="op" change="yes" rank="30000" ranktoset="30000">
668 # <customprefix name="voice" change="yes" rank="10000" ranktoset="10000" depriv="no">
670 # Do /RELOADMODULE customprefix after changing the settings of this module.
672 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
673 # Custom title module: Adds the /TITLE command which allows for trusted
674 # users to gain a custom whois line and an optional vhost can be
676 #<module name="customtitle">
678 #-#-#-#-#-#-#-#-#-#- CUSTOM TITLE CONFIGURATION -#-#-#-#-#-#-#-#-#-#
679 # name - The username used to identify.
680 # password - The password used to identify.
681 # hash - The hash for the specific user's password (optional).
682 # password_hash and a hashing module must be loaded
684 # host - Allowed hostmask (optional).
685 # title - Title shown in whois.
686 # vhost - Displayed host (optional).
688 #<title name="foo" password="bar" title="Official Chat Helper">
689 #<title name="bar" password="foo" host="ident@test.org" title="Official Chat Helper" vhost="helper.test.org">
690 #<title name="foo" password="$2a$10$UYZ4OcO8NNTCCGyCdY9SK.2GHiqGgxZfHFPOPmWuxEVWVQTtoDC7C" hash="bcrypt" title="Official Chat Helper">
692 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
693 # DCCALLOW module: Adds the /DCCALLOW command.
694 #<module name="dccallow">
696 #-#-#-#-#-#-#-#-#-#-#- DCCALLOW CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
697 # blockchat - Whether to block DCC CHAT as well as DCC SEND.
698 # length - Default duration of entries in DCCALLOW list.
699 # action - Default action to take if no action is
700 # specified, can be 'block' or 'allow'.
701 # maxentries - Max number of nicks to allow on a DCCALLOW list.
703 # File configuration:
704 # pattern - The glob pattern to match against.
705 # action - Action to take if a user attempts to send a file
706 # that matches this pattern, can be 'block' or
709 #<dccallow blockchat="yes" length="5m" action="block" maxentries="20">
710 #<banfile pattern="*.exe" action="block">
711 #<banfile pattern="*.txt" action="allow">
713 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
714 # Deaf module: Adds support for the usermode +d - deaf to channel
715 # messages and channel notices.
716 #<module name="deaf">
718 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
719 # Delay join module: Adds the channel mode +D which delays all JOIN
720 # messages from users until they speak. If they quit or part before
721 # speaking, their quit or part message will not be shown to the channel
722 # which helps cut down noise on large channels in a more friendly way
723 # than the auditorium mode. Only channel ops may set the +D mode.
724 #<module name="delayjoin">
726 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
727 # Delay message module: Adds the channel mode +d which disallows a user
728 # from talking in the channel unless they've been joined for X seconds.
729 # Settable using /MODE #chan +d 30
730 #<module name="delaymsg">
731 # Set allownotice to no to disallow NOTICEs too. Defaults to yes.
732 #<delaymsg allownotice="no">
734 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
735 # Deny channels module: Deny channels from being used by users.
736 #<module name="denychans">
738 #-#-#-#-#-#-#-#-#-#-#- DENYCHAN DEFINITIONS -#-#-#-#-#-#-#-#-#-#-#-#
740 # If you have the denychans module loaded, you need to specify the #
741 # channels to deny: #
743 # name - The channel name to deny (glob masks are ok). #
744 # allowopers - If operators are allowed to override the deny. #
745 # reason - Reason given for the deny. #
746 # redirect - Redirect the user to a different channel. #
748 #<badchan name="#gods*" allowopers="yes" reason="Tortoises!"> #
749 #<badchan name="#chan1" redirect="#chan2" reason="Chan1 is closed"> #
751 # Redirects will not work if the target channel is set +L. #
753 # Additionally, you may specify channels which are allowed, even if #
754 # a badchan tag specifies it would be denied: #
755 #<goodchan name="#funtimes"> #
756 # Glob masks are accepted here also. #
758 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
759 # DNS blacklist module: Provides support for looking up IPs on one or #
761 #<module name="dnsbl"> #
763 # For configuration options please see the wiki page for dnsbl at #
764 # https://wiki.inspircd.org/Modules/3.0/dnsbl #
766 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
767 # Exempt channel operators module: Provides support for allowing #
768 # channel operators to be exempt from some channel modes. Supported #
769 # modes are blockcaps, noctcp, blockcolor, nickflood, flood, censor, #
770 # filter, regmoderated, nonick, nonotice, and stripcolor. #
771 #<module name="exemptchanops"> #
773 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
774 # Filter module: Provides message filtering, similar to SPAMFILTER. #
775 #<module name="filter">
777 # This module depends upon a regex provider such as regex_pcre or #
778 # regex_glob to function. You must specify which of these you want #
779 # the filter module to use via the tag below. #
781 # Valid engines are: #
783 # glob - Glob patterns, provided via regex_glob. #
784 # pcre - PCRE regexps, provided via regex_pcre, needs libpcre. #
785 # tre - TRE regexps, provided via regex_tre, requires libtre. #
786 # posix - POSIX regexps, provided via regex_posix, not available #
787 # on Windows, no dependencies on other operating systems. #
788 # stdlib - stdlib regexps, provided via regex_stdlib, see comment #
789 # at the <module> tag for info on availability. #
791 # If notifyuser is set to no, the user will not be notified when #
792 # his/her message is blocked. #
793 #<filteropts engine="glob" notifyuser="yes">
795 # Your choice of regex engine must match on all servers network-wide. #
797 # To learn more about the configuration of this module, read #
798 # examples/filter.conf.example, which covers the various types of #
799 # filters and shows how to add exemptions. #
801 #-#-#-#-#-#-#-#-#-#-#- FILTER CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#
803 # Optional - If you specify to use the filter module, then #
804 # specify below the path to the filter.conf file, or define some #
807 #<include file="examples/filter.conf.example">
809 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
810 # Flash Policy Daemon module: Allows Flash IRC clients (e.g. LightIRC)#
811 # to connect. If no file is specified, it'll serve a default policy #
812 # allowing all IPs to connect to all plaintext IRC ports #
813 #<bind address="" port="8430" type="flashpolicyd"> #
814 #<flashpolicyd timeout="5" file=""> #
815 #<module name="flashpolicyd"> #
817 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
818 # Gecos (real name) ban: Implements extended ban 'r', which stops anyone
819 # matching a mask like +b r:*realname?here* from joining a channel.
820 #<module name="gecosban">
822 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
823 # GeoIP module: Allows the server admin to match users by country code.
824 # This module is in extras. Re-run configure with:
825 # ./configure --enable-extras=m_geoip.cpp
826 # and run make install, then uncomment this module to enable it.
827 # This module requires GeoIP to be installed on your system,
828 # use your package manager to find the appropriate packages
829 # or check the InspIRCd wiki page for this module.
830 #<module name="geoip">
832 # The actual allow/ban actions are done by connect classes, not by the
833 # GeoIP module. An example connect class to ban people from russia or
836 # <connect deny="*" geoip="TR,RU">
838 # If enabled you can also ban people from channnels by country code
839 # using the G: extban (e.g. /mode #channel +b G:US).
840 # <geoip extban="yes">
842 # The country code must be in capitals and should be an ISO country
843 # code such as TR, GB, or US. Unknown IPs (localhost, LAN IPs, etc)
844 # will be assigned the country code "UNK". Since connect classes are
845 # matched from top down, your deny classes must be above your allow
846 # classes for them to match.
848 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
849 # Globops module: Provides the /GLOBOPS command and snomask +g.
850 # This module is oper-only.
851 # To use, GLOBOPS must be in one of your oper class blocks.
852 #<module name="globops">
854 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
855 # Global load module: Allows loading and unloading of modules network-
856 # wide (USE WITH EXTREME CAUTION!)
857 # This module is oper-only and provides /GLOADMODULE, /GUNLOADMODULE
858 # and /GRELOADMODULE.
859 # To use, GLOADMODULE, GUNLOADMODULE and GRELOADMODULE
860 # must be in one of your oper class blocks.
861 #<module name="globalload">
863 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
864 # HELPOP module: Provides the /HELPOP command
865 #<module name="helpop">
867 #-#-#-#-#-#-#-#-#-#-#-#- HELPOP CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
869 # If you specify to use the helpop module, then specify below the #
870 # path to the helpop.conf file. #
872 #<include file="examples/inspircd.helpop-full.example">
874 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
875 # Hide chans module: Allows users to hide their channels list from non-
876 # opers by setting user mode +I on themselves.
877 #<module name="hidechans">
879 # This mode can optionally prevent opers from seeing channels on a +I
880 # user, for more privacy if set to true.
881 # This setting is not recommended for most mainstream networks.
882 #<hidechans affectsopers="false">
884 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
885 # Hide list module: Allows for hiding the list of listmodes from users
886 # who do not have sufficient channel rank.
887 #<module name="hidelist">
889 # Each <hidelist> tag configures one listmode to hide.
890 # mode: Name of the listmode to hide.
891 # rank: Minimum rank required to view the list. If set to 0, all
892 # members of the channel may view the list, but non-members may not.
893 # The rank of the built-in op and voice mode is 30000 and 10000,
894 # respectively; the rank of other prefix modes is configurable.
897 # Hiding the ban list is not recommended because it may break some
900 # Hide filter (+g) list:
901 #<hidelist mode="filter" rank="30000">
902 # Only show invite exceptions (+I) to channel members:
903 #<hidelist mode="invex" rank="0">
905 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
906 # Hide oper module: Allows opers to hide their oper status from non-
907 # opers by setting user mode +H on themselves.
908 # This module is oper-only.
909 #<module name="hideoper">
911 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
912 # Hostchange module: Allows a different style of cloaking.
913 #<module name="hostchange">
915 #-#-#-#-#-#-#-#-#-#-#- HOSTCHANGE CONFIGURATION -#-#-#-#-#-#-#-#-#-#
917 # See https://wiki.inspircd.org/Modules/3.0/hostchange for help. #
919 #<host suffix="invalid.org" separator="." prefix="">
920 #<hostchange mask="*@42.theanswer.example.org" action="addnick">
921 #<hostchange mask="*root@*" action="suffix">
922 #<hostchange mask="a@example.com" action="set" value="foo.bar.baz">
923 #<hostchange mask="localhost" ports="7000,7001,7005-7007" action="set" value="blahblah.foo">
925 # hostcycle: If loaded, when a user gets a host or ident set, it will
926 # cycle them in all their channels. If not loaded it will simply change
927 # their host/ident without cycling them.
928 # This module is compatible with the ircv3_chghost module. Clients
929 # supporting the chghost extension will get the chghost message instead
930 # of seeing a host cycle.
931 #<module name="hostcycle">
933 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
934 # httpd module: Provides HTTP server support for InspIRCd.
935 #<module name="httpd">
937 #-#-#-#-#-#-#-#-#-#-#-#- HTTPD CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
939 # If you choose to use the httpd module, then you will need to add
940 # a <bind> tag with type "httpd", and load at least one of the other
941 # httpd_* modules to provide pages to display.
943 # You can adjust the timeout for HTTP connections below. All HTTP
944 # connections will be closed after (roughly) this time period.
945 #<httpd timeout="20">
947 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
948 # HTTP ACL module: Provides access control lists for httpd dependent
949 # modules. Use this module to restrict pages by IP address and by
951 #<module name="httpd_acl">
953 #-#-#-#-#-#-#-#-#-#-#-#- HTTPD ACL CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
955 # Restrict access to the httpd_stats module to all but the local
956 # network and when the correct password is specified:
957 # <httpdacl path="/stats*" types="password,whitelist"
958 # username="secrets" password="mypasshere" whitelist="127.0.0.*,10.*">
960 # Deny all connections to all but the main index page:
961 # <httpdacl path="/*" types="blacklist" blacklist="*">
963 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
964 # HTTP config module: Allows the configuration of the server to be
965 # viewed over HTTP. Requires httpd to be loaded for it to function.
966 #<module name="httpd_config">
968 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
969 # HTTP stats module: Provides basic stats pages over HTTP.
970 # Requires httpd to be loaded for it to function.
971 #<module name="httpd_stats">
973 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
974 # Ident: Provides RFC 1413 ident lookup support.
975 # When this module is loaded <connect:allow> tags may have an optional
976 # useident="yes|no" boolean value, determining whether or not to lookup
977 # ident on users matching that connect tag.
978 #<module name="ident">
980 #-#-#-#-#-#-#-#-#-#-#-#- IDENT CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
982 # Optional - If you are using the ident module, then you can specify #
983 # the timeout for ident lookups here. If not defined, it will default #
984 # to 5 seconds. This is a non-blocking timeout which holds the user #
985 # in a 'connecting' state until the lookup is complete. #
986 # The bind value indicates which IP to bind outbound requests to. #
987 # nolookupprefix: If on, the idents of users being in a connect class #
988 # with ident lookups disabled (i.e. <connect useident="off">) will be #
989 # prefixed with a "~". If off, the ident of those users will not be #
990 # prefixed. Default is off. #
992 #<ident timeout="5" nolookupprefix="no">
994 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
995 # Invite exception module: Adds support for channel invite exceptions
997 #<module name="inviteexception">
998 # bypasskey: If this is enabled, exceptions will bypass +k as well as +i
999 #<inviteexception bypasskey="yes">
1001 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1002 # IRCv3 module: Provides the following IRCv3 extensions:
1003 # extended-join, away-notify and account-notify. These are optional
1004 # enhancements to the client-to-server protocol. An extension is only
1005 # active for a client when the client specifically requests it, so this
1006 # module needs the cap module to work.
1008 # Further information on these extensions can be found at the IRCv3
1009 # working group website:
1010 # http://ircv3.net/irc/
1012 #<module name="ircv3">
1013 # The following block can be used to control which extensions are
1014 # enabled. Note that extended-join can be incompatible with delayjoin
1016 #<ircv3 accountnotify="on" awaynotify="on" extendedjoin="on">
1018 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1019 # IRCv3 cap-notify module: Provides the cap-notify IRCv3.2 extension.
1020 # Required for IRCv3.2 conformance.
1021 #<module name="ircv3_capnotify">
1023 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1024 # IRCv3 chghost module: Provides the chghost IRCv3.2 extension which
1025 # allows capable clients to learn when the host/ident of another user
1026 # changes without cycling the user. This module is compatible with the
1027 # hostcycle module. If both are loaded, clients supporting the chghost
1028 # extension will get the chghost message and won't see host cycling.
1029 #<module name="ircv3_chghost">
1031 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1032 # IRCv3 echo-message module: Provides the echo-message IRCv3.2
1033 # extension which allows capable clients to get an acknowledgement when
1034 # their messages are delivered and learn what modifications, if any,
1035 # were applied to them.
1036 #<module name="ircv3_echomessage">
1038 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1039 # IRCv3 invite-notify module: Provides the invite-notify IRCv3.2
1040 # extension which notifies supporting clients when a user invites
1041 # another user into a channel. This respects <options:announceinvites>.
1042 #<module name="ircv3_invitenotify">
1044 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1045 # IRCv3 Strict Transport Security module: Provides the sts IRCv3.2
1046 # extension which allows clients connecting insecurely to upgrade their
1047 # connections to TLS.
1048 #<module name="ircv3_sts">
1050 # If using the ircv3_sts module you MUST define a STS policy to send
1051 # to clients using the <sts> tag. This tag takes the following
1054 # host - A glob match for the SNI hostname to apply this policy to.
1055 # duration - The amount of time that the policy lasts for. Defaults to
1056 # approximately two months by default.
1057 # port - The port on which TLS connections to the server are being
1058 # accepted. You MUST have a CA-verified certificate on this
1059 # port. Self signed certificates are not acceptable.
1060 # preload - Whether client developers can include your certificate in
1063 # <sts host="*.example.com" duration="60d" port="6697" preload="yes">
1065 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1066 # Join flood module: Adds support for join flood protection +j X:Y.
1067 # Closes the channel for N seconds if X users join in Y seconds.
1068 #<module name="joinflood">
1070 # The number of seconds to close the channel for:
1071 #<joinflood duration="1m">
1073 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1074 # Jump server module: Adds support for the RPL_REDIR numeric.
1075 # This module is oper-only.
1076 # To use, JUMPSERVER must be in one of your oper class blocks.
1077 # If your server is redirecting new clients and you get disconnected,
1078 # do a REHASH from shell to open up again.
1079 #<module name="jumpserver">
1081 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1082 # Anti auto rejoin: Adds support for prevention of auto-rejoin (+J).
1083 #<module name="kicknorejoin">
1085 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1086 # Knock module: Adds the /KNOCK command and channel mode +K.
1087 #<module name="knock">
1089 # This setting specifies what to do when someone successfully /KNOCKs.
1090 # If set to "notice", then a NOTICE will be sent to the channel.
1091 # This is the default and the compatible setting, as it requires no
1092 # special support from the clients.
1093 # If set to "numeric" then a 710 numeric will be sent to the channel.
1094 # This allows easier scripting but not all clients support it.
1095 # If set to "both" then (surprise!) both will be sent.
1096 #<knock notify="notice">
1098 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1099 # LDAP module: Allows other SQL modules to access a LDAP database
1100 # through a unified API.
1101 # This modules is in extras. Re-run configure with:
1102 # ./configure --enable-extras=m_ldap.cpp
1103 # and run make install, then uncomment this module to enable it.
1105 #<module name="ldap">
1106 #<database module="ldap" id="ldapdb" server="ldap://localhost" binddn="cn=Manager,dc=inspircd,dc=org" bindauth="mysecretpass" searchscope="subtree">
1107 # The server parameter indicates the LDAP server to connect to. The #
1108 # ldap:// style scheme before the hostname proper is MANDATORY. #
1110 # The binddn and bindauth indicate the DN to bind to for searching, #
1111 # and the password for the distinguished name. Some LDAP servers will #
1112 # allow anonymous searching in which case these two values do not #
1113 # need defining, otherwise they should be set similar to the examples #
1116 # The searchscope value indicates the subtree to search under. On our #
1117 # test system this is 'subtree'. Your mileage may vary. #
1119 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1120 # LDAP authentication module: Adds the ability to authenticate users #
1122 #<module name="ldapauth">
1126 # <ldapauth dbid="ldapdb" #
1127 # baserdn="ou=People,dc=brainbox,dc=cc" #
1129 # allowpattern="Guest* Bot*" #
1130 # killreason="Access denied" #
1132 # host="$uid.$ou.inspircd.org" #
1133 # useusername="no"> #
1135 # <ldapwhitelist cidr="10.42.0.0/16"> #
1137 # <ldaprequire attribute="attr" value="val"> #
1139 # The baserdn indicates the base DN to search in for users. Usually #
1140 # this is 'ou=People,dc=yourdomain,dc=yourtld'. #
1142 # The attribute value indicates the attribute which is used to locate #
1143 # a user account by name. On POSIX systems this is usually 'uid'. #
1145 # The allowpattern value allows you to specify a space separated list #
1146 # of wildcard masks which will always be allowed to connect #
1147 # regardless of if they have an account, for example guest and bot #
1150 # The useusername setting chooses whether the user's username or #
1151 # nickname is used when locating a user account, if a username isn't #
1152 # provided in PASS. #
1154 # Killreason indicates the QUIT reason to give to users if they fail #
1155 # to authenticate. #
1157 # Setting the verbose value causes an oper notice to be sent out for #
1158 # every failed authentication to the server, with an error string. #
1160 # ldapwhitelist indicates that clients connecting from an IP in the #
1161 # provided CIDR do not need to authenticate against LDAP. It can be #
1162 # repeated to whitelist multiple CIDRs. #
1164 # ldaprequire allows further filtering on the LDAP user, by requiring #
1165 # certain LDAP attibutes to have a given value. It can be repeated, #
1166 # in which case the list will act as an OR list, that is, the #
1167 # authentication will succeed if any of the requirements in the list #
1170 # host allows you to change the displayed host of users connecting #
1171 # from ldap. The string supplied takes formatters which are replaced #
1172 # from the DN. For instance, if your DN looks like: #
1173 # uid=w00t,ou=people,dc=inspircd,dc=org, then the formatters uid, ou #
1174 # and dc will be available to you. If a key is given multiple times #
1175 # in the DN, the last appearance will take precedence. #
1177 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1178 # LDAP oper configuration module: Adds the ability to authenticate #
1180 #<module name="ldapoper">
1184 # <ldapoper dbid="ldapdb"
1185 # baserdn="ou=People,dc=brainbox,dc=cc"
1188 # Available configuration items are identical to the same items in #
1189 # ldapauth above (except for the verbose setting, that is only #
1190 # supported in ldapauth). #
1191 # Please always specify a password in your <oper> tags even if the #
1192 # opers are to be authenticated via LDAP, so in case this module is #
1193 # not loaded the oper accounts are still protected by a password. #
1195 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1196 # Lock server module: Adds /LOCKSERV and /UNLOCKSERV commands that #
1197 # are used to temporarily close/open the server for new connections. #
1198 # These commands require that the /LOCKSERV and /UNLOCKSERV commands #
1199 # are specified in a <class> tag that the oper is part of. This is so #
1200 # you can control who has access to this possible dangerous command. #
1201 # If your server is locked and you get disconnected, do a REHASH from #
1202 # shell to open up again. #
1203 # This module is oper-only.
1204 #<module name="lockserv">
1206 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1207 # Map hiding module: replaces /MAP and /LINKS output to users with a #
1208 # message to see a website, set by maphide="http://test.org/map" in #
1209 # the <security> tag, instead. #
1210 #<module name="maphide">
1212 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1213 # Message flood module: Adds message/notice flood protection via
1215 #<module name="messageflood">
1217 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1218 # MLOCK module: Adds support for server-side enforcement of services
1219 # side MLOCKs. Basically, this module suppresses any mode change that
1220 # would likely be immediately bounced by services.
1221 #<module name="mlock">
1223 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1224 # Modenotice module: Adds the /MODENOTICE command that allows opers to
1225 # send notices to all users having the given user mode(s) set.
1226 #<module name="modenotice">
1228 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1229 # Monitor module: Adds support for MONITOR which is used by clients to
1230 # maintain notify lists.
1231 #<module name="monitor">
1233 # Set the maximum number of entries on a user's monitor list below.
1234 #<monitor maxentries="30">
1236 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1237 # MySQL module: Allows other SQL modules to access MySQL databases
1238 # through a unified API.
1239 # This module is in extras. Re-run configure with:
1240 # ./configure --enable-extras=m_mysql.cpp
1241 # and run make install, then uncomment this module to enable it.
1242 #<module name="mysql">
1244 #-#-#-#-#-#-#-#-#-#-#-#- SQL CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#-#
1246 # mysql is more complex than described here, see the wiki for more #
1247 # info: https://wiki.inspircd.org/Modules/3.0/mysql #
1249 #<database module="mysql" name="mydb" user="myuser" pass="mypass" host="localhost" id="my_database2">
1251 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1252 # Named modes module: Allows for the display and set/unset of channel
1253 # modes via long-form mode names via +Z and the /PROP command.
1254 # For example, to set a ban, do /mode #channel +Z ban=foo!bar@baz or
1255 # /PROP #channel ban=foo!bar@baz
1256 #<module name="namedmodes">
1258 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1259 # NAMESX module: Provides support for the NAMESX extension which allows
1260 # clients to see all the prefixes set on a user without getting confused.
1261 # This is supported by mIRC, x-chat, klient, and maybe more.
1262 #<module name="namesx">
1264 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1265 # National characters module:
1266 # 1) Allows using national characters in nicknames.
1267 # 2) Allows using custom (national) casemapping over the network.
1268 #<module name="nationalchars">
1270 # file - Location of the file which contains casemapping rules. If this
1271 # is a relative path then it is relative to "<PWD>/../locales"
1272 # on UNIX and "<PWD>/locales" on Windows.
1273 # casemapping - The name of the casemapping sent to clients in the 005
1274 # numeric. If this is not set then it defaults to the name
1275 # of the casemapping file unless the file name contains a
1276 # space in which case you will have to specify it manually.
1277 #<nationalchars file="bynets/russian-w1251-charlink" casemapping="ru_RU.cp1251-charlink">
1279 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1280 # Nickchange flood protection module: Provides channel mode +F X:Y
1281 # which allows up to X nick changes in Y seconds.
1282 #<module name="nickflood">
1284 # The number of seconds to prevent nick changes for:
1285 #<nickflood duration="1m">
1287 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1288 # Nicklock module: Let opers change a user's nick and then stop that
1289 # user from changing their nick again until unlocked.
1290 # This module is oper-only.
1291 # To use, NICKLOCK and NICKUNLOCK must be in one of your oper class blocks.
1292 #<module name="nicklock">
1294 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1295 # No CTCP module: Adds the channel mode +C to block CTCPs and extban
1296 # 'C' to block CTCPs sent by specific users.
1297 #<module name="noctcp">
1299 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1300 # No kicks module: Adds the +Q channel mode and the Q: extban to deny
1301 # certain users from kicking.
1302 #<module name="nokicks">
1304 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1305 # No nicks module: Adds the +N channel mode, as well as the 'N' extban.
1306 # +N stops all users from changing their nick, the N extban stops
1307 # anyone from matching a +b N:nick!user@host mask from changing their
1309 #<module name="nonicks">
1311 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1312 # No part message module: Adds extban 'p' to block part messages from #
1314 #<module name="nopartmsg">
1316 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1317 # No notice module: Adds the channel mode +T and the extban 'T' to
1318 # block specific users from noticing the channel.
1319 #<module name="nonotice">
1321 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1322 # Network business join module:
1323 # Allows an oper to join a channel using /OJOIN, giving them +Y on the
1324 # channel which makes them immune to kick/deop/etc.
1325 #<module name="ojoin">
1327 # Specify the prefix that +Y will grant here.
1328 # Leave 'prefix' empty if you do not wish +Y to grant a prefix.
1329 # If 'notice' is set to on, upon /OJOIN, the server will notice the
1330 # channel saying that the oper is joining on network business.
1331 # If 'op' is set to on, it will give them +o along with +Y.
1332 #<ojoin prefix="!" notice="yes" op="yes">
1334 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1335 # Oper channels mode: Adds the +O channel mode and extban O:<mask>
1336 # to ban, except, etc. specific oper types. For example
1337 # /mode #channel +iI O:* is equivalent to channel mode +O, but you
1338 # may also set +iI O:AdminTypeOnly to only allow admins.
1339 # Modes +I and +e work in a similar fashion.
1340 #<module name="operchans">
1342 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1343 # Oper join module: Auto-joins opers to a channel upon oper-up.
1344 # This module is oper-only. For the user equivalent, see the conn_join
1346 #<module name="operjoin">
1348 #-#-#-#-#-#-#-#-#-#-# OPERJOIN CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
1350 # If you are using the operjoin module, specify options here: #
1352 # channel - The channel name to join, can also be a comma #
1353 # separated list e.g. "#channel1,#channel2". #
1355 # override - If on, lets the oper join walking thru any modes #
1356 # that might be set, even bans. #
1358 #<operjoin channel="#channel" override="no">
1360 # Alternatively you can use the autojoin="channellist" in a <type> #
1361 # tag to set specific autojoins for a type of oper, for example: #
1363 #<type name="Helper" autojoin="#help" classes="...">
1365 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1366 # Oper log module: Logs all oper commands to the server log (with log
1367 # type "m_operlog" at default loglevel), and optionally to the 'r'
1369 # This module is oper-only.
1370 #<module name="operlog">
1372 # If the following option is on then all oper commands will be sent to
1373 # the snomask 'r'. The default is off.
1374 #<operlog tosnomask="off">
1376 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1377 # Oper prefixing module: Adds a channel prefix mode +y which is given
1378 # to all IRC operators automatically on all channels they are in.
1379 # This prefix mode is more powerful than channel op and other regular
1382 # Load this module if you want all your IRC operators to have channel
1384 #<module name="operprefix">
1386 # You may additionally customise the prefix character.
1387 #<operprefix prefix="!">
1389 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1390 # Oper MOTD module: Provides support for separate message of the day
1392 # This module is oper-only.
1393 #<module name="opermotd">
1395 #-#-#-#-#-#-#-#-#-#-# OPERMOTD CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
1397 # If you are using the opermotd module, specify the motd here. #
1399 # onoper - If on, the message is sent on /OPER, otherwise it's #
1400 # only sent when /OPERMOTD is used. #
1402 # processcolors - Allow color codes to be processed in the opermotd. #
1403 # Read the comment above <connect:allowmotdcolors> in #
1404 # inspircd.conf.example for details. #
1406 #<opermotd file="examples/opermotd.txt.example" onoper="yes" processcolors="false">
1408 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1409 # Override module: Adds support for oper override.
1410 # This module is oper-only.
1411 #<module name="override">
1413 #-#-#-#-#-#-#-#-#-#-# OVERRIDE CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
1415 # Much of override's configuration relates to your oper blocks. #
1416 # For more information on how to allow opers to override, see: #
1417 # https://wiki.inspircd.org/Modules/3.0/override #
1419 # noisy - If enabled, all oper overrides will be announced #
1420 # via channel notice. #
1422 # requirekey - If enabled, overriding on join requires a channel #
1423 # key of "override" to be specified #
1425 # enableumode - If enabled, usermode +O is required for override. #
1427 #<override noisy="yes" requirekey="no" enableumode="true">
1429 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1430 # Oper levels module: Gives each oper a level and prevents actions
1431 # being taken by lower level opers against higher level opers.
1432 # Specify the level as the 'level' parameter of the <type> tag.
1433 # This module is oper-only.
1434 #<module name="operlevels">
1436 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1437 # Oper modes module: Allows you to specify modes to add/remove on oper.
1438 # Specify the modes as the 'modes' parameter of the <type> tag
1439 # and/or as the 'modes' parameter of the <oper> tag.
1440 # This module is oper-only. For the user equivalent, see the
1441 # conn_umodes module.
1442 #<module name="opermodes">
1444 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1445 # Password forwarding module: Forwards a password users can send on
1446 # connect to the specified client below. The client is usually NickServ
1447 # and this module is usually used to authenticate users with NickServ
1448 # using their connect password.
1449 #<module name="passforward">
1452 # nick: nick to forward connect passwords to.
1455 # forwardmsg: Message to send to users using a connect password.
1456 # $nick will be the users' nick, $nickrequired will be the nick
1457 # of where the password is going (the nick above).
1458 # You can also use $user for the user ident string.
1459 forwardmsg="NOTICE $nick :*** Forwarding PASS to $nickrequired"
1461 # cmd: Command for the user to run when it receives a connect
1463 cmd="PRIVMSG $nickrequired :IDENTIFY $pass">
1465 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1466 # Password hash module: Allows hashed passwords to be used.
1467 # To be useful, a hashing module like bcrypt also needs to be loaded.
1468 #<module name="password_hash">
1470 #-#-#-#-#-#-#-#-#-# PASSWORD HASH CONFIGURATION #-#-#-#-#-#-#-#-#-#-#-#
1472 # To use this module, you must define a hash type for each oper's
1473 # password you want to hash. For example:
1475 # <oper name="Brain"
1476 # host="ident@dialup15.isp.test.com"
1478 # password="$2a$10$Mss9AtHHslZTLBrXqM0FB.JBwD.UTSu8A48SfrY9exrpxbsRiRTbO"
1481 # If you are using a hash algorithm which does not perform salting you can use
1482 # HMAC to salt your passwords in order to prevent them from being looked up in
1485 # hash="hmac-sha256" password="lkS1Nbtp$CyLd/WPQXizsbxFUTqFRoMvaC+zhOULEeZaQkUJj+Gg"
1487 # Generate hashes using the /MKPASSWD command on the server.
1488 # Don't run it on a server you don't trust with your password.
1490 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1491 # PBKDF2 module: Allows other modules to generate PBKDF2 hashes,
1492 # usually for cryptographic uses and security.
1493 # This module relies on other hash providers (e.g. SHA256).
1494 #<module name="pbkdf2">
1496 # iterations: Iterations the hashing function runs when generating new
1498 # length: Length in bytes of the derived key.
1499 #<pbkdf2 iterations="12288" length="32">
1500 # You can override these values with specific values
1501 # for specific providers if you want to. Example given for SHA256.
1502 #<pbkdf2prov hash="sha256" iterations="24576">
1504 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1505 # Permanent channels module: Channels with the permanent channel mode
1506 # will remain open even after everyone else has left the channel, and
1507 # therefore keep things like modes, ban lists and topic. Permanent
1508 # channels -may- need support from your Services package to function
1509 # properly with them. This adds channel mode +P.
1510 # This module is oper-only.
1511 #<module name="permchannels">
1513 # If you like, this module can write a config file of permanent channels
1514 # whenever +P is set, unset, or the topic/modes on a +P channel is changed.
1515 # If you want to do this, set the filename below, and uncomment the include.
1517 # If 'listmodes' is true then all list modes (+b, +I, +e, +g...) will be
1518 # saved. Defaults to false.
1519 #<permchanneldb filename="permchannels.conf" listmodes="true">
1520 #<include file="permchannels.conf">
1522 # You may also create channels on startup by using the <permchannels> block.
1523 #<permchannels channel="#opers" modes="isP" topic="Opers only.">
1525 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1526 # PostgreSQL module: Allows other SQL modules to access PgSQL databases
1527 # through a unified API.
1528 # This module is in extras. Re-run configure with:
1529 # ./configure --enable-extras=m_pgsql.cpp
1530 # and run make install, then uncomment this module to enable it.
1531 #<module name="pgsql">
1533 #-#-#-#-#-#-#-#-#-#-#-#- SQL CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#-#
1535 # pgsql is more complex than described here, see the wiki for #
1536 # more: https://wiki.inspircd.org/Modules/3.0/pgsql #
1538 #<database module="pgsql" name="mydb" user="myuser" pass="mypass" host="localhost" id="my_database" ssl="no">
1540 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1541 # Muteban: Implements extended ban 'm', which stops anyone matching
1542 # a mask like +b m:nick!user@host from speaking on channel.
1543 #<module name="muteban">
1545 # If notifyuser is set to no, the user will not be notified when
1546 # his/her message is blocked.
1547 #<muteban notifyuser="yes">
1549 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1550 # Random quote module: Provides a random quote on connect.
1551 # NOTE: Some of these may mimic fatal errors and confuse users and
1552 # opers alike - BEWARE!
1553 #<module name="randquote">
1555 #-#-#-#-#-#-#-#-#-#- RANDOMQUOTES CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
1557 # Optional - If you specify to use the randquote module, then specify #
1558 # below the path to the quotes file. #
1560 #<randquote file="quotes.txt">
1562 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1563 # Redirect module: Adds channel mode +L which redirects users to #
1564 # another channel when the channel has reached its user limit and #
1565 # user mode +L which stops redirection. #
1566 #<module name="redirect">
1568 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1569 # Regular expression provider for glob or wildcard (?/*) matching.
1570 # You must have at least 1 provider loaded to use the filter or rline
1571 # modules. This module has no additional requirements, as it uses the
1572 # matching already present in InspIRCd core.
1573 #<module name="regex_glob">
1575 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1576 # Regular expression provider for PCRE (Perl-Compatible Regular
1577 # Expressions). You need libpcre installed to compile and load this
1578 # module. You must have at least 1 provider loaded to use the filter or
1580 #<module name="regex_pcre">
1582 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1583 # Regular Expression Provider for RE2 Regular Expressions.
1584 # You need libre2 installed and in your include/library paths in order
1585 # to compile and load this module.
1586 #<module name="regex_re2">
1588 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1589 # Regular expression provider for POSIX regular expressions.
1590 # You shouldn't need any additional libraries on a POSIX-compatible
1591 # system (i.e.: any Linux, BSD, but not Windows). You must have at
1592 # least 1 provider loaded to use filter or rline.
1593 # On POSIX-compliant systems, regex syntax can be found by using the
1594 # command: 'man 7 regex'.
1595 #<module name="regex_posix">
1597 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1598 # Regular expression provider for C++11 std::regex regular expressions.
1599 # This module works on any fully compliant implementation of the C++11
1600 # std::regex container. Examples for such are Visual C++ 2010 and newer
1601 # but not libstdc++ (which GCC uses).
1602 # You should verify that std::regex is supported by your setup before
1603 # using this module, as it may compile normally but won't do anything
1604 # on some implementations.
1605 #<module name="regex_stdlib">
1607 # Specify the regular expression engine to use here. Valid settings are
1608 # bre, ere, awk, grep, egrep, ecmascript (default if not specified).
1609 #<stdregex type="ecmascript">
1611 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1612 # Regular expression provider for TRE regular expressions.
1613 # This is the same regular expression engine used by UnrealIRCd, so
1614 # if you are most familiar with the syntax of /SPAMFILTER from there,
1615 # this is the provider you want. You need libtre installed in order
1616 # to compile and load this module.
1617 #<module name="regex_tre">
1619 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1620 # Registered users only channel creation module. If enabled, only
1621 # registered users and opers can create new channels.
1623 # You probably *DO NOT* want to load this module on a public network.
1625 #<module name="regonlycreate">
1627 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1628 # Remove module: Adds the /REMOVE command which is a peaceful
1629 # alternative to /KICK.
1630 #<module name="remove">
1632 # supportnokicks: If true, /REMOVE is not allowed on channels where the
1633 # nokicks (+Q) mode is set. Defaults to false.
1634 # protectedrank: Members having this rank or above may not be /REMOVE'd
1635 # by anyone. Set to 0 to disable this feature. Defaults to 50000.
1636 #<remove supportnokicks="true" protectedrank="50000">
1638 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1639 # A module to block, kick or ban upon similar messages being uttered several times.
1640 # Syntax [~*][lines]:[sec]{[:difference]}{[:matchlines]}
1641 # ~ is to block, * is to ban, default is kick.
1642 # lines - In mode 1 the amount of lines that has to match consecutively - In mode 2 the size of the backlog to keep for matching
1643 # seconds - How old the message has to be before it's invalidated.
1644 # distance - Edit distance, in percent, between two strings to trigger on.
1645 # matchlines - When set, the function goes into mode 2. In this mode the function will trigger if this many of the last <lines> matches.
1647 # As this module can be rather CPU-intensive, it comes with some options.
1648 # maxbacklog - Maximum size that can be specified for backlog. 0 disables multiline matching.
1649 # maxdistance - Max percentage of difference between two lines we'll allow to match. Set to 0 to disable edit-distance matching.
1650 # maxlines - Max lines of backlog to match against.
1651 # maxtime - Maximum period of time a user can set. 0 to allow any.
1652 # size - Maximum number of characters to check for, can be used to truncate messages
1653 # before they are checked, resulting in less CPU usage. Increasing this beyond 512
1654 # doesn't have any effect, as the maximum length of a message on IRC cannot exceed that.
1655 #<repeat maxbacklog="20" maxlines="20" maxdistance="50" maxtime="0" size="512">
1656 #<module name="repeat">
1658 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1659 # Restricted channels module: Allows only opers to create channels.
1661 # You probably *DO NOT* want to load this module on a public network.
1663 #<module name="restrictchans">
1665 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1666 # Restrict message module: Allows users to only message opers.
1668 # You probably *DO NOT* want to load this module on a public network.
1670 #<module name="restrictmsg">
1672 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1673 # R-Line module: Ban users through regular expression patterns.
1674 #<module name="rline">
1676 #-#-#-#-#-#-#-#-#-#-#-#- RLINE CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#-#
1678 # If you wish to re-check a user when they change nickname (can be
1679 # useful under some situations, but *can* also use CPU with more users
1680 # on a server) then set 'matchonnickchange' to yes.
1681 # Also, this is where you set what Regular Expression engine is to be
1682 # used. If you ever change it while running, all of your R-Lines will
1683 # be wiped. This is the regex engine used by all R-Lines set, and
1684 # regex_<engine> must be loaded, or rline will be non-functional
1685 # until you load it or change the engine to one that is loaded.
1687 #<rline matchonnickchange="yes" engine="pcre">
1689 # Generally, you will NOT want to use 'glob' here, as this turns
1690 # rline into just another gline. The exceptions are that rline will
1691 # always use the full "nick!user@host realname" string, rather than only
1692 # user@host, but beware that only the ? and * wildcards are available,
1693 # and are the only way to specify where the space can occur if you do
1694 # use glob. For this reason, is recommended to use a real regex engine
1695 # so that at least \s or [[:space:]] is available.
1697 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1698 # RMODE module: Adds the /RMODE command
1699 # Allows channel mods to remove list modes en masse.
1700 # Syntax: /rmode <channel> <mode> [pattern]
1701 # E.g. '/rmode #Channel b m:*' will remove all mute-extbans on the channel.
1702 #<module name="rmode">
1704 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1705 # SAJOIN module: Adds the /SAJOIN command which forcibly joins a user
1706 # to the given channel.
1707 # This module is oper-only.
1708 # To use, SAJOIN must be in one of your oper class blocks.
1709 # Opers need the users/sajoin-others priv to be able to /SAJOIN users
1710 # other than themselves.
1711 #<module name="sajoin">
1713 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1714 # SAKICK module: Adds the /SAKICK command which kicks a user from the
1716 # This module is oper-only.
1717 # To use, SAKICK must be in one of your oper class blocks.
1718 #<module name="sakick">
1720 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1721 # SAMODE module: Adds the /SAMODE command which allows server operators
1722 # to change modes on a channel without requiring them to have any
1723 # channel priviliges. Also allows changing user modes for any user.
1724 # This module is oper-only.
1725 # To use, SAMODE must be in one of your oper class blocks.
1726 #<module name="samode">
1728 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1729 # SANICK module: Adds the /SANICK command which allows opers to change
1731 # This module is oper-only.
1732 # To use, SANICK must be in one of your oper class blocks.
1733 #<module name="sanick">
1735 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1736 # SAPART module: Adds the /SAPART command which forcibly parts a user
1738 # This module is oper-only.
1739 # To use, SAPART must be in one of your oper class blocks.
1740 #<module name="sapart">
1742 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1743 # SAQUIT module: Adds the /SAQUIT command which forcibly quits a user.
1744 # This module is oper-only.
1745 # To use, SAQUIT must be in one of your oper class blocks.
1746 #<module name="saquit">
1748 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1749 # SATOPIC module: Adds the /SATOPIC command which allows changing the
1750 # topic on a channel without requiring any channel priviliges.
1751 # This module is oper-only.
1752 # To use, SATOPIC must be in one of your oper class blocks.
1753 #<module name="satopic">
1755 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1756 # SASL authentication module: Provides support for IRC Authentication
1757 # Layer via AUTHENTICATE. Note: You also need to have cap loaded
1759 #<module name="sasl">
1760 # Define the following to your services server name to improve security
1761 # by ensuring the SASL messages are only sent to the services server
1762 # and not to all connected servers. This prevents a rogue server from
1763 # capturing SASL messages and disables the SASL cap when services is
1765 #<sasl target="services.mynetwork.com">
1767 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1768 # Secure list module: Prevent /LIST in the first minute of connection,
1769 # crippling most spambots and trojan spreader bots.
1770 #<module name="securelist">
1772 #-#-#-#-#-#-#-#-#-# SECURELIST CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#-#
1774 # Securelist can be harmful to some IRC search engines. To prevent #
1775 # securelist blocking these sites from listing, define exception tags #
1777 #<securehost exception="*@*.netsplit.de">
1778 #<securehost exception="*@*.ircdriven.com">
1779 #<securehost exception="*@*.ircs.me">
1781 # Define the following variable to change how long a user must wait #
1782 # before issuing a LIST. If not defined, defaults to 60 seconds. #
1784 #<securelist waittime="1m"> #
1786 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1787 # Servprotect module: Provides support for Austhex style +k /
1788 # UnrealIRCD +S services mode.
1789 #<module name="servprotect">
1791 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1792 # See nicks module: Adds snomask +n and +N which show local and remote
1794 # This module is oper-only.
1795 #<module name="seenicks">
1797 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1798 # Set idle module: Adds a command for opers to change their idle time.
1799 # This module is oper-only.
1800 # To use, SETIDLE must be in one of your oper class blocks.
1801 #<module name="setidle">
1803 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1804 # Services support module: Adds several usermodes such as +R and +M.
1805 # This module implements the 'identified' state via account names,
1806 # and is similar in operation to the way asuka and ircu handle services.
1808 # At the same time, this offers +r for users and channels to mark them
1809 # as identified separately from the idea of a master account, which
1810 # can be useful for services which are heavily nick-as-account centric.
1812 # Also of note is that this module implements two extbans:
1813 # +b R: (stop matching account names from joining)
1814 # +b U:n!u@h (blocks matching unregistered users)
1816 #<module name="services_account">
1818 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1819 # Sethost module: Adds the /SETHOST command.
1820 # This module is oper-only.
1821 # To use, SETHOST must be in one of your oper class blocks.
1822 # See the chghost module for how to customise valid chars for hostnames.
1823 #<module name="sethost">
1825 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1826 # Setident module: Adds the /SETIDENT command.
1827 # This module is oper-only.
1828 # To use, SETIDENT must be in one of your oper class blocks.
1829 #<module name="setident">
1831 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1832 # SETNAME module: Adds the /SETNAME command.
1833 #<module name="setname">
1835 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1836 # Serverban: Implements extended ban 's', which stops anyone connected
1837 # to a server matching a mask like +b s:server.mask.here from joining.
1838 #<module name="serverban">
1840 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1841 # SHA1 module: Allows other modules to generate SHA1 hashes.
1842 # Required by the WebSocket module.
1843 #<module name="sha1">
1845 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1846 # Showfile: Provides support for showing a text file to users when #
1847 # they enter a command. #
1848 # This module adds one command for each <showfile> tag that shows the #
1849 # given file to the user as a series of messages or numerics. #
1850 #<module name="showfile"> #
1852 #-#-#-#-#-#-#-#-#-#-# SHOWFILE CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#-#
1854 # name - The name of the command which displays this file. This is #
1855 # the only mandatory setting, all others are optional. #
1856 # file - The text file to be shown to the user. #
1857 # By default same as the command name. #
1858 # method - How should the file be shown? #
1859 # * numeric: Send contents using a numeric #
1860 # (similar to /MOTD; the default). #
1861 # * notice: Send contents as a series of notices. #
1862 # * msg: Send contents as a series of private messages. #
1863 # colors - If true, color codes (\c, \b, \u, etc.) will be processed #
1864 # and sent as ANSI colors. If false (default) the file will #
1865 # be displayed as-is. #
1867 # When using the method "numeric", the following extra settings are #
1870 # introtext - Introductory line, "Showing <name>" by default. #
1871 # intronumeric - Numeric used for the introductory line. #
1872 # numeric - Numeric used for sending the text itself. #
1873 # endtext - Ending line, "End of <name>" by default. #
1874 # endnumeric - Numeric used for the ending line. #
1876 #<showfile name="RULES"
1879 # introtext="Server rules:"
1880 # endtext="End of server rules.">
1882 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1883 # Show whois module: Adds the +W usermode which allows opers to see
1884 # when they are /WHOIS'd.
1885 # This module is oper-only by default.
1886 #<module name="showwhois">
1888 # If you wish, you may also let users set this mode. Only opers with the
1889 # users/auspex priv will see real hosts of people, though.
1890 #<showwhois opersonly="yes"
1892 # You may also set whether or not users should receive whois notices,
1893 # should they be /WHOIS'd by an oper.
1894 #showfromopers="yes">
1896 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1897 # Shun module: Provides the /SHUN command, which stops a user from
1898 # executing all except configured commands.
1899 # This module is oper-only.
1900 # To use, SHUN must be in one of your oper class blocks.
1901 #<module name="shun">
1903 # You may also configure which commands you wish a user to be able to
1904 # perform when shunned. It should be noted that if a shunned user
1905 # issues QUIT or PART then their message will be removed, as if they
1906 # did not issue one.
1908 # You can optionally let the user know that their command was blocked.
1910 # You may also let SHUN affect opers (defaults to no).
1911 #<shun enabledcommands="ADMIN PING PONG QUIT PART JOIN" notifyuser="yes" affectopers="no">
1913 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1914 # SSL mode module: Adds support for SSL-only channels via the '+z'
1915 # channel mode, SSL-only private messages via the '+z' user mode and
1916 # the 'z:' extban which matches SSL client certificate fingerprints.
1918 # Does not do anything useful without a working SSL module and the
1919 # sslinfo module (see below).
1920 #<module name="sslmodes">
1922 # The +z user mode is not enabled by default to enable link compatibility
1923 # with 2.0 servers. You can enable it by uncommenting this:
1924 #<sslmodes enableumode="yes">
1926 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1927 # SSL rehash signal module: Allows the SSL modules to be rehashed by
1928 # sending SIGUSR1 to a running InspIRCd process.
1929 # This modules is in extras. Re-run configure with:
1930 # ./configure --enable-extras=m_sslrehashsignal.cpp
1931 # and run make install, then uncomment this module to enable it.
1932 #<module name="sslrehashsignal">
1934 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1935 # GnuTLS SSL module: Adds support for SSL connections using GnuTLS,
1936 # if enabled. You must answer 'yes' in ./configure when asked or
1937 # manually symlink the source for this module from the directory
1938 # src/modules/extra, if you want to enable this, or it will not load.
1939 #<module name="ssl_gnutls">
1941 #-#-#-#-#-#-#-#-#-#-#- GNUTLS CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#
1943 # ssl_gnutls is too complex to describe here, see the wiki: #
1944 # https://wiki.inspircd.org/Modules/3.0/ssl_gnutls #
1946 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1947 # SSL info module: Allows users to retrieve information about other
1948 # users' peer SSL certificates and keys. This can be used by client
1949 # scripts to validate users. For this to work, one of ssl_gnutls
1950 # or ssl_openssl must be loaded. This module also adds the
1951 # "* <user> is using a secure connection" whois line, the ability for
1952 # opers to use SSL cert fingerprints to verify their identity and the
1953 # ability to force opers to use SSL connections in order to oper up.
1954 # It is highly recommended to load this module if you use SSL on your
1956 # For how to use the oper features, please see the first example <oper> tag
1957 # in opers.conf.example.
1959 #<module name="sslinfo">
1961 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1962 # mbedTLS SSL module: Adds support for SSL/TLS connections using mbedTLS.
1963 #<module name="ssl_mbedtls">
1965 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1966 # OpenSSL SSL module: Adds support for SSL connections using OpenSSL,
1967 # if enabled. You must answer 'yes' in ./configure when asked or symlink
1968 # the source for this module from the directory src/modules/extra, if
1969 # you want to enable this, or it will not load.
1970 #<module name="ssl_openssl">
1972 #-#-#-#-#-#-#-#-#-#-#- OPENSSL CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#
1974 # ssl_openssl is too complex to describe here, see the wiki: #
1975 # https://wiki.inspircd.org/Modules/3.0/ssl_openssl #
1977 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1978 # Strip color module: Adds channel mode +S that strips color codes and
1979 # all control codes except CTCP from all messages sent to the channel.
1980 #<module name="stripcolor">
1982 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1983 # Silence module: Adds support for the /SILENCE command, which allows
1984 # users to have a server-side ignore list for their client.
1985 #<module name="silence">
1987 # Set the maximum number of entries allowed on a user's silence list.
1988 #<silence maxentries="32"
1990 # Whether messages from U-lined servers will bypass silence masks.
1993 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1994 # SQLite3 module: Allows other SQL modules to access SQLite3 #
1995 # databases through a unified API. #
1996 # This module is in extras. Re-run configure with: #
1997 # ./configure --enable-extras=m_sqlite3.cpp
1998 # and run make install, then uncomment this module to enable it. #
2000 #<module name="sqlite3">
2002 #-#-#-#-#-#-#-#-#-#-#-#- SQL CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#-#
2004 # sqlite is more complex than described here, see the wiki for more #
2005 # info: https://wiki.inspircd.org/Modules/3.0/sqlite3 #
2007 #<database module="sqlite" hostname="/full/path/to/database.db" id="anytext">
2009 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2010 # SQL authentication module: Allows IRCd connections to be tied into
2011 # a database table (for example a forum).
2013 #<module name="sqlauth">
2015 #-#-#-#-#-#-#-#-#-#-#- SQLAUTH CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#
2017 # sqlauth is too complex to describe here, see the wiki: #
2018 # https://wiki.inspircd.org/Modules/3.0/sqlauth #
2020 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2021 # SQL oper module: Allows you to store oper credentials in an SQL
2022 # table. You can add additional table columns like you would config
2023 # tags in opers.conf. Opers in opers.conf will override opers from
2026 #<module name="sqloper">
2028 #-#-#-#-#-#-#-#-#-#-#- SQLOPER CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#
2030 # dbid - Database ID to use (see SQL modules). #
2032 # See also: https://wiki.inspircd.org/Modules/3.0/sqloper #
2036 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2037 # StartTLS module: Implements STARTTLS, which allows clients #
2038 # connected to non SSL enabled ports to enable SSL, if a proper SSL #
2039 # module is loaded (either ssl_gnutls or ssl_openssl). #
2040 #<module name="starttls">
2042 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2043 # SVSHold module: Implements SVSHOLD. Like Q:Lines, but can only be #
2044 # added/removed by Services. #
2045 #<module name="svshold">
2046 # SVSHOLD does not generate server notices by default, you can turn
2047 # notices on by uncommenting the next line.
2048 #<svshold silent="false">
2050 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2051 # SWHOIS module: Allows you to add arbitrary lines to user WHOIS.
2052 # This module is oper-only.
2053 # To use, SWHOIS must be in one of your oper class blocks.
2054 #<module name="swhois">
2056 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2057 # Timed bans module: Adds timed channel bans with the /TBAN command.
2058 #<module name="timedbans">
2060 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2061 # Test line module: Adds the /TLINE command, used to test how many
2062 # users a /GLINE or /ZLINE etc. would match.
2063 # This module is oper-only.
2064 # To use, TLINE must be in one of your oper class blocks.
2065 #<module name="tline">
2067 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2068 # Topiclock module: implements server-side topic locking to achieve deeper
2069 # integration with services packages.
2070 #<module name="topiclock">
2072 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2073 # UHNAMES support module: Adds support for the IRCX style UHNAMES
2074 # extension, which displays ident and hostname in the names list for
2075 # each user, saving clients from doing a WHO on the channel.
2076 # If a client does not support UHNAMES it will not enable it, this will
2077 # not break incompatible clients.
2078 #<module name="uhnames">
2080 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2081 # Uninvite module: Adds the /UNINVITE command which lets users remove
2082 # pending invites from channels without waiting for the user to join.
2083 #<module name="uninvite">
2085 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2086 # Userip module: Adds the /USERIP command.
2087 # Allows users to query their own IP, also allows opers to query the IP
2089 #<module name="userip">
2091 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2092 # Vhost module: Adds the VHOST command which allows for adding virtual
2093 # hosts which are accessible using a username and password in the config.
2094 #<module name="vhost">
2096 #-#-#-#-#-#-#-#-#-#-#- VHOST CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#-#
2098 # user - Username for the vhost. #
2100 # pass - Password for the vhost. #
2102 # hash - The hash for the specific user (optional) #
2103 # password_hash and a hashing module must be loaded for #
2106 # host - Vhost to set. #
2108 #<vhost user="some_username" pass="some_password" host="some.host.test.cc">
2109 #<vhost user="foo" password="$2a$10$iTuYLT6BRhRlOgzfsW9oPe62etW.oXwSpyKw5rJit64SGZanLXghO" hash="bcrypt" host="some.other.host.example.com">
2111 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2112 # Watch module: Adds the WATCH command, which is used by clients to
2113 # maintain notify lists.
2114 #<module name="watch">
2116 # Set the maximum number of entries on a user's watch list below.
2117 #<watch maxentries="32">
2119 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2120 # WebSocket module: Adds HTML5 WebSocket support.
2121 # Specify hook="websocket" in a <bind> tag to make that port accept
2122 # WebSocket connections. Compatible with SSL/TLS.
2123 # Requires SHA-1 hash support available in the sha1 module.
2124 #<module name="websocket">
2126 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2127 # XLine database: Stores all *Lines (G/Z/K/R/any added by other modules)
2128 # in a file which is re-loaded on restart. This is useful
2129 # for two reasons: it keeps bans so users may not evade them, and on
2130 # bigger networks, server connections will take less time as there will
2131 # be a lot less bans to apply - as most of them will already be there.
2132 #<module name="xline_db">
2134 # Specify the filename for the xline database here.
2135 #<xlinedb filename="xline.db">
2137 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2138 # ____ _ _____ _ _ ____ _ _ _ #
2139 # | _ \ ___ __ _ __| | |_ _| |__ (_)___ | __ )(_) |_| | #
2140 # | |_) / _ \/ _` |/ _` | | | | '_ \| / __| | _ \| | __| | #
2141 # | _ < __/ (_| | (_| | | | | | | | \__ \ | |_) | | |_|_| #
2142 # |_| \_\___|\__,_|\__,_| |_| |_| |_|_|___/ |____/|_|\__(_) #
2144 # To link servers to InspIRCd, you MUST load the spanningtree module. #
2145 # If you don't do this, server links will NOT work at all. #
2146 # This is by design, to allow for the implementation of other linking #
2147 # protocols in modules in the future. #
2149 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2150 # Spanning tree module: Allows linking of servers using the spanning
2151 # tree protocol (see the READ THIS BIT section above).
2152 # You will almost always want to load this.
2154 #<module name="spanningtree">
projects / user / henk / code / inspircd.git / blob