· 6 years ago · Dec 27, 2019, 02:52 AM
1#-#-#-#-#-#-#-#-#-#-#-#-#- MODULE OPTIONS -#-#-#-#-#-#-#-#-#-#-#-#-#
2# #
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. #
10# #
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://docs.inspircd.org/3/modules for a list of modules and #
14# each modules link for any additional conf tags they require. #
15# #
16# ____ _ _____ _ _ ____ _ _ _ #
17# | _ \ ___ __ _ __| | |_ _| |__ (_)___ | __ )(_) |_| | #
18# | |_) / _ \/ _` |/ _` | | | | '_ \| / __| | _ \| | __| | #
19# | _ < __/ (_| | (_| | | | | | | | \__ \ | |_) | | |_|_| #
20# |_| \_\___|\__,_|\__,_| |_| |_| |_|_|___/ |____/|_|\__(_) #
21# #
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 #
26# this file. #
27# #
28
29#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
30# MD5 module: Allows other modules to generate MD5 hashes, usually for
31# cryptographic uses and security.
32#
33# IMPORTANT:
34# Other modules such as cloaking and password_hash may rely on
35# this module being loaded to function.
36#
37<module name="md5">
38
39#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
40# SHA256 module: Allows other modules to generate SHA256 hashes,
41# usually for cryptographic uses and security.
42#
43# IMPORTANT:
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).
48#
49<module name="sha256">
50
51#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
52# Abbreviation module: Provides the ability to abbreviate commands a-la
53# BBC BASIC keywords.
54<module name="abbreviation">
55
56#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
57# Alias module: Allows you to define server-side command aliases.
58<module name="alias">
59#
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">
65#
66#-#-#-#-#-#-#-#-#-#-#- ALIAS DEFINITIONS -#-#-#-#-#-#-#-#-#-#-#-#-#-#
67# #
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: #
72# #
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. #
80# #
81# usercommand - If this is true, the alias can be run simply as #
82# /ALIASNAME. Defaults to true. #
83# #
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. #
88# #
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 #
96# optional. #
97# #
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). #
113# #
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. #
118# #
119# stripcolor - If this is true, the text from the user will be #
120# stripped of color and format codes before #
121# matching against 'text'. #
122# #
123# uline - Setting this to true will ensure that the user #
124# given in 'requires' is also on a U-lined server, #
125# as well as actually being on the network. If the #
126# user is online, but not on a U-lined server, #
127# then an oper alert is sent out as this is #
128# possibly a sign of a user trying to impersonate #
129# a service. #
130# #
131# operonly - If true, this will make the alias oper only. #
132# If a non-oper attempts to use the alias, it will #
133# appear to not exist. #
134# #
135#
136# An example of using the format value to create an alias with two
137# different behaviours depending on the format of the parameters.
138#
139#<alias text="ID" format="#*" replace="SQUERY ChanServ :IDENTIFY $2 $3"
140# requires="ChanServ" uline="yes">
141#
142#<alias text="ID" replace="SQUERY NickServ :IDENTIFY $2"
143# requires="NickServ" uline="yes">
144#
145# This alias fixes a glitch in xchat 2.6.x and above and the way it
146# assumes IDENTIFY must be prefixed by a colon (:) character. It should
147# be placed ABOVE the default NICKSERV alias.
148#
149#<alias text="NICKSERV" format=":IDENTIFY *" replace="SQUERY NickServ :IDENTIFY $3-"
150# requires="NickServ" uline="yes">
151#
152# You may also add aliases to trigger based on something said in a
153# channel, aka 'fantasy' commands, configured in the same manner as any
154# other alias, with usercommand="no" and channelcommand="yes" The
155# command must be preceded by the fantasy prefix when used.
156#
157#<alias text="CS" usercommand="no" channelcommand="yes"
158# replace="SQUERY ChanServ :$1 $chan $2-" requires="ChanServ" uline="yes">
159#
160# This would be used as "!cs <command> <options>", with the channel
161# being automatically inserted after the command in the message to
162# ChanServ, assuming the fantasy prefix is "!".
163
164#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
165# Allowinvite module: Gives channel mode +A to allow all users to use
166# /INVITE, and extban A to deny invite from specific masks.
167<module name="allowinvite">
168
169#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
170# Alltime module: Shows time on all connected servers at once.
171# This module is oper-only and provides /ALLTIME.
172# To use, ALLTIME must be in one of your oper class blocks.
173<module name="alltime">
174
175#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
176# Anticaps module: Adds channel mode +B which allows you to punish
177# users that send overly capitalised messages to channels. Unlike the
178# blockcaps module this module is more flexible as it has more options
179# for punishment and allows channels to configure their own punishment
180#Â policies.
181<module name="anticaps">
182#
183# You may also configure the characters which anticaps considers to be
184# lower case and upper case. Any characters not listed here are assumed
185# to be punctuation and will be ignored when counting:
186# <anticaps lowercase="abcdefghijklmnopqrstuvwxyz"
187# uppercase="ABCDEFGHIJKLMNOPQRSTUVWXYZ">
188
189#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
190# Auditorium module: Adds channel mode +u which makes everyone else
191# except you in the channel invisible, used for large meetings etc.
192<module name="auditorium">
193#
194# Auditorium settings:
195#
196#<auditorium opvisible="no" opcansee="no" opercansee="yes">
197#
198# opvisible (auditorium-vis in exemptchanops):
199# Show channel ops to all users
200# opcansee (auditorium-see in exemptchanops):
201# Allow ops to see all joins/parts/kicks in the channel
202# opercansee:
203# Allow opers (channels/auspex) to see see all joins/parts/kicks in the channel
204#
205# Exemptchanops can be used to adjust the level at which users become visible or
206# the level at which they can see the full member list of the channel.
207
208#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
209# Autoop module: Adds basic channel access controls via the +w listmode.
210# For example +w o:*!Attila@127.0.0.1 will op anyone matching that mask
211# on join. This can be combined with extbans, for example +w o:R:Brain
212# will op anyone identified to the account "Brain".
213# Another useful combination is with SSL client certificate
214# fingerprints: +w h:z:72db600734bb9546c1bdd02377bc21d2a9690d48 will
215# give halfop to the user(s) having the given certificate.
216<module name="autoop">
217
218#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
219# Ban except module: Adds support for channel ban exceptions (+e).
220<module name="banexception">
221
222#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
223# Ban redirection module: Allows bans which redirect to a specified
224# channel. e.g. +b nick!ident@host#channelbanneduserissentto
225<module name="banredirect">
226
227#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
228# bcrypt module: Allows other modules to generate bcrypt hashes,
229# usually for cryptographic uses and security.
230<module name="bcrypt">
231#
232# rounds: Defines how many rounds the bcrypt function will run when
233# generating new hashes.
234#<bcrypt rounds="10">
235
236#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
237# Block amsg module: Attempt to block all usage of /amsg and /ame.
238<module name="blockamsg">
239#
240#-#-#-#-#-#-#-#-#-#-#- BLOCKAMSG CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
241# #
242# If you have the blockamsg module loaded, you can configure it with #
243# the <blockamsg> tag: #
244# #
245# delay - How much time between two messages to force them #
246# to be recognised as unrelated. #
247# action - Any of 'notice', 'noticeopers', 'silent', 'kill' #
248# or 'killopers'. Define how to take action when #
249# a user uses /amsg or /ame. #
250#
251#<blockamsg delay="3" action="killopers">
252
253#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
254# Block CAPS module: Adds channel mode +B, blocks all-CAPS messages.
255#
256# NOTE: This module is deprecated and will be removed in a future version
257# of InspIRCd. You should use the anticaps module shown above instead.
258<module name="blockcaps">
259#
260#-#-#-#-#-#-#-#-#-#-#- BLOCKCAPS CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
261# #
262# percent - The percentage of a message which must be upper #
263# case before it will be blocked. #
264# #
265# minlen - The minimum length a message must be before it #
266# will be blocked. #
267# #
268# lowercase - The characters which will be considered lower #
269# case. #
270# #
271# uppercase - The characters which will be considered upper #
272# case. #
273#
274#<blockcaps percent="50"
275# minlen="5"
276# lowercase="abcdefghijklmnopqrstuvwxyz"
277# uppercase="ABCDEFGHIJKLMNOPQRSTUVWXYZ">
278
279#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
280# Block color module: Blocking color-coded messages with chan mode +c.
281<module name="blockcolor">
282
283#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
284# Botmode module: Adds the user mode +B. If set on a user, it will
285# show that the user is a bot in /WHOIS.
286<module name="botmode">
287
288#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
289# CallerID module: Adds user mode +g which activates hybrid-style
290# callerid: block all private messages unless you /ACCEPT first.
291<module name="callerid">
292#
293#-#-#-#-#-#-#-#-#-#-#- CALLERID CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#
294# maxaccepts - Maximum number of entries a user can add to their #
295# /ACCEPT list. Default is 30 entries. #
296# tracknick - Preserve /ACCEPT entries when a user changes nick? #
297# If no (the default), the user is removed from #
298# everyone's accept list if their nickname changes. #
299# cooldown - Amount of time that must pass since the last #
300# notification sent to a user before they can be #
301# sent another. Default is 1 minute. #
302#<callerid maxaccepts="30"
303# tracknick="no"
304# cooldown="1m">
305
306#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
307# CAP module: Provides the CAP negotiation mechanism required by the
308# sasl, namesx, uhnames, and ircv3 modules.
309# It is also recommended for STARTTLS support in the starttls module.
310<module name="cap">
311
312#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
313# CBAN module: Lets you disallow channels from being used at runtime.
314# This module is oper-only and provides /CBAN.
315# To use, CBAN must be in one of your oper class blocks.
316<module name="cban">
317
318#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
319# Censor module: Adds channel and user mode +G which block phrases that
320# are listed in the server bad words list.
321<module name="censor">
322#
323#-#-#-#-#-#-#-#-#-#-#- CENSOR CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#
324# #
325# If you have the censor module loaded you should specify one or more #
326# phrases to replace/block in user messages. The config for this is #
327# formatted as follows: #
328# #
329# Replaces "eggplant" with "aubergine" within messages: #
330# <badword text="eggplant" replace="aubergine"> #
331# #
332# Blocks messages that contain "fluffy capybaras": #
333#<badword text="fluffy capybaras"> #
334
335#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
336# CGI:IRC module: Enables forwarding the real IP address of a user from
337# a gateway to the IRC server.
338<module name="cgiirc">
339#
340#-#-#-#-#-#-#-#-#-#-#-# CGIIRC CONFIGURATION #-#-#-#-#-#-#-#-#-#-#-#-#
341#
342# If you use the cgiirc module then you must specify the gateways which
343# are authorised to forward IP/host information to your server. There
344# are currently two ways to do this:
345#
346# The webirc method is the recommended way to allow gateways to forward
347# IP/host information. When using this method the gateway sends a WEBIRC
348# message to the server on connection. For more details please read the
349# IRCv3 WebIRC specification at: https://ircv3.net/specs/extensions/webirc.html
350#
351# When using this method you must specify a wildcard mask or CIDR range
352# to allow gateway connections from and at least one of either a SSL
353# client certificate fingerprint for the gateway or a password to be
354# sent in the WEBIRC command.
355#
356# <cgihost type="webirc"
357# fingerprint="bd90547b59c1942b85f382bc059318f4c6ca54c5"
358# mask="192.0.2.0/24">
359# <cgihost type="webirc"
360# password="$2a$10$WEUpX9GweJiEF1WxBDSkeODBstIBMlVPweQTG9cKM8/Vd58BeM5cW"
361# hash="bcrypt"
362# mask="*.webirc.gateway.example.com">
363#
364# Alternatively if your gateway does not support sending the WEBIRC
365# message then you can configure InspIRCd to look for the client IP
366# address in the ident sent by the user. This is not recommended as it
367# only works with IPv4 connections.
368#
369# When using this method you must specify a wildcard mask or CIDR range to allow
370# gateway connections from. You can also optionally configure the static value
371# that replaces the IP in the ident to avoid leaking the real IP address of
372# gateway clients (defaults to "gateway" if not set).
373#
374# <cgihost type="ident"
375# mask="198.51.100.0/24"
376# newident="wibble">
377# <cgihost type="ident"
378# mask="*.ident.gateway.example.com"
379# newident="wobble">
380#
381# By default gateway connections are logged to the +w snomask. If you
382# do not want this to happen then you can uncomment this to disable it.
383# <cgiirc opernotice="no">
384
385# IMPORTANT NOTE:
386# ---------------
387#
388# When you connect gateway clients, there are two connect classes which
389# apply to these clients. When the client initially connects, the connect
390# class which matches the gateway site's host is checked. Therefore you
391# must raise the maximum local/global clients for this IP as high as you
392# want to allow gateway clients. After the client has connected and is
393# determined to be a gateway client, the class which matches the client's
394# real IP is then checked. You may set this class to a lower value, so that
395# the real IP of the client can still be restricted to, for example, 3
396# sessions maximum.
397
398#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
399# Channel create module: Adds snomask +j, which will notify opers of
400# any new channels that are created.
401# This module is oper-only.
402<module name="chancreate">
403
404#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
405# Channel filter module: Allows channel-op defined message filtering
406# using simple string matches (channel mode +g).
407<module name="chanfilter">
408#
409# If hidemask is set to yes, the user will not be shown the mask when
410# their message is blocked.
411#
412# If maxlen is set then it defines the maximum length of a filter entry.
413#
414# If notifyuser is set to no, the user will not be notified when
415# their message is blocked.
416#<chanfilter hidemask="yes" maxlen="50" notifyuser="yes">
417
418#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
419# Channel history module: Displays the last 'X' lines of chat to a user
420# joining a channel with +H 'X:T' set; 'T' is the maximum time to keep
421# lines in the history buffer. Designed so that the new user knows what
422# the current topic of conversation is when joining the channel.
423<module name="chanhistory">
424#
425# Set the maximum number of lines allowed to be stored per channel below.
426# This is the hard limit for 'X'.
427# If notice is set to yes, joining users will get a NOTICE before playback
428# telling them about the following lines being the pre-join history.
429# If bots is set to yes, it will also send to users marked with +B
430#<chanhistory maxlines="50" notice="yes" bots="yes">
431
432#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
433# Channel logging module: Used to send snotice output to channels, to
434# allow staff to centrally monitor and discuss network activity.
435#
436# The "channel" field is where you want the messages to go, "snomasks"
437# is what snomasks you want to be sent to that channel. Multiple tags
438# are allowed.
439<module name="chanlog">
440#<chanlog snomasks="AOcC" channel="#opers">
441
442#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
443# Channel names module: Allows disabling channels which have certain
444# characters in the channel name such as bold, colorcodes, etc. which
445# can be quite annoying and allow users to on occasion have a channel
446# that looks like the name of another channel on the network.
447<module name="channames">
448
449#<channames
450 # denyrange: characters or range of characters to deny in channel
451 # names.
452 #denyrange="2,3"
453
454 # allowrange: characters or range of characters to specifically allow
455 # in channel names.
456 #allowrange="">
457
458#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
459# Channelban: Implements extended ban j:, which stops anyone already
460# in a channel matching a ban like +b j:#channel from joining.
461# It is also possible to ban based on their status in that channel,
462# like so: +b j:@#channel, this example prevents the ops from joining.
463# Note that by default wildcard characters * and ? are allowed in
464# channel names. To disallow them, load the channames module and
465# add characters 42 and 63 to denyrange (see above).
466<module name="channelban">
467
468#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
469# Check module: Adds the /CHECK command.
470# Check is useful for looking up information on channels, users,
471# IP addresses and hosts.
472# This module is oper-only.
473# To use, CHECK must be in one of your oper class blocks.
474<module name="check">
475
476#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
477# CHGHOST module: Adds the /CHGHOST command.
478# This module is oper-only.
479# To use, CHGHOST must be in one of your oper class blocks.
480# NOTE: Services will not be able to set vhosts on users if this module
481# isn't loaded. If you're planning on running services, you probably
482# want to load this.
483<module name="chghost">
484#
485#-#-#-#-#-#-#-#-# /CHGHOST - /SETHOST CONFIGURATION #-#-#-#-#-#-#-#-#
486# Optional - If you want to use special chars for hostnames you can #
487# specify your own custom list of chars with the <hostname> tag: #
488# #
489# charmap - A list of chars accepted as valid by the /CHGHOST #
490# and /SETHOST commands. Also note that the list is #
491# case-sensitive. #
492#<hostname charmap="abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ.-_/0123456789">
493
494#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
495# CHGIDENT module: Adds the /CHGIDENT command.
496# This module is oper-only.
497# To use, CHGIDENT must be in one of your oper class blocks.
498<module name="chgident">
499
500#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
501# CHGNAME module: Adds the /CHGNAME command.
502# This module is oper-only.
503# To use, CHGNAME must be in one of your oper class blocks.
504<module name="chgname">
505#
506#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
507# Connection class ban module: Adds support for extban 'n' which
508# matches against the class name of the user's connection.
509# This module assumes that connection classes are named in a uniform
510# way on all servers of the network. Wildcards are accepted.
511<module name="classban">
512
513#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
514# Clear chan module: Allows opers to masskick, masskill or
515# mass G/Z-line all users on a channel using /CLEARCHAN.
516<module name="clearchan">
517
518#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
519# Cloaking module: Adds user mode +x and cloaking support.
520# Relies on the md5 module being loaded.
521# To cloak users when they connect, load the conn_umodes module and set
522# <connect:modes> to include the +x mode. The example <connect> tag
523# shows this. See the conn_umodes module for more information.
524<module name="cloaking">
525#
526#-#-#-#-#-#-#-#-#-#-#- CLOAKING CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#
527# #
528# To use cloaking, you must define a cloak key, and optionally a #
529# cloak prefix as shown below. The cloak key must be shared across #
530# the network for consistent cloaking and must be at least thirty #
531# characters long. #
532# #
533# There are two methods of cloaking: #
534# #
535# half Cloak only the "unique" portion of a host; by #
536# default show the last 2 parts of the domain, #
537# /16 subnet of IPv4 or /48 subnet of the IPv6 #
538# address. #
539# To change the number of shown parts, modify the #
540# domainparts option. #
541# #
542# full Cloak the users completely, using three slices for #
543# common CIDR bans (IPv4: /16, /24; IPv6: /48, /64). #
544# #
545# The methods use a single key that can be any length of text. #
546# An optional prefix may be specified to mark cloaked hosts. #
547# #
548# IMPORTANT: Changing these details will break all of your existing #
549# bans. If you do not want this to happen you can define multiple #
550# cloak tags. The first will be used for cloaking and the rest will #
551# be used for checking if a user is banned in a channel. #
552#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
553#
554#<cloak mode="half"
555# key="changeme"
556# domainparts="3"
557# prefix="net-"
558# ignorecase="no">
559#
560#<cloak mode="full"
561# key="changeme"
562# prefix="net-"
563# ignorecase="no">
564
565#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
566# Clones module: Adds an oper command /CLONES for detecting cloned
567# users. Warning: This command may be resource intensive when it is
568# issued, use with care.
569# This module is oper-only.
570# To use, CLONES must be in one of your oper class blocks.
571<module name="clones">
572
573#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
574# Common channels module: Adds user mode +c, which, when set, requires
575# that users must share a common channel with you to PRIVMSG or NOTICE
576# you.
577<module name="commonchans">
578
579#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
580# Auto join on connect module: Allows you to force users to join one
581# or more channels automatically upon connecting to the server, or
582# join them in case they aren't on any channels after being online
583# for X seconds.
584<module name="conn_join">
585#
586#-#-#-#-#-#-#-#-#-#-#-#- CONNJOIN CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
587#
588# If you have the conn_join module loaded, you can configure it below
589# or set autojoin="#chat,#help" in <connect> blocks.
590#
591# Join users immediately after connection to #one #two and #three.
592#<autojoin channel="#one,#two,#three">
593# Join users to #chat after 15 seconds if they aren't on any channels.
594#<autojoin channel="#chat" delay="15">
595
596#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
597# Set modes on connect module: When this module is loaded <connect>
598# blocks may have an optional modes="" value, which contains modes to
599# add or remove from users when they connect to the server.
600<module name="conn_umodes">
601
602#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
603# Wait for PONG on connect module: Send a PING to all connecting users
604# and don't let them connect until they reply with a PONG.
605# This is useful to stop certain kinds of bots and proxies.
606<module name="conn_waitpong">
607#
608#-#-#-#-#-#-#-#-#-#-#- WAITPONG CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
609# #
610# If you have the conn_waitpong module loaded, configure it with the #
611# <waitpong> tag: #
612# #
613# sendsnotice - Whether to send a helpful notice to users on #
614# connect telling them how to connect, should #
615# their client not reply PONG automatically. #
616# #
617# killonbadreply - Whether to kill the user if they send the wrong #
618# PONG reply. #
619# #
620#<waitpong sendsnotice="yes" killonbadreply="yes">
621
622#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
623# Channel cycle module: Adds the /CYCLE command which is a server-side
624# /HOP that bypasses restrictive modes.
625<module name="cycle">
626
627#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
628# Connectban: Provides IP connection throttling. Any IP range that
629# connects too many times (configurable) in an hour is Z-lined for a
630# (configurable) duration, and their count resets to 0.
631<module name="connectban">
632#
633# ipv4cidr and ipv6cidr allow you to turn the comparison from
634# individual IP addresses (32 and 128 bits) into CIDR masks, to allow
635# for throttling over whole ISPs/blocks of IPs, which may be needed to
636# prevent attacks.
637#
638# This allows for 10 connections in an hour with a 10 minute ban if
639# that is exceeded.
640#<connectban threshold="10" duration="10m" ipv4cidr="32" ipv6cidr="128"
641# A custom ban message may optionally be specified.
642# 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.">
643
644#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
645# Connection throttle module.
646<module name="connflood">
647#
648#-#-#-#-#-#-#-#-#-#-#- CONNTHROTTLE CONFIGURATION -#-#-#-#-#-#-#-#-#-#
649# period, maxconns - Amount of connections per <period>.
650#
651# timeout - Time to wait after the throttle was activated
652# before deactivating it. Be aware that the time
653# is seconds + timeout.
654#
655# quitmsg - The message that users get if they attempt to
656# connect while the throttle is active.
657#
658# bootwait - Amount of time in seconds to wait before enforcing
659# the throttling when the server just booted.
660#
661#<connflood period="30" maxconns="3" timeout="30"
662# quitmsg="Throttled" bootwait="2m">
663
664#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
665# Custom prefixes: Allows for channel prefixes to be configured.
666<module name="customprefix">
667#
668# name The name of the mode, must be unique from other modes.
669# letter The letter used for this mode. Required.
670# prefix The prefix used for nicks with this mode. Not required.
671# rank A numeric rank for this prefix, defining what permissions it gives.
672# The rank of voice, halfop and op is 10000, 20000, and 30000,
673# respectively.
674# ranktoset The numeric rank required to set this mode. Defaults to rank.
675# ranktounset The numeric rank required to unset this mode. Defaults to ranktoset.
676# depriv Can you remove the mode from yourself? Defaults to yes.
677#<customprefix name="founder" letter="q" prefix="~" rank="50000" ranktoset="50000">
678#<customprefix name="admin" letter="a" prefix="&" rank="40000" ranktoset="50000">
679#<customprefix name="halfop" letter="h" prefix="%" rank="20000" ranktoset="30000">
680#
681# You can also override the configuration of prefix modes added by both the core
682# and other modules by adding a customprefix tag with change="yes" specified.
683# <customprefix name="op" change="yes" rank="30000" ranktoset="30000">
684# <customprefix name="voice" change="yes" rank="10000" ranktoset="20000" depriv="no">
685#
686# Do /RELOADMODULE customprefix after changing the settings of this module.
687
688#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
689# Custom title module: Adds the /TITLE command which allows for trusted
690# users to gain a custom whois line and an optional vhost can be
691# specified.
692<module name="customtitle">
693#
694#-#-#-#-#-#-#-#-#-#- CUSTOM TITLE CONFIGURATION -#-#-#-#-#-#-#-#-#-#
695# name - The username used to identify.
696# password - The password used to identify.
697# hash - The hash for the specific user's password (optional).
698# password_hash and a hashing module must be loaded
699# for this to work.
700# host - Allowed hostmask (optional).
701# title - Title shown in whois.
702# vhost - Displayed host (optional).
703#
704#<title name="foo" password="bar" title="Official Chat Helper">
705#<title name="bar" password="foo" host="ident@test.org" title="Official Chat Helper" vhost="helper.test.org">
706#<title name="foo" password="$2a$10$UYZ4OcO8NNTCCGyCdY9SK.2GHiqGgxZfHFPOPmWuxEVWVQTtoDC7C" hash="bcrypt" title="Official Chat Helper">
707
708#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
709# DCCALLOW module: Adds the /DCCALLOW command.
710<module name="dccallow">
711#
712#-#-#-#-#-#-#-#-#-#-#- DCCALLOW CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
713# blockchat - Whether to block DCC CHAT as well as DCC SEND.
714# length - Default duration of entries in DCCALLOW list.
715# action - Default action to take if no action is
716# specified, can be 'block' or 'allow'.
717# maxentries - Max number of nicks to allow on a DCCALLOW list.
718#
719# File configuration:
720# pattern - The glob pattern to match against.
721# action - Action to take if a user attempts to send a file
722# that matches this pattern, can be 'block' or
723# 'allow'.
724#
725#<dccallow blockchat="yes" length="5m" action="block" maxentries="20">
726#<banfile pattern="*.exe" action="block">
727#<banfile pattern="*.txt" action="allow">
728
729#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
730# Deaf module: Adds support for user modes +d and +D:
731# d - deaf to channel messages and notices.
732# D - deaf to user messages and notices.
733# The +D user mode is not enabled by default to enable link compatibility
734# with 2.0 servers.
735<module name="deaf">
736#
737#-#-#-#-#-#-#-#-#-#-#-#- DEAF CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#
738# bypasschars - Characters that bypass deaf to a regular user.
739# bypasscharsuline - Characters that bypass deaf to a U-lined user (services).
740# Both of these take a list of characters that must match
741# the starting character of a message.
742# If 'bypasscharsuline' is empty, then 'bypasschars' will
743# match for both regular and U-lined users.
744# enableprivdeaf - Whether to enable user mode +D (privdeaf).
745# privdeafuline - Whether U-lined users bypass user mode +D (privdeaf).
746#
747#<deaf bypasschars="" bypasscharsuline="!" enableprivdeaf="no" privdeafuline="yes">
748
749#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
750# Delay join module: Adds the channel mode +D which delays all JOIN
751# messages from users until they speak. If they quit or part before
752# speaking, their quit or part message will not be shown to the channel
753# which helps cut down noise on large channels in a more friendly way
754# than the auditorium mode. Only channel ops may set the +D mode.
755<module name="delayjoin">
756
757#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
758# Delay message module: Adds the channel mode +d which disallows a user
759# from talking in the channel unless they've been joined for X seconds.
760# Settable using /MODE #chan +d 30
761<module name="delaymsg">
762# Set allownotice to no to disallow NOTICEs too. Defaults to yes.
763#<delaymsg allownotice="no">
764
765#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
766# Deny channels module: Deny channels from being used by users.
767<module name="denychans">
768#
769#-#-#-#-#-#-#-#-#-#-#- DENYCHAN DEFINITIONS -#-#-#-#-#-#-#-#-#-#-#-#
770# #
771# If you have the denychans module loaded, you need to specify the #
772# channels to deny: #
773# #
774# name - The channel name to deny (glob masks are ok). #
775# allowopers - If operators are allowed to override the deny. #
776# reason - Reason given for the deny. #
777# redirect - Redirect the user to a different channel. #
778# #
779#<badchan name="#gods*" allowopers="yes" reason="Tortoises!"> #
780#<badchan name="#chan1" redirect="#chan2" reason="Chan1 is closed"> #
781# #
782# Redirects will not work if the target channel is set +L. #
783# #
784# Additionally, you may specify channels which are allowed, even if #
785# a badchan tag specifies it would be denied: #
786#<goodchan name="#funtimes"> #
787# Glob masks are accepted here also. #
788
789#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
790# Disable module: Provides support for disabling commands and modes. #
791<module name="disable">
792#
793#-#-#-#-#-#-#-#-#-#-#-#- DISABLE CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#
794# #
795# If you have the disable module loaded then you need to specify the #
796# commands and modes that you want disabled. Users who have not fully #
797# connected yet are exempt from this module so you can e.g. disable #
798# the NICK command but still allow users to connect to the server. #
799# #
800# commands - A space-delimited list of commands that can not be used #
801# by users. You can exempt server operators from this with #
802# the servers/use-disabled-commands privilege. #
803# #
804# chanmodes - One or more channel modes that can not be added/removed #
805# by users. You can exempt server operators from this #
806# with the servers/use-disabled-modes privilege. #
807# #
808# usermodes - One or more user modes that can not be added/removed by #
809# users. You can exempt server operators from this with #
810# the servers/use-disabled-modes privilege. #
811# #
812# fakenonexistent - Whether to pretend that a disabled command/mode #
813# does not exist when executed/changed by a user. #
814# Defaults to no. #
815# #
816# notifyopers - Whether to send a notice to snomask `a` when a user #
817# is prevented from using a disabled command/mode. #
818# Defaults to no. #
819# #
820#<disabled commands="KICK TOPIC" #
821# chanmodes="kp" #
822# usermodes="iw" #
823# fakenonexistent="yes" #
824# notifyopers="no"> #
825
826#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
827# DNS blacklist module: Provides support for looking up IPs on one or #
828# more blacklists. #
829<module name="dnsbl">
830# #
831# For configuration options please see the docs page for dnsbl at #
832# https://docs.inspircd.org/3/modules/dnsbl #
833
834#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
835# Exempt channel operators module: Provides support for allowing #
836# users of a specified channel status to be exempt from some channel #
837# restriction modes. Supported restrictions are: #
838# anticaps, auditorium-see, auditorium-vis, blockcaps, blockcolor, #
839# censor, filter, flood, nickflood, noctcp, nonick, nonotice, #
840# regmoderated, stripcolor, and topiclock. #
841# See <options:exemptchanops> in inspircd.conf.example for a more #
842# detailed list of the restriction modes that can be exempted. #
843# These are settable using: /MODE #chan +X <restriction>:<status> #
844<module name="exemptchanops">
845
846#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
847# Filter module: Provides message filtering, similar to SPAMFILTER. #
848<module name="filter">
849# #
850# This module depends upon a regex provider such as regex_pcre or #
851# regex_glob to function. You must specify which of these you want #
852# the filter module to use via the tag below. #
853# #
854# Valid engines are: #
855# #
856# glob - Glob patterns, provided via regex_glob. #
857# pcre - PCRE regexps, provided via regex_pcre, needs libpcre. #
858# tre - TRE regexps, provided via regex_tre, requires libtre. #
859# posix - POSIX regexps, provided via regex_posix, not available #
860# on Windows, no dependencies on other operating systems. #
861# stdlib - stdlib regexps, provided via regex_stdlib, see comment #
862# at the <module> tag for info on availability. #
863# #
864# If notifyuser is set to no, the user will not be notified when #
865# their message is blocked. #
866# #
867# If warnonselfmsg is set to yes when a user sends a message to #
868# themself that matches a filter the filter will be ignored and a #
869# warning will be sent to opers instead. This stops spambots which #
870# send their spam message to themselves first to check if it is being #
871# filtered by the server. #
872#<filteropts engine="glob" notifyuser="yes" warnonselfmsg="no">
873# #
874# Your choice of regex engine must match on all servers network-wide. #
875# #
876# To learn more about the configuration of this module, read #
877# examples/filter.conf.example, which covers the various types of #
878# filters and shows how to add exemptions. #
879# #
880#-#-#-#-#-#-#-#-#-#-#- FILTER CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#
881# #
882# Optional - If you specify to use the filter module, then #
883# specify below the path to the filter.conf file, or define some #
884# <keyword> tags. #
885# #
886<include file="examples/filter.conf.example">
887
888#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
889# Flash Policy Daemon module: Allows Flash IRC clients (e.g. LightIRC)#
890# to connect. If no file is specified, it'll serve a default policy #
891# allowing all IPs to connect to all plaintext IRC ports #
892#<bind address="" port="8430" type="flashpolicyd"> #
893#<flashpolicyd timeout="5" file=""> #
894<module name="flashpolicyd"> #
895
896#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
897# Real name ban: Implements two extended bans: #
898# 'a', which matches a n!u@h+realname mask like +b a:*!*@host+*real* #
899# 'r', which matches a realname mask like +b r:*realname?here* #
900<module name="gecosban">
901
902#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
903# Geolocation ban module: Adds support for extban 'G' which matches #
904# against the ISO 3166-1 alpha-2 codes for the countries that users #
905# are connecting from. Users connecting from unknown origins such as #
906# internal networks can be matched against using the XX alpha-2 code. #
907# A full list of ISO 3166-1 alpha-2 codes can be found at #
908# https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2 #
909<module name="geoban">
910
911#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
912# Geolocation connect class module: Adds support for limiting connect #
913# classes to users from specific countries. With this module you can #
914# specify a space-delimited list of two character the ISO 3166-1 #
915# alpha-2 codes in the "country" field of a connect class. e.g. to #
916# deny connections from users in Russia or Turkey: #
917# #
918# <connect deny="*" country="TR RU"> #
919# #
920# Users connecting from unknown origins such as internal networks can #
921# be matched against using the XX alpha-2 code. A full list of ISO #
922# 3166-1 alpha-2 codes can be found at #
923# https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2 #
924<module name="geoclass">
925
926#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
927# MaxMindDB geolocation module: Provides geolocation information for #
928# other modules that need it using the libMaxMindDB library. #
929# #
930# This module is in extras. Re-run configure with: #
931# ./configure --enable-extras=m_geo_maxmind.cpp
932# and run make install, then uncomment this module to enable it. #
933# #
934# This module requires libMaxMindDB to be installed on your system. #
935# Use your package manager to find the appropriate packages or check #
936# the InspIRCd documentation page for this module. #
937<module name="geo_maxmind">
938# #
939# If you use the geo_maxmind module you MUST provide a database file #
940# to look up geolocation information in. You can either purchase this #
941# from MaxMind at https://www.maxmind.com/en/geoip2-country-database #
942# or use the free CC-BY-SA licensed GeoLite2 Country database which #
943# can be downloaded at https://dev.maxmind.com/geoip/geoip2/geolite2/ #
944#<maxmind file="GeoLite2-Country.mmdb">
945
946#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
947# Globops module: Provides the /GLOBOPS command and snomask +g.
948# This module is oper-only.
949# To use, GLOBOPS must be in one of your oper class blocks.
950<module name="globops">
951
952#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
953# Global load module: Allows loading and unloading of modules network-
954# wide (USE WITH EXTREME CAUTION!)
955# This module is oper-only and provides /GLOADMODULE, /GUNLOADMODULE
956# and /GRELOADMODULE.
957# To use, GLOADMODULE, GUNLOADMODULE and GRELOADMODULE
958# must be in one of your oper class blocks.
959<module name="globalload">
960
961#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
962# HAProxy module: Adds support for the HAProxy PROXY v2 protocol. To
963# use this module specify hook="haproxy" in the <bind> tag that HAProxy
964# has been configured to connect to.
965<module name="haproxy">
966
967#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
968# HELPOP module: Provides the /HELPOP command
969<module name="helpop">
970#
971#-#-#-#-#-#-#-#-#-#-#-#- HELPOP CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
972# #
973# If you specify to use the helpop module, then specify below the #
974# path to the helpop.conf file. #
975# #
976<include file="examples/helpop.conf.example">
977
978#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
979# Hide chans module: Allows users to hide their channels list from non-
980# opers by setting user mode +I on themselves.
981<module name="hidechans">
982#
983# This mode can optionally prevent opers from seeing channels on a +I
984# user, for more privacy if set to true.
985# This setting is not recommended for most mainstream networks.
986#<hidechans affectsopers="false">
987
988#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
989# Hide list module: Allows for hiding the list of listmodes from users
990# who do not have sufficient channel rank.
991<module name="hidelist">
992#
993# Each <hidelist> tag configures one listmode to hide.
994# mode: Name of the listmode to hide.
995# rank: Minimum rank required to view the list. If set to 0, all
996# members of the channel may view the list, but non-members may not.
997# The rank of the built-in op and voice mode is 30000 and 10000,
998# respectively; the rank of other prefix modes is configurable.
999# Defaults to 20000.
1000#
1001# Hiding the ban list is not recommended because it may break some
1002# clients.
1003#
1004# Hide filter (+g) list:
1005#<hidelist mode="filter" rank="30000">
1006# Only show invite exceptions (+I) to channel members:
1007#<hidelist mode="invex" rank="0">
1008
1009#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1010# Hide mode module: Allows for hiding mode changes from users who do not
1011# have sufficient channel privileges.
1012<module name="hidemode">
1013#
1014# Hide bans (+b) from people who are not voiced:
1015#<hidemode mode="ban" rank="10000">
1016
1017#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1018# Hide oper module: Allows opers to hide their oper status from non-
1019# opers by setting user mode +H on themselves.
1020# This module is oper-only.
1021<module name="hideoper">
1022
1023#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1024# Hostchange module: Allows a different style of cloaking.
1025<module name="hostchange">
1026#
1027#-#-#-#-#-#-#-#-#-#-#- HOSTCHANGE CONFIGURATION -#-#-#-#-#-#-#-#-#-#
1028# #
1029# See https://docs.inspircd.org/3/modules/hostchange for help. #
1030# #
1031#<hostchange mask="*@42.theanswer.example.org" action="addaccount" suffix=".users.example.com">
1032#<hostchange mask="*root@*" action="addnick" prefix="example/users/">
1033#<hostchange mask="a@example.com" action="set" value="foo.bar.baz">
1034#<hostchange mask="*@localhost" ports="7000,7001,7005-7007" action="set" value="blahblah.foo">
1035
1036# hostcycle: If loaded, when a user gets a host or ident set, it will
1037# cycle them in all their channels. If not loaded it will simply change
1038# their host/ident without cycling them.
1039# This module is compatible with the ircv3_chghost module. Clients
1040# supporting the chghost extension will get the chghost message instead
1041# of seeing a host cycle.
1042<module name="hostcycle">
1043
1044#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1045# httpd module: Provides HTTP server support for InspIRCd.
1046<module name="httpd">
1047#
1048#-#-#-#-#-#-#-#-#-#-#-#- HTTPD CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
1049#
1050# If you choose to use the httpd module, then you will need to add
1051# a <bind> tag with type "httpd", and load at least one of the other
1052# httpd_* modules to provide pages to display.
1053# <bind address="127.0.0.1" port="8067" type="httpd">
1054# <bind address="127.0.0.1" port="8097" type="httpd" ssl="gnutls">
1055#
1056# You can adjust the timeout for HTTP connections below. All HTTP
1057# connections will be closed after (roughly) this time period.
1058#<httpd timeout="20">
1059
1060#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1061# HTTP ACL module: Provides access control lists for httpd dependent
1062# modules. Use this module to restrict pages by IP address and by
1063# password.
1064<module name="httpd_acl">
1065#
1066#-#-#-#-#-#-#-#-#-#-#-#- HTTPD ACL CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
1067#
1068# Restrict access to the httpd_stats module to all but the local
1069# network and when the correct password is specified:
1070# <httpdacl path="/stats*" types="password,whitelist"
1071# username="secrets" password="mypasshere" whitelist="127.0.0.*,10.*">
1072#
1073# Deny all connections to all but the main index page:
1074# <httpdacl path="/*" types="blacklist" blacklist="*">
1075
1076#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1077# HTTP config module: Allows the server configuration to be viewed over
1078# HTTP via the /config path. Requires the httpd module to be loaded for
1079# it to function.
1080#
1081# IMPORTANT: This module exposes extremely sensitive information about
1082# your server and users so you *MUST* protect it using a local-only
1083# <bind> tag and/or the httpd_acl module. See above for details.
1084<module name="httpd_config">
1085
1086#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1087# HTTP stats module: Provides server statistics over HTTP via the /stats
1088# path. Requires the httpd module to be loaded for it to function.
1089#
1090# IMPORTANT: This module exposes extremely sensitive information about
1091# your server and users so you *MUST* protect it using a local-only
1092# <bind> tag and/or the httpd_acl module. See above for details.
1093<module name="httpd_stats">
1094
1095#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1096# Ident: Provides RFC 1413 ident lookup support.
1097# When this module is loaded <connect:allow> tags may have an optional
1098# useident="yes|no" boolean value, determining whether or not to lookup
1099# ident on users matching that connect tag.
1100<module name="ident">
1101#
1102#-#-#-#-#-#-#-#-#-#-#-#- IDENT CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
1103# #
1104# Optional - If you are using the ident module, then you can specify #
1105# the timeout for ident lookups here. If not defined, it will default #
1106# to 5 seconds. This is a non-blocking timeout which holds the user #
1107# in a 'connecting' state until the lookup is complete. #
1108# prefixunqueried: If on, the idents of users being in a connect class#
1109# with ident lookups disabled (i.e. <connect useident="off">) will be #
1110# prefixed with a "~". If off, the ident of those users will not be #
1111# prefixed. Default is off. #
1112#
1113#<ident timeout="5" prefixunqueried="no">
1114
1115#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1116# Invite exception module: Adds support for channel invite exceptions
1117# (+I).
1118<module name="inviteexception">
1119# bypasskey: If this is enabled, exceptions will bypass +k as well as +i
1120#<inviteexception bypasskey="yes">
1121
1122#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1123# IRCv3 module: Provides the following IRCv3 extensions:
1124# extended-join, away-notify and account-notify. These are optional
1125# enhancements to the client-to-server protocol. An extension is only
1126# active for a client when the client specifically requests it, so this
1127# module needs the cap module to work.
1128#
1129# Further information on these extensions can be found at the IRCv3
1130# working group website:
1131# https://ircv3.net/irc/
1132#
1133<module name="ircv3">
1134# The following block can be used to control which extensions are
1135# enabled. Note that extended-join can be incompatible with delayjoin
1136# and host cycling.
1137#<ircv3 accountnotify="on" awaynotify="on" extendedjoin="on">
1138
1139#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1140# IRCv3 account-tag module. Adds the 'account' tag which contains the
1141# services account name of the message sender.
1142<module name="ircv3_accounttag">
1143
1144#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1145# IRCv3 batch module: Provides the batch IRCv3 extension which allows
1146# the server to inform a client that a group of messages are related to
1147# each other.
1148<module name="ircv3_batch">
1149
1150#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1151# IRCv3 cap-notify module: Provides the cap-notify IRCv3 extension.
1152# Required for IRCv3 conformance.
1153<module name="ircv3_capnotify">
1154
1155#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1156# IRCv3 chghost module: Provides the chghost IRCv3 extension which
1157# allows capable clients to learn when the host/ident of another user
1158# changes without cycling the user. This module is compatible with the
1159# hostcycle module. If both are loaded, clients supporting the chghost
1160# extension will get the chghost message and won't see host cycling.
1161<module name="ircv3_chghost">
1162
1163#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1164# IRCv3 client-to-client tags module: Provides the message-tags IRCv3
1165#Â extension which allows clients to add extra data to their messages.
1166# This is used to support new IRCv3 features such as replies and ids.
1167<module name="ircv3_ctctags">
1168
1169#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1170# IRCv3 echo-message module: Provides the echo-message IRCv3
1171# extension which allows capable clients to get an acknowledgement when
1172# their messages are delivered and learn what modifications, if any,
1173# were applied to them.
1174<module name="ircv3_echomessage">
1175
1176#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1177# IRCv3 invite-notify module: Provides the invite-notify IRCv3
1178# extension which notifies supporting clients when a user invites
1179# another user into a channel. This respects <options:announceinvites>.
1180<module name="ircv3_invitenotify">
1181
1182#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1183# IRCv3 message id module: Provides the msgid IRCv3 extension which
1184# adds a unique identifier to each message when the message-tags cap
1185# has been requested. This enables support for modern features such as
1186# reactions and replies.
1187<module name="ircv3_msgid">
1188
1189#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1190# IRCv3 server-time module. Adds the 'time' tag which adds a timestamp
1191# to all messages received from the server.
1192<module name="ircv3_servertime">
1193
1194#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1195# IRCv3 Strict Transport Security module: Provides the sts IRCv3
1196# extension which allows clients connecting insecurely to upgrade their
1197# connections to TLS.
1198<module name="ircv3_sts">
1199#
1200# If using the ircv3_sts module you MUST define a STS policy to send
1201# to clients using the <sts> tag. This tag takes the following
1202# attributes:
1203#
1204# host - A glob match for the SNI hostname to apply this policy to.
1205# duration - The amount of time that the policy lasts for. Defaults to
1206# approximately two months by default.
1207# port - The port on which TLS connections to the server are being
1208# accepted. You MUST have a CA-verified certificate on this
1209# port. Self signed certificates are not acceptable.
1210# preload - Whether client developers can include your certificate in
1211# preload lists.
1212#
1213# <sts host="*.example.com" duration="60d" port="6697" preload="yes">
1214
1215#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1216# Join flood module: Adds support for join flood protection +j X:Y.
1217# Closes the channel for N seconds if X users join in Y seconds.
1218<module name="joinflood">
1219#
1220# The number of seconds to close the channel for:
1221#<joinflood duration="1m">
1222
1223#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1224# Anti auto rejoin: Adds support for prevention of auto-rejoin (+J).
1225<module name="kicknorejoin">
1226
1227#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1228# Knock module: Adds the /KNOCK command and channel mode +K.
1229<module name="knock">
1230#
1231# This setting specifies what to do when someone successfully /KNOCKs.
1232# If set to "notice", then a NOTICE will be sent to the channel.
1233# This is the default and the compatible setting, as it requires no
1234# special support from the clients.
1235# If set to "numeric" then a 710 numeric will be sent to the channel.
1236# This allows easier scripting but not all clients support it.
1237# If set to "both" then (surprise!) both will be sent.
1238#<knock notify="notice">
1239
1240#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1241# LDAP module: Allows other SQL modules to access a LDAP database
1242# through a unified API.
1243# This modules is in extras. Re-run configure with:
1244# ./configure --enable-extras=m_ldap.cpp
1245# and run make install, then uncomment this module to enable it.
1246#
1247<module name="ldap">
1248#<database module="ldap" id="ldapdb" server="ldap://localhost" binddn="cn=Manager,dc=inspircd,dc=org" bindauth="mysecretpass" searchscope="subtree">
1249# The server parameter indicates the LDAP server to connect to. The #
1250# ldap:// style scheme before the hostname proper is MANDATORY. #
1251# #
1252# The binddn and bindauth indicate the DN to bind to for searching, #
1253# and the password for the distinguished name. Some LDAP servers will #
1254# allow anonymous searching in which case these two values do not #
1255# need defining, otherwise they should be set similar to the examples #
1256# above. #
1257# #
1258# The searchscope value indicates the subtree to search under. On our #
1259# test system this is 'subtree'. Your mileage may vary. #
1260
1261#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1262# LDAP authentication module: Adds the ability to authenticate users #
1263# via LDAP. #
1264<module name="ldapauth">
1265# #
1266# Configuration: #
1267# #
1268# <ldapauth dbid="ldapdb" #
1269# baserdn="ou=People,dc=brainbox,dc=cc" #
1270# attribute="uid" #
1271# allowpattern="Guest* Bot*" #
1272# killreason="Access denied" #
1273# verbose="yes" #
1274# host="$uid.$ou.inspircd.org" #
1275# useusername="no"> #
1276# #
1277# <ldapwhitelist cidr="10.42.0.0/16"> #
1278# #
1279# <ldaprequire attribute="attr" value="val"> #
1280# #
1281# The baserdn indicates the base DN to search in for users. Usually #
1282# this is 'ou=People,dc=yourdomain,dc=yourtld'. #
1283# #
1284# The attribute value indicates the attribute which is used to locate #
1285# a user account by name. On POSIX systems this is usually 'uid'. #
1286# #
1287# The allowpattern value allows you to specify a space separated list #
1288# of wildcard masks which will always be allowed to connect #
1289# regardless of if they have an account, for example guest and bot #
1290# users. #
1291# #
1292# The useusername setting chooses whether the user's username or #
1293# nickname is used when locating a user account, if a username isn't #
1294# provided in PASS. #
1295# #
1296# Killreason indicates the QUIT reason to give to users if they fail #
1297# to authenticate. #
1298# #
1299# Setting the verbose value causes an oper notice to be sent out for #
1300# every failed authentication to the server, with an error string. #
1301# #
1302# ldapwhitelist indicates that clients connecting from an IP in the #
1303# provided CIDR do not need to authenticate against LDAP. It can be #
1304# repeated to whitelist multiple CIDRs. #
1305# #
1306# ldaprequire allows further filtering on the LDAP user, by requiring #
1307# certain LDAP attibutes to have a given value. It can be repeated, #
1308# in which case the list will act as an OR list, that is, the #
1309# authentication will succeed if any of the requirements in the list #
1310# is satisfied. #
1311# #
1312# host allows you to change the displayed host of users connecting #
1313# from ldap. The string supplied takes formatters which are replaced #
1314# from the DN. For instance, if your DN looks like: #
1315# uid=w00t,ou=people,dc=inspircd,dc=org, then the formatters uid, ou #
1316# and dc will be available to you. If a key is given multiple times #
1317# in the DN, the last appearance will take precedence. #
1318
1319#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1320# LDAP oper configuration module: Adds the ability to authenticate #
1321# opers via LDAP. #
1322<module name="ldapoper">
1323# #
1324# Configuration: #
1325# #
1326# <ldapoper dbid="ldapdb"
1327# baserdn="ou=People,dc=brainbox,dc=cc"
1328# attribute="uid">
1329# #
1330# Available configuration items are identical to the same items in #
1331# ldapauth above (except for the verbose setting, that is only #
1332# supported in ldapauth). #
1333# Please always specify a password in your <oper> tags even if the #
1334# opers are to be authenticated via LDAP, so in case this module is #
1335# not loaded the oper accounts are still protected by a password. #
1336
1337#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1338# Lock server module: Adds /LOCKSERV and /UNLOCKSERV commands that #
1339# are used to temporarily close/open the server for new connections. #
1340# These commands require that the /LOCKSERV and /UNLOCKSERV commands #
1341# are specified in a <class> tag that the oper is part of. This is so #
1342# you can control who has access to this possible dangerous command. #
1343# If your server is locked and you get disconnected, do a REHASH from #
1344# shell to open up again. #
1345# This module is oper-only.
1346<module name="lockserv">
1347
1348#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1349# Map hiding module: replaces /MAP and /LINKS output to users with a #
1350# message to see a website, set by maphide="https://test.org/map" in #
1351# the <security> tag, instead. #
1352<module name="maphide">
1353
1354#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1355# Message flood module: Adds message/notice flood protection via
1356# channel mode +f.
1357<module name="messageflood">
1358#
1359# The weight to give each message type. TAGMSGs are considered to be
1360# 1/5 of a NOTICE or PRIVMSG to avoid users being accidentally flooded
1361# out of a channel by automatic client features such as typing
1362# notifications.
1363#<messageflood notice="1.0" privmsg="1.0" tagmsg="0.2">
1364
1365#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1366# MLOCK module: Adds support for server-side enforcement of services
1367# side MLOCKs. Basically, this module suppresses any mode change that
1368# would likely be immediately bounced by services.
1369<module name="mlock">
1370
1371#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1372# Modenotice module: Adds the /MODENOTICE command that allows opers to
1373# send notices to all users having the given user mode(s) set.
1374<module name="modenotice">
1375
1376#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1377# Monitor module: Adds support for MONITOR which is used by clients to
1378# maintain notify lists.
1379<module name="monitor">
1380#
1381# Set the maximum number of entries on a user's monitor list below.
1382#<monitor maxentries="30">
1383
1384#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1385# MySQL module: Allows other SQL modules to access MySQL databases
1386# through a unified API.
1387# This module is in extras. Re-run configure with:
1388# ./configure --enable-extras=m_mysql.cpp
1389# and run make install, then uncomment this module to enable it.
1390<module name="mysql">
1391#
1392#-#-#-#-#-#-#-#-#-#-#-#- SQL CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#-#
1393# #
1394# mysql is more complex than described here, see the docs for more #
1395# info: https://docs.inspircd.org/3/modules/mysql #
1396#
1397#<database module="mysql" name="mydb" user="myuser" pass="mypass" host="localhost" id="my_database2">
1398
1399#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1400# Named modes module: Allows for the display and set/unset of channel
1401# modes via long-form mode names via +Z and the /PROP command.
1402# For example, to set a ban, do /MODE #channel +Z ban=foo!bar@baz or
1403# /PROP #channel ban=foo!bar@baz
1404<module name="namedmodes">
1405
1406#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1407# NAMESX module: Provides support for the NAMESX extension which allows
1408# clients to see all the prefixes set on a user without getting confused.
1409# This is supported by mIRC, x-chat, klient, and maybe more.
1410<module name="namesx">
1411
1412#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1413# National characters module:
1414# 1) Allows using national characters in nicknames.
1415# 2) Allows using custom (national) casemapping over the network.
1416<module name="nationalchars">
1417#
1418# file - Location of the file which contains casemapping rules. If this
1419# is a relative path then it is relative to "<PWD>/../locales"
1420# on UNIX and "<PWD>/locales" on Windows.
1421# casemapping - The name of the casemapping sent to clients in the 005
1422# numeric. If this is not set then it defaults to the name
1423# of the casemapping file unless the file name contains a
1424# space in which case you will have to specify it manually.
1425#<nationalchars file="bynets/russian-w1251-charlink" casemapping="ru_RU.cp1251-charlink">
1426
1427#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1428# Nickchange flood protection module: Provides channel mode +F X:Y
1429# which allows up to X nick changes in Y seconds.
1430<module name="nickflood">
1431#
1432# The number of seconds to prevent nick changes for:
1433#<nickflood duration="1m">
1434
1435#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1436# Nicklock module: Let opers change a user's nick and then stop that
1437# user from changing their nick again until unlocked.
1438# This module is oper-only.
1439# To use, NICKLOCK and NICKUNLOCK must be in one of your oper class blocks.
1440<module name="nicklock">
1441
1442#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1443# No CTCP module: Adds the channel mode +C and user mode +T to block
1444# CTCPs and extban 'C' to block CTCPs sent by specific users.
1445<module name="noctcp">
1446#
1447# The +T user mode is not enabled by default to enable link compatibility
1448# with 2.0 servers. You can enable it by uncommenting this:
1449#<noctcp enableumode="yes">
1450
1451#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1452# No kicks module: Adds the +Q channel mode and the Q: extban to deny
1453# certain users from kicking.
1454<module name="nokicks">
1455
1456#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1457# No nicks module: Adds the +N channel mode, as well as the 'N' extban.
1458# +N stops all users from changing their nick, the N extban stops
1459# anyone from matching a +b N:nick!user@host mask from changing their
1460# nick.
1461<module name="nonicks">
1462
1463#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1464# No part message module: Adds extban 'p' to block part messages from #
1465# matching users. #
1466<module name="nopartmsg">
1467
1468#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1469# No notice module: Adds the channel mode +T and the extban 'T' to
1470# block specific users from noticing the channel.
1471<module name="nonotice">
1472
1473#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1474# Network business join module:
1475# Allows an oper to join a channel using /OJOIN, giving them +Y on the
1476# channel which makes them immune to kicks.
1477<module name="ojoin">
1478#
1479# Specify the prefix that +Y will grant here.
1480# Leave 'prefix' empty if you do not wish +Y to grant a prefix.
1481# If 'notice' is set to on, upon /OJOIN, the server will notice the
1482# channel saying that the oper is joining on network business.
1483# If 'op' is set to on, it will give them +o along with +Y.
1484#<ojoin prefix="!" notice="yes" op="yes">
1485
1486#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1487# Oper channels mode: Adds the +O channel mode and extban O:<mask>
1488# to ban, except, etc. specific oper types. For example
1489# /MODE #channel +iI O:* is equivalent to channel mode +O, but you
1490# may also set +iI O:AdminTypeOnly to only allow admins.
1491# Modes +I and +e work in a similar fashion.
1492<module name="operchans">
1493
1494#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1495# Oper join module: Auto-joins opers to a channel upon oper-up.
1496# This module is oper-only. For the user equivalent, see the conn_join
1497# module.
1498<module name="operjoin">
1499#
1500#-#-#-#-#-#-#-#-#-#-# OPERJOIN CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
1501# #
1502# If you are using the operjoin module, specify options here: #
1503# #
1504# channel - The channel name to join, can also be a comma #
1505# separated list e.g. "#channel1,#channel2". #
1506# #
1507# override - If on, lets the oper join walking thru any modes #
1508# that might be set, even bans. #
1509# #
1510#<operjoin channel="#channel" override="no">
1511#
1512# Alternatively you can use the autojoin="channellist" in a <type> #
1513# tag to set specific autojoins for a type of oper, for example: #
1514#
1515#<type name="Helper" autojoin="#help" classes="...">
1516
1517#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1518# Oper log module: Logs all oper commands to the server log (with log
1519# type "m_operlog" at default loglevel), and optionally to the 'r'
1520# snomask.
1521# This module is oper-only.
1522<module name="operlog">
1523#
1524# If the following option is on then all oper commands will be sent to
1525# the snomask 'r'. The default is off.
1526#<operlog tosnomask="off">
1527
1528#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1529# Oper prefixing module: Adds a channel prefix mode +y which is given
1530# to all server operators automatically on all channels they are in.
1531# This prefix mode is more powerful than channel op and other regular
1532# prefix modes.
1533#
1534# Load this module if you want all your server operators to have
1535# channel operator powers.
1536<module name="operprefix">
1537#
1538# You may additionally customise the prefix character.
1539#<operprefix prefix="!">
1540
1541#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1542# Oper MOTD module: Provides support for a separate message of the day
1543# on oper-up.
1544# This module is oper-only.
1545<module name="opermotd">
1546#
1547#-#-#-#-#-#-#-#-#-#-# OPERMOTD CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
1548# #
1549# If you are using the opermotd module, specify the motd file here. #
1550# #
1551# onoper - If on, the message is sent on /OPER, otherwise it's #
1552# only sent when /OPERMOTD is used. #
1553# #
1554#<opermotd file="examples/opermotd.txt.example" onoper="yes">
1555
1556#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1557# Override module: Adds support for oper override.
1558# This module is oper-only.
1559<module name="override">
1560#
1561#-#-#-#-#-#-#-#-#-#-# OVERRIDE CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
1562# #
1563# Much of override's configuration relates to your oper blocks. #
1564# For more information on how to allow opers to override, see: #
1565# https://docs.inspircd.org/3/modules/override #
1566# #
1567# noisy - If enabled, all oper overrides will be announced #
1568# via channel notice. #
1569# #
1570# requirekey - If enabled, overriding on join requires a channel #
1571# key of "override" to be specified. #
1572# #
1573# enableumode - If enabled, user mode +O is required for override. #
1574# #
1575#<override noisy="yes" requirekey="no" enableumode="true">
1576
1577#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1578# Oper levels module: Gives each oper a level and prevents actions
1579# being taken by lower level opers against higher level opers.
1580# Specify the level as the 'level' parameter of the <type> tag.
1581# This module is oper-only.
1582<module name="operlevels">
1583
1584#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1585# Oper modes module: Allows you to specify modes to add/remove on oper.
1586# Specify the modes as the 'modes' parameter of the <type> tag
1587# and/or as the 'modes' parameter of the <oper> tag.
1588# This module is oper-only. For the user equivalent, see the
1589# conn_umodes module.
1590<module name="opermodes">
1591
1592#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1593# Password forwarding module: Forwards a password users can send on
1594# connect to the specified client below. The client is usually NickServ
1595# and this module is usually used to authenticate users with NickServ
1596# using their connect password.
1597<module name="passforward">
1598
1599<passforward
1600 # nick: nick to forward connect passwords to.
1601 nick="NickServ"
1602
1603 # forwardmsg: Message to send to users using a connect password.
1604 # $nick will be the users' nick, $nickrequired will be the nick
1605 # of where the password is going (the nick above).
1606 # You can also use $user for the user ident string.
1607 forwardmsg="NOTICE $nick :*** Forwarding PASS to $nickrequired"
1608
1609 # cmd: Command for the user to run when it receives a connect
1610 # password.
1611 cmd="SQUERY $nickrequired :IDENTIFY $pass">
1612
1613#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1614# Password hash module: Allows hashed passwords to be used.
1615# To be useful, a hashing module like bcrypt also needs to be loaded.
1616<module name="password_hash">
1617#
1618#-#-#-#-#-#-#-#-#-# PASSWORD HASH CONFIGURATION #-#-#-#-#-#-#-#-#-#-#-#
1619#
1620# To use this module, you must define a hash type for each oper's
1621# password you want to hash. For example:
1622#
1623# <oper name="Brain"
1624# host="ident@dialup15.isp.test.com"
1625# hash="bcrypt"
1626# password="$2a$10$Mss9AtHHslZTLBrXqM0FB.JBwD.UTSu8A48SfrY9exrpxbsRiRTbO"
1627# type="NetAdmin">
1628#
1629# If you are using a hash algorithm which does not perform salting you can use
1630# HMAC to salt your passwords in order to prevent them from being looked up in
1631# a rainbow table.
1632#
1633# hash="hmac-sha256" password="lkS1Nbtp$CyLd/WPQXizsbxFUTqFRoMvaC+zhOULEeZaQkUJj+Gg"
1634#
1635# Generate hashes using the /MKPASSWD command on the server.
1636# Don't run it on a server you don't trust with your password.
1637
1638#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1639# PBKDF2 module: Allows other modules to generate PBKDF2 hashes,
1640# usually for cryptographic uses and security.
1641# This module relies on other hash providers (e.g. SHA256).
1642<module name="pbkdf2">
1643#
1644# iterations: Iterations the hashing function runs when generating new
1645# hashes.
1646# length: Length in bytes of the derived key.
1647#<pbkdf2 iterations="12288" length="32">
1648# You can override these values with specific values
1649# for specific providers if you want to. Example given for SHA256.
1650#<pbkdf2prov hash="sha256" iterations="24576">
1651
1652#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1653# Permanent channels module: Channels with the permanent channel mode
1654# will remain open even after everyone else has left the channel, and
1655# therefore keep things like modes, ban lists and topic. Permanent
1656# channels -may- need support from your Services package to function
1657# properly with them. This adds channel mode +P.
1658# This module is oper-only.
1659<module name="permchannels">
1660#
1661# If you like, this module can write a config file of permanent channels
1662# whenever +P is set, unset, or the topic/modes on a +P channel is changed.
1663# If you want to do this, set the filename below, and uncomment the include.
1664#
1665# If 'listmodes' is true then all list modes (+b, +I, +e, +g...) will be
1666# saved. Defaults to false.
1667#
1668# 'saveperiod' determines how often to check if the database needs to be
1669# saved to disk. Defaults to every five seconds.
1670#<permchanneldb filename="permchannels.conf"
1671# listmodes="true"
1672# saveperiod="5s">
1673<include file="permchannels.conf">
1674#
1675# You may also create channels on startup by using the <permchannels> block.
1676#<permchannels channel="#opers" modes="isP" topic="Opers only.">
1677
1678#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1679# PostgreSQL module: Allows other SQL modules to access PgSQL databases
1680# through a unified API.
1681# This module is in extras. Re-run configure with:
1682# ./configure --enable-extras=m_pgsql.cpp
1683# and run make install, then uncomment this module to enable it.
1684<module name="pgsql">
1685#
1686#-#-#-#-#-#-#-#-#-#-#-#- SQL CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#-#
1687# #
1688# pgsql is more complex than described here, see the docs for #
1689# more: https://docs.inspircd.org/3/modules/pgsql #
1690#
1691#<database module="pgsql" name="mydb" user="myuser" pass="mypass" host="localhost" id="my_database" ssl="no">
1692
1693#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1694# Muteban: Implements extended ban 'm', which stops anyone matching
1695# a mask like +b m:nick!user@host from speaking on channel.
1696<module name="muteban">
1697#
1698# If notifyuser is set to no, the user will not be notified when
1699# their message is blocked.
1700#<muteban notifyuser="yes">
1701
1702#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1703# Random quote module: Provides a random quote on connect.
1704# NOTE: Some of these may mimic fatal errors and confuse users and
1705# opers alike - BEWARE!
1706<module name="randquote">
1707#
1708#-#-#-#-#-#-#-#-#-#- RANDOMQUOTES CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
1709# #
1710# Optional - If you specify to use the randquote module, then specify #
1711# below the path to the quotes file. #
1712# #
1713#<randquote file="quotes.txt">
1714
1715#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1716# Redirect module: Adds channel mode +L which redirects users to #
1717# another channel when the channel has reached its user limit and #
1718# user mode +L which stops redirection. #
1719<module name="redirect">
1720
1721#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1722# Regular expression provider for glob or wildcard (?/*) matching.
1723# You must have at least 1 provider loaded to use the filter or R-line
1724# modules. This module has no additional requirements, as it uses the
1725# matching already present in InspIRCd core.
1726<module name="regex_glob">
1727
1728#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1729# Regular expression provider for PCRE (Perl-Compatible Regular
1730# Expressions). You need libpcre installed to compile and load this
1731# module. You must have at least 1 provider loaded to use the filter or
1732# R-line modules.
1733<module name="regex_pcre">
1734
1735#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1736# Regular Expression Provider for RE2 Regular Expressions.
1737# You need libre2 installed and in your include/library paths in order
1738# to compile and load this module.
1739<module name="regex_re2">
1740
1741#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1742# Regular expression provider for POSIX regular expressions.
1743# You shouldn't need any additional libraries on a POSIX-compatible
1744# system (i.e.: any Linux, BSD, but not Windows). You must have at
1745# least 1 provider loaded to use the filter or R-line modules.
1746# On POSIX-compliant systems, regex syntax can be found by using the
1747# command: 'man 7 regex'.
1748<module name="regex_posix">
1749
1750#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1751# Regular expression provider for C++11 std::regex regular expressions.
1752# This module works on any fully compliant implementation of the C++11
1753# std::regex container. Examples for such are Visual C++ 2010 and newer
1754# but not libstdc++ (which GCC uses).
1755# You should verify that std::regex is supported by your setup before
1756# using this module, as it may compile normally but won't do anything
1757# on some implementations.
1758<module name="regex_stdlib">
1759#
1760# Specify the regular expression engine to use here. Valid settings are
1761# bre, ere, awk, grep, egrep, ecmascript (default if not specified).
1762#<stdregex type="ecmascript">
1763
1764#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1765# Regular expression provider for TRE regular expressions.
1766# This is the same regular expression engine used by UnrealIRCd, so
1767# if you are most familiar with the syntax of /SPAMFILTER from there,
1768# this is the provider you want. You need libtre installed in order
1769# to compile and load this module.
1770<module name="regex_tre">
1771
1772#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1773# Remove module: Adds the /REMOVE command which is a peaceful
1774# alternative to /KICK. It also provides the /FPART command which works
1775# in the same way as /REMOVE.
1776<module name="remove">
1777#
1778# supportnokicks: If true, /REMOVE is not allowed on channels where the
1779# nokicks (+Q) mode is set. Defaults to false.
1780# protectedrank: Members having this rank or above may not be /REMOVE'd
1781# by anyone. Set to 0 to disable this feature. Defaults to 50000.
1782#<remove supportnokicks="true" protectedrank="50000">
1783
1784#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1785# Repeat module: Allows to block, kick or ban upon similar messages
1786# being uttered several times. Provides channel mode +E.
1787#
1788# Syntax: [~|*]<lines>:<sec>[:<difference>][:<backlog>]
1789# ~ is to block, * is to ban, default is kick.
1790# lines - In mode 1, the amount of lines that has to match consecutively.
1791# In mode 2, the size of the backlog to keep for matching.
1792# seconds - How old the message has to be before it's invalidated.
1793# difference - Edit distance, in percent, between two strings to trigger on.
1794# backlog - When set, the function goes into mode 2. In this mode the
1795# function will trigger if this many of the last <lines> matches.
1796#
1797# As this module can be rather CPU-intensive, it comes with some options.
1798# maxbacklog - Maximum size that can be specified for backlog. 0 disables
1799# multiline matching.
1800# maxdistance - Max percentage of difference between two lines we'll allow
1801# to match. Set to 0 to disable edit-distance matching.
1802# maxlines - Max lines of backlog to match against.
1803# maxtime - Maximum period of time a user can set. 0 to allow any.
1804# size - Maximum number of characters to check for, can be used to
1805# truncate messages before they are checked, resulting in
1806# less CPU usage. Increasing this beyond 512 doesn't have
1807# any effect, as the maximum length of a message on IRC
1808# cannot exceed that.
1809#<repeat maxbacklog="20" maxdistance="50" maxlines="20" maxtime="0" size="512">
1810<module name="repeat">
1811
1812#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1813# Restricted channels module: Allows only opers with the
1814# channels/restricted-create priv and/or registered users to
1815# create channels.
1816#
1817# You probably *DO NOT* want to load this module on a public network.
1818#
1819<module name="restrictchans">
1820#
1821# allowregistered: should registered users be allowed to bypass the restrictions?
1822#<restrictchans allowregistered="no">
1823#
1824# Allow any channel matching #user-* to be created, bypassing restrictchans checks
1825#<allowchannel name="#user-*">
1826
1827#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1828# Restrict message module: Allows users to only message opers.
1829#
1830# You probably *DO NOT* want to load this module on a public network.
1831#
1832<module name="restrictmsg">
1833
1834#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1835# R-line module: Ban users through regular expression patterns.
1836<module name="rline">
1837#
1838#-#-#-#-#-#-#-#-#-#-#-#- RLINE CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#-#
1839#
1840# If you wish to re-check a user when they change nickname (can be
1841# useful under some situations, but *can* also use CPU with more users
1842# on a server) then set 'matchonnickchange' to yes.
1843# If you additionally want Z-lines to be added on matches, then
1844# set 'zlineonmatch' to yes.
1845# Also, this is where you set what Regular Expression engine is to be
1846# used. If you ever change it while running, all of your R-lines will
1847# be wiped. This is the regex engine used by all R-lines set, and
1848# regex_<engine> must be loaded, or rline will be non-functional
1849# until you load it or change the engine to one that is loaded.
1850#
1851#<rline matchonnickchange="yes" zlineonmatch="no" engine="pcre">
1852#
1853# Generally, you will NOT want to use 'glob' here, as this turns an
1854# R-line into just another G-line. The exceptions are that R-lines will
1855# always use the full "nick!user@host realname" string, rather than only
1856# user@host, but beware that only the ? and * wildcards are available,
1857# and are the only way to specify where the space can occur if you do
1858# use glob. For this reason, is recommended to use a real regex engine
1859# so that at least \s or [[:space:]] is available.
1860
1861#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1862# RMODE module: Adds the /RMODE command.
1863# Allows channel operators to remove list modes en masse, optionally
1864# matching a glob-based pattern.
1865# Syntax: /RMODE <channel> <mode> [<pattern>]
1866# E.g. '/RMODE #channel b m:*' will remove all mute extbans on the channel.
1867<module name="rmode">
1868
1869#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1870# SAJOIN module: Adds the /SAJOIN command which forcibly joins a user
1871# to the given channel.
1872# This module is oper-only.
1873# To use, SAJOIN must be in one of your oper class blocks.
1874# Opers need the users/sajoin-others priv to be able to /SAJOIN users
1875# other than themselves.
1876<module name="sajoin">
1877
1878#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1879# SAKICK module: Adds the /SAKICK command which kicks a user from the
1880# given channel.
1881# This module is oper-only.
1882# To use, SAKICK must be in one of your oper class blocks.
1883<module name="sakick">
1884
1885#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1886# SAMODE module: Adds the /SAMODE command which allows server operators
1887# to change modes on a channel without requiring them to have any
1888# channel priviliges. Also allows changing user modes for any user.
1889# This module is oper-only.
1890# To use, SAMODE must be in one of your oper class blocks.
1891<module name="samode">
1892
1893#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1894# SANICK module: Adds the /SANICK command which allows opers to change
1895# users' nicks.
1896# This module is oper-only.
1897# To use, SANICK must be in one of your oper class blocks.
1898<module name="sanick">
1899
1900#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1901# SAPART module: Adds the /SAPART command which forcibly parts a user
1902# from a channel.
1903# This module is oper-only.
1904# To use, SAPART must be in one of your oper class blocks.
1905<module name="sapart">
1906
1907#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1908# SAQUIT module: Adds the /SAQUIT command which forcibly quits a user.
1909# This module is oper-only.
1910# To use, SAQUIT must be in one of your oper class blocks.
1911<module name="saquit">
1912
1913#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1914# SATOPIC module: Adds the /SATOPIC command which allows changing the
1915# topic on a channel without requiring any channel priviliges.
1916# This module is oper-only.
1917# To use, SATOPIC must be in one of your oper class blocks.
1918<module name="satopic">
1919
1920#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1921# SASL authentication module: Provides support for IRC Authentication
1922# Layer via AUTHENTICATE. Note: You also need to have cap loaded
1923# for SASL to work.
1924<module name="sasl">
1925# Define the following to your services server name to improve security
1926# by ensuring the SASL messages are only sent to the services server
1927# and not to all connected servers. This prevents a rogue server from
1928# capturing SASL messages and disables the SASL cap when services is
1929# down.
1930#<sasl target="services.mynetwork.com">
1931
1932#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1933# Secure list module: Prevent /LIST in the first minute of connection,
1934# crippling most spambots and trojan spreader bots.
1935<module name="securelist">
1936#
1937#-#-#-#-#-#-#-#-#-# SECURELIST CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#-#
1938# #
1939# Securelist can be harmful to some IRC search engines. To prevent #
1940# securelist blocking these sites from listing, define exception tags #
1941# as shown below: #
1942#<securehost exception="*@*.netsplit.de">
1943#<securehost exception="*@*.ircdriven.com">
1944#<securehost exception="*@*.ircs.me">
1945# #
1946# Define the following variable to change how long a user must wait #
1947# before issuing a LIST. If not defined, defaults to 60 seconds. #
1948# #
1949#<securelist waittime="1m"> #
1950
1951#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1952# Servprotect module: Provides support for Austhex style +k /
1953# UnrealIRCD +S services mode.
1954<module name="servprotect">
1955
1956#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1957# See nicks module: Adds snomask +n and +N which show local and remote
1958# nick changes.
1959# This module is oper-only.
1960<module name="seenicks">
1961
1962#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1963# Set idle module: Adds a command for opers to change their idle time.
1964# This module is oper-only.
1965# To use, SETIDLE must be in one of your oper class blocks.
1966<module name="setidle">
1967
1968#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1969# Services support module: Adds several user modes such as +R and +M.
1970# This module implements the 'identified' state via account names,
1971# and is similar in operation to the way asuka and ircu handle services.
1972#
1973# At the same time, this offers +r for users and channels to mark them
1974# as identified separately from the idea of a master account, which
1975# can be useful for services which are heavily nick-as-account centric.
1976#
1977# Also of note is that this module implements two extbans:
1978# +b R: (stop matching account names from joining)
1979# +b U:n!u@h (blocks matching unregistered users)
1980#
1981<module name="services_account">
1982
1983#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1984# Sethost module: Adds the /SETHOST command.
1985# This module is oper-only.
1986# To use, SETHOST must be in one of your oper class blocks.
1987# See the chghost module for how to customise valid chars for hostnames.
1988<module name="sethost">
1989
1990#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1991# Setident module: Adds the /SETIDENT command.
1992# This module is oper-only.
1993# To use, SETIDENT must be in one of your oper class blocks.
1994<module name="setident">
1995
1996#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1997# SETNAME module: Adds the /SETNAME command.
1998<module name="setname">
1999#
2000#-#-#-#-#-#-#-#-#-#-#-#- SETNAME CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#
2001# #
2002# operonly - Whether the SETNAME command should only be usable by #
2003# server operators. Defaults to no. #
2004# #
2005# notifyopers - Whether to send a snotice to snomask `a` when a user #
2006# changes their real name. Defaults to to yes if #
2007# oper-only and no if usable by everyone. #
2008# #
2009#<setname notifyopers="yes"
2010# operonly="no">
2011
2012#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2013# Serverban: Implements extended ban 's', which stops anyone connected
2014# to a server matching a mask like +b s:server.mask.here from joining.
2015# Wildcards are accepted.
2016<module name="serverban">
2017
2018#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2019# SHA1 module: Allows other modules to generate SHA1 hashes.
2020# Required by the WebSocket module.
2021<module name="sha1">
2022
2023#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2024# Showfile: Provides support for showing a text file to users when #
2025# they enter a command. #
2026# This module adds one command for each <showfile> tag that shows the #
2027# given file to the user as a series of messages or numerics. #
2028<module name="showfile">
2029# #
2030#-#-#-#-#-#-#-#-#-#-# SHOWFILE CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#-#
2031# #
2032# name - The name of the command which displays this file. This is #
2033# the only mandatory setting, all others are optional. #
2034# file - The text file to be shown to the user. #
2035# By default same as the command name. #
2036# method - How should the file be shown? #
2037# * numeric: Send contents using a numeric #
2038# (similar to /MOTD; the default). #
2039# * notice: Send contents as a series of notices. #
2040# * msg: Send contents as a series of private messages. #
2041# #
2042# When using the method "numeric", the following extra settings are #
2043# available: #
2044# #
2045# introtext - Introductory line, "Showing <name>" by default. #
2046# intronumeric - Numeric used for the introductory line. #
2047# numeric - Numeric used for sending the text itself. #
2048# endtext - Ending line, "End of <name>" by default. #
2049# endnumeric - Numeric used for the ending line. #
2050# #
2051#<showfile name="RULES"
2052# file="rules.txt"
2053# introtext="Server rules:"
2054# endtext="End of server rules.">
2055
2056#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2057# Show whois module: Adds the +W user mode which allows opers to see
2058# when they are /WHOIS'd.
2059# This module is oper-only by default.
2060<module name="showwhois">
2061#
2062# If you wish, you may also let users set this mode. Only opers with the
2063# users/auspex priv will see real hosts of people, though.
2064#<showwhois opersonly="yes"
2065#
2066# You may also set whether or not users should receive whois notices,
2067# should they be /WHOIS'd by an oper.
2068#showfromopers="yes">
2069
2070#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2071# Shun module: Provides the /SHUN command, which stops a user from
2072# executing all except configured commands.
2073# This module is oper-only.
2074# To use, SHUN must be in one of your oper class blocks.
2075<module name="shun">
2076#
2077# You may also configure which commands you wish a user to be able to
2078# perform when shunned. It should be noted that if a shunned user
2079# issues QUIT or PART then their message will be removed, as if they
2080# did not issue one.
2081#
2082# You can optionally let the user know that their command was blocked.
2083#
2084# You may also let SHUN affect opers (defaults to no).
2085#<shun enabledcommands="ADMIN PING PONG QUIT PART JOIN" notifyuser="yes" affectopers="no">
2086
2087#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2088# SSL mode module: Adds support for SSL-only channels via the '+z'
2089# channel mode, SSL-only private messages via the '+z' user mode and
2090# the 'z:' extban which matches SSL client certificate fingerprints.
2091#
2092# Does not do anything useful without a working SSL module and the
2093# sslinfo module (see below).
2094<module name="sslmodes">
2095#
2096# The +z user mode is not enabled by default to enable link compatibility
2097# with 2.0 servers. You can enable it by uncommenting this:
2098#<sslmodes enableumode="yes">
2099
2100#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2101# SSL rehash signal module: Allows the SSL modules to be rehashed by
2102# sending SIGUSR1 to a running InspIRCd process.
2103# This modules is in extras. Re-run configure with:
2104# ./configure --enable-extras=m_sslrehashsignal.cpp
2105# and run make install, then uncomment this module to enable it.
2106<module name="sslrehashsignal">
2107
2108#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2109# GnuTLS SSL module: Adds support for SSL/TLS connections using GnuTLS,
2110# if enabled. You must answer 'yes' in ./configure when asked or
2111# manually symlink the source for this module from the directory
2112# src/modules/extra, if you want to enable this, or it will not load.
2113<module name="ssl_gnutls">
2114#
2115#-#-#-#-#-#-#-#-#-#-#- GNUTLS CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#
2116# #
2117# ssl_gnutls is too complex to describe here, see the docs: #
2118# https://docs.inspircd.org/3/modules/ssl_gnutls #
2119
2120#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2121# SSL info module: Allows users to retrieve information about other
2122# users' peer SSL certificates and keys via the SSLINFO command.
2123# This can be used by client scripts to validate users. For this to
2124# work, one of ssl_gnutls, ssl_mbedtls or ssl_openssl must be loaded.
2125# This module also adds the "<user> is using a secure connection"
2126# and "<user> has client certificate fingerprint <fingerprint>"
2127# WHOIS lines, the ability for opers to use SSL cert fingerprints to
2128# verify their identity and the ability to force opers to use SSL
2129# connections in order to oper up. It is highly recommended to load
2130# this module if you use SSL on your network.
2131# For how to use the oper features, please see the first
2132# example <oper> tag in opers.conf.example.
2133#
2134<module name="sslinfo">
2135#
2136# If you want to prevent users from viewing SSL certificate information
2137# and fingerprints of other users, set operonly to yes.
2138#<sslinfo operonly="no">
2139
2140#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2141# mbedTLS SSL module: Adds support for SSL/TLS connections using mbedTLS.
2142<module name="ssl_mbedtls">
2143#
2144#-#-#-#-#-#-#-#-#-#-#- MBEDTLS CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#
2145# #
2146# ssl_mbedtls is too complex to describe here, see the docs: #
2147# https://docs.inspircd.org/3/modules/ssl_mbedtls #
2148
2149#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2150# OpenSSL SSL module: Adds support for SSL/TLS connections using OpenSSL,
2151# if enabled. You must answer 'yes' in ./configure when asked or symlink
2152# the source for this module from the directory src/modules/extra, if
2153# you want to enable this, or it will not load.
2154<module name="ssl_openssl">
2155#
2156#-#-#-#-#-#-#-#-#-#-#- OPENSSL CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#
2157# #
2158# ssl_openssl is too complex to describe here, see the docs: #
2159# https://docs.inspircd.org/3/modules/ssl_openssl #
2160
2161#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2162# Strip color module: Adds channel mode +S that strips color codes and
2163# all control codes except CTCP from all messages sent to the channel.
2164<module name="stripcolor">
2165
2166#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2167# Silence module: Adds support for the /SILENCE command, which allows
2168# users to have a server-side ignore list for their client.
2169<module name="silence">
2170#
2171# Set the maximum number of entries allowed on a user's silence list.
2172#<silence maxentries="32"
2173#
2174# Whether messages from U-lined servers will bypass silence masks.
2175#exemptuline="yes">
2176
2177#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2178# SQLite3 module: Allows other SQL modules to access SQLite3 #
2179# databases through a unified API. #
2180# This module is in extras. Re-run configure with: #
2181# ./configure --enable-extras=m_sqlite3.cpp
2182# and run make install, then uncomment this module to enable it. #
2183#
2184<module name="sqlite3">
2185#
2186#-#-#-#-#-#-#-#-#-#-#-#- SQL CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#-#
2187# #
2188# sqlite is more complex than described here, see the docs for more #
2189# info: https://docs.inspircd.org/3/modules/sqlite3 #
2190#
2191#<database module="sqlite" hostname="/full/path/to/database.db" id="anytext">
2192
2193#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2194# SQL authentication module: Allows IRCd connections to be tied into
2195# a database table (for example a forum).
2196#
2197<module name="sqlauth">
2198#
2199#-#-#-#-#-#-#-#-#-#-#- SQLAUTH CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#
2200# #
2201# sqlauth is too complex to describe here, see the docs: #
2202# https://docs.inspircd.org/3/modules/sqlauth #
2203
2204#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2205# SQL oper module: Allows you to store oper credentials in an SQL
2206# table. You can add additional table columns like you would config
2207# tags in opers.conf. Opers in opers.conf will override opers from
2208# this module.
2209#
2210<module name="sqloper">
2211#
2212#-#-#-#-#-#-#-#-#-#-#- SQLOPER CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#
2213# #
2214# dbid - Database ID to use (see SQL modules). #
2215# #
2216# See also: https://docs.inspircd.org/3/modules/sqloper #
2217# #
2218#<sqloper dbid="1">
2219
2220#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2221# StartTLS module: Implements STARTTLS, which allows clients #
2222# connected to non SSL enabled ports to enable SSL, if a proper SSL #
2223# module is loaded (either ssl_gnutls, ssl_mbedtls or ssl_openssl). #
2224<module name="starttls">
2225
2226#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2227# SVSHold module: Implements SVSHOLD. Like Q-lines, but can only be #
2228# added/removed by Services. #
2229<module name="svshold">
2230# SVSHOLD does not generate server notices by default, you can turn
2231# notices on by uncommenting the next line.
2232#<svshold silent="false">
2233
2234#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2235# SWHOIS module: Allows you to add arbitrary lines to user WHOIS.
2236# This module is oper-only.
2237# To use, SWHOIS must be in one of your oper class blocks.
2238<module name="swhois">
2239
2240#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2241# Timed bans module: Adds timed channel bans with the /TBAN command.
2242<module name="timedbans">
2243
2244#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2245# Test line module: Adds the /TLINE command, used to test how many
2246# users a /GLINE or /ZLINE etc. would match.
2247# This module is oper-only.
2248# To use, TLINE must be in one of your oper class blocks.
2249<module name="tline">
2250
2251#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2252# Topiclock module: implements server-side topic locking to achieve deeper
2253# integration with services packages.
2254<module name="topiclock">
2255
2256#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2257# UHNAMES support module: Adds support for the IRCX style UHNAMES
2258# extension, which displays ident and hostname in the names list for
2259# each user, saving clients from doing a WHO on the channel.
2260# If a client does not support UHNAMES it will not enable it, this will
2261# not break incompatible clients.
2262<module name="uhnames">
2263
2264#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2265# Uninvite module: Adds the /UNINVITE command which lets users remove
2266# pending invites from channels without waiting for the user to join.
2267<module name="uninvite">
2268
2269#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2270# Userip module: Adds the /USERIP command.
2271# Allows users to query their own IP, also allows opers to query the IP
2272# of anyone else.
2273<module name="userip">
2274
2275#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2276# Vhost module: Adds the VHOST command which allows for adding virtual
2277# hosts which are accessible using a username and password in the config.
2278<module name="vhost">
2279#
2280#-#-#-#-#-#-#-#-#-#-#- VHOST CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#-#
2281# #
2282# user - Username for the vhost. #
2283# #
2284# pass - Password for the vhost. #
2285# #
2286# hash - The hash for the specific user (optional) #
2287# password_hash and a hashing module must be loaded for #
2288# this to work. #
2289# #
2290# host - Vhost to set. #
2291#
2292#<vhost user="some_username" pass="some_password" host="some.host.test.cc">
2293#<vhost user="foo" password="$2a$10$iTuYLT6BRhRlOgzfsW9oPe62etW.oXwSpyKw5rJit64SGZanLXghO" hash="bcrypt" host="some.other.host.example.com">
2294
2295#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2296# Watch module: Adds the WATCH command, which is used by clients to
2297# maintain notify lists.
2298<module name="watch">
2299#
2300# Set the maximum number of entries on a user's watch list below.
2301#<watch maxentries="32">
2302
2303#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2304# WebSocket module: Adds HTML5 WebSocket support.
2305# Specify hook="websocket" in a <bind> tag to make that port accept
2306# WebSocket connections. Compatible with SSL/TLS.
2307# Requires SHA-1 hash support available in the sha1 module.
2308<module name="websocket">
2309#
2310# Whether to re-encode messages as UTF-8 before sending to WebSocket
2311# clients. This is recommended as the WebSocket protocol requires all
2312# text frames to be sent as UTF-8. If you do not have this enabled
2313# messages will be sent as binary frames instead.
2314#<websocket sendastext="yes">
2315#
2316# If you use the websocket module you MUST specify one or more origins
2317# which are allowed to connect to the server. You should set this as
2318# strict as possible to prevent malicious webpages from connecting to
2319# your server.
2320# <wsorigin allow="https://*.example.com">
2321
2322#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2323# X-line database: Stores all *-lines (G/Z/K/R/any added by other modules)
2324# in a file which is re-loaded on restart. This is useful
2325# for two reasons: it keeps bans so users may not evade them, and on
2326# bigger networks, server connections will take less time as there will
2327# be a lot less bans to apply - as most of them will already be there.
2328<module name="xline_db">
2329
2330# Specify the filename for the xline database and how often to check whether
2331# the database needs to be saved here.
2332#<xlinedb filename="xline.db" saveperiod="5s">
2333
2334#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2335# ____ _ _____ _ _ ____ _ _ _ #
2336# | _ \ ___ __ _ __| | |_ _| |__ (_)___ | __ )(_) |_| | #
2337# | |_) / _ \/ _` |/ _` | | | | '_ \| / __| | _ \| | __| | #
2338# | _ < __/ (_| | (_| | | | | | | | \__ \ | |_) | | |_|_| #
2339# |_| \_\___|\__,_|\__,_| |_| |_| |_|_|___/ |____/|_|\__(_) #
2340# #
2341# To link servers to InspIRCd, you MUST load the spanningtree module. #
2342# If you don't do this, server links will NOT work at all. #
2343# This is by design, to allow for the implementation of other linking #
2344# protocols in modules in the future. #
2345
2346#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2347# Spanning tree module: Allows linking of servers using the spanning
2348# tree protocol (see the READ THIS BIT section above).
2349# You will almost always want to load this.
2350#
2351<module name="spanningtree">