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 their #
291 # /ACCEPT list. Default is 30 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 their nickname changes. #
295 # cooldown - Amount of time that must pass since the last #
296 # notification sent to a user before they can be #
297 # sent another. Default is 1 minute. #
298 #<callerid maxaccepts="30"
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 which block phrases that
316 # are listed in the server bad words list.
317 #<module name="censor">
319 #-#-#-#-#-#-#-#-#-#-#- CENSOR CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#
321 # If you have the censor module loaded you should specify one or more #
322 # phrases to replace/block in user messages. The config for this is #
323 # formatted as follows: #
325 # Replaces "eggplant" with "aubergine" within messages: #
326 # <badword text="eggplant" replace="aubergine"> #
328 # Blocks messages that contain "fluffy capybaras": #
329 #<badword text="fluffy capybaras"> #
331 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
332 # CGI:IRC module: Enables forwarding the real IP address of a user from
333 # a gateway to the IRC server.
334 #<module name="cgiirc">
336 #-#-#-#-#-#-#-#-#-#-#-# CGIIRC CONFIGURATION #-#-#-#-#-#-#-#-#-#-#-#-#
338 # If you use the cgiirc module then you must specify the gateways which
339 # are authorised to forward IP/host information to your server. There
340 # are currently two ways to do this:
342 # The webirc method is the recommended way to allow gateways to forward
343 # IP/host information. When using this method the gateway sends a WEBIRC
344 # message to the server on connection. For more details please read the
345 # IRCv3 WebIRC specification at http://ircv3.net/specs/extensions/webirc.html.
347 # When using this method you must specify a wildcard mask or CIDR range
348 # to allow gateway connections from and at least one of either a SSL
349 # client certificate fingerprint for the gateway or a password to be
350 # sent in the WEBIRC command.
352 # <cgihost type="webirc"
353 # fingerprint="bd90547b59c1942b85f382bc059318f4c6ca54c5"
354 # mask="192.0.2.0/24">
355 # <cgihost type="webirc"
356 # password="$2a$10$WEUpX9GweJiEF1WxBDSkeODBstIBMlVPweQTG9cKM8/Vd58BeM5cW"
358 # mask="*.webirc.gateway.example.com">
360 # Alternatively if your gateway does not support sending the WEBIRC
361 # message then you can configure InspIRCd to look for the client IP
362 # address in the ident sent by the user. This is not recommended as it
363 # only works with IPv4 connections.
365 # When using this method you must specify a wildcard mask or CIDR range to allow
366 # gateway connections from. You can also optionally configure the static value
367 # that replaces the IP in the ident to avoid leaking the real IP address of
368 # gateway clients (defaults to "gateway" if not set).
370 # <cgihost type="ident"
371 # mask="198.51.100.0/24"
373 # <cgihost type="ident"
374 # mask="*.ident.gateway.example.com"
377 # By default gateway connections are logged to the +w snomask. If you
378 # do not want this to happen then you can uncomment this to disable it.
379 # <cgiirc opernotice="no">
384 # When you connect gateway clients, there are two connect classes which
385 # apply to these clients. When the client initially connects, the connect
386 # class which matches the gateway site's host is checked. Therefore you
387 # must raise the maximum local/global clients for this IP as high as you
388 # want to allow gateway clients. After the client has connected and is
389 # determined to be a gateway client, the class which matches the client's
390 # real IP is then checked. You may set this class to a lower value, so that
391 # the real IP of the client can still be restricted to, for example, 3
394 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
395 # Channel create module: Adds snomask +j, which will notify opers of
396 # any new channels that are created.
397 # This module is oper-only.
398 #<module name="chancreate">
400 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
401 # Channel filter module: Allows channel-op defined message filtering
402 # using simple string matches (channel mode +g).
403 #<module name="chanfilter">
405 # If hidemask is set to yes, the user will not be shown the mask when
406 # his/her message is blocked.
408 # If maxlen is set then it defines the maximum length of a filter entry.
410 # If notifyuser is set to no, the user will not be notified when
411 # his/her message is blocked.
412 #<chanfilter hidemask="yes" maxlen="50" notifyuser="yes">
414 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
415 # Channel history module: Displays the last 'X' lines of chat to a user
416 # joining a channel with +H 'X:T' set; 'T' is the maximum time to keep
417 # lines in the history buffer. Designed so that the new user knows what
418 # the current topic of conversation is when joining the channel.
419 #<module name="chanhistory">
421 # Set the maximum number of lines allowed to be stored per channel below.
422 # This is the hard limit for 'X'.
423 # If notice is set to yes, joining users will get a NOTICE before playback
424 # telling them about the following lines being the pre-join history.
425 # If bots is set to yes, it will also send to users marked with +B
426 #<chanhistory maxlines="50" notice="yes" bots="yes">
428 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
429 # Channel logging module: Used to send snotice output to channels, to
430 # allow staff to centrally monitor and discuss network activity.
432 # The "channel" field is where you want the messages to go, "snomasks"
433 # is what snomasks you want to be sent to that channel. Multiple tags
435 #<module name="chanlog">
436 #<chanlog snomasks="AOcC" channel="#opers">
438 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
439 # Channel names module: Allows disabling channels which have certain
440 # characters in the channel name such as bold, colorcodes, etc. which
441 # can be quite annoying and allow users to on occasion have a channel
442 # that looks like the name of another channel on the network.
443 #<module name="channames">
446 # denyrange: characters or range of characters to deny in channel
450 # allowrange: characters or range of characters to specifically allow
454 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
455 # Channelban: Implements extended ban j:, which stops anyone already
456 # in a channel matching a ban like +b j:#channel*mask from joining.
457 # Note that by default wildcard characters * and ? are allowed in
458 # channel names. To disallow them, load m_channames and add characters
459 # 42 and 63 to denyrange (see above).
460 #<module name="channelban">
462 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
463 # Check module: Adds the /CHECK command.
464 # Check is useful for looking up information on channels, users,
465 # IP addresses and hosts.
466 # This module is oper-only.
467 # To use, CHECK must be in one of your oper class blocks.
468 #<module name="check">
470 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
471 # CHGHOST module: Adds the /CHGHOST command.
472 # This module is oper-only.
473 # To use, CHGHOST must be in one of your oper class blocks.
474 # NOTE: Services will not be able to set vhosts on users if this module
475 # isn't loaded. If you're planning on running services, you probably
477 #<module name="chghost">
479 #-#-#-#-#-#-#-#-# /CHGHOST - /SETHOST CONFIGURATION #-#-#-#-#-#-#-#-#
480 # Optional - If you want to use special chars for hostnames you can #
481 # specify your own custom list of chars with the <hostname> tag: #
483 # charmap - A list of chars accepted as valid by the /CHGHOST #
484 # and /SETHOST commands. Also note that the list is #
486 #<hostname charmap="abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ.-_/0123456789">
488 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
489 # CHGIDENT module: Adds the /CHGIDENT command.
490 # This module is oper-only.
491 # To use, CHGIDENT must be in one of your oper class blocks.
492 #<module name="chgident">
494 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
495 # CHGNAME module: Adds the /CHGNAME command.
496 # This module is oper-only.
497 # To use, CHGNAME must be in one of your oper class blocks.
498 #<module name="chgname">
500 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
501 # Connection class ban module: Adds support for extban 'n' which
502 # matches against the class name of the user's connection.
503 # This module assumes that connection classes are named in a uniform
504 # way on all servers of the network.
505 #<module name="classban">
507 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
508 # Clear chan module: Allows opers to masskick, masskill or
509 # mass G/Z-line all users on a channel using /CLEARCHAN.
510 #<module name="clearchan">
512 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
513 # Cloaking module: Adds usermode +x and cloaking support.
514 # Relies on the md5 module being loaded.
515 # To cloak users when they connect, load the conn_umodes module and set
516 # <connect:modes> to include the +x mode. The example <connect> tag
517 # shows this. See the conn_umodes module for more information.
518 #<module name="cloaking">
520 #-#-#-#-#-#-#-#-#-#-#- CLOAKING CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#
522 # To use cloaking, you must define a cloak key, and optionally a #
523 # cloak prefix as shown below. The cloak key must be shared across #
524 # the network for consistent cloaking and must be at least thirty #
527 # There are two methods of cloaking: #
529 # half Cloak only the "unique" portion of a host; by #
530 # default show the last 2 parts of the domain, #
531 # /16 subnet of IPv4 or /48 subnet of the IPv6 #
533 # To change the number of shown parts, modify the #
534 # domainparts option. #
536 # full Cloak the users completely, using three slices for #
537 # common CIDR bans (IPv4: /16, /24; IPv6: /48, /64). #
539 # The methods use a single key that can be any length of text. #
540 # An optional prefix may be specified to mark cloaked hosts. #
542 # IMPORTANT: Changing these details will break all of your existing #
543 # bans. If you do not want this to happen you can define multiple #
544 # cloak tags. The first will be used for cloaking and the rest will #
545 # be used for checking if a user is banned in a channel. #
546 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
557 #-#-#-#-#-#-#-#-#-#-#-#- CLOSE MODULE #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
558 # Close module: Allows an oper to close all unregistered connections.
559 # This module is oper-only and provides the /CLOSE command.
560 # To use, CLOSE must be in one of your oper class blocks.
561 #<module name="close">
563 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
564 # Clones module: Adds an oper command /CLONES for detecting cloned
565 # users. Warning: This command may be resource intensive when it is
566 # issued, use with care.
567 # This module is oper-only.
568 # To use, CLONES must be in one of your oper class blocks.
569 #<module name="clones">
571 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
572 # Common channels module: Adds user mode +c, which, when set, requires
573 # that users must share a common channel with you to PRIVMSG or NOTICE
575 #<module name="commonchans">
577 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
578 # Auto join on connect module: Allows you to force users to join one
579 # or more channels automatically upon connecting to the server, or
580 # join them in case they aren't on any channels after being online
582 #<module name="conn_join">
584 #-#-#-#-#-#-#-#-#-#-#-#- CONNJOIN CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
586 # If you have the conn_join module loaded, you can configure it below
587 # or set autojoin="#chat,#help" in <connect> blocks.
589 # Join users immediately after connection to #one #two and #three.
590 #<autojoin channel="#one,#two,#three">
591 # Join users to #chat after 15 seconds if they aren't on any channels.
592 #<autojoin channel="#chat" delay="15">
594 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
595 # Set modes on connect module: When this module is loaded <connect>
596 # blocks may have an optional modes="" value, which contains modes to
597 # add or remove from users when they connect to the server.
598 #<module name="conn_umodes">
600 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
601 # Wait for PONG on connect module: Send a PING to all connecting users
602 # and don't let them connect until they reply with a PONG.
603 # This is useful to stop certain kinds of bots and proxies.
604 #<module name="conn_waitpong">
606 #-#-#-#-#-#-#-#-#-#-#- WAITPONG CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
608 # If you have the conn_waitpong module loaded, configure it with the #
611 # sendsnotice - Whether to send a helpful notice to users on #
612 # connect telling them how to connect, should #
613 # their client not reply PONG automatically. #
615 # killonbadreply - Whether to kill the user if they send the wrong #
618 #<waitpong sendsnotice="yes" killonbadreply="yes">
620 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
621 # Channel cycle module: Adds the /CYCLE command which is a server-side
622 # /HOP that bypasses restrictive modes.
623 #<module name="cycle">
625 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
626 # Connectban: Provides IP connection throttling. Any IP range that
627 # connects too many times (configurable) in an hour is Z-lined for a
628 # (configurable) duration, and their count resets to 0.
629 #<module name="connectban">
631 # ipv4cidr and ipv6cidr allow you to turn the comparison from
632 # individual IP addresses (32 and 128 bits) into CIDR masks, to allow
633 # for throttling over whole ISPs/blocks of IPs, which may be needed to
636 # This allows for 10 connections in an hour with a 10 minute ban if
638 #<connectban threshold="10" duration="10m" ipv4cidr="32" ipv6cidr="128"
639 # A custom ban message may optionally be specified.
640 # 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.">
642 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
643 # Connection throttle module.
644 #<module name="connflood">
646 #-#-#-#-#-#-#-#-#-#-#- CONNTHROTTLE CONFIGURATION -#-#-#-#-#-#-#-#-#-#
647 # period, maxconns - Amount of connections per <period>.
649 # timeout - Time to wait after the throttle was activated
650 # before deactivating it. Be aware that the time
651 # is seconds + timeout.
653 # quitmsg - The message that users get if they attempt to
654 # connect while the throttle is active.
656 # bootwait - Amount of time in seconds to wait before enforcing
657 # the throttling when the server just booted.
659 #<connflood seconds="30" maxconns="3" timeout="30"
660 # quitmsg="Throttled" bootwait="10">
662 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
663 # Custom prefixes: Allows for channel prefixes to be configured.
664 #<module name="customprefix">
666 # name The name of the mode, must be unique from other modes.
667 # letter The letter used for this mode. Required.
668 # prefix The prefix used for nicks with this mode. Not required.
669 # rank A numeric rank for this prefix, defining what permissions it gives.
670 # The rank of voice, halfop and op is 10000, 20000, and 30000,
672 # ranktoset The numeric rank required to set this mode. Defaults to rank.
673 # ranktounset The numeric rank required to unset this mode. Defaults to ranktoset.
674 # depriv Can you remove the mode from yourself? Defaults to yes.
675 #<customprefix name="founder" letter="q" prefix="~" rank="50000" ranktoset="50000">
676 #<customprefix name="admin" letter="a" prefix="&" rank="40000" ranktoset="50000">
677 #<customprefix name="halfop" letter="h" prefix="%" rank="20000" ranktoset="30000">
679 # You can also override the configuration of prefix modes added by both the core
680 # and other modules by adding a customprefix tag with change="yes" specified.
681 # <customprefix name="op" change="yes" rank="30000" ranktoset="30000">
682 # <customprefix name="voice" change="yes" rank="10000" ranktoset="10000" depriv="no">
684 # Do /RELOADMODULE customprefix after changing the settings of this module.
686 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
687 # Custom title module: Adds the /TITLE command which allows for trusted
688 # users to gain a custom whois line and an optional vhost can be
690 #<module name="customtitle">
692 #-#-#-#-#-#-#-#-#-#- CUSTOM TITLE CONFIGURATION -#-#-#-#-#-#-#-#-#-#
693 # name - The username used to identify.
694 # password - The password used to identify.
695 # hash - The hash for the specific user's password (optional).
696 # password_hash and a hashing module must be loaded
698 # host - Allowed hostmask (optional).
699 # title - Title shown in whois.
700 # vhost - Displayed host (optional).
702 #<title name="foo" password="bar" title="Official Chat Helper">
703 #<title name="bar" password="foo" host="ident@test.org" title="Official Chat Helper" vhost="helper.test.org">
704 #<title name="foo" password="$2a$10$UYZ4OcO8NNTCCGyCdY9SK.2GHiqGgxZfHFPOPmWuxEVWVQTtoDC7C" hash="bcrypt" title="Official Chat Helper">
706 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
707 # DCCALLOW module: Adds the /DCCALLOW command.
708 #<module name="dccallow">
710 #-#-#-#-#-#-#-#-#-#-#- DCCALLOW CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
711 # blockchat - Whether to block DCC CHAT as well as DCC SEND.
712 # length - Default duration of entries in DCCALLOW list.
713 # action - Default action to take if no action is
714 # specified, can be 'block' or 'allow'.
715 # maxentries - Max number of nicks to allow on a DCCALLOW list.
717 # File configuration:
718 # pattern - The glob pattern to match against.
719 # action - Action to take if a user attempts to send a file
720 # that matches this pattern, can be 'block' or
723 #<dccallow blockchat="yes" length="5m" action="block" maxentries="20">
724 #<banfile pattern="*.exe" action="block">
725 #<banfile pattern="*.txt" action="allow">
727 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
728 # Deaf module: Adds support for the usermode +d - deaf to channel
729 # messages and channel notices.
730 #<module name="deaf">
732 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
733 # Delay join module: Adds the channel mode +D which delays all JOIN
734 # messages from users until they speak. If they quit or part before
735 # speaking, their quit or part message will not be shown to the channel
736 # which helps cut down noise on large channels in a more friendly way
737 # than the auditorium mode. Only channel ops may set the +D mode.
738 #<module name="delayjoin">
740 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
741 # Delay message module: Adds the channel mode +d which disallows a user
742 # from talking in the channel unless they've been joined for X seconds.
743 # Settable using /MODE #chan +d 30
744 #<module name="delaymsg">
745 # Set allownotice to no to disallow NOTICEs too. Defaults to yes.
746 #<delaymsg allownotice="no">
748 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
749 # Deny channels module: Deny channels from being used by users.
750 #<module name="denychans">
752 #-#-#-#-#-#-#-#-#-#-#- DENYCHAN DEFINITIONS -#-#-#-#-#-#-#-#-#-#-#-#
754 # If you have the denychans module loaded, you need to specify the #
755 # channels to deny: #
757 # name - The channel name to deny (glob masks are ok). #
758 # allowopers - If operators are allowed to override the deny. #
759 # reason - Reason given for the deny. #
760 # redirect - Redirect the user to a different channel. #
762 #<badchan name="#gods*" allowopers="yes" reason="Tortoises!"> #
763 #<badchan name="#chan1" redirect="#chan2" reason="Chan1 is closed"> #
765 # Redirects will not work if the target channel is set +L. #
767 # Additionally, you may specify channels which are allowed, even if #
768 # a badchan tag specifies it would be denied: #
769 #<goodchan name="#funtimes"> #
770 # Glob masks are accepted here also. #
772 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
773 # Disable module: Provides support for disabling commands and modes. #
774 #<module name="disable">
776 #-#-#-#-#-#-#-#-#-#-#-#- DISABLE CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#
778 # If you have the disable module loaded then you need to specify the #
779 # commands and modes that you want disabled. Users who have not fully #
780 # connected yet are exempt from this module so you can e.g. disable #
781 # the NICK command but still allow users to connect to the server. #
783 # commands - A space-delimited list of commands that can not be used #
784 # by users. You can exempt server operators from this with #
785 # the servers/use-disabled-commands privilege. #
787 # chanmodes - One or more channel modes that can not be added/removed #
788 # by users. You can exempt server operators from this #
789 # with the servers/use-disabled-commands privilege. #
791 # usermodes - One or more user modes that can not be added/removed by #
792 # users. You can exempt server operators from this with #
793 # the servers/use-disabled-commands privilege. #
795 # fakenonexistent - Whether to pretend that a disabled command/mode #
796 # does not exist when executed/changed by a user. #
799 # notifyopers - Whether to send a notice to snomask `a` when a user #
800 # is prevented from using a disabled command/mode. #
803 #<disabled commands="KICK TOPIC" #
806 # fakenonexistent="yes" #
807 # notifyopers="no"> #
809 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
810 # DNS blacklist module: Provides support for looking up IPs on one or #
812 #<module name="dnsbl"> #
814 # For configuration options please see the wiki page for dnsbl at #
815 # https://wiki.inspircd.org/Modules/3.0/dnsbl #
817 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
818 # Exempt channel operators module: Provides support for allowing #
819 # users of a specified channel status to be exempt from some channel #
820 # restriction modes. Supported restrictions are #
821 # blockcaps, blockcolor, censor, filter, flood, nickflood, noctcp, #
822 # nonick, nonotice, regmoderated, stripcolor, and topiclock. #
823 # See <options:exemptchanops> in inspircd.conf.example for a more #
824 # detailed list of the restriction modes that can be exempted. #
825 # These are settable using /mode #chan +X <restriction>:<status> #
826 #<module name="exemptchanops"> #
828 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
829 # Filter module: Provides message filtering, similar to SPAMFILTER. #
830 #<module name="filter">
832 # This module depends upon a regex provider such as regex_pcre or #
833 # regex_glob to function. You must specify which of these you want #
834 # the filter module to use via the tag below. #
836 # Valid engines are: #
838 # glob - Glob patterns, provided via regex_glob. #
839 # pcre - PCRE regexps, provided via regex_pcre, needs libpcre. #
840 # tre - TRE regexps, provided via regex_tre, requires libtre. #
841 # posix - POSIX regexps, provided via regex_posix, not available #
842 # on Windows, no dependencies on other operating systems. #
843 # stdlib - stdlib regexps, provided via regex_stdlib, see comment #
844 # at the <module> tag for info on availability. #
846 # If notifyuser is set to no, the user will not be notified when #
847 # his/her message is blocked. #
848 #<filteropts engine="glob" notifyuser="yes">
850 # Your choice of regex engine must match on all servers network-wide. #
852 # To learn more about the configuration of this module, read #
853 # examples/filter.conf.example, which covers the various types of #
854 # filters and shows how to add exemptions. #
856 #-#-#-#-#-#-#-#-#-#-#- FILTER CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#
858 # Optional - If you specify to use the filter module, then #
859 # specify below the path to the filter.conf file, or define some #
862 #<include file="examples/filter.conf.example">
864 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
865 # Flash Policy Daemon module: Allows Flash IRC clients (e.g. LightIRC)#
866 # to connect. If no file is specified, it'll serve a default policy #
867 # allowing all IPs to connect to all plaintext IRC ports #
868 #<bind address="" port="8430" type="flashpolicyd"> #
869 #<flashpolicyd timeout="5" file=""> #
870 #<module name="flashpolicyd"> #
872 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
873 # Real name ban: Implements two extended bans: #
874 # 'a', which matches a n!u@h+realname mask like +b a:*!*@host+*real* #
875 # 'r', which matches a realname mask like +b r:*realname?here* #
876 #<module name="gecosban">
878 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
879 # GeoIP module: Allows the server admin to match users by country code.
880 # This module is in extras. Re-run configure with:
881 # ./configure --enable-extras=m_geoip.cpp
882 # and run make install, then uncomment this module to enable it.
883 # This module requires GeoIP to be installed on your system,
884 # use your package manager to find the appropriate packages
885 # or check the InspIRCd wiki page for this module.
886 #<module name="geoip">
888 # The actual allow/ban actions are done by connect classes, not by the
889 # GeoIP module. An example connect class to ban people from russia or
892 # <connect deny="*" geoip="TR,RU">
894 # If enabled you can also ban people from channnels by country code
895 # using the G: extban (e.g. /mode #channel +b G:US).
896 # <geoip extban="yes">
898 # The country code must be in capitals and should be an ISO country
899 # code such as TR, GB, or US. Unknown IPs (localhost, LAN IPs, etc)
900 # will be assigned the country code "UNK". Since connect classes are
901 # matched from top down, your deny classes must be above your allow
902 # classes for them to match.
904 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
905 # Globops module: Provides the /GLOBOPS command and snomask +g.
906 # This module is oper-only.
907 # To use, GLOBOPS must be in one of your oper class blocks.
908 #<module name="globops">
910 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
911 # Global load module: Allows loading and unloading of modules network-
912 # wide (USE WITH EXTREME CAUTION!)
913 # This module is oper-only and provides /GLOADMODULE, /GUNLOADMODULE
914 # and /GRELOADMODULE.
915 # To use, GLOADMODULE, GUNLOADMODULE and GRELOADMODULE
916 # must be in one of your oper class blocks.
917 #<module name="globalload">
919 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
920 # HAProxy module: Adds support for the HAProxy PROXY v2 protocol. To
921 # use this module specify hook="haproxy" in the <bind> tag that HAProxy
922 # has been configured to connect to.
923 #<module name="haproxy">
925 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
926 # HELPOP module: Provides the /HELPOP command
927 #<module name="helpop">
929 #-#-#-#-#-#-#-#-#-#-#-#- HELPOP CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
931 # If you specify to use the helpop module, then specify below the #
932 # path to the helpop.conf file. #
934 #<include file="examples/helpop-full.conf.example">
936 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
937 # Hide chans module: Allows users to hide their channels list from non-
938 # opers by setting user mode +I on themselves.
939 #<module name="hidechans">
941 # This mode can optionally prevent opers from seeing channels on a +I
942 # user, for more privacy if set to true.
943 # This setting is not recommended for most mainstream networks.
944 #<hidechans affectsopers="false">
946 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
947 # Hide list module: Allows for hiding the list of listmodes from users
948 # who do not have sufficient channel rank.
949 #<module name="hidelist">
951 # Each <hidelist> tag configures one listmode to hide.
952 # mode: Name of the listmode to hide.
953 # rank: Minimum rank required to view the list. If set to 0, all
954 # members of the channel may view the list, but non-members may not.
955 # The rank of the built-in op and voice mode is 30000 and 10000,
956 # respectively; the rank of other prefix modes is configurable.
959 # Hiding the ban list is not recommended because it may break some
962 # Hide filter (+g) list:
963 #<hidelist mode="filter" rank="30000">
964 # Only show invite exceptions (+I) to channel members:
965 #<hidelist mode="invex" rank="0">
967 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
968 # Hide mode module: Allows for hiding mode changes from users who do not
969 # have sufficient channel privileges.
970 #<module name="hidemode">
972 # Hide bans (+b) from people who are not voiced:
973 #<hidemode mode="ban" rank="10000">
975 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
976 # Hide oper module: Allows opers to hide their oper status from non-
977 # opers by setting user mode +H on themselves.
978 # This module is oper-only.
979 #<module name="hideoper">
981 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
982 # Hostchange module: Allows a different style of cloaking.
983 #<module name="hostchange">
985 #-#-#-#-#-#-#-#-#-#-#- HOSTCHANGE CONFIGURATION -#-#-#-#-#-#-#-#-#-#
987 # See https://wiki.inspircd.org/Modules/3.0/hostchange for help. #
989 #<hostchange mask="*@42.theanswer.example.org" action="addaccount" suffix=".users.example.com">
990 #<hostchange mask="*root@*" action="addnick" prefix="example/users/">
991 #<hostchange mask="a@example.com" action="set" value="foo.bar.baz">
992 #<hostchange mask="*@localhost" ports="7000,7001,7005-7007" action="set" value="blahblah.foo">
994 # hostcycle: If loaded, when a user gets a host or ident set, it will
995 # cycle them in all their channels. If not loaded it will simply change
996 # their host/ident without cycling them.
997 # This module is compatible with the ircv3_chghost module. Clients
998 # supporting the chghost extension will get the chghost message instead
999 # of seeing a host cycle.
1000 #<module name="hostcycle">
1002 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1003 # httpd module: Provides HTTP server support for InspIRCd.
1004 #<module name="httpd">
1006 #-#-#-#-#-#-#-#-#-#-#-#- HTTPD CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
1008 # If you choose to use the httpd module, then you will need to add
1009 # a <bind> tag with type "httpd", and load at least one of the other
1010 # httpd_* modules to provide pages to display.
1011 # <bind address="127.0.0.1" port="8067" type="httpd">
1012 # <bind address="127.0.0.1" port="8097" type="httpd" ssl="gnutls">
1014 # You can adjust the timeout for HTTP connections below. All HTTP
1015 # connections will be closed after (roughly) this time period.
1016 #<httpd timeout="20">
1018 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1019 # HTTP ACL module: Provides access control lists for httpd dependent
1020 # modules. Use this module to restrict pages by IP address and by
1022 #<module name="httpd_acl">
1024 #-#-#-#-#-#-#-#-#-#-#-#- HTTPD ACL CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
1026 # Restrict access to the httpd_stats module to all but the local
1027 # network and when the correct password is specified:
1028 # <httpdacl path="/stats*" types="password,whitelist"
1029 # username="secrets" password="mypasshere" whitelist="127.0.0.*,10.*">
1031 # Deny all connections to all but the main index page:
1032 # <httpdacl path="/*" types="blacklist" blacklist="*">
1034 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1035 # HTTP config module: Allows the server configuration to be viewed over
1036 # HTTP via the /config path. Requires the httpd module to be loaded for
1039 # IMPORTANT: This module exposes extremely sensitive information about
1040 # your server and users so you *MUST* protect it using a local-only
1041 # <bind> tag and/or the httpd_acl module. See above for details.
1042 #<module name="httpd_config">
1044 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1045 # HTTP stats module: Provides server statistics over HTTP via the /stats
1046 # path. Requires the httpd module to be loaded for it to function.
1048 # IMPORTANT: This module exposes extremely sensitive information about
1049 # your server and users so you *MUST* protect it using a local-only
1050 # <bind> tag and/or the httpd_acl module. See above for details.
1051 #<module name="httpd_stats">
1053 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1054 # Ident: Provides RFC 1413 ident lookup support.
1055 # When this module is loaded <connect:allow> tags may have an optional
1056 # useident="yes|no" boolean value, determining whether or not to lookup
1057 # ident on users matching that connect tag.
1058 #<module name="ident">
1060 #-#-#-#-#-#-#-#-#-#-#-#- IDENT CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
1062 # Optional - If you are using the ident module, then you can specify #
1063 # the timeout for ident lookups here. If not defined, it will default #
1064 # to 5 seconds. This is a non-blocking timeout which holds the user #
1065 # in a 'connecting' state until the lookup is complete. #
1066 # nolookupprefix: If on, the idents of users being in a connect class #
1067 # with ident lookups disabled (i.e. <connect useident="off">) will be #
1068 # prefixed with a "~". If off, the ident of those users will not be #
1069 # prefixed. Default is off. #
1071 #<ident timeout="5" nolookupprefix="no">
1073 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1074 # Invite exception module: Adds support for channel invite exceptions
1076 #<module name="inviteexception">
1077 # bypasskey: If this is enabled, exceptions will bypass +k as well as +i
1078 #<inviteexception bypasskey="yes">
1080 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1081 # IRCv3 module: Provides the following IRCv3 extensions:
1082 # extended-join, away-notify and account-notify. These are optional
1083 # enhancements to the client-to-server protocol. An extension is only
1084 # active for a client when the client specifically requests it, so this
1085 # module needs the cap module to work.
1087 # Further information on these extensions can be found at the IRCv3
1088 # working group website:
1089 # http://ircv3.net/irc/
1091 #<module name="ircv3">
1092 # The following block can be used to control which extensions are
1093 # enabled. Note that extended-join can be incompatible with delayjoin
1095 #<ircv3 accountnotify="on" awaynotify="on" extendedjoin="on">
1097 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1098 # IRCv3 account-tag module. Adds the 'account' tag which contains the
1099 # services account name of the message sender.
1100 #<module name="ircv3_accounttag">
1102 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1103 # IRCv3 batch module: Provides the batch IRCv3 extension which allows
1104 # the server to inform a client that a group of messages are related to
1106 #<module name="ircv3_batch">
1108 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1109 # IRCv3 cap-notify module: Provides the cap-notify IRCv3 extension.
1110 # Required for IRCv3 conformance.
1111 #<module name="ircv3_capnotify">
1113 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1114 # IRCv3 chghost module: Provides the chghost IRCv3 extension which
1115 # allows capable clients to learn when the host/ident of another user
1116 # changes without cycling the user. This module is compatible with the
1117 # hostcycle module. If both are loaded, clients supporting the chghost
1118 # extension will get the chghost message and won't see host cycling.
1119 #<module name="ircv3_chghost">
1121 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1122 # IRCv3 echo-message module: Provides the echo-message IRCv3
1123 # extension which allows capable clients to get an acknowledgement when
1124 # their messages are delivered and learn what modifications, if any,
1125 # were applied to them.
1126 #<module name="ircv3_echomessage">
1128 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1129 # IRCv3 invite-notify module: Provides the invite-notify IRCv3
1130 # extension which notifies supporting clients when a user invites
1131 # another user into a channel. This respects <options:announceinvites>.
1132 #<module name="ircv3_invitenotify">
1134 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1135 # IRCv3 server-time module. Adds the 'time' tag which adds a timestamp
1136 # to all messages received from the server.
1137 #<module name="ircv3_servertime">
1139 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1140 # IRCv3 Strict Transport Security module: Provides the sts IRCv3
1141 # extension which allows clients connecting insecurely to upgrade their
1142 # connections to TLS.
1143 #<module name="ircv3_sts">
1145 # If using the ircv3_sts module you MUST define a STS policy to send
1146 # to clients using the <sts> tag. This tag takes the following
1149 # host - A glob match for the SNI hostname to apply this policy to.
1150 # duration - The amount of time that the policy lasts for. Defaults to
1151 # approximately two months by default.
1152 # port - The port on which TLS connections to the server are being
1153 # accepted. You MUST have a CA-verified certificate on this
1154 # port. Self signed certificates are not acceptable.
1155 # preload - Whether client developers can include your certificate in
1158 # <sts host="*.example.com" duration="60d" port="6697" preload="yes">
1160 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1161 # Join flood module: Adds support for join flood protection +j X:Y.
1162 # Closes the channel for N seconds if X users join in Y seconds.
1163 #<module name="joinflood">
1165 # The number of seconds to close the channel for:
1166 #<joinflood duration="1m">
1168 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1169 # Jump server module: Adds support for the RPL_REDIR numeric.
1170 # This module is oper-only.
1171 # To use, JUMPSERVER must be in one of your oper class blocks.
1172 # If your server is redirecting new clients and you get disconnected,
1173 # do a REHASH from shell to open up again.
1174 #<module name="jumpserver">
1176 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1177 # Anti auto rejoin: Adds support for prevention of auto-rejoin (+J).
1178 #<module name="kicknorejoin">
1180 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1181 # Knock module: Adds the /KNOCK command and channel mode +K.
1182 #<module name="knock">
1184 # This setting specifies what to do when someone successfully /KNOCKs.
1185 # If set to "notice", then a NOTICE will be sent to the channel.
1186 # This is the default and the compatible setting, as it requires no
1187 # special support from the clients.
1188 # If set to "numeric" then a 710 numeric will be sent to the channel.
1189 # This allows easier scripting but not all clients support it.
1190 # If set to "both" then (surprise!) both will be sent.
1191 #<knock notify="notice">
1193 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1194 # LDAP module: Allows other SQL modules to access a LDAP database
1195 # through a unified API.
1196 # This modules is in extras. Re-run configure with:
1197 # ./configure --enable-extras=m_ldap.cpp
1198 # and run make install, then uncomment this module to enable it.
1200 #<module name="ldap">
1201 #<database module="ldap" id="ldapdb" server="ldap://localhost" binddn="cn=Manager,dc=inspircd,dc=org" bindauth="mysecretpass" searchscope="subtree">
1202 # The server parameter indicates the LDAP server to connect to. The #
1203 # ldap:// style scheme before the hostname proper is MANDATORY. #
1205 # The binddn and bindauth indicate the DN to bind to for searching, #
1206 # and the password for the distinguished name. Some LDAP servers will #
1207 # allow anonymous searching in which case these two values do not #
1208 # need defining, otherwise they should be set similar to the examples #
1211 # The searchscope value indicates the subtree to search under. On our #
1212 # test system this is 'subtree'. Your mileage may vary. #
1214 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1215 # LDAP authentication module: Adds the ability to authenticate users #
1217 #<module name="ldapauth">
1221 # <ldapauth dbid="ldapdb" #
1222 # baserdn="ou=People,dc=brainbox,dc=cc" #
1224 # allowpattern="Guest* Bot*" #
1225 # killreason="Access denied" #
1227 # host="$uid.$ou.inspircd.org" #
1228 # useusername="no"> #
1230 # <ldapwhitelist cidr="10.42.0.0/16"> #
1232 # <ldaprequire attribute="attr" value="val"> #
1234 # The baserdn indicates the base DN to search in for users. Usually #
1235 # this is 'ou=People,dc=yourdomain,dc=yourtld'. #
1237 # The attribute value indicates the attribute which is used to locate #
1238 # a user account by name. On POSIX systems this is usually 'uid'. #
1240 # The allowpattern value allows you to specify a space separated list #
1241 # of wildcard masks which will always be allowed to connect #
1242 # regardless of if they have an account, for example guest and bot #
1245 # The useusername setting chooses whether the user's username or #
1246 # nickname is used when locating a user account, if a username isn't #
1247 # provided in PASS. #
1249 # Killreason indicates the QUIT reason to give to users if they fail #
1250 # to authenticate. #
1252 # Setting the verbose value causes an oper notice to be sent out for #
1253 # every failed authentication to the server, with an error string. #
1255 # ldapwhitelist indicates that clients connecting from an IP in the #
1256 # provided CIDR do not need to authenticate against LDAP. It can be #
1257 # repeated to whitelist multiple CIDRs. #
1259 # ldaprequire allows further filtering on the LDAP user, by requiring #
1260 # certain LDAP attibutes to have a given value. It can be repeated, #
1261 # in which case the list will act as an OR list, that is, the #
1262 # authentication will succeed if any of the requirements in the list #
1265 # host allows you to change the displayed host of users connecting #
1266 # from ldap. The string supplied takes formatters which are replaced #
1267 # from the DN. For instance, if your DN looks like: #
1268 # uid=w00t,ou=people,dc=inspircd,dc=org, then the formatters uid, ou #
1269 # and dc will be available to you. If a key is given multiple times #
1270 # in the DN, the last appearance will take precedence. #
1272 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1273 # LDAP oper configuration module: Adds the ability to authenticate #
1275 #<module name="ldapoper">
1279 # <ldapoper dbid="ldapdb"
1280 # baserdn="ou=People,dc=brainbox,dc=cc"
1283 # Available configuration items are identical to the same items in #
1284 # ldapauth above (except for the verbose setting, that is only #
1285 # supported in ldapauth). #
1286 # Please always specify a password in your <oper> tags even if the #
1287 # opers are to be authenticated via LDAP, so in case this module is #
1288 # not loaded the oper accounts are still protected by a password. #
1290 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1291 # Lock server module: Adds /LOCKSERV and /UNLOCKSERV commands that #
1292 # are used to temporarily close/open the server for new connections. #
1293 # These commands require that the /LOCKSERV and /UNLOCKSERV commands #
1294 # are specified in a <class> tag that the oper is part of. This is so #
1295 # you can control who has access to this possible dangerous command. #
1296 # If your server is locked and you get disconnected, do a REHASH from #
1297 # shell to open up again. #
1298 # This module is oper-only.
1299 #<module name="lockserv">
1301 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1302 # Map hiding module: replaces /MAP and /LINKS output to users with a #
1303 # message to see a website, set by maphide="http://test.org/map" in #
1304 # the <security> tag, instead. #
1305 #<module name="maphide">
1307 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1308 # Message flood module: Adds message/notice flood protection via
1310 #<module name="messageflood">
1312 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1313 # MLOCK module: Adds support for server-side enforcement of services
1314 # side MLOCKs. Basically, this module suppresses any mode change that
1315 # would likely be immediately bounced by services.
1316 #<module name="mlock">
1318 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1319 # Modenotice module: Adds the /MODENOTICE command that allows opers to
1320 # send notices to all users having the given user mode(s) set.
1321 #<module name="modenotice">
1323 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1324 # Monitor module: Adds support for MONITOR which is used by clients to
1325 # maintain notify lists.
1326 #<module name="monitor">
1328 # Set the maximum number of entries on a user's monitor list below.
1329 #<monitor maxentries="30">
1331 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1332 # MySQL module: Allows other SQL modules to access MySQL databases
1333 # through a unified API.
1334 # This module is in extras. Re-run configure with:
1335 # ./configure --enable-extras=m_mysql.cpp
1336 # and run make install, then uncomment this module to enable it.
1337 #<module name="mysql">
1339 #-#-#-#-#-#-#-#-#-#-#-#- SQL CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#-#
1341 # mysql is more complex than described here, see the wiki for more #
1342 # info: https://wiki.inspircd.org/Modules/3.0/mysql #
1344 #<database module="mysql" name="mydb" user="myuser" pass="mypass" host="localhost" id="my_database2">
1346 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1347 # Named modes module: Allows for the display and set/unset of channel
1348 # modes via long-form mode names via +Z and the /PROP command.
1349 # For example, to set a ban, do /mode #channel +Z ban=foo!bar@baz or
1350 # /PROP #channel ban=foo!bar@baz
1351 #<module name="namedmodes">
1353 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1354 # NAMESX module: Provides support for the NAMESX extension which allows
1355 # clients to see all the prefixes set on a user without getting confused.
1356 # This is supported by mIRC, x-chat, klient, and maybe more.
1357 #<module name="namesx">
1359 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1360 # National characters module:
1361 # 1) Allows using national characters in nicknames.
1362 # 2) Allows using custom (national) casemapping over the network.
1363 #<module name="nationalchars">
1365 # file - Location of the file which contains casemapping rules. If this
1366 # is a relative path then it is relative to "<PWD>/../locales"
1367 # on UNIX and "<PWD>/locales" on Windows.
1368 # casemapping - The name of the casemapping sent to clients in the 005
1369 # numeric. If this is not set then it defaults to the name
1370 # of the casemapping file unless the file name contains a
1371 # space in which case you will have to specify it manually.
1372 #<nationalchars file="bynets/russian-w1251-charlink" casemapping="ru_RU.cp1251-charlink">
1374 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1375 # Nickchange flood protection module: Provides channel mode +F X:Y
1376 # which allows up to X nick changes in Y seconds.
1377 #<module name="nickflood">
1379 # The number of seconds to prevent nick changes for:
1380 #<nickflood duration="1m">
1382 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1383 # Nicklock module: Let opers change a user's nick and then stop that
1384 # user from changing their nick again until unlocked.
1385 # This module is oper-only.
1386 # To use, NICKLOCK and NICKUNLOCK must be in one of your oper class blocks.
1387 #<module name="nicklock">
1389 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1390 # No CTCP module: Adds the channel mode +C and user mode +T to block
1391 # CTCPs and extban 'C' to block CTCPs sent by specific users.
1392 #<module name="noctcp">
1394 # The +T user mode is not enabled by default to enable link compatibility
1395 # with 2.0 servers. You can enable it by uncommenting this:
1396 #<noctcp enableumode="yes">
1398 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1399 # No kicks module: Adds the +Q channel mode and the Q: extban to deny
1400 # certain users from kicking.
1401 #<module name="nokicks">
1403 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1404 # No nicks module: Adds the +N channel mode, as well as the 'N' extban.
1405 # +N stops all users from changing their nick, the N extban stops
1406 # anyone from matching a +b N:nick!user@host mask from changing their
1408 #<module name="nonicks">
1410 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1411 # No part message module: Adds extban 'p' to block part messages from #
1413 #<module name="nopartmsg">
1415 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1416 # No notice module: Adds the channel mode +T and the extban 'T' to
1417 # block specific users from noticing the channel.
1418 #<module name="nonotice">
1420 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1421 # Network business join module:
1422 # Allows an oper to join a channel using /OJOIN, giving them +Y on the
1423 # channel which makes them immune to kick/deop/etc.
1424 #<module name="ojoin">
1426 # Specify the prefix that +Y will grant here.
1427 # Leave 'prefix' empty if you do not wish +Y to grant a prefix.
1428 # If 'notice' is set to on, upon /OJOIN, the server will notice the
1429 # channel saying that the oper is joining on network business.
1430 # If 'op' is set to on, it will give them +o along with +Y.
1431 #<ojoin prefix="!" notice="yes" op="yes">
1433 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1434 # Oper channels mode: Adds the +O channel mode and extban O:<mask>
1435 # to ban, except, etc. specific oper types. For example
1436 # /mode #channel +iI O:* is equivalent to channel mode +O, but you
1437 # may also set +iI O:AdminTypeOnly to only allow admins.
1438 # Modes +I and +e work in a similar fashion.
1439 #<module name="operchans">
1441 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1442 # Oper join module: Auto-joins opers to a channel upon oper-up.
1443 # This module is oper-only. For the user equivalent, see the conn_join
1445 #<module name="operjoin">
1447 #-#-#-#-#-#-#-#-#-#-# OPERJOIN CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
1449 # If you are using the operjoin module, specify options here: #
1451 # channel - The channel name to join, can also be a comma #
1452 # separated list e.g. "#channel1,#channel2". #
1454 # override - If on, lets the oper join walking thru any modes #
1455 # that might be set, even bans. #
1457 #<operjoin channel="#channel" override="no">
1459 # Alternatively you can use the autojoin="channellist" in a <type> #
1460 # tag to set specific autojoins for a type of oper, for example: #
1462 #<type name="Helper" autojoin="#help" classes="...">
1464 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1465 # Oper log module: Logs all oper commands to the server log (with log
1466 # type "m_operlog" at default loglevel), and optionally to the 'r'
1468 # This module is oper-only.
1469 #<module name="operlog">
1471 # If the following option is on then all oper commands will be sent to
1472 # the snomask 'r'. The default is off.
1473 #<operlog tosnomask="off">
1475 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1476 # Oper prefixing module: Adds a channel prefix mode +y which is given
1477 # to all IRC operators automatically on all channels they are in.
1478 # This prefix mode is more powerful than channel op and other regular
1481 # Load this module if you want all your IRC operators to have channel
1483 #<module name="operprefix">
1485 # You may additionally customise the prefix character.
1486 #<operprefix prefix="!">
1488 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1489 # Oper MOTD module: Provides support for separate message of the day
1491 # This module is oper-only.
1492 #<module name="opermotd">
1494 #-#-#-#-#-#-#-#-#-#-# OPERMOTD CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
1496 # If you are using the opermotd module, specify the motd here. #
1498 # onoper - If on, the message is sent on /OPER, otherwise it's #
1499 # only sent when /OPERMOTD is used. #
1501 #<opermotd file="examples/opermotd.txt.example" onoper="yes">
1503 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1504 # Override module: Adds support for oper override.
1505 # This module is oper-only.
1506 #<module name="override">
1508 #-#-#-#-#-#-#-#-#-#-# OVERRIDE CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
1510 # Much of override's configuration relates to your oper blocks. #
1511 # For more information on how to allow opers to override, see: #
1512 # https://wiki.inspircd.org/Modules/3.0/override #
1514 # noisy - If enabled, all oper overrides will be announced #
1515 # via channel notice. #
1517 # requirekey - If enabled, overriding on join requires a channel #
1518 # key of "override" to be specified #
1520 # enableumode - If enabled, usermode +O is required for override. #
1522 #<override noisy="yes" requirekey="no" enableumode="true">
1524 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1525 # Oper levels module: Gives each oper a level and prevents actions
1526 # being taken by lower level opers against higher level opers.
1527 # Specify the level as the 'level' parameter of the <type> tag.
1528 # This module is oper-only.
1529 #<module name="operlevels">
1531 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1532 # Oper modes module: Allows you to specify modes to add/remove on oper.
1533 # Specify the modes as the 'modes' parameter of the <type> tag
1534 # and/or as the 'modes' parameter of the <oper> tag.
1535 # This module is oper-only. For the user equivalent, see the
1536 # conn_umodes module.
1537 #<module name="opermodes">
1539 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1540 # Password forwarding module: Forwards a password users can send on
1541 # connect to the specified client below. The client is usually NickServ
1542 # and this module is usually used to authenticate users with NickServ
1543 # using their connect password.
1544 #<module name="passforward">
1547 # nick: nick to forward connect passwords to.
1550 # forwardmsg: Message to send to users using a connect password.
1551 # $nick will be the users' nick, $nickrequired will be the nick
1552 # of where the password is going (the nick above).
1553 # You can also use $user for the user ident string.
1554 forwardmsg="NOTICE $nick :*** Forwarding PASS to $nickrequired"
1556 # cmd: Command for the user to run when it receives a connect
1558 cmd="PRIVMSG $nickrequired :IDENTIFY $pass">
1560 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1561 # Password hash module: Allows hashed passwords to be used.
1562 # To be useful, a hashing module like bcrypt also needs to be loaded.
1563 #<module name="password_hash">
1565 #-#-#-#-#-#-#-#-#-# PASSWORD HASH CONFIGURATION #-#-#-#-#-#-#-#-#-#-#-#
1567 # To use this module, you must define a hash type for each oper's
1568 # password you want to hash. For example:
1570 # <oper name="Brain"
1571 # host="ident@dialup15.isp.test.com"
1573 # password="$2a$10$Mss9AtHHslZTLBrXqM0FB.JBwD.UTSu8A48SfrY9exrpxbsRiRTbO"
1576 # If you are using a hash algorithm which does not perform salting you can use
1577 # HMAC to salt your passwords in order to prevent them from being looked up in
1580 # hash="hmac-sha256" password="lkS1Nbtp$CyLd/WPQXizsbxFUTqFRoMvaC+zhOULEeZaQkUJj+Gg"
1582 # Generate hashes using the /MKPASSWD command on the server.
1583 # Don't run it on a server you don't trust with your password.
1585 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1586 # PBKDF2 module: Allows other modules to generate PBKDF2 hashes,
1587 # usually for cryptographic uses and security.
1588 # This module relies on other hash providers (e.g. SHA256).
1589 #<module name="pbkdf2">
1591 # iterations: Iterations the hashing function runs when generating new
1593 # length: Length in bytes of the derived key.
1594 #<pbkdf2 iterations="12288" length="32">
1595 # You can override these values with specific values
1596 # for specific providers if you want to. Example given for SHA256.
1597 #<pbkdf2prov hash="sha256" iterations="24576">
1599 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1600 # Permanent channels module: Channels with the permanent channel mode
1601 # will remain open even after everyone else has left the channel, and
1602 # therefore keep things like modes, ban lists and topic. Permanent
1603 # channels -may- need support from your Services package to function
1604 # properly with them. This adds channel mode +P.
1605 # This module is oper-only.
1606 #<module name="permchannels">
1608 # If you like, this module can write a config file of permanent channels
1609 # whenever +P is set, unset, or the topic/modes on a +P channel is changed.
1610 # If you want to do this, set the filename below, and uncomment the include.
1612 # If 'listmodes' is true then all list modes (+b, +I, +e, +g...) will be
1613 # saved. Defaults to false.
1614 #<permchanneldb filename="permchannels.conf" listmodes="true">
1615 #<include file="permchannels.conf">
1617 # You may also create channels on startup by using the <permchannels> block.
1618 #<permchannels channel="#opers" modes="isP" topic="Opers only.">
1620 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1621 # PostgreSQL module: Allows other SQL modules to access PgSQL databases
1622 # through a unified API.
1623 # This module is in extras. Re-run configure with:
1624 # ./configure --enable-extras=m_pgsql.cpp
1625 # and run make install, then uncomment this module to enable it.
1626 #<module name="pgsql">
1628 #-#-#-#-#-#-#-#-#-#-#-#- SQL CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#-#
1630 # pgsql is more complex than described here, see the wiki for #
1631 # more: https://wiki.inspircd.org/Modules/3.0/pgsql #
1633 #<database module="pgsql" name="mydb" user="myuser" pass="mypass" host="localhost" id="my_database" ssl="no">
1635 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1636 # Muteban: Implements extended ban 'm', which stops anyone matching
1637 # a mask like +b m:nick!user@host from speaking on channel.
1638 #<module name="muteban">
1640 # If notifyuser is set to no, the user will not be notified when
1641 # his/her message is blocked.
1642 #<muteban notifyuser="yes">
1644 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1645 # Random quote module: Provides a random quote on connect.
1646 # NOTE: Some of these may mimic fatal errors and confuse users and
1647 # opers alike - BEWARE!
1648 #<module name="randquote">
1650 #-#-#-#-#-#-#-#-#-#- RANDOMQUOTES CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
1652 # Optional - If you specify to use the randquote module, then specify #
1653 # below the path to the quotes file. #
1655 #<randquote file="quotes.txt">
1657 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1658 # Redirect module: Adds channel mode +L which redirects users to #
1659 # another channel when the channel has reached its user limit and #
1660 # user mode +L which stops redirection. #
1661 #<module name="redirect">
1663 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1664 # Regular expression provider for glob or wildcard (?/*) matching.
1665 # You must have at least 1 provider loaded to use the filter or R-line
1666 # modules. This module has no additional requirements, as it uses the
1667 # matching already present in InspIRCd core.
1668 #<module name="regex_glob">
1670 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1671 # Regular expression provider for PCRE (Perl-Compatible Regular
1672 # Expressions). You need libpcre installed to compile and load this
1673 # module. You must have at least 1 provider loaded to use the filter or
1675 #<module name="regex_pcre">
1677 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1678 # Regular Expression Provider for RE2 Regular Expressions.
1679 # You need libre2 installed and in your include/library paths in order
1680 # to compile and load this module.
1681 #<module name="regex_re2">
1683 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1684 # Regular expression provider for POSIX regular expressions.
1685 # You shouldn't need any additional libraries on a POSIX-compatible
1686 # system (i.e.: any Linux, BSD, but not Windows). You must have at
1687 # least 1 provider loaded to use the filter or R-line modules.
1688 # On POSIX-compliant systems, regex syntax can be found by using the
1689 # command: 'man 7 regex'.
1690 #<module name="regex_posix">
1692 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1693 # Regular expression provider for C++11 std::regex regular expressions.
1694 # This module works on any fully compliant implementation of the C++11
1695 # std::regex container. Examples for such are Visual C++ 2010 and newer
1696 # but not libstdc++ (which GCC uses).
1697 # You should verify that std::regex is supported by your setup before
1698 # using this module, as it may compile normally but won't do anything
1699 # on some implementations.
1700 #<module name="regex_stdlib">
1702 # Specify the regular expression engine to use here. Valid settings are
1703 # bre, ere, awk, grep, egrep, ecmascript (default if not specified).
1704 #<stdregex type="ecmascript">
1706 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1707 # Regular expression provider for TRE regular expressions.
1708 # This is the same regular expression engine used by UnrealIRCd, so
1709 # if you are most familiar with the syntax of /SPAMFILTER from there,
1710 # this is the provider you want. You need libtre installed in order
1711 # to compile and load this module.
1712 #<module name="regex_tre">
1714 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1715 # Remove module: Adds the /REMOVE command which is a peaceful
1716 # alternative to /KICK.
1717 #<module name="remove">
1719 # supportnokicks: If true, /REMOVE is not allowed on channels where the
1720 # nokicks (+Q) mode is set. Defaults to false.
1721 # protectedrank: Members having this rank or above may not be /REMOVE'd
1722 # by anyone. Set to 0 to disable this feature. Defaults to 50000.
1723 #<remove supportnokicks="true" protectedrank="50000">
1725 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1726 # A module to block, kick or ban upon similar messages being uttered several times.
1727 # Syntax [~*][lines]:[sec]{[:difference]}{[:matchlines]}
1728 # ~ is to block, * is to ban, default is kick.
1729 # 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
1730 # seconds - How old the message has to be before it's invalidated.
1731 # distance - Edit distance, in percent, between two strings to trigger on.
1732 # matchlines - When set, the function goes into mode 2. In this mode the function will trigger if this many of the last <lines> matches.
1734 # As this module can be rather CPU-intensive, it comes with some options.
1735 # maxbacklog - Maximum size that can be specified for backlog. 0 disables multiline matching.
1736 # maxdistance - Max percentage of difference between two lines we'll allow to match. Set to 0 to disable edit-distance matching.
1737 # maxlines - Max lines of backlog to match against.
1738 # maxtime - Maximum period of time a user can set. 0 to allow any.
1739 # size - Maximum number of characters to check for, can be used to truncate messages
1740 # before they are checked, resulting in less CPU usage. Increasing this beyond 512
1741 # doesn't have any effect, as the maximum length of a message on IRC cannot exceed that.
1742 #<repeat maxbacklog="20" maxlines="20" maxdistance="50" maxtime="0" size="512">
1743 #<module name="repeat">
1745 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1746 # Restricted channels module: Allows only opers or registered users to
1749 # You probably *DO NOT* want to load this module on a public network.
1751 #<module name="restrictchans">
1753 # allowregistered: should registered users be allowed to bypass the restrictions?
1754 #<restrictchans allowregistered="no">
1756 # Allow any channel matching #user-* to be created, bypassing restrictchans checks
1757 #<allowchannel name="#user-*">
1759 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1760 # Restrict message module: Allows users to only message opers.
1762 # You probably *DO NOT* want to load this module on a public network.
1764 #<module name="restrictmsg">
1766 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1767 # R-line module: Ban users through regular expression patterns.
1768 #<module name="rline">
1770 #-#-#-#-#-#-#-#-#-#-#-#- RLINE CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#-#
1772 # If you wish to re-check a user when they change nickname (can be
1773 # useful under some situations, but *can* also use CPU with more users
1774 # on a server) then set 'matchonnickchange' to yes.
1775 # Also, this is where you set what Regular Expression engine is to be
1776 # used. If you ever change it while running, all of your R-lines will
1777 # be wiped. This is the regex engine used by all R-lines set, and
1778 # regex_<engine> must be loaded, or rline will be non-functional
1779 # until you load it or change the engine to one that is loaded.
1781 #<rline matchonnickchange="yes" engine="pcre">
1783 # Generally, you will NOT want to use 'glob' here, as this turns an
1784 # R-line into just another G-line. The exceptions are that R-lines will
1785 # always use the full "nick!user@host realname" string, rather than only
1786 # user@host, but beware that only the ? and * wildcards are available,
1787 # and are the only way to specify where the space can occur if you do
1788 # use glob. For this reason, is recommended to use a real regex engine
1789 # so that at least \s or [[:space:]] is available.
1791 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1792 # RMODE module: Adds the /RMODE command
1793 # Allows channel mods to remove list modes en masse.
1794 # Syntax: /rmode <channel> <mode> [pattern]
1795 # E.g. '/rmode #Channel b m:*' will remove all mute-extbans on the channel.
1796 #<module name="rmode">
1798 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1799 # SAJOIN module: Adds the /SAJOIN command which forcibly joins a user
1800 # to the given channel.
1801 # This module is oper-only.
1802 # To use, SAJOIN must be in one of your oper class blocks.
1803 # Opers need the users/sajoin-others priv to be able to /SAJOIN users
1804 # other than themselves.
1805 #<module name="sajoin">
1807 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1808 # SAKICK module: Adds the /SAKICK command which kicks a user from the
1810 # This module is oper-only.
1811 # To use, SAKICK must be in one of your oper class blocks.
1812 #<module name="sakick">
1814 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1815 # SAMODE module: Adds the /SAMODE command which allows server operators
1816 # to change modes on a channel without requiring them to have any
1817 # channel priviliges. Also allows changing user modes for any user.
1818 # This module is oper-only.
1819 # To use, SAMODE must be in one of your oper class blocks.
1820 #<module name="samode">
1822 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1823 # SANICK module: Adds the /SANICK command which allows opers to change
1825 # This module is oper-only.
1826 # To use, SANICK must be in one of your oper class blocks.
1827 #<module name="sanick">
1829 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1830 # SAPART module: Adds the /SAPART command which forcibly parts a user
1832 # This module is oper-only.
1833 # To use, SAPART must be in one of your oper class blocks.
1834 #<module name="sapart">
1836 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1837 # SAQUIT module: Adds the /SAQUIT command which forcibly quits a user.
1838 # This module is oper-only.
1839 # To use, SAQUIT must be in one of your oper class blocks.
1840 #<module name="saquit">
1842 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1843 # SATOPIC module: Adds the /SATOPIC command which allows changing the
1844 # topic on a channel without requiring any channel priviliges.
1845 # This module is oper-only.
1846 # To use, SATOPIC must be in one of your oper class blocks.
1847 #<module name="satopic">
1849 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1850 # SASL authentication module: Provides support for IRC Authentication
1851 # Layer via AUTHENTICATE. Note: You also need to have cap loaded
1853 #<module name="sasl">
1854 # Define the following to your services server name to improve security
1855 # by ensuring the SASL messages are only sent to the services server
1856 # and not to all connected servers. This prevents a rogue server from
1857 # capturing SASL messages and disables the SASL cap when services is
1859 #<sasl target="services.mynetwork.com">
1861 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1862 # Secure list module: Prevent /LIST in the first minute of connection,
1863 # crippling most spambots and trojan spreader bots.
1864 #<module name="securelist">
1866 #-#-#-#-#-#-#-#-#-# SECURELIST CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#-#
1868 # Securelist can be harmful to some IRC search engines. To prevent #
1869 # securelist blocking these sites from listing, define exception tags #
1871 #<securehost exception="*@*.netsplit.de">
1872 #<securehost exception="*@*.ircdriven.com">
1873 #<securehost exception="*@*.ircs.me">
1875 # Define the following variable to change how long a user must wait #
1876 # before issuing a LIST. If not defined, defaults to 60 seconds. #
1878 #<securelist waittime="1m"> #
1880 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1881 # Servprotect module: Provides support for Austhex style +k /
1882 # UnrealIRCD +S services mode.
1883 #<module name="servprotect">
1885 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1886 # See nicks module: Adds snomask +n and +N which show local and remote
1888 # This module is oper-only.
1889 #<module name="seenicks">
1891 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1892 # Set idle module: Adds a command for opers to change their idle time.
1893 # This module is oper-only.
1894 # To use, SETIDLE must be in one of your oper class blocks.
1895 #<module name="setidle">
1897 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1898 # Services support module: Adds several usermodes such as +R and +M.
1899 # This module implements the 'identified' state via account names,
1900 # and is similar in operation to the way asuka and ircu handle services.
1902 # At the same time, this offers +r for users and channels to mark them
1903 # as identified separately from the idea of a master account, which
1904 # can be useful for services which are heavily nick-as-account centric.
1906 # Also of note is that this module implements two extbans:
1907 # +b R: (stop matching account names from joining)
1908 # +b U:n!u@h (blocks matching unregistered users)
1910 #<module name="services_account">
1912 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1913 # Sethost module: Adds the /SETHOST command.
1914 # This module is oper-only.
1915 # To use, SETHOST must be in one of your oper class blocks.
1916 # See the chghost module for how to customise valid chars for hostnames.
1917 #<module name="sethost">
1919 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1920 # Setident module: Adds the /SETIDENT command.
1921 # This module is oper-only.
1922 # To use, SETIDENT must be in one of your oper class blocks.
1923 #<module name="setident">
1925 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1926 # SETNAME module: Adds the /SETNAME command.
1927 #<module name="setname">
1929 #-#-#-#-#-#-#-#-#-#-#-#- SETNAME CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#
1931 # operonly - Whether the SETNAME command should only be usable by #
1932 # server operators. Defaults to no. #
1934 # notifyopers - Whether to send a snotice to snomask `a` when the #
1935 # server operators. Defaults to to yes if oper-only and #
1936 # no if usable by everyone. #
1938 #<setname notifyopers="yes" #
1941 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1942 # Serverban: Implements extended ban 's', which stops anyone connected
1943 # to a server matching a mask like +b s:server.mask.here from joining.
1944 #<module name="serverban">
1946 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1947 # SHA1 module: Allows other modules to generate SHA1 hashes.
1948 # Required by the WebSocket module.
1949 #<module name="sha1">
1951 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1952 # Showfile: Provides support for showing a text file to users when #
1953 # they enter a command. #
1954 # This module adds one command for each <showfile> tag that shows the #
1955 # given file to the user as a series of messages or numerics. #
1956 #<module name="showfile"> #
1958 #-#-#-#-#-#-#-#-#-#-# SHOWFILE CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#-#
1960 # name - The name of the command which displays this file. This is #
1961 # the only mandatory setting, all others are optional. #
1962 # file - The text file to be shown to the user. #
1963 # By default same as the command name. #
1964 # method - How should the file be shown? #
1965 # * numeric: Send contents using a numeric #
1966 # (similar to /MOTD; the default). #
1967 # * notice: Send contents as a series of notices. #
1968 # * msg: Send contents as a series of private messages. #
1970 # When using the method "numeric", the following extra settings are #
1973 # introtext - Introductory line, "Showing <name>" by default. #
1974 # intronumeric - Numeric used for the introductory line. #
1975 # numeric - Numeric used for sending the text itself. #
1976 # endtext - Ending line, "End of <name>" by default. #
1977 # endnumeric - Numeric used for the ending line. #
1979 #<showfile name="RULES"
1981 # introtext="Server rules:"
1982 # endtext="End of server rules.">
1984 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1985 # Show whois module: Adds the +W usermode which allows opers to see
1986 # when they are /WHOIS'd.
1987 # This module is oper-only by default.
1988 #<module name="showwhois">
1990 # If you wish, you may also let users set this mode. Only opers with the
1991 # users/auspex priv will see real hosts of people, though.
1992 #<showwhois opersonly="yes"
1994 # You may also set whether or not users should receive whois notices,
1995 # should they be /WHOIS'd by an oper.
1996 #showfromopers="yes">
1998 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1999 # Shun module: Provides the /SHUN command, which stops a user from
2000 # executing all except configured commands.
2001 # This module is oper-only.
2002 # To use, SHUN must be in one of your oper class blocks.
2003 #<module name="shun">
2005 # You may also configure which commands you wish a user to be able to
2006 # perform when shunned. It should be noted that if a shunned user
2007 # issues QUIT or PART then their message will be removed, as if they
2008 # did not issue one.
2010 # You can optionally let the user know that their command was blocked.
2012 # You may also let SHUN affect opers (defaults to no).
2013 #<shun enabledcommands="ADMIN PING PONG QUIT PART JOIN" notifyuser="yes" affectopers="no">
2015 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2016 # SSL mode module: Adds support for SSL-only channels via the '+z'
2017 # channel mode, SSL-only private messages via the '+z' user mode and
2018 # the 'z:' extban which matches SSL client certificate fingerprints.
2020 # Does not do anything useful without a working SSL module and the
2021 # sslinfo module (see below).
2022 #<module name="sslmodes">
2024 # The +z user mode is not enabled by default to enable link compatibility
2025 # with 2.0 servers. You can enable it by uncommenting this:
2026 #<sslmodes enableumode="yes">
2028 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2029 # SSL rehash signal module: Allows the SSL modules to be rehashed by
2030 # sending SIGUSR1 to a running InspIRCd process.
2031 # This modules is in extras. Re-run configure with:
2032 # ./configure --enable-extras=m_sslrehashsignal.cpp
2033 # and run make install, then uncomment this module to enable it.
2034 #<module name="sslrehashsignal">
2036 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2037 # GnuTLS SSL module: Adds support for SSL connections using GnuTLS,
2038 # if enabled. You must answer 'yes' in ./configure when asked or
2039 # manually symlink the source for this module from the directory
2040 # src/modules/extra, if you want to enable this, or it will not load.
2041 #<module name="ssl_gnutls">
2043 #-#-#-#-#-#-#-#-#-#-#- GNUTLS CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#
2045 # ssl_gnutls is too complex to describe here, see the wiki: #
2046 # https://wiki.inspircd.org/Modules/3.0/ssl_gnutls #
2048 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2049 # SSL info module: Allows users to retrieve information about other
2050 # users' peer SSL certificates and keys. This can be used by client
2051 # scripts to validate users. For this to work, one of ssl_gnutls
2052 # or ssl_openssl must be loaded. This module also adds the
2053 # "* <user> is using a secure connection" whois line, the ability for
2054 # opers to use SSL cert fingerprints to verify their identity and the
2055 # ability to force opers to use SSL connections in order to oper up.
2056 # It is highly recommended to load this module if you use SSL on your
2058 # For how to use the oper features, please see the first example <oper> tag
2059 # in opers.conf.example.
2061 #<module name="sslinfo">
2063 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2064 # mbedTLS SSL module: Adds support for SSL/TLS connections using mbedTLS.
2065 #<module name="ssl_mbedtls">
2067 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2068 # OpenSSL SSL module: Adds support for SSL connections using OpenSSL,
2069 # if enabled. You must answer 'yes' in ./configure when asked or symlink
2070 # the source for this module from the directory src/modules/extra, if
2071 # you want to enable this, or it will not load.
2072 #<module name="ssl_openssl">
2074 #-#-#-#-#-#-#-#-#-#-#- OPENSSL CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#
2076 # ssl_openssl is too complex to describe here, see the wiki: #
2077 # https://wiki.inspircd.org/Modules/3.0/ssl_openssl #
2079 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2080 # Strip color module: Adds channel mode +S that strips color codes and
2081 # all control codes except CTCP from all messages sent to the channel.
2082 #<module name="stripcolor">
2084 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2085 # Silence module: Adds support for the /SILENCE command, which allows
2086 # users to have a server-side ignore list for their client.
2087 #<module name="silence">
2089 # Set the maximum number of entries allowed on a user's silence list.
2090 #<silence maxentries="32"
2092 # Whether messages from U-lined servers will bypass silence masks.
2095 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2096 # SQLite3 module: Allows other SQL modules to access SQLite3 #
2097 # databases through a unified API. #
2098 # This module is in extras. Re-run configure with: #
2099 # ./configure --enable-extras=m_sqlite3.cpp
2100 # and run make install, then uncomment this module to enable it. #
2102 #<module name="sqlite3">
2104 #-#-#-#-#-#-#-#-#-#-#-#- SQL CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#-#
2106 # sqlite is more complex than described here, see the wiki for more #
2107 # info: https://wiki.inspircd.org/Modules/3.0/sqlite3 #
2109 #<database module="sqlite" hostname="/full/path/to/database.db" id="anytext">
2111 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2112 # SQL authentication module: Allows IRCd connections to be tied into
2113 # a database table (for example a forum).
2115 #<module name="sqlauth">
2117 #-#-#-#-#-#-#-#-#-#-#- SQLAUTH CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#
2119 # sqlauth is too complex to describe here, see the wiki: #
2120 # https://wiki.inspircd.org/Modules/3.0/sqlauth #
2122 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2123 # SQL oper module: Allows you to store oper credentials in an SQL
2124 # table. You can add additional table columns like you would config
2125 # tags in opers.conf. Opers in opers.conf will override opers from
2128 #<module name="sqloper">
2130 #-#-#-#-#-#-#-#-#-#-#- SQLOPER CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#
2132 # dbid - Database ID to use (see SQL modules). #
2134 # See also: https://wiki.inspircd.org/Modules/3.0/sqloper #
2138 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2139 # StartTLS module: Implements STARTTLS, which allows clients #
2140 # connected to non SSL enabled ports to enable SSL, if a proper SSL #
2141 # module is loaded (either ssl_gnutls or ssl_openssl). #
2142 #<module name="starttls">
2144 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2145 # SVSHold module: Implements SVSHOLD. Like Q-lines, but can only be #
2146 # added/removed by Services. #
2147 #<module name="svshold">
2148 # SVSHOLD does not generate server notices by default, you can turn
2149 # notices on by uncommenting the next line.
2150 #<svshold silent="false">
2152 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2153 # SWHOIS module: Allows you to add arbitrary lines to user WHOIS.
2154 # This module is oper-only.
2155 # To use, SWHOIS must be in one of your oper class blocks.
2156 #<module name="swhois">
2158 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2159 # Timed bans module: Adds timed channel bans with the /TBAN command.
2160 #<module name="timedbans">
2162 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2163 # Test line module: Adds the /TLINE command, used to test how many
2164 # users a /GLINE or /ZLINE etc. would match.
2165 # This module is oper-only.
2166 # To use, TLINE must be in one of your oper class blocks.
2167 #<module name="tline">
2169 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2170 # Topiclock module: implements server-side topic locking to achieve deeper
2171 # integration with services packages.
2172 #<module name="topiclock">
2174 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2175 # UHNAMES support module: Adds support for the IRCX style UHNAMES
2176 # extension, which displays ident and hostname in the names list for
2177 # each user, saving clients from doing a WHO on the channel.
2178 # If a client does not support UHNAMES it will not enable it, this will
2179 # not break incompatible clients.
2180 #<module name="uhnames">
2182 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2183 # Uninvite module: Adds the /UNINVITE command which lets users remove
2184 # pending invites from channels without waiting for the user to join.
2185 #<module name="uninvite">
2187 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2188 # Userip module: Adds the /USERIP command.
2189 # Allows users to query their own IP, also allows opers to query the IP
2191 #<module name="userip">
2193 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2194 # Vhost module: Adds the VHOST command which allows for adding virtual
2195 # hosts which are accessible using a username and password in the config.
2196 #<module name="vhost">
2198 #-#-#-#-#-#-#-#-#-#-#- VHOST CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#-#
2200 # user - Username for the vhost. #
2202 # pass - Password for the vhost. #
2204 # hash - The hash for the specific user (optional) #
2205 # password_hash and a hashing module must be loaded for #
2208 # host - Vhost to set. #
2210 #<vhost user="some_username" pass="some_password" host="some.host.test.cc">
2211 #<vhost user="foo" password="$2a$10$iTuYLT6BRhRlOgzfsW9oPe62etW.oXwSpyKw5rJit64SGZanLXghO" hash="bcrypt" host="some.other.host.example.com">
2213 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2214 # Watch module: Adds the WATCH command, which is used by clients to
2215 # maintain notify lists.
2216 #<module name="watch">
2218 # Set the maximum number of entries on a user's watch list below.
2219 #<watch maxentries="32">
2221 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2222 # WebSocket module: Adds HTML5 WebSocket support.
2223 # Specify hook="websocket" in a <bind> tag to make that port accept
2224 # WebSocket connections. Compatible with SSL/TLS.
2225 # Requires SHA-1 hash support available in the sha1 module.
2226 #<module name="websocket">
2228 # Whether to re-encode messages as UTF-8 before sending to WebSocket
2229 # clients. This is recommended as the WebSocket protocol requires all
2230 # text frames to be sent as UTF-8. If you do not have this enabled
2231 # messages will be sent as binary frames instead.
2232 #<websocket sendastext="yes">
2234 # If you use the websocket module you MUST specify one or more origins
2235 # which are allowed to connect to the server. You should set this as
2236 # strict as possible to prevent malicious webpages from connecting to
2238 # <wsorigin allow="https://*.example.com/">
2240 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2241 # XLine database: Stores all *-lines (G/Z/K/R/any added by other modules)
2242 # in a file which is re-loaded on restart. This is useful
2243 # for two reasons: it keeps bans so users may not evade them, and on
2244 # bigger networks, server connections will take less time as there will
2245 # be a lot less bans to apply - as most of them will already be there.
2246 #<module name="xline_db">
2248 # Specify the filename for the xline database here.
2249 #<xlinedb filename="xline.db">
2251 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2252 # ____ _ _____ _ _ ____ _ _ _ #
2253 # | _ \ ___ __ _ __| | |_ _| |__ (_)___ | __ )(_) |_| | #
2254 # | |_) / _ \/ _` |/ _` | | | | '_ \| / __| | _ \| | __| | #
2255 # | _ < __/ (_| | (_| | | | | | | | \__ \ | |_) | | |_|_| #
2256 # |_| \_\___|\__,_|\__,_| |_| |_| |_|_|___/ |____/|_|\__(_) #
2258 # To link servers to InspIRCd, you MUST load the spanningtree module. #
2259 # If you don't do this, server links will NOT work at all. #
2260 # This is by design, to allow for the implementation of other linking #
2261 # protocols in modules in the future. #
2263 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2264 # Spanning tree module: Allows linking of servers using the spanning
2265 # tree protocol (see the READ THIS BIT section above).
2266 # You will almost always want to load this.
2268 #<module name="spanningtree">
projects / user / henk / code / inspircd.git / blob