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://docs.inspircd.org/2/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://docs.inspircd.org/2/modules/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://docs.inspircd.org/2/modules/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 docs page for m_dnsbl at #
749 # https://docs.inspircd.org/2/modules/dnsbl #
751 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
752 # Exempt channel operators module: Provides support for allowing #
753 # users of a specified channel status to be exempt from some channel #
754 # restriction modes. Supported restrictions are #
755 # blockcaps, blockcolor, censor, filter, flood, nickflood, noctcp, #
756 # nonick, nonotice, regmoderated, stripcolor, and topiclock. #
757 # See <options:exemptchanops> in inspircd.conf.example for a more #
758 # detailed list of the restriction modes that can be exempted. #
759 # These are settable using /mode #chan +X <restriction>:<status> #
760 #<module name="m_exemptchanops.so"> #
762 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
763 # Filter module: Provides message filtering, similar to SPAMFILTER. #
764 #<module name="m_filter.so">
766 # This module depends upon a regex provider such as m_regex_pcre or #
767 # m_regex_glob to function. You must specify which of these you want #
768 # m_filter to use via the tag below. #
770 # Valid engines are: #
772 # glob - Glob patterns, provided via m_regex_glob. #
773 # pcre - PCRE regexps, provided via m_regex_pcre, needs libpcre. #
774 # tre - TRE regexps, provided via m_regex_tre, requires libtre. #
775 # posix - POSIX regexps, provided via m_regex_posix, not available #
776 # on Windows, no dependencies on other operating systems. #
777 # stdlib - stdlib regexps, provided via m_regex_stdlib, see comment #
778 # at the <module> tag for info on availability. #
780 #<filteropts engine="glob"> #
782 # Your choice of regex engine must match on all servers network-wide.
784 # You may specify specific channels that are exempt from being filtered:
785 #<exemptfromfilter channel="#blah">
787 #-#-#-#-#-#-#-#-#-#-#- FILTER CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#
789 # Optional - If you specify to use the m_filter module, then #
790 # specify below the path to the filter.conf file, or define some #
793 #<include file="conf/examples/filter.conf.example">
795 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
796 # Gecos ban: Implements extended ban 'r', which stops anyone matching
797 # a mask like +b r:*realname?here* from joining a channel.
798 #<module name="m_gecosban.so">
800 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
801 # GeoIP module: Allows the server admin to match users by country code.
802 # This module is in extras. Re-run configure with:
803 # ./configure --enable-extras=m_geoip.cpp
804 # and run make install, then uncomment this module to enable it.
805 # This module requires GeoIP to be installed on your system,
806 # use your package manager to find the appropriate packages
807 # or check the InspIRCd docs page for this module.
808 #<module name="m_geoip.so">
810 # The actual allow/ban actions are done by connect classes, not by the
811 # GeoIP module. An example connect class to ban people from russia or
814 # <connect deny="*" geoip="TR,RU">
816 # The country code must be in capitals and should be an ISO country
817 # code such as TR, GB, or US. Unknown IPs (localhost, LAN IPs, etc)
818 # will be assigned the country code "UNK". Since connect classes are
819 # matched from top down, your deny classes must be above your allow
820 # classes for them to match.
822 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
823 # Globops module: Provides the /GLOBOPS command and snomask +g.
824 # This module is oper-only.
825 # To use, GLOBOPS must be in one of your oper class blocks.
826 #<module name="m_globops.so">
828 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
829 # Global load module: Allows loading and unloading of modules network-
830 # wide (USE WITH EXTREME CAUTION!)
831 # This module is oper-only and provides /GLOADMODULE, /GUNLOADMODULE
832 # and /GRELOADMODULE.
833 # To use, GLOADMODULE, GUNLOADMODULE and GRELOADMODULE
834 # must be in one of your oper class blocks.
835 #<module name="m_globalload.so">
837 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
838 # Halfop module: Provides the +h (halfops) channel status mode.
840 # IMPORTANT: This module has been removed in the next major version of
841 # InspIRCd. You should use m_customprefix instead.
842 #<module name="m_halfop.so">
844 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
845 # HELPOP module: Provides the /HELPOP command.
846 #<module name="m_helpop.so">
848 #-#-#-#-#-#-#-#-#-#-#-#- HELPOP CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
850 # If you specify to use the m_helpop.so module, then specify below #
851 # the path to the helpop.conf file. #
852 #<include file="conf/examples/helpop-full.conf.example">
854 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
855 # Hide chans module: Allows users to hide their channels list from non-
856 # opers by setting user mode +I on themselves.
857 #<module name="m_hidechans.so">
859 # This mode can optionally prevent opers from seeing channels on a +I
860 # user, for more privacy if set to true.
861 # This setting is not recommended for most mainstream networks.
862 #<hidechans affectsopers="false">
864 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
865 # Hide oper module: Allows opers to hide their oper status from non-
866 # opers by setting user mode +H on themselves.
867 # This module is oper-only.
868 #<module name="m_hideoper.so">
870 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
871 # Hostchange module: Allows a different style of cloaking.
872 #<module name="m_hostchange.so">
874 #-#-#-#-#-#-#-#-#-#-#- HOSTCHANGE CONFIGURATION -#-#-#-#-#-#-#-#-#-#
876 # See https://docs.inspircd.org/2/modules/hostchange for help. #
878 #<host suffix="invalid.org" separator="." prefix="">
879 #<hostchange mask="*@42.theanswer.example.org" action="addnick">
880 #<hostchange mask="*root@*" action="suffix">
881 #<hostchange mask="a@example.com" action="set" value="foo.bar.baz">
882 #<hostchange mask="localhost" ports="7000,7001,7005-7007" action="set" value="blahblah.foo">
884 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
885 # httpd module: Provides HTTP server support for InspIRCd.
886 #<module name="m_httpd.so">
888 #-#-#-#-#-#-#-#-#-#-#-#- HTTPD CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
890 # If you choose to use the m_httpd.so module, then you will need to add
891 # a <bind> tag with type "httpd", and load at least one of the other
892 # m_httpd_* modules to provide pages to display.
893 # <bind address="127.0.0.1" port="8067" type="httpd">
894 # <bind address="127.0.0.1" port="8097" type="httpd" ssl="gnutls">
896 # You can adjust the timeout for HTTP connections below. All HTTP
897 # connections will be closed after (roughly) this many seconds.
898 #<httpd timeout="20">
900 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
901 # HTTP ACL module: Provides access control lists for m_httpd dependent
902 # modules. Use this module to restrict pages by IP address and by
904 #<module name="m_httpd_acl.so">
906 #-#-#-#-#-#-#-#-#-#-#-#- HTTPD ACL CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
908 # Restrict access to the m_httpd_stats module to all but the local
909 # network and when the correct password is specified:
910 # <httpdacl path="/stats*" types="password,whitelist"
911 # username="secrets" password="mypasshere" whitelist="127.0.0.*,10.*">
913 # Deny all connections to all but the main index page:
914 # <httpdacl path="/*" types="blacklist" blacklist="*">
916 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
917 # HTTP config module: Allows the server configuration to be viewed over
918 # HTTP via the /config path. Requires m_httpd.so to be loaded for it to
921 # IMPORTANT: This module exposes extremely sensitive information about
922 # your server and users so you *MUST* protect it using a local-only
923 # <bind> tag and/or the m_httpd_acl.so module. See above for details.
924 #<module name="m_httpd_config.so">
926 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
927 # HTTP stats module: Provides server statistics over HTTP via the /stats
928 # path. Requires m_httpd.so to be loaded for it to function.
930 # IMPORTANT: This module exposes extremely sensitive information about
931 # your server and users so you *MUST* protect it using a local-only
932 # <bind> tag and/or the m_httpd_acl.so module. See above for details.
933 #<module name="m_httpd_stats.so">
935 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
936 # Ident: Provides RFC 1413 ident lookup support.
937 # When this module is loaded <connect:allow> tags may have an optional
938 # useident="yes|no" boolean value, determining whether or not to lookup
939 # ident on users matching that connect tag.
940 #<module name="m_ident.so">
942 #-#-#-#-#-#-#-#-#-#-#-#- IDENT CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
944 # Optional - If you are using the m_ident.so module, then you can #
945 # specify the timeout for ident lookups here. If not defined, it will #
946 # default to 5 seconds. This is a non-blocking timeout which holds #
947 # the user in a 'connecting' state until the lookup is complete. #
948 # The bind value indicates which IP to bind outbound requests to. #
952 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
953 # Invite exception module: Adds support for channel invite exceptions
955 #<module name="m_inviteexception.so">
956 # bypasskey: If this is enabled, exceptions will bypass +k as well as +i
957 #<inviteexception bypasskey="yes">
959 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
960 # IRCv3 module: Provides the following IRCv3 extensions:
961 # extended-join, away-notify and account-notify. These are optional
962 # enhancements to the client-to-server protocol. An extension is only
963 # active for a client when the client specifically requests it, so this
964 # module needs m_cap to work.
966 # Further information on these extensions can be found at the IRCv3
967 # working group website:
968 # http://ircv3.net/irc/
970 #<module name="m_ircv3.so">
971 # The following block can be used to control which extensions are
972 # enabled. Note that extended-join can be incompatible with m_delayjoin
974 #<ircv3 accountnotify="on" awaynotify="on" extendedjoin="on">
976 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
977 # Join flood module: Adds support for join flood protection +j X:Y.
978 # Closes the channel for 60 seconds if X users join in Y seconds.
979 #<module name="m_joinflood.so">
981 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
982 # Jump server module: Adds support for the RPL_REDIR numeric.
983 # This module is oper-only.
984 # To use, JUMPSERVER must be in one of your oper class blocks.
985 # If your server is redirecting new clients and you get disconnected,
986 # do a REHASH from shell to open up again.
987 #<module name="m_jumpserver.so">
989 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
990 # Anti auto rejoin: Adds support for prevention of auto-rejoin (+J).
991 #<module name="m_kicknorejoin.so">
992 # Set the maximum time that is accepted as a parameter for +J here.
993 #<kicknorejoin maxtime="1m">
995 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
996 # Knock module: Adds the /KNOCK command and channel mode +K.
997 #<module name="m_knock.so">
999 # This setting specifies what to do when someone successfully /KNOCKs.
1000 # If set to "notice", then a NOTICE will be sent to the channel.
1001 # This is the default and the compatible setting, as it requires no
1002 # special support from the clients.
1003 # If set to "numeric" then a 710 numeric will be sent to the channel.
1004 # This allows easier scripting but not all clients support it.
1005 # If set to "both" then (surprise!) both will be sent.
1006 #<knock notify="notice">
1008 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1009 # LDAP authentication module: Adds the ability to authenticate users #
1010 # via LDAP. This is an extra module which must be enabled explicitly #
1011 # by symlinking it from modules/extra, and requires the OpenLDAP libs #
1012 # This module is in extras. To enable it, Re-run configure with: #
1013 # ./configure --enable-extras=m_ldapauth.cpp #
1014 # and run make install, then uncomment this module. #
1015 #<module name="m_ldapauth.so">
1019 # <ldapauth baserdn="ou=People,dc=brainbox,dc=cc" #
1021 # server="ldap://brainwave.brainbox.cc" #
1022 # allowpattern="Guest*" #
1023 # killreason="Access denied" #
1024 # searchscope="subtree" #
1025 # binddn="cn=Manager,dc=brainbox,dc=cc" #
1026 # bindauth="mysecretpass" #
1028 # host="$uid.$ou.inspircd.org" #
1029 # useusername="no"> #
1031 # <ldapwhitelist cidr="10.42.0.0/16"> #
1033 # <ldaprequire attribute="attr" value="val"> #
1035 # The baserdn indicates the base DN to search in for users. Usually #
1036 # this is 'ou=People,dc=yourdomain,dc=yourtld'. #
1038 # The attribute value indicates the attribute which is used to locate #
1039 # a user account by name. On POSIX systems this is usually 'uid'. #
1041 # The useusername setting chooses whether the user's username or #
1042 # nickname is used when locating a user account, if a username isn't #
1043 # provided in PASS. #
1045 # The server parameter indicates the LDAP server to connect to. The #
1046 # ldap:// style scheme before the hostname proper is MANDATORY. #
1048 # The allowpattern value allows you to specify a wildcard mask which #
1049 # will always be allowed to connect regardless of if they have an #
1050 # account, for example guest users. #
1052 # Killreason indicates the QUIT reason to give to users if they fail #
1053 # to authenticate. #
1055 # The searchscope value indicates the subtree to search under. On our #
1056 # test system this is 'subtree'. Your mileage may vary. #
1058 # Setting the verbose value causes an oper notice to be sent out for #
1059 # every failed authentication to the server, with an error string. #
1061 # The binddn and bindauth indicate the DN to bind to for searching, #
1062 # and the password for the distinguished name. Some LDAP servers will #
1063 # allow anonymous searching in which case these two values do not #
1064 # need defining, otherwise they should be set similar to the examples #
1067 # ldapwhitelist indicates that clients connecting from an IP in the #
1068 # provided CIDR do not need to authenticate against LDAP. It can be #
1069 # repeated to whitelist multiple CIDRs. #
1071 # ldaprequire allows further filtering on the LDAP user, by requiring #
1072 # certain LDAP attibutes to have a given value. It can be repeated, #
1073 # in which case the list will act as an OR list, that is, the #
1074 # authentication will succeed if any of the requirements in the list #
1077 # host allows you to change the displayed host of users connecting #
1078 # from ldap. The string supplied takes formatters which are replaced #
1079 # from the DN. For instance, if your DN looks like: #
1080 # uid=w00t,ou=people,dc=inspircd,dc=org, then the formatters uid, ou #
1081 # and dc will be available to you. If a key is given multiple times #
1082 # in the DN, the last appearance will take precedence. #
1084 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1085 # LDAP oper configuration module: Adds the ability to authenticate #
1086 # opers via LDAP. This is an extra module which must be enabled #
1087 # explicitly by symlinking it from modules/extra, and requires the #
1088 # OpenLDAP libs. Re-run configure with: #
1089 # ./configure --enable-extras=m_ldapoper.cpp
1090 # and run make install, then uncomment this module to enable it. #
1091 #<module name="m_ldapoper.so">
1095 # <ldapoper baserdn="ou=People,dc=brainbox,dc=cc"
1096 # server="ldap://brainwave.brainbox.cc"
1097 # searchscope="subtree"
1098 # binddn="cn=Manager,dc=brainbox,dc=cc"
1099 # bindauth="mysecretpass"
1102 # Available configuration items are identical to the same items in #
1103 # m_ldapauth above (except for the verbose setting, that is only #
1104 # supported in m_ldapauth). #
1105 # Please always specify a password in your <oper> tags even if the #
1106 # opers are to be authenticated via LDAP, so in case this module is #
1107 # not loaded the oper accounts are still protected by a password. #
1109 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1110 # Lock server module: Adds /LOCKSERV and /UNLOCKSERV commands that #
1111 # are used to temporarily close/open the server for new connections. #
1112 # These commands require that the /LOCKSERV and /UNLOCKSERV commands #
1113 # are specified in a <class> tag that the oper is part of. This is so #
1114 # you can control who has access to this possible dangerous command. #
1115 # If your server is locked and you get disconnected, do a REHASH from #
1116 # shell to open up again. #
1117 # This module is oper-only.
1118 #<module name="m_lockserv.so">
1120 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1121 # Map hiding module: replaces /MAP and /LINKS output to users with a #
1122 # message to see a website, set by maphide="http://test.org/map" in #
1123 # the <security> tag, instead. #
1124 #<module name="m_maphide.so">
1126 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1127 # Message flood module: Adds message/notice flood protection via
1129 #<module name="m_messageflood.so">
1131 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1132 # MLOCK module: Adds support for server-side enforcement of services
1133 # side MLOCKs. Basically, this module suppresses any mode change that
1134 # would likely be immediately bounced by services.
1135 #<module name="m_mlock.so">
1137 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1138 # MsSQL module: Allows other SQL modules to access MS SQL Server
1139 # through a unified API.
1140 # This module is in extras. Re-run configure with:
1141 # ./configure --enable-extras=m_mssql.cpp
1142 # and run make install, then uncomment this module to enable it.
1143 #<module name="m_mssql.so">
1145 #-#-#-#-#-#-#-#-#-#-#-#- SQL CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#-#
1147 # m_mssql.so is more complex than described here, see docs for more #
1148 # info https://docs.inspircd.org/2/modules/mssql #
1150 #<database module="mssql" name="db" user="user" pass="pass" host="localhost" id="db1">
1152 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1153 # MySQL module: Allows other SQL modules to access MySQL databases
1154 # through a unified API.
1155 # This module is in extras. Re-run configure with:
1156 # ./configure --enable-extras=m_mysql.cpp
1157 # and run make install, then uncomment this module to enable it.
1158 #<module name="m_mysql.so">
1160 #-#-#-#-#-#-#-#-#-#-#-#- SQL CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#-#
1162 # m_mysql.so is more complex than described here, see the docs for #
1163 # more: https://docs.inspircd.org/2/modules/mysql #
1165 #<database module="mysql" name="mydb" user="myuser" pass="mypass" host="localhost" id="my_database2">
1167 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1168 # Named modes module: Allows for the display and set/unset of channel
1169 # modes via long-form mode names via +Z and the /PROP command.
1170 # For example, to set a ban, do /mode #channel +Z ban=foo!bar@baz or
1171 # /PROP #channel ban=foo!bar@baz
1172 #<module name="m_namedmodes.so">
1174 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1175 # NAMESX module: Provides support for the NAMESX extension which allows
1176 # clients to see all the prefixes set on a user without getting confused.
1177 # This is supported by mIRC, x-chat, klient, and maybe more.
1178 #<module name="m_namesx.so">
1180 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1181 # National characters module:
1182 # 1) Allows using national characters in nicknames.
1183 # 2) Allows using custom (national) casemapping over the network.
1184 #<module name="m_nationalchars.so">
1186 # file - Location of the file which contains casemapping rules. If this
1187 # is a relative path then it is relative to "<PWD>/../locales"
1188 # on UNIX and "<PWD>/locales" on Windows.
1189 # casemapping - The name of the casemapping sent to clients in the 005
1190 # numeric. If this is not set then it defaults to the name
1191 # of the casemapping file unless the file name contains a
1192 # space in which case you will have to specify it manually.
1193 #<nationalchars file="bynets/russian-w1251-charlink" casemapping="ru_RU.cp1251-charlink">
1195 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1196 # Nickchange flood protection module: Provides channel mode +F X:Y
1197 # which allows up to X nick changes in Y seconds.
1198 #<module name="m_nickflood.so">
1200 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1201 # Nicklock module: Let opers change a user's nick and then stop that
1202 # user from changing their nick again until unlocked.
1203 # This module is oper-only.
1204 # To use, NICKLOCK and NICKUNLOCK must be in one of your oper class blocks.
1205 #<module name="m_nicklock.so">
1207 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1208 # No CTCP module: Adds the channel mode +C to block CTCPs and extban
1209 # 'C' to block CTCPs sent by specific users.
1210 #<module name="m_noctcp.so">
1212 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1213 # No kicks module: Adds the +Q channel mode and the Q: extban to deny
1214 # certain users from kicking.
1215 #<module name="m_nokicks.so">
1217 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1218 # No nicks module: Adds the +N channel mode, as well as the 'N' extban.
1219 # +N stops all users from changing their nick, the N extban stops
1220 # anyone from matching a +b N:nick!user@host mask from changing their
1222 #<module name="m_nonicks.so">
1224 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1225 # No part message module: Adds extban 'p' to block part messages from #
1227 #<module name="m_nopartmsg.so">
1229 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1230 # No notice module: Adds the channel mode +T and the extban 'T' to
1231 # block specific users from noticing the channel.
1232 #<module name="m_nonotice.so">
1234 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1235 # Network business join module:
1236 # Allows an oper to join a channel using /OJOIN, giving them +Y on the
1237 # channel which makes them immune to kick/deop/etc.
1238 #<module name="m_ojoin.so">
1240 # Specify the prefix that +Y will grant here.
1241 # Leave 'prefix' empty if you do not wish +Y to grant a prefix.
1242 # If 'notice' is set to on, upon /OJOIN, the server will notice the
1243 # channel saying that the oper is joining on network business.
1244 # If 'op' is set to on, it will give them +o along with +Y.
1245 #<ojoin prefix="!" notice="yes" op="yes">
1247 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1248 # Oper channels mode: Adds the +O channel mode and extban O:<mask>
1249 # to ban, except, etc. specific oper types. For example
1250 # /mode #channel +iI O:* is equivalent to channel mode +O, but you
1251 # may also set +iI O:AdminTypeOnly to only allow admins.
1252 # Modes +I and +e work in a similar fashion.
1253 #<module name="m_operchans.so">
1255 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1256 # Oper join module: Auto-joins opers to a channel upon oper-up.
1257 # This module is oper-only. For the user equivalent, see m_conn_join.
1258 #<module name="m_operjoin.so">
1260 #-#-#-#-#-#-#-#-#-#-# OPERJOIN CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
1262 # If you are using the m_operjoin.so module, specify options here: #
1264 # channel - The channel name to join, can also be a comma #
1265 # separated list e.g. "#channel1,#channel2". #
1267 # override - If on, lets the oper join walking thru any modes #
1268 # that might be set, even bans. #
1270 #<operjoin channel="#channel" override="no">
1272 # Alternatively you can use the autojoin="channellist" in a <type> #
1273 # tag to set specific autojoins for a type of oper, for example: #
1275 #<type name="Helper" autojoin="#help" classes="...">
1277 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1278 # Oper log module: Logs all oper commands to the server log (with log
1279 # type "m_operlog" at default loglevel), and optionally to the 'r'
1281 # This module is oper-only.
1282 #<module name="m_operlog.so">
1284 # If the following option is on then all oper commands will be sent to
1285 # the snomask 'r'. The default is off.
1286 #<operlog tosnomask="off">
1288 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1289 # Oper prefixing module: Adds a channel prefix mode +y which is given
1290 # to all IRC operators automatically on all channels they are in.
1291 # This prefix mode is more powerful than channel op and other regular
1294 # Load this module if you want all your IRC operators to have channel
1296 #<module name="m_operprefix.so">
1298 # You may additionally customise the prefix character.
1299 #<operprefix prefix="!">
1301 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1302 # Oper MOTD module: Provides support for separate message of the day
1304 # This module is oper-only.
1305 #<module name="m_opermotd.so">
1307 #-#-#-#-#-#-#-#-#-#-# OPERMOTD CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
1309 # If you are using the m_opermotd.so module, specify the motd here. #
1311 # onoper - If on, the message is sent on /OPER, otherwise it's #
1312 # only sent when /OPERMOTD is used. #
1314 # processcolors - Allow color codes to be processed in the opermotd. #
1315 # Read the comment above <connect:allowmotdcolors> in #
1316 # inspircd.conf.example for details. #
1318 #<opermotd file="conf/examples/opermotd.txt.example" onoper="yes" processcolors="false">
1320 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1321 # Override module: Adds support for oper override.
1322 # This module is oper-only.
1323 #<module name="m_override.so">
1325 #-#-#-#-#-#-#-#-#-#-# OVERRIDE CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
1327 # m_override.so is too complex it describe here, see the docs: #
1328 # https://docs.inspircd.org/2/modules/override #
1330 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1331 # Oper levels module: Gives each oper a level and prevents actions
1332 # being taken by lower level opers against higher level opers.
1333 # Specify the level as the 'level' parameter of the <type> tag.
1334 # This module is oper-only.
1335 #<module name="m_operlevels.so">
1337 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1338 # Oper modes module: Allows you to specify modes to add/remove on oper.
1339 # Specify the modes as the 'modes' parameter of the <type> tag
1340 # and/or as the 'modes' parameter of the <oper> tag.
1341 # This module is oper-only. For the user equivalent, see m_conn_umodes.
1342 #<module name="m_opermodes.so">
1344 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1345 # Password forwarding module: Forwards a password users can send on
1346 # connect to the specified client below. The client is usually NickServ
1347 # and this module is usually used to authenticate users with NickServ
1348 # using their connect password.
1349 #<module name="m_passforward.so">
1352 # nick: nick to forward connect passwords to.
1355 # forwardmsg: Message to send to users using a connect password.
1356 # $nick will be the users' nick, $nickrequired will be the nick
1357 # of where the password is going (the nick above).
1358 # You can also use $user for the user ident string.
1359 forwardmsg="NOTICE $nick :*** Forwarding PASS to $nickrequired"
1361 # cmd: Command for the user to run when it receives a connect
1363 cmd="PRIVMSG $nickrequired :IDENTIFY $pass">
1365 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1366 # Password hash module: Allows hashed passwords to be used.
1367 # To be useful, a hashing module like m_sha256.so also needs to be loaded.
1368 #<module name="m_password_hash.so">
1370 #-#-#-#-#-#-#-#-#-# PASSWORD HASH CONFIGURATION #-#-#-#-#-#-#-#-#-#-#-#
1372 # To use this module, you must define a hash type for each oper's
1373 # password you want to hash. For example:
1375 # <oper name="Brain"
1376 # host="ident@dialup15.isp.test.com"
1378 # password="01ba4719c80b6fe911b091a7c05124b64eeece964e09c058ef8f9805daca546b"
1381 # Starting from 2.0, you can use a more secure salted hash that prevents simply
1382 # looking up the hash's value in a rainbow table built for the hash.
1383 # hash="hmac-sha256" password="lkS1Nbtp$CyLd/WPQXizsbxFUTqFRoMvaC+zhOULEeZaQkUJj+Gg"
1385 # Generate hashes using the /MKPASSWD command on the server.
1386 # Don't run it on a server you don't trust with your password.
1388 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1389 # Permanent channels module: Channels with the permanent channel mode
1390 # will remain open even after everyone else has left the channel, and
1391 # therefore keep things like modes, ban lists and topic. Permanent
1392 # channels -may- need support from your Services package to function
1393 # properly with them. This adds channel mode +P.
1394 # This module is oper-only.
1395 #<module name="m_permchannels.so">
1397 # If you like, m_permchannels can write a config file of permanent channels
1398 # whenever +P is set, unset, or the topic/modes on a +P channel is changed.
1399 # If you want to do this, set the filename below, and uncomment the include.
1401 # If 'listmodes' is true then all list modes (+b, +I, +e, +g...) will be
1402 # saved. Defaults to false.
1403 #<permchanneldb filename="data/permchannels.conf" listmodes="true">
1404 #<include file="data/permchannels.conf">
1406 # You may also create channels on startup by using the <permchannels> block.
1407 # Don't forget to set them +P in the modes, or they won't stay permanent.
1408 #<permchannels channel="#opers" modes="isP" topic="Opers only.">
1410 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1411 # PostgreSQL module: Allows other SQL modules to access PgSQL databases
1412 # through a unified API.
1413 # This module is in extras. Re-run configure with:
1414 # ./configure --enable-extras=m_pgsql.cpp
1415 # and run make install, then uncomment this module to enable it.
1416 #<module name="m_pgsql.so">
1418 #-#-#-#-#-#-#-#-#-#-#-#- SQL CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#-#
1420 # m_pgsql.so is more complex than described here, see the docs for #
1421 # more: https://docs.inspircd.org/2/modules/pgsql #
1423 #<database module="pgsql" name="mydb" user="myuser" pass="mypass" host="localhost" id="my_database" ssl="no">
1425 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1426 # Muteban: Implements extended ban 'm', which stops anyone matching
1427 # a mask like +b m:nick!user@host from speaking on channel.
1428 #<module name="m_muteban.so">
1430 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1431 # Random quote module: Provides a random quote on connect.
1432 # NOTE: Some of these may mimic fatal errors and confuse users and
1433 # opers alike - BEWARE!
1434 #<module name="m_randquote.so">
1436 #-#-#-#-#-#-#-#-#-#- RANDOMQUOTES CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
1438 # Optional - If you specify to use the m_randquote.so module, then #
1439 # specify below the path to the quotes file. #
1441 #<randquote file="quotes.txt">
1443 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1444 # Redirect module: Adds channel redirection mode +L. #
1445 # Optional: <redirect:antiredirect> to add usermode +L to stop forced #
1446 # redirection and instead print an error. #
1448 # Note: You can not update this with a simple rehash, it requires #
1449 # reloading the module for it to take effect. #
1450 # This also breaks linking to servers that do not have the option. #
1451 # This defaults to false for the 2.0 version, it will be enabled in #
1452 # all the future versions. #
1453 #<module name="m_redirect.so">
1454 #<redirect antiredirect="true">
1456 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1457 # Regular expression provider for glob or wildcard (?/*) matching.
1458 # You must have at least 1 provider loaded to use m_filter or m_rline
1459 # modules. This module has no additional requirements, as it uses the
1460 # matching already present in InspIRCd core.
1461 #<module name="m_regex_glob.so">
1463 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1464 # Regular expression provider for PCRE (Perl-Compatible Regular
1465 # Expressions). You need libpcre installed to compile and load this
1466 # module. You must have at least 1 provider loaded to use m_filter or
1468 #<module name="m_regex_pcre.so">
1470 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1471 # Regular expression provider for POSIX regular expressions.
1472 # You shouldn't need any additional libraries on a POSIX-compatible
1473 # system (i.e.: any Linux, BSD, but not Windows). You must have at
1474 # least 1 provider loaded to use m_filter or m_rline.
1475 # On POSIX-compliant systems, regex syntax can be found by using the
1476 # command: 'man 7 regex'.
1477 #<module name="m_regex_posix.so">
1479 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1480 # Regular expression provider for C++11 std::regex regular expressions.
1481 # This module works on any fully compliant implementation of the C++11
1482 # std::regex container. Examples for such are Visual C++ 2010 and newer
1483 # but not libstdc++ (which GCC uses).
1484 # You should verify that std::regex is supported by your setup before
1485 # using this module, as it may compile normally but won't do anything
1486 # on some implementations.
1487 #<module name="m_regex_stdlib.so">
1489 # Specify the regular expression engine to use here. Valid settings are
1490 # bre, ere, awk, grep, egrep, ecmascript (default if not specified).
1491 #<stdregex type="ecmascript">
1493 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1494 # Regular expression provider for TRE regular expressions.
1495 # This is the same regular expression engine used by UnrealIRCd, so
1496 # if you are most familiar with the syntax of /SPAMFILTER from there,
1497 # this is the provider you want. You need libtre installed in order
1498 # to compile and load this module.
1499 #<module name="m_regex_tre.so">
1501 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1502 # Registered users only channel creation module. If enabled, only
1503 # registered users and opers can create new channels.
1505 # You probably *DO NOT* want to load this module on a public network.
1507 #<module name="m_regonlycreate.so">
1509 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1510 # Remove module: Adds the /REMOVE command which is a peaceful
1511 # alternative to /KICK.
1512 #<module name="m_remove.so">
1514 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1515 # Restricted channels module: Allows only opers to create channels.
1517 # You probably *DO NOT* want to load this module on a public network.
1519 #<module name="m_restrictchans.so">
1521 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1522 # Restrict message module: Allows users to only message opers.
1524 # You probably *DO NOT* want to load this module on a public network.
1526 #<module name="m_restrictmsg.so">
1528 # Uncomment this to allow users to message ulines (e.g. services):
1529 #<restrictmsg uline="yes">
1531 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1532 # R-Line module: Ban users through regular expression patterns.
1533 #<module name="m_rline.so">
1535 #-#-#-#-#-#-#-#-#-#-#-#- RLINE CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#-#
1537 # If you wish to re-check a user when they change nickname (can be
1538 # useful under some situations, but *can* also use CPU with more users
1539 # on a server) then set 'matchonnickchange' to yes.
1540 # Also, this is where you set what Regular Expression engine is to be
1541 # used. If you ever change it while running, all of your R-Lines will
1542 # be wiped. This is the regex engine used by all R-Lines set, and
1543 # m_regex_<engine>.so must be loaded, or rline will be non-functional
1544 # until you load it or change the engine to one that is loaded.
1546 #<rline matchonnickchange="yes" engine="pcre">
1548 # Generally, you will NOT want to use 'glob' here, as this turns
1549 # rline into just another gline. The exceptions are that rline will
1550 # always use the full "nick!user@host realname" string, rather than only
1551 # user@host, but beware that only the ? and * wildcards are available,
1552 # and are the only way to specify where the space can occur if you do
1553 # use glob. For this reason, is recommended to use a real regex engine
1554 # so that at least \s or [[:space:]] is available.
1556 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1557 # SAJOIN module: Adds the /SAJOIN command which forcibly joins a user
1558 # to the given channel.
1559 # This module is oper-only.
1560 # To use, SAJOIN must be in one of your oper class blocks.
1561 #<module name="m_sajoin.so">
1563 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1564 # SAKICK module: Adds the /SAKICK command which kicks a user from the
1566 # This module is oper-only.
1567 # To use, SAKICK must be in one of your oper class blocks.
1568 #<module name="m_sakick.so">
1570 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1571 # SAMODE module: Adds the /SAMODE command which allows server operators
1572 # to change modes on a channel without requiring them to have any
1573 # channel priviliges. Also allows changing user modes for any user.
1574 # This module is oper-only.
1575 # To use, SAMODE must be in one of your oper class blocks.
1576 #<module name="m_samode.so">
1578 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1579 # SANICK module: Adds the /SANICK command which allows opers to change
1581 # This module is oper-only.
1582 # To use, SANICK must be in one of your oper class blocks.
1583 #<module name="m_sanick.so">
1585 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1586 # SAPART module: Adds the /SAPART command which forcibly parts a user
1588 # This module is oper-only.
1589 # To use, SAPART must be in one of your oper class blocks.
1590 #<module name="m_sapart.so">
1592 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1593 # SAQUIT module: Adds the /SAQUIT command which forcibly quits a user.
1594 # This module is oper-only.
1595 # To use, SAQUIT must be in one of your oper class blocks.
1596 #<module name="m_saquit.so">
1598 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1599 # SATOPIC module: Adds the /SATOPIC command which allows changing the
1600 # topic on a channel without requiring any channel priviliges.
1601 # This module is oper-only.
1602 # To use, SATOPIC must be in one of your oper class blocks.
1603 #<module name="m_satopic.so">
1605 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1606 # SASL authentication module: Provides support for IRC Authentication
1607 # Layer via AUTHENTICATE. Note: You also need to have m_cap.so loaded
1609 #<module name="m_sasl.so">
1610 # Define the following to your services server name to improve security
1611 # by ensuring the SASL messages are only sent to the services server
1612 # and not to all connected servers. This prevents a rogue server from
1613 # capturing SASL messages.
1614 #<sasl target="services.mynetwork.com">
1616 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1617 # Secure list module: Prevent /LIST in the first minute of connection,
1618 # crippling most spambots and trojan spreader bots.
1619 #<module name="m_securelist.so">
1621 #-#-#-#-#-#-#-#-#-# SECURELIST CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#-#
1623 # Securelist can be harmful to some IRC search engines. To prevent #
1624 # securelist blocking these sites from listing, define exception tags #
1626 #<securehost exception="*@*.netsplit.de">
1627 #<securehost exception="*@*.ircdriven.com">
1628 #<securehost exception="*@*.ircs.me">
1630 # Define the following variable to change how long a user must wait #
1631 # before issuing a LIST. If not defined, defaults to 60 seconds. #
1633 #<securelist waittime="60"> #
1635 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1636 # Servprotect module: Provides support for Austhex style +k /
1637 # UnrealIRCD +S services mode.
1638 #<module name="m_servprotect.so">
1640 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1641 # See nicks module: Adds snomask +n and +N which show local and remote
1643 # This module is oper-only.
1644 #<module name="m_seenicks.so">
1646 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1647 # Set idle module: Adds a command for opers to change their idle time.
1648 # This module is oper-only.
1649 # To use, SETIDLE must be in one of your oper class blocks.
1650 #<module name="m_setidle.so">
1652 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1653 # Services support module: Adds several usermodes such as +R and +M.
1654 # This module implements the 'identified' state via account names,
1655 # and is similar in operation to the way asuka and ircu handle services.
1657 # At the same time, this offers +r for users and channels to mark them
1658 # as identified separately from the idea of a master account, which
1659 # can be useful for services which are heavily nick-as-account centric.
1661 # Also of note is that this module implements two extbans:
1662 # +b R: (stop matching account names from joining)
1663 # +b U:n!u@h (blocks matching unregistered users)
1665 #<module name="m_services_account.so">
1667 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1668 # Sethost module: Adds the /SETHOST command.
1669 # This module is oper-only.
1670 # To use, SETHOST must be in one of your oper class blocks.
1671 # See m_chghost for how to customise valid chars for hostnames.
1672 #<module name="m_sethost.so">
1674 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1675 # Setident module: Adds the /SETIDENT command.
1676 # This module is oper-only.
1677 # To use, SETIDENT must be in one of your oper class blocks.
1678 #<module name="m_setident.so">
1680 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1681 # SETNAME module: Adds the /SETNAME command.
1682 #<module name="m_setname.so">
1684 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1685 # Serverban: Implements extended ban 's', which stops anyone connected
1686 # to a server matching a mask like +b s:server.mask.here from joining.
1687 #<module name="m_serverban.so">
1689 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1690 # Show whois module: Adds the +W usermode which allows opers to see
1691 # when they are /WHOIS'd.
1692 # This module is oper-only by default.
1693 #<module name="m_showwhois.so">
1695 # If you wish, you may also let users set this mode. Only opers with the
1696 # users/auspex priv will see real hosts of people, though. This setting
1697 # is not reloadable via /REHASH, changing it requires /RELOADMODULE.
1698 #<showwhois opersonly="yes"
1700 # You may also set whether or not users should receive whois notices,
1701 # should they be /WHOIS'd by an oper.
1702 #showfromopers="yes">
1704 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1705 # Shun module: Provides the /SHUN command, which stops a user from
1706 # executing all except configured commands.
1707 # This module is oper-only.
1708 # To use, SHUN must be in one of your oper class blocks.
1709 #<module name="m_shun.so">
1711 # You may also configure which commands you wish a user to be able to
1712 # perform when shunned. It should be noted that if a shunned user
1713 # issues QUIT or PART then their message will be removed, as if they
1714 # did not issue one.
1716 # You can optionally let the user know that their command was blocked.
1718 # You may also let SHUN affect opers (defaults to no).
1719 #<shun enabledcommands="ADMIN PING PONG QUIT PART JOIN" notifyuser="yes" affectopers="no">
1721 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1722 # SSL channel mode module: Adds support for SSL-only channels via
1723 # channel mode +z and the 'z' extban which matches SSL client
1724 # certificate fingerprints.
1725 # Does not do anything useful without a working SSL module and the
1726 # m_sslinfo module (see below).
1727 #<module name="m_sslmodes.so">
1729 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1730 # GnuTLS SSL module: Adds support for SSL connections using GnuTLS,
1731 # if enabled. You must answer 'yes' in ./configure when asked or
1732 # manually symlink the source for this module from the directory
1733 # src/modules/extra, if you want to enable this, or it will not load.
1734 #<module name="m_ssl_gnutls.so">
1736 #-#-#-#-#-#-#-#-#-#-#- GNUTLS CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#
1738 # m_ssl_gnutls.so is too complex to describe here, see the docs: #
1739 # https://docs.inspircd.org/2/modules/ssl_gnutls #
1741 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1742 # SSL info module: Allows users to retrieve information about other
1743 # users' peer SSL certificates and keys. This can be used by client
1744 # scripts to validate users. For this to work, one of m_ssl_gnutls.so
1745 # or m_ssl_openssl.so must be loaded. This module also adds the
1746 # "* <user> is using a secure connection" whois line, the ability for
1747 # opers to use SSL fingerprints to verify their identity and the
1748 # ability to force opers to use SSL connections in order to oper up.
1749 # It is highly recommended to load this module if you use SSL on your
1751 # For how to use the oper features, please see the first example <oper> tag
1752 # in opers.conf.example.
1754 #<module name="m_sslinfo.so">
1756 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1757 # OpenSSL SSL module: Adds support for SSL connections using OpenSSL,
1758 # if enabled. You must answer 'yes' in ./configure when asked or symlink
1759 # the source for this module from the directory src/modules/extra, if
1760 # you want to enable this, or it will not load.
1761 #<module name="m_ssl_openssl.so">
1763 #-#-#-#-#-#-#-#-#-#-#- OPENSSL CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#
1765 # m_ssl_openssl.so is too complex to describe here, see the docs: #
1766 # https://docs.inspircd.org/2/modules/ssl_openssl #
1768 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1769 # Strip color module: Adds channel mode +S that strips mIRC color
1770 # codes from all messages sent to the channel.
1771 #<module name="m_stripcolor.so">
1773 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1774 # Silence module: Adds support for the /SILENCE command, which allows
1775 # users to have a server-side ignore list for their client.
1776 #<module name="m_silence.so">
1778 # Set the maximum number of entries allowed on a user's silence list.
1779 #<silence maxentries="32">
1781 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1782 # SQLite3 module: Allows other SQL modules to access SQLite3 #
1783 # databases through a unified API. #
1784 # This module is in extras. Re-run configure with: #
1785 # ./configure --enable-extras=m_sqlite3.cpp
1786 # and run make install, then uncomment this module to enable it. #
1788 #<module name="m_sqlite3.so">
1790 #-#-#-#-#-#-#-#-#-#-#-#- SQL CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#-#
1792 # m_sqlite.so is more complex than described here, see the docs for #
1793 # more: https://docs.inspircd.org/2/modules/sqlite3 #
1795 #<database module="sqlite" hostname="/full/path/to/database.db" id="anytext">
1797 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1798 # SQL authentication module: Allows IRCd connections to be tied into
1799 # a database table (for example a forum).
1801 #<module name="m_sqlauth.so">
1803 #-#-#-#-#-#-#-#-#-#-#- SQLAUTH CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#
1805 # m_sqlauth.so is too complex to describe here, see the docs: #
1806 # https://docs.inspircd.org/2/modules/sqlauth #
1808 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1809 # SQL oper module: Allows you to store oper credentials in an SQL table
1811 #<module name="m_sqloper.so">
1813 #-#-#-#-#-#-#-#-#-#-#- SQLOPER CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#
1815 # dbid - Database ID to use (see SQL modules). #
1816 # hash - Hashing provider to use for password hashing. #
1818 # See also: https://docs.inspircd.org/2/modules/sqloper #
1820 #<sqloper dbid="1" hash="md5">
1822 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1823 # SVSHold module: Implements SVSHOLD. Like Q:Lines, but can only be #
1824 # added/removed by Services. #
1825 #<module name="m_svshold.so">
1826 # If silent is true no snotices will be generated by SVSHOLD.
1827 #<svshold silent="false">
1829 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1830 # SWHOIS module: Allows you to add arbitrary lines to user WHOIS.
1831 # This module is oper-only.
1832 # To use, SWHOIS must be in one of your oper class blocks.
1833 #<module name="m_swhois.so">
1835 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1836 # Test module: Enable this to create a command useful in testing
1837 # flood control. To avoid accidental use on live networks, the server
1838 # name must contain ".test" to load the module
1839 #<module name="m_testnet.so">
1841 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1842 # Timed bans module: Adds timed channel bans with the /TBAN command.
1843 #<module name="m_timedbans.so">
1845 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1846 # Test line module: Adds the /TLINE command, used to test how many
1847 # users a /GLINE or /ZLINE etc. would match.
1848 # This module is oper-only.
1849 # To use, TLINE must be in one of your oper class blocks.
1850 #<module name="m_tline.so">
1852 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1853 # Topiclock module: implements server-side topic locking to achieve deeper
1854 # integration with services packages.
1855 #<module name="m_topiclock.so">
1857 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1858 # UHNAMES support module: Adds support for the IRCX style UHNAMES
1859 # extension, which displays ident and hostname in the names list for
1860 # each user, saving clients from doing a WHO on the channel.
1861 # If a client does not support UHNAMES it will not enable it, this will
1862 # not break incompatible clients.
1863 #<module name="m_uhnames.so">
1865 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1866 # Uninvite module: Adds the /UNINVITE command which lets users remove
1867 # pending invites from channels without waiting for the user to join.
1868 #<module name="m_uninvite.so">
1870 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1871 # Userip module: Adds the /USERIP command.
1872 # Allows users to query their own IP, also allows opers to query the IP
1874 #<module name="m_userip.so">
1876 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1877 # Vhost module: Adds the VHOST command which allows for adding virtual
1878 # hosts which are accessible using a username and password in the config.
1879 #<module name="m_vhost.so">
1881 #-#-#-#-#-#-#-#-#-#-#- VHOST CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#-#
1883 # user - Username for the vhost. #
1885 # pass - Password for the vhost. #
1887 # hash - The hash for the specific user (optional) #
1888 # m_password_hash.so and a hashing module must be loaded #
1889 # for this to work. #
1891 # host - Vhost to set. #
1893 #<vhost user="some_username" pass="some_password" host="some.host.test.cc">
1894 #<vhost user="foo" password="fcde2b2edba56bf408601fb721fe9b5c338d10ee429ea04fae5511b68fbf8fb9" hash="sha256" host="some.other.host.example.com">
1896 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1897 # Watch module: Adds the WATCH command, which is used by clients to
1898 # maintain notify lists.
1899 #<module name="m_watch.so">
1901 # Set the maximum number of entries on a user's watch list below.
1902 #<watch maxentries="32">
1904 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1905 # XLine database: Stores all *Lines (G/Z/K/R/any added by other modules)
1906 # in a file which is re-loaded on restart. This is useful
1907 # for two reasons: it keeps bans so users may not evade them, and on
1908 # bigger networks, server connections will take less time as there will
1909 # be a lot less bans to apply - as most of them will already be there.
1910 #<module name="m_xline_db.so">
1912 # Specify the filename for the xline database here.
1913 #<xlinedb filename="data/xline.db">
1915 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1916 # ____ _ _____ _ _ ____ _ _ _ #
1917 # | _ \ ___ __ _ __| | |_ _| |__ (_)___ | __ )(_) |_| | #
1918 # | |_) / _ \/ _` |/ _` | | | | '_ \| / __| | _ \| | __| | #
1919 # | _ < __/ (_| | (_| | | | | | | | \__ \ | |_) | | |_|_| #
1920 # |_| \_\___|\__,_|\__,_| |_| |_| |_|_|___/ |____/|_|\__(_) #
1922 # To link servers to InspIRCd, you MUST load the m_spanningtree #
1923 # module. If you don't do this, server links will NOT work at all. #
1924 # This is by design, to allow for the implementation of other linking #
1925 # protocols in modules in the future. #
1927 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1928 # Spanning tree module: Allows linking of servers using the spanning
1929 # tree protocol (see the READ THIS BIT section above).
1930 # You will almost always want to load this.
1932 #<module name="m_spanningtree.so">
projects / user / henk / code / inspircd.git / blob