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 # Auditorium module: Adds channel mode +u which makes everyone else
180 # except you in the channel invisible, used for large meetings etc.
181 #<module name="auditorium">
183 # Auditorium settings:
185 #<auditorium opvisible="no" opcansee="no" opercansee="yes">
187 # opvisible (auditorium-vis in exemptchanops):
188 # Show channel ops to all users
189 # opcansee (auditorium-see in exemptchanops):
190 # Allow ops to see all joins/parts/kicks in the channel
192 # Allow opers (channels/auspex) to see see all joins/parts/kicks in the channel
194 # Exemptchanops can be used to adjust the level at which users become visible or
195 # the level at which they can see the full member list of the channel.
197 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
198 # Autoop module: Adds basic channel access controls via the +w listmode.
199 # For example +w o:*!Attila@127.0.0.1 will op anyone matching that mask
200 # on join. This can be combined with extbans, for example +w o:R:Brain
201 # will op anyone identified to the account "Brain".
202 # Another useful combination is with SSL client certificate
203 # fingerprints: +w h:z:72db600734bb9546c1bdd02377bc21d2a9690d48 will
204 # give halfop to the user(s) having the given certificate.
205 #<module name="autoop">
207 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
208 # Ban except module: Adds support for channel ban exceptions (+e).
209 #<module name="banexception">
211 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
212 # Ban redirection module: Allows bans which redirect to a specified
213 # channel. e.g. +b nick!ident@host#channelbanneduserissentto
214 #<module name="banredirect">
216 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
217 # bcrypt module: Allows other modules to generate bcrypt hashes,
218 # usually for cryptographic uses and security.
219 #<module name="bcrypt">
221 # rounds: Defines how many rounds the bcrypt function will run when
222 # generating new hashes.
223 #<bcrypt rounds="10">
225 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
226 # Block amsg module: Attempt to block all usage of /amsg and /ame.
227 #<module name="blockamsg">
229 #-#-#-#-#-#-#-#-#-#-#- BLOCKAMSG CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
231 # If you have the blockamsg module loaded, you can configure it with #
232 # the <blockamsg> tag: #
234 # delay - How much time between two messages to force them #
235 # to be recognised as unrelated. #
236 # action - Any of 'notice', 'noticeopers', 'silent', 'kill' #
237 # or 'killopers'. Define how to take action when #
238 # a user uses /amsg or /ame. #
240 #<blockamsg delay="3" action="killopers">
242 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
243 # Block CAPS module: Adds channel mode +B, blocks all-CAPS messages.
244 #<module name="blockcaps">
246 #-#-#-#-#-#-#-#-#-#-#- BLOCKCAPS CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
248 # percent - What percentage of the text must be caps before #
249 # text will be blocked. #
251 # minlen - The minimum length a line must be for the block #
252 # percent to have any effect. #
254 # capsmap - A list of chars to be considered CAPS. Can be used #
255 # to add CAPS characters for your language. Also you #
256 # can add things like ! and space to further lock #
257 # down on caps usage. #
258 #<blockcaps percent="50"
260 # capsmap="ABCDEFGHIJKLMNOPQRSTUVWXYZ! ">
262 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
263 # Block color module: Blocking color-coded messages with chan mode +c.
264 #<module name="blockcolor">
266 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
267 # Botmode module: Adds the user mode +B. If set on a user, it will
268 # show that the user is a bot in /WHOIS.
269 #<module name="botmode">
271 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
272 # CallerID module: Adds usermode +g which activates hybrid-style
273 # callerid: block all private messages unless you /ACCEPT first.
274 #<module name="callerid">
276 #-#-#-#-#-#-#-#-#-#-#- CALLERID CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#
277 # maxaccepts - Maximum number of entries a user can add to his #
278 # /ACCEPT list. Default is 16 entries. #
279 # operoverride - Can opers (note: ALL opers) override callerid? #
281 # tracknick - Preserve /accept entries when a user changes nick? #
282 # If no (the default), the user is removed from #
283 # everyone's accept list if he changes nickname. #
284 # cooldown - Amount of time that must pass since the last #
285 # notification sent to a user before he can be sent #
286 # another. Default is 1 minute. #
287 #<callerid maxaccepts="16"
292 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
293 # CAP module: Provides the CAP negotiation mechanism required by the
294 # sasl, namesx, uhnames, and ircv3 modules.
295 # It is also recommended for STARTTLS support in the starttls module.
298 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
299 # CBAN module: Lets you disallow channels from being used at runtime.
300 # This module is oper-only and provides /CBAN.
301 # To use, CBAN must be in one of your oper class blocks.
302 #<module name="cban">
304 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
305 # Censor module: Adds channel and user mode +G.
306 #<module name="censor">
308 #-#-#-#-#-#-#-#-#-#-#- CENSOR CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#
310 # Optional - If you specify to use the censor module, then you must #
311 # specify some censor tags. See also: #
312 # https://wiki.inspircd.org/Modules/3.0/censor #
314 #<include file="examples/censor.conf.example">
316 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
317 # CGI:IRC module: Enables forwarding the real IP address of a user from
318 # a gateway to the IRC server.
319 #<module name="cgiirc">
321 #-#-#-#-#-#-#-#-#-#-#-# CGIIRC CONFIGURATION #-#-#-#-#-#-#-#-#-#-#-#-#
323 # If you use the cgiirc module then you must specify the gateways which
324 # are authorised to forward IP/host information to your server. There
325 # are currently two ways to do this:
327 # The webirc method is the recommended way to allow gateways to forward
328 # IP/host information. When using this method the gateway sends a WEBIRC
329 # message to the server on connection. For more details please read the
330 # IRCv3 WebIRC specification at http://ircv3.net/specs/extensions/webirc.html.
332 # When using this method you must specify a wildcard mask or CIDR range
333 # to allow gateway connections from and at least one of either a SSL
334 # client certificate fingerprint for the gateway or a password to be
335 # sent in the WEBIRC command.
337 # <cgihost type="webirc"
338 # fingerprint="bd90547b59c1942b85f382bc059318f4c6ca54c5"
339 # mask="192.0.2.0/24">
340 # <cgihost type="webirc"
341 # password="$2a$10$WEUpX9GweJiEF1WxBDSkeODBstIBMlVPweQTG9cKM8/Vd58BeM5cW"
343 # mask="*.webirc.gateway.example.com">
345 # Alternatively if your gateway does not support sending the WEBIRC
346 # message then you can configure InspIRCd to look for the client IP
347 # address in the ident sent by the user. This is not recommended as it
348 # only works with IPv4 connections.
350 # When using this method you must specify a wildcard mask or CIDR range to
351 # allow gateway connections from.
353 # <cgihost type="ident" mask="198.51.100.0/24">
354 # <cgihost type="ident" mask="*.ident.gateway.example.com">
356 # By default gateway connections are logged to the +w snomask. If you
357 # do not want this to happen then you can uncomment this to disable it.
358 # <cgiirc opernotice="no">
363 # When you connect gateway clients, there are two connect classes which
364 # apply to these clients. When the client initially connects, the connect
365 # class which matches the gateway site's host is checked. Therefore you
366 # must raise the maximum local/global clients for this IP as high as you
367 # want to allow gateway clients. After the client has connected and is
368 # determined to be a gateway client, the class which matches the client's
369 # real IP is then checked. You may set this class to a lower value, so that
370 # the real IP of the client can still be restricted to, for example, 3
373 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
374 # Channel create module: Adds snomask +j, which will notify opers of
375 # any new channels that are created.
376 # This module is oper-only.
377 #<module name="chancreate">
379 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
380 # Channel filter module: Allows channel-op defined message filtering
381 # using simple string matches (channel mode +g).
382 #<module name="chanfilter">
384 # If hidemask is set to yes, the user will not be shown the mask when
385 # his/her message is blocked.
386 #<chanfilter hidemask="yes">
388 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
389 # Channel history module: Displays the last 'X' lines of chat to a user
390 # joining a channel with +H 'X:T' set; 'T' is the maximum time to keep
391 # lines in the history buffer. Designed so that the new user knows what
392 # the current topic of conversation is when joining the channel.
393 #<module name="chanhistory">
395 # Set the maximum number of lines allowed to be stored per channel below.
396 # This is the hard limit for 'X'.
397 # If notice is set to yes, joining users will get a NOTICE before playback
398 # telling them about the following lines being the pre-join history.
399 # If bots is set to yes, it will also send to users marked with +B
400 #<chanhistory maxlines="20" notice="yes" bots="yes">
402 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
403 # Channel logging module: Used to send snotice output to channels, to
404 # allow staff to centrally monitor and discuss network activity.
406 # The "channel" field is where you want the messages to go, "snomasks"
407 # is what snomasks you want to be sent to that channel. Multiple tags
409 #<module name="chanlog">
410 #<chanlog snomasks="AOcC" channel="#opers">
412 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
413 # Channel names module: Allows disabling channels which have certain
414 # characters in the channel name such as bold, colorcodes, etc. which
415 # can be quite annoying and allow users to on occasion have a channel
416 # that looks like the name of another channel on the network.
417 #<module name="channames">
420 # denyrange: characters or range of characters to deny in channel
424 # allowrange: characters or range of characters to specifically allow
428 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
429 # Channelban: Implements extended ban j:, which stops anyone already
430 # in a channel matching a ban like +b j:#channel*mask from joining.
431 # Note that by default wildcard characters * and ? are allowed in
432 # channel names. To disallow them, load m_channames and add characters
433 # 42 and 63 to denyrange (see above).
434 #<module name="channelban">
436 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
437 # Check module: Adds the /CHECK command.
438 # Check is useful for looking up information on channels, users,
439 # IP addresses and hosts.
440 # This module is oper-only.
441 # To use, CHECK must be in one of your oper class blocks.
442 #<module name="check">
444 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
445 # CHGHOST module: Adds the /CHGHOST command.
446 # This module is oper-only.
447 # To use, CHGHOST must be in one of your oper class blocks.
448 # NOTE: Services will not be able to set vhosts on users if this module
449 # isn't loaded. If you're planning on running services, you probably
451 #<module name="chghost">
453 #-#-#-#-#-#-#-#-# /CHGHOST - /SETHOST CONFIGURATION #-#-#-#-#-#-#-#-#
454 # Optional - If you want to use special chars for hostnames you can #
455 # specify your own custom list of chars with the <hostname> tag: #
457 # charmap - A list of chars accepted as valid by the /CHGHOST #
458 # and /SETHOST commands. Also note that the list is #
460 #<hostname charmap="abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ.-_/0123456789">
462 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
463 # CHGIDENT module: Adds the /CHGIDENT command.
464 # This module is oper-only.
465 # To use, CHGIDENT must be in one of your oper class blocks.
466 #<module name="chgident">
468 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
469 # CHGNAME module: Adds the /CHGNAME command.
470 # This module is oper-only.
471 # To use, CHGNAME must be in one of your oper class blocks.
472 #<module name="chgname">
474 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
475 # Connection class ban module: Adds support for extban 'n' which
476 # matches against the class name of the user's connection.
477 # This module assumes that connection classes are named in a uniform
478 # way on all servers of the network.
479 #<module name="classban">
481 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
482 # Clear chan module: Allows opers to masskick, masskill or mass-G/ZLine
483 # all users on a channel using /CLEARCHAN.
484 #<module name="clearchan">
486 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
487 # Cloaking module: Adds usermode +x and cloaking support.
488 # Relies on the md5 module being loaded.
489 # To cloak users when they connect, load the conn_umodes module and set
490 # <connect:modes> to include the +x mode. The example <connect> tag
491 # shows this. See the conn_umodes module for more information.
492 #<module name="cloaking">
494 #-#-#-#-#-#-#-#-#-#-#- CLOAKING CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#
496 # To use cloaking, you must define a cloak key, and optionally a #
497 # cloak prefix as shown below. The cloak key must be shared across #
498 # the network for correct cloaking. #
500 # There are two methods of cloaking: #
502 # half Cloak only the "unique" portion of a host; by #
503 # default show the last 2 parts of the domain, #
504 # /16 subnet of IPv4 or /48 subnet of the IPv6 #
506 # To change the number of shown parts, modify the #
507 # domainparts option. #
509 # full Cloak the users completely, using three slices for #
510 # common CIDR bans (IPv4: /16, /24; IPv6: /48, /64). #
512 # The methods use a single key that can be any length of text. #
513 # An optional prefix may be specified to mark cloaked hosts. #
514 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
521 #-#-#-#-#-#-#-#-#-#-#-#- CLOSE MODULE #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
522 # Close module: Allows an oper to close all unregistered connections.
523 # This module is oper-only and provides the /CLOSE command.
524 # To use, CLOSE must be in one of your oper class blocks.
525 #<module name="close">
527 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
528 # Clones module: Adds an oper command /CLONES for detecting cloned
529 # users. Warning: This command may be resource intensive when it is
530 # issued, use with care.
531 # This module is oper-only.
532 # To use, CLONES must be in one of your oper class blocks.
533 #<module name="clones">
535 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
536 # Common channels module: Adds user mode +c, which, when set, requires
537 # that users must share a common channel with you to PRIVMSG or NOTICE
539 #<module name="commonchans">
541 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
542 # Auto join on connect module: Allows you to force users to join one
543 # or more channels automatically upon connecting to the server, or
544 # join them in case they aren't on any channels after being online
546 #<module name="conn_join">
548 #-#-#-#-#-#-#-#-#-#-#-#- CONNJOIN CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
550 # If you have the conn_join module loaded, you can configure it below
551 # or set autojoin="#chat,#help" in <connect> blocks.
553 # Join users immediately after connection to #one #two and #three.
554 #<autojoin channel="#one,#two,#three">
555 # Join users to #chat after 15 seconds if they aren't on any channels.
556 #<autojoin channel="#chat" delay="15">
558 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
559 # Set modes on connect module: When this module is loaded <connect>
560 # blocks may have an optional modes="" value, which contains modes to
561 # add or remove from users when they connect to the server.
562 #<module name="conn_umodes">
564 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
565 # Wait for PONG on connect module: Send a PING to all connecting users
566 # and don't let them connect until they reply with a PONG.
567 # This is useful to stop certain kinds of bots and proxies.
568 #<module name="conn_waitpong">
570 #-#-#-#-#-#-#-#-#-#-#- WAITPONG CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
572 # If you have the conn_waitpong module loaded, configure it with the #
575 # sendsnotice - Whether to send a helpful notice to users on #
576 # connect telling them how to connect, should #
577 # their client not reply PONG automatically. #
579 # killonbadreply - Whether to kill the user if they send the wrong #
582 #<waitpong sendsnotice="yes" killonbadreply="yes">
584 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
585 # Channel cycle module: Adds the /CYCLE command which is a server-side
586 # /HOP that bypasses restrictive modes.
587 #<module name="cycle">
589 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
590 # Connectban: Provides IP connection throttling. Any IP range that
591 # connects too many times (configurable) in an hour is Z-Lined for a
592 # (configurable) duration, and their count resets to 0.
593 #<module name="connectban">
595 # ipv4cidr and ipv6cidr allow you to turn the comparison from
596 # individual IP addresses (32 and 128 bits) into CIDR masks, to allow
597 # for throttling over whole ISPs/blocks of IPs, which may be needed to
600 # This allows for 10 connections in an hour with a 10 minute ban if
602 #<connectban threshold="10" duration="10m" ipv4cidr="32" ipv6cidr="128"
603 # A custom ban message may optionally be specified.
604 # 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.">
606 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
607 # Connection throttle module.
608 #<module name="connflood">
610 #-#-#-#-#-#-#-#-#-#-#- CONNTHROTTLE CONFIGURATION -#-#-#-#-#-#-#-#-#-#
611 # period, maxconns - Amount of connections per <period>.
613 # timeout - Time to wait after the throttle was activated
614 # before deactivating it. Be aware that the time
615 # is seconds + timeout.
617 # quitmsg - The message that users get if they attempt to
618 # connect while the throttle is active.
620 # bootwait - Amount of time in seconds to wait before enforcing
621 # the throttling when the server just booted.
623 #<connflood seconds="30" maxconns="3" timeout="30"
624 # quitmsg="Throttled" bootwait="10">
626 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
627 # Custom prefixes: Allows for channel prefixes to be configured.
628 #<module name="customprefix">
630 # name The name of the mode, must be unique from other modes.
631 # letter The letter used for this mode. Required.
632 # prefix The prefix used for nicks with this mode. Not required.
633 # rank A numeric rank for this prefix, defining what permissions it gives.
634 # The rank of voice, halfop and op is 10000, 20000, and 30000,
636 # ranktoset The numeric rank required to set this mode. Defaults to rank.
637 # ranktounset The numeric rank required to unset this mode. Defaults to ranktoset.
638 # depriv Can you remove the mode from yourself? Defaults to yes.
639 #<customprefix name="founder" letter="q" prefix="~" rank="50000" ranktoset="50000">
640 #<customprefix name="admin" letter="a" prefix="&" rank="40000" ranktoset="50000">
641 #<customprefix name="halfop" letter="h" prefix="%" rank="20000" ranktoset="30000">
643 # You can also override the configuration of prefix modes added by both the core
644 # and other modules by adding a customprefix tag with change="yes" specified.
645 # <customprefix name="op" change="yes" rank="30000" ranktoset="30000">
646 # <customprefix name="voice" change="yes" rank="10000" ranktoset="10000" depriv="no">
648 # Do /RELOADMODULE customprefix after changing the settings of this module.
650 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
651 # Custom title module: Adds the /TITLE command which allows for trusted
652 # users to gain a custom whois line and an optional vhost can be
654 #<module name="customtitle">
656 #-#-#-#-#-#-#-#-#-#- CUSTOM TITLE CONFIGURATION -#-#-#-#-#-#-#-#-#-#
657 # name - The username used to identify.
658 # password - The password used to identify.
659 # hash - The hash for the specific user's password (optional).
660 # password_hash and a hashing module must be loaded
662 # host - Allowed hostmask (optional).
663 # title - Title shown in whois.
664 # vhost - Displayed host (optional).
666 #<title name="foo" password="bar" title="Official Chat Helper">
667 #<title name="bar" password="foo" host="ident@test.org" title="Official Chat Helper" vhost="helper.test.org">
668 #<title name="foo" password="$2a$10$UYZ4OcO8NNTCCGyCdY9SK.2GHiqGgxZfHFPOPmWuxEVWVQTtoDC7C" hash="bcrypt" title="Official Chat Helper">
670 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
671 # DCCALLOW module: Adds the /DCCALLOW command.
672 #<module name="dccallow">
674 #-#-#-#-#-#-#-#-#-#-#- DCCALLOW CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
675 # blockchat - Whether to block DCC CHAT as well as DCC SEND.
676 # length - Default duration of entries in DCCALLOW list.
677 # action - Default action to take if no action is
678 # specified, can be 'block' or 'allow'.
679 # maxentries - Max number of nicks to allow on a DCCALLOW list.
681 # File configuration:
682 # pattern - The glob pattern to match against.
683 # action - Action to take if a user attempts to send a file
684 # that matches this pattern, can be 'block' or
687 #<dccallow blockchat="yes" length="5m" action="block" maxentries="20">
688 #<banfile pattern="*.exe" action="block">
689 #<banfile pattern="*.txt" action="allow">
691 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
692 # Deaf module: Adds support for the usermode +d - deaf to channel
693 # messages and channel notices.
694 #<module name="deaf">
696 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
697 # Delay join module: Adds the channel mode +D which delays all JOIN
698 # messages from users until they speak. If they quit or part before
699 # speaking, their quit or part message will not be shown to the channel
700 # which helps cut down noise on large channels in a more friendly way
701 # than the auditorium mode. Only channel ops may set the +D mode.
702 #<module name="delayjoin">
704 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
705 # Delay message module: Adds the channel mode +d which disallows a user
706 # from talking in the channel unless they've been joined for X seconds.
707 # Settable using /MODE #chan +d 30
708 #<module name="delaymsg">
709 # Set allownotice to no to disallow NOTICEs too. Defaults to yes.
710 #<delaymsg allownotice="no">
712 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
713 # Deny channels module: Deny channels from being used by users.
714 #<module name="denychans">
716 #-#-#-#-#-#-#-#-#-#-#- DENYCHAN DEFINITIONS -#-#-#-#-#-#-#-#-#-#-#-#
718 # If you have the denychans module loaded, you need to specify the #
719 # channels to deny: #
721 # name - The channel name to deny (glob masks are ok). #
722 # allowopers - If operators are allowed to override the deny. #
723 # reason - Reason given for the deny. #
724 # redirect - Redirect the user to a different channel. #
726 #<badchan name="#gods*" allowopers="yes" reason="Tortoises!"> #
727 #<badchan name="#chan1" redirect="#chan2" reason="Chan1 is closed"> #
729 # Redirects will not work if the target channel is set +L. #
731 # Additionally, you may specify channels which are allowed, even if #
732 # a badchan tag specifies it would be denied: #
733 #<goodchan name="#funtimes"> #
734 # Glob masks are accepted here also. #
736 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
737 # DNS blacklist module: Provides support for looking up IPs on one or #
739 #<module name="dnsbl"> #
741 # For configuration options please see the wiki page for dnsbl at #
742 # https://wiki.inspircd.org/Modules/3.0/dnsbl #
744 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
745 # Exempt channel operators module: Provides support for allowing #
746 # channel operators to be exempt from some channel modes. Supported #
747 # modes are blockcaps, noctcp, blockcolor, nickflood, flood, censor, #
748 # filter, regmoderated, nonick, nonotice, and stripcolor. #
749 #<module name="exemptchanops"> #
751 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
752 # Filter module: Provides message filtering, similar to SPAMFILTER. #
753 #<module name="filter">
755 # This module depends upon a regex provider such as regex_pcre or #
756 # regex_glob to function. You must specify which of these you want #
757 # the filter module to use via the tag below. #
759 # Valid engines are: #
761 # glob - Glob patterns, provided via regex_glob. #
762 # pcre - PCRE regexps, provided via regex_pcre, needs libpcre. #
763 # tre - TRE regexps, provided via regex_tre, requires libtre. #
764 # posix - POSIX regexps, provided via regex_posix, not available #
765 # on Windows, no dependencies on other operating systems. #
766 # stdlib - stdlib regexps, provided via regex_stdlib, see comment #
767 # at the <module> tag for info on availability. #
769 #<filteropts engine="glob"> #
771 # Your choice of regex engine must match on all servers network-wide.
773 # To learn more about the configuration of this module, read #
774 # examples/filter.conf.example, which covers the various types of #
775 # filters and shows how to add exemptions. #
777 #-#-#-#-#-#-#-#-#-#-#- FILTER CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#
779 # Optional - If you specify to use the filter module, then #
780 # specify below the path to the filter.conf file, or define some #
783 #<include file="examples/filter.conf.example">
785 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
786 # Flash Policy Daemon module: Allows Flash IRC clients (e.g. LightIRC)#
787 # to connect. If no file is specified, it'll serve a default policy #
788 # allowing all IPs to connect to all plaintext IRC ports #
789 #<bind address="" port="8430" type="flashpolicyd"> #
790 #<flashpolicyd timeout="5" file=""> #
791 #<module name="flashpolicyd"> #
793 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
794 # Gecos ban: Implements extended ban 'r', which stops anyone matching
795 # a mask like +b r:*realname?here* from joining a channel.
796 #<module name="gecosban">
798 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
799 # GeoIP module: Allows the server admin to match users by country code.
800 # This module is in extras. Re-run configure with:
801 # ./configure --enable-extras=m_geoip.cpp
802 # and run make install, then uncomment this module to enable it.
803 # This module requires GeoIP to be installed on your system,
804 # use your package manager to find the appropriate packages
805 # or check the InspIRCd wiki page for this module.
806 #<module name="geoip">
808 # The actual allow/ban actions are done by connect classes, not by the
809 # GeoIP module. An example connect class to ban people from russia or
812 # <connect deny="*" geoip="TR,RU">
814 # The country code must be in capitals and should be an ISO country
815 # code such as TR, GB, or US. Unknown IPs (localhost, LAN IPs, etc)
816 # will be assigned the country code "UNK". Since connect classes are
817 # matched from top down, your deny classes must be above your allow
818 # classes for them to match.
820 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
821 # Globops module: Provides the /GLOBOPS command and snomask +g.
822 # This module is oper-only.
823 # To use, GLOBOPS must be in one of your oper class blocks.
824 #<module name="globops">
826 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
827 # Global load module: Allows loading and unloading of modules network-
828 # wide (USE WITH EXTREME CAUTION!)
829 # This module is oper-only and provides /GLOADMODULE, /GUNLOADMODULE
830 # and /GRELOADMODULE.
831 # To use, GLOADMODULE, GUNLOADMODULE and GRELOADMODULE
832 # must be in one of your oper class blocks.
833 #<module name="globalload">
835 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
836 # HELPOP module: Provides the /HELPOP command
837 #<module name="helpop">
839 #-#-#-#-#-#-#-#-#-#-#-#- HELPOP CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
841 # If you specify to use the helpop module, then specify below the #
842 # path to the helpop.conf file. #
844 #<include file="examples/inspircd.helpop-full.example">
846 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
847 # Hide chans module: Allows users to hide their channels list from non-
848 # opers by setting user mode +I on themselves.
849 #<module name="hidechans">
851 # This mode can optionally prevent opers from seeing channels on a +I
852 # user, for more privacy if set to true.
853 # This setting is not recommended for most mainstream networks.
854 #<hidechans affectsopers="false">
856 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
857 # Hide list module: Allows for hiding the list of listmodes from users
858 # who do not have sufficient channel rank.
859 #<module name="hidelist">
861 # Each <hidelist> tag configures one listmode to hide.
862 # mode: Name of the listmode to hide.
863 # rank: Minimum rank required to view the list. If set to 0, all
864 # members of the channel may view the list, but non-members may not.
865 # The rank of the built-in op and voice mode is 30000 and 10000,
866 # respectively; the rank of other prefix modes is configurable.
869 # Hiding the ban list is not recommended because it may break some
872 # Hide filter (+g) list:
873 #<hidelist mode="filter" rank="30000">
874 # Only show invite exceptions (+I) to channel members:
875 #<hidelist mode="invex" rank="0">
877 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
878 # Hide oper module: Allows opers to hide their oper status from non-
879 # opers by setting user mode +H on themselves.
880 # This module is oper-only.
881 #<module name="hideoper">
883 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
884 # Hostchange module: Allows a different style of cloaking.
885 #<module name="hostchange">
887 #-#-#-#-#-#-#-#-#-#-#- HOSTCHANGE CONFIGURATION -#-#-#-#-#-#-#-#-#-#
889 # See https://wiki.inspircd.org/Modules/3.0/hostchange for help. #
891 #<host suffix="invalid.org" separator="." prefix="">
892 #<hostchange mask="*@42.theanswer.example.org" action="addnick">
893 #<hostchange mask="*root@*" action="suffix">
894 #<hostchange mask="a@example.com" action="set" value="foo.bar.baz">
895 #<hostchange mask="localhost" ports="7000,7001,7005-7007" action="set" value="blahblah.foo">
897 # hostcycle: If loaded, when a user gets a host or ident set, it will
898 # cycle them in all their channels. If not loaded it will simply change
899 # their host/ident without cycling them.
900 # This module is compatible with the ircv3_chghost module. Clients
901 # supporting the chghost extension will get the chghost message instead
902 # of seeing a host cycle.
903 #<module name="hostcycle">
905 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
906 # httpd module: Provides HTTP server support for InspIRCd.
907 #<module name="httpd">
909 #-#-#-#-#-#-#-#-#-#-#-#- HTTPD CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
911 # If you choose to use the httpd module, then you will need to add
912 # a <bind> tag with type "httpd", and load at least one of the other
913 # httpd_* modules to provide pages to display.
915 # You can adjust the timeout for HTTP connections below. All HTTP
916 # connections will be closed after (roughly) this time period.
917 #<httpd timeout="20">
919 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
920 # HTTP ACL module: Provides access control lists for httpd dependent
921 # modules. Use this module to restrict pages by IP address and by
923 #<module name="httpd_acl">
925 #-#-#-#-#-#-#-#-#-#-#-#- HTTPD ACL CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
927 # Restrict access to the httpd_stats module to all but the local
928 # network and when the correct password is specified:
929 # <httpdacl path="/stats*" types="password,whitelist"
930 # username="secrets" password="mypasshere" whitelist="127.0.0.*,10.*">
932 # Deny all connections to all but the main index page:
933 # <httpdacl path="/*" types="blacklist" blacklist="*">
935 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
936 # HTTP config module: Allows the configuration of the server to be
937 # viewed over HTTP. Requires httpd to be loaded for it to function.
938 #<module name="httpd_config">
940 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
941 # HTTP stats module: Provides basic stats pages over HTTP.
942 # Requires httpd to be loaded for it to function.
943 #<module name="httpd_stats">
945 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
946 # Ident: Provides RFC 1413 ident lookup support.
947 # When this module is loaded <connect:allow> tags may have an optional
948 # useident="yes|no" boolean value, determining whether or not to lookup
949 # ident on users matching that connect tag.
950 #<module name="ident">
952 #-#-#-#-#-#-#-#-#-#-#-#- IDENT CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
954 # Optional - If you are using the ident module, then you can specify #
955 # the timeout for ident lookups here. If not defined, it will default #
956 # to 5 seconds. This is a non-blocking timeout which holds the user #
957 # in a 'connecting' state until the lookup is complete. #
958 # The bind value indicates which IP to bind outbound requests to. #
959 # nolookupprefix: If on, the idents of users being in a connect class #
960 # with ident lookups disabled (i.e. <connect useident="off">) will be #
961 # prefixed with a "~". If off, the ident of those users will not be #
962 # prefixed. Default is off. #
964 #<ident timeout="5" nolookupprefix="no">
966 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
967 # Invite exception module: Adds support for channel invite exceptions
969 #<module name="inviteexception">
970 # bypasskey: If this is enabled, exceptions will bypass +k as well as +i
971 #<inviteexception bypasskey="yes">
973 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
974 # IRCv3 module: Provides the following IRCv3 extensions:
975 # extended-join, away-notify and account-notify. These are optional
976 # enhancements to the client-to-server protocol. An extension is only
977 # active for a client when the client specifically requests it, so this
978 # module needs the cap module to work.
980 # Further information on these extensions can be found at the IRCv3
981 # working group website:
982 # http://ircv3.net/irc/
984 #<module name="ircv3">
985 # The following block can be used to control which extensions are
986 # enabled. Note that extended-join can be incompatible with delayjoin
988 #<ircv3 accountnotify="on" awaynotify="on" extendedjoin="on">
990 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
991 # IRCv3 cap-notify module: Provides the cap-notify IRCv3.2 extension.
992 # Required for IRCv3.2 conformance.
993 #<module name="ircv3_capnotify">
995 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
996 # IRCv3 chghost module: Provides the chghost IRCv3.2 extension which
997 # allows capable clients to learn when the host/ident of another user
998 # changes without cycling the user. This module is compatible with the
999 # hostcycle module. If both are loaded, clients supporting the chghost
1000 # extension will get the chghost message and won't see host cycling.
1001 #<module name="ircv3_chghost">
1003 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1004 # IRCv3 echo-message module: Provides the echo-message IRCv3.2
1005 # extension which allows capable clients to get an acknowledgement when
1006 # their messages are delivered and learn what modifications, if any,
1007 # were applied to them.
1008 #<module name="ircv3_echomessage">
1010 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1011 # IRCv3 invite-notify module: Provides the invite-notify IRCv3.2
1012 # extension which notifies supporting clients when a user invites
1013 # another user into a channel. This respects <options:announceinvites>.
1014 #<module name="ircv3_invitenotify">
1016 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1017 # IRCv3 Strict Transport Security module: Provides the sts IRCv3.2
1018 # extension which allows clients connecting insecurely to upgrade their
1019 # connections to TLS.
1020 #<module name="ircv3_sts">
1022 # If using the ircv3_sts module you MUST define a STS policy to send
1023 # to clients using the <sts> tag. This tag takes the following
1026 # host - A glob match for the SNI hostname to apply this policy to.
1027 # duration - The amount of time that the policy lasts for. Defaults to
1028 # approximately two months by default.
1029 # port - The port on which TLS connections to the server are being
1030 # accepted. You MUST have a CA-verified certificate on this
1031 # port. Self signed certificates are not acceptable.
1032 # preload - Whether client developers can include your certificate in
1035 # <sts host="*.example.com" duration="60d" port="6697" preload="yes">
1037 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1038 # Join flood module: Adds support for join flood protection +j X:Y.
1039 # Closes the channel for N seconds if X users join in Y seconds.
1040 #<module name="joinflood">
1042 # The number of seconds to close the channel for:
1043 #<joinflood duration="1m">
1045 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1046 # Jump server module: Adds support for the RPL_REDIR numeric.
1047 # This module is oper-only.
1048 # To use, JUMPSERVER must be in one of your oper class blocks.
1049 # If your server is redirecting new clients and you get disconnected,
1050 # do a REHASH from shell to open up again.
1051 #<module name="jumpserver">
1053 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1054 # Anti auto rejoin: Adds support for prevention of auto-rejoin (+J).
1055 #<module name="kicknorejoin">
1057 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1058 # Knock module: Adds the /KNOCK command and channel mode +K.
1059 #<module name="knock">
1061 # This setting specifies what to do when someone successfully /KNOCKs.
1062 # If set to "notice", then a NOTICE will be sent to the channel.
1063 # This is the default and the compatible setting, as it requires no
1064 # special support from the clients.
1065 # If set to "numeric" then a 710 numeric will be sent to the channel.
1066 # This allows easier scripting but not all clients support it.
1067 # If set to "both" then (surprise!) both will be sent.
1068 #<knock notify="notice">
1070 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1071 # LDAP module: Allows other SQL modules to access a LDAP database
1072 # through a unified API.
1073 # This modules is in extras. Re-run configure with:
1074 # ./configure --enable-extras=m_ldap.cpp
1075 # and run make install, then uncomment this module to enable it.
1077 #<module name="ldap">
1078 #<database module="ldap" id="ldapdb" server="ldap://localhost" binddn="cn=Manager,dc=inspircd,dc=org" bindauth="mysecretpass" searchscope="subtree">
1079 # The server parameter indicates the LDAP server to connect to. The #
1080 # ldap:// style scheme before the hostname proper is MANDATORY. #
1082 # The binddn and bindauth indicate the DN to bind to for searching, #
1083 # and the password for the distinguished name. Some LDAP servers will #
1084 # allow anonymous searching in which case these two values do not #
1085 # need defining, otherwise they should be set similar to the examples #
1088 # The searchscope value indicates the subtree to search under. On our #
1089 # test system this is 'subtree'. Your mileage may vary. #
1091 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1092 # LDAP authentication module: Adds the ability to authenticate users #
1094 #<module name="ldapauth">
1098 # <ldapauth dbid="ldapdb" #
1099 # baserdn="ou=People,dc=brainbox,dc=cc" #
1101 # allowpattern="Guest* Bot*" #
1102 # killreason="Access denied" #
1104 # host="$uid.$ou.inspircd.org" #
1105 # useusername="no"> #
1107 # <ldapwhitelist cidr="10.42.0.0/16"> #
1109 # <ldaprequire attribute="attr" value="val"> #
1111 # The baserdn indicates the base DN to search in for users. Usually #
1112 # this is 'ou=People,dc=yourdomain,dc=yourtld'. #
1114 # The attribute value indicates the attribute which is used to locate #
1115 # a user account by name. On POSIX systems this is usually 'uid'. #
1117 # The allowpattern value allows you to specify a space separated list #
1118 # of wildcard masks which will always be allowed to connect #
1119 # regardless of if they have an account, for example guest and bot #
1122 # The useusername setting chooses whether the user's username or #
1123 # nickname is used when locating a user account, if a username isn't #
1124 # provided in PASS. #
1126 # Killreason indicates the QUIT reason to give to users if they fail #
1127 # to authenticate. #
1129 # Setting the verbose value causes an oper notice to be sent out for #
1130 # every failed authentication to the server, with an error string. #
1132 # ldapwhitelist indicates that clients connecting from an IP in the #
1133 # provided CIDR do not need to authenticate against LDAP. It can be #
1134 # repeated to whitelist multiple CIDRs. #
1136 # ldaprequire allows further filtering on the LDAP user, by requiring #
1137 # certain LDAP attibutes to have a given value. It can be repeated, #
1138 # in which case the list will act as an OR list, that is, the #
1139 # authentication will succeed if any of the requirements in the list #
1142 # host allows you to change the displayed host of users connecting #
1143 # from ldap. The string supplied takes formatters which are replaced #
1144 # from the DN. For instance, if your DN looks like: #
1145 # uid=w00t,ou=people,dc=inspircd,dc=org, then the formatters uid, ou #
1146 # and dc will be available to you. If a key is given multiple times #
1147 # in the DN, the last appearance will take precedence. #
1149 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1150 # LDAP oper configuration module: Adds the ability to authenticate #
1152 #<module name="ldapoper">
1156 # <ldapoper dbid="ldapdb"
1157 # baserdn="ou=People,dc=brainbox,dc=cc"
1160 # Available configuration items are identical to the same items in #
1161 # ldapauth above (except for the verbose setting, that is only #
1162 # supported in ldapauth). #
1163 # Please always specify a password in your <oper> tags even if the #
1164 # opers are to be authenticated via LDAP, so in case this module is #
1165 # not loaded the oper accounts are still protected by a password. #
1167 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1168 # Lock server module: Adds /LOCKSERV and /UNLOCKSERV commands that #
1169 # are used to temporarily close/open the server for new connections. #
1170 # These commands require that the /LOCKSERV and /UNLOCKSERV commands #
1171 # are specified in a <class> tag that the oper is part of. This is so #
1172 # you can control who has access to this possible dangerous command. #
1173 # If your server is locked and you get disconnected, do a REHASH from #
1174 # shell to open up again. #
1175 # This module is oper-only.
1176 #<module name="lockserv">
1178 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1179 # Map hiding module: replaces /MAP and /LINKS output to users with a #
1180 # message to see a website, set by maphide="http://test.org/map" in #
1181 # the <security> tag, instead. #
1182 #<module name="maphide">
1184 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1185 # Message flood module: Adds message/notice flood protection via
1187 #<module name="messageflood">
1189 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1190 # MLOCK module: Adds support for server-side enforcement of services
1191 # side MLOCKs. Basically, this module suppresses any mode change that
1192 # would likely be immediately bounced by services.
1193 #<module name="mlock">
1195 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1196 # Modenotice module: Adds the /MODENOTICE command that allows opers to
1197 # send notices to all users having the given user mode(s) set.
1198 #<module name="modenotice">
1200 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1201 # Monitor module: Adds support for MONITOR which is used by clients to
1202 # maintain notify lists.
1203 #<module name="monitor">
1205 # Set the maximum number of entries on a user's monitor list below.
1206 #<monitor maxentries="30">
1208 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1209 # MySQL module: Allows other SQL modules to access MySQL databases
1210 # through a unified API.
1211 # This module is in extras. Re-run configure with:
1212 # ./configure --enable-extras=m_mysql.cpp
1213 # and run make install, then uncomment this module to enable it.
1214 #<module name="mysql">
1216 #-#-#-#-#-#-#-#-#-#-#-#- SQL CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#-#
1218 # mysql is more complex than described here, see the wiki for more #
1219 # info: https://wiki.inspircd.org/Modules/3.0/mysql #
1221 #<database module="mysql" name="mydb" user="myuser" pass="mypass" host="localhost" id="my_database2">
1223 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1224 # Named modes module: Allows for the display and set/unset of channel
1225 # modes via long-form mode names via +Z and the /PROP command.
1226 # For example, to set a ban, do /mode #channel +Z ban=foo!bar@baz or
1227 # /PROP #channel ban=foo!bar@baz
1228 #<module name="namedmodes">
1230 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1231 # NAMESX module: Provides support for the NAMESX extension which allows
1232 # clients to see all the prefixes set on a user without getting confused.
1233 # This is supported by mIRC, x-chat, klient, and maybe more.
1234 #<module name="namesx">
1236 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1237 # National characters module:
1238 # 1) Allows using national characters in nicknames.
1239 # 2) Allows using custom (national) casemapping over the network.
1240 #<module name="nationalchars">
1242 # file - Location of the file which contains casemapping rules. If this
1243 # is a relative path then it is relative to "<PWD>/../locales"
1244 # on UNIX and "<PWD>/locales" on Windows.
1245 # casemapping - The name of the casemapping sent to clients in the 005
1246 # numeric. If this is not set then it defaults to the name
1247 # of the casemapping file unless the file name contains a
1248 # space in which case you will have to specify it manually.
1249 #<nationalchars file="bynets/russian-w1251-charlink" casemapping="ru_RU.cp1251-charlink">
1251 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1252 # Nickchange flood protection module: Provides channel mode +F X:Y
1253 # which allows up to X nick changes in Y seconds.
1254 #<module name="nickflood">
1256 # The number of seconds to prevent nick changes for:
1257 #<nickflood duration="1m">
1259 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1260 # Nicklock module: Let opers change a user's nick and then stop that
1261 # user from changing their nick again until unlocked.
1262 # This module is oper-only.
1263 # To use, NICKLOCK and NICKUNLOCK must be in one of your oper class blocks.
1264 #<module name="nicklock">
1266 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1267 # No CTCP module: Adds the channel mode +C to block CTCPs and extban
1268 # 'C' to block CTCPs sent by specific users.
1269 #<module name="noctcp">
1271 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1272 # No kicks module: Adds the +Q channel mode and the Q: extban to deny
1273 # certain users from kicking.
1274 #<module name="nokicks">
1276 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1277 # No nicks module: Adds the +N channel mode, as well as the 'N' extban.
1278 # +N stops all users from changing their nick, the N extban stops
1279 # anyone from matching a +b N:nick!user@host mask from changing their
1281 #<module name="nonicks">
1283 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1284 # No part message module: Adds extban 'p' to block part messages from #
1286 #<module name="nopartmsg">
1288 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1289 # No notice module: Adds the channel mode +T and the extban 'T' to
1290 # block specific users from noticing the channel.
1291 #<module name="nonotice">
1293 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1294 # Network business join module:
1295 # Allows an oper to join a channel using /OJOIN, giving them +Y on the
1296 # channel which makes them immune to kick/deop/etc.
1297 #<module name="ojoin">
1299 # Specify the prefix that +Y will grant here.
1300 # Leave 'prefix' empty if you do not wish +Y to grant a prefix.
1301 # If 'notice' is set to on, upon /OJOIN, the server will notice the
1302 # channel saying that the oper is joining on network business.
1303 # If 'op' is set to on, it will give them +o along with +Y.
1304 #<ojoin prefix="!" notice="yes" op="yes">
1306 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1307 # Oper channels mode: Adds the +O channel mode and extban O:<mask>
1308 # to ban, except, etc. specific oper types. For example
1309 # /mode #channel +iI O:* is equivalent to channel mode +O, but you
1310 # may also set +iI O:AdminTypeOnly to only allow admins.
1311 # Modes +I and +e work in a similar fashion.
1312 #<module name="operchans">
1314 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1315 # Oper join module: Auto-joins opers to a channel upon oper-up.
1316 # This module is oper-only. For the user equivalent, see the conn_join
1318 #<module name="operjoin">
1320 #-#-#-#-#-#-#-#-#-#-# OPERJOIN CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
1322 # If you are using the operjoin module, specify options here: #
1324 # channel - The channel name to join, can also be a comma #
1325 # separated list e.g. "#channel1,#channel2". #
1327 # override - If on, lets the oper join walking thru any modes #
1328 # that might be set, even bans. #
1330 #<operjoin channel="#channel" override="no">
1332 # Alternatively you can use the autojoin="channellist" in a <type> #
1333 # tag to set specific autojoins for a type of oper, for example: #
1335 #<type name="Helper" autojoin="#help" classes="...">
1337 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1338 # Oper log module: Logs all oper commands to the server log (with log
1339 # type "m_operlog" at default loglevel), and optionally to the 'r'
1341 # This module is oper-only.
1342 #<module name="operlog">
1344 # If the following option is on then all oper commands will be sent to
1345 # the snomask 'r'. The default is off.
1346 #<operlog tosnomask="off">
1348 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1349 # Oper prefixing module: Adds a channel prefix mode +y which is given
1350 # to all IRC operators automatically on all channels they are in.
1351 # This prefix mode is more powerful than channel op and other regular
1354 # Load this module if you want all your IRC operators to have channel
1356 #<module name="operprefix">
1358 # You may additionally customise the prefix character.
1359 #<operprefix prefix="!">
1361 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1362 # Oper MOTD module: Provides support for separate message of the day
1364 # This module is oper-only.
1365 #<module name="opermotd">
1367 #-#-#-#-#-#-#-#-#-#-# OPERMOTD CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
1369 # If you are using the opermotd module, specify the motd here. #
1371 # onoper - If on, the message is sent on /OPER, otherwise it's #
1372 # only sent when /OPERMOTD is used. #
1374 # processcolors - Allow color codes to be processed in the opermotd. #
1375 # Read the comment above <connect:allowmotdcolors> in #
1376 # inspircd.conf.example for details. #
1378 #<opermotd file="examples/opermotd.txt.example" onoper="yes" processcolors="false">
1380 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1381 # Override module: Adds support for oper override.
1382 # This module is oper-only.
1383 #<module name="override">
1385 #-#-#-#-#-#-#-#-#-#-# OVERRIDE CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
1387 # override is too complex it describe here, see the wiki: #
1388 # http://wiki.inspircd.org/Modules/override #
1390 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1391 # Oper levels module: Gives each oper a level and prevents actions
1392 # being taken by lower level opers against higher level opers.
1393 # Specify the level as the 'level' parameter of the <type> tag.
1394 # This module is oper-only.
1395 #<module name="operlevels">
1397 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1398 # Oper modes module: Allows you to specify modes to add/remove on oper.
1399 # Specify the modes as the 'modes' parameter of the <type> tag
1400 # and/or as the 'modes' parameter of the <oper> tag.
1401 # This module is oper-only. For the user equivalent, see the
1402 # conn_umodes module.
1403 #<module name="opermodes">
1405 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1406 # Password forwarding module: Forwards a password users can send on
1407 # connect to the specified client below. The client is usually NickServ
1408 # and this module is usually used to authenticate users with NickServ
1409 # using their connect password.
1410 #<module name="passforward">
1413 # nick: nick to forward connect passwords to.
1416 # forwardmsg: Message to send to users using a connect password.
1417 # $nick will be the users' nick, $nickrequired will be the nick
1418 # of where the password is going (the nick above).
1419 # You can also use $user for the user ident string.
1420 forwardmsg="NOTICE $nick :*** Forwarding PASS to $nickrequired"
1422 # cmd: Command for the user to run when it receives a connect
1424 cmd="PRIVMSG $nickrequired :IDENTIFY $pass">
1426 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1427 # Password hash module: Allows hashed passwords to be used.
1428 # To be useful, a hashing module like bcrypt also needs to be loaded.
1429 #<module name="password_hash">
1431 #-#-#-#-#-#-#-#-#-# PASSWORD HASH CONFIGURATION #-#-#-#-#-#-#-#-#-#-#-#
1433 # To use this module, you must define a hash type for each oper's
1434 # password you want to hash. For example:
1436 # <oper name="Brain"
1437 # host="ident@dialup15.isp.test.com"
1439 # password="$2a$10$Mss9AtHHslZTLBrXqM0FB.JBwD.UTSu8A48SfrY9exrpxbsRiRTbO"
1442 # If you are using a hash algorithm which does not perform salting you can use
1443 # HMAC to salt your passwords in order to prevent them from being looked up in
1446 # hash="hmac-sha256" password="lkS1Nbtp$CyLd/WPQXizsbxFUTqFRoMvaC+zhOULEeZaQkUJj+Gg"
1448 # Generate hashes using the /MKPASSWD command on the server.
1449 # Don't run it on a server you don't trust with your password.
1451 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1452 # PBKDF2 module: Allows other modules to generate PBKDF2 hashes,
1453 # usually for cryptographic uses and security.
1454 # This module relies on other hash providers (e.g. SHA256).
1455 #<module name="pbkdf2">
1457 # iterations: Iterations the hashing function runs when generating new
1459 # length: Length in bytes of the derived key.
1460 #<pbkdf2 iterations="12288" length="32">
1461 # You can override these values with specific values
1462 # for specific providers if you want to. Example given for SHA256.
1463 #<pbkdf2prov hash="sha256" iterations="24576">
1465 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1466 # Permanent channels module: Channels with the permanent channel mode
1467 # will remain open even after everyone else has left the channel, and
1468 # therefore keep things like modes, ban lists and topic. Permanent
1469 # channels -may- need support from your Services package to function
1470 # properly with them. This adds channel mode +P.
1471 # This module is oper-only.
1472 #<module name="permchannels">
1474 # If you like, this module can write a config file of permanent channels
1475 # whenever +P is set, unset, or the topic/modes on a +P channel is changed.
1476 # If you want to do this, set the filename below, and uncomment the include.
1478 # If 'listmodes' is true then all list modes (+b, +I, +e, +g...) will be
1479 # saved. Defaults to false.
1480 #<permchanneldb filename="permchannels.conf" listmodes="true">
1481 #<include file="permchannels.conf">
1483 # You may also create channels on startup by using the <permchannels> block.
1484 #<permchannels channel="#opers" modes="isP" topic="Opers only.">
1486 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1487 # PostgreSQL module: Allows other SQL modules to access PgSQL databases
1488 # through a unified API.
1489 # This module is in extras. Re-run configure with:
1490 # ./configure --enable-extras=m_pgsql.cpp
1491 # and run make install, then uncomment this module to enable it.
1492 #<module name="pgsql">
1494 #-#-#-#-#-#-#-#-#-#-#-#- SQL CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#-#
1496 # pgsql is more complex than described here, see the wiki for #
1497 # more: https://wiki.inspircd.org/Modules/3.0/pgsql #
1499 #<database module="pgsql" name="mydb" user="myuser" pass="mypass" host="localhost" id="my_database" ssl="no">
1501 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1502 # Muteban: Implements extended ban 'm', which stops anyone matching
1503 # a mask like +b m:nick!user@host from speaking on channel.
1504 #<module name="muteban">
1506 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1507 # Random quote module: Provides a random quote on connect.
1508 # NOTE: Some of these may mimic fatal errors and confuse users and
1509 # opers alike - BEWARE!
1510 #<module name="randquote">
1512 #-#-#-#-#-#-#-#-#-#- RANDOMQUOTES CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
1514 # Optional - If you specify to use the randquote module, then specify #
1515 # below the path to the quotes file. #
1517 #<randquote file="quotes.txt">
1519 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1520 # Redirect module: Adds channel mode +L which redirects users to #
1521 # another channel when the channel has reached its user limit and #
1522 # user mode +L which stops redirection. #
1523 #<module name="redirect">
1525 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1526 # Regular expression provider for glob or wildcard (?/*) matching.
1527 # You must have at least 1 provider loaded to use the filter or rline
1528 # modules. This module has no additional requirements, as it uses the
1529 # matching already present in InspIRCd core.
1530 #<module name="regex_glob">
1532 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1533 # Regular expression provider for PCRE (Perl-Compatible Regular
1534 # Expressions). You need libpcre installed to compile and load this
1535 # module. You must have at least 1 provider loaded to use the filter or
1537 #<module name="regex_pcre">
1539 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1540 # Regular Expression Provider for RE2 Regular Expressions.
1541 # You need libre2 installed and in your include/library paths in order
1542 # to compile and load this module.
1543 #<module name="regex_re2">
1545 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1546 # Regular expression provider for POSIX regular expressions.
1547 # You shouldn't need any additional libraries on a POSIX-compatible
1548 # system (i.e.: any Linux, BSD, but not Windows). You must have at
1549 # least 1 provider loaded to use filter or rline.
1550 # On POSIX-compliant systems, regex syntax can be found by using the
1551 # command: 'man 7 regex'.
1552 #<module name="regex_posix">
1554 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1555 # Regular expression provider for C++11 std::regex regular expressions.
1556 # This module works on any fully compliant implementation of the C++11
1557 # std::regex container. Examples for such are Visual C++ 2010 and newer
1558 # but not libstdc++ (which GCC uses).
1559 # You should verify that std::regex is supported by your setup before
1560 # using this module, as it may compile normally but won't do anything
1561 # on some implementations.
1562 #<module name="regex_stdlib">
1564 # Specify the regular expression engine to use here. Valid settings are
1565 # bre, ere, awk, grep, egrep, ecmascript (default if not specified).
1566 #<stdregex type="ecmascript">
1568 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1569 # Regular expression provider for TRE regular expressions.
1570 # This is the same regular expression engine used by UnrealIRCd, so
1571 # if you are most familiar with the syntax of /SPAMFILTER from there,
1572 # this is the provider you want. You need libtre installed in order
1573 # to compile and load this module.
1574 #<module name="regex_tre">
1576 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1577 # Registered users only channel creation module. If enabled, only
1578 # registered users and opers can create new channels.
1580 # You probably *DO NOT* want to load this module on a public network.
1582 #<module name="regonlycreate">
1584 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1585 # Remove module: Adds the /REMOVE command which is a peaceful
1586 # alternative to /KICK.
1587 #<module name="remove">
1589 # supportnokicks: If true, /REMOVE is not allowed on channels where the
1590 # nokicks (+Q) mode is set. Defaults to false.
1591 # protectedrank: Members having this rank or above may not be /REMOVE'd
1592 # by anyone. Set to 0 to disable this feature. Defaults to 50000.
1593 #<remove supportnokicks="true" protectedrank="50000">
1595 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1596 # A module to block, kick or ban upon similar messages being uttered several times.
1597 # Syntax [~*][lines]:[sec]{[:difference]}{[:matchlines]}
1598 # ~ is to block, * is to ban, default is kick.
1599 # 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
1600 # seconds - How old the message has to be before it's invalidated.
1601 # distance - Edit distance, in percent, between two strings to trigger on.
1602 # matchlines - When set, the function goes into mode 2. In this mode the function will trigger if this many of the last <lines> matches.
1604 # As this module can be rather CPU-intensive, it comes with some options.
1605 # maxbacklog - Maximum size that can be specified for backlog. 0 disables multiline matching.
1606 # maxdistance - Max percentage of difference between two lines we'll allow to match. Set to 0 to disable edit-distance matching.
1607 # maxlines - Max lines of backlog to match against.
1608 # maxtime - Maximum period of time a user can set. 0 to allow any.
1609 # size - Maximum number of characters to check for, can be used to truncate messages
1610 # before they are checked, resulting in less CPU usage. Increasing this beyond 512
1611 # doesn't have any effect, as the maximum length of a message on IRC cannot exceed that.
1612 #<repeat maxbacklog="20" maxlines="20" maxdistance="50" maxtime="0" size="512">
1613 #<module name="repeat">
1615 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1616 # Restricted channels module: Allows only opers to create channels.
1618 # You probably *DO NOT* want to load this module on a public network.
1620 #<module name="restrictchans">
1622 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1623 # Restrict message module: Allows users to only message opers.
1625 # You probably *DO NOT* want to load this module on a public network.
1627 #<module name="restrictmsg">
1629 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1630 # R-Line module: Ban users through regular expression patterns.
1631 #<module name="rline">
1633 #-#-#-#-#-#-#-#-#-#-#-#- RLINE CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#-#
1635 # If you wish to re-check a user when they change nickname (can be
1636 # useful under some situations, but *can* also use CPU with more users
1637 # on a server) then set 'matchonnickchange' to yes.
1638 # Also, this is where you set what Regular Expression engine is to be
1639 # used. If you ever change it while running, all of your R-Lines will
1640 # be wiped. This is the regex engine used by all R-Lines set, and
1641 # regex_<engine> must be loaded, or rline will be non-functional
1642 # until you load it or change the engine to one that is loaded.
1644 #<rline matchonnickchange="yes" engine="pcre">
1646 # Generally, you will NOT want to use 'glob' here, as this turns
1647 # rline into just another gline. The exceptions are that rline will
1648 # always use the full "nick!user@host realname" string, rather than only
1649 # user@host, but beware that only the ? and * wildcards are available,
1650 # and are the only way to specify where the space can occur if you do
1651 # use glob. For this reason, is recommended to use a real regex engine
1652 # so that at least \s or [[:space:]] is available.
1654 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1655 # RMODE module: Adds the /RMODE command
1656 # Allows channel mods to remove list modes en masse.
1657 # Syntax: /rmode <channel> <mode> [pattern]
1658 # E.g. '/rmode #Channel b m:*' will remove all mute-extbans on the channel.
1659 #<module name="rmode">
1661 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1662 # SAJOIN module: Adds the /SAJOIN command which forcibly joins a user
1663 # to the given channel.
1664 # This module is oper-only.
1665 # To use, SAJOIN must be in one of your oper class blocks.
1666 # Opers need the users/sajoin-others priv to be able to /SAJOIN users
1667 # other than themselves.
1668 #<module name="sajoin">
1670 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1671 # SAKICK module: Adds the /SAKICK command which kicks a user from the
1673 # This module is oper-only.
1674 # To use, SAKICK must be in one of your oper class blocks.
1675 #<module name="sakick">
1677 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1678 # SAMODE module: Adds the /SAMODE command which allows server operators
1679 # to change modes on a channel without requiring them to have any
1680 # channel priviliges. Also allows changing user modes for any user.
1681 # This module is oper-only.
1682 # To use, SAMODE must be in one of your oper class blocks.
1683 #<module name="samode">
1685 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1686 # SANICK module: Adds the /SANICK command which allows opers to change
1688 # This module is oper-only.
1689 # To use, SANICK must be in one of your oper class blocks.
1690 #<module name="sanick">
1692 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1693 # SAPART module: Adds the /SAPART command which forcibly parts a user
1695 # This module is oper-only.
1696 # To use, SAPART must be in one of your oper class blocks.
1697 #<module name="sapart">
1699 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1700 # SAQUIT module: Adds the /SAQUIT command which forcibly quits a user.
1701 # This module is oper-only.
1702 # To use, SAQUIT must be in one of your oper class blocks.
1703 #<module name="saquit">
1705 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1706 # SATOPIC module: Adds the /SATOPIC command which allows changing the
1707 # topic on a channel without requiring any channel priviliges.
1708 # This module is oper-only.
1709 # To use, SATOPIC must be in one of your oper class blocks.
1710 #<module name="satopic">
1712 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1713 # SASL authentication module: Provides support for IRC Authentication
1714 # Layer via AUTHENTICATE. Note: You also need to have cap loaded
1716 #<module name="sasl">
1717 # Define the following to your services server name to improve security
1718 # by ensuring the SASL messages are only sent to the services server
1719 # and not to all connected servers. This prevents a rogue server from
1720 # capturing SASL messages and disables the SASL cap when services is
1722 #<sasl target="services.mynetwork.com">
1724 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1725 # Secure list module: Prevent /LIST in the first minute of connection,
1726 # crippling most spambots and trojan spreader bots.
1727 #<module name="securelist">
1729 #-#-#-#-#-#-#-#-#-# SECURELIST CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#-#
1731 # Securelist can be harmful to some IRC search engines. To prevent #
1732 # securelist blocking these sites from listing, define exception tags #
1734 #<securehost exception="*@*.netsplit.de">
1735 #<securehost exception="*@*.ircdriven.com">
1736 #<securehost exception="*@*.ircs.me">
1738 # Define the following variable to change how long a user must wait #
1739 # before issuing a LIST. If not defined, defaults to 60 seconds. #
1741 #<securelist waittime="1m"> #
1743 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1744 # Servprotect module: Provides support for Austhex style +k /
1745 # UnrealIRCD +S services mode.
1746 #<module name="servprotect">
1748 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1749 # See nicks module: Adds snomask +n and +N which show local and remote
1751 # This module is oper-only.
1752 #<module name="seenicks">
1754 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1755 # Set idle module: Adds a command for opers to change their idle time.
1756 # This module is oper-only.
1757 # To use, SETIDLE must be in one of your oper class blocks.
1758 #<module name="setidle">
1760 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1761 # Services support module: Adds several usermodes such as +R and +M.
1762 # This module implements the 'identified' state via account names,
1763 # and is similar in operation to the way asuka and ircu handle services.
1765 # At the same time, this offers +r for users and channels to mark them
1766 # as identified separately from the idea of a master account, which
1767 # can be useful for services which are heavily nick-as-account centric.
1769 # Also of note is that this module implements two extbans:
1770 # +b R: (stop matching account names from joining)
1771 # +b U:n!u@h (blocks matching unregistered users)
1773 #<module name="services_account">
1775 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1776 # Sethost module: Adds the /SETHOST command.
1777 # This module is oper-only.
1778 # To use, SETHOST must be in one of your oper class blocks.
1779 # See the chghost module for how to customise valid chars for hostnames.
1780 #<module name="sethost">
1782 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1783 # Setident module: Adds the /SETIDENT command.
1784 # This module is oper-only.
1785 # To use, SETIDENT must be in one of your oper class blocks.
1786 #<module name="setident">
1788 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1789 # SETNAME module: Adds the /SETNAME command.
1790 #<module name="setname">
1792 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1793 # Serverban: Implements extended ban 's', which stops anyone connected
1794 # to a server matching a mask like +b s:server.mask.here from joining.
1795 #<module name="serverban">
1797 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1798 # SHA1 module: Allows other modules to generate SHA1 hashes.
1799 # Required by the WebSocket module.
1800 #<module name="sha1">
1802 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1803 # Showfile: Provides support for showing a text file to users when #
1804 # they enter a command. #
1805 # This module adds one command for each <showfile> tag that shows the #
1806 # given file to the user as a series of messages or numerics. #
1807 #<module name="showfile"> #
1809 #-#-#-#-#-#-#-#-#-#-# SHOWFILE CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#-#
1811 # name - The name of the command which displays this file. This is #
1812 # the only mandatory setting, all others are optional. #
1813 # file - The text file to be shown to the user. #
1814 # By default same as the command name. #
1815 # method - How should the file be shown? #
1816 # * numeric: Send contents using a numeric #
1817 # (similar to /MOTD; the default). #
1818 # * notice: Send contents as a series of notices. #
1819 # * msg: Send contents as a series of private messages. #
1820 # colors - If true, color codes (\c, \b, \u, etc.) will be processed #
1821 # and sent as ANSI colors. If false (default) the file will #
1822 # be displayed as-is. #
1824 # When using the method "numeric", the following extra settings are #
1827 # introtext - Introductory line, "Showing <name>" by default. #
1828 # intronumeric - Numeric used for the introductory line. #
1829 # numeric - Numeric used for sending the text itself. #
1830 # endtext - Ending line, "End of <name>" by default. #
1831 # endnumeric - Numeric used for the ending line. #
1833 #<showfile name="RULES"
1836 # introtext="Server rules:"
1837 # endtext="End of server rules.">
1839 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1840 # Show whois module: Adds the +W usermode which allows opers to see
1841 # when they are /WHOIS'd.
1842 # This module is oper-only by default.
1843 #<module name="showwhois">
1845 # If you wish, you may also let users set this mode. Only opers with the
1846 # users/auspex priv will see real hosts of people, though.
1847 #<showwhois opersonly="yes"
1849 # You may also set whether or not users should receive whois notices,
1850 # should they be /WHOIS'd by an oper.
1851 #showfromopers="yes">
1853 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1854 # Shun module: Provides the /SHUN command, which stops a user from
1855 # executing all except configured commands.
1856 # This module is oper-only.
1857 # To use, SHUN must be in one of your oper class blocks.
1858 #<module name="shun">
1860 # You may also configure which commands you wish a user to be able to
1861 # perform when shunned. It should be noted that if a shunned user
1862 # issues QUIT or PART then their message will be removed, as if they
1863 # did not issue one.
1865 # You can optionally let the user know that their command was blocked.
1867 # You may also let SHUN affect opers (defaults to no).
1868 #<shun enabledcommands="ADMIN PING PONG QUIT PART JOIN" notifyuser="yes" affectopers="no">
1870 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1871 # SSL channel mode module: Adds support for SSL-only channels via
1872 # channel mode +z and the 'z' extban which matches SSL client
1873 # certificate fingerprints.
1874 # Does not do anything useful without a working SSL module and the
1875 # sslinfo module (see below).
1876 #<module name="sslmodes">
1878 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1879 # GnuTLS SSL module: Adds support for SSL connections using GnuTLS,
1880 # if enabled. You must answer 'yes' in ./configure when asked or
1881 # manually symlink the source for this module from the directory
1882 # src/modules/extra, if you want to enable this, or it will not load.
1883 #<module name="ssl_gnutls">
1885 #-#-#-#-#-#-#-#-#-#-#- GNUTLS CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#
1887 # ssl_gnutls is too complex to describe here, see the wiki: #
1888 # https://wiki.inspircd.org/Modules/3.0/ssl_gnutls #
1890 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1891 # SSL info module: Allows users to retrieve information about other
1892 # users' peer SSL certificates and keys. This can be used by client
1893 # scripts to validate users. For this to work, one of ssl_gnutls
1894 # or ssl_openssl must be loaded. This module also adds the
1895 # "* <user> is using a secure connection" whois line, the ability for
1896 # opers to use SSL cert fingerprints to verify their identity and the
1897 # ability to force opers to use SSL connections in order to oper up.
1898 # It is highly recommended to load this module if you use SSL on your
1900 # For how to use the oper features, please see the first example <oper> tag
1901 # in opers.conf.example.
1903 #<module name="sslinfo">
1905 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1906 # mbedTLS SSL module: Adds support for SSL/TLS connections using mbedTLS.
1907 #<module name="ssl_mbedtls">
1909 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1910 # OpenSSL SSL module: Adds support for SSL connections using OpenSSL,
1911 # if enabled. You must answer 'yes' in ./configure when asked or symlink
1912 # the source for this module from the directory src/modules/extra, if
1913 # you want to enable this, or it will not load.
1914 #<module name="ssl_openssl">
1916 #-#-#-#-#-#-#-#-#-#-#- OPENSSL CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#
1918 # ssl_openssl is too complex to describe here, see the wiki: #
1919 # https://wiki.inspircd.org/Modules/3.0/ssl_openssl #
1921 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1922 # Strip color module: Adds channel mode +S that strips color codes and
1923 # all control codes except CTCP from all messages sent to the channel.
1924 #<module name="stripcolor">
1926 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1927 # Silence module: Adds support for the /SILENCE command, which allows
1928 # users to have a server-side ignore list for their client.
1929 #<module name="silence">
1931 # Set the maximum number of entries allowed on a user's silence list.
1932 #<silence maxentries="32"
1934 # Whether messages from U-lined servers will bypass silence masks.
1937 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1938 # SQLite3 module: Allows other SQL modules to access SQLite3 #
1939 # databases through a unified API. #
1940 # This module is in extras. Re-run configure with: #
1941 # ./configure --enable-extras=m_sqlite3.cpp
1942 # and run make install, then uncomment this module to enable it. #
1944 #<module name="sqlite3">
1946 #-#-#-#-#-#-#-#-#-#-#-#- SQL CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#-#
1948 # sqlite is more complex than described here, see the wiki for more #
1949 # info: https://wiki.inspircd.org/Modules/3.0/sqlite3 #
1951 #<database module="sqlite" hostname="/full/path/to/database.db" id="anytext">
1953 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1954 # SQL authentication module: Allows IRCd connections to be tied into
1955 # a database table (for example a forum).
1956 # This module is in extras. Re-run configure with:
1957 # ./configure --enable-extras=m_sqlauth.cpp
1958 # and run make install, then uncomment this module to enable it.
1960 #<module name="sqlauth">
1962 #-#-#-#-#-#-#-#-#-#-#- SQLAUTH CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#
1964 # sqlauth is too complex to describe here, see the wiki: #
1965 # https://wiki.inspircd.org/Modules/3.0/sqlauth #
1967 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1968 # SQL oper module: Allows you to store oper credentials in an SQL table
1969 # This module is in extras. Re-run configure with:
1970 # ./configure --enable-extras=m_sqloper.cpp
1971 # and run make install, then uncomment this module to enable it.
1973 #<module name="sqloper">
1975 #-#-#-#-#-#-#-#-#-#-#- SQLOPER CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#
1977 # dbid - Database ID to use (see SQL modules). #
1978 # hash - Hashing provider to use for password hashing. #
1980 # See also: https://wiki.inspircd.org/Modules/3.0/sqloper #
1982 #<sqloper dbid="1" hash="bcrypt">
1984 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1985 # StartTLS module: Implements STARTTLS, which allows clients #
1986 # connected to non SSL enabled ports to enable SSL, if a proper SSL #
1987 # module is loaded (either ssl_gnutls or ssl_openssl). #
1988 #<module name="starttls">
1990 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1991 # SVSHold module: Implements SVSHOLD. Like Q:Lines, but can only be #
1992 # added/removed by Services. #
1993 #<module name="svshold">
1994 # SVSHOLD does not generate server notices by default, you can turn
1995 # notices on by uncommenting the next line.
1996 #<svshold silent="false">
1998 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1999 # SWHOIS module: Allows you to add arbitrary lines to user WHOIS.
2000 # This module is oper-only.
2001 # To use, SWHOIS must be in one of your oper class blocks.
2002 #<module name="swhois">
2004 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2005 # Timed bans module: Adds timed channel bans with the /TBAN command.
2006 #<module name="timedbans">
2008 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2009 # Test line module: Adds the /TLINE command, used to test how many
2010 # users a /GLINE or /ZLINE etc. would match.
2011 # This module is oper-only.
2012 # To use, TLINE must be in one of your oper class blocks.
2013 #<module name="tline">
2015 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2016 # Topiclock module: implements server-side topic locking to achieve deeper
2017 # integration with services packages.
2018 #<module name="topiclock">
2020 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2021 # UHNAMES support module: Adds support for the IRCX style UHNAMES
2022 # extension, which displays ident and hostname in the names list for
2023 # each user, saving clients from doing a WHO on the channel.
2024 # If a client does not support UHNAMES it will not enable it, this will
2025 # not break incompatible clients.
2026 #<module name="uhnames">
2028 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2029 # Uninvite module: Adds the /UNINVITE command which lets users remove
2030 # pending invites from channels without waiting for the user to join.
2031 #<module name="uninvite">
2033 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2034 # Userip module: Adds the /USERIP command.
2035 # Allows users to query their own IP, also allows opers to query the IP
2037 #<module name="userip">
2039 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2040 # Vhost module: Adds the VHOST command which allows for adding virtual
2041 # hosts which are accessible using a username and password in the config.
2042 #<module name="vhost">
2044 #-#-#-#-#-#-#-#-#-#-#- VHOST CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#-#
2046 # user - Username for the vhost. #
2048 # pass - Password for the vhost. #
2050 # hash - The hash for the specific user (optional) #
2051 # password_hash and a hashing module must be loaded for #
2054 # host - Vhost to set. #
2056 #<vhost user="some_username" pass="some_password" host="some.host.test.cc">
2057 #<vhost user="foo" password="$2a$10$iTuYLT6BRhRlOgzfsW9oPe62etW.oXwSpyKw5rJit64SGZanLXghO" hash="bcrypt" host="some.other.host.example.com">
2059 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2060 # Watch module: Adds the WATCH command, which is used by clients to
2061 # maintain notify lists.
2062 #<module name="watch">
2064 # Set the maximum number of entries on a user's watch list below.
2065 #<watch maxentries="32">
2067 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2068 # WebSocket module: Adds HTML5 WebSocket support.
2069 # Specify hook="websocket" in a <bind> tag to make that port accept
2070 # WebSocket connections. Compatible with SSL/TLS.
2071 # Requires SHA-1 hash support available in the sha1 module.
2072 #<module name="websocket">
2074 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2075 # XLine database: Stores all *Lines (G/Z/K/R/any added by other modules)
2076 # in a file which is re-loaded on restart. This is useful
2077 # for two reasons: it keeps bans so users may not evade them, and on
2078 # bigger networks, server connections will take less time as there will
2079 # be a lot less bans to apply - as most of them will already be there.
2080 #<module name="xline_db">
2082 # Specify the filename for the xline database here.
2083 #<xlinedb filename="xline.db">
2085 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2086 # ____ _ _____ _ _ ____ _ _ _ #
2087 # | _ \ ___ __ _ __| | |_ _| |__ (_)___ | __ )(_) |_| | #
2088 # | |_) / _ \/ _` |/ _` | | | | '_ \| / __| | _ \| | __| | #
2089 # | _ < __/ (_| | (_| | | | | | | | \__ \ | |_) | | |_|_| #
2090 # |_| \_\___|\__,_|\__,_| |_| |_| |_|_|___/ |____/|_|\__(_) #
2092 # To link servers to InspIRCd, you MUST load the spanningtree module. #
2093 # If you don't do this, server links will NOT work at all. #
2094 # This is by design, to allow for the implementation of other linking #
2095 # protocols in modules in the future. #
2097 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2098 # Spanning tree module: Allows linking of servers using the spanning
2099 # tree protocol (see the READ THIS BIT section above).
2100 # You will almost always want to load this.
2102 #<module name="spanningtree">
projects / user / henk / code / inspircd.git / blob