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 - How many percent of text must be caps before text #
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 #<module name="hostcycle">
883 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
884 # httpd module: Provides HTTP server support for InspIRCd.
885 #<module name="httpd">
887 #-#-#-#-#-#-#-#-#-#-#-#- HTTPD CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
889 # If you choose to use the httpd module, then you will need to add
890 # a <bind> tag with type "httpd", and load at least one of the other
891 # httpd_* modules to provide pages to display.
893 # You can adjust the timeout for HTTP connections below. All HTTP
894 # connections will be closed after (roughly) this many seconds.
895 #<httpd timeout="20">
897 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
898 # HTTP ACL module: Provides access control lists for httpd dependent
899 # modules. Use this module to restrict pages by IP address and by
901 #<module name="httpd_acl">
903 #-#-#-#-#-#-#-#-#-#-#-#- HTTPD ACL CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
905 # Restrict access to the httpd_stats module to all but the local
906 # network and when the correct password is specified:
907 # <httpdacl path="/stats*" types="password,whitelist"
908 # username="secrets" password="mypasshere" whitelist="127.0.0.*,10.*">
910 # Deny all connections to all but the main index page:
911 # <httpdacl path="/*" types="blacklist" blacklist="*">
913 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
914 # HTTP config module: Allows the configuration of the server to be
915 # viewed over HTTP. Requires httpd to be loaded for it to function.
916 #<module name="httpd_config">
918 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
919 # HTTP stats module: Provides basic stats pages over HTTP.
920 # Requires httpd to be loaded for it to function.
921 #<module name="httpd_stats">
923 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
924 # Ident: Provides RFC 1413 ident lookup support.
925 # When this module is loaded <connect:allow> tags may have an optional
926 # useident="yes|no" boolean value, determining whether or not to lookup
927 # ident on users matching that connect tag.
928 #<module name="ident">
930 #-#-#-#-#-#-#-#-#-#-#-#- IDENT CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
932 # Optional - If you are using the ident module, then you can specify #
933 # the timeout for ident lookups here. If not defined, it will default #
934 # to 5 seconds. This is a non-blocking timeout which holds the user #
935 # in a 'connecting' state until the lookup is complete. #
936 # The bind value indicates which IP to bind outbound requests to. #
937 # nolookupprefix: If on, the idents of users being in a connect class #
938 # with ident lookups disabled (i.e. <connect useident="off">) will be #
939 # prefixed with a "~". If off, the ident of those users will not be #
940 # prefixed. Default is off. #
942 #<ident timeout="5" nolookupprefix="no">
944 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
945 # Invite exception module: Adds support for channel invite exceptions
947 #<module name="inviteexception">
948 # bypasskey: If this is enabled, exceptions will bypass +k as well as +i
949 #<inviteexception bypasskey="yes">
951 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
952 # IRCv3 module: Provides the following IRCv3.1 extensions:
953 # extended-join, away-notify and account-notify. These are optional
954 # enhancements to the client-to-server protocol. An extension is only
955 # active for a client when the client specifically requests it, so this
956 # module needs the cap module to work.
958 # Further information on these extensions can be found at the IRCv3
959 # working group website:
960 # http://ircv3.org/extensions/
962 #<module name="ircv3">
963 # The following block can be used to control which extensions are
964 # enabled. Note that extended-join can be incompatible with delayjoin
966 #<ircv3 accountnotify="on" awaynotify="on" extendedjoin="on">
968 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
969 # Join flood module: Adds support for join flood protection +j X:Y.
970 # Closes the channel for 60 seconds if X users join in Y seconds.
971 #<module name="joinflood">
973 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
974 # Jump server module: Adds support for the RPL_REDIR numeric.
975 # This module is oper-only.
976 # To use, JUMPSERVER must be in one of your oper class blocks.
977 # If your server is redirecting new clients and you get disconnected,
978 # do a REHASH from shell to open up again.
979 #<module name="jumpserver">
981 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
982 # Anti auto rejoin: Adds support for prevention of auto-rejoin (+J).
983 #<module name="kicknorejoin">
985 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
986 # Knock module: Adds the /KNOCK command and channel mode +K.
987 #<module name="knock">
989 # This setting specifies what to do when someone successfully /KNOCKs.
990 # If set to "notice", then a NOTICE will be sent to the channel.
991 # This is the default and the compatible setting, as it requires no
992 # special support from the clients.
993 # If set to "numeric" then a 710 numeric will be sent to the channel.
994 # This allows easier scripting but not all clients support it.
995 # If set to "both" then (surprise!) both will be sent.
996 #<knock notify="notice">
998 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
999 # LDAP module: Allows other SQL modules to access a LDAP database
1000 # through a unified API.
1001 # This modules is in extras. Re-run configure with:
1002 # ./configure --enable-extras=m_ldap.cpp
1003 # and run make install, then uncomment this module to enable it.
1005 #<module name="ldap">
1006 #<database module="ldap" id="ldapdb" server="ldap://localhost" binddn="cn=Manager,dc=inspircd,dc=org" bindauth="mysecretpass" searchscope="subtree">
1007 # The server parameter indicates the LDAP server to connect to. The #
1008 # ldap:// style scheme before the hostname proper is MANDATORY. #
1010 # The binddn and bindauth indicate the DN to bind to for searching, #
1011 # and the password for the distinguished name. Some LDAP servers will #
1012 # allow anonymous searching in which case these two values do not #
1013 # need defining, otherwise they should be set similar to the examples #
1016 # The searchscope value indicates the subtree to search under. On our #
1017 # test system this is 'subtree'. Your mileage may vary. #
1019 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1020 # LDAP authentication module: Adds the ability to authenticate users #
1022 #<module name="ldapauth">
1026 # <ldapauth dbid="ldapdb" #
1027 # baserdn="ou=People,dc=brainbox,dc=cc" #
1029 # allowpattern="Guest* Bot*" #
1030 # killreason="Access denied" #
1032 # host="$uid.$ou.inspircd.org"> #
1034 # <ldapwhitelist cidr="10.42.0.0/16"> #
1036 # <ldaprequire attribute="attr" value="val"> #
1038 # The baserdn indicates the base DN to search in for users. Usually #
1039 # this is 'ou=People,dc=yourdomain,dc=yourtld'. #
1041 # The attribute value indicates the attribute which is used to locate #
1042 # a user account by name. On POSIX systems this is usually 'uid'. #
1044 # The allowpattern value allows you to specify a space separated list #
1045 # of wildcard masks which will always be allowed to connect #
1046 # regardless of if they have an account, for example guest and bot #
1049 # Killreason indicates the QUIT reason to give to users if they fail #
1050 # to authenticate. #
1052 # Setting the verbose value causes an oper notice to be sent out for #
1053 # every failed authentication to the server, with an error string. #
1055 # ldapwhitelist indicates that clients connecting from an IP in the #
1056 # provided CIDR do not need to authenticate against LDAP. It can be #
1057 # repeated to whitelist multiple CIDRs. #
1059 # ldaprequire allows further filtering on the LDAP user, by requiring #
1060 # certain LDAP attibutes to have a given value. It can be repeated, #
1061 # in which case the list will act as an OR list, that is, the #
1062 # authentication will succeed if any of the requirements in the list #
1065 # host allows you to change the displayed host of users connecting #
1066 # from ldap. The string supplied takes formatters which are replaced #
1067 # from the DN. For instance, if your DN looks like: #
1068 # uid=w00t,ou=people,dc=inspircd,dc=org, then the formatters uid, ou #
1069 # and dc will be available to you. If a key is given multiple times #
1070 # in the DN, the last appearance will take precedence. #
1072 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1073 # LDAP oper configuration module: Adds the ability to authenticate #
1075 #<module name="ldapoper">
1079 # <ldapoper dbid="ldapdb"
1080 # baserdn="ou=People,dc=brainbox,dc=cc"
1083 # Available configuration items are identical to the same items in #
1084 # ldapauth above (except for the verbose setting, that is only #
1085 # supported in ldapauth). #
1086 # Please always specify a password in your <oper> tags even if the #
1087 # opers are to be authenticated via LDAP, so in case this module is #
1088 # not loaded the oper accounts are still protected by a password. #
1090 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1091 # Lock server module: Adds /LOCKSERV and /UNLOCKSERV commands that #
1092 # are used to temporarily close/open the server for new connections. #
1093 # These commands require that the /LOCKSERV and /UNLOCKSERV commands #
1094 # are specified in a <class> tag that the oper is part of. This is so #
1095 # you can control who has access to this possible dangerous command. #
1096 # If your server is locked and you get disconnected, do a REHASH from #
1097 # shell to open up again. #
1098 # This module is oper-only.
1099 #<module name="lockserv">
1101 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1102 # Map hiding module: replaces /MAP and /LINKS output to users with a #
1103 # message to see a website, set by maphide="http://test.org/map" in #
1104 # the <security> tag, instead. #
1105 #<module name="maphide">
1107 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1108 # Message flood module: Adds message/notice flood protection via
1110 #<module name="messageflood">
1112 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1113 # MLOCK module: Adds support for server-side enforcement of services
1114 # side MLOCKs. Basically, this module suppresses any mode change that
1115 # would likely be immediately bounced by services.
1116 #<module name="mlock">
1118 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1119 # Modenotice module: Adds the /MODENOTICE command that allows opers to
1120 # send notices to all users having the given user mode(s) set.
1121 #<module name="modenotice">
1123 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1124 # MsSQL module: Allows other SQL modules to access MS SQL Server
1125 # through a unified API.
1126 # This module is in extras. Re-run configure with:
1127 # ./configure --enable-extras=m_mssql.cpp
1128 # and run make install, then uncomment this module to enable it.
1129 #<module name="mssql">
1131 #-#-#-#-#-#-#-#-#-#-#-#- SQL CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#-#
1133 # mssql is more complex than described here, see the wiki for more #
1134 # info http://wiki.inspircd.org/Modules/mssql #
1136 #<database module="mssql" name="db" user="user" pass="pass" host="localhost" id="db1">
1138 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1139 # MySQL module: Allows other SQL modules to access MySQL databases
1140 # through a unified API.
1141 # This module is in extras. Re-run configure with:
1142 # ./configure --enable-extras=m_mysql.cpp
1143 # and run make install, then uncomment this module to enable it.
1144 #<module name="mysql">
1146 #-#-#-#-#-#-#-#-#-#-#-#- SQL CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#-#
1148 # mysql is more complex than described here, see the wiki for more #
1149 # info: http://wiki.inspircd.org/Modules/mysql #
1151 #<database module="mysql" name="mydb" user="myuser" pass="mypass" host="localhost" id="my_database2">
1153 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1154 # Named modes module: Allows for the display and set/unset of channel
1155 # modes via long-form mode names via +Z and the /PROP command.
1156 # For example, to set a ban, do /mode #channel +Z ban=foo!bar@baz or
1157 # /PROP #channel ban=foo!bar@baz
1158 #<module name="namedmodes">
1160 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1161 # NAMESX module: Provides support for the NAMESX extension which allows
1162 # clients to see all the prefixes set on a user without getting confused.
1163 # This is supported by mIRC, x-chat, klient, and maybe more.
1164 #<module name="namesx">
1166 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1167 # National characters module:
1168 # 1) Allows using national characters in nicknames.
1169 # 2) Allows using custom (national) casemapping over the network.
1170 #<module name="nationalchars">
1172 # file - filename of existing file in "locales" directory
1173 # casemapping - custom value for 005 numeric (if you want it to be
1174 # different from the filename). Set this to the name of
1175 # the locale if you are specifying an absolute path.
1176 #<nationalchars file="bynets/russian-w1251-charlink" casemapping="ru_RU.cp1251-charlink">
1178 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1179 # Nickchange flood protection module: Provides channel mode +F X:Y
1180 # which allows up to X nick changes in Y seconds.
1181 #<module name="nickflood">
1183 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1184 # Nicklock module: Let opers change a user's nick and then stop that
1185 # user from changing their nick again until unlocked.
1186 # This module is oper-only.
1187 # To use, NICKLOCK and NICKUNLOCK must be in one of your oper class blocks.
1188 #<module name="nicklock">
1190 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1191 # No CTCP module: Adds the channel mode +C to block CTCPs and extban
1192 # 'C' to block CTCPs sent by specific users.
1193 #<module name="noctcp">
1195 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1196 # No kicks module: Adds the +Q channel mode and the Q: extban to deny
1197 # certain users from kicking.
1198 #<module name="nokicks">
1200 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1201 # No nicks module: Adds the +N channel mode, as well as the 'N' extban.
1202 # +N stops all users from changing their nick, the N extban stops
1203 # anyone from matching a +b N:nick!user@host mask from changing their
1205 #<module name="nonicks">
1207 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1208 # No part message module: Adds extban 'p' to block part messages from #
1210 #<module name="nopartmsg">
1212 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1213 # No notice module: Adds the channel mode +T and the extban 'T' to
1214 # block specific users from noticing the channel.
1215 #<module name="nonotice">
1217 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1218 # Network business join module:
1219 # Allows an oper to join a channel using /OJOIN, giving them +Y on the
1220 # channel which makes them immune to kick/deop/etc.
1221 #<module name="ojoin">
1223 # Specify the prefix that +Y will grant here.
1224 # Leave 'prefix' empty if you do not wish +Y to grant a prefix.
1225 # If 'notice' is set to on, upon /OJOIN, the server will notice the
1226 # channel saying that the oper is joining on network business.
1227 # If 'op' is set to on, it will give them +o along with +Y.
1228 #<ojoin prefix="!" notice="yes" op="yes">
1230 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1231 # Oper channels mode: Adds the +O channel mode and extban O:<mask>
1232 # to ban, except, etc. specific oper types. For example
1233 # /mode #channel +iI O:* is equivalent to channel mode +O, but you
1234 # may also set +iI O:AdminTypeOnly to only allow admins.
1235 # Modes +I and +e work in a similar fashion.
1236 #<module name="operchans">
1238 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1239 # Oper join module: Auto-joins opers to a channel upon oper-up.
1240 # This module is oper-only. For the user equivalent, see the conn_join
1242 #<module name="operjoin">
1244 #-#-#-#-#-#-#-#-#-#-# OPERJOIN CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
1246 # If you are using the operjoin module, specify options here: #
1248 # channel - The channel name to join, can also be a comma #
1249 # separated list e.g. "#channel1,#channel2". #
1251 # override - If on, lets the oper join walking thru any modes #
1252 # that might be set, even bans. #
1254 #<operjoin channel="#channel" override="no">
1256 # Alternatively you can use the autojoin="channellist" in a <type> #
1257 # tag to set specific autojoins for a type of oper, for example: #
1259 #<type name="Helper" autojoin="#help" classes="...">
1261 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1262 # Oper log module: Logs all oper commands to the server log (with log
1263 # type "m_operlog" at default loglevel), and optionally to the 'r'
1265 # This module is oper-only.
1266 #<module name="operlog">
1268 # If the following option is on then all oper commands will be sent to
1269 # the snomask 'r'. The default is off.
1270 #<operlog tosnomask="off">
1272 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1273 # Oper prefixing module: Adds a channel prefix mode +y which is given
1274 # to all IRC operators automatically on all channels they are in.
1275 # This prefix mode is more powerful than channel op and other regular
1278 # Load this module if you want all your IRC operators to have channel
1280 #<module name="operprefix">
1282 # You may additionally customise the prefix character.
1283 #<operprefix prefix="!">
1285 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1286 # Oper MOTD module: Provides support for separate message of the day
1288 # This module is oper-only.
1289 #<module name="opermotd">
1291 #-#-#-#-#-#-#-#-#-#-# OPERMOTD CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
1293 # If you are using the opermotd module, specify the motd here. #
1295 # onoper - If on, the message is sent on /OPER, otherwise it's #
1296 # only sent when /OPERMOTD is used. #
1298 # processcolors - Allow color codes to be processed in the opermotd. #
1299 # Read the comment above <connect:allowmotdcolors> in #
1300 # inspircd.conf.example for details. #
1302 #<opermotd file="examples/opermotd.txt.example" onoper="yes" processcolors="false">
1304 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1305 # Override module: Adds support for oper override.
1306 # This module is oper-only.
1307 #<module name="override">
1309 #-#-#-#-#-#-#-#-#-#-# OVERRIDE CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
1311 # override is too complex it describe here, see the wiki: #
1312 # http://wiki.inspircd.org/Modules/override #
1314 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1315 # Oper levels module: Gives each oper a level and prevents actions
1316 # being taken by lower level opers against higher level opers.
1317 # Specify the level as the 'level' parameter of the <type> tag.
1318 # This module is oper-only.
1319 #<module name="operlevels">
1321 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1322 # Oper modes module: Allows you to specify modes to add/remove on oper.
1323 # Specify the modes as the 'modes' parameter of the <type> tag
1324 # and/or as the 'modes' parameter of the <oper> tag.
1325 # This module is oper-only. For the user equivalent, see the
1326 # conn_umodes module.
1327 #<module name="opermodes">
1329 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1330 # Password forwarding module: Forwards a password users can send on
1331 # connect to the specified client below. The client is usually NickServ
1332 # and this module is usually used to authenticate users with NickServ
1333 # using their connect password.
1334 #<module name="passforward">
1337 # nick: nick to forward connect passwords to.
1340 # forwardmsg: Message to send to users using a connect password.
1341 # $nick will be the users' nick, $nickrequired will be the nick
1342 # of where the password is going (the nick above).
1343 # You can also use $user for the user ident string.
1344 forwardmsg="NOTICE $nick :*** Forwarding PASS to $nickrequired"
1346 # cmd: Command for the user to run when it receives a connect
1348 cmd="PRIVMSG $nickrequired :IDENTIFY $pass">
1350 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1351 # Password hash module: Allows hashed passwords to be used.
1352 # To be useful, a hashing module like sha256 also needs to be loaded.
1353 #<module name="password_hash">
1355 #-#-#-#-#-#-#-#-#-# PASSWORD HASH CONFIGURATION #-#-#-#-#-#-#-#-#-#-#-#
1357 # To use this module, you must define a hash type for each oper's
1358 # password you want to hash. For example:
1360 # <oper name="Brain"
1361 # host="ident@dialup15.isp.test.com"
1363 # password="01ba4719c80b6fe911b091a7c05124b64eeece964e09c058ef8f9805daca546b"
1366 # Starting from 2.0, you can use a more secure salted hash that prevents simply
1367 # looking up the hash's value in a rainbow table built for the hash.
1368 # hash="hmac-sha256" password="lkS1Nbtp$CyLd/WPQXizsbxFUTqFRoMvaC+zhOULEeZaQkUJj+Gg"
1370 # Generate hashes using the /MKPASSWD command on the server.
1371 # Don't run it on a server you don't trust with your password.
1373 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1374 # PBKDF2 module: Allows other modules to generate PBKDF2 hashes,
1375 # usually for cryptographic uses and security.
1376 # This module relies on other hash providers (e.g. SHA256).
1377 #<module name="pbkdf2">
1379 # iterations: Iterations the hashing function runs when generating new
1381 # length: Length in bytes of the derived key.
1382 #<pbkdf2 iterations="12288" length="32">
1383 # You can override these values with specific values
1384 # for specific providers if you want to. Example given for SHA256.
1385 #<pbkdf2prov hash="sha256" iterations="24576">
1387 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1388 # Permanent channels module: Channels with the permanent channel mode
1389 # will remain open even after everyone else has left the channel, and
1390 # therefore keep things like modes, ban lists and topic. Permanent
1391 # channels -may- need support from your Services package to function
1392 # properly with them. This adds channel mode +P.
1393 # This module is oper-only.
1394 #<module name="permchannels">
1396 # If you like, this module can write a config file of permanent channels
1397 # whenever +P is set, unset, or the topic/modes on a +P channel is changed.
1398 # If you want to do this, set the filename below, and uncomment the include.
1400 # If 'listmodes' is true then all list modes (+b, +I, +e, +g...) will be
1401 # saved. Defaults to false.
1402 #<permchanneldb filename="permchannels.conf" listmodes="true">
1403 #<include file="permchannels.conf">
1405 # You may also create channels on startup by using the <permchannels> block.
1406 # Don't forget to set them +P in the modes, or they won't stay permanent.
1407 #<permchannels channel="#opers" modes="isP" topic="Opers only.">
1409 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1410 # PostgreSQL module: Allows other SQL modules to access PgSQL databases
1411 # through a unified API.
1412 # This module is in extras. Re-run configure with:
1413 # ./configure --enable-extras=m_pgsql.cpp
1414 # and run make install, then uncomment this module to enable it.
1415 #<module name="pgsql">
1417 #-#-#-#-#-#-#-#-#-#-#-#- SQL CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#-#
1419 # pgsql is more complex than described here, see the wiki for #
1420 # more: http://wiki.inspircd.org/Modules/pgsql #
1422 #<database module="pgsql" name="mydb" user="myuser" pass="mypass" host="localhost" id="my_database" ssl="no">
1424 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1425 # Muteban: Implements extended ban 'm', which stops anyone matching
1426 # a mask like +b m:nick!user@host from speaking on channel.
1427 #<module name="muteban">
1429 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1430 # Random quote module: Provides a random quote on connect.
1431 # NOTE: Some of these may mimic fatal errors and confuse users and
1432 # opers alike - BEWARE!
1433 #<module name="randquote">
1435 #-#-#-#-#-#-#-#-#-#- RANDOMQUOTES CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
1437 # Optional - If you specify to use the randquote module, then specify #
1438 # below the path to the quotes file. #
1440 #<randquote file="quotes.txt">
1442 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1443 # Redirect module: Adds channel redirection mode +L. #
1444 # Optional: <redirect:antiredirect> to add usermode +L to stop forced #
1445 # redirection and instead print an error. #
1447 # Note: You can not update this with a simple rehash, it requires #
1448 # reloading the module for it to take effect. #
1449 # This also breaks linking to servers that do not have the option. #
1450 # This defaults to false for the 2.0 version, it will be enabled in #
1451 # all the future versions. #
1452 #<module name="redirect">
1453 #<redirect antiredirect="true">
1455 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1456 # Regular expression provider for glob or wildcard (?/*) matching.
1457 # You must have at least 1 provider loaded to use the filter or rline
1458 # modules. This module has no additional requirements, as it uses the
1459 # matching already present in InspIRCd core.
1460 #<module name="regex_glob">
1462 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1463 # Regular expression provider for PCRE (Perl-Compatible Regular
1464 # Expressions). You need libpcre installed to compile and load this
1465 # module. You must have at least 1 provider loaded to use the filter or
1467 #<module name="regex_pcre">
1469 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1470 # Regular Expression Provider for RE2 Regular Expressions.
1471 # You need libre2 installed and in your include/library paths in order
1472 # to compile and load this module.
1473 #<module name="regex_re2">
1475 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1476 # Regular expression provider for POSIX regular expressions.
1477 # You shouldn't need any additional libraries on a POSIX-compatible
1478 # system (i.e.: any Linux, BSD, but not Windows). You must have at
1479 # least 1 provider loaded to use filter or rline.
1480 # On POSIX-compliant systems, regex syntax can be found by using the
1481 # command: 'man 7 regex'.
1482 #<module name="regex_posix">
1484 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1485 # Regular expression provider for C++11 std::regex regular expressions.
1486 # This module works on any fully compliant implementation of the C++11
1487 # std::regex container. Examples for such are Visual C++ 2010 and newer
1488 # but not libstdc++ (which GCC uses).
1489 # You should verify that std::regex is supported by your setup before
1490 # using this module, as it may compile normally but won't do anything
1491 # on some implementations.
1492 #<module name="regex_stdlib">
1494 # Specify the regular expression engine to use here. Valid settings are
1495 # bre, ere, awk, grep, egrep, ecmascript (default if not specified).
1496 #<stdregex type="ecmascript">
1498 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1499 # Regular expression provider for TRE regular expressions.
1500 # This is the same regular expression engine used by UnrealIRCd, so
1501 # if you are most familiar with the syntax of /SPAMFILTER from there,
1502 # this is the provider you want. You need libtre installed in order
1503 # to compile and load this module.
1504 #<module name="regex_tre">
1506 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1507 # Registered users only channel creation module. If enabled, only
1508 # registered users and opers can create new channels.
1510 # You probably *DO NOT* want to load this module on a public network.
1512 #<module name="regonlycreate">
1514 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1515 # Remove module: Adds the /REMOVE command which is a peaceful
1516 # alternative to /KICK.
1517 #<module name="remove">
1519 # supportnokicks: If true, /REMOVE is not allowed on channels where the
1520 # nokicks (+Q) mode is set. Defaults to false.
1521 # protectedrank: Members having this rank or above may not be /REMOVE'd
1522 # by anyone. Set to 0 to disable this feature. Defaults to 50000.
1523 #<remove supportnokicks="true" protectedrank="50000">
1525 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1526 # A module to block, kick or ban upon similar messages being uttered several times.
1527 # Syntax [~*][lines]:[sec]{[:difference]}{[:matchlines]}
1528 # ~ is to block, * is to ban, default is kick.
1529 # 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
1530 # seconds - How old the message has to be before it's invalidated.
1531 # distance - Edit distance, in percent, between two strings to trigger on.
1532 # matchlines - When set, the function goes into mode 2. In this mode the function will trigger if this many of the last <lines> matches.
1534 # As this module can be rather CPU-intensive, it comes with some options.
1535 # maxbacklog - Maximum size that can be specified for backlog. 0 disables multiline matching.
1536 # maxdistance - Max percentage of difference between two lines we'll allow to match. Set to 0 to disable edit-distance matching.
1537 # maxlines - Max lines of backlog to match against.
1538 # maxsecs - Maximum value of seconds a user can set. 0 to allow any.
1539 # size - Maximum number of characters to check for, can be used to truncate messages
1540 # before they are checked, resulting in less CPU usage. Increasing this beyond 512
1541 # doesn't have any effect, as the maximum length of a message on IRC cannot exceed that.
1542 #<repeat maxbacklog="20" maxlines="20" maxdistance="50" maxsecs="0" size="512">
1543 #<module name="repeat">
1545 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1546 # Restricted channels module: Allows only opers to create channels.
1548 # You probably *DO NOT* want to load this module on a public network.
1550 #<module name="restrictchans">
1552 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1553 # Restrict message module: Allows users to only message opers.
1555 # You probably *DO NOT* want to load this module on a public network.
1557 #<module name="restrictmsg">
1559 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1560 # R-Line module: Ban users through regular expression patterns.
1561 #<module name="rline">
1563 #-#-#-#-#-#-#-#-#-#-#-#- RLINE CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#-#
1565 # If you wish to re-check a user when they change nickname (can be
1566 # useful under some situations, but *can* also use CPU with more users
1567 # on a server) then set 'matchonnickchange' to yes.
1568 # Also, this is where you set what Regular Expression engine is to be
1569 # used. If you ever change it while running, all of your R-Lines will
1570 # be wiped. This is the regex engine used by all R-Lines set, and
1571 # regex_<engine> must be loaded, or rline will be non-functional
1572 # until you load it or change the engine to one that is loaded.
1574 #<rline matchonnickchange="yes" engine="pcre">
1576 # Generally, you will NOT want to use 'glob' here, as this turns
1577 # rline into just another gline. The exceptions are that rline will
1578 # always use the full "nick!user@host realname" string, rather than only
1579 # user@host, but beware that only the ? and * wildcards are available,
1580 # and are the only way to specify where the space can occur if you do
1581 # use glob. For this reason, is recommended to use a real regex engine
1582 # so that at least \s or [[:space:]] is available.
1584 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1585 # RMODE module: Adds the /RMODE command
1586 # Allows channel mods to remove list modes en masse.
1587 # Syntax: /rmode <channel> <mode> [pattern]
1588 # E.g. '/rmode #Channel b m:*' will remove all mute-extbans on the channel.
1589 #<module name="rmode">
1591 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1592 # SAJOIN module: Adds the /SAJOIN command which forcibly joins a user
1593 # to the given channel.
1594 # This module is oper-only.
1595 # To use, SAJOIN must be in one of your oper class blocks.
1596 # Opers need the users/sajoin-others priv to be able to /SAJOIN users
1597 # other than themselves.
1598 #<module name="sajoin">
1600 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1601 # SAKICK module: Adds the /SAKICK command which kicks a user from the
1603 # This module is oper-only.
1604 # To use, SAKICK must be in one of your oper class blocks.
1605 #<module name="sakick">
1607 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1608 # SAMODE module: Adds the /SAMODE command which allows server operators
1609 # to change modes on a channel without requiring them to have any
1610 # channel priviliges. Also allows changing user modes for any user.
1611 # This module is oper-only.
1612 # To use, SAMODE must be in one of your oper class blocks.
1613 #<module name="samode">
1615 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1616 # SANICK module: Adds the /SANICK command which allows opers to change
1618 # This module is oper-only.
1619 # To use, SANICK must be in one of your oper class blocks.
1620 #<module name="sanick">
1622 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1623 # SAPART module: Adds the /SAPART command which forcibly parts a user
1625 # This module is oper-only.
1626 # To use, SAPART must be in one of your oper class blocks.
1627 #<module name="sapart">
1629 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1630 # SAQUIT module: Adds the /SAQUIT command which forcibly quits a user.
1631 # This module is oper-only.
1632 # To use, SAQUIT must be in one of your oper class blocks.
1633 #<module name="saquit">
1635 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1636 # SATOPIC module: Adds the /SATOPIC command which allows changing the
1637 # topic on a channel without requiring any channel priviliges.
1638 # This module is oper-only.
1639 # To use, SATOPIC must be in one of your oper class blocks.
1640 #<module name="satopic">
1642 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1643 # SASL authentication module: Provides support for IRC Authentication
1644 # Layer via AUTHENTICATE. Note: You also need to have cap loaded
1646 #<module name="sasl">
1648 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1649 # Secure list module: Prevent /LIST in the first minute of connection,
1650 # crippling most spambots and trojan spreader bots.
1651 #<module name="securelist">
1653 #-#-#-#-#-#-#-#-#-# SECURELIST CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#-#
1655 # Securelist can be harmful to some IRC search engines such as #
1656 # netsplit.de and searchirc.com. To prevent securelist blocking these #
1657 # sites from listing, define exception tags as shown below: #
1658 #<securehost exception="*@*.searchirc.org">
1659 #<securehost exception="*@*.netsplit.de">
1660 #<securehost exception="*@echo940.server4you.de">
1661 #<securehost exception="*@*.ircdriven.com">
1663 # Define the following variable to change how long a user must wait #
1664 # before issuing a LIST. If not defined, defaults to 60 seconds. #
1666 #<securelist waittime="60"> #
1668 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1669 # Servprotect module: Provides support for Austhex style +k /
1670 # UnrealIRCD +S services mode.
1671 #<module name="servprotect">
1673 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1674 # See nicks module: Adds snomask +n and +N which show local and remote
1676 # This module is oper-only.
1677 #<module name="seenicks">
1679 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1680 # Set idle module: Adds a command for opers to change their idle time.
1681 # This module is oper-only.
1682 # To use, SETIDLE must be in one of your oper class blocks.
1683 #<module name="setidle">
1685 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1686 # Services support module: Adds several usermodes such as +R and +M.
1687 # This module implements the 'identified' state via account names,
1688 # and is similar in operation to the way asuka and ircu handle services.
1690 # At the same time, this offers +r for users and channels to mark them
1691 # as identified separately from the idea of a master account, which
1692 # can be useful for services which are heavily nick-as-account centric.
1694 # Also of note is that this module implements two extbans:
1695 # +b R: (stop matching account names from joining)
1696 # +b U:n!u@h (blocks matching unregistered users)
1698 #<module name="services_account">
1700 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1701 # Sethost module: Adds the /SETHOST command.
1702 # This module is oper-only.
1703 # To use, SETHOST must be in one of your oper class blocks.
1704 # See the chghost module for how to customise valid chars for hostnames.
1705 #<module name="sethost">
1707 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1708 # Setident module: Adds the /SETIDENT command.
1709 # This module is oper-only.
1710 # To use, SETIDENT must be in one of your oper class blocks.
1711 #<module name="setident">
1713 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1714 # SETNAME module: Adds the /SETNAME command.
1715 #<module name="setname">
1717 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1718 # Serverban: Implements extended ban 's', which stops anyone connected
1719 # to a server matching a mask like +b s:server.mask.here from joining.
1720 #<module name="serverban">
1722 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1723 # Showfile: Provides support for showing a text file to users when #
1724 # they enter a command. #
1725 # This module adds one command for each <showfile> tag that shows the #
1726 # given file to the user as a series of messages or numerics. #
1727 #<module name="showfile"> #
1729 #-#-#-#-#-#-#-#-#-#-# SHOWFILE CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#-#
1731 # name - The name of the command which displays this file. This is #
1732 # the only mandatory setting, all others are optional. #
1733 # file - The text file to be shown to the user. #
1734 # By default same as the command name. #
1735 # method - How should the file be shown? #
1736 # * numeric: Send contents using a numeric #
1737 # (similar to /MOTD; the default). #
1738 # * notice: Send contents as a series of notices. #
1739 # * msg: Send contents as a series of private messages. #
1740 # colors - If true, color codes (\c, \b, \u, etc.) will be processed #
1741 # and sent as ANSI colors. If false (default) the file will #
1742 # be displayed as-is. #
1744 # When using the method "numeric", the following extra settings are #
1747 # introtext - Introductory line, "Showing <name>" by default. #
1748 # intronumeric - Numeric used for the introductory line. #
1749 # numeric - Numeric used for sending the text itself. #
1750 # endtext - Ending line, "End of <name>" by default. #
1751 # endnumeric - Numeric used for the ending line. #
1753 #<showfile name="RULES"
1756 # introtext="Server rules:"
1757 # endtext="End of server rules.">
1759 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1760 # Show whois module: Adds the +W usermode which allows opers to see
1761 # when they are /WHOIS'd.
1762 # This module is oper-only by default.
1763 #<module name="showwhois">
1765 # If you wish, you may also let users set this mode. Only opers with the
1766 # users/auspex priv will see real hosts of people, though.
1767 #<showwhois opersonly="yes"
1769 # You may also set whether or not users should receive whois notices,
1770 # should they be /WHOIS'd by an oper.
1771 #showfromopers="yes">
1773 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1774 # Shun module: Provides the /SHUN command, which stops a user from
1775 # executing all except configured commands.
1776 # This module is oper-only.
1777 # To use, SHUN must be in one of your oper class blocks.
1778 #<module name="shun">
1780 # You may also configure which commands you wish a user to be able to
1781 # perform when shunned. It should be noted that if a shunned user
1782 # issues QUIT or PART then their message will be removed, as if they
1783 # did not issue one.
1785 # You can optionally let the user know that their command was blocked.
1787 # You may also let SHUN affect opers (defaults to no).
1788 #<shun enabledcommands="PING PONG QUIT PART JOIN" notifyuser="yes" affectopers="no">
1790 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1791 # SSL channel mode module: Adds support for SSL-only channels via
1792 # channel mode +z and the 'z' extban which matches SSL client
1793 # certificate fingerprints.
1794 # Does not do anything useful without a working SSL module (see below).
1795 #<module name="sslmodes">
1797 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1798 # GnuTLS SSL module: Adds support for SSL connections using GnuTLS,
1799 # if enabled. You must answer 'yes' in ./configure when asked or
1800 # manually symlink the source for this module from the directory
1801 # src/modules/extra, if you want to enable this, or it will not load.
1802 #<module name="ssl_gnutls">
1804 #-#-#-#-#-#-#-#-#-#-#- GNUTLS CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#
1806 # ssl_gnutls is too complex to describe here, see the wiki: #
1807 # http://wiki.inspircd.org/Modules/ssl_gnutls #
1809 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1810 # SSL info module: Allows users to retrieve information about other
1811 # users' peer SSL certificates and keys. This can be used by client
1812 # scripts to validate users. For this to work, one of ssl_gnutls
1813 # or ssl_openssl must be loaded. This module also adds the
1814 # "* <user> is using a secure connection" whois line, the ability for
1815 # opers to use SSL cert fingerprints to verify their identity and the
1816 # ability to force opers to use SSL connections in order to oper up.
1817 # It is highly recommended to load this module if you use SSL on your
1819 # For how to use the oper features, please see the first example <oper> tag
1820 # in opers.conf.example.
1822 #<module name="sslinfo">
1824 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1825 # OpenSSL SSL module: Adds support for SSL connections using OpenSSL,
1826 # if enabled. You must answer 'yes' in ./configure when asked or symlink
1827 # the source for this module from the directory src/modules/extra, if
1828 # you want to enable this, or it will not load.
1829 #<module name="ssl_openssl">
1831 #-#-#-#-#-#-#-#-#-#-#- OPENSSL CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#
1833 # ssl_openssl is too complex to describe here, see the wiki: #
1834 # http://wiki.inspircd.org/Modules/ssl_openssl #
1836 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1837 # Strip color module: Adds channel mode +S that strips mIRC color
1838 # codes from all messages sent to the channel.
1839 #<module name="stripcolor">
1841 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1842 # Silence module: Adds support for the /SILENCE command, which allows
1843 # users to have a server-side ignore list for their client.
1844 #<module name="silence">
1846 # Set the maximum number of entries allowed on a user's silence list.
1847 #<silence maxentries="32"
1849 # Whether messages from U-lined servers will bypass silence masks.
1852 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1853 # SQLite3 module: Allows other SQL modules to access SQLite3 #
1854 # databases through a unified API. #
1855 # This module is in extras. Re-run configure with: #
1856 # ./configure --enable-extras=m_sqlite.cpp
1857 # and run make install, then uncomment this module to enable it. #
1859 #<module name="sqlite3">
1861 #-#-#-#-#-#-#-#-#-#-#-#- SQL CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#-#
1863 # sqlite is more complex than described here, see the wiki for more #
1864 # info: http://wiki.inspircd.org/Modules/sqlite3 #
1866 #<database module="sqlite" hostname="/full/path/to/database.db" id="anytext">
1868 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1869 # SQL authentication module: Allows IRCd connections to be tied into
1870 # a database table (for example a forum).
1871 # This module is in extras. Re-run configure with:
1872 # ./configure --enable-extras=m_sqlauth.cpp
1873 # and run make install, then uncomment this module to enable it.
1875 #<module name="sqlauth">
1877 #-#-#-#-#-#-#-#-#-#-#- SQLAUTH CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#
1879 # sqlauth is too complex to describe here, see the wiki: #
1880 # http://wiki.inspircd.org/Modules/sqlauth #
1882 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1883 # SQL oper module: Allows you to store oper credentials in an SQL table
1884 # This module is in extras. Re-run configure with:
1885 # ./configure --enable-extras=m_sqloper.cpp
1886 # and run make install, then uncomment this module to enable it.
1888 #<module name="sqloper">
1890 #-#-#-#-#-#-#-#-#-#-#- SQLOPER CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#
1892 # dbid - Database ID to use (see SQL modules). #
1893 # hash - Hashing provider to use for password hashing. #
1895 # See also: http://wiki.inspircd.org/Modules/sqloper #
1897 #<sqloper dbid="1" hash="md5">
1899 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1900 # StartTLS module: Implements STARTTLS, which allows clients #
1901 # connected to non SSL enabled ports to enable SSL, if a proper SSL #
1902 # module is loaded (either ssl_gnutls or ssl_openssl). #
1903 #<module name="starttls">
1905 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1906 # SVSHold module: Implements SVSHOLD. Like Q:Lines, but can only be #
1907 # added/removed by Services. #
1908 #<module name="svshold">
1909 # SVSHOLD does not generate server notices by default, you can turn
1910 # notices on by uncommenting the next line.
1911 #<svshold silent="false">
1913 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1914 # SWHOIS module: Allows you to add arbitrary lines to user WHOIS.
1915 # This module is oper-only.
1916 # To use, SWHOIS must be in one of your oper class blocks.
1917 #<module name="swhois">
1919 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1920 # Test module: Enable this to create a command useful in testing
1921 # flood control. To avoid accidental use on live networks, the server
1922 # name must contain ".test" to load the module
1923 #<module name="testnet">
1925 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1926 # Timed bans module: Adds timed channel bans with the /TBAN command.
1927 #<module name="timedbans">
1929 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1930 # Test line module: Adds the /TLINE command, used to test how many
1931 # users a /GLINE or /ZLINE etc. would match.
1932 # This module is oper-only.
1933 # To use, TLINE must be in one of your oper class blocks.
1934 #<module name="tline">
1936 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1937 # Topiclock module: implements server-side topic locking to achieve deeper
1938 # integration with services packages.
1939 #<module name="topiclock">
1941 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1942 # UHNAMES support module: Adds support for the IRCX style UHNAMES
1943 # extension, which displays ident and hostname in the names list for
1944 # each user, saving clients from doing a WHO on the channel.
1945 # If a client does not support UHNAMES it will not enable it, this will
1946 # not break incompatible clients.
1947 #<module name="uhnames">
1949 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1950 # Uninvite module: Adds the /UNINVITE command which lets users remove
1951 # pending invites from channels without waiting for the user to join.
1952 #<module name="uninvite">
1954 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1955 # Userip module: Adds the /USERIP command.
1956 # Allows users to query their own IP, also allows opers to query the IP
1958 #<module name="userip">
1960 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1961 # Vhost module: Adds the VHOST command which allows for adding virtual
1962 # hosts which are accessible using a username and password in the config.
1963 #<module name="vhost">
1965 #-#-#-#-#-#-#-#-#-#-#- VHOST CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#-#
1967 # user - Username for the vhost. #
1969 # pass - Password for the vhost. #
1971 # hash - The hash for the specific user (optional) #
1972 # password_hash and a hashing module must be loaded for #
1975 # host - Vhost to set. #
1977 #<vhost user="some_username" pass="some_password" host="some.host.test.cc">
1978 #<vhost user="foo" password="fcde2b2edba56bf408601fb721fe9b5c338d10ee429ea04fae5511b68fbf8fb9" hash="sha256" host="some.other.host.example.com">
1980 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1981 # Watch module: Adds the WATCH command, which is used by clients to
1982 # maintain notify lists.
1983 #<module name="watch">
1985 # Set the maximum number of entries on a user's watch list below.
1986 #<watch maxentries="32">
1988 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1989 # XLine database: Stores all *Lines (G/Z/K/R/any added by other modules)
1990 # in a file which is re-loaded on restart. This is useful
1991 # for two reasons: it keeps bans so users may not evade them, and on
1992 # bigger networks, server connections will take less time as there will
1993 # be a lot less bans to apply - as most of them will already be there.
1994 #<module name="xline_db">
1996 # Specify the filename for the xline database here.
1997 #<xlinedb filename="data/xline.db">
1999 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2000 # ____ _ _____ _ _ ____ _ _ _ #
2001 # | _ \ ___ __ _ __| | |_ _| |__ (_)___ | __ )(_) |_| | #
2002 # | |_) / _ \/ _` |/ _` | | | | '_ \| / __| | _ \| | __| | #
2003 # | _ < __/ (_| | (_| | | | | | | | \__ \ | |_) | | |_|_| #
2004 # |_| \_\___|\__,_|\__,_| |_| |_| |_|_|___/ |____/|_|\__(_) #
2006 # To link servers to InspIRCd, you MUST load the spanningtree module. #
2007 # If you don't do this, server links will NOT work at all. #
2008 # This is by design, to allow for the implementation of other linking #
2009 # protocols in modules in the future. #
2011 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2012 # Spanning tree module: Allows linking of servers using the spanning
2013 # tree protocol (see the READ THIS BIT section above).
2014 # You will almost always want to load this.
2016 #<module name="spanningtree">
projects / user / henk / code / inspircd.git / blob