1 #-#-#-#-#-#-#-#-#-#-#-#-#- MODULE OPTIONS -#-#-#-#-#-#-#-#-#-#-#-#-#
3 # These tags define which modules will be loaded on startup by your #
4 # server. Add modules without any paths. When you make your ircd #
5 # using the 'make' command, all compiled modules will be moved into #
6 # the folder you specified when you ran ./configure. The module tag #
7 # automatically looks for modules in this location. #
8 # If you attempt to load a module outside of this location, either #
9 # in the config, or via /LOADMODULE, you will receive an error. #
11 # By default, ALL modules are commented out. You must uncomment them #
12 # or add lines to your config to load modules. Please refer to #
13 # https://wiki.inspircd.org/2.0/Modules for a list of modules and #
14 # each modules link for any additional conf tags they require. #
16 # ____ _ _____ _ _ ____ _ _ _ #
17 # | _ \ ___ __ _ __| | |_ _| |__ (_)___ | __ )(_) |_| | #
18 # | |_) / _ \/ _` |/ _` | | | | '_ \| / __| | _ \| | __| | #
19 # | _ < __/ (_| | (_| | | | | | | | \__ \ | |_) | | |_|_| #
20 # |_| \_\___|\__,_|\__,_| |_| |_| |_|_|___/ |____/|_|\__(_) #
22 # To link servers to InspIRCd, you MUST load the m_spanningtree #
23 # module. If you don't do this, server links will NOT work at all. #
24 # This is by design, to allow for the implementation of other linking #
25 # protocols in modules in the future. This module is at the bottom of #
29 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
30 # MD5 module: Allows other modules to generate MD5 hashes, usually for
31 # cryptographic uses and security.
34 # Other modules such as m_cloaking.so and m_password_hash.so may rely on
35 # this module being loaded to function.
37 #<module name="m_md5.so">
39 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
40 # SHA256 module: Allows other modules to generate SHA256 hashes,
41 # usually for cryptographic uses and security.
44 # Other modules such as m_password_hash.so may rely on this module being
45 # loaded to function. Certain modules such as m_spanningtree.so will
46 # function without this module but when it is loaded their features will
47 # be enhanced (for example the addition of HMAC authentication).
49 #<module name="m_sha256.so">
50 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
51 # RIPEMD160 module: Allows other modules to generate RIPEMD160 hashes,
52 # usually for cryptographic uses and security.
55 # Other modules may rely on this module being loaded to function.
56 #<module name="m_ripemd160.so">
58 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
59 # Abbreviation module: Provides the ability to abbreviate commands a-la
61 #<module name="m_abbreviation.so">
63 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
64 # Alias module: Allows you to define server-side command aliases.
65 #<module name="m_alias.so">
67 # Set the 'prefix' for in-channel aliases (fantasy commands) to the
68 # specified character. If not set, the default is "!".
69 # If 'allowbots' is disabled, +B clients will not be able to use
70 # fantasy commands. If not set, the default is no.
71 #<fantasy prefix="!" allowbots="no">
73 #-#-#-#-#-#-#-#-#-#-#- ALIAS DEFINITIONS -#-#-#-#-#-#-#-#-#-#-#-#-#-#
75 # If you have the m_alias.so module loaded, you may also define #
76 # aliases as shown below. They are commonly used to provide shortcut #
77 # commands to services, however they are not limited to just this use.#
78 # An alias tag requires the following values to be defined in it: #
80 # text - The text to detect as the actual command line. #
81 # Can't contain spaces, but case insensitive. #
82 # You may have multiple aliases with the same #
83 # command name (text="" value), however the first #
84 # found will be executed if its format value is #
85 # matched, or it has no format value. Aliases are #
86 # read from the top of the file to the bottom. #
88 # usercommand - If this is true, the alias can be run simply as #
89 # /aliasname. Defaults to true. #
91 # channelcommand - If this is true, the alias can be used as an #
92 # in-channel alias or 'fantasy command', prefixed #
93 # by the fantasy prefix character, !aliasname by #
94 # default. Defaults to false. #
96 # format - If this is defined, the parameters of the alias #
97 # must match this glob pattern. For example if you #
98 # want the first parameter to start with a # for #
99 # the alias to be executed, set format="#*" in the #
100 # alias definition. Note that the :'s which are #
101 # part of IRC formatted lines will be preserved #
102 # for matching of this text. This value is #
105 # replace - The text to replace 'text' with. Usually this #
106 # will be "PRIVMSG ServiceName :$2-" or similar. #
107 # You may use the variables $1 through $9 in the #
108 # replace string, which refer to the first through #
109 # ninth word in the original string typed by the #
110 # user. You may also use $1- through $9- which #
111 # refer to the first word onwards, through to the #
112 # ninth word onwards, e.g. if the user types the #
113 # command "foo bar baz qux quz" then $3- will hold #
114 # "baz qux quz" and $2 will contain "bar". You may #
115 # also use the special variables: $nick, $ident, #
116 # $host and $vhost, and you may separate multiple #
117 # commands with a newline (which can be written in #
118 # the file literally, or encoded as &nl; or \n #
119 # depending on the config format setting). #
121 # requires - If you provide a value for 'requires' this means #
122 # the given nickname MUST be online for the alias #
123 # to successfully trigger. If they are not, then #
124 # the user receives a 'no such nick' 401 numeric. #
126 # uline - Setting this to true will ensure that the user #
127 # given in 'requires' is also on a u-lined server, #
128 # as well as actually being on the network. If the #
129 # user is online, but not on a u-lined server, #
130 # then an oper alert is sent out as this is #
131 # possibly a sign of a user trying to impersonate #
134 # operonly - If true, this will make the alias oper only. #
135 # If a non-oper attempts to use the alias, it will #
136 # appear to not exist. #
138 #<alias text="NICKSERV" replace="PRIVMSG NickServ :$2-" requires="NickServ" uline="yes">
139 #<alias text="CHANSERV" replace="PRIVMSG ChanServ :$2-" requires="ChanServ" uline="yes">
140 #<alias text="OPERSERV" replace="PRIVMSG OperServ :$2-" requires="OperServ" uline="yes" operonly="yes">
141 #<alias text="BOTSERV" replace="PRIVMSG BotServ :$2-" requires="BotServ" uline="yes">
142 #<alias text="HOSTSERV" replace="PRIVMSG HostServ :$2-" requires="HostServ" uline="yes">
143 #<alias text="MEMOSERV" replace="PRIVMSG MemoServ :$2-" requires="MemoServ" uline="yes">
144 #<alias text="NS" replace="PRIVMSG NickServ :$2-" requires="NickServ" uline="yes">
145 #<alias text="CS" replace="PRIVMSG ChanServ :$2-" requires="ChanServ" uline="yes">
146 #<alias text="OS" replace="PRIVMSG OperServ :$2-" requires="OperServ" uline="yes" operonly="yes">
147 #<alias text="BS" replace="PRIVMSG BotServ :$2-" requires="BotServ" uline="yes">
148 #<alias text="HS" replace="PRIVMSG HostServ :$2-" requires="HostServ" uline="yes">
149 #<alias text="MS" replace="PRIVMSG MemoServ :$2-" requires="MemoServ" uline="yes">
151 # An example of using the format value to create an alias with two
152 # different behaviours depending on the format of the parameters.
154 #<alias text="ID" format="#*" replace="PRIVMSG ChanServ :IDENTIFY $2 $3"
155 # requires="ChanServ" uline="yes">
157 #<alias text="ID" replace="PRIVMSG NickServ :IDENTIFY $2"
158 # requires="NickServ" uline="yes">
160 # This alias fixes a glitch in xchat 2.6.x and above and the way it
161 # assumes IDENTIFY must be prefixed by a colon (:) character. It should
162 # be placed ABOVE the default NICKSERV alias (the first example) listed
165 #<alias text="NICKSERV" format=":IDENTIFY *" replace="PRIVMSG NickServ :IDENTIFY $3-"
166 # requires="NickServ" uline="yes">
168 # You may also add aliases to trigger based on something said in a
169 # channel, aka 'fantasy' commands, configured in the same manner as any
170 # other alias, with usercommand="no" and channelcommand="yes" The
171 # command must be preceded by the fantasy prefix when used.
173 #<alias text="CS" usercommand="no" channelcommand="yes"
174 # replace="PRIVMSG ChanServ :$1 $chan $2-" requires="ChanServ" uline="yes">
176 # This would be used as "!cs <command> <options>", with the channel
177 # being automatically inserted after the command in the message to
178 # ChanServ, assuming the fantasy prefix is "!".
180 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
181 # Allowinvite module: Gives channel mode +A to allow all users to use
182 # /INVITE, and extban A to deny invite from specific masks.
183 #<module name="m_allowinvite.so">
185 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
186 # Alltime module: Shows time on all connected servers at once.
187 # This module is oper-only and provides /ALLTIME.
188 # To use, ALLTIME must be in one of your oper class blocks.
189 #<module name="m_alltime.so">
191 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
192 # Auditorium module: Adds channel mode +u which makes everyone else
193 # except you in the channel invisible, used for large meetings etc.
194 #<module name="m_auditorium.so">
196 # Auditorium settings:
198 #<auditorium opvisible="no" opcansee="no" opercansee="yes">
200 # opvisible (auditorium-vis in exemptchanops):
201 # Show channel ops to all users
202 # opcansee (auditorium-see in exemptchanops):
203 # Allow ops to see all joins/parts/kicks in the channel
205 # Allow opers (channels/auspex) to see see all joins/parts/kicks in the channel
207 # Exemptchanops can be used to adjust the level at which users become visible or
208 # the level at which they can see the full member list of the channel.
210 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
211 # Autoop module: Adds basic channel access controls via the +w listmode.
212 # For example +w o:*!Attila@127.0.0.1 will op anyone matching that mask
213 # on join. This can be combined with extbans, for example +w o:R:Brain
214 # will op anyone identified to the account "Brain".
215 # Another useful combination is with SSL client certificate
216 # fingerprints: +w h:z:72db600734bb9546c1bdd02377bc21d2a9690d48 will
217 # give halfop to the user(s) having the given certificate.
218 #<module name="m_autoop.so">
220 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
221 # Ban except module: Adds support for channel ban exceptions (+e).
222 #<module name="m_banexception.so">
224 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
225 # Ban redirection module: Allows bans which redirect to a specified
226 # channel. e.g. +b nick!ident@host#channelbanneduserissentto
227 #<module name="m_banredirect.so">
229 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
230 # Block amsg module: Attempt to block all usage of /amsg and /ame.
231 #<module name="m_blockamsg.so">
233 #-#-#-#-#-#-#-#-#-#-#- BLOCKAMSG CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
235 # If you have the m_blockamsg.so module loaded, you can configure it #
236 # with the <blockamsg> tag: #
238 # delay - How many seconds between two messages to force #
239 # them to be recognised as unrelated. #
240 # action - Any of 'notice', 'noticeopers', 'silent', 'kill' #
241 # or 'killopers'. Define how to take action when #
242 # a user uses /amsg or /ame. #
244 #<blockamsg delay="3" action="killopers">
246 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
247 # Block CAPS module: Adds channel mode +B, blocks all-CAPS messages.
248 #<module name="m_blockcaps.so">
250 #-#-#-#-#-#-#-#-#-#-#- BLOCKCAPS CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
252 # percent - How many percent of text must be caps before text #
255 # minlen - The minimum length a line must be for the block #
256 # percent to have any effect. #
258 # capsmap - A list of chars to be considered CAPS. Can be used #
259 # to add CAPS characters for your language. Also you #
260 # can add things like ! and space to further lock #
261 # down on caps usage. #
262 #<blockcaps percent="50"
264 # capsmap="ABCDEFGHIJKLMNOPQRSTUVWXYZ! ">
266 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
267 # Block color module: Blocking color-coded messages with chan mode +c.
268 #<module name="m_blockcolor.so">
270 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
271 # Botmode module: Adds the user mode +B. If set on a user, it will
272 # show that the user is a bot in /WHOIS.
273 #<module name="m_botmode.so">
275 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
276 # CallerID module: Adds usermode +g which activates hybrid-style
277 # callerid: block all private messages unless you /ACCEPT first.
278 #<module name="m_callerid.so">
280 #-#-#-#-#-#-#-#-#-#-#- CALLERID CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#
281 # maxaccepts - Maximum number of entries a user can add to his #
282 # /ACCEPT list. Default is 16 entries. #
283 # operoverride - Can opers (note: ALL opers) override callerid? #
285 # tracknick - Preserve /accept entries when a user changes nick? #
286 # If no (the default), the user is removed from #
287 # everyone's accept list if he changes nickname. #
288 # cooldown - Amount of time (in seconds) that must pass since #
289 # the last notification sent to a user before he can #
290 # be sent another. Default is 60 (1 minute). #
291 #<callerid maxaccepts="16"
296 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
297 # CAP module: Provides the CAP negotiation mechanism required by the
298 # m_sasl, m_namesx, m_uhnames, and m_ircv3 modules.
299 # It is also recommended for the STARTTLS support in m_ssl_gnutls.
300 #<module name="m_cap.so">
302 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
303 # CBAN module: Lets you disallow channels from being used at runtime.
304 # This module is oper-only and provides /CBAN.
305 # To use, CBAN must be in one of your oper class blocks.
306 #<module name="m_cban.so">
308 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
309 # Censor module: Adds channel and user mode +G.
310 #<module name="m_censor.so">
312 #-#-#-#-#-#-#-#-#-#-#- CENSOR CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#
314 # Optional - If you specify to use the m_censor module, then you must #
315 # specify some censor tags. See also: #
316 # https://wiki.inspircd.org/Modules/2.0/censor #
318 #<include file="conf/examples/censor.conf.example">
320 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
321 # CGI:IRC module: Adds support for automatic host changing in CGI:IRC
322 # (http://cgiirc.sourceforge.net).
323 #<module name="m_cgiirc.so">
325 #-#-#-#-#-#-#-#-#-#-#-# CGIIRC CONFIGURATION #-#-#-#-#-#-#-#-#-#-#-#-#
327 # Optional - If you specify to use m_cgiirc, then you must specify one
328 # or more cgihost tags which indicate authorised CGI:IRC servers which
329 # will be connecting to your network, and an optional cgiirc tag.
330 # For more information see: https://wiki.inspircd.org/Modules/2.0/cgiirc
332 # Set to yes if you want to notice opers when CGI:IRC clients connect.
333 # <cgiirc opernotice="no">
335 # The type field indicates where the module should get the real
336 # client's IP address from, for further information, please see the
337 # CGI:IRC documentation.
340 # <cgihost type="pass" mask="www.example.com"> # Get IP from PASS
341 # <cgihost type="ident" mask="otherbox.example.com"> # Get IP from ident
342 # <cgihost type="passfirst" mask="www.example.com"> # See the docs
344 # <cgihost type="webirc" password="foobar"
345 # mask="somebox.example.com"> # Get IP from WEBIRC
350 # When you connect CGI:IRC clients, there are two connect classes which
351 # apply to these clients. When the client initially connects, the connect
352 # class which matches the CGI:IRC site's host is checked. Therefore you
353 # must raise the maximum local/global clients for this ip as high as you
354 # want to allow cgi clients. After the client has connected and is
355 # determined to be a cgi:irc client, the class which matches the client's
356 # real IP is then checked. You may set this class to a lower value, so that
357 # the real IP of the client can still be restricted to, for example, 3
360 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
361 # Channel create module: Adds snomask +j, which will notify opers of
362 # any new channels that are created.
363 # This module is oper-only.
364 #<module name="m_chancreate.so">
366 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
367 # Channel filter module: Allows channel-op defined message filtering
368 # using simple string matches (channel mode +g).
369 #<module name="m_chanfilter.so">
371 # If hidemask is set to yes, the user will not be shown the mask when
372 # his/her message is blocked.
373 #<chanfilter hidemask="yes">
375 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
376 # Channel history module: Displays the last 'X' lines of chat to a user
377 # joining a channel with +H 'X:T' set; 'T' is the maximum time to keep
378 # lines in the history buffer. Designed so that the new user knows what
379 # the current topic of conversation is when joining the channel.
380 #<module name="m_chanhistory.so">
382 # Set the maximum number of lines allowed to be stored per channel below.
383 # This is the hard limit for 'X'.
384 # If notice is set to yes, joining users will get a NOTICE before playback
385 # telling them about the following lines being the pre-join history.
386 # If bots is set to yes, it will also send to users marked with +B
387 #<chanhistory maxlines="20" notice="yes" bots="yes">
389 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
390 # Channel logging module: Used to send snotice output to channels, to
391 # allow staff to centrally monitor and discuss network activity.
393 # The "channel" field is where you want the messages to go, "snomasks"
394 # is what snomasks you want to be sent to that channel. Multiple tags
396 #<module name="m_chanlog.so">
397 #<chanlog snomasks="AOcC" channel="#opers">
399 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
400 # Channel names module: Allows disabling channels which have certain
401 # characters in the channel name such as bold, colorcodes, etc. which
402 # can be quite annoying and allow users to on occasion have a channel
403 # that looks like the name of another channel on the network.
404 #<module name="m_channames.so">
407 # denyrange: characters or range of characters to deny in channel
411 # allowrange: characters or range of characters to specifically allow
415 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
416 # Channelban: Implements extended ban j:, which stops anyone already
417 # in a channel matching a ban like +b j:#channel*mask from joining.
418 # Note that by default wildcard characters * and ? are allowed in
419 # channel names. To disallow them, load m_channames and add characters
420 # 42 and 63 to denyrange (see above).
421 #<module name="m_channelban.so">
423 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
424 # Chanprotect module: Gives +q and +a channel modes.
426 # IMPORTANT: This module has been removed in the next major version of
427 # InspIRCd. You should use m_customprefix instead.
428 #<module name="m_chanprotect.so">
431 # noservices: With this set to yes, when a user joins an empty channel,
432 # the server will set +q on them. If set to no, it will only set +o
433 # on them until they register the channel.
436 # qprefix: Prefix (symbol) to use for +q users.
439 # aprefix: Prefix (symbol) to use for +a users.
442 # deprotectself: If this value is set (true, yes or 1), it will allow
443 # +a and +q users to remove the +a and +q from themselves, otherwise,
444 # the status will have to be removed by services.
447 # deprotectothers: If this value is set to yes, true, or 1, then any
448 # user with +q or +a may remove the +q or +a from other users.
449 #deprotectothers="yes">
452 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
453 # Check module: Adds the /CHECK command.
454 # Check is useful for looking up information on channels, users,
455 # IP addresses and hosts.
456 # This module is oper-only.
457 # To use, CHECK must be in one of your oper class blocks.
458 #<module name="m_check.so">
460 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
461 # CHGHOST module: Adds the /CHGHOST command.
462 # This module is oper-only.
463 # To use, CHGHOST must be in one of your oper class blocks.
464 # NOTE: Services will not be able to set vhosts on users if this module
465 # isn't loaded. If you're planning on running services, you probably
467 #<module name="m_chghost.so">
469 #-#-#-#-#-#-#-#-# /CHGHOST - /SETHOST CONFIGURATION #-#-#-#-#-#-#-#-#
470 # Optional - If you want to use special chars for hostnames you can #
471 # specify your own custom list of chars with the <hostname> tag: #
473 # charmap - A list of chars accepted as valid by the /CHGHOST #
474 # and /SETHOST commands. Also note that the list is #
476 #<hostname charmap="abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ.-_/0123456789">
478 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
479 # CHGIDENT module: Adds the /CHGIDENT command.
480 # This module is oper-only.
481 # To use, CHGIDENT must be in one of your oper class blocks.
482 #<module name="m_chgident.so">
484 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
485 # CHGNAME module: Adds the /CHGNAME command.
486 # This module is oper-only.
487 # To use, CHGNAME must be in one of your oper class blocks.
488 #<module name="m_chgname.so">
490 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
491 # Cloaking module: Adds usermode +x and cloaking support.
492 # Relies on the module m_md5.so being loaded.
493 # To cloak users when they connect, load m_conn_umodes and set
494 # <connect:modes> to include the +x mode. The example <connect> tag
495 # shows this. See the m_conn_umodes module for more information.
496 #<module name="m_cloaking.so">
498 #-#-#-#-#-#-#-#-#-#-#- CLOAKING CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#
500 # To use m_cloaking, you must define a cloak key, and optionally a #
501 # cloak prefix as shown below. The cloak key must be shared across #
502 # the network for correct cloaking. #
504 # There are four methods of cloaking: #
506 # half Cloak only the "unique" portion of a host; show #
507 # the last 2 parts of the domain, /16 subnet of IPv4 #
508 # or /48 subnet of the IPv6 address. #
510 # full Cloak the users completely, using three slices for #
511 # common CIDR bans (IPv4: /16, /24; IPv6: /48, /64). #
513 # These methods use a single key that can be any length of text. #
514 # An optional prefix may be specified to mark cloaked hosts. #
516 # The following methods are maintained for backwards compatibility; #
517 # they are slightly less secure, and always hide unresolved IPs. #
519 # compat-host InspIRCd 1.2-compatible host-based cloaking. #
520 # compat-ip InspIRCd 1.2-compatible ip-always cloaking. #
522 # If you use a compat cloaking mode then you must specify key1, key2, #
523 # key3, key4; the values must be less than 0x80000000 and should be #
524 # picked at random. Prefix is mandatory, will default to network name #
525 # if not specified, and will always have a "-" appended. #
527 # IMPORTANT: The compat-host and compat-ip modes have been removed in #
528 # the next major version of InspIRCd. You should ONLY use them if you #
529 # need backwards compatibility with InspIRCd 1.2. #
535 #-#-#-#-#-#-#-#-#-#-#-#- CLOSE MODULE #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
536 # Close module: Allows an oper to close all unregistered connections.
537 # This module is oper-only and provides the /CLOSE command.
538 # To use, CLOSE must be in one of your oper class blocks.
539 #<module name="m_close.so">
541 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
542 # Clones module: Adds an oper command /CLONES for detecting cloned
543 # users. Warning: This command may be resource intensive when it is
544 # issued, use with care.
545 # This module is oper-only.
546 # To use, CLONES must be in one of your oper class blocks.
547 #<module name="m_clones.so">
549 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
550 # Common channels module: Adds user mode +c, which, when set, requires
551 # that users must share a common channel with you to PRIVMSG or NOTICE
553 #<module name="m_commonchans.so">
555 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
556 # Auto join on connect module: Allows you to force users to join one
557 # or more channels automatically upon connecting to the server.
558 #<module name="m_conn_join.so">
560 #-#-#-#-#-#-#-#-#-#-#-#- CONNJOIN CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
562 # If you have m_conn_join.so loaded, you can configure it using the
563 # following values, or set autojoin="#chat,#help" in <connect> blocks.
565 #<autojoin channel="#one,#two,#three">
567 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
568 # Set modes on connect module: When this module is loaded <connect>
569 # blocks may have an optional modes="" value, which contains modes to
570 # add or remove from users when they connect to the server.
571 #<module name="m_conn_umodes.so">
573 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
574 # Wait for PONG on connect module: Send a PING to all connecting users
575 # and don't let them connect until they reply with a PONG.
576 # This is useful to stop certain kinds of bots and proxies.
577 #<module name="m_conn_waitpong.so">
579 #-#-#-#-#-#-#-#-#-#-#- WAITPONG CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
581 # If you have the m_conn_waitpong.so module loaded, configure it with #
582 # the <waitpong> tag: #
584 # sendsnotice - Whether to send a helpful notice to users on #
585 # connect telling them how to connect, should #
586 # their client not reply PONG automatically. #
588 # killonbadreply - Whether to kill the user if they send the wrong #
591 #<waitpong sendsnotice="yes" killonbadreply="yes">
593 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
594 # Channel cycle module: Adds the /CYCLE command which is a server-side
595 # /HOP that bypasses restrictive modes.
596 #<module name="m_cycle.so">
598 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
599 # Connectban: Provides IP connection throttling. Any IP range that
600 # connects too many times (configurable) in an hour is Z-Lined for a
601 # (configurable) duration, and their count resets to 0.
602 #<module name="m_connectban.so">
604 # ipv4cidr and ipv6cidr allow you to turn the comparison from
605 # individual IP addresses (32 and 128 bits) into CIDR masks, to allow
606 # for throttling over whole ISPs/blocks of IPs, which may be needed to
609 # This allows for 10 connections in an hour with a 10 minute ban if
611 #<connectban threshold="10" duration="10m" ipv4cidr="32" ipv6cidr="128">
613 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
614 # Connection throttle module.
615 #<module name="m_connflood.so">
617 #-#-#-#-#-#-#-#-#-#-#- CONNTHROTTLE CONFIGURATION -#-#-#-#-#-#-#-#-#-#
618 # seconds, maxconns - Amount of connections per <seconds>.
620 # timeout - Time to wait after the throttle was activated
621 # before deactivating it. Be aware that the time
622 # is seconds + timeout.
624 # quitmsg - The message that users get if they attempt to
625 # connect while the throttle is active.
627 # bootwait - Amount of time in seconds to wait before enforcing
628 # the throttling when the server just booted.
630 #<connflood seconds="30" maxconns="3" timeout="30"
631 # quitmsg="Throttled" bootwait="10">
633 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
634 # Custom prefixes: Allows for channel prefixes to be added.
635 # This replaces m_chanprotect and m_halfop.
636 #<module name="m_customprefix.so">
638 # name The name of the mode, must be unique from other modes.
639 # letter The letter used for this mode. Required.
640 # prefix The prefix used for nicks with this mode. Not required.
641 # rank A numeric rank for this prefix, defining what permissions it gives.
642 # The rank of voice, halfop and op is 10000, 20000, and 30000,
644 # ranktoset The numeric rank required to set/unset this mode. Defaults to rank.
645 # depriv Can you remove the mode from yourself? Defaults to yes.
646 #<customprefix name="founder" letter="q" prefix="~" rank="50000" ranktoset="50000">
647 #<customprefix name="admin" letter="a" prefix="&" rank="40000" ranktoset="50000">
648 #<customprefix name="halfop" letter="h" prefix="%" rank="20000" ranktoset="30000">
649 #<customprefix name="halfvoice" letter="V" prefix="-" rank="1" ranktoset="20000">
651 # Do /RELOADMODULE m_customprefix.so after changing the settings of this module.
653 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
654 # Custom title module: Adds the /TITLE command which allows for trusted
655 # users to gain a custom whois line and an optional vhost can be
657 #<module name="m_customtitle.so">
659 #-#-#-#-#-#-#-#-#-#- CUSTOM TITLE CONFIGURATION -#-#-#-#-#-#-#-#-#-#
660 # name - The username used to identify.
661 # password - The password used to identify.
662 # hash - The hash for the specific user's password (optional).
663 # m_password_hash.so and a hashing module must be loaded
665 # host - Allowed hostmask (optional).
666 # title - Title shown in whois.
667 # vhost - Displayed host (optional).
669 #<title name="foo" password="bar" title="Official Chat Helper">
670 #<title name="bar" password="foo" host="ident@test.org" title="Official Chat Helper" vhost="helper.test.org">
671 #<title name="foo" password="fcde2b2edba56bf408601fb721fe9b5c338d10ee429ea04fae5511b68fbf8fb9" hash="sha256" title="Official Chat Helper">
673 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
674 # DCCALLOW module: Adds the /DCCALLOW command.
675 #<module name="m_dccallow.so">
677 #-#-#-#-#-#-#-#-#-#-#- DCCALLOW CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
678 # blockchat - Whether to block DCC CHAT as well as DCC SEND.
679 # length - Default duration of entries in DCCALLOW list.
680 # action - Default action to take if no action is
681 # specified, can be 'block' or 'allow'.
682 # maxentries - Max number of nicks to allow on a DCCALLOW list.
684 # File configuration:
685 # pattern - The glob pattern to match against.
686 # action - Action to take if a user attempts to send a file
687 # that matches this pattern, can be 'block' or
690 #<dccallow blockchat="yes" length="5m" action="block" maxentries="20">
691 #<banfile pattern="*.exe" action="block">
692 #<banfile pattern="*.txt" action="allow">
694 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
695 # Deaf module: Adds support for the usermode +d - deaf to channel
696 # messages and channel notices.
697 #<module name="m_deaf.so">
699 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
700 # Delay join module: Adds the channel mode +D which delays all JOIN
701 # messages from users until they speak. If they quit or part before
702 # speaking, their quit or part message will not be shown to the channel
703 # which helps cut down noise on large channels in a more friendly way
704 # than the auditorium mode. Only channel ops may set the +D mode.
705 #<module name="m_delayjoin.so">
707 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
708 # Delay message module: Adds the channel mode +d which disallows a user
709 # from talking in the channel unless they've been joined for X seconds.
710 # Settable using /MODE #chan +d 30
711 #<module name="m_delaymsg.so">
712 # Set allownotice to no to disallow NOTICEs too. Defaults to yes.
713 #<delaymsg allownotice="no">
715 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
716 # Deny channels module: Deny channels from being used by users.
717 #<module name="m_denychans.so">
719 #-#-#-#-#-#-#-#-#-#-#- DENYCHAN DEFINITIONS -#-#-#-#-#-#-#-#-#-#-#-#
721 # If you have the m_denychans.so module loaded, you need to specify #
722 # the channels to deny: #
724 # name - The channel name to deny (glob masks are ok). #
725 # allowopers - If operators are allowed to override the deny. #
726 # reason - Reason given for the deny. #
727 # redirect - Redirect the user to a different channel. #
729 #<badchan name="#gods*" allowopers="yes" reason="Tortoises!"> #
730 #<badchan name="#chan1" redirect="#chan2" reason="Chan1 is closed"> #
732 # Redirects will not work if the target channel is set +L. #
734 # Additionally, you may specify channels which are allowed, even if #
735 # a badchan tag specifies it would be denied: #
736 #<goodchan name="#funtimes"> #
737 # Glob masks are accepted here also. #
739 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
740 # Devoice module: Let users devoice themselves using /DEVOICE #chan.
741 #<module name="m_devoice.so">
743 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
744 # DNS blacklist module: Provides support for looking up IPs on one or #
746 #<module name="m_dnsbl.so"> #
748 # For configuration options please see the wiki page for m_dnsbl at #
749 # https://wiki.inspircd.org/Modules/2.0/dnsbl #
751 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
752 # Exempt channel operators module: Provides support for allowing #
753 # channel operators to be exempt from some channel modes. Supported #
754 # modes are blockcaps, noctcp, blockcolor, nickflood, flood, censor, #
755 # filter, regmoderated, nonick, nonotice, and stripcolor. #
756 #<module name="m_exemptchanops.so"> #
758 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
759 # Filter module: Provides message filtering, similar to SPAMFILTER. #
760 #<module name="m_filter.so">
762 # This module depends upon a regex provider such as m_regex_pcre or #
763 # m_regex_glob to function. You must specify which of these you want #
764 # m_filter to use via the tag below. #
766 # Valid engines are: #
768 # glob - Glob patterns, provided via m_regex_glob. #
769 # pcre - PCRE regexps, provided via m_regex_pcre, needs libpcre. #
770 # tre - TRE regexps, provided via m_regex_tre, requires libtre. #
771 # posix - POSIX regexps, provided via m_regex_posix, not available #
772 # on Windows, no dependencies on other operating systems. #
773 # stdlib - stdlib regexps, provided via m_regex_stdlib, see comment #
774 # at the <module> tag for info on availability. #
776 #<filteropts engine="glob"> #
778 # Your choice of regex engine must match on all servers network-wide.
780 # You may specify specific channels that are exempt from being filtered:
781 #<exemptfromfilter channel="#blah">
783 #-#-#-#-#-#-#-#-#-#-#- FILTER CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#
785 # Optional - If you specify to use the m_filter module, then #
786 # specify below the path to the filter.conf file, or define some #
789 #<include file="conf/examples/filter.conf.example">
791 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
792 # Gecos ban: Implements extended ban 'r', which stops anyone matching
793 # a mask like +b r:*realname?here* from joining a channel.
794 #<module name="m_gecosban.so">
796 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
797 # GeoIP module: Allows the server admin to match users by country code.
798 # This module is in extras. Re-run configure with:
799 # ./configure --enable-extras=m_geoip.cpp
800 # and run make install, then uncomment this module to enable it.
801 # This module requires GeoIP to be installed on your system,
802 # use your package manager to find the appropriate packages
803 # or check the InspIRCd wiki page for this module.
804 #<module name="m_geoip.so">
806 # The actual allow/ban actions are done by connect classes, not by the
807 # GeoIP module. An example connect class to ban people from russia or
810 # <connect deny="*" geoip="TR,RU">
812 # The country code must be in capitals and should be an ISO country
813 # code such as TR, GB, or US. Unknown IPs (localhost, LAN IPs, etc)
814 # will be assigned the country code "UNK". Since connect classes are
815 # matched from top down, your deny classes must be above your allow
816 # classes for them to match.
818 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
819 # Globops module: Provides the /GLOBOPS command and snomask +g.
820 # This module is oper-only.
821 # To use, GLOBOPS must be in one of your oper class blocks.
822 #<module name="m_globops.so">
824 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
825 # Global load module: Allows loading and unloading of modules network-
826 # wide (USE WITH EXTREME CAUTION!)
827 # This module is oper-only and provides /GLOADMODULE, /GUNLOADMODULE
828 # and /GRELOADMODULE.
829 # To use, GLOADMODULE, GUNLOADMODULE and GRELOADMODULE
830 # must be in one of your oper class blocks.
831 #<module name="m_globalload.so">
833 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
834 # Halfop module: Provides the +h (halfops) channel status mode.
836 # IMPORTANT: This module has been removed in the next major version of
837 # InspIRCd. You should use m_customprefix instead.
838 #<module name="m_halfop.so">
840 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
841 # HELPOP module: Provides the /HELPOP command.
842 #<module name="m_helpop.so">
844 #-#-#-#-#-#-#-#-#-#-#-#- HELPOP CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
846 # If you specify to use the m_helpop.so module, then specify below #
847 # the path to the helpop.conf file. #
848 #<include file="conf/examples/inspircd.helpop-full.example">
850 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
851 # Hide chans module: Allows users to hide their channels list from non-
852 # opers by setting user mode +I on themselves.
853 #<module name="m_hidechans.so">
855 # This mode can optionally prevent opers from seeing channels on a +I
856 # user, for more privacy if set to true.
857 # This setting is not recommended for most mainstream networks.
858 #<hidechans affectsopers="false">
860 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
861 # Hide oper module: Allows opers to hide their oper status from non-
862 # opers by setting user mode +H on themselves.
863 # This module is oper-only.
864 #<module name="m_hideoper.so">
866 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
867 # Hostchange module: Allows a different style of cloaking.
868 #<module name="m_hostchange.so">
870 #-#-#-#-#-#-#-#-#-#-#- HOSTCHANGE CONFIGURATION -#-#-#-#-#-#-#-#-#-#
872 # See https://wiki.inspircd.org/Modules/2.0/hostchange for help. #
874 #<host suffix="invalid.org" separator="." prefix="">
875 #<hostchange mask="*@42.theanswer.example.org" action="addnick">
876 #<hostchange mask="*root@*" action="suffix">
877 #<hostchange mask="a@example.com" action="set" value="foo.bar.baz">
878 #<hostchange mask="localhost" ports="7000,7001,7005-7007" action="set" value="blahblah.foo">
880 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
881 # httpd module: Provides HTTP server support for InspIRCd.
882 #<module name="m_httpd.so">
884 #-#-#-#-#-#-#-#-#-#-#-#- HTTPD CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
886 # If you choose to use the m_httpd.so module, then you will need to add
887 # a <bind> tag with type "httpd", and load at least one of the other
888 # m_httpd_* modules to provide pages to display.
890 # You can adjust the timeout for HTTP connections below. All HTTP
891 # connections will be closed after (roughly) this many seconds.
892 #<httpd timeout="20">
894 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
895 # HTTP ACL module: Provides access control lists for m_httpd dependent
896 # modules. Use this module to restrict pages by IP address and by
898 #<module name="m_httpd_acl.so">
900 #-#-#-#-#-#-#-#-#-#-#-#- HTTPD ACL CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
902 # Restrict access to the m_httpd_stats module to all but the local
903 # network and when the correct password is specified:
904 # <httpdacl path="/stats*" types="password,whitelist"
905 # username="secrets" password="mypasshere" whitelist="127.0.0.*,10.*">
907 # Deny all connections to all but the main index page:
908 # <httpdacl path="/*" types="blacklist" blacklist="*">
910 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
911 # HTTP config module: Allows the configuration of the server to be
912 # viewed over HTTP. Requires m_httpd.so to be loaded for it to function.
913 #<module name="m_httpd_config.so">
915 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
916 # HTTP stats module: Provides basic stats pages over HTTP.
917 # Requires m_httpd.so to be loaded for it to function.
918 #<module name="m_httpd_stats.so">
920 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
921 # Ident: Provides RFC 1413 ident lookup support.
922 # When this module is loaded <connect:allow> tags may have an optional
923 # useident="yes|no" boolean value, determining whether or not to lookup
924 # ident on users matching that connect tag.
925 #<module name="m_ident.so">
927 #-#-#-#-#-#-#-#-#-#-#-#- IDENT CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
929 # Optional - If you are using the m_ident.so module, then you can #
930 # specify the timeout for ident lookups here. If not defined, it will #
931 # default to 5 seconds. This is a non-blocking timeout which holds #
932 # the user in a 'connecting' state until the lookup is complete. #
933 # The bind value indicates which IP to bind outbound requests to. #
937 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
938 # Invite exception module: Adds support for channel invite exceptions
940 #<module name="m_inviteexception.so">
941 # bypasskey: If this is enabled, exceptions will bypass +k as well as +i
942 #<inviteexception bypasskey="yes">
944 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
945 # IRCv3 module: Provides the following IRCv3 extensions:
946 # extended-join, away-notify and account-notify. These are optional
947 # enhancements to the client-to-server protocol. An extension is only
948 # active for a client when the client specifically requests it, so this
949 # module needs m_cap to work.
951 # Further information on these extensions can be found at the IRCv3
952 # working group website:
953 # http://ircv3.net/irc/
955 #<module name="m_ircv3.so">
956 # The following block can be used to control which extensions are
957 # enabled. Note that extended-join can be incompatible with m_delayjoin
959 #<ircv3 accountnotify="on" awaynotify="on" extendedjoin="on">
961 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
962 # Join flood module: Adds support for join flood protection +j X:Y.
963 # Closes the channel for 60 seconds if X users join in Y seconds.
964 #<module name="m_joinflood.so">
966 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
967 # Jump server module: Adds support for the RPL_REDIR numeric.
968 # This module is oper-only.
969 # To use, JUMPSERVER must be in one of your oper class blocks.
970 # If your server is redirecting new clients and you get disconnected,
971 # do a REHASH from shell to open up again.
972 #<module name="m_jumpserver.so">
974 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
975 # Anti auto rejoin: Adds support for prevention of auto-rejoin (+J).
976 #<module name="m_kicknorejoin.so">
977 # Set the maximum time that is accepted as a parameter for +J here.
978 #<kicknorejoin maxtime="1m">
980 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
981 # Knock module: Adds the /KNOCK command and channel mode +K.
982 #<module name="m_knock.so">
984 # This setting specifies what to do when someone successfully /KNOCKs.
985 # If set to "notice", then a NOTICE will be sent to the channel.
986 # This is the default and the compatible setting, as it requires no
987 # special support from the clients.
988 # If set to "numeric" then a 710 numeric will be sent to the channel.
989 # This allows easier scripting but not all clients support it.
990 # If set to "both" then (surprise!) both will be sent.
991 #<knock notify="notice">
993 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
994 # LDAP authentication module: Adds the ability to authenticate users #
995 # via LDAP. This is an extra module which must be enabled explicitly #
996 # by symlinking it from modules/extra, and requires the OpenLDAP libs #
997 # This module is in extras. To enable it, Re-run configure with: #
998 # ./configure --enable-extras=m_ldapauth.cpp #
999 # and run make install, then uncomment this module. #
1000 #<module name="m_ldapauth.so">
1004 # <ldapauth baserdn="ou=People,dc=brainbox,dc=cc" #
1006 # server="ldap://brainwave.brainbox.cc" #
1007 # allowpattern="Guest*" #
1008 # killreason="Access denied" #
1009 # searchscope="subtree" #
1010 # binddn="cn=Manager,dc=brainbox,dc=cc" #
1011 # bindauth="mysecretpass" #
1013 # host="$uid.$ou.inspircd.org" #
1014 # useusername="no"> #
1016 # <ldapwhitelist cidr="10.42.0.0/16"> #
1018 # <ldaprequire attribute="attr" value="val"> #
1020 # The baserdn indicates the base DN to search in for users. Usually #
1021 # this is 'ou=People,dc=yourdomain,dc=yourtld'. #
1023 # The attribute value indicates the attribute which is used to locate #
1024 # a user account by name. On POSIX systems this is usually 'uid'. #
1026 # The useusername setting chooses whether the user's username or #
1027 # nickname is used when locating a user account, if a username isn't #
1028 # provided in PASS. #
1030 # The server parameter indicates the LDAP server to connect to. The #
1031 # ldap:// style scheme before the hostname proper is MANDATORY. #
1033 # The allowpattern value allows you to specify a wildcard mask which #
1034 # will always be allowed to connect regardless of if they have an #
1035 # account, for example guest users. #
1037 # Killreason indicates the QUIT reason to give to users if they fail #
1038 # to authenticate. #
1040 # The searchscope value indicates the subtree to search under. On our #
1041 # test system this is 'subtree'. Your mileage may vary. #
1043 # Setting the verbose value causes an oper notice to be sent out for #
1044 # every failed authentication to the server, with an error string. #
1046 # The binddn and bindauth indicate the DN to bind to for searching, #
1047 # and the password for the distinguished name. Some LDAP servers will #
1048 # allow anonymous searching in which case these two values do not #
1049 # need defining, otherwise they should be set similar to the examples #
1052 # ldapwhitelist indicates that clients connecting from an IP in the #
1053 # provided CIDR do not need to authenticate against LDAP. It can be #
1054 # repeated to whitelist multiple CIDRs. #
1056 # ldaprequire allows further filtering on the LDAP user, by requiring #
1057 # certain LDAP attibutes to have a given value. It can be repeated, #
1058 # in which case the list will act as an OR list, that is, the #
1059 # authentication will succeed if any of the requirements in the list #
1062 # host allows you to change the displayed host of users connecting #
1063 # from ldap. The string supplied takes formatters which are replaced #
1064 # from the DN. For instance, if your DN looks like: #
1065 # uid=w00t,ou=people,dc=inspircd,dc=org, then the formatters uid, ou #
1066 # and dc will be available to you. If a key is given multiple times #
1067 # in the DN, the last appearance will take precedence. #
1069 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1070 # LDAP oper configuration module: Adds the ability to authenticate #
1071 # opers via LDAP. This is an extra module which must be enabled #
1072 # explicitly by symlinking it from modules/extra, and requires the #
1073 # OpenLDAP libs. Re-run configure with: #
1074 # ./configure --enable-extras=m_ldapoper.cpp
1075 # and run make install, then uncomment this module to enable it. #
1076 #<module name="m_ldapoper.so">
1080 # <ldapoper baserdn="ou=People,dc=brainbox,dc=cc"
1081 # server="ldap://brainwave.brainbox.cc"
1082 # searchscope="subtree"
1083 # binddn="cn=Manager,dc=brainbox,dc=cc"
1084 # bindauth="mysecretpass"
1087 # Available configuration items are identical to the same items in #
1088 # m_ldapauth above (except for the verbose setting, that is only #
1089 # supported in m_ldapauth). #
1090 # Please always specify a password in your <oper> tags even if the #
1091 # opers are to be authenticated via LDAP, so in case this module is #
1092 # not loaded the oper accounts are still protected by a password. #
1094 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1095 # Lock server module: Adds /LOCKSERV and /UNLOCKSERV commands that #
1096 # are used to temporarily close/open the server for new connections. #
1097 # These commands require that the /LOCKSERV and /UNLOCKSERV commands #
1098 # are specified in a <class> tag that the oper is part of. This is so #
1099 # you can control who has access to this possible dangerous command. #
1100 # If your server is locked and you get disconnected, do a REHASH from #
1101 # shell to open up again. #
1102 # This module is oper-only.
1103 #<module name="m_lockserv.so">
1105 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1106 # Map hiding module: replaces /MAP and /LINKS output to users with a #
1107 # message to see a website, set by maphide="http://test.org/map" in #
1108 # the <security> tag, instead. #
1109 #<module name="m_maphide.so">
1111 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1112 # Message flood module: Adds message/notice flood protection via
1114 #<module name="m_messageflood.so">
1116 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1117 # MLOCK module: Adds support for server-side enforcement of services
1118 # side MLOCKs. Basically, this module suppresses any mode change that
1119 # would likely be immediately bounced by services.
1120 #<module name="m_mlock.so">
1122 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1123 # MsSQL module: Allows other SQL modules to access MS SQL Server
1124 # through a unified API.
1125 # This module is in extras. Re-run configure with:
1126 # ./configure --enable-extras=m_mssql.cpp
1127 # and run make install, then uncomment this module to enable it.
1128 #<module name="m_mssql.so">
1130 #-#-#-#-#-#-#-#-#-#-#-#- SQL CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#-#
1132 # m_mssql.so is more complex than described here, see wiki for more #
1133 # info https://wiki.inspircd.org/Modules/2.0/mssql #
1135 #<database module="mssql" name="db" user="user" pass="pass" host="localhost" id="db1">
1137 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1138 # MySQL module: Allows other SQL modules to access MySQL databases
1139 # through a unified API.
1140 # This module is in extras. Re-run configure with:
1141 # ./configure --enable-extras=m_mysql.cpp
1142 # and run make install, then uncomment this module to enable it.
1143 #<module name="m_mysql.so">
1145 #-#-#-#-#-#-#-#-#-#-#-#- SQL CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#-#
1147 # m_mysql.so is more complex than described here, see the wiki for #
1148 # more: https://wiki.inspircd.org/Modules/2.0/mysql #
1150 #<database module="mysql" name="mydb" user="myuser" pass="mypass" host="localhost" id="my_database2">
1152 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1153 # Named modes module: Allows for the display and set/unset of channel
1154 # modes via long-form mode names via +Z and the /PROP command.
1155 # For example, to set a ban, do /mode #channel +Z ban=foo!bar@baz or
1156 # /PROP #channel ban=foo!bar@baz
1157 #<module name="m_namedmodes.so">
1159 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1160 # NAMESX module: Provides support for the NAMESX extension which allows
1161 # clients to see all the prefixes set on a user without getting confused.
1162 # This is supported by mIRC, x-chat, klient, and maybe more.
1163 #<module name="m_namesx.so">
1165 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1166 # National characters module:
1167 # 1) Allows using national characters in nicknames.
1168 # 2) Allows using custom (national) casemapping over the network.
1169 #<module name="m_nationalchars.so">
1171 # file - Location of the file which contains casemapping rules. If this
1172 # is a relative path then it is relative to "<PWD>/../locales"
1173 # on UNIX and "<PWD>/locales" on Windows.
1174 # casemapping - The name of the casemapping sent to clients in the 005
1175 # numeric. If this is not set then it defaults to the name
1176 # of the casemapping file unless the file name contains a
1177 # space in which case you will have to specify it manually.
1178 #<nationalchars file="bynets/russian-w1251-charlink" casemapping="ru_RU.cp1251-charlink">
1180 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1181 # Nickchange flood protection module: Provides channel mode +F X:Y
1182 # which allows up to X nick changes in Y seconds.
1183 #<module name="m_nickflood.so">
1185 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1186 # Nicklock module: Let opers change a user's nick and then stop that
1187 # user from changing their nick again until unlocked.
1188 # This module is oper-only.
1189 # To use, NICKLOCK and NICKUNLOCK must be in one of your oper class blocks.
1190 #<module name="m_nicklock.so">
1192 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1193 # No CTCP module: Adds the channel mode +C to block CTCPs and extban
1194 # 'C' to block CTCPs sent by specific users.
1195 #<module name="m_noctcp.so">
1197 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1198 # No kicks module: Adds the +Q channel mode and the Q: extban to deny
1199 # certain users from kicking.
1200 #<module name="m_nokicks.so">
1202 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1203 # No nicks module: Adds the +N channel mode, as well as the 'N' extban.
1204 # +N stops all users from changing their nick, the N extban stops
1205 # anyone from matching a +b N:nick!user@host mask from changing their
1207 #<module name="m_nonicks.so">
1209 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1210 # No part message module: Adds extban 'p' to block part messages from #
1212 #<module name="m_nopartmsg.so">
1214 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1215 # No notice module: Adds the channel mode +T and the extban 'T' to
1216 # block specific users from noticing the channel.
1217 #<module name="m_nonotice.so">
1219 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1220 # Network business join module:
1221 # Allows an oper to join a channel using /OJOIN, giving them +Y on the
1222 # channel which makes them immune to kick/deop/etc.
1223 #<module name="m_ojoin.so">
1225 # Specify the prefix that +Y will grant here.
1226 # Leave 'prefix' empty if you do not wish +Y to grant a prefix.
1227 # If 'notice' is set to on, upon /OJOIN, the server will notice the
1228 # channel saying that the oper is joining on network business.
1229 # If 'op' is set to on, it will give them +o along with +Y.
1230 #<ojoin prefix="!" notice="yes" op="yes">
1232 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1233 # Oper channels mode: Adds the +O channel mode and extban O:<mask>
1234 # to ban, except, etc. specific oper types. For example
1235 # /mode #channel +iI O:* is equivalent to channel mode +O, but you
1236 # may also set +iI O:AdminTypeOnly to only allow admins.
1237 # Modes +I and +e work in a similar fashion.
1238 #<module name="m_operchans.so">
1240 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1241 # Oper join module: Auto-joins opers to a channel upon oper-up.
1242 # This module is oper-only. For the user equivalent, see m_conn_join.
1243 #<module name="m_operjoin.so">
1245 #-#-#-#-#-#-#-#-#-#-# OPERJOIN CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
1247 # If you are using the m_operjoin.so module, specify options here: #
1249 # channel - The channel name to join, can also be a comma #
1250 # separated list e.g. "#channel1,#channel2". #
1252 # override - If on, lets the oper join walking thru any modes #
1253 # that might be set, even bans. #
1255 #<operjoin channel="#channel" override="no">
1257 # Alternatively you can use the autojoin="channellist" in a <type> #
1258 # tag to set specific autojoins for a type of oper, for example: #
1260 #<type name="Helper" autojoin="#help" classes="...">
1262 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1263 # Oper log module: Logs all oper commands to the server log (with log
1264 # type "m_operlog" at default loglevel), and optionally to the 'r'
1266 # This module is oper-only.
1267 #<module name="m_operlog.so">
1269 # If the following option is on then all oper commands will be sent to
1270 # the snomask 'r'. The default is off.
1271 #<operlog tosnomask="off">
1273 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1274 # Oper prefixing module: Adds a channel prefix mode +y which is given
1275 # to all IRC operators automatically on all channels they are in.
1276 # This prefix mode is more powerful than channel op and other regular
1279 # Load this module if you want all your IRC operators to have channel
1281 #<module name="m_operprefix.so">
1283 # You may additionally customise the prefix character.
1284 #<operprefix prefix="!">
1286 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1287 # Oper MOTD module: Provides support for separate message of the day
1289 # This module is oper-only.
1290 #<module name="m_opermotd.so">
1292 #-#-#-#-#-#-#-#-#-#-# OPERMOTD CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
1294 # If you are using the m_opermotd.so module, specify the motd here. #
1296 # onoper - If on, the message is sent on /OPER, otherwise it's #
1297 # only sent when /OPERMOTD is used. #
1299 # processcolors - Allow color codes to be processed in the opermotd. #
1300 # Read the comment above <connect:allowmotdcolors> in #
1301 # inspircd.conf.example for details. #
1303 #<opermotd file="conf/examples/opermotd.txt.example" onoper="yes" processcolors="false">
1305 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1306 # Override module: Adds support for oper override.
1307 # This module is oper-only.
1308 #<module name="m_override.so">
1310 #-#-#-#-#-#-#-#-#-#-# OVERRIDE CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
1312 # m_override.so is too complex it describe here, see the wiki: #
1313 # https://wiki.inspircd.org/Modules/2.0/override #
1315 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1316 # Oper levels module: Gives each oper a level and prevents actions
1317 # being taken by lower level opers against higher level opers.
1318 # Specify the level as the 'level' parameter of the <type> tag.
1319 # This module is oper-only.
1320 #<module name="m_operlevels.so">
1322 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1323 # Oper modes module: Allows you to specify modes to add/remove on oper.
1324 # Specify the modes as the 'modes' parameter of the <type> tag
1325 # and/or as the 'modes' parameter of the <oper> tag.
1326 # This module is oper-only. For the user equivalent, see m_conn_umodes.
1327 #<module name="m_opermodes.so">
1329 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1330 # Password forwarding module: Forwards a password users can send on
1331 # connect to the specified client below. The client is usually NickServ
1332 # and this module is usually used to authenticate users with NickServ
1333 # using their connect password.
1334 #<module name="m_passforward.so">
1337 # nick: nick to forward connect passwords to.
1340 # forwardmsg: Message to send to users using a connect password.
1341 # $nick will be the users' nick, $nickrequired will be the nick
1342 # of where the password is going (the nick above).
1343 # You can also use $user for the user ident string.
1344 forwardmsg="NOTICE $nick :*** Forwarding PASS to $nickrequired"
1346 # cmd: Command for the user to run when it receives a connect
1348 cmd="PRIVMSG $nickrequired :IDENTIFY $pass">
1350 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1351 # Password hash module: Allows hashed passwords to be used.
1352 # To be useful, a hashing module like m_sha256.so also needs to be loaded.
1353 #<module name="m_password_hash.so">
1355 #-#-#-#-#-#-#-#-#-# PASSWORD HASH CONFIGURATION #-#-#-#-#-#-#-#-#-#-#-#
1357 # To use this module, you must define a hash type for each oper's
1358 # password you want to hash. For example:
1360 # <oper name="Brain"
1361 # host="ident@dialup15.isp.test.com"
1363 # password="01ba4719c80b6fe911b091a7c05124b64eeece964e09c058ef8f9805daca546b"
1366 # Starting from 2.0, you can use a more secure salted hash that prevents simply
1367 # looking up the hash's value in a rainbow table built for the hash.
1368 # hash="hmac-sha256" password="lkS1Nbtp$CyLd/WPQXizsbxFUTqFRoMvaC+zhOULEeZaQkUJj+Gg"
1370 # Generate hashes using the /MKPASSWD command on the server.
1371 # Don't run it on a server you don't trust with your password.
1373 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1374 # Permanent channels module: Channels with the permanent channel mode
1375 # will remain open even after everyone else has left the channel, and
1376 # therefore keep things like modes, ban lists and topic. Permanent
1377 # channels -may- need support from your Services package to function
1378 # properly with them. This adds channel mode +P.
1379 # This module is oper-only.
1380 #<module name="m_permchannels.so">
1382 # If you like, m_permchannels can write a config file of permanent channels
1383 # whenever +P is set, unset, or the topic/modes on a +P channel is changed.
1384 # If you want to do this, set the filename below, and uncomment the include.
1386 # If 'listmodes' is true then all list modes (+b, +I, +e, +g...) will be
1387 # saved. Defaults to false.
1388 #<permchanneldb filename="data/permchannels.conf" listmodes="true">
1389 #<include file="data/permchannels.conf">
1391 # You may also create channels on startup by using the <permchannels> block.
1392 # Don't forget to set them +P in the modes, or they won't stay permanent.
1393 #<permchannels channel="#opers" modes="isP" topic="Opers only.">
1395 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1396 # PostgreSQL module: Allows other SQL modules to access PgSQL databases
1397 # through a unified API.
1398 # This module is in extras. Re-run configure with:
1399 # ./configure --enable-extras=m_pgsql.cpp
1400 # and run make install, then uncomment this module to enable it.
1401 #<module name="m_pgsql.so">
1403 #-#-#-#-#-#-#-#-#-#-#-#- SQL CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#-#
1405 # m_pgsql.so is more complex than described here, see the wiki for #
1406 # more: https://wiki.inspircd.org/Modules/2.0/pgsql #
1408 #<database module="pgsql" name="mydb" user="myuser" pass="mypass" host="localhost" id="my_database" ssl="no">
1410 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1411 # Muteban: Implements extended ban 'm', which stops anyone matching
1412 # a mask like +b m:nick!user@host from speaking on channel.
1413 #<module name="m_muteban.so">
1415 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1416 # Random quote module: Provides a random quote on connect.
1417 # NOTE: Some of these may mimic fatal errors and confuse users and
1418 # opers alike - BEWARE!
1419 #<module name="m_randquote.so">
1421 #-#-#-#-#-#-#-#-#-#- RANDOMQUOTES CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
1423 # Optional - If you specify to use the m_randquote.so module, then #
1424 # specify below the path to the quotes file. #
1426 #<randquote file="quotes.txt">
1428 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1429 # Redirect module: Adds channel redirection mode +L. #
1430 # Optional: <redirect:antiredirect> to add usermode +L to stop forced #
1431 # redirection and instead print an error. #
1433 # Note: You can not update this with a simple rehash, it requires #
1434 # reloading the module for it to take effect. #
1435 # This also breaks linking to servers that do not have the option. #
1436 # This defaults to false for the 2.0 version, it will be enabled in #
1437 # all the future versions. #
1438 #<module name="m_redirect.so">
1439 #<redirect antiredirect="true">
1441 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1442 # Regular expression provider for glob or wildcard (?/*) matching.
1443 # You must have at least 1 provider loaded to use m_filter or m_rline
1444 # modules. This module has no additional requirements, as it uses the
1445 # matching already present in InspIRCd core.
1446 #<module name="m_regex_glob.so">
1448 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1449 # Regular expression provider for PCRE (Perl-Compatible Regular
1450 # Expressions). You need libpcre installed to compile and load this
1451 # module. You must have at least 1 provider loaded to use m_filter or
1453 #<module name="m_regex_pcre.so">
1455 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1456 # Regular expression provider for POSIX regular expressions.
1457 # You shouldn't need any additional libraries on a POSIX-compatible
1458 # system (i.e.: any Linux, BSD, but not Windows). You must have at
1459 # least 1 provider loaded to use m_filter or m_rline.
1460 # On POSIX-compliant systems, regex syntax can be found by using the
1461 # command: 'man 7 regex'.
1462 #<module name="m_regex_posix.so">
1464 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1465 # Regular expression provider for C++11 std::regex regular expressions.
1466 # This module works on any fully compliant implementation of the C++11
1467 # std::regex container. Examples for such are Visual C++ 2010 and newer
1468 # but not libstdc++ (which GCC uses).
1469 # You should verify that std::regex is supported by your setup before
1470 # using this module, as it may compile normally but won't do anything
1471 # on some implementations.
1472 #<module name="m_regex_stdlib.so">
1474 # Specify the regular expression engine to use here. Valid settings are
1475 # bre, ere, awk, grep, egrep, ecmascript (default if not specified).
1476 #<stdregex type="ecmascript">
1478 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1479 # Regular expression provider for TRE regular expressions.
1480 # This is the same regular expression engine used by UnrealIRCd, so
1481 # if you are most familiar with the syntax of /SPAMFILTER from there,
1482 # this is the provider you want. You need libtre installed in order
1483 # to compile and load this module.
1484 #<module name="m_regex_tre.so">
1486 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1487 # Registered users only channel creation module. If enabled, only
1488 # registered users and opers can create new channels.
1490 # You probably *DO NOT* want to load this module on a public network.
1492 #<module name="m_regonlycreate.so">
1494 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1495 # Remove module: Adds the /REMOVE command which is a peaceful
1496 # alternative to /KICK.
1497 #<module name="m_remove.so">
1499 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1500 # Restricted channels module: Allows only opers to create channels.
1502 # You probably *DO NOT* want to load this module on a public network.
1504 #<module name="m_restrictchans.so">
1506 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1507 # Restrict message module: Allows users to only message opers.
1509 # You probably *DO NOT* want to load this module on a public network.
1511 #<module name="m_restrictmsg.so">
1513 # Uncomment this to allow users to message ulines (e.g. services):
1514 #<restrictmsg uline="yes">
1516 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1517 # R-Line module: Ban users through regular expression patterns.
1518 #<module name="m_rline.so">
1520 #-#-#-#-#-#-#-#-#-#-#-#- RLINE CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#-#
1522 # If you wish to re-check a user when they change nickname (can be
1523 # useful under some situations, but *can* also use CPU with more users
1524 # on a server) then set 'matchonnickchange' to yes.
1525 # Also, this is where you set what Regular Expression engine is to be
1526 # used. If you ever change it while running, all of your R-Lines will
1527 # be wiped. This is the regex engine used by all R-Lines set, and
1528 # m_regex_<engine>.so must be loaded, or rline will be non-functional
1529 # until you load it or change the engine to one that is loaded.
1531 #<rline matchonnickchange="yes" engine="pcre">
1533 # Generally, you will NOT want to use 'glob' here, as this turns
1534 # rline into just another gline. The exceptions are that rline will
1535 # always use the full "nick!user@host realname" string, rather than only
1536 # user@host, but beware that only the ? and * wildcards are available,
1537 # and are the only way to specify where the space can occur if you do
1538 # use glob. For this reason, is recommended to use a real regex engine
1539 # so that at least \s or [[:space:]] is available.
1541 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1542 # SAJOIN module: Adds the /SAJOIN command which forcibly joins a user
1543 # to the given channel.
1544 # This module is oper-only.
1545 # To use, SAJOIN must be in one of your oper class blocks.
1546 #<module name="m_sajoin.so">
1548 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1549 # SAKICK module: Adds the /SAKICK command which kicks a user from the
1551 # This module is oper-only.
1552 # To use, SAKICK must be in one of your oper class blocks.
1553 #<module name="m_sakick.so">
1555 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1556 # SAMODE module: Adds the /SAMODE command which allows server operators
1557 # to change modes on a channel without requiring them to have any
1558 # channel priviliges. Also allows changing user modes for any user.
1559 # This module is oper-only.
1560 # To use, SAMODE must be in one of your oper class blocks.
1561 #<module name="m_samode.so">
1563 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1564 # SANICK module: Adds the /SANICK command which allows opers to change
1566 # This module is oper-only.
1567 # To use, SANICK must be in one of your oper class blocks.
1568 #<module name="m_sanick.so">
1570 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1571 # SAPART module: Adds the /SAPART command which forcibly parts a user
1573 # This module is oper-only.
1574 # To use, SAPART must be in one of your oper class blocks.
1575 #<module name="m_sapart.so">
1577 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1578 # SAQUIT module: Adds the /SAQUIT command which forcibly quits a user.
1579 # This module is oper-only.
1580 # To use, SAQUIT must be in one of your oper class blocks.
1581 #<module name="m_saquit.so">
1583 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1584 # SATOPIC module: Adds the /SATOPIC command which allows changing the
1585 # topic on a channel without requiring any channel priviliges.
1586 # This module is oper-only.
1587 # To use, SATOPIC must be in one of your oper class blocks.
1588 #<module name="m_satopic.so">
1590 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1591 # SASL authentication module: Provides support for IRC Authentication
1592 # Layer via AUTHENTICATE. Note: You also need to have m_cap.so loaded
1594 #<module name="m_sasl.so">
1595 # Define the following to your services server name to improve security
1596 # by ensuring the SASL messages are only sent to the services server
1597 # and not to all connected servers. This prevents a rogue server from
1598 # capturing SASL messages.
1599 #<sasl target="services.mynetwork.com">
1601 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1602 # Secure list module: Prevent /LIST in the first minute of connection,
1603 # crippling most spambots and trojan spreader bots.
1604 #<module name="m_securelist.so">
1606 #-#-#-#-#-#-#-#-#-# SECURELIST CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#-#
1608 # Securelist can be harmful to some IRC search engines. To prevent #
1609 # securelist blocking these sites from listing, define exception tags #
1611 #<securehost exception="*@*.netsplit.de">
1612 #<securehost exception="*@*.ircdriven.com">
1613 #<securehost exception="*@*.ircs.me">
1615 # Define the following variable to change how long a user must wait #
1616 # before issuing a LIST. If not defined, defaults to 60 seconds. #
1618 #<securelist waittime="60"> #
1620 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1621 # Servprotect module: Provides support for Austhex style +k /
1622 # UnrealIRCD +S services mode.
1623 #<module name="m_servprotect.so">
1625 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1626 # See nicks module: Adds snomask +n and +N which show local and remote
1628 # This module is oper-only.
1629 #<module name="m_seenicks.so">
1631 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1632 # Set idle module: Adds a command for opers to change their idle time.
1633 # This module is oper-only.
1634 # To use, SETIDLE must be in one of your oper class blocks.
1635 #<module name="m_setidle.so">
1637 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1638 # Services support module: Adds several usermodes such as +R and +M.
1639 # This module implements the 'identified' state via account names,
1640 # and is similar in operation to the way asuka and ircu handle services.
1642 # At the same time, this offers +r for users and channels to mark them
1643 # as identified separately from the idea of a master account, which
1644 # can be useful for services which are heavily nick-as-account centric.
1646 # Also of note is that this module implements two extbans:
1647 # +b R: (stop matching account names from joining)
1648 # +b U:n!u@h (blocks matching unregistered users)
1650 #<module name="m_services_account.so">
1652 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1653 # Sethost module: Adds the /SETHOST command.
1654 # This module is oper-only.
1655 # To use, SETHOST must be in one of your oper class blocks.
1656 # See m_chghost for how to customise valid chars for hostnames.
1657 #<module name="m_sethost.so">
1659 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1660 # Setident module: Adds the /SETIDENT command.
1661 # This module is oper-only.
1662 # To use, SETIDENT must be in one of your oper class blocks.
1663 #<module name="m_setident.so">
1665 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1666 # SETNAME module: Adds the /SETNAME command.
1667 #<module name="m_setname.so">
1669 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1670 # Serverban: Implements extended ban 's', which stops anyone connected
1671 # to a server matching a mask like +b s:server.mask.here from joining.
1672 #<module name="m_serverban.so">
1674 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1675 # Show whois module: Adds the +W usermode which allows opers to see
1676 # when they are /WHOIS'd.
1677 # This module is oper-only by default.
1678 #<module name="m_showwhois.so">
1680 # If you wish, you may also let users set this mode. Only opers with the
1681 # users/auspex priv will see real hosts of people, though. This setting
1682 # is not reloadable via /REHASH, changing it requires /RELOADMODULE.
1683 #<showwhois opersonly="yes"
1685 # You may also set whether or not users should receive whois notices,
1686 # should they be /WHOIS'd by an oper.
1687 #showfromopers="yes">
1689 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1690 # Shun module: Provides the /SHUN command, which stops a user from
1691 # executing all except configured commands.
1692 # This module is oper-only.
1693 # To use, SHUN must be in one of your oper class blocks.
1694 #<module name="m_shun.so">
1696 # You may also configure which commands you wish a user to be able to
1697 # perform when shunned. It should be noted that if a shunned user
1698 # issues QUIT or PART then their message will be removed, as if they
1699 # did not issue one.
1701 # You can optionally let the user know that their command was blocked.
1703 # You may also let SHUN affect opers (defaults to no).
1704 #<shun enabledcommands="ADMIN PING PONG QUIT PART JOIN" notifyuser="yes" affectopers="no">
1706 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1707 # SSL channel mode module: Adds support for SSL-only channels via
1708 # channel mode +z and the 'z' extban which matches SSL client
1709 # certificate fingerprints.
1710 # Does not do anything useful without a working SSL module and the
1711 # m_sslinfo module (see below).
1712 #<module name="m_sslmodes.so">
1714 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1715 # GnuTLS SSL module: Adds support for SSL connections using GnuTLS,
1716 # if enabled. You must answer 'yes' in ./configure when asked or
1717 # manually symlink the source for this module from the directory
1718 # src/modules/extra, if you want to enable this, or it will not load.
1719 #<module name="m_ssl_gnutls.so">
1721 #-#-#-#-#-#-#-#-#-#-#- GNUTLS CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#
1723 # m_ssl_gnutls.so is too complex to describe here, see the wiki: #
1724 # https://wiki.inspircd.org/Modules/2.0/ssl_gnutls #
1726 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1727 # SSL info module: Allows users to retrieve information about other
1728 # users' peer SSL certificates and keys. This can be used by client
1729 # scripts to validate users. For this to work, one of m_ssl_gnutls.so
1730 # or m_ssl_openssl.so must be loaded. This module also adds the
1731 # "* <user> is using a secure connection" whois line, the ability for
1732 # opers to use SSL fingerprints to verify their identity and the
1733 # ability to force opers to use SSL connections in order to oper up.
1734 # It is highly recommended to load this module if you use SSL on your
1736 # For how to use the oper features, please see the first example <oper> tag
1737 # in opers.conf.example.
1739 #<module name="m_sslinfo.so">
1741 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1742 # OpenSSL SSL module: Adds support for SSL connections using OpenSSL,
1743 # if enabled. You must answer 'yes' in ./configure when asked or symlink
1744 # the source for this module from the directory src/modules/extra, if
1745 # you want to enable this, or it will not load.
1746 #<module name="m_ssl_openssl.so">
1748 #-#-#-#-#-#-#-#-#-#-#- OPENSSL CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#
1750 # m_ssl_openssl.so is too complex to describe here, see the wiki: #
1751 # https://wiki.inspircd.org/Modules/2.0/ssl_openssl #
1753 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1754 # Strip color module: Adds channel mode +S that strips mIRC color
1755 # codes from all messages sent to the channel.
1756 #<module name="m_stripcolor.so">
1758 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1759 # Silence module: Adds support for the /SILENCE command, which allows
1760 # users to have a server-side ignore list for their client.
1761 #<module name="m_silence.so">
1763 # Set the maximum number of entries allowed on a user's silence list.
1764 #<silence maxentries="32">
1766 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1767 # SQLite3 module: Allows other SQL modules to access SQLite3 #
1768 # databases through a unified API. #
1769 # This module is in extras. Re-run configure with: #
1770 # ./configure --enable-extras=m_sqlite3.cpp
1771 # and run make install, then uncomment this module to enable it. #
1773 #<module name="m_sqlite3.so">
1775 #-#-#-#-#-#-#-#-#-#-#-#- SQL CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#-#
1777 # m_sqlite.so is more complex than described here, see the wiki for #
1778 # more: https://wiki.inspircd.org/Modules/2.0/sqlite3 #
1780 #<database module="sqlite" hostname="/full/path/to/database.db" id="anytext">
1782 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1783 # SQL authentication module: Allows IRCd connections to be tied into
1784 # a database table (for example a forum).
1786 #<module name="m_sqlauth.so">
1788 #-#-#-#-#-#-#-#-#-#-#- SQLAUTH CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#
1790 # m_sqlauth.so is too complex to describe here, see the wiki: #
1791 # https://wiki.inspircd.org/Modules/2.0/sqlauth #
1793 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1794 # SQL oper module: Allows you to store oper credentials in an SQL table
1796 #<module name="m_sqloper.so">
1798 #-#-#-#-#-#-#-#-#-#-#- SQLOPER CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#
1800 # dbid - Database ID to use (see SQL modules). #
1801 # hash - Hashing provider to use for password hashing. #
1803 # See also: https://wiki.inspircd.org/Modules/2.0/sqloper #
1805 #<sqloper dbid="1" hash="md5">
1807 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1808 # SVSHold module: Implements SVSHOLD. Like Q:Lines, but can only be #
1809 # added/removed by Services. #
1810 #<module name="m_svshold.so">
1811 # If silent is true no snotices will be generated by SVSHOLD.
1812 #<svshold silent="false">
1814 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1815 # SWHOIS module: Allows you to add arbitrary lines to user WHOIS.
1816 # This module is oper-only.
1817 # To use, SWHOIS must be in one of your oper class blocks.
1818 #<module name="m_swhois.so">
1820 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1821 # Test module: Enable this to create a command useful in testing
1822 # flood control. To avoid accidental use on live networks, the server
1823 # name must contain ".test" to load the module
1824 #<module name="m_testnet.so">
1826 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1827 # Timed bans module: Adds timed channel bans with the /TBAN command.
1828 #<module name="m_timedbans.so">
1830 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1831 # Test line module: Adds the /TLINE command, used to test how many
1832 # users a /GLINE or /ZLINE etc. would match.
1833 # This module is oper-only.
1834 # To use, TLINE must be in one of your oper class blocks.
1835 #<module name="m_tline.so">
1837 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1838 # Topiclock module: implements server-side topic locking to achieve deeper
1839 # integration with services packages.
1840 #<module name="m_topiclock.so">
1842 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1843 # UHNAMES support module: Adds support for the IRCX style UHNAMES
1844 # extension, which displays ident and hostname in the names list for
1845 # each user, saving clients from doing a WHO on the channel.
1846 # If a client does not support UHNAMES it will not enable it, this will
1847 # not break incompatible clients.
1848 #<module name="m_uhnames.so">
1850 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1851 # Uninvite module: Adds the /UNINVITE command which lets users remove
1852 # pending invites from channels without waiting for the user to join.
1853 #<module name="m_uninvite.so">
1855 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1856 # Userip module: Adds the /USERIP command.
1857 # Allows users to query their own IP, also allows opers to query the IP
1859 #<module name="m_userip.so">
1861 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1862 # Vhost module: Adds the VHOST command which allows for adding virtual
1863 # hosts which are accessible using a username and password in the config.
1864 #<module name="m_vhost.so">
1866 #-#-#-#-#-#-#-#-#-#-#- VHOST CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#-#
1868 # user - Username for the vhost. #
1870 # pass - Password for the vhost. #
1872 # hash - The hash for the specific user (optional) #
1873 # m_password_hash.so and a hashing module must be loaded #
1874 # for this to work. #
1876 # host - Vhost to set. #
1878 #<vhost user="some_username" pass="some_password" host="some.host.test.cc">
1879 #<vhost user="foo" password="fcde2b2edba56bf408601fb721fe9b5c338d10ee429ea04fae5511b68fbf8fb9" hash="sha256" host="some.other.host.example.com">
1881 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1882 # Watch module: Adds the WATCH command, which is used by clients to
1883 # maintain notify lists.
1884 #<module name="m_watch.so">
1886 # Set the maximum number of entries on a user's watch list below.
1887 #<watch maxentries="32">
1889 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1890 # XLine database: Stores all *Lines (G/Z/K/R/any added by other modules)
1891 # in a file which is re-loaded on restart. This is useful
1892 # for two reasons: it keeps bans so users may not evade them, and on
1893 # bigger networks, server connections will take less time as there will
1894 # be a lot less bans to apply - as most of them will already be there.
1895 #<module name="m_xline_db.so">
1897 # Specify the filename for the xline database here.
1898 #<xlinedb filename="data/xline.db">
1900 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1901 # ____ _ _____ _ _ ____ _ _ _ #
1902 # | _ \ ___ __ _ __| | |_ _| |__ (_)___ | __ )(_) |_| | #
1903 # | |_) / _ \/ _` |/ _` | | | | '_ \| / __| | _ \| | __| | #
1904 # | _ < __/ (_| | (_| | | | | | | | \__ \ | |_) | | |_|_| #
1905 # |_| \_\___|\__,_|\__,_| |_| |_| |_|_|___/ |____/|_|\__(_) #
1907 # To link servers to InspIRCd, you MUST load the m_spanningtree #
1908 # module. If you don't do this, server links will NOT work at all. #
1909 # This is by design, to allow for the implementation of other linking #
1910 # protocols in modules in the future. #
1912 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1913 # Spanning tree module: Allows linking of servers using the spanning
1914 # tree protocol (see the READ THIS BIT section above).
1915 # You will almost always want to load this.
1917 #<module name="m_spanningtree.so">
projects / user / henk / code / inspircd.git / blob