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