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