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