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