1 #-#-#-#-#-#-#-#-#-#-#-#-#- MODULE OPTIONS -#-#-#-#-#-#-#-#-#-#-#-#-#
3 # These tags define which modules will be loaded on startup by your #
4 # server. Add modules without any paths. When you make your ircd #
5 # using the 'make' command, all compiled modules will be moved into #
6 # the folder you specified when you ran ./configure. The module tag #
7 # automatically looks for modules in this location. #
8 # If you attempt to load a module outside of this location, either #
9 # in the config, or via /LOADMODULE, you will receive an error. #
11 # By default, ALL modules are commented out. You must uncomment them #
12 # or add lines to your config to load modules. Please refer to #
13 # https://wiki.inspircd.org/3.0/Modules for a list of modules and #
14 # each modules link for any additional conf tags they require. #
16 # ____ _ _____ _ _ ____ _ _ _ #
17 # | _ \ ___ __ _ __| | |_ _| |__ (_)___ | __ )(_) |_| | #
18 # | |_) / _ \/ _` |/ _` | | | | '_ \| / __| | _ \| | __| | #
19 # | _ < __/ (_| | (_| | | | | | | | \__ \ | |_) | | |_|_| #
20 # |_| \_\___|\__,_|\__,_| |_| |_| |_|_|___/ |____/|_|\__(_) #
22 # To link servers to InspIRCd, you MUST load the spanningtree module. #
23 # If you don't do this, server links will NOT work at all. #
24 # This is by design, to allow for the implementation of other linking #
25 # protocols in modules in the future. This module is at the bottom of #
29 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
30 # MD5 module: Allows other modules to generate MD5 hashes, usually for
31 # cryptographic uses and security.
34 # Other modules such as cloaking and password_hash may rely on
35 # this module being loaded to function.
39 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
40 # SHA256 module: Allows other modules to generate SHA256 hashes,
41 # usually for cryptographic uses and security.
44 # Other modules such as password_hash may rely on this module being
45 # loaded to function. Certain modules such as spanningtree will
46 # function without this module but when it is loaded their features will
47 # be enhanced (for example the addition of HMAC authentication).
49 #<module name="sha256">
51 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
52 # Abbreviation module: Provides the ability to abbreviate commands a-la
54 #<module name="abbreviation">
56 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
57 # Alias module: Allows you to define server-side command aliases.
58 #<module name="alias">
60 # Set the 'prefix' for in-channel aliases (fantasy commands) to the
61 # specified character. If not set, the default is "!".
62 # If 'allowbots' is disabled, +B clients will not be able to use
63 # fantasy commands. If not set, the default is no.
64 #<fantasy prefix="!" allowbots="no">
66 #-#-#-#-#-#-#-#-#-#-#- ALIAS DEFINITIONS -#-#-#-#-#-#-#-#-#-#-#-#-#-#
68 # If you have the alias module loaded, you may also define aliases as #
69 # shown below. They are commonly used to provide shortcut commands to #
70 # services, however they are not limited to just this use. #
71 # An alias tag requires the following values to be defined in it: #
73 # text - The text to detect as the actual command line. #
74 # Can't contain spaces, but case insensitive. #
75 # You may have multiple aliases with the same #
76 # command name (text="" value), however the first #
77 # found will be executed if its format value is #
78 # matched, or it has no format value. Aliases are #
79 # read from the top of the file to the bottom. #
81 # usercommand - If this is true, the alias can be run simply as #
82 # /aliasname. Defaults to true. #
84 # channelcommand - If this is true, the alias can be used as an #
85 # in-channel alias or 'fantasy command', prefixed #
86 # by the fantasy prefix character, !aliasname by #
87 # default. Defaults to false. #
89 # format - If this is defined, the parameters of the alias #
90 # must match this glob pattern. For example if you #
91 # want the first parameter to start with a # for #
92 # the alias to be executed, set format="#*" in the #
93 # alias definition. Note that the :'s which are #
94 # part of IRC formatted lines will be preserved #
95 # for matching of this text. This value is #
98 # replace - The text to replace 'text' with. Usually this #
99 # will be "PRIVMSG ServiceName :$2-" or similar. #
100 # You may use the variables $1 through $9 in the #
101 # replace string, which refer to the first through #
102 # ninth word in the original string typed by the #
103 # user. You may also use $1- through $9- which #
104 # refer to the first word onwards, through to the #
105 # ninth word onwards, e.g. if the user types the #
106 # command "foo bar baz qux quz" then $3- will hold #
107 # "baz qux quz" and $2 will contain "bar". You may #
108 # also use the special variables: $nick, $ident, #
109 # $host and $vhost, and you may separate multiple #
110 # commands with a newline (which can be written in #
111 # the file literally, or encoded as &nl; or \n #
112 # depending on the config format setting). #
114 # requires - If you provide a value for 'requires' this means #
115 # the given nickname MUST be online for the alias #
116 # to successfully trigger. If they are not, then #
117 # the user receives a 'no such nick' 401 numeric. #
119 # uline - Setting this to true will ensure that the user #
120 # given in 'requires' is also on a u-lined server, #
121 # as well as actually being on the network. If the #
122 # user is online, but not on a u-lined server, #
123 # then an oper alert is sent out as this is #
124 # possibly a sign of a user trying to impersonate #
127 # operonly - If true, this will make the alias oper only. #
128 # If a non-oper attempts to use the alias, it will #
129 # appear to not exist. #
132 # An example of using the format value to create an alias with two
133 # different behaviours depending on the format of the parameters.
135 #<alias text="ID" format="#*" replace="PRIVMSG ChanServ :IDENTIFY $2 $3"
136 # requires="ChanServ" uline="yes">
138 #<alias text="ID" replace="PRIVMSG NickServ :IDENTIFY $2"
139 # requires="NickServ" uline="yes">
141 # This alias fixes a glitch in xchat 2.6.x and above and the way it
142 # assumes IDENTIFY must be prefixed by a colon (:) character. It should
143 # be placed ABOVE the default NICKSERV alias.
145 #<alias text="NICKSERV" format=":IDENTIFY *" replace="PRIVMSG NickServ :IDENTIFY $3-"
146 # requires="NickServ" uline="yes">
148 # You may also add aliases to trigger based on something said in a
149 # channel, aka 'fantasy' commands, configured in the same manner as any
150 # other alias, with usercommand="no" and channelcommand="yes" The
151 # command must be preceded by the fantasy prefix when used.
153 #<alias text="CS" usercommand="no" channelcommand="yes"
154 # replace="PRIVMSG ChanServ :$1 $chan $2-" requires="ChanServ" uline="yes">
156 # This would be used as "!cs <command> <options>", with the channel
157 # being automatically inserted after the command in the message to
158 # ChanServ, assuming the fantasy prefix is "!".
160 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
161 # Allowinvite module: Gives channel mode +A to allow all users to use
162 # /INVITE, and extban A to deny invite from specific masks.
163 #<module name="allowinvite">
165 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
166 # Alltime module: Shows time on all connected servers at once.
167 # This module is oper-only and provides /ALLTIME.
168 # To use, ALLTIME must be in one of your oper class blocks.
169 #<module name="alltime">
171 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
172 # Anticaps module: Adds channel mode +B which allows you to punish
173 # users that send overly capitalised messages to channels. Unlike the
174 # blockcaps module this module is more flexible as it has more options
175 # for punishment and allows channels to configure their own punishment
177 #<module name="anticaps">
179 # You may also configure the characters which anticaps considers to be
180 # lower case and upper case. Any characters not listed here are assumed
181 # to be punctuation and will be ignored when counting:
182 # <anticaps lowercase="abcdefghijklmnopqrstuvwxyz"
183 # uppercase="ABCDEFGHIJKLMNOPQRSTUVWXYZ">
185 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
186 # Auditorium module: Adds channel mode +u which makes everyone else
187 # except you in the channel invisible, used for large meetings etc.
188 #<module name="auditorium">
190 # Auditorium settings:
192 #<auditorium opvisible="no" opcansee="no" opercansee="yes">
194 # opvisible (auditorium-vis in exemptchanops):
195 # Show channel ops to all users
196 # opcansee (auditorium-see in exemptchanops):
197 # Allow ops to see all joins/parts/kicks in the channel
199 # Allow opers (channels/auspex) to see see all joins/parts/kicks in the channel
201 # Exemptchanops can be used to adjust the level at which users become visible or
202 # the level at which they can see the full member list of the channel.
204 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
205 # Autoop module: Adds basic channel access controls via the +w listmode.
206 # For example +w o:*!Attila@127.0.0.1 will op anyone matching that mask
207 # on join. This can be combined with extbans, for example +w o:R:Brain
208 # will op anyone identified to the account "Brain".
209 # Another useful combination is with SSL client certificate
210 # fingerprints: +w h:z:72db600734bb9546c1bdd02377bc21d2a9690d48 will
211 # give halfop to the user(s) having the given certificate.
212 #<module name="autoop">
214 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
215 # Ban except module: Adds support for channel ban exceptions (+e).
216 #<module name="banexception">
218 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
219 # Ban redirection module: Allows bans which redirect to a specified
220 # channel. e.g. +b nick!ident@host#channelbanneduserissentto
221 #<module name="banredirect">
223 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
224 # bcrypt module: Allows other modules to generate bcrypt hashes,
225 # usually for cryptographic uses and security.
226 #<module name="bcrypt">
228 # rounds: Defines how many rounds the bcrypt function will run when
229 # generating new hashes.
230 #<bcrypt rounds="10">
232 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
233 # Block amsg module: Attempt to block all usage of /amsg and /ame.
234 #<module name="blockamsg">
236 #-#-#-#-#-#-#-#-#-#-#- BLOCKAMSG CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
238 # If you have the blockamsg module loaded, you can configure it with #
239 # the <blockamsg> tag: #
241 # delay - How much time between two messages to force them #
242 # to be recognised as unrelated. #
243 # action - Any of 'notice', 'noticeopers', 'silent', 'kill' #
244 # or 'killopers'. Define how to take action when #
245 # a user uses /amsg or /ame. #
247 #<blockamsg delay="3" action="killopers">
249 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
250 # Block CAPS module: Adds channel mode +B, blocks all-CAPS messages.
252 # NOTE: This module is deprecated and will be removed in a future version
253 # of InspIRCd. You should use the anticaps module shown above instead.
254 #<module name="blockcaps">
256 #-#-#-#-#-#-#-#-#-#-#- BLOCKCAPS CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
258 # percent - The percentage of a message which must be upper #
259 # case before it will be blocked. #
261 # minlen - The minimum length a message must be before it #
264 # lowercase - The characters which will be considered lower #
267 # uppercase - The characters which will be considered upper #
270 #<blockcaps percent="50"
272 # lowercase="abcdefghijklmnopqrstuvwxyz"
273 # uppercase="ABCDEFGHIJKLMNOPQRSTUVWXYZ">
275 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
276 # Block color module: Blocking color-coded messages with chan mode +c.
277 #<module name="blockcolor">
279 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
280 # Botmode module: Adds the user mode +B. If set on a user, it will
281 # show that the user is a bot in /WHOIS.
282 #<module name="botmode">
284 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
285 # CallerID module: Adds usermode +g which activates hybrid-style
286 # callerid: block all private messages unless you /ACCEPT first.
287 #<module name="callerid">
289 #-#-#-#-#-#-#-#-#-#-#- CALLERID CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#
290 # maxaccepts - Maximum number of entries a user can add to his #
291 # /ACCEPT list. Default is 16 entries. #
292 # tracknick - Preserve /accept entries when a user changes nick? #
293 # If no (the default), the user is removed from #
294 # everyone's accept list if he changes nickname. #
295 # cooldown - Amount of time that must pass since the last #
296 # notification sent to a user before he can be sent #
297 # another. Default is 1 minute. #
298 #<callerid maxaccepts="16"
302 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
303 # CAP module: Provides the CAP negotiation mechanism required by the
304 # sasl, namesx, uhnames, and ircv3 modules.
305 # It is also recommended for STARTTLS support in the starttls module.
308 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
309 # CBAN module: Lets you disallow channels from being used at runtime.
310 # This module is oper-only and provides /CBAN.
311 # To use, CBAN must be in one of your oper class blocks.
312 #<module name="cban">
314 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
315 # Censor module: Adds channel and user mode +G.
316 #<module name="censor">
318 #-#-#-#-#-#-#-#-#-#-#- CENSOR CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#
320 # Optional - If you specify to use the censor module, then you must #
321 # specify some censor tags. See also: #
322 # https://wiki.inspircd.org/Modules/3.0/censor #
324 #<include file="examples/censor.conf.example">
326 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
327 # CGI:IRC module: Enables forwarding the real IP address of a user from
328 # a gateway to the IRC server.
329 #<module name="cgiirc">
331 #-#-#-#-#-#-#-#-#-#-#-# CGIIRC CONFIGURATION #-#-#-#-#-#-#-#-#-#-#-#-#
333 # If you use the cgiirc module then you must specify the gateways which
334 # are authorised to forward IP/host information to your server. There
335 # are currently two ways to do this:
337 # The webirc method is the recommended way to allow gateways to forward
338 # IP/host information. When using this method the gateway sends a WEBIRC
339 # message to the server on connection. For more details please read the
340 # IRCv3 WebIRC specification at http://ircv3.net/specs/extensions/webirc.html.
342 # When using this method you must specify a wildcard mask or CIDR range
343 # to allow gateway connections from and at least one of either a SSL
344 # client certificate fingerprint for the gateway or a password to be
345 # sent in the WEBIRC command.
347 # <cgihost type="webirc"
348 # fingerprint="bd90547b59c1942b85f382bc059318f4c6ca54c5"
349 # mask="192.0.2.0/24">
350 # <cgihost type="webirc"
351 # password="$2a$10$WEUpX9GweJiEF1WxBDSkeODBstIBMlVPweQTG9cKM8/Vd58BeM5cW"
353 # mask="*.webirc.gateway.example.com">
355 # Alternatively if your gateway does not support sending the WEBIRC
356 # message then you can configure InspIRCd to look for the client IP
357 # address in the ident sent by the user. This is not recommended as it
358 # only works with IPv4 connections.
360 # When using this method you must specify a wildcard mask or CIDR range to
361 # allow gateway connections from.
363 # <cgihost type="ident" mask="198.51.100.0/24">
364 # <cgihost type="ident" mask="*.ident.gateway.example.com">
366 # By default gateway connections are logged to the +w snomask. If you
367 # do not want this to happen then you can uncomment this to disable it.
368 # <cgiirc opernotice="no">
373 # When you connect gateway clients, there are two connect classes which
374 # apply to these clients. When the client initially connects, the connect
375 # class which matches the gateway site's host is checked. Therefore you
376 # must raise the maximum local/global clients for this IP as high as you
377 # want to allow gateway clients. After the client has connected and is
378 # determined to be a gateway client, the class which matches the client's
379 # real IP is then checked. You may set this class to a lower value, so that
380 # the real IP of the client can still be restricted to, for example, 3
383 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
384 # Channel create module: Adds snomask +j, which will notify opers of
385 # any new channels that are created.
386 # This module is oper-only.
387 #<module name="chancreate">
389 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
390 # Channel filter module: Allows channel-op defined message filtering
391 # using simple string matches (channel mode +g).
392 #<module name="chanfilter">
394 # If hidemask is set to yes, the user will not be shown the mask when
395 # his/her message is blocked.
397 # If maxlen is set then it defines the maximum length of a filter entry.
399 # If notifyuser is set to no, the user will not be notified when
400 # his/her message is blocked.
401 #<chanfilter hidemask="yes" maxlen="50" notifyuser="yes">
403 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
404 # Channel history module: Displays the last 'X' lines of chat to a user
405 # joining a channel with +H 'X:T' set; 'T' is the maximum time to keep
406 # lines in the history buffer. Designed so that the new user knows what
407 # the current topic of conversation is when joining the channel.
408 #<module name="chanhistory">
410 # Set the maximum number of lines allowed to be stored per channel below.
411 # This is the hard limit for 'X'.
412 # If notice is set to yes, joining users will get a NOTICE before playback
413 # telling them about the following lines being the pre-join history.
414 # If bots is set to yes, it will also send to users marked with +B
415 #<chanhistory maxlines="50" notice="yes" bots="yes">
417 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
418 # Channel logging module: Used to send snotice output to channels, to
419 # allow staff to centrally monitor and discuss network activity.
421 # The "channel" field is where you want the messages to go, "snomasks"
422 # is what snomasks you want to be sent to that channel. Multiple tags
424 #<module name="chanlog">
425 #<chanlog snomasks="AOcC" channel="#opers">
427 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
428 # Channel names module: Allows disabling channels which have certain
429 # characters in the channel name such as bold, colorcodes, etc. which
430 # can be quite annoying and allow users to on occasion have a channel
431 # that looks like the name of another channel on the network.
432 #<module name="channames">
435 # denyrange: characters or range of characters to deny in channel
439 # allowrange: characters or range of characters to specifically allow
443 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
444 # Channelban: Implements extended ban j:, which stops anyone already
445 # in a channel matching a ban like +b j:#channel*mask from joining.
446 # Note that by default wildcard characters * and ? are allowed in
447 # channel names. To disallow them, load m_channames and add characters
448 # 42 and 63 to denyrange (see above).
449 #<module name="channelban">
451 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
452 # Check module: Adds the /CHECK command.
453 # Check is useful for looking up information on channels, users,
454 # IP addresses and hosts.
455 # This module is oper-only.
456 # To use, CHECK must be in one of your oper class blocks.
457 #<module name="check">
459 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
460 # CHGHOST module: Adds the /CHGHOST command.
461 # This module is oper-only.
462 # To use, CHGHOST must be in one of your oper class blocks.
463 # NOTE: Services will not be able to set vhosts on users if this module
464 # isn't loaded. If you're planning on running services, you probably
466 #<module name="chghost">
468 #-#-#-#-#-#-#-#-# /CHGHOST - /SETHOST CONFIGURATION #-#-#-#-#-#-#-#-#
469 # Optional - If you want to use special chars for hostnames you can #
470 # specify your own custom list of chars with the <hostname> tag: #
472 # charmap - A list of chars accepted as valid by the /CHGHOST #
473 # and /SETHOST commands. Also note that the list is #
475 #<hostname charmap="abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ.-_/0123456789">
477 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
478 # CHGIDENT module: Adds the /CHGIDENT command.
479 # This module is oper-only.
480 # To use, CHGIDENT must be in one of your oper class blocks.
481 #<module name="chgident">
483 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
484 # CHGNAME module: Adds the /CHGNAME command.
485 # This module is oper-only.
486 # To use, CHGNAME must be in one of your oper class blocks.
487 #<module name="chgname">
489 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
490 # Connection class ban module: Adds support for extban 'n' which
491 # matches against the class name of the user's connection.
492 # This module assumes that connection classes are named in a uniform
493 # way on all servers of the network.
494 #<module name="classban">
496 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
497 # Clear chan module: Allows opers to masskick, masskill or mass-G/ZLine
498 # all users on a channel using /CLEARCHAN.
499 #<module name="clearchan">
501 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
502 # Cloaking module: Adds usermode +x and cloaking support.
503 # Relies on the md5 module being loaded.
504 # To cloak users when they connect, load the conn_umodes module and set
505 # <connect:modes> to include the +x mode. The example <connect> tag
506 # shows this. See the conn_umodes module for more information.
507 #<module name="cloaking">
509 #-#-#-#-#-#-#-#-#-#-#- CLOAKING CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#
511 # To use cloaking, you must define a cloak key, and optionally a #
512 # cloak prefix as shown below. The cloak key must be shared across #
513 # the network for correct cloaking. #
515 # There are two methods of cloaking: #
517 # half Cloak only the "unique" portion of a host; by #
518 # default show the last 2 parts of the domain, #
519 # /16 subnet of IPv4 or /48 subnet of the IPv6 #
521 # To change the number of shown parts, modify the #
522 # domainparts option. #
524 # full Cloak the users completely, using three slices for #
525 # common CIDR bans (IPv4: /16, /24; IPv6: /48, /64). #
527 # The methods use a single key that can be any length of text. #
528 # An optional prefix may be specified to mark cloaked hosts. #
529 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
536 #-#-#-#-#-#-#-#-#-#-#-#- CLOSE MODULE #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
537 # Close module: Allows an oper to close all unregistered connections.
538 # This module is oper-only and provides the /CLOSE command.
539 # To use, CLOSE must be in one of your oper class blocks.
540 #<module name="close">
542 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
543 # Clones module: Adds an oper command /CLONES for detecting cloned
544 # users. Warning: This command may be resource intensive when it is
545 # issued, use with care.
546 # This module is oper-only.
547 # To use, CLONES must be in one of your oper class blocks.
548 #<module name="clones">
550 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
551 # Common channels module: Adds user mode +c, which, when set, requires
552 # that users must share a common channel with you to PRIVMSG or NOTICE
554 #<module name="commonchans">
556 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
557 # Auto join on connect module: Allows you to force users to join one
558 # or more channels automatically upon connecting to the server, or
559 # join them in case they aren't on any channels after being online
561 #<module name="conn_join">
563 #-#-#-#-#-#-#-#-#-#-#-#- CONNJOIN CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
565 # If you have the conn_join module loaded, you can configure it below
566 # or set autojoin="#chat,#help" in <connect> blocks.
568 # Join users immediately after connection to #one #two and #three.
569 #<autojoin channel="#one,#two,#three">
570 # Join users to #chat after 15 seconds if they aren't on any channels.
571 #<autojoin channel="#chat" delay="15">
573 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
574 # Set modes on connect module: When this module is loaded <connect>
575 # blocks may have an optional modes="" value, which contains modes to
576 # add or remove from users when they connect to the server.
577 #<module name="conn_umodes">
579 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
580 # Wait for PONG on connect module: Send a PING to all connecting users
581 # and don't let them connect until they reply with a PONG.
582 # This is useful to stop certain kinds of bots and proxies.
583 #<module name="conn_waitpong">
585 #-#-#-#-#-#-#-#-#-#-#- WAITPONG CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
587 # If you have the conn_waitpong module loaded, configure it with the #
590 # sendsnotice - Whether to send a helpful notice to users on #
591 # connect telling them how to connect, should #
592 # their client not reply PONG automatically. #
594 # killonbadreply - Whether to kill the user if they send the wrong #
597 #<waitpong sendsnotice="yes" killonbadreply="yes">
599 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
600 # Channel cycle module: Adds the /CYCLE command which is a server-side
601 # /HOP that bypasses restrictive modes.
602 #<module name="cycle">
604 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
605 # Connectban: Provides IP connection throttling. Any IP range that
606 # connects too many times (configurable) in an hour is Z-Lined for a
607 # (configurable) duration, and their count resets to 0.
608 #<module name="connectban">
610 # ipv4cidr and ipv6cidr allow you to turn the comparison from
611 # individual IP addresses (32 and 128 bits) into CIDR masks, to allow
612 # for throttling over whole ISPs/blocks of IPs, which may be needed to
615 # This allows for 10 connections in an hour with a 10 minute ban if
617 #<connectban threshold="10" duration="10m" ipv4cidr="32" ipv6cidr="128"
618 # A custom ban message may optionally be specified.
619 # 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.">
621 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
622 # Connection throttle module.
623 #<module name="connflood">
625 #-#-#-#-#-#-#-#-#-#-#- CONNTHROTTLE CONFIGURATION -#-#-#-#-#-#-#-#-#-#
626 # period, maxconns - Amount of connections per <period>.
628 # timeout - Time to wait after the throttle was activated
629 # before deactivating it. Be aware that the time
630 # is seconds + timeout.
632 # quitmsg - The message that users get if they attempt to
633 # connect while the throttle is active.
635 # bootwait - Amount of time in seconds to wait before enforcing
636 # the throttling when the server just booted.
638 #<connflood seconds="30" maxconns="3" timeout="30"
639 # quitmsg="Throttled" bootwait="10">
641 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
642 # Custom prefixes: Allows for channel prefixes to be configured.
643 #<module name="customprefix">
645 # name The name of the mode, must be unique from other modes.
646 # letter The letter used for this mode. Required.
647 # prefix The prefix used for nicks with this mode. Not required.
648 # rank A numeric rank for this prefix, defining what permissions it gives.
649 # The rank of voice, halfop and op is 10000, 20000, and 30000,
651 # ranktoset The numeric rank required to set this mode. Defaults to rank.
652 # ranktounset The numeric rank required to unset this mode. Defaults to ranktoset.
653 # depriv Can you remove the mode from yourself? Defaults to yes.
654 #<customprefix name="founder" letter="q" prefix="~" rank="50000" ranktoset="50000">
655 #<customprefix name="admin" letter="a" prefix="&" rank="40000" ranktoset="50000">
656 #<customprefix name="halfop" letter="h" prefix="%" rank="20000" ranktoset="30000">
658 # You can also override the configuration of prefix modes added by both the core
659 # and other modules by adding a customprefix tag with change="yes" specified.
660 # <customprefix name="op" change="yes" rank="30000" ranktoset="30000">
661 # <customprefix name="voice" change="yes" rank="10000" ranktoset="10000" depriv="no">
663 # Do /RELOADMODULE customprefix after changing the settings of this module.
665 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
666 # Custom title module: Adds the /TITLE command which allows for trusted
667 # users to gain a custom whois line and an optional vhost can be
669 #<module name="customtitle">
671 #-#-#-#-#-#-#-#-#-#- CUSTOM TITLE CONFIGURATION -#-#-#-#-#-#-#-#-#-#
672 # name - The username used to identify.
673 # password - The password used to identify.
674 # hash - The hash for the specific user's password (optional).
675 # password_hash and a hashing module must be loaded
677 # host - Allowed hostmask (optional).
678 # title - Title shown in whois.
679 # vhost - Displayed host (optional).
681 #<title name="foo" password="bar" title="Official Chat Helper">
682 #<title name="bar" password="foo" host="ident@test.org" title="Official Chat Helper" vhost="helper.test.org">
683 #<title name="foo" password="$2a$10$UYZ4OcO8NNTCCGyCdY9SK.2GHiqGgxZfHFPOPmWuxEVWVQTtoDC7C" hash="bcrypt" title="Official Chat Helper">
685 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
686 # DCCALLOW module: Adds the /DCCALLOW command.
687 #<module name="dccallow">
689 #-#-#-#-#-#-#-#-#-#-#- DCCALLOW CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
690 # blockchat - Whether to block DCC CHAT as well as DCC SEND.
691 # length - Default duration of entries in DCCALLOW list.
692 # action - Default action to take if no action is
693 # specified, can be 'block' or 'allow'.
694 # maxentries - Max number of nicks to allow on a DCCALLOW list.
696 # File configuration:
697 # pattern - The glob pattern to match against.
698 # action - Action to take if a user attempts to send a file
699 # that matches this pattern, can be 'block' or
702 #<dccallow blockchat="yes" length="5m" action="block" maxentries="20">
703 #<banfile pattern="*.exe" action="block">
704 #<banfile pattern="*.txt" action="allow">
706 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
707 # Deaf module: Adds support for the usermode +d - deaf to channel
708 # messages and channel notices.
709 #<module name="deaf">
711 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
712 # Delay join module: Adds the channel mode +D which delays all JOIN
713 # messages from users until they speak. If they quit or part before
714 # speaking, their quit or part message will not be shown to the channel
715 # which helps cut down noise on large channels in a more friendly way
716 # than the auditorium mode. Only channel ops may set the +D mode.
717 #<module name="delayjoin">
719 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
720 # Delay message module: Adds the channel mode +d which disallows a user
721 # from talking in the channel unless they've been joined for X seconds.
722 # Settable using /MODE #chan +d 30
723 #<module name="delaymsg">
724 # Set allownotice to no to disallow NOTICEs too. Defaults to yes.
725 #<delaymsg allownotice="no">
727 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
728 # Deny channels module: Deny channels from being used by users.
729 #<module name="denychans">
731 #-#-#-#-#-#-#-#-#-#-#- DENYCHAN DEFINITIONS -#-#-#-#-#-#-#-#-#-#-#-#
733 # If you have the denychans module loaded, you need to specify the #
734 # channels to deny: #
736 # name - The channel name to deny (glob masks are ok). #
737 # allowopers - If operators are allowed to override the deny. #
738 # reason - Reason given for the deny. #
739 # redirect - Redirect the user to a different channel. #
741 #<badchan name="#gods*" allowopers="yes" reason="Tortoises!"> #
742 #<badchan name="#chan1" redirect="#chan2" reason="Chan1 is closed"> #
744 # Redirects will not work if the target channel is set +L. #
746 # Additionally, you may specify channels which are allowed, even if #
747 # a badchan tag specifies it would be denied: #
748 #<goodchan name="#funtimes"> #
749 # Glob masks are accepted here also. #
751 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
752 # DNS blacklist module: Provides support for looking up IPs on one or #
754 #<module name="dnsbl"> #
756 # For configuration options please see the wiki page for dnsbl at #
757 # https://wiki.inspircd.org/Modules/3.0/dnsbl #
759 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
760 # Exempt channel operators module: Provides support for allowing #
761 # users of a specified channel status to be exempt from some channel #
762 # restriction modes. Supported restrictions are #
763 # blockcaps, blockcolor, censor, filter, flood, nickflood, noctcp, #
764 # nonick, nonotice, regmoderated, stripcolor, and topiclock. #
765 # See <options:exemptchanops> in inspircd.conf.example for a more #
766 # detailed list of the restriction modes that can be exempted. #
767 # These are settable using /mode #chan +X <restriction>:<status> #
768 #<module name="exemptchanops"> #
770 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
771 # Filter module: Provides message filtering, similar to SPAMFILTER. #
772 #<module name="filter">
774 # This module depends upon a regex provider such as regex_pcre or #
775 # regex_glob to function. You must specify which of these you want #
776 # the filter module to use via the tag below. #
778 # Valid engines are: #
780 # glob - Glob patterns, provided via regex_glob. #
781 # pcre - PCRE regexps, provided via regex_pcre, needs libpcre. #
782 # tre - TRE regexps, provided via regex_tre, requires libtre. #
783 # posix - POSIX regexps, provided via regex_posix, not available #
784 # on Windows, no dependencies on other operating systems. #
785 # stdlib - stdlib regexps, provided via regex_stdlib, see comment #
786 # at the <module> tag for info on availability. #
788 # If notifyuser is set to no, the user will not be notified when #
789 # his/her message is blocked. #
790 #<filteropts engine="glob" notifyuser="yes">
792 # Your choice of regex engine must match on all servers network-wide. #
794 # To learn more about the configuration of this module, read #
795 # examples/filter.conf.example, which covers the various types of #
796 # filters and shows how to add exemptions. #
798 #-#-#-#-#-#-#-#-#-#-#- FILTER CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#
800 # Optional - If you specify to use the filter module, then #
801 # specify below the path to the filter.conf file, or define some #
804 #<include file="examples/filter.conf.example">
806 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
807 # Flash Policy Daemon module: Allows Flash IRC clients (e.g. LightIRC)#
808 # to connect. If no file is specified, it'll serve a default policy #
809 # allowing all IPs to connect to all plaintext IRC ports #
810 #<bind address="" port="8430" type="flashpolicyd"> #
811 #<flashpolicyd timeout="5" file=""> #
812 #<module name="flashpolicyd"> #
814 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
815 # Real name ban: Implements extended ban 'r', which stops anyone
816 # matching a mask like +b r:*realname?here* from joining a channel.
817 #<module name="gecosban">
819 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
820 # GeoIP module: Allows the server admin to match users by country code.
821 # This module is in extras. Re-run configure with:
822 # ./configure --enable-extras=m_geoip.cpp
823 # and run make install, then uncomment this module to enable it.
824 # This module requires GeoIP to be installed on your system,
825 # use your package manager to find the appropriate packages
826 # or check the InspIRCd wiki page for this module.
827 #<module name="geoip">
829 # The actual allow/ban actions are done by connect classes, not by the
830 # GeoIP module. An example connect class to ban people from russia or
833 # <connect deny="*" geoip="TR,RU">
835 # If enabled you can also ban people from channnels by country code
836 # using the G: extban (e.g. /mode #channel +b G:US).
837 # <geoip extban="yes">
839 # The country code must be in capitals and should be an ISO country
840 # code such as TR, GB, or US. Unknown IPs (localhost, LAN IPs, etc)
841 # will be assigned the country code "UNK". Since connect classes are
842 # matched from top down, your deny classes must be above your allow
843 # classes for them to match.
845 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
846 # Globops module: Provides the /GLOBOPS command and snomask +g.
847 # This module is oper-only.
848 # To use, GLOBOPS must be in one of your oper class blocks.
849 #<module name="globops">
851 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
852 # Global load module: Allows loading and unloading of modules network-
853 # wide (USE WITH EXTREME CAUTION!)
854 # This module is oper-only and provides /GLOADMODULE, /GUNLOADMODULE
855 # and /GRELOADMODULE.
856 # To use, GLOADMODULE, GUNLOADMODULE and GRELOADMODULE
857 # must be in one of your oper class blocks.
858 #<module name="globalload">
860 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
861 # HAProxy module: Adds support for the HAProxy PROXY v2 protocol. To
862 # use this module specify hook="haproxy" in the <bind> tag that HAProxy
863 # has been configured to connect to.
864 #<module name="haproxy">
866 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
867 # HELPOP module: Provides the /HELPOP command
868 #<module name="helpop">
870 #-#-#-#-#-#-#-#-#-#-#-#- HELPOP CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
872 # If you specify to use the helpop module, then specify below the #
873 # path to the helpop.conf file. #
875 #<include file="examples/helpop-full.conf.example">
877 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
878 # Hide chans module: Allows users to hide their channels list from non-
879 # opers by setting user mode +I on themselves.
880 #<module name="hidechans">
882 # This mode can optionally prevent opers from seeing channels on a +I
883 # user, for more privacy if set to true.
884 # This setting is not recommended for most mainstream networks.
885 #<hidechans affectsopers="false">
887 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
888 # Hide list module: Allows for hiding the list of listmodes from users
889 # who do not have sufficient channel rank.
890 #<module name="hidelist">
892 # Each <hidelist> tag configures one listmode to hide.
893 # mode: Name of the listmode to hide.
894 # rank: Minimum rank required to view the list. If set to 0, all
895 # members of the channel may view the list, but non-members may not.
896 # The rank of the built-in op and voice mode is 30000 and 10000,
897 # respectively; the rank of other prefix modes is configurable.
900 # Hiding the ban list is not recommended because it may break some
903 # Hide filter (+g) list:
904 #<hidelist mode="filter" rank="30000">
905 # Only show invite exceptions (+I) to channel members:
906 #<hidelist mode="invex" rank="0">
908 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
909 # Hide oper module: Allows opers to hide their oper status from non-
910 # opers by setting user mode +H on themselves.
911 # This module is oper-only.
912 #<module name="hideoper">
914 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
915 # Hostchange module: Allows a different style of cloaking.
916 #<module name="hostchange">
918 #-#-#-#-#-#-#-#-#-#-#- HOSTCHANGE CONFIGURATION -#-#-#-#-#-#-#-#-#-#
920 # See https://wiki.inspircd.org/Modules/3.0/hostchange for help. #
922 #<host suffix="invalid.org" separator="." prefix="">
923 #<hostchange mask="*@42.theanswer.example.org" action="addnick">
924 #<hostchange mask="*root@*" action="suffix">
925 #<hostchange mask="a@example.com" action="set" value="foo.bar.baz">
926 #<hostchange mask="localhost" ports="7000,7001,7005-7007" action="set" value="blahblah.foo">
928 # hostcycle: If loaded, when a user gets a host or ident set, it will
929 # cycle them in all their channels. If not loaded it will simply change
930 # their host/ident without cycling them.
931 # This module is compatible with the ircv3_chghost module. Clients
932 # supporting the chghost extension will get the chghost message instead
933 # of seeing a host cycle.
934 #<module name="hostcycle">
936 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
937 # httpd module: Provides HTTP server support for InspIRCd.
938 #<module name="httpd">
940 #-#-#-#-#-#-#-#-#-#-#-#- HTTPD CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
942 # If you choose to use the httpd module, then you will need to add
943 # a <bind> tag with type "httpd", and load at least one of the other
944 # httpd_* modules to provide pages to display.
945 # <bind address="127.0.0.1" port="8067" type="httpd">
946 # <bind address="127.0.0.1" port="8097" type="httpd" ssl="gnutls">
948 # You can adjust the timeout for HTTP connections below. All HTTP
949 # connections will be closed after (roughly) this time period.
950 #<httpd timeout="20">
952 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
953 # HTTP ACL module: Provides access control lists for httpd dependent
954 # modules. Use this module to restrict pages by IP address and by
956 #<module name="httpd_acl">
958 #-#-#-#-#-#-#-#-#-#-#-#- HTTPD ACL CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
960 # Restrict access to the httpd_stats module to all but the local
961 # network and when the correct password is specified:
962 # <httpdacl path="/stats*" types="password,whitelist"
963 # username="secrets" password="mypasshere" whitelist="127.0.0.*,10.*">
965 # Deny all connections to all but the main index page:
966 # <httpdacl path="/*" types="blacklist" blacklist="*">
968 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
969 # HTTP config module: Allows the server configuration to be viewed over
970 # HTTP via the /config path. Requires the httpd module to be loaded for
973 # IMPORTANT: This module exposes extremely sensitive information about
974 # your server and users so you *MUST* protect it using a local-only
975 # <bind> tag and/or the httpd_acl module. See above for details.
976 #<module name="httpd_config">
978 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
979 # HTTP stats module: Provides server statistics over HTTP via the /stats
980 # path. Requires the httpd module to be loaded for it to function.
982 # IMPORTANT: This module exposes extremely sensitive information about
983 # your server and users so you *MUST* protect it using a local-only
984 # <bind> tag and/or the httpd_acl module. See above for details.
985 #<module name="httpd_stats">
987 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
988 # Ident: Provides RFC 1413 ident lookup support.
989 # When this module is loaded <connect:allow> tags may have an optional
990 # useident="yes|no" boolean value, determining whether or not to lookup
991 # ident on users matching that connect tag.
992 #<module name="ident">
994 #-#-#-#-#-#-#-#-#-#-#-#- IDENT CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
996 # Optional - If you are using the ident module, then you can specify #
997 # the timeout for ident lookups here. If not defined, it will default #
998 # to 5 seconds. This is a non-blocking timeout which holds the user #
999 # in a 'connecting' state until the lookup is complete. #
1000 # The bind value indicates which IP to bind outbound requests to. #
1001 # nolookupprefix: If on, the idents of users being in a connect class #
1002 # with ident lookups disabled (i.e. <connect useident="off">) will be #
1003 # prefixed with a "~". If off, the ident of those users will not be #
1004 # prefixed. Default is off. #
1006 #<ident timeout="5" nolookupprefix="no">
1008 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1009 # Invite exception module: Adds support for channel invite exceptions
1011 #<module name="inviteexception">
1012 # bypasskey: If this is enabled, exceptions will bypass +k as well as +i
1013 #<inviteexception bypasskey="yes">
1015 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1016 # IRCv3 module: Provides the following IRCv3 extensions:
1017 # extended-join, away-notify and account-notify. These are optional
1018 # enhancements to the client-to-server protocol. An extension is only
1019 # active for a client when the client specifically requests it, so this
1020 # module needs the cap module to work.
1022 # Further information on these extensions can be found at the IRCv3
1023 # working group website:
1024 # http://ircv3.net/irc/
1026 #<module name="ircv3">
1027 # The following block can be used to control which extensions are
1028 # enabled. Note that extended-join can be incompatible with delayjoin
1030 #<ircv3 accountnotify="on" awaynotify="on" extendedjoin="on">
1032 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1033 # IRCv3 cap-notify module: Provides the cap-notify IRCv3 extension.
1034 # Required for IRCv3 conformance.
1035 #<module name="ircv3_capnotify">
1037 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1038 # IRCv3 account-tag module. Adds the 'account' tag which contains the
1039 # services account name of the message sender.
1040 #<module name="ircv3_accounttag">
1042 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1043 # IRCv3 batch module: Provides the batch IRCv3 extension which allows
1044 # the server to inform a client that a group of messages are related to
1046 #<module name="ircv3_batch">
1048 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1049 # IRCv3 cap-notify module: Provides the cap-notify IRCv3 extension.
1050 # Required for IRCv3 conformance.
1051 #<module name="ircv3_capnotify">
1053 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1054 # IRCv3 chghost module: Provides the chghost IRCv3 extension which
1055 # allows capable clients to learn when the host/ident of another user
1056 # changes without cycling the user. This module is compatible with the
1057 # hostcycle module. If both are loaded, clients supporting the chghost
1058 # extension will get the chghost message and won't see host cycling.
1059 #<module name="ircv3_chghost">
1061 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1062 # IRCv3 echo-message module: Provides the echo-message IRCv3
1063 # extension which allows capable clients to get an acknowledgement when
1064 # their messages are delivered and learn what modifications, if any,
1065 # were applied to them.
1066 #<module name="ircv3_echomessage">
1068 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1069 # IRCv3 invite-notify module: Provides the invite-notify IRCv3
1070 # extension which notifies supporting clients when a user invites
1071 # another user into a channel. This respects <options:announceinvites>.
1072 #<module name="ircv3_invitenotify">
1074 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1075 # IRCv3 server-time module. Adds the 'time' tag which adds a timestamp
1076 # to all messages received from the server.
1077 #<module name="ircv3_servertime">
1079 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1080 # IRCv3 Strict Transport Security module: Provides the sts IRCv3
1081 # extension which allows clients connecting insecurely to upgrade their
1082 # connections to TLS.
1083 #<module name="ircv3_sts">
1085 # If using the ircv3_sts module you MUST define a STS policy to send
1086 # to clients using the <sts> tag. This tag takes the following
1089 # host - A glob match for the SNI hostname to apply this policy to.
1090 # duration - The amount of time that the policy lasts for. Defaults to
1091 # approximately two months by default.
1092 # port - The port on which TLS connections to the server are being
1093 # accepted. You MUST have a CA-verified certificate on this
1094 # port. Self signed certificates are not acceptable.
1095 # preload - Whether client developers can include your certificate in
1098 # <sts host="*.example.com" duration="60d" port="6697" preload="yes">
1100 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1101 # Join flood module: Adds support for join flood protection +j X:Y.
1102 # Closes the channel for N seconds if X users join in Y seconds.
1103 #<module name="joinflood">
1105 # The number of seconds to close the channel for:
1106 #<joinflood duration="1m">
1108 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1109 # Jump server module: Adds support for the RPL_REDIR numeric.
1110 # This module is oper-only.
1111 # To use, JUMPSERVER must be in one of your oper class blocks.
1112 # If your server is redirecting new clients and you get disconnected,
1113 # do a REHASH from shell to open up again.
1114 #<module name="jumpserver">
1116 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1117 # Anti auto rejoin: Adds support for prevention of auto-rejoin (+J).
1118 #<module name="kicknorejoin">
1120 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1121 # Knock module: Adds the /KNOCK command and channel mode +K.
1122 #<module name="knock">
1124 # This setting specifies what to do when someone successfully /KNOCKs.
1125 # If set to "notice", then a NOTICE will be sent to the channel.
1126 # This is the default and the compatible setting, as it requires no
1127 # special support from the clients.
1128 # If set to "numeric" then a 710 numeric will be sent to the channel.
1129 # This allows easier scripting but not all clients support it.
1130 # If set to "both" then (surprise!) both will be sent.
1131 #<knock notify="notice">
1133 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1134 # LDAP module: Allows other SQL modules to access a LDAP database
1135 # through a unified API.
1136 # This modules is in extras. Re-run configure with:
1137 # ./configure --enable-extras=m_ldap.cpp
1138 # and run make install, then uncomment this module to enable it.
1140 #<module name="ldap">
1141 #<database module="ldap" id="ldapdb" server="ldap://localhost" binddn="cn=Manager,dc=inspircd,dc=org" bindauth="mysecretpass" searchscope="subtree">
1142 # The server parameter indicates the LDAP server to connect to. The #
1143 # ldap:// style scheme before the hostname proper is MANDATORY. #
1145 # The binddn and bindauth indicate the DN to bind to for searching, #
1146 # and the password for the distinguished name. Some LDAP servers will #
1147 # allow anonymous searching in which case these two values do not #
1148 # need defining, otherwise they should be set similar to the examples #
1151 # The searchscope value indicates the subtree to search under. On our #
1152 # test system this is 'subtree'. Your mileage may vary. #
1154 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1155 # LDAP authentication module: Adds the ability to authenticate users #
1157 #<module name="ldapauth">
1161 # <ldapauth dbid="ldapdb" #
1162 # baserdn="ou=People,dc=brainbox,dc=cc" #
1164 # allowpattern="Guest* Bot*" #
1165 # killreason="Access denied" #
1167 # host="$uid.$ou.inspircd.org" #
1168 # useusername="no"> #
1170 # <ldapwhitelist cidr="10.42.0.0/16"> #
1172 # <ldaprequire attribute="attr" value="val"> #
1174 # The baserdn indicates the base DN to search in for users. Usually #
1175 # this is 'ou=People,dc=yourdomain,dc=yourtld'. #
1177 # The attribute value indicates the attribute which is used to locate #
1178 # a user account by name. On POSIX systems this is usually 'uid'. #
1180 # The allowpattern value allows you to specify a space separated list #
1181 # of wildcard masks which will always be allowed to connect #
1182 # regardless of if they have an account, for example guest and bot #
1185 # The useusername setting chooses whether the user's username or #
1186 # nickname is used when locating a user account, if a username isn't #
1187 # provided in PASS. #
1189 # Killreason indicates the QUIT reason to give to users if they fail #
1190 # to authenticate. #
1192 # Setting the verbose value causes an oper notice to be sent out for #
1193 # every failed authentication to the server, with an error string. #
1195 # ldapwhitelist indicates that clients connecting from an IP in the #
1196 # provided CIDR do not need to authenticate against LDAP. It can be #
1197 # repeated to whitelist multiple CIDRs. #
1199 # ldaprequire allows further filtering on the LDAP user, by requiring #
1200 # certain LDAP attibutes to have a given value. It can be repeated, #
1201 # in which case the list will act as an OR list, that is, the #
1202 # authentication will succeed if any of the requirements in the list #
1205 # host allows you to change the displayed host of users connecting #
1206 # from ldap. The string supplied takes formatters which are replaced #
1207 # from the DN. For instance, if your DN looks like: #
1208 # uid=w00t,ou=people,dc=inspircd,dc=org, then the formatters uid, ou #
1209 # and dc will be available to you. If a key is given multiple times #
1210 # in the DN, the last appearance will take precedence. #
1212 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1213 # LDAP oper configuration module: Adds the ability to authenticate #
1215 #<module name="ldapoper">
1219 # <ldapoper dbid="ldapdb"
1220 # baserdn="ou=People,dc=brainbox,dc=cc"
1223 # Available configuration items are identical to the same items in #
1224 # ldapauth above (except for the verbose setting, that is only #
1225 # supported in ldapauth). #
1226 # Please always specify a password in your <oper> tags even if the #
1227 # opers are to be authenticated via LDAP, so in case this module is #
1228 # not loaded the oper accounts are still protected by a password. #
1230 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1231 # Lock server module: Adds /LOCKSERV and /UNLOCKSERV commands that #
1232 # are used to temporarily close/open the server for new connections. #
1233 # These commands require that the /LOCKSERV and /UNLOCKSERV commands #
1234 # are specified in a <class> tag that the oper is part of. This is so #
1235 # you can control who has access to this possible dangerous command. #
1236 # If your server is locked and you get disconnected, do a REHASH from #
1237 # shell to open up again. #
1238 # This module is oper-only.
1239 #<module name="lockserv">
1241 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1242 # Map hiding module: replaces /MAP and /LINKS output to users with a #
1243 # message to see a website, set by maphide="http://test.org/map" in #
1244 # the <security> tag, instead. #
1245 #<module name="maphide">
1247 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1248 # Message flood module: Adds message/notice flood protection via
1250 #<module name="messageflood">
1252 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1253 # MLOCK module: Adds support for server-side enforcement of services
1254 # side MLOCKs. Basically, this module suppresses any mode change that
1255 # would likely be immediately bounced by services.
1256 #<module name="mlock">
1258 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1259 # Modenotice module: Adds the /MODENOTICE command that allows opers to
1260 # send notices to all users having the given user mode(s) set.
1261 #<module name="modenotice">
1263 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1264 # Monitor module: Adds support for MONITOR which is used by clients to
1265 # maintain notify lists.
1266 #<module name="monitor">
1268 # Set the maximum number of entries on a user's monitor list below.
1269 #<monitor maxentries="30">
1271 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1272 # MySQL module: Allows other SQL modules to access MySQL databases
1273 # through a unified API.
1274 # This module is in extras. Re-run configure with:
1275 # ./configure --enable-extras=m_mysql.cpp
1276 # and run make install, then uncomment this module to enable it.
1277 #<module name="mysql">
1279 #-#-#-#-#-#-#-#-#-#-#-#- SQL CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#-#
1281 # mysql is more complex than described here, see the wiki for more #
1282 # info: https://wiki.inspircd.org/Modules/3.0/mysql #
1284 #<database module="mysql" name="mydb" user="myuser" pass="mypass" host="localhost" id="my_database2">
1286 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1287 # Named modes module: Allows for the display and set/unset of channel
1288 # modes via long-form mode names via +Z and the /PROP command.
1289 # For example, to set a ban, do /mode #channel +Z ban=foo!bar@baz or
1290 # /PROP #channel ban=foo!bar@baz
1291 #<module name="namedmodes">
1293 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1294 # NAMESX module: Provides support for the NAMESX extension which allows
1295 # clients to see all the prefixes set on a user without getting confused.
1296 # This is supported by mIRC, x-chat, klient, and maybe more.
1297 #<module name="namesx">
1299 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1300 # National characters module:
1301 # 1) Allows using national characters in nicknames.
1302 # 2) Allows using custom (national) casemapping over the network.
1303 #<module name="nationalchars">
1305 # file - Location of the file which contains casemapping rules. If this
1306 # is a relative path then it is relative to "<PWD>/../locales"
1307 # on UNIX and "<PWD>/locales" on Windows.
1308 # casemapping - The name of the casemapping sent to clients in the 005
1309 # numeric. If this is not set then it defaults to the name
1310 # of the casemapping file unless the file name contains a
1311 # space in which case you will have to specify it manually.
1312 #<nationalchars file="bynets/russian-w1251-charlink" casemapping="ru_RU.cp1251-charlink">
1314 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1315 # Nickchange flood protection module: Provides channel mode +F X:Y
1316 # which allows up to X nick changes in Y seconds.
1317 #<module name="nickflood">
1319 # The number of seconds to prevent nick changes for:
1320 #<nickflood duration="1m">
1322 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1323 # Nicklock module: Let opers change a user's nick and then stop that
1324 # user from changing their nick again until unlocked.
1325 # This module is oper-only.
1326 # To use, NICKLOCK and NICKUNLOCK must be in one of your oper class blocks.
1327 #<module name="nicklock">
1329 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1330 # No CTCP module: Adds the channel mode +C to block CTCPs and extban
1331 # 'C' to block CTCPs sent by specific users.
1332 #<module name="noctcp">
1334 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1335 # No kicks module: Adds the +Q channel mode and the Q: extban to deny
1336 # certain users from kicking.
1337 #<module name="nokicks">
1339 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1340 # No nicks module: Adds the +N channel mode, as well as the 'N' extban.
1341 # +N stops all users from changing their nick, the N extban stops
1342 # anyone from matching a +b N:nick!user@host mask from changing their
1344 #<module name="nonicks">
1346 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1347 # No part message module: Adds extban 'p' to block part messages from #
1349 #<module name="nopartmsg">
1351 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1352 # No notice module: Adds the channel mode +T and the extban 'T' to
1353 # block specific users from noticing the channel.
1354 #<module name="nonotice">
1356 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1357 # Network business join module:
1358 # Allows an oper to join a channel using /OJOIN, giving them +Y on the
1359 # channel which makes them immune to kick/deop/etc.
1360 #<module name="ojoin">
1362 # Specify the prefix that +Y will grant here.
1363 # Leave 'prefix' empty if you do not wish +Y to grant a prefix.
1364 # If 'notice' is set to on, upon /OJOIN, the server will notice the
1365 # channel saying that the oper is joining on network business.
1366 # If 'op' is set to on, it will give them +o along with +Y.
1367 #<ojoin prefix="!" notice="yes" op="yes">
1369 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1370 # Oper channels mode: Adds the +O channel mode and extban O:<mask>
1371 # to ban, except, etc. specific oper types. For example
1372 # /mode #channel +iI O:* is equivalent to channel mode +O, but you
1373 # may also set +iI O:AdminTypeOnly to only allow admins.
1374 # Modes +I and +e work in a similar fashion.
1375 #<module name="operchans">
1377 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1378 # Oper join module: Auto-joins opers to a channel upon oper-up.
1379 # This module is oper-only. For the user equivalent, see the conn_join
1381 #<module name="operjoin">
1383 #-#-#-#-#-#-#-#-#-#-# OPERJOIN CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
1385 # If you are using the operjoin module, specify options here: #
1387 # channel - The channel name to join, can also be a comma #
1388 # separated list e.g. "#channel1,#channel2". #
1390 # override - If on, lets the oper join walking thru any modes #
1391 # that might be set, even bans. #
1393 #<operjoin channel="#channel" override="no">
1395 # Alternatively you can use the autojoin="channellist" in a <type> #
1396 # tag to set specific autojoins for a type of oper, for example: #
1398 #<type name="Helper" autojoin="#help" classes="...">
1400 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1401 # Oper log module: Logs all oper commands to the server log (with log
1402 # type "m_operlog" at default loglevel), and optionally to the 'r'
1404 # This module is oper-only.
1405 #<module name="operlog">
1407 # If the following option is on then all oper commands will be sent to
1408 # the snomask 'r'. The default is off.
1409 #<operlog tosnomask="off">
1411 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1412 # Oper prefixing module: Adds a channel prefix mode +y which is given
1413 # to all IRC operators automatically on all channels they are in.
1414 # This prefix mode is more powerful than channel op and other regular
1417 # Load this module if you want all your IRC operators to have channel
1419 #<module name="operprefix">
1421 # You may additionally customise the prefix character.
1422 #<operprefix prefix="!">
1424 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1425 # Oper MOTD module: Provides support for separate message of the day
1427 # This module is oper-only.
1428 #<module name="opermotd">
1430 #-#-#-#-#-#-#-#-#-#-# OPERMOTD CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
1432 # If you are using the opermotd module, specify the motd here. #
1434 # onoper - If on, the message is sent on /OPER, otherwise it's #
1435 # only sent when /OPERMOTD is used. #
1437 #<opermotd file="examples/opermotd.txt.example" onoper="yes">
1439 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1440 # Override module: Adds support for oper override.
1441 # This module is oper-only.
1442 #<module name="override">
1444 #-#-#-#-#-#-#-#-#-#-# OVERRIDE CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
1446 # Much of override's configuration relates to your oper blocks. #
1447 # For more information on how to allow opers to override, see: #
1448 # https://wiki.inspircd.org/Modules/3.0/override #
1450 # noisy - If enabled, all oper overrides will be announced #
1451 # via channel notice. #
1453 # requirekey - If enabled, overriding on join requires a channel #
1454 # key of "override" to be specified #
1456 # enableumode - If enabled, usermode +O is required for override. #
1458 #<override noisy="yes" requirekey="no" enableumode="true">
1460 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1461 # Oper levels module: Gives each oper a level and prevents actions
1462 # being taken by lower level opers against higher level opers.
1463 # Specify the level as the 'level' parameter of the <type> tag.
1464 # This module is oper-only.
1465 #<module name="operlevels">
1467 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1468 # Oper modes module: Allows you to specify modes to add/remove on oper.
1469 # Specify the modes as the 'modes' parameter of the <type> tag
1470 # and/or as the 'modes' parameter of the <oper> tag.
1471 # This module is oper-only. For the user equivalent, see the
1472 # conn_umodes module.
1473 #<module name="opermodes">
1475 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1476 # Password forwarding module: Forwards a password users can send on
1477 # connect to the specified client below. The client is usually NickServ
1478 # and this module is usually used to authenticate users with NickServ
1479 # using their connect password.
1480 #<module name="passforward">
1483 # nick: nick to forward connect passwords to.
1486 # forwardmsg: Message to send to users using a connect password.
1487 # $nick will be the users' nick, $nickrequired will be the nick
1488 # of where the password is going (the nick above).
1489 # You can also use $user for the user ident string.
1490 forwardmsg="NOTICE $nick :*** Forwarding PASS to $nickrequired"
1492 # cmd: Command for the user to run when it receives a connect
1494 cmd="PRIVMSG $nickrequired :IDENTIFY $pass">
1496 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1497 # Password hash module: Allows hashed passwords to be used.
1498 # To be useful, a hashing module like bcrypt also needs to be loaded.
1499 #<module name="password_hash">
1501 #-#-#-#-#-#-#-#-#-# PASSWORD HASH CONFIGURATION #-#-#-#-#-#-#-#-#-#-#-#
1503 # To use this module, you must define a hash type for each oper's
1504 # password you want to hash. For example:
1506 # <oper name="Brain"
1507 # host="ident@dialup15.isp.test.com"
1509 # password="$2a$10$Mss9AtHHslZTLBrXqM0FB.JBwD.UTSu8A48SfrY9exrpxbsRiRTbO"
1512 # If you are using a hash algorithm which does not perform salting you can use
1513 # HMAC to salt your passwords in order to prevent them from being looked up in
1516 # hash="hmac-sha256" password="lkS1Nbtp$CyLd/WPQXizsbxFUTqFRoMvaC+zhOULEeZaQkUJj+Gg"
1518 # Generate hashes using the /MKPASSWD command on the server.
1519 # Don't run it on a server you don't trust with your password.
1521 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1522 # PBKDF2 module: Allows other modules to generate PBKDF2 hashes,
1523 # usually for cryptographic uses and security.
1524 # This module relies on other hash providers (e.g. SHA256).
1525 #<module name="pbkdf2">
1527 # iterations: Iterations the hashing function runs when generating new
1529 # length: Length in bytes of the derived key.
1530 #<pbkdf2 iterations="12288" length="32">
1531 # You can override these values with specific values
1532 # for specific providers if you want to. Example given for SHA256.
1533 #<pbkdf2prov hash="sha256" iterations="24576">
1535 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1536 # Permanent channels module: Channels with the permanent channel mode
1537 # will remain open even after everyone else has left the channel, and
1538 # therefore keep things like modes, ban lists and topic. Permanent
1539 # channels -may- need support from your Services package to function
1540 # properly with them. This adds channel mode +P.
1541 # This module is oper-only.
1542 #<module name="permchannels">
1544 # If you like, this module can write a config file of permanent channels
1545 # whenever +P is set, unset, or the topic/modes on a +P channel is changed.
1546 # If you want to do this, set the filename below, and uncomment the include.
1548 # If 'listmodes' is true then all list modes (+b, +I, +e, +g...) will be
1549 # saved. Defaults to false.
1550 #<permchanneldb filename="permchannels.conf" listmodes="true">
1551 #<include file="permchannels.conf">
1553 # You may also create channels on startup by using the <permchannels> block.
1554 #<permchannels channel="#opers" modes="isP" topic="Opers only.">
1556 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1557 # PostgreSQL module: Allows other SQL modules to access PgSQL databases
1558 # through a unified API.
1559 # This module is in extras. Re-run configure with:
1560 # ./configure --enable-extras=m_pgsql.cpp
1561 # and run make install, then uncomment this module to enable it.
1562 #<module name="pgsql">
1564 #-#-#-#-#-#-#-#-#-#-#-#- SQL CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#-#
1566 # pgsql is more complex than described here, see the wiki for #
1567 # more: https://wiki.inspircd.org/Modules/3.0/pgsql #
1569 #<database module="pgsql" name="mydb" user="myuser" pass="mypass" host="localhost" id="my_database" ssl="no">
1571 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1572 # Muteban: Implements extended ban 'm', which stops anyone matching
1573 # a mask like +b m:nick!user@host from speaking on channel.
1574 #<module name="muteban">
1576 # If notifyuser is set to no, the user will not be notified when
1577 # his/her message is blocked.
1578 #<muteban notifyuser="yes">
1580 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1581 # Random quote module: Provides a random quote on connect.
1582 # NOTE: Some of these may mimic fatal errors and confuse users and
1583 # opers alike - BEWARE!
1584 #<module name="randquote">
1586 #-#-#-#-#-#-#-#-#-#- RANDOMQUOTES CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
1588 # Optional - If you specify to use the randquote module, then specify #
1589 # below the path to the quotes file. #
1591 #<randquote file="quotes.txt">
1593 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1594 # Redirect module: Adds channel mode +L which redirects users to #
1595 # another channel when the channel has reached its user limit and #
1596 # user mode +L which stops redirection. #
1597 #<module name="redirect">
1599 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1600 # Regular expression provider for glob or wildcard (?/*) matching.
1601 # You must have at least 1 provider loaded to use the filter or rline
1602 # modules. This module has no additional requirements, as it uses the
1603 # matching already present in InspIRCd core.
1604 #<module name="regex_glob">
1606 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1607 # Regular expression provider for PCRE (Perl-Compatible Regular
1608 # Expressions). You need libpcre installed to compile and load this
1609 # module. You must have at least 1 provider loaded to use the filter or
1611 #<module name="regex_pcre">
1613 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1614 # Regular Expression Provider for RE2 Regular Expressions.
1615 # You need libre2 installed and in your include/library paths in order
1616 # to compile and load this module.
1617 #<module name="regex_re2">
1619 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1620 # Regular expression provider for POSIX regular expressions.
1621 # You shouldn't need any additional libraries on a POSIX-compatible
1622 # system (i.e.: any Linux, BSD, but not Windows). You must have at
1623 # least 1 provider loaded to use filter or rline.
1624 # On POSIX-compliant systems, regex syntax can be found by using the
1625 # command: 'man 7 regex'.
1626 #<module name="regex_posix">
1628 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1629 # Regular expression provider for C++11 std::regex regular expressions.
1630 # This module works on any fully compliant implementation of the C++11
1631 # std::regex container. Examples for such are Visual C++ 2010 and newer
1632 # but not libstdc++ (which GCC uses).
1633 # You should verify that std::regex is supported by your setup before
1634 # using this module, as it may compile normally but won't do anything
1635 # on some implementations.
1636 #<module name="regex_stdlib">
1638 # Specify the regular expression engine to use here. Valid settings are
1639 # bre, ere, awk, grep, egrep, ecmascript (default if not specified).
1640 #<stdregex type="ecmascript">
1642 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1643 # Regular expression provider for TRE regular expressions.
1644 # This is the same regular expression engine used by UnrealIRCd, so
1645 # if you are most familiar with the syntax of /SPAMFILTER from there,
1646 # this is the provider you want. You need libtre installed in order
1647 # to compile and load this module.
1648 #<module name="regex_tre">
1650 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1651 # Registered users only channel creation module. If enabled, only
1652 # registered users and opers can create new channels.
1654 # You probably *DO NOT* want to load this module on a public network.
1656 #<module name="regonlycreate">
1658 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1659 # Remove module: Adds the /REMOVE command which is a peaceful
1660 # alternative to /KICK.
1661 #<module name="remove">
1663 # supportnokicks: If true, /REMOVE is not allowed on channels where the
1664 # nokicks (+Q) mode is set. Defaults to false.
1665 # protectedrank: Members having this rank or above may not be /REMOVE'd
1666 # by anyone. Set to 0 to disable this feature. Defaults to 50000.
1667 #<remove supportnokicks="true" protectedrank="50000">
1669 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1670 # A module to block, kick or ban upon similar messages being uttered several times.
1671 # Syntax [~*][lines]:[sec]{[:difference]}{[:matchlines]}
1672 # ~ is to block, * is to ban, default is kick.
1673 # 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
1674 # seconds - How old the message has to be before it's invalidated.
1675 # distance - Edit distance, in percent, between two strings to trigger on.
1676 # matchlines - When set, the function goes into mode 2. In this mode the function will trigger if this many of the last <lines> matches.
1678 # As this module can be rather CPU-intensive, it comes with some options.
1679 # maxbacklog - Maximum size that can be specified for backlog. 0 disables multiline matching.
1680 # maxdistance - Max percentage of difference between two lines we'll allow to match. Set to 0 to disable edit-distance matching.
1681 # maxlines - Max lines of backlog to match against.
1682 # maxtime - Maximum period of time a user can set. 0 to allow any.
1683 # size - Maximum number of characters to check for, can be used to truncate messages
1684 # before they are checked, resulting in less CPU usage. Increasing this beyond 512
1685 # doesn't have any effect, as the maximum length of a message on IRC cannot exceed that.
1686 #<repeat maxbacklog="20" maxlines="20" maxdistance="50" maxtime="0" size="512">
1687 #<module name="repeat">
1689 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1690 # Restricted channels module: Allows only opers to create channels.
1692 # You probably *DO NOT* want to load this module on a public network.
1694 #<module name="restrictchans">
1696 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1697 # Restrict message module: Allows users to only message opers.
1699 # You probably *DO NOT* want to load this module on a public network.
1701 #<module name="restrictmsg">
1703 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1704 # R-Line module: Ban users through regular expression patterns.
1705 #<module name="rline">
1707 #-#-#-#-#-#-#-#-#-#-#-#- RLINE CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#-#
1709 # If you wish to re-check a user when they change nickname (can be
1710 # useful under some situations, but *can* also use CPU with more users
1711 # on a server) then set 'matchonnickchange' to yes.
1712 # Also, this is where you set what Regular Expression engine is to be
1713 # used. If you ever change it while running, all of your R-Lines will
1714 # be wiped. This is the regex engine used by all R-Lines set, and
1715 # regex_<engine> must be loaded, or rline will be non-functional
1716 # until you load it or change the engine to one that is loaded.
1718 #<rline matchonnickchange="yes" engine="pcre">
1720 # Generally, you will NOT want to use 'glob' here, as this turns
1721 # rline into just another gline. The exceptions are that rline will
1722 # always use the full "nick!user@host realname" string, rather than only
1723 # user@host, but beware that only the ? and * wildcards are available,
1724 # and are the only way to specify where the space can occur if you do
1725 # use glob. For this reason, is recommended to use a real regex engine
1726 # so that at least \s or [[:space:]] is available.
1728 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1729 # RMODE module: Adds the /RMODE command
1730 # Allows channel mods to remove list modes en masse.
1731 # Syntax: /rmode <channel> <mode> [pattern]
1732 # E.g. '/rmode #Channel b m:*' will remove all mute-extbans on the channel.
1733 #<module name="rmode">
1735 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1736 # SAJOIN module: Adds the /SAJOIN command which forcibly joins a user
1737 # to the given channel.
1738 # This module is oper-only.
1739 # To use, SAJOIN must be in one of your oper class blocks.
1740 # Opers need the users/sajoin-others priv to be able to /SAJOIN users
1741 # other than themselves.
1742 #<module name="sajoin">
1744 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1745 # SAKICK module: Adds the /SAKICK command which kicks a user from the
1747 # This module is oper-only.
1748 # To use, SAKICK must be in one of your oper class blocks.
1749 #<module name="sakick">
1751 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1752 # SAMODE module: Adds the /SAMODE command which allows server operators
1753 # to change modes on a channel without requiring them to have any
1754 # channel priviliges. Also allows changing user modes for any user.
1755 # This module is oper-only.
1756 # To use, SAMODE must be in one of your oper class blocks.
1757 #<module name="samode">
1759 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1760 # SANICK module: Adds the /SANICK command which allows opers to change
1762 # This module is oper-only.
1763 # To use, SANICK must be in one of your oper class blocks.
1764 #<module name="sanick">
1766 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1767 # SAPART module: Adds the /SAPART command which forcibly parts a user
1769 # This module is oper-only.
1770 # To use, SAPART must be in one of your oper class blocks.
1771 #<module name="sapart">
1773 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1774 # SAQUIT module: Adds the /SAQUIT command which forcibly quits a user.
1775 # This module is oper-only.
1776 # To use, SAQUIT must be in one of your oper class blocks.
1777 #<module name="saquit">
1779 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1780 # SATOPIC module: Adds the /SATOPIC command which allows changing the
1781 # topic on a channel without requiring any channel priviliges.
1782 # This module is oper-only.
1783 # To use, SATOPIC must be in one of your oper class blocks.
1784 #<module name="satopic">
1786 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1787 # SASL authentication module: Provides support for IRC Authentication
1788 # Layer via AUTHENTICATE. Note: You also need to have cap loaded
1790 #<module name="sasl">
1791 # Define the following to your services server name to improve security
1792 # by ensuring the SASL messages are only sent to the services server
1793 # and not to all connected servers. This prevents a rogue server from
1794 # capturing SASL messages and disables the SASL cap when services is
1796 #<sasl target="services.mynetwork.com">
1798 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1799 # Secure list module: Prevent /LIST in the first minute of connection,
1800 # crippling most spambots and trojan spreader bots.
1801 #<module name="securelist">
1803 #-#-#-#-#-#-#-#-#-# SECURELIST CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#-#
1805 # Securelist can be harmful to some IRC search engines. To prevent #
1806 # securelist blocking these sites from listing, define exception tags #
1808 #<securehost exception="*@*.netsplit.de">
1809 #<securehost exception="*@*.ircdriven.com">
1810 #<securehost exception="*@*.ircs.me">
1812 # Define the following variable to change how long a user must wait #
1813 # before issuing a LIST. If not defined, defaults to 60 seconds. #
1815 #<securelist waittime="1m"> #
1817 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1818 # Servprotect module: Provides support for Austhex style +k /
1819 # UnrealIRCD +S services mode.
1820 #<module name="servprotect">
1822 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1823 # See nicks module: Adds snomask +n and +N which show local and remote
1825 # This module is oper-only.
1826 #<module name="seenicks">
1828 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1829 # Set idle module: Adds a command for opers to change their idle time.
1830 # This module is oper-only.
1831 # To use, SETIDLE must be in one of your oper class blocks.
1832 #<module name="setidle">
1834 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1835 # Services support module: Adds several usermodes such as +R and +M.
1836 # This module implements the 'identified' state via account names,
1837 # and is similar in operation to the way asuka and ircu handle services.
1839 # At the same time, this offers +r for users and channels to mark them
1840 # as identified separately from the idea of a master account, which
1841 # can be useful for services which are heavily nick-as-account centric.
1843 # Also of note is that this module implements two extbans:
1844 # +b R: (stop matching account names from joining)
1845 # +b U:n!u@h (blocks matching unregistered users)
1847 #<module name="services_account">
1849 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1850 # Sethost module: Adds the /SETHOST command.
1851 # This module is oper-only.
1852 # To use, SETHOST must be in one of your oper class blocks.
1853 # See the chghost module for how to customise valid chars for hostnames.
1854 #<module name="sethost">
1856 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1857 # Setident module: Adds the /SETIDENT command.
1858 # This module is oper-only.
1859 # To use, SETIDENT must be in one of your oper class blocks.
1860 #<module name="setident">
1862 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1863 # SETNAME module: Adds the /SETNAME command.
1864 #<module name="setname">
1866 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1867 # Serverban: Implements extended ban 's', which stops anyone connected
1868 # to a server matching a mask like +b s:server.mask.here from joining.
1869 #<module name="serverban">
1871 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1872 # SHA1 module: Allows other modules to generate SHA1 hashes.
1873 # Required by the WebSocket module.
1874 #<module name="sha1">
1876 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1877 # Showfile: Provides support for showing a text file to users when #
1878 # they enter a command. #
1879 # This module adds one command for each <showfile> tag that shows the #
1880 # given file to the user as a series of messages or numerics. #
1881 #<module name="showfile"> #
1883 #-#-#-#-#-#-#-#-#-#-# SHOWFILE CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#-#
1885 # name - The name of the command which displays this file. This is #
1886 # the only mandatory setting, all others are optional. #
1887 # file - The text file to be shown to the user. #
1888 # By default same as the command name. #
1889 # method - How should the file be shown? #
1890 # * numeric: Send contents using a numeric #
1891 # (similar to /MOTD; the default). #
1892 # * notice: Send contents as a series of notices. #
1893 # * msg: Send contents as a series of private messages. #
1895 # When using the method "numeric", the following extra settings are #
1898 # introtext - Introductory line, "Showing <name>" by default. #
1899 # intronumeric - Numeric used for the introductory line. #
1900 # numeric - Numeric used for sending the text itself. #
1901 # endtext - Ending line, "End of <name>" by default. #
1902 # endnumeric - Numeric used for the ending line. #
1904 #<showfile name="RULES"
1906 # introtext="Server rules:"
1907 # endtext="End of server rules.">
1909 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1910 # Show whois module: Adds the +W usermode which allows opers to see
1911 # when they are /WHOIS'd.
1912 # This module is oper-only by default.
1913 #<module name="showwhois">
1915 # If you wish, you may also let users set this mode. Only opers with the
1916 # users/auspex priv will see real hosts of people, though.
1917 #<showwhois opersonly="yes"
1919 # You may also set whether or not users should receive whois notices,
1920 # should they be /WHOIS'd by an oper.
1921 #showfromopers="yes">
1923 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1924 # Shun module: Provides the /SHUN command, which stops a user from
1925 # executing all except configured commands.
1926 # This module is oper-only.
1927 # To use, SHUN must be in one of your oper class blocks.
1928 #<module name="shun">
1930 # You may also configure which commands you wish a user to be able to
1931 # perform when shunned. It should be noted that if a shunned user
1932 # issues QUIT or PART then their message will be removed, as if they
1933 # did not issue one.
1935 # You can optionally let the user know that their command was blocked.
1937 # You may also let SHUN affect opers (defaults to no).
1938 #<shun enabledcommands="ADMIN PING PONG QUIT PART JOIN" notifyuser="yes" affectopers="no">
1940 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1941 # SSL mode module: Adds support for SSL-only channels via the '+z'
1942 # channel mode, SSL-only private messages via the '+z' user mode and
1943 # the 'z:' extban which matches SSL client certificate fingerprints.
1945 # Does not do anything useful without a working SSL module and the
1946 # sslinfo module (see below).
1947 #<module name="sslmodes">
1949 # The +z user mode is not enabled by default to enable link compatibility
1950 # with 2.0 servers. You can enable it by uncommenting this:
1951 #<sslmodes enableumode="yes">
1953 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1954 # SSL rehash signal module: Allows the SSL modules to be rehashed by
1955 # sending SIGUSR1 to a running InspIRCd process.
1956 # This modules is in extras. Re-run configure with:
1957 # ./configure --enable-extras=m_sslrehashsignal.cpp
1958 # and run make install, then uncomment this module to enable it.
1959 #<module name="sslrehashsignal">
1961 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1962 # GnuTLS SSL module: Adds support for SSL connections using GnuTLS,
1963 # if enabled. You must answer 'yes' in ./configure when asked or
1964 # manually symlink the source for this module from the directory
1965 # src/modules/extra, if you want to enable this, or it will not load.
1966 #<module name="ssl_gnutls">
1968 #-#-#-#-#-#-#-#-#-#-#- GNUTLS CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#
1970 # ssl_gnutls is too complex to describe here, see the wiki: #
1971 # https://wiki.inspircd.org/Modules/3.0/ssl_gnutls #
1973 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1974 # SSL info module: Allows users to retrieve information about other
1975 # users' peer SSL certificates and keys. This can be used by client
1976 # scripts to validate users. For this to work, one of ssl_gnutls
1977 # or ssl_openssl must be loaded. This module also adds the
1978 # "* <user> is using a secure connection" whois line, the ability for
1979 # opers to use SSL cert fingerprints to verify their identity and the
1980 # ability to force opers to use SSL connections in order to oper up.
1981 # It is highly recommended to load this module if you use SSL on your
1983 # For how to use the oper features, please see the first example <oper> tag
1984 # in opers.conf.example.
1986 #<module name="sslinfo">
1988 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1989 # mbedTLS SSL module: Adds support for SSL/TLS connections using mbedTLS.
1990 #<module name="ssl_mbedtls">
1992 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1993 # OpenSSL SSL module: Adds support for SSL connections using OpenSSL,
1994 # if enabled. You must answer 'yes' in ./configure when asked or symlink
1995 # the source for this module from the directory src/modules/extra, if
1996 # you want to enable this, or it will not load.
1997 #<module name="ssl_openssl">
1999 #-#-#-#-#-#-#-#-#-#-#- OPENSSL CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#
2001 # ssl_openssl is too complex to describe here, see the wiki: #
2002 # https://wiki.inspircd.org/Modules/3.0/ssl_openssl #
2004 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2005 # Strip color module: Adds channel mode +S that strips color codes and
2006 # all control codes except CTCP from all messages sent to the channel.
2007 #<module name="stripcolor">
2009 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2010 # Silence module: Adds support for the /SILENCE command, which allows
2011 # users to have a server-side ignore list for their client.
2012 #<module name="silence">
2014 # Set the maximum number of entries allowed on a user's silence list.
2015 #<silence maxentries="32"
2017 # Whether messages from U-lined servers will bypass silence masks.
2020 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2021 # SQLite3 module: Allows other SQL modules to access SQLite3 #
2022 # databases through a unified API. #
2023 # This module is in extras. Re-run configure with: #
2024 # ./configure --enable-extras=m_sqlite3.cpp
2025 # and run make install, then uncomment this module to enable it. #
2027 #<module name="sqlite3">
2029 #-#-#-#-#-#-#-#-#-#-#-#- SQL CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#-#
2031 # sqlite is more complex than described here, see the wiki for more #
2032 # info: https://wiki.inspircd.org/Modules/3.0/sqlite3 #
2034 #<database module="sqlite" hostname="/full/path/to/database.db" id="anytext">
2036 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2037 # SQL authentication module: Allows IRCd connections to be tied into
2038 # a database table (for example a forum).
2040 #<module name="sqlauth">
2042 #-#-#-#-#-#-#-#-#-#-#- SQLAUTH CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#
2044 # sqlauth is too complex to describe here, see the wiki: #
2045 # https://wiki.inspircd.org/Modules/3.0/sqlauth #
2047 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2048 # SQL oper module: Allows you to store oper credentials in an SQL
2049 # table. You can add additional table columns like you would config
2050 # tags in opers.conf. Opers in opers.conf will override opers from
2053 #<module name="sqloper">
2055 #-#-#-#-#-#-#-#-#-#-#- SQLOPER CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#
2057 # dbid - Database ID to use (see SQL modules). #
2059 # See also: https://wiki.inspircd.org/Modules/3.0/sqloper #
2063 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2064 # StartTLS module: Implements STARTTLS, which allows clients #
2065 # connected to non SSL enabled ports to enable SSL, if a proper SSL #
2066 # module is loaded (either ssl_gnutls or ssl_openssl). #
2067 #<module name="starttls">
2069 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2070 # SVSHold module: Implements SVSHOLD. Like Q:Lines, but can only be #
2071 # added/removed by Services. #
2072 #<module name="svshold">
2073 # SVSHOLD does not generate server notices by default, you can turn
2074 # notices on by uncommenting the next line.
2075 #<svshold silent="false">
2077 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2078 # SWHOIS module: Allows you to add arbitrary lines to user WHOIS.
2079 # This module is oper-only.
2080 # To use, SWHOIS must be in one of your oper class blocks.
2081 #<module name="swhois">
2083 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2084 # Timed bans module: Adds timed channel bans with the /TBAN command.
2085 #<module name="timedbans">
2087 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2088 # Test line module: Adds the /TLINE command, used to test how many
2089 # users a /GLINE or /ZLINE etc. would match.
2090 # This module is oper-only.
2091 # To use, TLINE must be in one of your oper class blocks.
2092 #<module name="tline">
2094 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2095 # Topiclock module: implements server-side topic locking to achieve deeper
2096 # integration with services packages.
2097 #<module name="topiclock">
2099 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2100 # UHNAMES support module: Adds support for the IRCX style UHNAMES
2101 # extension, which displays ident and hostname in the names list for
2102 # each user, saving clients from doing a WHO on the channel.
2103 # If a client does not support UHNAMES it will not enable it, this will
2104 # not break incompatible clients.
2105 #<module name="uhnames">
2107 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2108 # Uninvite module: Adds the /UNINVITE command which lets users remove
2109 # pending invites from channels without waiting for the user to join.
2110 #<module name="uninvite">
2112 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2113 # Userip module: Adds the /USERIP command.
2114 # Allows users to query their own IP, also allows opers to query the IP
2116 #<module name="userip">
2118 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2119 # Vhost module: Adds the VHOST command which allows for adding virtual
2120 # hosts which are accessible using a username and password in the config.
2121 #<module name="vhost">
2123 #-#-#-#-#-#-#-#-#-#-#- VHOST CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#-#
2125 # user - Username for the vhost. #
2127 # pass - Password for the vhost. #
2129 # hash - The hash for the specific user (optional) #
2130 # password_hash and a hashing module must be loaded for #
2133 # host - Vhost to set. #
2135 #<vhost user="some_username" pass="some_password" host="some.host.test.cc">
2136 #<vhost user="foo" password="$2a$10$iTuYLT6BRhRlOgzfsW9oPe62etW.oXwSpyKw5rJit64SGZanLXghO" hash="bcrypt" host="some.other.host.example.com">
2138 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2139 # Watch module: Adds the WATCH command, which is used by clients to
2140 # maintain notify lists.
2141 #<module name="watch">
2143 # Set the maximum number of entries on a user's watch list below.
2144 #<watch maxentries="32">
2146 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2147 # WebSocket module: Adds HTML5 WebSocket support.
2148 # Specify hook="websocket" in a <bind> tag to make that port accept
2149 # WebSocket connections. Compatible with SSL/TLS.
2150 # Requires SHA-1 hash support available in the sha1 module.
2151 #<module name="websocket">
2153 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2154 # XLine database: Stores all *Lines (G/Z/K/R/any added by other modules)
2155 # in a file which is re-loaded on restart. This is useful
2156 # for two reasons: it keeps bans so users may not evade them, and on
2157 # bigger networks, server connections will take less time as there will
2158 # be a lot less bans to apply - as most of them will already be there.
2159 #<module name="xline_db">
2161 # Specify the filename for the xline database here.
2162 #<xlinedb filename="xline.db">
2164 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2165 # ____ _ _____ _ _ ____ _ _ _ #
2166 # | _ \ ___ __ _ __| | |_ _| |__ (_)___ | __ )(_) |_| | #
2167 # | |_) / _ \/ _` |/ _` | | | | '_ \| / __| | _ \| | __| | #
2168 # | _ < __/ (_| | (_| | | | | | | | \__ \ | |_) | | |_|_| #
2169 # |_| \_\___|\__,_|\__,_| |_| |_| |_|_|___/ |____/|_|\__(_) #
2171 # To link servers to InspIRCd, you MUST load the spanningtree module. #
2172 # If you don't do this, server links will NOT work at all. #
2173 # This is by design, to allow for the implementation of other linking #
2174 # protocols in modules in the future. #
2176 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2177 # Spanning tree module: Allows linking of servers using the spanning
2178 # tree protocol (see the READ THIS BIT section above).
2179 # You will almost always want to load this.
2181 #<module name="spanningtree">
projects / user / henk / code / inspircd.git / blob