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 # http://wiki.inspircd.org/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 spanningtree module. #
23 # If you don't do this, server links will NOT work at all. #
24 # This is by design, to allow for the implementation of other linking #
25 # protocols in modules in the future. This module is at the bottom of #
29 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
30 # MD5 module: Allows other modules to generate MD5 hashes, usually for
31 # cryptographic uses and security.
34 # Other modules such as cloaking and password_hash may rely on
35 # this module being loaded to function.
39 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
40 # SHA256 module: Allows other modules to generate SHA256 hashes,
41 # usually for cryptographic uses and security.
44 # Other modules such as password_hash may rely on this module being
45 # loaded to function. Certain modules such as spanningtree will
46 # function without this module but when it is loaded their features will
47 # be enhanced (for example the addition of HMAC authentication).
49 #<module name="sha256">
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="ripemd160">
58 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
59 # Abbreviation module: Provides the ability to abbreviate commands a-la
61 #<module name="abbreviation">
63 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
64 # Alias module: Allows you to define server-side command aliases.
65 #<module name="alias">
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 alias module loaded, you may also define aliases as #
76 # shown below. They are commonly used to provide shortcut commands to #
77 # 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="allowinvite">
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="alltime">
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="auditorium">
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="autoop">
220 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
221 # Ban except module: Adds support for channel ban exceptions (+e).
222 #<module name="banexception">
224 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
225 # Ban redirection module: Allows bans which redirect to a specified
226 # channel. e.g. +b nick!ident@host#channelbanneduserissentto
227 #<module name="banredirect">
229 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
230 # bcrypt module: Allows other modules to generate bcrypt hashes,
231 # usually for cryptographic uses and security.
232 #<module name="bcrypt">
234 # rounds: Defines how many rounds the bcrypt function will run when
235 # generating new hashes.
236 #<bcrypt rounds="10">
238 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
239 # Block amsg module: Attempt to block all usage of /amsg and /ame.
240 #<module name="blockamsg">
242 #-#-#-#-#-#-#-#-#-#-#- BLOCKAMSG CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
244 # If you have the blockamsg module loaded, you can configure it with #
245 # the <blockamsg> tag: #
247 # delay - How many seconds between two messages to force #
248 # them to be recognised as unrelated. #
249 # action - Any of 'notice', 'noticeopers', 'silent', 'kill' #
250 # or 'killopers'. Define how to take action when #
251 # a user uses /amsg or /ame. #
253 #<blockamsg delay="3" action="killopers">
255 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
256 # Block CAPS module: Adds channel mode +B, blocks all-CAPS messages.
257 #<module name="blockcaps">
259 #-#-#-#-#-#-#-#-#-#-#- BLOCKCAPS CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
261 # percent - What percentage of the text must be caps before #
262 # text will be blocked. #
264 # minlen - The minimum length a line must be for the block #
265 # percent to have any effect. #
267 # capsmap - A list of chars to be considered CAPS. Can be used #
268 # to add CAPS characters for your language. Also you #
269 # can add things like ! and space to further lock #
270 # down on caps usage. #
271 #<blockcaps percent="50"
273 # capsmap="ABCDEFGHIJKLMNOPQRSTUVWXYZ! ">
275 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
276 # Block color module: Blocking color-coded messages with chan mode +c.
277 #<module name="blockcolor">
279 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
280 # Botmode module: Adds the user mode +B. If set on a user, it will
281 # show that the user is a bot in /WHOIS.
282 #<module name="botmode">
284 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
285 # CallerID module: Adds usermode +g which activates hybrid-style
286 # callerid: block all private messages unless you /ACCEPT first.
287 #<module name="callerid">
289 #-#-#-#-#-#-#-#-#-#-#- CALLERID CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#
290 # maxaccepts - Maximum number of entries a user can add to his #
291 # /ACCEPT list. Default is 16 entries. #
292 # operoverride - Can opers (note: ALL opers) override callerid? #
294 # tracknick - Preserve /accept entries when a user changes nick? #
295 # If no (the default), the user is removed from #
296 # everyone's accept list if he changes nickname. #
297 # cooldown - Amount of time (in seconds) that must pass since #
298 # the last notification sent to a user before he can #
299 # be sent another. Default is 60 (1 minute). #
300 #<callerid maxaccepts="16"
305 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
306 # CAP module: Provides the CAP negotiation mechanism required by the
307 # sasl, namesx, uhnames, and ircv3 modules.
308 # It is also recommended for STARTTLS support in the starttls module.
311 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
312 # CBAN module: Lets you disallow channels from being used at runtime.
313 # This module is oper-only and provides /CBAN.
314 # To use, CBAN must be in one of your oper class blocks.
315 #<module name="cban">
317 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
318 # Censor module: Adds channel and user mode +G.
319 #<module name="censor">
321 #-#-#-#-#-#-#-#-#-#-#- CENSOR CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#
323 # Optional - If you specify to use the censor module, then you must #
324 # specify some censor tags. See also: #
325 # http://wiki.inspircd.org/Modules/censor #
327 #<include file="examples/censor.conf.example">
329 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
330 # CGI:IRC module: Adds support for automatic host changing in CGI:IRC
331 # (http://cgiirc.sourceforge.net).
332 # Adds snomask +w for monitoring CGI:IRC connections.
333 #<module name="cgiirc">
335 #-#-#-#-#-#-#-#-#-#-#-# CGIIRC CONFIGURATION #-#-#-#-#-#-#-#-#-#-#-#-#
337 # Optional - If you specify to use cgiirc, then you must specify one
338 # or more cgihost tags which indicate authorised CGI:IRC servers which
339 # will be connecting to your network, and an optional cgiirc tag.
340 # For more information see: http://wiki.inspircd.org/Modules/cgiirc
342 # Set to yes if you want to notice opers when CGI:IRC clients connect.
343 # <cgiirc opernotice="no">
345 # The type field indicates where the module should get the real
346 # client's IP address from, for further information, please see the
347 # CGI:IRC documentation.
350 # <cgihost type="pass" mask="www.example.com"> # Get IP from PASS
351 # <cgihost type="ident" mask="otherbox.example.com"> # Get IP from ident
352 # <cgihost type="passfirst" mask="www.example.com"> # See the docs
354 # <cgihost type="webirc" password="foobar"
355 # mask="somebox.example.com"> # Get IP from WEBIRC
360 # When you connect CGI:IRC clients, there are two connect classes which
361 # apply to these clients. When the client initially connects, the connect
362 # class which matches the CGI:IRC site's host is checked. Therefore you
363 # must raise the maximum local/global clients for this ip as high as you
364 # want to allow cgi clients. After the client has connected and is
365 # determined to be a cgi:irc client, the class which matches the client's
366 # real IP is then checked. You may set this class to a lower value, so that
367 # the real IP of the client can still be restricted to, for example, 3
370 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
371 # Channel create module: Adds snomask +j, which will notify opers of
372 # any new channels that are created.
373 # This module is oper-only.
374 #<module name="chancreate">
376 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
377 # Channel filter module: Allows channel-op defined message filtering
378 # using simple string matches (channel mode +g).
379 #<module name="chanfilter">
381 # If hidemask is set to yes, the user will not be shown the mask when
382 # his/her message is blocked.
383 #<chanfilter hidemask="yes">
385 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
386 # Channel history module: Displays the last 'X' lines of chat to a user
387 # joining a channel with +H 'X:T' set; 'T' is the maximum time to keep
388 # lines in the history buffer. Designed so that the new user knows what
389 # the current topic of conversation is when joining the channel.
390 #<module name="chanhistory">
392 # Set the maximum number of lines allowed to be stored per channel below.
393 # This is the hard limit for 'X'.
394 # If notice is set to yes, joining users will get a NOTICE before playback
395 # telling them about the following lines being the pre-join history.
396 # If bots is set to yes, it will also send to users marked with +B
397 #<chanhistory maxlines="20" notice="yes" bots="yes">
399 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
400 # Channel logging module: Used to send snotice output to channels, to
401 # allow staff to centrally monitor and discuss network activity.
403 # The "channel" field is where you want the messages to go, "snomasks"
404 # is what snomasks you want to be sent to that channel. Multiple tags
406 #<module name="chanlog">
407 #<chanlog snomasks="AOcC" channel="#opers">
409 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
410 # Channel names module: Allows disabling channels which have certain
411 # characters in the channel name such as bold, colorcodes, etc. which
412 # can be quite annoying and allow users to on occasion have a channel
413 # that looks like the name of another channel on the network.
414 #<module name="channames">
417 # denyrange: characters or range of characters to deny in channel
421 # allowrange: characters or range of characters to specifically allow
425 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
426 # Channelban: Implements extended ban j:, which stops anyone already
427 # in a channel matching a ban like +b j:#channel*mask from joining.
428 #<module name="channelban">
430 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
431 # Check module: Adds the /CHECK command.
432 # Check is useful for looking up information on channels, users,
433 # IP addresses and hosts.
434 # This module is oper-only.
435 # To use, CHECK must be in one of your oper class blocks.
436 #<module name="check">
438 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
439 # CHGHOST module: Adds the /CHGHOST command.
440 # This module is oper-only.
441 # To use, CHGHOST must be in one of your oper class blocks.
442 # NOTE: Services will not be able to set vhosts on users if this module
443 # isn't loaded. If you're planning on running services, you probably
445 #<module name="chghost">
447 #-#-#-#-#-#-#-#-# /CHGHOST - /SETHOST CONFIGURATION #-#-#-#-#-#-#-#-#
448 # Optional - If you want to use special chars for hostnames you can #
449 # specify your own custom list of chars with the <hostname> tag: #
451 # charmap - A list of chars accepted as valid by the /CHGHOST #
452 # and /SETHOST commands. Also note that the list is #
454 #<hostname charmap="abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ.-_/0123456789">
456 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
457 # CHGIDENT module: Adds the /CHGIDENT command.
458 # This module is oper-only.
459 # To use, CHGIDENT must be in one of your oper class blocks.
460 #<module name="chgident">
462 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
463 # CHGNAME module: Adds the /CHGNAME command.
464 # This module is oper-only.
465 # To use, CHGNAME must be in one of your oper class blocks.
466 #<module name="chgname">
468 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
469 # Clear chan module: Allows opers to masskick, masskill or mass-G/ZLine
470 # all users on a channel using /CLEARCHAN.
471 #<module name="clearchan">
473 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
474 # Cloaking module: Adds usermode +x and cloaking support.
475 # Relies on the md5 module being loaded.
476 # To cloak users when they connect, load the conn_umodes module and set
477 # <connect:modes> to include the +x mode. The example <connect> tag
478 # shows this. See the conn_umodes module for more information.
479 #<module name="cloaking">
481 #-#-#-#-#-#-#-#-#-#-#- CLOAKING CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#
483 # To use cloaking, you must define a cloak key, and optionally a #
484 # cloak prefix as shown below. The cloak key must be shared across #
485 # the network for correct cloaking. #
487 # There are two methods of cloaking: #
489 # half Cloak only the "unique" portion of a host; show #
490 # the last 2 parts of the domain, /16 subnet of IPv4 #
491 # or /48 subnet of the IPv6 address. #
493 # full Cloak the users completely, using three slices for #
494 # common CIDR bans (IPv4: /16, /24; IPv6: /48, /64). #
496 # The methods use a single key that can be any length of text. #
497 # An optional prefix may be specified to mark cloaked hosts. #
498 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
504 #-#-#-#-#-#-#-#-#-#-#-#- CLOSE MODULE #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
505 # Close module: Allows an oper to close all unregistered connections.
506 # This module is oper-only and provides the /CLOSE command.
507 # To use, CLOSE must be in one of your oper class blocks.
508 #<module name="close">
510 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
511 # Clones module: Adds an oper command /CLONES for detecting cloned
512 # users. Warning: This command may be resource intensive when it is
513 # issued, use with care.
514 # This module is oper-only.
515 # To use, CLONES must be in one of your oper class blocks.
516 #<module name="clones">
518 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
519 # Common channels module: Adds user mode +c, which, when set, requires
520 # that users must share a common channel with you to PRIVMSG or NOTICE
522 #<module name="commonchans">
524 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
525 # Auto join on connect module: Allows you to force users to join one
526 # or more channels automatically upon connecting to the server, or
527 # join them in case they aren't on any channels after being online
529 #<module name="conn_join">
531 #-#-#-#-#-#-#-#-#-#-#-#- CONNJOIN CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
533 # If you have the conn_join module loaded, you can configure it below
534 # or set autojoin="#chat,#help" in <connect> blocks.
536 # Join users immediately after connection to #one #two and #three.
537 #<autojoin channel="#one,#two,#three">
538 # Join users to #chat after 15 seconds if they aren't on any channels.
539 #<autojoin channel="#chat" delay="15">
541 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
542 # Set modes on connect module: When this module is loaded <connect>
543 # blocks may have an optional modes="" value, which contains modes to
544 # add or remove from users when they connect to the server.
545 #<module name="conn_umodes">
547 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
548 # Wait for PONG on connect module: Send a PING to all connecting users
549 # and don't let them connect until they reply with a PONG.
550 # This is useful to stop certain kinds of bots and proxies.
551 #<module name="conn_waitpong">
553 #-#-#-#-#-#-#-#-#-#-#- WAITPONG CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
555 # If you have the conn_waitpong module loaded, configure it with the #
558 # sendsnotice - Whether to send a helpful notice to users on #
559 # connect telling them how to connect, should #
560 # their client not reply PONG automatically. #
562 # killonbadreply - Whether to kill the user if they send the wrong #
565 #<waitpong sendsnotice="yes" killonbadreply="yes">
567 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
568 # Channel cycle module: Adds the /CYCLE command which is a server-side
569 # /HOP that bypasses restrictive modes.
570 #<module name="cycle">
572 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
573 # Connectban: Provides IP connection throttling. Any IP range that
574 # connects too many times (configurable) in an hour is Z-Lined for a
575 # (configurable) duration, and their count resets to 0.
576 #<module name="connectban">
578 # ipv4cidr and ipv6cidr allow you to turn the comparison from
579 # individual IP addresses (32 and 128 bits) into CIDR masks, to allow
580 # for throttling over whole ISPs/blocks of IPs, which may be needed to
583 # This allows for 10 connections in an hour with a 10 minute ban if
585 #<connectban threshold="10" duration="10m" ipv4cidr="32" ipv6cidr="128"
586 # A custom ban message may optionally be specified.
587 # banmessage="Your IP range has been attempting to connect too many times in too short a duration. Wait a while, and you will be able to connect.">
589 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
590 # Connection throttle module.
591 #<module name="connflood">
593 #-#-#-#-#-#-#-#-#-#-#- CONNTHROTTLE CONFIGURATION -#-#-#-#-#-#-#-#-#-#
594 # seconds, maxconns - Amount of connections per <seconds>.
596 # timeout - Time to wait after the throttle was activated
597 # before deactivating it. Be aware that the time
598 # is seconds + timeout.
600 # quitmsg - The message that users get if they attempt to
601 # connect while the throttle is active.
603 # bootwait - Amount of time in seconds to wait before enforcing
604 # the throttling when the server just booted.
606 #<connflood seconds="30" maxconns="3" timeout="30"
607 # quitmsg="Throttled" bootwait="10">
609 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
610 # Custom prefixes: Allows for channel prefixes to be added.
611 #<module name="customprefix">
613 # name The name of the mode, must be unique from other modes.
614 # letter The letter used for this mode. Required.
615 # prefix The prefix used for nicks with this mode. Not required.
616 # rank A numeric rank for this prefix, defining what permissions it gives.
617 # The rank of voice, halfop and op is 10000, 20000, and 30000,
619 # ranktoset The numeric rank required to set/unset this mode. Defaults to rank.
620 # depriv Can you remove the mode from yourself? Defaults to yes.
621 #<customprefix name="founder" letter="q" prefix="~" rank="50000" ranktoset="50000">
622 #<customprefix name="admin" letter="a" prefix="&" rank="40000" ranktoset="50000">
623 #<customprefix name="halfop" letter="h" prefix="%" rank="20000" ranktoset="30000">
624 #<customprefix name="halfvoice" letter="V" prefix="-" rank="1" ranktoset="20000">
626 # Do /RELOADMODULE customprefix after changing the settings of this module.
628 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
629 # Custom title module: Adds the /TITLE command which allows for trusted
630 # users to gain a custom whois line and an optional vhost can be
632 #<module name="customtitle">
634 #-#-#-#-#-#-#-#-#-#- CUSTOM TITLE CONFIGURATION -#-#-#-#-#-#-#-#-#-#
635 # name - The username used to identify.
636 # password - The password used to identify.
637 # hash - The hash for the specific user's password (optional).
638 # password_hash and a hashing module must be loaded
640 # host - Allowed hostmask (optional).
641 # title - Title shown in whois.
642 # vhost - Displayed host (optional).
644 #<title name="foo" password="bar" title="Official Chat Helper">
645 #<title name="bar" password="foo" host="ident@test.org" title="Official Chat Helper" vhost="helper.test.org">
646 #<title name="foo" password="fcde2b2edba56bf408601fb721fe9b5c338d10ee429ea04fae5511b68fbf8fb9" hash="sha256" title="Official Chat Helper">
648 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
649 # DCCALLOW module: Adds the /DCCALLOW command.
650 #<module name="dccallow">
652 #-#-#-#-#-#-#-#-#-#-#- DCCALLOW CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
653 # blockchat - Whether to block DCC CHAT as well as DCC SEND.
654 # length - Default duration of entries in DCCALLOW list.
655 # action - Default action to take if no action is
656 # specified, can be 'block' or 'allow'.
658 # File configuration:
659 # pattern - The glob pattern to match against.
660 # action - Action to take if a user attempts to send a file
661 # that matches this pattern, can be 'block' or
664 #<dccallow blockchat="yes" length="5m" action="block">
665 #<banfile pattern="*.exe" action="block">
666 #<banfile pattern="*.txt" action="allow">
668 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
669 # Deaf module: Adds support for the usermode +d - deaf to channel
670 # messages and channel notices.
671 #<module name="deaf">
673 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
674 # Delay join module: Adds the channel mode +D which delays all JOIN
675 # messages from users until they speak. If they quit or part before
676 # speaking, their quit or part message will not be shown to the channel
677 # which helps cut down noise on large channels in a more friendly way
678 # than the auditorium mode. Only channel ops may set the +D mode.
679 #<module name="delayjoin">
681 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
682 # Delay message module: Adds the channel mode +d which disallows a user
683 # from talking in the channel unless they've been joined for X seconds.
684 # Settable using /MODE #chan +d 30
685 #<module name="delaymsg">
686 # Set allownotice to no to disallow NOTICEs too. Defaults to yes.
687 #<delaymsg allownotice="no">
689 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
690 # Deny channels module: Deny channels from being used by users.
691 #<module name="denychans">
693 #-#-#-#-#-#-#-#-#-#-#- DENYCHAN DEFINITIONS -#-#-#-#-#-#-#-#-#-#-#-#
695 # If you have the denychans module loaded, you need to specify the #
696 # channels to deny: #
698 # name - The channel name to deny (glob masks are ok). #
699 # allowopers - If operators are allowed to override the deny. #
700 # reason - Reason given for the deny. #
701 # redirect - Redirect the user to a different channel. #
703 #<badchan name="#gods*" allowopers="yes" reason="Tortoises!"> #
704 #<badchan name="#chan1" redirect="#chan2" reason="Chan1 is closed"> #
706 # Redirects will not work if the target channel is set +L. #
708 # Additionally, you may specify channels which are allowed, even if #
709 # a badchan tag specifies it would be denied: #
710 #<goodchan name="#funtimes"> #
711 # Glob masks are accepted here also. #
713 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
714 # Devoice module: Let users devoice themselves using /DEVOICE #chan.
715 #<module name="devoice">
717 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
718 # DNS blacklist module: Provides support for looking up IPs on one or #
720 #<module name="dnsbl"> #
722 # For configuration options please see the wiki page for dnsbl at #
723 # http://wiki.inspircd.org/Modules/dnsbl #
725 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
726 # Exempt channel operators module: Provides support for allowing #
727 # channel operators to be exempt from some channel modes. Supported #
728 # modes are blockcaps, noctcp, blockcolor, nickflood, flood, censor, #
729 # filter, regmoderated, nonick, nonotice, and stripcolor. #
730 #<module name="exemptchanops"> #
732 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
733 # Filter module: Provides message filtering, similar to SPAMFILTER. #
734 #<module name="filter">
736 # This module depends upon a regex provider such as regex_pcre or #
737 # regex_glob to function. You must specify which of these you want #
738 # the filter module to use via the tag below. #
740 # Valid engines are: #
742 # glob - Glob patterns, provided via regex_glob. #
743 # pcre - PCRE regexps, provided via regex_pcre, needs libpcre. #
744 # tre - TRE regexps, provided via regex_tre, requires libtre. #
745 # posix - POSIX regexps, provided via regex_posix, not available #
746 # on Windows, no dependencies on other operating systems. #
747 # stdlib - stdlib regexps, provided via regex_stdlib, see comment #
748 # at the <module> tag for info on availability. #
750 #<filteropts engine="glob"> #
752 # Your choice of regex engine must match on all servers network-wide.
754 # To learn more about the configuration of this module, read #
755 # examples/filter.conf.example, which covers the various types of #
756 # filters and shows how to add exemptions. #
758 #-#-#-#-#-#-#-#-#-#-#- FILTER CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#
760 # Optional - If you specify to use the filter module, then #
761 # specify below the path to the filter.conf file, or define some #
764 #<include file="examples/filter.conf.example">
766 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
767 # Flash Policy Daemon module: Allows Flash IRC clients (e.g. LightIRC)#
768 # to connect. If no file is specified, it'll serve a default policy #
769 # allowing all IPs to connect to all plaintext IRC ports #
770 #<bind address="" port="8430" type="flashpolicyd"> #
771 #<flashpolicyd timeout="5" file=""> #
772 #<module name="flashpolicyd"> #
774 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
775 # Gecos ban: Implements extended ban 'r', which stops anyone matching
776 # a mask like +b r:*realname?here* from joining a channel.
777 #<module name="gecosban">
779 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
780 # GeoIP module: Allows the server admin to match users by country code.
781 # This module is in extras. Re-run configure with:
782 # ./configure --enable-extras=m_geoip.cpp
783 # and run make install, then uncomment this module to enable it.
784 # This module requires GeoIP to be installed on your system,
785 # use your package manager to find the appropriate packages
786 # or check the InspIRCd wiki page for this module.
787 #<module name="geoip">
789 # The actual allow/ban actions are done by connect classes, not by the
790 # GeoIP module. An example connect class to ban people from russia or
793 # <connect deny="*" geoip="TR,RU">
795 # The country code must be in capitals and should be an ISO country
796 # code such as TR, GB, or US. Unknown IPs (localhost, LAN IPs, etc)
797 # will be assigned the country code "UNK". Since connect classes are
798 # matched from top down, your deny classes must be above your allow
799 # classes for them to match.
801 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
802 # Globops module: Provides the /GLOBOPS command and snomask +g.
803 # This module is oper-only.
804 # To use, GLOBOPS must be in one of your oper class blocks.
805 #<module name="globops">
807 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
808 # Global load module: Allows loading and unloading of modules network-
809 # wide (USE WITH EXTREME CAUTION!)
810 # This module is oper-only and provides /GLOADMODULE, /GUNLOADMODULE
811 # and /GRELOADMODULE.
812 # To use, GLOADMODULE, GUNLOADMODULE and GRELOADMODULE
813 # must be in one of your oper class blocks.
814 #<module name="globalload">
816 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
817 # HELPOP module: Provides the /HELPOP command
818 #<module name="helpop">
820 #-#-#-#-#-#-#-#-#-#-#-#- HELPOP CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
822 # If you specify to use the helpop module, then specify below the #
823 # path to the helpop.conf file. #
825 #<include file="examples/inspircd.helpop-full.example">
827 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
828 # Hide chans module: Allows users to hide their channels list from non-
829 # opers by setting user mode +I on themselves.
830 #<module name="hidechans">
832 # This mode can optionally prevent opers from seeing channels on a +I
833 # user, for more privacy if set to true.
834 # This setting is not recommended for most mainstream networks.
835 #<hidechans affectsopers="false">
837 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
838 # Hide list module: Allows for hiding the list of listmodes from users
839 # who do not have sufficient channel rank.
840 #<module name="hidelist">
842 # Each <hidelist> tag configures one listmode to hide.
843 # mode: Name of the listmode to hide.
844 # rank: Minimum rank required to view the list. If set to 0, all
845 # members of the channel may view the list, but non-members may not.
846 # The rank of the built-in op and voice mode is 30000 and 10000,
847 # respectively; the rank of other prefix modes is configurable.
850 # Hiding the ban list is not recommended because it may break some
853 # Hide filter (+g) list:
854 #<hidelist mode="filter" rank="30000">
855 # Only show invite exceptions (+I) to channel members:
856 #<hidelist mode="invex" rank="0">
858 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
859 # Hide oper module: Allows opers to hide their oper status from non-
860 # opers by setting user mode +H on themselves.
861 # This module is oper-only.
862 #<module name="hideoper">
864 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
865 # Hostchange module: Allows a different style of cloaking.
866 #<module name="hostchange">
868 #-#-#-#-#-#-#-#-#-#-#- HOSTCHANGE CONFIGURATION -#-#-#-#-#-#-#-#-#-#
870 # See http://wiki.inspircd.org/Modules/hostchange for help. #
872 #<host suffix="invalid.org" separator="." prefix="">
873 #<hostchange mask="*@42.theanswer.example.org" action="addnick">
874 #<hostchange mask="*root@*" action="suffix">
875 #<hostchange mask="a@example.com" action="set" value="foo.bar.baz">
876 #<hostchange mask="localhost" ports="7000,7001,7005-7007" action="set" value="blahblah.foo">
878 # hostcycle: If loaded, when a user gets a host or ident set, it will
879 # cycle them in all their channels. If not loaded it will simply change
880 # their host/ident without cycling them.
881 # This module is compatible with the ircv3_chghost module. Clients
882 # supporting the chghost extension will get the chghost message instead
883 # of seeing a host cycle.
884 #<module name="hostcycle">
886 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
887 # httpd module: Provides HTTP server support for InspIRCd.
888 #<module name="httpd">
890 #-#-#-#-#-#-#-#-#-#-#-#- HTTPD CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
892 # If you choose to use the httpd module, then you will need to add
893 # a <bind> tag with type "httpd", and load at least one of the other
894 # httpd_* modules to provide pages to display.
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 httpd dependent
902 # modules. Use this module to restrict pages by IP address and by
904 #<module name="httpd_acl">
906 #-#-#-#-#-#-#-#-#-#-#-#- HTTPD ACL CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
908 # Restrict access to the 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 configuration of the server to be
918 # viewed over HTTP. Requires httpd to be loaded for it to function.
919 #<module name="httpd_config">
921 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
922 # HTTP stats module: Provides basic stats pages over HTTP.
923 # Requires httpd to be loaded for it to function.
924 #<module name="httpd_stats">
926 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
927 # Ident: Provides RFC 1413 ident lookup support.
928 # When this module is loaded <connect:allow> tags may have an optional
929 # useident="yes|no" boolean value, determining whether or not to lookup
930 # ident on users matching that connect tag.
931 #<module name="ident">
933 #-#-#-#-#-#-#-#-#-#-#-#- IDENT CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
935 # Optional - If you are using the ident module, then you can specify #
936 # the timeout for ident lookups here. If not defined, it will default #
937 # to 5 seconds. This is a non-blocking timeout which holds the user #
938 # in a 'connecting' state until the lookup is complete. #
939 # The bind value indicates which IP to bind outbound requests to. #
940 # nolookupprefix: If on, the idents of users being in a connect class #
941 # with ident lookups disabled (i.e. <connect useident="off">) will be #
942 # prefixed with a "~". If off, the ident of those users will not be #
943 # prefixed. Default is off. #
945 #<ident timeout="5" nolookupprefix="no">
947 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
948 # Invite exception module: Adds support for channel invite exceptions
950 #<module name="inviteexception">
951 # bypasskey: If this is enabled, exceptions will bypass +k as well as +i
952 #<inviteexception bypasskey="yes">
954 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
955 # IRCv3 module: Provides the following IRCv3.1 extensions:
956 # extended-join, away-notify and account-notify. These are optional
957 # enhancements to the client-to-server protocol. An extension is only
958 # active for a client when the client specifically requests it, so this
959 # module needs the cap module to work.
961 # Further information on these extensions can be found at the IRCv3
962 # working group website:
963 # http://ircv3.org/extensions/
965 #<module name="ircv3">
966 # The following block can be used to control which extensions are
967 # enabled. Note that extended-join can be incompatible with delayjoin
969 #<ircv3 accountnotify="on" awaynotify="on" extendedjoin="on">
971 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
972 # IRCv3 cap-notify module: Provides the cap-notify IRCv3.2 extension.
973 # Required for IRCv3.2 conformance.
974 #<module name="ircv3_capnotify">
976 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
977 # IRCv3 chghost module: Provides the chghost IRCv3.2 extension which
978 # allows capable clients to learn when the host/ident of another user
979 # changes without cycling the user. This module is compatible with the
980 # hostcycle module. If both are loaded, clients supporting the chghost
981 # extension will get the chghost message and won't see host cycling.
982 #<module name="ircv3_chghost">
984 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
985 # IRCv3 echo-message module: Provides the echo-message IRCv3.2
986 # extension which allows capable clients to get an acknowledgement when
987 # their messages are delivered and learn what modifications, if any,
988 # were applied to them.
989 #<module name="ircv3_echomessage">
991 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
992 # IRCv3 invite-notify module: Provides the invite-notify IRCv3.2
993 # extension which notifies supporting clients when a user invites
994 # another user into a channel. This respects <options:announceinvites>.
995 #<module name="ircv3_invitenotify">
997 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
998 # Join flood module: Adds support for join flood protection +j X:Y.
999 # Closes the channel for 60 seconds if X users join in Y seconds.
1000 #<module name="joinflood">
1002 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1003 # Jump server module: Adds support for the RPL_REDIR numeric.
1004 # This module is oper-only.
1005 # To use, JUMPSERVER must be in one of your oper class blocks.
1006 # If your server is redirecting new clients and you get disconnected,
1007 # do a REHASH from shell to open up again.
1008 #<module name="jumpserver">
1010 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1011 # Anti auto rejoin: Adds support for prevention of auto-rejoin (+J).
1012 #<module name="kicknorejoin">
1014 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1015 # Knock module: Adds the /KNOCK command and channel mode +K.
1016 #<module name="knock">
1018 # This setting specifies what to do when someone successfully /KNOCKs.
1019 # If set to "notice", then a NOTICE will be sent to the channel.
1020 # This is the default and the compatible setting, as it requires no
1021 # special support from the clients.
1022 # If set to "numeric" then a 710 numeric will be sent to the channel.
1023 # This allows easier scripting but not all clients support it.
1024 # If set to "both" then (surprise!) both will be sent.
1025 #<knock notify="notice">
1027 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1028 # LDAP module: Allows other SQL modules to access a LDAP database
1029 # through a unified API.
1030 # This modules is in extras. Re-run configure with:
1031 # ./configure --enable-extras=m_ldap.cpp
1032 # and run make install, then uncomment this module to enable it.
1034 #<module name="ldap">
1035 #<database module="ldap" id="ldapdb" server="ldap://localhost" binddn="cn=Manager,dc=inspircd,dc=org" bindauth="mysecretpass" searchscope="subtree">
1036 # The server parameter indicates the LDAP server to connect to. The #
1037 # ldap:// style scheme before the hostname proper is MANDATORY. #
1039 # The binddn and bindauth indicate the DN to bind to for searching, #
1040 # and the password for the distinguished name. Some LDAP servers will #
1041 # allow anonymous searching in which case these two values do not #
1042 # need defining, otherwise they should be set similar to the examples #
1045 # The searchscope value indicates the subtree to search under. On our #
1046 # test system this is 'subtree'. Your mileage may vary. #
1048 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1049 # LDAP authentication module: Adds the ability to authenticate users #
1051 #<module name="ldapauth">
1055 # <ldapauth dbid="ldapdb" #
1056 # baserdn="ou=People,dc=brainbox,dc=cc" #
1058 # allowpattern="Guest* Bot*" #
1059 # killreason="Access denied" #
1061 # host="$uid.$ou.inspircd.org"> #
1063 # <ldapwhitelist cidr="10.42.0.0/16"> #
1065 # <ldaprequire attribute="attr" value="val"> #
1067 # The baserdn indicates the base DN to search in for users. Usually #
1068 # this is 'ou=People,dc=yourdomain,dc=yourtld'. #
1070 # The attribute value indicates the attribute which is used to locate #
1071 # a user account by name. On POSIX systems this is usually 'uid'. #
1073 # The allowpattern value allows you to specify a space separated list #
1074 # of wildcard masks which will always be allowed to connect #
1075 # regardless of if they have an account, for example guest and bot #
1078 # Killreason indicates the QUIT reason to give to users if they fail #
1079 # to authenticate. #
1081 # Setting the verbose value causes an oper notice to be sent out for #
1082 # every failed authentication to the server, with an error string. #
1084 # ldapwhitelist indicates that clients connecting from an IP in the #
1085 # provided CIDR do not need to authenticate against LDAP. It can be #
1086 # repeated to whitelist multiple CIDRs. #
1088 # ldaprequire allows further filtering on the LDAP user, by requiring #
1089 # certain LDAP attibutes to have a given value. It can be repeated, #
1090 # in which case the list will act as an OR list, that is, the #
1091 # authentication will succeed if any of the requirements in the list #
1094 # host allows you to change the displayed host of users connecting #
1095 # from ldap. The string supplied takes formatters which are replaced #
1096 # from the DN. For instance, if your DN looks like: #
1097 # uid=w00t,ou=people,dc=inspircd,dc=org, then the formatters uid, ou #
1098 # and dc will be available to you. If a key is given multiple times #
1099 # in the DN, the last appearance will take precedence. #
1101 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1102 # LDAP oper configuration module: Adds the ability to authenticate #
1104 #<module name="ldapoper">
1108 # <ldapoper dbid="ldapdb"
1109 # baserdn="ou=People,dc=brainbox,dc=cc"
1112 # Available configuration items are identical to the same items in #
1113 # ldapauth above (except for the verbose setting, that is only #
1114 # supported in ldapauth). #
1115 # Please always specify a password in your <oper> tags even if the #
1116 # opers are to be authenticated via LDAP, so in case this module is #
1117 # not loaded the oper accounts are still protected by a password. #
1119 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1120 # Lock server module: Adds /LOCKSERV and /UNLOCKSERV commands that #
1121 # are used to temporarily close/open the server for new connections. #
1122 # These commands require that the /LOCKSERV and /UNLOCKSERV commands #
1123 # are specified in a <class> tag that the oper is part of. This is so #
1124 # you can control who has access to this possible dangerous command. #
1125 # If your server is locked and you get disconnected, do a REHASH from #
1126 # shell to open up again. #
1127 # This module is oper-only.
1128 #<module name="lockserv">
1130 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1131 # Map hiding module: replaces /MAP and /LINKS output to users with a #
1132 # message to see a website, set by maphide="http://test.org/map" in #
1133 # the <security> tag, instead. #
1134 #<module name="maphide">
1136 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1137 # Message flood module: Adds message/notice flood protection via
1139 #<module name="messageflood">
1141 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1142 # MLOCK module: Adds support for server-side enforcement of services
1143 # side MLOCKs. Basically, this module suppresses any mode change that
1144 # would likely be immediately bounced by services.
1145 #<module name="mlock">
1147 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1148 # Modenotice module: Adds the /MODENOTICE command that allows opers to
1149 # send notices to all users having the given user mode(s) set.
1150 #<module name="modenotice">
1152 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1153 # Monitor module: Adds support for MONITOR which is used by clients to
1154 # maintain notify lists.
1155 #<module name="monitor">
1157 # Set the maximum number of entries on a user's monitor list below.
1158 #<monitor maxentries="30">
1160 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1161 # MsSQL module: Allows other SQL modules to access MS SQL Server
1162 # through a unified API.
1163 # This module is in extras. Re-run configure with:
1164 # ./configure --enable-extras=m_mssql.cpp
1165 # and run make install, then uncomment this module to enable it.
1166 #<module name="mssql">
1168 #-#-#-#-#-#-#-#-#-#-#-#- SQL CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#-#
1170 # mssql is more complex than described here, see the wiki for more #
1171 # info http://wiki.inspircd.org/Modules/mssql #
1173 #<database module="mssql" name="db" user="user" pass="pass" host="localhost" id="db1">
1175 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1176 # MySQL module: Allows other SQL modules to access MySQL databases
1177 # through a unified API.
1178 # This module is in extras. Re-run configure with:
1179 # ./configure --enable-extras=m_mysql.cpp
1180 # and run make install, then uncomment this module to enable it.
1181 #<module name="mysql">
1183 #-#-#-#-#-#-#-#-#-#-#-#- SQL CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#-#
1185 # mysql is more complex than described here, see the wiki for more #
1186 # info: http://wiki.inspircd.org/Modules/mysql #
1188 #<database module="mysql" name="mydb" user="myuser" pass="mypass" host="localhost" id="my_database2">
1190 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1191 # Named modes module: Allows for the display and set/unset of channel
1192 # modes via long-form mode names via +Z and the /PROP command.
1193 # For example, to set a ban, do /mode #channel +Z ban=foo!bar@baz or
1194 # /PROP #channel ban=foo!bar@baz
1195 #<module name="namedmodes">
1197 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1198 # NAMESX module: Provides support for the NAMESX extension which allows
1199 # clients to see all the prefixes set on a user without getting confused.
1200 # This is supported by mIRC, x-chat, klient, and maybe more.
1201 #<module name="namesx">
1203 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1204 # National characters module:
1205 # 1) Allows using national characters in nicknames.
1206 # 2) Allows using custom (national) casemapping over the network.
1207 #<module name="nationalchars">
1209 # file - filename of existing file in "locales" directory
1210 # casemapping - custom value for 005 numeric (if you want it to be
1211 # different from the filename). Set this to the name of
1212 # the locale if you are specifying an absolute path.
1213 #<nationalchars file="bynets/russian-w1251-charlink" casemapping="ru_RU.cp1251-charlink">
1215 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1216 # Nickchange flood protection module: Provides channel mode +F X:Y
1217 # which allows up to X nick changes in Y seconds.
1218 #<module name="nickflood">
1220 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1221 # Nicklock module: Let opers change a user's nick and then stop that
1222 # user from changing their nick again until unlocked.
1223 # This module is oper-only.
1224 # To use, NICKLOCK and NICKUNLOCK must be in one of your oper class blocks.
1225 #<module name="nicklock">
1227 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1228 # No CTCP module: Adds the channel mode +C to block CTCPs and extban
1229 # 'C' to block CTCPs sent by specific users.
1230 #<module name="noctcp">
1232 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1233 # No kicks module: Adds the +Q channel mode and the Q: extban to deny
1234 # certain users from kicking.
1235 #<module name="nokicks">
1237 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1238 # No nicks module: Adds the +N channel mode, as well as the 'N' extban.
1239 # +N stops all users from changing their nick, the N extban stops
1240 # anyone from matching a +b N:nick!user@host mask from changing their
1242 #<module name="nonicks">
1244 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1245 # No part message module: Adds extban 'p' to block part messages from #
1247 #<module name="nopartmsg">
1249 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1250 # No notice module: Adds the channel mode +T and the extban 'T' to
1251 # block specific users from noticing the channel.
1252 #<module name="nonotice">
1254 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1255 # Network business join module:
1256 # Allows an oper to join a channel using /OJOIN, giving them +Y on the
1257 # channel which makes them immune to kick/deop/etc.
1258 #<module name="ojoin">
1260 # Specify the prefix that +Y will grant here.
1261 # Leave 'prefix' empty if you do not wish +Y to grant a prefix.
1262 # If 'notice' is set to on, upon /OJOIN, the server will notice the
1263 # channel saying that the oper is joining on network business.
1264 # If 'op' is set to on, it will give them +o along with +Y.
1265 #<ojoin prefix="!" notice="yes" op="yes">
1267 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1268 # Oper channels mode: Adds the +O channel mode and extban O:<mask>
1269 # to ban, except, etc. specific oper types. For example
1270 # /mode #channel +iI O:* is equivalent to channel mode +O, but you
1271 # may also set +iI O:AdminTypeOnly to only allow admins.
1272 # Modes +I and +e work in a similar fashion.
1273 #<module name="operchans">
1275 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1276 # Oper join module: Auto-joins opers to a channel upon oper-up.
1277 # This module is oper-only. For the user equivalent, see the conn_join
1279 #<module name="operjoin">
1281 #-#-#-#-#-#-#-#-#-#-# OPERJOIN CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
1283 # If you are using the operjoin module, specify options here: #
1285 # channel - The channel name to join, can also be a comma #
1286 # separated list e.g. "#channel1,#channel2". #
1288 # override - If on, lets the oper join walking thru any modes #
1289 # that might be set, even bans. #
1291 #<operjoin channel="#channel" override="no">
1293 # Alternatively you can use the autojoin="channellist" in a <type> #
1294 # tag to set specific autojoins for a type of oper, for example: #
1296 #<type name="Helper" autojoin="#help" classes="...">
1298 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1299 # Oper log module: Logs all oper commands to the server log (with log
1300 # type "m_operlog" at default loglevel), and optionally to the 'r'
1302 # This module is oper-only.
1303 #<module name="operlog">
1305 # If the following option is on then all oper commands will be sent to
1306 # the snomask 'r'. The default is off.
1307 #<operlog tosnomask="off">
1309 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1310 # Oper prefixing module: Adds a channel prefix mode +y which is given
1311 # to all IRC operators automatically on all channels they are in.
1312 # This prefix mode is more powerful than channel op and other regular
1315 # Load this module if you want all your IRC operators to have channel
1317 #<module name="operprefix">
1319 # You may additionally customise the prefix character.
1320 #<operprefix prefix="!">
1322 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1323 # Oper MOTD module: Provides support for separate message of the day
1325 # This module is oper-only.
1326 #<module name="opermotd">
1328 #-#-#-#-#-#-#-#-#-#-# OPERMOTD CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
1330 # If you are using the opermotd module, specify the motd here. #
1332 # onoper - If on, the message is sent on /OPER, otherwise it's #
1333 # only sent when /OPERMOTD is used. #
1335 # processcolors - Allow color codes to be processed in the opermotd. #
1336 # Read the comment above <connect:allowmotdcolors> in #
1337 # inspircd.conf.example for details. #
1339 #<opermotd file="examples/opermotd.txt.example" onoper="yes" processcolors="false">
1341 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1342 # Override module: Adds support for oper override.
1343 # This module is oper-only.
1344 #<module name="override">
1346 #-#-#-#-#-#-#-#-#-#-# OVERRIDE CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
1348 # override is too complex it describe here, see the wiki: #
1349 # http://wiki.inspircd.org/Modules/override #
1351 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1352 # Oper levels module: Gives each oper a level and prevents actions
1353 # being taken by lower level opers against higher level opers.
1354 # Specify the level as the 'level' parameter of the <type> tag.
1355 # This module is oper-only.
1356 #<module name="operlevels">
1358 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1359 # Oper modes module: Allows you to specify modes to add/remove on oper.
1360 # Specify the modes as the 'modes' parameter of the <type> tag
1361 # and/or as the 'modes' parameter of the <oper> tag.
1362 # This module is oper-only. For the user equivalent, see the
1363 # conn_umodes module.
1364 #<module name="opermodes">
1366 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1367 # Password forwarding module: Forwards a password users can send on
1368 # connect to the specified client below. The client is usually NickServ
1369 # and this module is usually used to authenticate users with NickServ
1370 # using their connect password.
1371 #<module name="passforward">
1374 # nick: nick to forward connect passwords to.
1377 # forwardmsg: Message to send to users using a connect password.
1378 # $nick will be the users' nick, $nickrequired will be the nick
1379 # of where the password is going (the nick above).
1380 # You can also use $user for the user ident string.
1381 forwardmsg="NOTICE $nick :*** Forwarding PASS to $nickrequired"
1383 # cmd: Command for the user to run when it receives a connect
1385 cmd="PRIVMSG $nickrequired :IDENTIFY $pass">
1387 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1388 # Password hash module: Allows hashed passwords to be used.
1389 # To be useful, a hashing module like sha256 also needs to be loaded.
1390 #<module name="password_hash">
1392 #-#-#-#-#-#-#-#-#-# PASSWORD HASH CONFIGURATION #-#-#-#-#-#-#-#-#-#-#-#
1394 # To use this module, you must define a hash type for each oper's
1395 # password you want to hash. For example:
1397 # <oper name="Brain"
1398 # host="ident@dialup15.isp.test.com"
1400 # password="01ba4719c80b6fe911b091a7c05124b64eeece964e09c058ef8f9805daca546b"
1403 # Starting from 2.0, you can use a more secure salted hash that prevents simply
1404 # looking up the hash's value in a rainbow table built for the hash.
1405 # hash="hmac-sha256" password="lkS1Nbtp$CyLd/WPQXizsbxFUTqFRoMvaC+zhOULEeZaQkUJj+Gg"
1407 # Generate hashes using the /MKPASSWD command on the server.
1408 # Don't run it on a server you don't trust with your password.
1410 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1411 # PBKDF2 module: Allows other modules to generate PBKDF2 hashes,
1412 # usually for cryptographic uses and security.
1413 # This module relies on other hash providers (e.g. SHA256).
1414 #<module name="pbkdf2">
1416 # iterations: Iterations the hashing function runs when generating new
1418 # length: Length in bytes of the derived key.
1419 #<pbkdf2 iterations="12288" length="32">
1420 # You can override these values with specific values
1421 # for specific providers if you want to. Example given for SHA256.
1422 #<pbkdf2prov hash="sha256" iterations="24576">
1424 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1425 # Permanent channels module: Channels with the permanent channel mode
1426 # will remain open even after everyone else has left the channel, and
1427 # therefore keep things like modes, ban lists and topic. Permanent
1428 # channels -may- need support from your Services package to function
1429 # properly with them. This adds channel mode +P.
1430 # This module is oper-only.
1431 #<module name="permchannels">
1433 # If you like, this module can write a config file of permanent channels
1434 # whenever +P is set, unset, or the topic/modes on a +P channel is changed.
1435 # If you want to do this, set the filename below, and uncomment the include.
1437 # If 'listmodes' is true then all list modes (+b, +I, +e, +g...) will be
1438 # saved. Defaults to false.
1439 #<permchanneldb filename="permchannels.conf" listmodes="true">
1440 #<include file="permchannels.conf">
1442 # You may also create channels on startup by using the <permchannels> block.
1443 # Don't forget to set them +P in the modes, or they won't stay permanent.
1444 #<permchannels channel="#opers" modes="isP" topic="Opers only.">
1446 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1447 # PostgreSQL module: Allows other SQL modules to access PgSQL databases
1448 # through a unified API.
1449 # This module is in extras. Re-run configure with:
1450 # ./configure --enable-extras=m_pgsql.cpp
1451 # and run make install, then uncomment this module to enable it.
1452 #<module name="pgsql">
1454 #-#-#-#-#-#-#-#-#-#-#-#- SQL CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#-#
1456 # pgsql is more complex than described here, see the wiki for #
1457 # more: http://wiki.inspircd.org/Modules/pgsql #
1459 #<database module="pgsql" name="mydb" user="myuser" pass="mypass" host="localhost" id="my_database" ssl="no">
1461 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1462 # Muteban: Implements extended ban 'm', which stops anyone matching
1463 # a mask like +b m:nick!user@host from speaking on channel.
1464 #<module name="muteban">
1466 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1467 # Random quote module: Provides a random quote on connect.
1468 # NOTE: Some of these may mimic fatal errors and confuse users and
1469 # opers alike - BEWARE!
1470 #<module name="randquote">
1472 #-#-#-#-#-#-#-#-#-#- RANDOMQUOTES CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
1474 # Optional - If you specify to use the randquote module, then specify #
1475 # below the path to the quotes file. #
1477 #<randquote file="quotes.txt">
1479 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1480 # Redirect module: Adds channel redirection mode +L. #
1481 # Optional: <redirect:antiredirect> to add usermode +L to stop forced #
1482 # redirection and instead print an error. #
1484 # Note: You can not update this with a simple rehash, it requires #
1485 # reloading the module for it to take effect. #
1486 # This also breaks linking to servers that do not have the option. #
1487 # This defaults to false for the 2.0 version, it will be enabled in #
1488 # all the future versions. #
1489 #<module name="redirect">
1490 #<redirect antiredirect="true">
1492 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1493 # Regular expression provider for glob or wildcard (?/*) matching.
1494 # You must have at least 1 provider loaded to use the filter or rline
1495 # modules. This module has no additional requirements, as it uses the
1496 # matching already present in InspIRCd core.
1497 #<module name="regex_glob">
1499 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1500 # Regular expression provider for PCRE (Perl-Compatible Regular
1501 # Expressions). You need libpcre installed to compile and load this
1502 # module. You must have at least 1 provider loaded to use the filter or
1504 #<module name="regex_pcre">
1506 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1507 # Regular Expression Provider for RE2 Regular Expressions.
1508 # You need libre2 installed and in your include/library paths in order
1509 # to compile and load this module.
1510 #<module name="regex_re2">
1512 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1513 # Regular expression provider for POSIX regular expressions.
1514 # You shouldn't need any additional libraries on a POSIX-compatible
1515 # system (i.e.: any Linux, BSD, but not Windows). You must have at
1516 # least 1 provider loaded to use filter or rline.
1517 # On POSIX-compliant systems, regex syntax can be found by using the
1518 # command: 'man 7 regex'.
1519 #<module name="regex_posix">
1521 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1522 # Regular expression provider for C++11 std::regex regular expressions.
1523 # This module works on any fully compliant implementation of the C++11
1524 # std::regex container. Examples for such are Visual C++ 2010 and newer
1525 # but not libstdc++ (which GCC uses).
1526 # You should verify that std::regex is supported by your setup before
1527 # using this module, as it may compile normally but won't do anything
1528 # on some implementations.
1529 #<module name="regex_stdlib">
1531 # Specify the regular expression engine to use here. Valid settings are
1532 # bre, ere, awk, grep, egrep, ecmascript (default if not specified).
1533 #<stdregex type="ecmascript">
1535 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1536 # Regular expression provider for TRE regular expressions.
1537 # This is the same regular expression engine used by UnrealIRCd, so
1538 # if you are most familiar with the syntax of /SPAMFILTER from there,
1539 # this is the provider you want. You need libtre installed in order
1540 # to compile and load this module.
1541 #<module name="regex_tre">
1543 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1544 # Registered users only channel creation module. If enabled, only
1545 # registered users and opers can create new channels.
1547 # You probably *DO NOT* want to load this module on a public network.
1549 #<module name="regonlycreate">
1551 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1552 # Remove module: Adds the /REMOVE command which is a peaceful
1553 # alternative to /KICK.
1554 #<module name="remove">
1556 # supportnokicks: If true, /REMOVE is not allowed on channels where the
1557 # nokicks (+Q) mode is set. Defaults to false.
1558 # protectedrank: Members having this rank or above may not be /REMOVE'd
1559 # by anyone. Set to 0 to disable this feature. Defaults to 50000.
1560 #<remove supportnokicks="true" protectedrank="50000">
1562 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1563 # A module to block, kick or ban upon similar messages being uttered several times.
1564 # Syntax [~*][lines]:[sec]{[:difference]}{[:matchlines]}
1565 # ~ is to block, * is to ban, default is kick.
1566 # lines - In mode 1 the amount of lines that has to match consecutively - In mode 2 the size of the backlog to keep for matching
1567 # seconds - How old the message has to be before it's invalidated.
1568 # distance - Edit distance, in percent, between two strings to trigger on.
1569 # matchlines - When set, the function goes into mode 2. In this mode the function will trigger if this many of the last <lines> matches.
1571 # As this module can be rather CPU-intensive, it comes with some options.
1572 # maxbacklog - Maximum size that can be specified for backlog. 0 disables multiline matching.
1573 # maxdistance - Max percentage of difference between two lines we'll allow to match. Set to 0 to disable edit-distance matching.
1574 # maxlines - Max lines of backlog to match against.
1575 # maxsecs - Maximum value of seconds a user can set. 0 to allow any.
1576 # size - Maximum number of characters to check for, can be used to truncate messages
1577 # before they are checked, resulting in less CPU usage. Increasing this beyond 512
1578 # doesn't have any effect, as the maximum length of a message on IRC cannot exceed that.
1579 #<repeat maxbacklog="20" maxlines="20" maxdistance="50" maxsecs="0" size="512">
1580 #<module name="repeat">
1582 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1583 # Restricted channels module: Allows only opers to create channels.
1585 # You probably *DO NOT* want to load this module on a public network.
1587 #<module name="restrictchans">
1589 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1590 # Restrict message module: Allows users to only message opers.
1592 # You probably *DO NOT* want to load this module on a public network.
1594 #<module name="restrictmsg">
1596 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1597 # R-Line module: Ban users through regular expression patterns.
1598 #<module name="rline">
1600 #-#-#-#-#-#-#-#-#-#-#-#- RLINE CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#-#
1602 # If you wish to re-check a user when they change nickname (can be
1603 # useful under some situations, but *can* also use CPU with more users
1604 # on a server) then set 'matchonnickchange' to yes.
1605 # Also, this is where you set what Regular Expression engine is to be
1606 # used. If you ever change it while running, all of your R-Lines will
1607 # be wiped. This is the regex engine used by all R-Lines set, and
1608 # regex_<engine> must be loaded, or rline will be non-functional
1609 # until you load it or change the engine to one that is loaded.
1611 #<rline matchonnickchange="yes" engine="pcre">
1613 # Generally, you will NOT want to use 'glob' here, as this turns
1614 # rline into just another gline. The exceptions are that rline will
1615 # always use the full "nick!user@host realname" string, rather than only
1616 # user@host, but beware that only the ? and * wildcards are available,
1617 # and are the only way to specify where the space can occur if you do
1618 # use glob. For this reason, is recommended to use a real regex engine
1619 # so that at least \s or [[:space:]] is available.
1621 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1622 # RMODE module: Adds the /RMODE command
1623 # Allows channel mods to remove list modes en masse.
1624 # Syntax: /rmode <channel> <mode> [pattern]
1625 # E.g. '/rmode #Channel b m:*' will remove all mute-extbans on the channel.
1626 #<module name="rmode">
1628 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1629 # SAJOIN module: Adds the /SAJOIN command which forcibly joins a user
1630 # to the given channel.
1631 # This module is oper-only.
1632 # To use, SAJOIN must be in one of your oper class blocks.
1633 # Opers need the users/sajoin-others priv to be able to /SAJOIN users
1634 # other than themselves.
1635 #<module name="sajoin">
1637 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1638 # SAKICK module: Adds the /SAKICK command which kicks a user from the
1640 # This module is oper-only.
1641 # To use, SAKICK must be in one of your oper class blocks.
1642 #<module name="sakick">
1644 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1645 # SAMODE module: Adds the /SAMODE command which allows server operators
1646 # to change modes on a channel without requiring them to have any
1647 # channel priviliges. Also allows changing user modes for any user.
1648 # This module is oper-only.
1649 # To use, SAMODE must be in one of your oper class blocks.
1650 #<module name="samode">
1652 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1653 # SANICK module: Adds the /SANICK command which allows opers to change
1655 # This module is oper-only.
1656 # To use, SANICK must be in one of your oper class blocks.
1657 #<module name="sanick">
1659 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1660 # SAPART module: Adds the /SAPART command which forcibly parts a user
1662 # This module is oper-only.
1663 # To use, SAPART must be in one of your oper class blocks.
1664 #<module name="sapart">
1666 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1667 # SAQUIT module: Adds the /SAQUIT command which forcibly quits a user.
1668 # This module is oper-only.
1669 # To use, SAQUIT must be in one of your oper class blocks.
1670 #<module name="saquit">
1672 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1673 # SATOPIC module: Adds the /SATOPIC command which allows changing the
1674 # topic on a channel without requiring any channel priviliges.
1675 # This module is oper-only.
1676 # To use, SATOPIC must be in one of your oper class blocks.
1677 #<module name="satopic">
1679 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1680 # SASL authentication module: Provides support for IRC Authentication
1681 # Layer via AUTHENTICATE. Note: You also need to have cap loaded
1683 #<module name="sasl">
1685 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1686 # Secure list module: Prevent /LIST in the first minute of connection,
1687 # crippling most spambots and trojan spreader bots.
1688 #<module name="securelist">
1690 #-#-#-#-#-#-#-#-#-# SECURELIST CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#-#
1692 # Securelist can be harmful to some IRC search engines such as #
1693 # netsplit.de and searchirc.com. To prevent securelist blocking these #
1694 # sites from listing, define exception tags as shown below: #
1695 #<securehost exception="*@*.searchirc.org">
1696 #<securehost exception="*@*.netsplit.de">
1697 #<securehost exception="*@echo940.server4you.de">
1698 #<securehost exception="*@*.ircdriven.com">
1700 # Define the following variable to change how long a user must wait #
1701 # before issuing a LIST. If not defined, defaults to 60 seconds. #
1703 #<securelist waittime="60"> #
1705 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1706 # Servprotect module: Provides support for Austhex style +k /
1707 # UnrealIRCD +S services mode.
1708 #<module name="servprotect">
1710 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1711 # See nicks module: Adds snomask +n and +N which show local and remote
1713 # This module is oper-only.
1714 #<module name="seenicks">
1716 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1717 # Set idle module: Adds a command for opers to change their idle time.
1718 # This module is oper-only.
1719 # To use, SETIDLE must be in one of your oper class blocks.
1720 #<module name="setidle">
1722 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1723 # Services support module: Adds several usermodes such as +R and +M.
1724 # This module implements the 'identified' state via account names,
1725 # and is similar in operation to the way asuka and ircu handle services.
1727 # At the same time, this offers +r for users and channels to mark them
1728 # as identified separately from the idea of a master account, which
1729 # can be useful for services which are heavily nick-as-account centric.
1731 # Also of note is that this module implements two extbans:
1732 # +b R: (stop matching account names from joining)
1733 # +b U:n!u@h (blocks matching unregistered users)
1735 #<module name="services_account">
1737 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1738 # Sethost module: Adds the /SETHOST command.
1739 # This module is oper-only.
1740 # To use, SETHOST must be in one of your oper class blocks.
1741 # See the chghost module for how to customise valid chars for hostnames.
1742 #<module name="sethost">
1744 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1745 # Setident module: Adds the /SETIDENT command.
1746 # This module is oper-only.
1747 # To use, SETIDENT must be in one of your oper class blocks.
1748 #<module name="setident">
1750 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1751 # SETNAME module: Adds the /SETNAME command.
1752 #<module name="setname">
1754 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1755 # Serverban: Implements extended ban 's', which stops anyone connected
1756 # to a server matching a mask like +b s:server.mask.here from joining.
1757 #<module name="serverban">
1759 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1760 # Showfile: Provides support for showing a text file to users when #
1761 # they enter a command. #
1762 # This module adds one command for each <showfile> tag that shows the #
1763 # given file to the user as a series of messages or numerics. #
1764 #<module name="showfile"> #
1766 #-#-#-#-#-#-#-#-#-#-# SHOWFILE CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#-#
1768 # name - The name of the command which displays this file. This is #
1769 # the only mandatory setting, all others are optional. #
1770 # file - The text file to be shown to the user. #
1771 # By default same as the command name. #
1772 # method - How should the file be shown? #
1773 # * numeric: Send contents using a numeric #
1774 # (similar to /MOTD; the default). #
1775 # * notice: Send contents as a series of notices. #
1776 # * msg: Send contents as a series of private messages. #
1777 # colors - If true, color codes (\c, \b, \u, etc.) will be processed #
1778 # and sent as ANSI colors. If false (default) the file will #
1779 # be displayed as-is. #
1781 # When using the method "numeric", the following extra settings are #
1784 # introtext - Introductory line, "Showing <name>" by default. #
1785 # intronumeric - Numeric used for the introductory line. #
1786 # numeric - Numeric used for sending the text itself. #
1787 # endtext - Ending line, "End of <name>" by default. #
1788 # endnumeric - Numeric used for the ending line. #
1790 #<showfile name="RULES"
1793 # introtext="Server rules:"
1794 # endtext="End of server rules.">
1796 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1797 # Show whois module: Adds the +W usermode which allows opers to see
1798 # when they are /WHOIS'd.
1799 # This module is oper-only by default.
1800 #<module name="showwhois">
1802 # If you wish, you may also let users set this mode. Only opers with the
1803 # users/auspex priv will see real hosts of people, though.
1804 #<showwhois opersonly="yes"
1806 # You may also set whether or not users should receive whois notices,
1807 # should they be /WHOIS'd by an oper.
1808 #showfromopers="yes">
1810 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1811 # Shun module: Provides the /SHUN command, which stops a user from
1812 # executing all except configured commands.
1813 # This module is oper-only.
1814 # To use, SHUN must be in one of your oper class blocks.
1815 #<module name="shun">
1817 # You may also configure which commands you wish a user to be able to
1818 # perform when shunned. It should be noted that if a shunned user
1819 # issues QUIT or PART then their message will be removed, as if they
1820 # did not issue one.
1822 # You can optionally let the user know that their command was blocked.
1824 # You may also let SHUN affect opers (defaults to no).
1825 #<shun enabledcommands="PING PONG QUIT PART JOIN" notifyuser="yes" affectopers="no">
1827 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1828 # SSL channel mode module: Adds support for SSL-only channels via
1829 # channel mode +z and the 'z' extban which matches SSL client
1830 # certificate fingerprints.
1831 # Does not do anything useful without a working SSL module (see below).
1832 #<module name="sslmodes">
1834 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1835 # GnuTLS SSL module: Adds support for SSL connections using GnuTLS,
1836 # if enabled. You must answer 'yes' in ./configure when asked or
1837 # manually symlink the source for this module from the directory
1838 # src/modules/extra, if you want to enable this, or it will not load.
1839 #<module name="ssl_gnutls">
1841 #-#-#-#-#-#-#-#-#-#-#- GNUTLS CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#
1843 # ssl_gnutls is too complex to describe here, see the wiki: #
1844 # http://wiki.inspircd.org/Modules/ssl_gnutls #
1846 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1847 # SSL info module: Allows users to retrieve information about other
1848 # users' peer SSL certificates and keys. This can be used by client
1849 # scripts to validate users. For this to work, one of ssl_gnutls
1850 # or ssl_openssl must be loaded. This module also adds the
1851 # "* <user> is using a secure connection" whois line, the ability for
1852 # opers to use SSL cert fingerprints to verify their identity and the
1853 # ability to force opers to use SSL connections in order to oper up.
1854 # It is highly recommended to load this module if you use SSL on your
1856 # For how to use the oper features, please see the first example <oper> tag
1857 # in opers.conf.example.
1859 #<module name="sslinfo">
1861 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1862 # OpenSSL SSL module: Adds support for SSL connections using OpenSSL,
1863 # if enabled. You must answer 'yes' in ./configure when asked or symlink
1864 # the source for this module from the directory src/modules/extra, if
1865 # you want to enable this, or it will not load.
1866 #<module name="ssl_openssl">
1868 #-#-#-#-#-#-#-#-#-#-#- OPENSSL CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#
1870 # ssl_openssl is too complex to describe here, see the wiki: #
1871 # http://wiki.inspircd.org/Modules/ssl_openssl #
1873 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1874 # Strip color module: Adds channel mode +S that strips color codes and
1875 # all control codes except CTCP from all messages sent to the channel.
1876 #<module name="stripcolor">
1878 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1879 # Silence module: Adds support for the /SILENCE command, which allows
1880 # users to have a server-side ignore list for their client.
1881 #<module name="silence">
1883 # Set the maximum number of entries allowed on a user's silence list.
1884 #<silence maxentries="32"
1886 # Whether messages from U-lined servers will bypass silence masks.
1889 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1890 # SQLite3 module: Allows other SQL modules to access SQLite3 #
1891 # databases through a unified API. #
1892 # This module is in extras. Re-run configure with: #
1893 # ./configure --enable-extras=m_sqlite.cpp
1894 # and run make install, then uncomment this module to enable it. #
1896 #<module name="sqlite3">
1898 #-#-#-#-#-#-#-#-#-#-#-#- SQL CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#-#
1900 # sqlite is more complex than described here, see the wiki for more #
1901 # info: http://wiki.inspircd.org/Modules/sqlite3 #
1903 #<database module="sqlite" hostname="/full/path/to/database.db" id="anytext">
1905 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1906 # SQL authentication module: Allows IRCd connections to be tied into
1907 # a database table (for example a forum).
1908 # This module is in extras. Re-run configure with:
1909 # ./configure --enable-extras=m_sqlauth.cpp
1910 # and run make install, then uncomment this module to enable it.
1912 #<module name="sqlauth">
1914 #-#-#-#-#-#-#-#-#-#-#- SQLAUTH CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#
1916 # sqlauth is too complex to describe here, see the wiki: #
1917 # http://wiki.inspircd.org/Modules/sqlauth #
1919 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1920 # SQL oper module: Allows you to store oper credentials in an SQL table
1921 # This module is in extras. Re-run configure with:
1922 # ./configure --enable-extras=m_sqloper.cpp
1923 # and run make install, then uncomment this module to enable it.
1925 #<module name="sqloper">
1927 #-#-#-#-#-#-#-#-#-#-#- SQLOPER CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#
1929 # dbid - Database ID to use (see SQL modules). #
1930 # hash - Hashing provider to use for password hashing. #
1932 # See also: http://wiki.inspircd.org/Modules/sqloper #
1934 #<sqloper dbid="1" hash="md5">
1936 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1937 # StartTLS module: Implements STARTTLS, which allows clients #
1938 # connected to non SSL enabled ports to enable SSL, if a proper SSL #
1939 # module is loaded (either ssl_gnutls or ssl_openssl). #
1940 #<module name="starttls">
1942 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1943 # SVSHold module: Implements SVSHOLD. Like Q:Lines, but can only be #
1944 # added/removed by Services. #
1945 #<module name="svshold">
1946 # SVSHOLD does not generate server notices by default, you can turn
1947 # notices on by uncommenting the next line.
1948 #<svshold silent="false">
1950 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1951 # SWHOIS module: Allows you to add arbitrary lines to user WHOIS.
1952 # This module is oper-only.
1953 # To use, SWHOIS must be in one of your oper class blocks.
1954 #<module name="swhois">
1956 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1957 # Timed bans module: Adds timed channel bans with the /TBAN command.
1958 #<module name="timedbans">
1960 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1961 # Test line module: Adds the /TLINE command, used to test how many
1962 # users a /GLINE or /ZLINE etc. would match.
1963 # This module is oper-only.
1964 # To use, TLINE must be in one of your oper class blocks.
1965 #<module name="tline">
1967 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1968 # Topiclock module: implements server-side topic locking to achieve deeper
1969 # integration with services packages.
1970 #<module name="topiclock">
1972 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1973 # UHNAMES support module: Adds support for the IRCX style UHNAMES
1974 # extension, which displays ident and hostname in the names list for
1975 # each user, saving clients from doing a WHO on the channel.
1976 # If a client does not support UHNAMES it will not enable it, this will
1977 # not break incompatible clients.
1978 #<module name="uhnames">
1980 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1981 # Uninvite module: Adds the /UNINVITE command which lets users remove
1982 # pending invites from channels without waiting for the user to join.
1983 #<module name="uninvite">
1985 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1986 # Userip module: Adds the /USERIP command.
1987 # Allows users to query their own IP, also allows opers to query the IP
1989 #<module name="userip">
1991 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1992 # Vhost module: Adds the VHOST command which allows for adding virtual
1993 # hosts which are accessible using a username and password in the config.
1994 #<module name="vhost">
1996 #-#-#-#-#-#-#-#-#-#-#- VHOST CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#-#
1998 # user - Username for the vhost. #
2000 # pass - Password for the vhost. #
2002 # hash - The hash for the specific user (optional) #
2003 # password_hash and a hashing module must be loaded for #
2006 # host - Vhost to set. #
2008 #<vhost user="some_username" pass="some_password" host="some.host.test.cc">
2009 #<vhost user="foo" password="fcde2b2edba56bf408601fb721fe9b5c338d10ee429ea04fae5511b68fbf8fb9" hash="sha256" host="some.other.host.example.com">
2011 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2012 # Watch module: Adds the WATCH command, which is used by clients to
2013 # maintain notify lists.
2014 #<module name="watch">
2016 # Set the maximum number of entries on a user's watch list below.
2017 #<watch maxentries="32">
2019 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2020 # XLine database: Stores all *Lines (G/Z/K/R/any added by other modules)
2021 # in a file which is re-loaded on restart. This is useful
2022 # for two reasons: it keeps bans so users may not evade them, and on
2023 # bigger networks, server connections will take less time as there will
2024 # be a lot less bans to apply - as most of them will already be there.
2025 #<module name="xline_db">
2027 # Specify the filename for the xline database here.
2028 #<xlinedb filename="data/xline.db">
2030 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2031 # ____ _ _____ _ _ ____ _ _ _ #
2032 # | _ \ ___ __ _ __| | |_ _| |__ (_)___ | __ )(_) |_| | #
2033 # | |_) / _ \/ _` |/ _` | | | | '_ \| / __| | _ \| | __| | #
2034 # | _ < __/ (_| | (_| | | | | | | | \__ \ | |_) | | |_|_| #
2035 # |_| \_\___|\__,_|\__,_| |_| |_| |_|_|___/ |____/|_|\__(_) #
2037 # To link servers to InspIRCd, you MUST load the spanningtree module. #
2038 # If you don't do this, server links will NOT work at all. #
2039 # This is by design, to allow for the implementation of other linking #
2040 # protocols in modules in the future. #
2042 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2043 # Spanning tree module: Allows linking of servers using the spanning
2044 # tree protocol (see the READ THIS BIT section above).
2045 # You will almost always want to load this.
2047 #<module name="spanningtree">