1 #-#-#-#-#-#-#-#-#-#-#-#-#- MODULE OPTIONS -#-#-#-#-#-#-#-#-#-#-#-#-#
3 # These tags define which modules will be loaded on startup by your #
4 # server. Add modules without any paths. When you make your ircd #
5 # using the 'make' command, all compiled modules will be moved into #
6 # the folder you specified when you ran ./configure. The module tag #
7 # automatically looks for modules in this location. #
8 # If you attempt to load a module outside of this location, either #
9 # in the config, or via /LOADMODULE, you will receive an error. #
11 # By default, ALL modules are commented out. You must uncomment them #
12 # or add lines to your config to load modules. Please refer to #
13 # http://wiki.inspircd.org/Modules for a list of modules and #
14 # each modules link for any additional conf tags they require. #
16 # ____ _ _____ _ _ ____ _ _ _ #
17 # | _ \ ___ __ _ __| | |_ _| |__ (_)___ | __ )(_) |_| | #
18 # | |_) / _ \/ _` |/ _` | | | | '_ \| / __| | _ \| | __| | #
19 # | _ < __/ (_| | (_| | | | | | | | \__ \ | |_) | | |_|_| #
20 # |_| \_\___|\__,_|\__,_| |_| |_| |_|_|___/ |____/|_|\__(_) #
22 # To link servers to InspIRCd, you MUST load the spanningtree module. #
23 # If you don't do this, server links will NOT work at all. #
24 # This is by design, to allow for the implementation of other linking #
25 # protocols in modules in the future. This module is at the bottom of #
29 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
30 # MD5 module: Allows other modules to generate MD5 hashes, usually for
31 # cryptographic uses and security.
34 # Other modules such as cloaking and password_hash may rely on
35 # this module being loaded to function.
39 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
40 # SHA256 module: Allows other modules to generate SHA256 hashes,
41 # usually for cryptographic uses and security.
44 # Other modules such as password_hash may rely on this module being
45 # loaded to function. Certain modules such as spanningtree will
46 # function without this module but when it is loaded their features will
47 # be enhanced (for example the addition of HMAC authentication).
49 #<module name="sha256">
50 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
51 # RIPEMD160 module: Allows other modules to generate RIPEMD160 hashes,
52 # usually for cryptographic uses and security.
55 # Other modules may rely on this module being loaded to function.
56 #<module name="ripemd160">
58 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
59 # Abbreviation module: Provides the ability to abbreviate commands a-la
61 #<module name="abbreviation">
63 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
64 # Alias module: Allows you to define server-side command aliases.
65 #<module name="alias">
67 # Set the 'prefix' for in-channel aliases (fantasy commands) to the
68 # specified character. If not set, the default is "!".
69 # If 'allowbots' is disabled, +B clients will not be able to use
70 # fantasy commands. If not set, the default is no.
71 #<fantasy prefix="!" allowbots="no">
73 #-#-#-#-#-#-#-#-#-#-#- ALIAS DEFINITIONS -#-#-#-#-#-#-#-#-#-#-#-#-#-#
75 # If you have the alias module loaded, you may also define aliases as #
76 # shown below. They are commonly used to provide shortcut commands to #
77 # services, however they are not limited to just this use. #
78 # An alias tag requires the following values to be defined in it: #
80 # text - The text to detect as the actual command line. #
81 # Can't contain spaces, but case insensitive. #
82 # You may have multiple aliases with the same #
83 # command name (text="" value), however the first #
84 # found will be executed if its format value is #
85 # matched, or it has no format value. Aliases are #
86 # read from the top of the file to the bottom. #
88 # usercommand - If this is true, the alias can be run simply as #
89 # /aliasname. Defaults to true. #
91 # channelcommand - If this is true, the alias can be used as an #
92 # in-channel alias or 'fantasy command', prefixed #
93 # by the fantasy prefix character, !aliasname by #
94 # default. Defaults to false. #
96 # format - If this is defined, the parameters of the alias #
97 # must match this glob pattern. For example if you #
98 # want the first parameter to start with a # for #
99 # the alias to be executed, set format="#*" in the #
100 # alias definition. Note that the :'s which are #
101 # part of IRC formatted lines will be preserved #
102 # for matching of this text. This value is #
105 # replace - The text to replace 'text' with. Usually this #
106 # will be "PRIVMSG ServiceName :$2-" or similar. #
107 # You may use the variables $1 through $9 in the #
108 # replace string, which refer to the first through #
109 # ninth word in the original string typed by the #
110 # user. You may also use $1- through $9- which #
111 # refer to the first word onwards, through to the #
112 # ninth word onwards, e.g. if the user types the #
113 # command "foo bar baz qux quz" then $3- will hold #
114 # "baz qux quz" and $2 will contain "bar". You may #
115 # also use the special variables: $nick, $ident, #
116 # $host and $vhost, and you may separate multiple #
117 # commands with a newline (which can be written in #
118 # the file literally, or encoded as &nl; or \n #
119 # depending on the config format setting). #
121 # requires - If you provide a value for 'requires' this means #
122 # the given nickname MUST be online for the alias #
123 # to successfully trigger. If they are not, then #
124 # the user receives a 'no such nick' 401 numeric. #
126 # uline - Setting this to true will ensure that the user #
127 # given in 'requires' is also on a u-lined server, #
128 # as well as actually being on the network. If the #
129 # user is online, but not on a u-lined server, #
130 # then an oper alert is sent out as this is #
131 # possibly a sign of a user trying to impersonate #
134 # operonly - If true, this will make the alias oper only. #
135 # If a non-oper attempts to use the alias, it will #
136 # appear to not exist. #
138 #<alias text="NICKSERV" replace="PRIVMSG NickServ :$2-" requires="NickServ" uline="yes">
139 #<alias text="CHANSERV" replace="PRIVMSG ChanServ :$2-" requires="ChanServ" uline="yes">
140 #<alias text="OPERSERV" replace="PRIVMSG OperServ :$2-" requires="OperServ" uline="yes" operonly="yes">
141 #<alias text="BOTSERV" replace="PRIVMSG BotServ :$2-" requires="BotServ" uline="yes">
142 #<alias text="HOSTSERV" replace="PRIVMSG HostServ :$2-" requires="HostServ" uline="yes">
143 #<alias text="MEMOSERV" replace="PRIVMSG MemoServ :$2-" requires="MemoServ" uline="yes">
144 #<alias text="NS" replace="PRIVMSG NickServ :$2-" requires="NickServ" uline="yes">
145 #<alias text="CS" replace="PRIVMSG ChanServ :$2-" requires="ChanServ" uline="yes">
146 #<alias text="OS" replace="PRIVMSG OperServ :$2-" requires="OperServ" uline="yes" operonly="yes">
147 #<alias text="BS" replace="PRIVMSG BotServ :$2-" requires="BotServ" uline="yes">
148 #<alias text="HS" replace="PRIVMSG HostServ :$2-" requires="HostServ" uline="yes">
149 #<alias text="MS" replace="PRIVMSG MemoServ :$2-" requires="MemoServ" uline="yes">
151 # An example of using the format value to create an alias with two
152 # different behaviours depending on the format of the parameters.
154 #<alias text="ID" format="#*" replace="PRIVMSG ChanServ :IDENTIFY $2 $3"
155 # requires="ChanServ" uline="yes">
157 #<alias text="ID" replace="PRIVMSG NickServ :IDENTIFY $2"
158 # requires="NickServ" uline="yes">
160 # This alias fixes a glitch in xchat 2.6.x and above and the way it
161 # assumes IDENTIFY must be prefixed by a colon (:) character. It should
162 # be placed ABOVE the default NICKSERV alias (the first example) listed
165 #<alias text="NICKSERV" format=":IDENTIFY *" replace="PRIVMSG NickServ :IDENTIFY $3-"
166 # requires="NickServ" uline="yes">
168 # You may also add aliases to trigger based on something said in a
169 # channel, aka 'fantasy' commands, configured in the same manner as any
170 # other alias, with usercommand="no" and channelcommand="yes" The
171 # command must be preceded by the fantasy prefix when used.
173 #<alias text="CS" usercommand="no" channelcommand="yes"
174 # replace="PRIVMSG ChanServ :$1 $chan $2-" requires="ChanServ" uline="yes">
176 # This would be used as "!cs <command> <options>", with the channel
177 # being automatically inserted after the command in the message to
178 # ChanServ, assuming the fantasy prefix is "!".
180 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
181 # Allowinvite module: Gives channel mode +A to allow all users to use
182 # /INVITE, and extban A to deny invite from specific masks.
183 #<module name="allowinvite">
185 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
186 # Alltime module: Shows time on all connected servers at once.
187 # This module is oper-only and provides /ALLTIME.
188 # To use, ALLTIME must be in one of your oper class blocks.
189 #<module name="alltime">
191 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
192 # Auditorium module: Adds channel mode +u which makes everyone else
193 # except you in the channel invisible, used for large meetings etc.
194 #<module name="auditorium">
196 # Auditorium settings:
198 #<auditorium opvisible="no" opcansee="no" opercansee="yes">
200 # opvisible (auditorium-vis in exemptchanops):
201 # Show channel ops to all users
202 # opcansee (auditorium-see in exemptchanops):
203 # Allow ops to see all joins/parts/kicks in the channel
205 # Allow opers (channels/auspex) to see see all joins/parts/kicks in the channel
207 # Exemptchanops can be used to adjust the level at which users become visible or
208 # the level at which they can see the full member list of the channel.
210 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
211 # Autoop module: Adds basic channel access controls via the +w listmode.
212 # For example +w o:*!Attila@127.0.0.1 will op anyone matching that mask
213 # on join. This can be combined with extbans, for example +w o:R:Brain
214 # will op anyone identified to the account "Brain".
215 # Another useful combination is with SSL client certificate
216 # fingerprints: +w h:z:72db600734bb9546c1bdd02377bc21d2a9690d48 will
217 # give halfop to the user(s) having the given certificate.
218 #<module name="autoop">
220 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
221 # Ban except module: Adds support for channel ban exceptions (+e).
222 #<module name="banexception">
224 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
225 # Ban redirection module: Allows bans which redirect to a specified
226 # channel. e.g. +b nick!ident@host#channelbanneduserissentto
227 #<module name="banredirect">
229 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
230 # bcrypt module: Allows other modules to generate bcrypt hashes,
231 # usually for cryptographic uses and security.
232 #<module name="bcrypt">
234 # rounds: Defines how many rounds the bcrypt function will run when
235 # generating new hashes.
236 #<bcrypt rounds="10">
238 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
239 # Block amsg module: Attempt to block all usage of /amsg and /ame.
240 #<module name="blockamsg">
242 #-#-#-#-#-#-#-#-#-#-#- BLOCKAMSG CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
244 # If you have the blockamsg module loaded, you can configure it with #
245 # the <blockamsg> tag: #
247 # delay - How many seconds between two messages to force #
248 # them to be recognised as unrelated. #
249 # action - Any of 'notice', 'noticeopers', 'silent', 'kill' #
250 # or 'killopers'. Define how to take action when #
251 # a user uses /amsg or /ame. #
253 #<blockamsg delay="3" action="killopers">
255 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
256 # Block CAPS module: Adds channel mode +B, blocks all-CAPS messages.
257 #<module name="blockcaps">
259 #-#-#-#-#-#-#-#-#-#-#- BLOCKCAPS CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
261 # percent - What percentage of the text must be caps before #
262 # text will be blocked. #
264 # minlen - The minimum length a line must be for the block #
265 # percent to have any effect. #
267 # capsmap - A list of chars to be considered CAPS. Can be used #
268 # to add CAPS characters for your language. Also you #
269 # can add things like ! and space to further lock #
270 # down on caps usage. #
271 #<blockcaps percent="50"
273 # capsmap="ABCDEFGHIJKLMNOPQRSTUVWXYZ! ">
275 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
276 # Block color module: Blocking color-coded messages with chan mode +c.
277 #<module name="blockcolor">
279 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
280 # Botmode module: Adds the user mode +B. If set on a user, it will
281 # show that the user is a bot in /WHOIS.
282 #<module name="botmode">
284 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
285 # CallerID module: Adds usermode +g which activates hybrid-style
286 # callerid: block all private messages unless you /ACCEPT first.
287 #<module name="callerid">
289 #-#-#-#-#-#-#-#-#-#-#- CALLERID CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#
290 # maxaccepts - Maximum number of entries a user can add to his #
291 # /ACCEPT list. Default is 16 entries. #
292 # operoverride - Can opers (note: ALL opers) override callerid? #
294 # tracknick - Preserve /accept entries when a user changes nick? #
295 # If no (the default), the user is removed from #
296 # everyone's accept list if he changes nickname. #
297 # cooldown - Amount of time (in seconds) that must pass since #
298 # the last notification sent to a user before he can #
299 # be sent another. Default is 60 (1 minute). #
300 #<callerid maxaccepts="16"
305 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
306 # CAP module: Provides the CAP negotiation mechanism required by the
307 # sasl, namesx, uhnames, and ircv3 modules.
308 # It is also recommended for STARTTLS support in the starttls module.
311 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
312 # CBAN module: Lets you disallow channels from being used at runtime.
313 # This module is oper-only and provides /CBAN.
314 # To use, CBAN must be in one of your oper class blocks.
315 #<module name="cban">
317 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
318 # Censor module: Adds channel and user mode +G.
319 #<module name="censor">
321 #-#-#-#-#-#-#-#-#-#-#- CENSOR CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#
323 # Optional - If you specify to use the censor module, then you must #
324 # specify some censor tags. See also: #
325 # http://wiki.inspircd.org/Modules/censor #
327 #<include file="examples/censor.conf.example">
329 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
330 # CGI:IRC module: Adds support for automatic host changing in CGI:IRC
331 # (http://cgiirc.sourceforge.net).
332 # Adds snomask +w for monitoring CGI:IRC connections.
333 #<module name="cgiirc">
335 #-#-#-#-#-#-#-#-#-#-#-# CGIIRC CONFIGURATION #-#-#-#-#-#-#-#-#-#-#-#-#
337 # Optional - If you specify to use cgiirc, then you must specify one
338 # or more cgihost tags which indicate authorised CGI:IRC servers which
339 # will be connecting to your network, and an optional cgiirc tag.
340 # For more information see: http://wiki.inspircd.org/Modules/cgiirc
342 # Set to yes if you want to notice opers when CGI:IRC clients connect.
343 # <cgiirc opernotice="no">
345 # The type field indicates where the module should get the real
346 # client's IP address from, for further information, please see the
347 # CGI:IRC documentation.
350 # <cgihost type="pass" mask="www.example.com"> # Get IP from PASS
351 # <cgihost type="ident" mask="otherbox.example.com"> # Get IP from ident
352 # <cgihost type="passfirst" mask="www.example.com"> # See the docs
354 # <cgihost type="webirc" password="foobar"
355 # mask="somebox.example.com"> # Get IP from WEBIRC
360 # When you connect CGI:IRC clients, there are two connect classes which
361 # apply to these clients. When the client initially connects, the connect
362 # class which matches the CGI:IRC site's host is checked. Therefore you
363 # must raise the maximum local/global clients for this ip as high as you
364 # want to allow cgi clients. After the client has connected and is
365 # determined to be a cgi:irc client, the class which matches the client's
366 # real IP is then checked. You may set this class to a lower value, so that
367 # the real IP of the client can still be restricted to, for example, 3
370 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
371 # Channel create module: Adds snomask +j, which will notify opers of
372 # any new channels that are created.
373 # This module is oper-only.
374 #<module name="chancreate">
376 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
377 # Channel filter module: Allows channel-op defined message filtering
378 # using simple string matches (channel mode +g).
379 #<module name="chanfilter">
381 # If hidemask is set to yes, the user will not be shown the mask when
382 # his/her message is blocked.
383 #<chanfilter hidemask="yes">
385 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
386 # Channel history module: Displays the last 'X' lines of chat to a user
387 # joining a channel with +H 'X:T' set; 'T' is the maximum time to keep
388 # lines in the history buffer. Designed so that the new user knows what
389 # the current topic of conversation is when joining the channel.
390 #<module name="chanhistory">
392 # Set the maximum number of lines allowed to be stored per channel below.
393 # This is the hard limit for 'X'.
394 # If notice is set to yes, joining users will get a NOTICE before playback
395 # telling them about the following lines being the pre-join history.
396 # If bots is set to yes, it will also send to users marked with +B
397 #<chanhistory maxlines="20" notice="yes" bots="yes">
399 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
400 # Channel logging module: Used to send snotice output to channels, to
401 # allow staff to centrally monitor and discuss network activity.
403 # The "channel" field is where you want the messages to go, "snomasks"
404 # is what snomasks you want to be sent to that channel. Multiple tags
406 #<module name="chanlog">
407 #<chanlog snomasks="AOcC" channel="#opers">
409 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
410 # Channel names module: Allows disabling channels which have certain
411 # characters in the channel name such as bold, colorcodes, etc. which
412 # can be quite annoying and allow users to on occasion have a channel
413 # that looks like the name of another channel on the network.
414 #<module name="channames">
417 # denyrange: characters or range of characters to deny in channel
421 # allowrange: characters or range of characters to specifically allow
425 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
426 # Channelban: Implements extended ban j:, which stops anyone already
427 # in a channel matching a ban like +b j:#channel*mask from joining.
428 # Note that by default wildcard characters * and ? are allowed in
429 # channel names. To disallow them, load m_channames and add characters
430 # 42 and 63 to denyrange (see above).
431 #<module name="channelban">
433 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
434 # Check module: Adds the /CHECK command.
435 # Check is useful for looking up information on channels, users,
436 # IP addresses and hosts.
437 # This module is oper-only.
438 # To use, CHECK must be in one of your oper class blocks.
439 #<module name="check">
441 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
442 # CHGHOST module: Adds the /CHGHOST command.
443 # This module is oper-only.
444 # To use, CHGHOST must be in one of your oper class blocks.
445 # NOTE: Services will not be able to set vhosts on users if this module
446 # isn't loaded. If you're planning on running services, you probably
448 #<module name="chghost">
450 #-#-#-#-#-#-#-#-# /CHGHOST - /SETHOST CONFIGURATION #-#-#-#-#-#-#-#-#
451 # Optional - If you want to use special chars for hostnames you can #
452 # specify your own custom list of chars with the <hostname> tag: #
454 # charmap - A list of chars accepted as valid by the /CHGHOST #
455 # and /SETHOST commands. Also note that the list is #
457 #<hostname charmap="abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ.-_/0123456789">
459 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
460 # CHGIDENT module: Adds the /CHGIDENT command.
461 # This module is oper-only.
462 # To use, CHGIDENT must be in one of your oper class blocks.
463 #<module name="chgident">
465 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
466 # CHGNAME module: Adds the /CHGNAME command.
467 # This module is oper-only.
468 # To use, CHGNAME must be in one of your oper class blocks.
469 #<module name="chgname">
471 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
472 # Connection class ban module: Adds support for extban 'n' which
473 # matches against the class name of the user's connection.
474 # This module assumes that connection classes are named in a uniform
475 # way on all servers of the network.
476 #<module name="classban">
478 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
479 # Clear chan module: Allows opers to masskick, masskill or mass-G/ZLine
480 # all users on a channel using /CLEARCHAN.
481 #<module name="clearchan">
483 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
484 # Cloaking module: Adds usermode +x and cloaking support.
485 # Relies on the md5 module being loaded.
486 # To cloak users when they connect, load the conn_umodes module and set
487 # <connect:modes> to include the +x mode. The example <connect> tag
488 # shows this. See the conn_umodes module for more information.
489 #<module name="cloaking">
491 #-#-#-#-#-#-#-#-#-#-#- CLOAKING CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#
493 # To use cloaking, you must define a cloak key, and optionally a #
494 # cloak prefix as shown below. The cloak key must be shared across #
495 # the network for correct cloaking. #
497 # There are two methods of cloaking: #
499 # half Cloak only the "unique" portion of a host; show #
500 # the last 2 parts of the domain, /16 subnet of IPv4 #
501 # or /48 subnet of the IPv6 address. #
503 # full Cloak the users completely, using three slices for #
504 # common CIDR bans (IPv4: /16, /24; IPv6: /48, /64). #
506 # The methods use a single key that can be any length of text. #
507 # An optional prefix may be specified to mark cloaked hosts. #
508 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
514 #-#-#-#-#-#-#-#-#-#-#-#- CLOSE MODULE #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
515 # Close module: Allows an oper to close all unregistered connections.
516 # This module is oper-only and provides the /CLOSE command.
517 # To use, CLOSE must be in one of your oper class blocks.
518 #<module name="close">
520 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
521 # Clones module: Adds an oper command /CLONES for detecting cloned
522 # users. Warning: This command may be resource intensive when it is
523 # issued, use with care.
524 # This module is oper-only.
525 # To use, CLONES must be in one of your oper class blocks.
526 #<module name="clones">
528 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
529 # Common channels module: Adds user mode +c, which, when set, requires
530 # that users must share a common channel with you to PRIVMSG or NOTICE
532 #<module name="commonchans">
534 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
535 # Auto join on connect module: Allows you to force users to join one
536 # or more channels automatically upon connecting to the server, or
537 # join them in case they aren't on any channels after being online
539 #<module name="conn_join">
541 #-#-#-#-#-#-#-#-#-#-#-#- CONNJOIN CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
543 # If you have the conn_join module loaded, you can configure it below
544 # or set autojoin="#chat,#help" in <connect> blocks.
546 # Join users immediately after connection to #one #two and #three.
547 #<autojoin channel="#one,#two,#three">
548 # Join users to #chat after 15 seconds if they aren't on any channels.
549 #<autojoin channel="#chat" delay="15">
551 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
552 # Set modes on connect module: When this module is loaded <connect>
553 # blocks may have an optional modes="" value, which contains modes to
554 # add or remove from users when they connect to the server.
555 #<module name="conn_umodes">
557 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
558 # Wait for PONG on connect module: Send a PING to all connecting users
559 # and don't let them connect until they reply with a PONG.
560 # This is useful to stop certain kinds of bots and proxies.
561 #<module name="conn_waitpong">
563 #-#-#-#-#-#-#-#-#-#-#- WAITPONG CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
565 # If you have the conn_waitpong module loaded, configure it with the #
568 # sendsnotice - Whether to send a helpful notice to users on #
569 # connect telling them how to connect, should #
570 # their client not reply PONG automatically. #
572 # killonbadreply - Whether to kill the user if they send the wrong #
575 #<waitpong sendsnotice="yes" killonbadreply="yes">
577 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
578 # Channel cycle module: Adds the /CYCLE command which is a server-side
579 # /HOP that bypasses restrictive modes.
580 #<module name="cycle">
582 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
583 # Connectban: Provides IP connection throttling. Any IP range that
584 # connects too many times (configurable) in an hour is Z-Lined for a
585 # (configurable) duration, and their count resets to 0.
586 #<module name="connectban">
588 # ipv4cidr and ipv6cidr allow you to turn the comparison from
589 # individual IP addresses (32 and 128 bits) into CIDR masks, to allow
590 # for throttling over whole ISPs/blocks of IPs, which may be needed to
593 # This allows for 10 connections in an hour with a 10 minute ban if
595 #<connectban threshold="10" duration="10m" ipv4cidr="32" ipv6cidr="128"
596 # A custom ban message may optionally be specified.
597 # 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.">
599 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
600 # Connection throttle module.
601 #<module name="connflood">
603 #-#-#-#-#-#-#-#-#-#-#- CONNTHROTTLE CONFIGURATION -#-#-#-#-#-#-#-#-#-#
604 # seconds, maxconns - Amount of connections per <seconds>.
606 # timeout - Time to wait after the throttle was activated
607 # before deactivating it. Be aware that the time
608 # is seconds + timeout.
610 # quitmsg - The message that users get if they attempt to
611 # connect while the throttle is active.
613 # bootwait - Amount of time in seconds to wait before enforcing
614 # the throttling when the server just booted.
616 #<connflood seconds="30" maxconns="3" timeout="30"
617 # quitmsg="Throttled" bootwait="10">
619 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
620 # Custom prefixes: Allows for channel prefixes to be added.
621 #<module name="customprefix">
623 # name The name of the mode, must be unique from other modes.
624 # letter The letter used for this mode. Required.
625 # prefix The prefix used for nicks with this mode. Not required.
626 # rank A numeric rank for this prefix, defining what permissions it gives.
627 # The rank of voice, halfop and op is 10000, 20000, and 30000,
629 # ranktoset The numeric rank required to set/unset this mode. Defaults to rank.
630 # depriv Can you remove the mode from yourself? Defaults to yes.
631 #<customprefix name="founder" letter="q" prefix="~" rank="50000" ranktoset="50000">
632 #<customprefix name="admin" letter="a" prefix="&" rank="40000" ranktoset="50000">
633 #<customprefix name="halfop" letter="h" prefix="%" rank="20000" ranktoset="30000">
634 #<customprefix name="halfvoice" letter="V" prefix="-" rank="1" ranktoset="20000">
636 # Do /RELOADMODULE customprefix after changing the settings of this module.
638 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
639 # Custom title module: Adds the /TITLE command which allows for trusted
640 # users to gain a custom whois line and an optional vhost can be
642 #<module name="customtitle">
644 #-#-#-#-#-#-#-#-#-#- CUSTOM TITLE CONFIGURATION -#-#-#-#-#-#-#-#-#-#
645 # name - The username used to identify.
646 # password - The password used to identify.
647 # hash - The hash for the specific user's password (optional).
648 # password_hash and a hashing module must be loaded
650 # host - Allowed hostmask (optional).
651 # title - Title shown in whois.
652 # vhost - Displayed host (optional).
654 #<title name="foo" password="bar" title="Official Chat Helper">
655 #<title name="bar" password="foo" host="ident@test.org" title="Official Chat Helper" vhost="helper.test.org">
656 #<title name="foo" password="$2a$10$UYZ4OcO8NNTCCGyCdY9SK.2GHiqGgxZfHFPOPmWuxEVWVQTtoDC7C" hash="bcrypt" title="Official Chat Helper">
658 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
659 # DCCALLOW module: Adds the /DCCALLOW command.
660 #<module name="dccallow">
662 #-#-#-#-#-#-#-#-#-#-#- DCCALLOW CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
663 # blockchat - Whether to block DCC CHAT as well as DCC SEND.
664 # length - Default duration of entries in DCCALLOW list.
665 # action - Default action to take if no action is
666 # specified, can be 'block' or 'allow'.
667 # maxentries - Max number of nicks to allow on a DCCALLOW list.
669 # File configuration:
670 # pattern - The glob pattern to match against.
671 # action - Action to take if a user attempts to send a file
672 # that matches this pattern, can be 'block' or
675 #<dccallow blockchat="yes" length="5m" action="block" maxentries="20">
676 #<banfile pattern="*.exe" action="block">
677 #<banfile pattern="*.txt" action="allow">
679 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
680 # Deaf module: Adds support for the usermode +d - deaf to channel
681 # messages and channel notices.
682 #<module name="deaf">
684 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
685 # Delay join module: Adds the channel mode +D which delays all JOIN
686 # messages from users until they speak. If they quit or part before
687 # speaking, their quit or part message will not be shown to the channel
688 # which helps cut down noise on large channels in a more friendly way
689 # than the auditorium mode. Only channel ops may set the +D mode.
690 #<module name="delayjoin">
692 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
693 # Delay message module: Adds the channel mode +d which disallows a user
694 # from talking in the channel unless they've been joined for X seconds.
695 # Settable using /MODE #chan +d 30
696 #<module name="delaymsg">
697 # Set allownotice to no to disallow NOTICEs too. Defaults to yes.
698 #<delaymsg allownotice="no">
700 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
701 # Deny channels module: Deny channels from being used by users.
702 #<module name="denychans">
704 #-#-#-#-#-#-#-#-#-#-#- DENYCHAN DEFINITIONS -#-#-#-#-#-#-#-#-#-#-#-#
706 # If you have the denychans module loaded, you need to specify the #
707 # channels to deny: #
709 # name - The channel name to deny (glob masks are ok). #
710 # allowopers - If operators are allowed to override the deny. #
711 # reason - Reason given for the deny. #
712 # redirect - Redirect the user to a different channel. #
714 #<badchan name="#gods*" allowopers="yes" reason="Tortoises!"> #
715 #<badchan name="#chan1" redirect="#chan2" reason="Chan1 is closed"> #
717 # Redirects will not work if the target channel is set +L. #
719 # Additionally, you may specify channels which are allowed, even if #
720 # a badchan tag specifies it would be denied: #
721 #<goodchan name="#funtimes"> #
722 # Glob masks are accepted here also. #
724 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
725 # Devoice module: Let users devoice themselves using /DEVOICE #chan.
726 #<module name="devoice">
728 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
729 # DNS blacklist module: Provides support for looking up IPs on one or #
731 #<module name="dnsbl"> #
733 # For configuration options please see the wiki page for dnsbl at #
734 # http://wiki.inspircd.org/Modules/dnsbl #
736 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
737 # Exempt channel operators module: Provides support for allowing #
738 # channel operators to be exempt from some channel modes. Supported #
739 # modes are blockcaps, noctcp, blockcolor, nickflood, flood, censor, #
740 # filter, regmoderated, nonick, nonotice, and stripcolor. #
741 #<module name="exemptchanops"> #
743 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
744 # Filter module: Provides message filtering, similar to SPAMFILTER. #
745 #<module name="filter">
747 # This module depends upon a regex provider such as regex_pcre or #
748 # regex_glob to function. You must specify which of these you want #
749 # the filter module to use via the tag below. #
751 # Valid engines are: #
753 # glob - Glob patterns, provided via regex_glob. #
754 # pcre - PCRE regexps, provided via regex_pcre, needs libpcre. #
755 # tre - TRE regexps, provided via regex_tre, requires libtre. #
756 # posix - POSIX regexps, provided via regex_posix, not available #
757 # on Windows, no dependencies on other operating systems. #
758 # stdlib - stdlib regexps, provided via regex_stdlib, see comment #
759 # at the <module> tag for info on availability. #
761 #<filteropts engine="glob"> #
763 # Your choice of regex engine must match on all servers network-wide.
765 # To learn more about the configuration of this module, read #
766 # examples/filter.conf.example, which covers the various types of #
767 # filters and shows how to add exemptions. #
769 #-#-#-#-#-#-#-#-#-#-#- FILTER CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#
771 # Optional - If you specify to use the filter module, then #
772 # specify below the path to the filter.conf file, or define some #
775 #<include file="examples/filter.conf.example">
777 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
778 # Flash Policy Daemon module: Allows Flash IRC clients (e.g. LightIRC)#
779 # to connect. If no file is specified, it'll serve a default policy #
780 # allowing all IPs to connect to all plaintext IRC ports #
781 #<bind address="" port="8430" type="flashpolicyd"> #
782 #<flashpolicyd timeout="5" file=""> #
783 #<module name="flashpolicyd"> #
785 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
786 # Gecos ban: Implements extended ban 'r', which stops anyone matching
787 # a mask like +b r:*realname?here* from joining a channel.
788 #<module name="gecosban">
790 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
791 # GeoIP module: Allows the server admin to match users by country code.
792 # This module is in extras. Re-run configure with:
793 # ./configure --enable-extras=m_geoip.cpp
794 # and run make install, then uncomment this module to enable it.
795 # This module requires GeoIP to be installed on your system,
796 # use your package manager to find the appropriate packages
797 # or check the InspIRCd wiki page for this module.
798 #<module name="geoip">
800 # The actual allow/ban actions are done by connect classes, not by the
801 # GeoIP module. An example connect class to ban people from russia or
804 # <connect deny="*" geoip="TR,RU">
806 # The country code must be in capitals and should be an ISO country
807 # code such as TR, GB, or US. Unknown IPs (localhost, LAN IPs, etc)
808 # will be assigned the country code "UNK". Since connect classes are
809 # matched from top down, your deny classes must be above your allow
810 # classes for them to match.
812 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
813 # Globops module: Provides the /GLOBOPS command and snomask +g.
814 # This module is oper-only.
815 # To use, GLOBOPS must be in one of your oper class blocks.
816 #<module name="globops">
818 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
819 # Global load module: Allows loading and unloading of modules network-
820 # wide (USE WITH EXTREME CAUTION!)
821 # This module is oper-only and provides /GLOADMODULE, /GUNLOADMODULE
822 # and /GRELOADMODULE.
823 # To use, GLOADMODULE, GUNLOADMODULE and GRELOADMODULE
824 # must be in one of your oper class blocks.
825 #<module name="globalload">
827 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
828 # HELPOP module: Provides the /HELPOP command
829 #<module name="helpop">
831 #-#-#-#-#-#-#-#-#-#-#-#- HELPOP CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
833 # If you specify to use the helpop module, then specify below the #
834 # path to the helpop.conf file. #
836 #<include file="examples/inspircd.helpop-full.example">
838 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
839 # Hide chans module: Allows users to hide their channels list from non-
840 # opers by setting user mode +I on themselves.
841 #<module name="hidechans">
843 # This mode can optionally prevent opers from seeing channels on a +I
844 # user, for more privacy if set to true.
845 # This setting is not recommended for most mainstream networks.
846 #<hidechans affectsopers="false">
848 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
849 # Hide list module: Allows for hiding the list of listmodes from users
850 # who do not have sufficient channel rank.
851 #<module name="hidelist">
853 # Each <hidelist> tag configures one listmode to hide.
854 # mode: Name of the listmode to hide.
855 # rank: Minimum rank required to view the list. If set to 0, all
856 # members of the channel may view the list, but non-members may not.
857 # The rank of the built-in op and voice mode is 30000 and 10000,
858 # respectively; the rank of other prefix modes is configurable.
861 # Hiding the ban list is not recommended because it may break some
864 # Hide filter (+g) list:
865 #<hidelist mode="filter" rank="30000">
866 # Only show invite exceptions (+I) to channel members:
867 #<hidelist mode="invex" rank="0">
869 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
870 # Hide oper module: Allows opers to hide their oper status from non-
871 # opers by setting user mode +H on themselves.
872 # This module is oper-only.
873 #<module name="hideoper">
875 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
876 # Hostchange module: Allows a different style of cloaking.
877 #<module name="hostchange">
879 #-#-#-#-#-#-#-#-#-#-#- HOSTCHANGE CONFIGURATION -#-#-#-#-#-#-#-#-#-#
881 # See http://wiki.inspircd.org/Modules/hostchange for help. #
883 #<host suffix="invalid.org" separator="." prefix="">
884 #<hostchange mask="*@42.theanswer.example.org" action="addnick">
885 #<hostchange mask="*root@*" action="suffix">
886 #<hostchange mask="a@example.com" action="set" value="foo.bar.baz">
887 #<hostchange mask="localhost" ports="7000,7001,7005-7007" action="set" value="blahblah.foo">
889 # hostcycle: If loaded, when a user gets a host or ident set, it will
890 # cycle them in all their channels. If not loaded it will simply change
891 # their host/ident without cycling them.
892 # This module is compatible with the ircv3_chghost module. Clients
893 # supporting the chghost extension will get the chghost message instead
894 # of seeing a host cycle.
895 #<module name="hostcycle">
897 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
898 # httpd module: Provides HTTP server support for InspIRCd.
899 #<module name="httpd">
901 #-#-#-#-#-#-#-#-#-#-#-#- HTTPD CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
903 # If you choose to use the httpd module, then you will need to add
904 # a <bind> tag with type "httpd", and load at least one of the other
905 # httpd_* modules to provide pages to display.
907 # You can adjust the timeout for HTTP connections below. All HTTP
908 # connections will be closed after (roughly) this many seconds.
909 #<httpd timeout="20">
911 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
912 # HTTP ACL module: Provides access control lists for httpd dependent
913 # modules. Use this module to restrict pages by IP address and by
915 #<module name="httpd_acl">
917 #-#-#-#-#-#-#-#-#-#-#-#- HTTPD ACL CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
919 # Restrict access to the httpd_stats module to all but the local
920 # network and when the correct password is specified:
921 # <httpdacl path="/stats*" types="password,whitelist"
922 # username="secrets" password="mypasshere" whitelist="127.0.0.*,10.*">
924 # Deny all connections to all but the main index page:
925 # <httpdacl path="/*" types="blacklist" blacklist="*">
927 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
928 # HTTP config module: Allows the configuration of the server to be
929 # viewed over HTTP. Requires httpd to be loaded for it to function.
930 #<module name="httpd_config">
932 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
933 # HTTP stats module: Provides basic stats pages over HTTP.
934 # Requires httpd to be loaded for it to function.
935 #<module name="httpd_stats">
937 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
938 # Ident: Provides RFC 1413 ident lookup support.
939 # When this module is loaded <connect:allow> tags may have an optional
940 # useident="yes|no" boolean value, determining whether or not to lookup
941 # ident on users matching that connect tag.
942 #<module name="ident">
944 #-#-#-#-#-#-#-#-#-#-#-#- IDENT CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
946 # Optional - If you are using the ident module, then you can specify #
947 # the timeout for ident lookups here. If not defined, it will default #
948 # to 5 seconds. This is a non-blocking timeout which holds the user #
949 # in a 'connecting' state until the lookup is complete. #
950 # The bind value indicates which IP to bind outbound requests to. #
951 # nolookupprefix: If on, the idents of users being in a connect class #
952 # with ident lookups disabled (i.e. <connect useident="off">) will be #
953 # prefixed with a "~". If off, the ident of those users will not be #
954 # prefixed. Default is off. #
956 #<ident timeout="5" nolookupprefix="no">
958 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
959 # Invite exception module: Adds support for channel invite exceptions
961 #<module name="inviteexception">
962 # bypasskey: If this is enabled, exceptions will bypass +k as well as +i
963 #<inviteexception bypasskey="yes">
965 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
966 # IRCv3 module: Provides the following IRCv3.1 extensions:
967 # extended-join, away-notify and account-notify. These are optional
968 # enhancements to the client-to-server protocol. An extension is only
969 # active for a client when the client specifically requests it, so this
970 # module needs the cap module to work.
972 # Further information on these extensions can be found at the IRCv3
973 # working group website:
974 # http://ircv3.org/extensions/
976 #<module name="ircv3">
977 # The following block can be used to control which extensions are
978 # enabled. Note that extended-join can be incompatible with delayjoin
980 #<ircv3 accountnotify="on" awaynotify="on" extendedjoin="on">
982 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
983 # IRCv3 cap-notify module: Provides the cap-notify IRCv3.2 extension.
984 # Required for IRCv3.2 conformance.
985 #<module name="ircv3_capnotify">
987 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
988 # IRCv3 chghost module: Provides the chghost IRCv3.2 extension which
989 # allows capable clients to learn when the host/ident of another user
990 # changes without cycling the user. This module is compatible with the
991 # hostcycle module. If both are loaded, clients supporting the chghost
992 # extension will get the chghost message and won't see host cycling.
993 #<module name="ircv3_chghost">
995 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
996 # IRCv3 echo-message module: Provides the echo-message IRCv3.2
997 # extension which allows capable clients to get an acknowledgement when
998 # their messages are delivered and learn what modifications, if any,
999 # were applied to them.
1000 #<module name="ircv3_echomessage">
1002 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1003 # IRCv3 invite-notify module: Provides the invite-notify IRCv3.2
1004 # extension which notifies supporting clients when a user invites
1005 # another user into a channel. This respects <options:announceinvites>.
1006 #<module name="ircv3_invitenotify">
1008 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1009 # Join flood module: Adds support for join flood protection +j X:Y.
1010 # Closes the channel for N seconds if X users join in Y seconds.
1011 #<module name="joinflood">
1013 # The number of seconds to close the channel for:
1014 #<joinflood duration="1m">
1016 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1017 # Jump server module: Adds support for the RPL_REDIR numeric.
1018 # This module is oper-only.
1019 # To use, JUMPSERVER must be in one of your oper class blocks.
1020 # If your server is redirecting new clients and you get disconnected,
1021 # do a REHASH from shell to open up again.
1022 #<module name="jumpserver">
1024 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1025 # Anti auto rejoin: Adds support for prevention of auto-rejoin (+J).
1026 #<module name="kicknorejoin">
1028 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1029 # Knock module: Adds the /KNOCK command and channel mode +K.
1030 #<module name="knock">
1032 # This setting specifies what to do when someone successfully /KNOCKs.
1033 # If set to "notice", then a NOTICE will be sent to the channel.
1034 # This is the default and the compatible setting, as it requires no
1035 # special support from the clients.
1036 # If set to "numeric" then a 710 numeric will be sent to the channel.
1037 # This allows easier scripting but not all clients support it.
1038 # If set to "both" then (surprise!) both will be sent.
1039 #<knock notify="notice">
1041 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1042 # LDAP module: Allows other SQL modules to access a LDAP database
1043 # through a unified API.
1044 # This modules is in extras. Re-run configure with:
1045 # ./configure --enable-extras=m_ldap.cpp
1046 # and run make install, then uncomment this module to enable it.
1048 #<module name="ldap">
1049 #<database module="ldap" id="ldapdb" server="ldap://localhost" binddn="cn=Manager,dc=inspircd,dc=org" bindauth="mysecretpass" searchscope="subtree">
1050 # The server parameter indicates the LDAP server to connect to. The #
1051 # ldap:// style scheme before the hostname proper is MANDATORY. #
1053 # The binddn and bindauth indicate the DN to bind to for searching, #
1054 # and the password for the distinguished name. Some LDAP servers will #
1055 # allow anonymous searching in which case these two values do not #
1056 # need defining, otherwise they should be set similar to the examples #
1059 # The searchscope value indicates the subtree to search under. On our #
1060 # test system this is 'subtree'. Your mileage may vary. #
1062 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1063 # LDAP authentication module: Adds the ability to authenticate users #
1065 #<module name="ldapauth">
1069 # <ldapauth dbid="ldapdb" #
1070 # baserdn="ou=People,dc=brainbox,dc=cc" #
1072 # allowpattern="Guest* Bot*" #
1073 # killreason="Access denied" #
1075 # host="$uid.$ou.inspircd.org"> #
1077 # <ldapwhitelist cidr="10.42.0.0/16"> #
1079 # <ldaprequire attribute="attr" value="val"> #
1081 # The baserdn indicates the base DN to search in for users. Usually #
1082 # this is 'ou=People,dc=yourdomain,dc=yourtld'. #
1084 # The attribute value indicates the attribute which is used to locate #
1085 # a user account by name. On POSIX systems this is usually 'uid'. #
1087 # The allowpattern value allows you to specify a space separated list #
1088 # of wildcard masks which will always be allowed to connect #
1089 # regardless of if they have an account, for example guest and bot #
1092 # Killreason indicates the QUIT reason to give to users if they fail #
1093 # to authenticate. #
1095 # Setting the verbose value causes an oper notice to be sent out for #
1096 # every failed authentication to the server, with an error string. #
1098 # ldapwhitelist indicates that clients connecting from an IP in the #
1099 # provided CIDR do not need to authenticate against LDAP. It can be #
1100 # repeated to whitelist multiple CIDRs. #
1102 # ldaprequire allows further filtering on the LDAP user, by requiring #
1103 # certain LDAP attibutes to have a given value. It can be repeated, #
1104 # in which case the list will act as an OR list, that is, the #
1105 # authentication will succeed if any of the requirements in the list #
1108 # host allows you to change the displayed host of users connecting #
1109 # from ldap. The string supplied takes formatters which are replaced #
1110 # from the DN. For instance, if your DN looks like: #
1111 # uid=w00t,ou=people,dc=inspircd,dc=org, then the formatters uid, ou #
1112 # and dc will be available to you. If a key is given multiple times #
1113 # in the DN, the last appearance will take precedence. #
1115 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1116 # LDAP oper configuration module: Adds the ability to authenticate #
1118 #<module name="ldapoper">
1122 # <ldapoper dbid="ldapdb"
1123 # baserdn="ou=People,dc=brainbox,dc=cc"
1126 # Available configuration items are identical to the same items in #
1127 # ldapauth above (except for the verbose setting, that is only #
1128 # supported in ldapauth). #
1129 # Please always specify a password in your <oper> tags even if the #
1130 # opers are to be authenticated via LDAP, so in case this module is #
1131 # not loaded the oper accounts are still protected by a password. #
1133 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1134 # Lock server module: Adds /LOCKSERV and /UNLOCKSERV commands that #
1135 # are used to temporarily close/open the server for new connections. #
1136 # These commands require that the /LOCKSERV and /UNLOCKSERV commands #
1137 # are specified in a <class> tag that the oper is part of. This is so #
1138 # you can control who has access to this possible dangerous command. #
1139 # If your server is locked and you get disconnected, do a REHASH from #
1140 # shell to open up again. #
1141 # This module is oper-only.
1142 #<module name="lockserv">
1144 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1145 # Map hiding module: replaces /MAP and /LINKS output to users with a #
1146 # message to see a website, set by maphide="http://test.org/map" in #
1147 # the <security> tag, instead. #
1148 #<module name="maphide">
1150 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1151 # Message flood module: Adds message/notice flood protection via
1153 #<module name="messageflood">
1155 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1156 # MLOCK module: Adds support for server-side enforcement of services
1157 # side MLOCKs. Basically, this module suppresses any mode change that
1158 # would likely be immediately bounced by services.
1159 #<module name="mlock">
1161 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1162 # Modenotice module: Adds the /MODENOTICE command that allows opers to
1163 # send notices to all users having the given user mode(s) set.
1164 #<module name="modenotice">
1166 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1167 # Monitor module: Adds support for MONITOR which is used by clients to
1168 # maintain notify lists.
1169 #<module name="monitor">
1171 # Set the maximum number of entries on a user's monitor list below.
1172 #<monitor maxentries="30">
1174 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1175 # MySQL module: Allows other SQL modules to access MySQL databases
1176 # through a unified API.
1177 # This module is in extras. Re-run configure with:
1178 # ./configure --enable-extras=m_mysql.cpp
1179 # and run make install, then uncomment this module to enable it.
1180 #<module name="mysql">
1182 #-#-#-#-#-#-#-#-#-#-#-#- SQL CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#-#
1184 # mysql is more complex than described here, see the wiki for more #
1185 # info: http://wiki.inspircd.org/Modules/mysql #
1187 #<database module="mysql" name="mydb" user="myuser" pass="mypass" host="localhost" id="my_database2">
1189 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1190 # Named modes module: Allows for the display and set/unset of channel
1191 # modes via long-form mode names via +Z and the /PROP command.
1192 # For example, to set a ban, do /mode #channel +Z ban=foo!bar@baz or
1193 # /PROP #channel ban=foo!bar@baz
1194 #<module name="namedmodes">
1196 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1197 # NAMESX module: Provides support for the NAMESX extension which allows
1198 # clients to see all the prefixes set on a user without getting confused.
1199 # This is supported by mIRC, x-chat, klient, and maybe more.
1200 #<module name="namesx">
1202 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1203 # National characters module:
1204 # 1) Allows using national characters in nicknames.
1205 # 2) Allows using custom (national) casemapping over the network.
1206 #<module name="nationalchars">
1208 # file - Location of the file which contains casemapping rules. If this
1209 # is a relative path then it is relative to "<PWD>/../locales"
1210 # on UNIX and "<PWD>/locales" on Windows.
1211 # casemapping - The name of the casemapping sent to clients in the 005
1212 # numeric. If this is not set then it defaults to the name
1213 # of the casemapping file unless the file name contains a
1214 # space in which case you will have to specify it manually.
1215 #<nationalchars file="bynets/russian-w1251-charlink" casemapping="ru_RU.cp1251-charlink">
1217 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1218 # Nickchange flood protection module: Provides channel mode +F X:Y
1219 # which allows up to X nick changes in Y seconds.
1220 #<module name="nickflood">
1222 # The number of seconds to prevent nick changes for:
1223 #<nickflood duration="1m">
1225 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1226 # Nicklock module: Let opers change a user's nick and then stop that
1227 # user from changing their nick again until unlocked.
1228 # This module is oper-only.
1229 # To use, NICKLOCK and NICKUNLOCK must be in one of your oper class blocks.
1230 #<module name="nicklock">
1232 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1233 # No CTCP module: Adds the channel mode +C to block CTCPs and extban
1234 # 'C' to block CTCPs sent by specific users.
1235 #<module name="noctcp">
1237 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1238 # No kicks module: Adds the +Q channel mode and the Q: extban to deny
1239 # certain users from kicking.
1240 #<module name="nokicks">
1242 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1243 # No nicks module: Adds the +N channel mode, as well as the 'N' extban.
1244 # +N stops all users from changing their nick, the N extban stops
1245 # anyone from matching a +b N:nick!user@host mask from changing their
1247 #<module name="nonicks">
1249 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1250 # No part message module: Adds extban 'p' to block part messages from #
1252 #<module name="nopartmsg">
1254 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1255 # No notice module: Adds the channel mode +T and the extban 'T' to
1256 # block specific users from noticing the channel.
1257 #<module name="nonotice">
1259 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1260 # Network business join module:
1261 # Allows an oper to join a channel using /OJOIN, giving them +Y on the
1262 # channel which makes them immune to kick/deop/etc.
1263 #<module name="ojoin">
1265 # Specify the prefix that +Y will grant here.
1266 # Leave 'prefix' empty if you do not wish +Y to grant a prefix.
1267 # If 'notice' is set to on, upon /OJOIN, the server will notice the
1268 # channel saying that the oper is joining on network business.
1269 # If 'op' is set to on, it will give them +o along with +Y.
1270 #<ojoin prefix="!" notice="yes" op="yes">
1272 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1273 # Oper channels mode: Adds the +O channel mode and extban O:<mask>
1274 # to ban, except, etc. specific oper types. For example
1275 # /mode #channel +iI O:* is equivalent to channel mode +O, but you
1276 # may also set +iI O:AdminTypeOnly to only allow admins.
1277 # Modes +I and +e work in a similar fashion.
1278 #<module name="operchans">
1280 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1281 # Oper join module: Auto-joins opers to a channel upon oper-up.
1282 # This module is oper-only. For the user equivalent, see the conn_join
1284 #<module name="operjoin">
1286 #-#-#-#-#-#-#-#-#-#-# OPERJOIN CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
1288 # If you are using the operjoin module, specify options here: #
1290 # channel - The channel name to join, can also be a comma #
1291 # separated list e.g. "#channel1,#channel2". #
1293 # override - If on, lets the oper join walking thru any modes #
1294 # that might be set, even bans. #
1296 #<operjoin channel="#channel" override="no">
1298 # Alternatively you can use the autojoin="channellist" in a <type> #
1299 # tag to set specific autojoins for a type of oper, for example: #
1301 #<type name="Helper" autojoin="#help" classes="...">
1303 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1304 # Oper log module: Logs all oper commands to the server log (with log
1305 # type "m_operlog" at default loglevel), and optionally to the 'r'
1307 # This module is oper-only.
1308 #<module name="operlog">
1310 # If the following option is on then all oper commands will be sent to
1311 # the snomask 'r'. The default is off.
1312 #<operlog tosnomask="off">
1314 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1315 # Oper prefixing module: Adds a channel prefix mode +y which is given
1316 # to all IRC operators automatically on all channels they are in.
1317 # This prefix mode is more powerful than channel op and other regular
1320 # Load this module if you want all your IRC operators to have channel
1322 #<module name="operprefix">
1324 # You may additionally customise the prefix character.
1325 #<operprefix prefix="!">
1327 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1328 # Oper MOTD module: Provides support for separate message of the day
1330 # This module is oper-only.
1331 #<module name="opermotd">
1333 #-#-#-#-#-#-#-#-#-#-# OPERMOTD CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
1335 # If you are using the opermotd module, specify the motd here. #
1337 # onoper - If on, the message is sent on /OPER, otherwise it's #
1338 # only sent when /OPERMOTD is used. #
1340 # processcolors - Allow color codes to be processed in the opermotd. #
1341 # Read the comment above <connect:allowmotdcolors> in #
1342 # inspircd.conf.example for details. #
1344 #<opermotd file="examples/opermotd.txt.example" onoper="yes" processcolors="false">
1346 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1347 # Override module: Adds support for oper override.
1348 # This module is oper-only.
1349 #<module name="override">
1351 #-#-#-#-#-#-#-#-#-#-# OVERRIDE CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
1353 # override is too complex it describe here, see the wiki: #
1354 # http://wiki.inspircd.org/Modules/override #
1356 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1357 # Oper levels module: Gives each oper a level and prevents actions
1358 # being taken by lower level opers against higher level opers.
1359 # Specify the level as the 'level' parameter of the <type> tag.
1360 # This module is oper-only.
1361 #<module name="operlevels">
1363 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1364 # Oper modes module: Allows you to specify modes to add/remove on oper.
1365 # Specify the modes as the 'modes' parameter of the <type> tag
1366 # and/or as the 'modes' parameter of the <oper> tag.
1367 # This module is oper-only. For the user equivalent, see the
1368 # conn_umodes module.
1369 #<module name="opermodes">
1371 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1372 # Password forwarding module: Forwards a password users can send on
1373 # connect to the specified client below. The client is usually NickServ
1374 # and this module is usually used to authenticate users with NickServ
1375 # using their connect password.
1376 #<module name="passforward">
1379 # nick: nick to forward connect passwords to.
1382 # forwardmsg: Message to send to users using a connect password.
1383 # $nick will be the users' nick, $nickrequired will be the nick
1384 # of where the password is going (the nick above).
1385 # You can also use $user for the user ident string.
1386 forwardmsg="NOTICE $nick :*** Forwarding PASS to $nickrequired"
1388 # cmd: Command for the user to run when it receives a connect
1390 cmd="PRIVMSG $nickrequired :IDENTIFY $pass">
1392 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1393 # Password hash module: Allows hashed passwords to be used.
1394 # To be useful, a hashing module like bcrypt also needs to be loaded.
1395 #<module name="password_hash">
1397 #-#-#-#-#-#-#-#-#-# PASSWORD HASH CONFIGURATION #-#-#-#-#-#-#-#-#-#-#-#
1399 # To use this module, you must define a hash type for each oper's
1400 # password you want to hash. For example:
1402 # <oper name="Brain"
1403 # host="ident@dialup15.isp.test.com"
1405 # password="$2a$10$Mss9AtHHslZTLBrXqM0FB.JBwD.UTSu8A48SfrY9exrpxbsRiRTbO"
1408 # If you are using a hash algorithm which does not perform salting you can use
1409 # HMAC to salt your passwords in order to prevent them from being looked up in
1412 # hash="hmac-sha256" password="lkS1Nbtp$CyLd/WPQXizsbxFUTqFRoMvaC+zhOULEeZaQkUJj+Gg"
1414 # Generate hashes using the /MKPASSWD command on the server.
1415 # Don't run it on a server you don't trust with your password.
1417 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1418 # PBKDF2 module: Allows other modules to generate PBKDF2 hashes,
1419 # usually for cryptographic uses and security.
1420 # This module relies on other hash providers (e.g. SHA256).
1421 #<module name="pbkdf2">
1423 # iterations: Iterations the hashing function runs when generating new
1425 # length: Length in bytes of the derived key.
1426 #<pbkdf2 iterations="12288" length="32">
1427 # You can override these values with specific values
1428 # for specific providers if you want to. Example given for SHA256.
1429 #<pbkdf2prov hash="sha256" iterations="24576">
1431 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1432 # Permanent channels module: Channels with the permanent channel mode
1433 # will remain open even after everyone else has left the channel, and
1434 # therefore keep things like modes, ban lists and topic. Permanent
1435 # channels -may- need support from your Services package to function
1436 # properly with them. This adds channel mode +P.
1437 # This module is oper-only.
1438 #<module name="permchannels">
1440 # If you like, this module can write a config file of permanent channels
1441 # whenever +P is set, unset, or the topic/modes on a +P channel is changed.
1442 # If you want to do this, set the filename below, and uncomment the include.
1444 # If 'listmodes' is true then all list modes (+b, +I, +e, +g...) will be
1445 # saved. Defaults to false.
1446 #<permchanneldb filename="permchannels.conf" listmodes="true">
1447 #<include file="permchannels.conf">
1449 # You may also create channels on startup by using the <permchannels> block.
1450 # Don't forget to set them +P in the modes, or they won't stay permanent.
1451 #<permchannels channel="#opers" modes="isP" topic="Opers only.">
1453 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1454 # PostgreSQL module: Allows other SQL modules to access PgSQL databases
1455 # through a unified API.
1456 # This module is in extras. Re-run configure with:
1457 # ./configure --enable-extras=m_pgsql.cpp
1458 # and run make install, then uncomment this module to enable it.
1459 #<module name="pgsql">
1461 #-#-#-#-#-#-#-#-#-#-#-#- SQL CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#-#
1463 # pgsql is more complex than described here, see the wiki for #
1464 # more: http://wiki.inspircd.org/Modules/pgsql #
1466 #<database module="pgsql" name="mydb" user="myuser" pass="mypass" host="localhost" id="my_database" ssl="no">
1468 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1469 # Muteban: Implements extended ban 'm', which stops anyone matching
1470 # a mask like +b m:nick!user@host from speaking on channel.
1471 #<module name="muteban">
1473 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1474 # Random quote module: Provides a random quote on connect.
1475 # NOTE: Some of these may mimic fatal errors and confuse users and
1476 # opers alike - BEWARE!
1477 #<module name="randquote">
1479 #-#-#-#-#-#-#-#-#-#- RANDOMQUOTES CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
1481 # Optional - If you specify to use the randquote module, then specify #
1482 # below the path to the quotes file. #
1484 #<randquote file="quotes.txt">
1486 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1487 # Redirect module: Adds channel redirection mode +L. #
1488 # Optional: <redirect:antiredirect> to add usermode +L to stop forced #
1489 # redirection and instead print an error. #
1491 # Note: You can not update this with a simple rehash, it requires #
1492 # reloading the module for it to take effect. #
1493 # This also breaks linking to servers that do not have the option. #
1494 # This defaults to false for the 2.0 version, it will be enabled in #
1495 # all the future versions. #
1496 #<module name="redirect">
1497 #<redirect antiredirect="true">
1499 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1500 # Regular expression provider for glob or wildcard (?/*) matching.
1501 # You must have at least 1 provider loaded to use the filter or rline
1502 # modules. This module has no additional requirements, as it uses the
1503 # matching already present in InspIRCd core.
1504 #<module name="regex_glob">
1506 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1507 # Regular expression provider for PCRE (Perl-Compatible Regular
1508 # Expressions). You need libpcre installed to compile and load this
1509 # module. You must have at least 1 provider loaded to use the filter or
1511 #<module name="regex_pcre">
1513 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1514 # Regular Expression Provider for RE2 Regular Expressions.
1515 # You need libre2 installed and in your include/library paths in order
1516 # to compile and load this module.
1517 #<module name="regex_re2">
1519 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1520 # Regular expression provider for POSIX regular expressions.
1521 # You shouldn't need any additional libraries on a POSIX-compatible
1522 # system (i.e.: any Linux, BSD, but not Windows). You must have at
1523 # least 1 provider loaded to use filter or rline.
1524 # On POSIX-compliant systems, regex syntax can be found by using the
1525 # command: 'man 7 regex'.
1526 #<module name="regex_posix">
1528 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1529 # Regular expression provider for C++11 std::regex regular expressions.
1530 # This module works on any fully compliant implementation of the C++11
1531 # std::regex container. Examples for such are Visual C++ 2010 and newer
1532 # but not libstdc++ (which GCC uses).
1533 # You should verify that std::regex is supported by your setup before
1534 # using this module, as it may compile normally but won't do anything
1535 # on some implementations.
1536 #<module name="regex_stdlib">
1538 # Specify the regular expression engine to use here. Valid settings are
1539 # bre, ere, awk, grep, egrep, ecmascript (default if not specified).
1540 #<stdregex type="ecmascript">
1542 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1543 # Regular expression provider for TRE regular expressions.
1544 # This is the same regular expression engine used by UnrealIRCd, so
1545 # if you are most familiar with the syntax of /SPAMFILTER from there,
1546 # this is the provider you want. You need libtre installed in order
1547 # to compile and load this module.
1548 #<module name="regex_tre">
1550 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1551 # Registered users only channel creation module. If enabled, only
1552 # registered users and opers can create new channels.
1554 # You probably *DO NOT* want to load this module on a public network.
1556 #<module name="regonlycreate">
1558 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1559 # Remove module: Adds the /REMOVE command which is a peaceful
1560 # alternative to /KICK.
1561 #<module name="remove">
1563 # supportnokicks: If true, /REMOVE is not allowed on channels where the
1564 # nokicks (+Q) mode is set. Defaults to false.
1565 # protectedrank: Members having this rank or above may not be /REMOVE'd
1566 # by anyone. Set to 0 to disable this feature. Defaults to 50000.
1567 #<remove supportnokicks="true" protectedrank="50000">
1569 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1570 # A module to block, kick or ban upon similar messages being uttered several times.
1571 # Syntax [~*][lines]:[sec]{[:difference]}{[:matchlines]}
1572 # ~ is to block, * is to ban, default is kick.
1573 # 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
1574 # seconds - How old the message has to be before it's invalidated.
1575 # distance - Edit distance, in percent, between two strings to trigger on.
1576 # matchlines - When set, the function goes into mode 2. In this mode the function will trigger if this many of the last <lines> matches.
1578 # As this module can be rather CPU-intensive, it comes with some options.
1579 # maxbacklog - Maximum size that can be specified for backlog. 0 disables multiline matching.
1580 # maxdistance - Max percentage of difference between two lines we'll allow to match. Set to 0 to disable edit-distance matching.
1581 # maxlines - Max lines of backlog to match against.
1582 # maxsecs - Maximum value of seconds a user can set. 0 to allow any.
1583 # size - Maximum number of characters to check for, can be used to truncate messages
1584 # before they are checked, resulting in less CPU usage. Increasing this beyond 512
1585 # doesn't have any effect, as the maximum length of a message on IRC cannot exceed that.
1586 #<repeat maxbacklog="20" maxlines="20" maxdistance="50" maxsecs="0" size="512">
1587 #<module name="repeat">
1589 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1590 # Restricted channels module: Allows only opers to create channels.
1592 # You probably *DO NOT* want to load this module on a public network.
1594 #<module name="restrictchans">
1596 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1597 # Restrict message module: Allows users to only message opers.
1599 # You probably *DO NOT* want to load this module on a public network.
1601 #<module name="restrictmsg">
1603 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1604 # R-Line module: Ban users through regular expression patterns.
1605 #<module name="rline">
1607 #-#-#-#-#-#-#-#-#-#-#-#- RLINE CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#-#
1609 # If you wish to re-check a user when they change nickname (can be
1610 # useful under some situations, but *can* also use CPU with more users
1611 # on a server) then set 'matchonnickchange' to yes.
1612 # Also, this is where you set what Regular Expression engine is to be
1613 # used. If you ever change it while running, all of your R-Lines will
1614 # be wiped. This is the regex engine used by all R-Lines set, and
1615 # regex_<engine> must be loaded, or rline will be non-functional
1616 # until you load it or change the engine to one that is loaded.
1618 #<rline matchonnickchange="yes" engine="pcre">
1620 # Generally, you will NOT want to use 'glob' here, as this turns
1621 # rline into just another gline. The exceptions are that rline will
1622 # always use the full "nick!user@host realname" string, rather than only
1623 # user@host, but beware that only the ? and * wildcards are available,
1624 # and are the only way to specify where the space can occur if you do
1625 # use glob. For this reason, is recommended to use a real regex engine
1626 # so that at least \s or [[:space:]] is available.
1628 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1629 # RMODE module: Adds the /RMODE command
1630 # Allows channel mods to remove list modes en masse.
1631 # Syntax: /rmode <channel> <mode> [pattern]
1632 # E.g. '/rmode #Channel b m:*' will remove all mute-extbans on the channel.
1633 #<module name="rmode">
1635 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1636 # SAJOIN module: Adds the /SAJOIN command which forcibly joins a user
1637 # to the given channel.
1638 # This module is oper-only.
1639 # To use, SAJOIN must be in one of your oper class blocks.
1640 # Opers need the users/sajoin-others priv to be able to /SAJOIN users
1641 # other than themselves.
1642 #<module name="sajoin">
1644 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1645 # SAKICK module: Adds the /SAKICK command which kicks a user from the
1647 # This module is oper-only.
1648 # To use, SAKICK must be in one of your oper class blocks.
1649 #<module name="sakick">
1651 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1652 # SAMODE module: Adds the /SAMODE command which allows server operators
1653 # to change modes on a channel without requiring them to have any
1654 # channel priviliges. Also allows changing user modes for any user.
1655 # This module is oper-only.
1656 # To use, SAMODE must be in one of your oper class blocks.
1657 #<module name="samode">
1659 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1660 # SANICK module: Adds the /SANICK command which allows opers to change
1662 # This module is oper-only.
1663 # To use, SANICK must be in one of your oper class blocks.
1664 #<module name="sanick">
1666 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1667 # SAPART module: Adds the /SAPART command which forcibly parts a user
1669 # This module is oper-only.
1670 # To use, SAPART must be in one of your oper class blocks.
1671 #<module name="sapart">
1673 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1674 # SAQUIT module: Adds the /SAQUIT command which forcibly quits a user.
1675 # This module is oper-only.
1676 # To use, SAQUIT must be in one of your oper class blocks.
1677 #<module name="saquit">
1679 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1680 # SATOPIC module: Adds the /SATOPIC command which allows changing the
1681 # topic on a channel without requiring any channel priviliges.
1682 # This module is oper-only.
1683 # To use, SATOPIC must be in one of your oper class blocks.
1684 #<module name="satopic">
1686 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1687 # SASL authentication module: Provides support for IRC Authentication
1688 # Layer via AUTHENTICATE. Note: You also need to have cap loaded
1690 #<module name="sasl">
1692 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1693 # Secure list module: Prevent /LIST in the first minute of connection,
1694 # crippling most spambots and trojan spreader bots.
1695 #<module name="securelist">
1697 #-#-#-#-#-#-#-#-#-# SECURELIST CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#-#
1699 # Securelist can be harmful to some IRC search engines such as #
1700 # netsplit.de and searchirc.com. To prevent securelist blocking these #
1701 # sites from listing, define exception tags as shown below: #
1702 #<securehost exception="*@*.searchirc.org">
1703 #<securehost exception="*@*.netsplit.de">
1704 #<securehost exception="*@echo940.server4you.de">
1705 #<securehost exception="*@*.ircdriven.com">
1707 # Define the following variable to change how long a user must wait #
1708 # before issuing a LIST. If not defined, defaults to 60 seconds. #
1710 #<securelist waittime="60"> #
1712 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1713 # Servprotect module: Provides support for Austhex style +k /
1714 # UnrealIRCD +S services mode.
1715 #<module name="servprotect">
1717 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1718 # See nicks module: Adds snomask +n and +N which show local and remote
1720 # This module is oper-only.
1721 #<module name="seenicks">
1723 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1724 # Set idle module: Adds a command for opers to change their idle time.
1725 # This module is oper-only.
1726 # To use, SETIDLE must be in one of your oper class blocks.
1727 #<module name="setidle">
1729 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1730 # Services support module: Adds several usermodes such as +R and +M.
1731 # This module implements the 'identified' state via account names,
1732 # and is similar in operation to the way asuka and ircu handle services.
1734 # At the same time, this offers +r for users and channels to mark them
1735 # as identified separately from the idea of a master account, which
1736 # can be useful for services which are heavily nick-as-account centric.
1738 # Also of note is that this module implements two extbans:
1739 # +b R: (stop matching account names from joining)
1740 # +b U:n!u@h (blocks matching unregistered users)
1742 #<module name="services_account">
1744 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1745 # Sethost module: Adds the /SETHOST command.
1746 # This module is oper-only.
1747 # To use, SETHOST must be in one of your oper class blocks.
1748 # See the chghost module for how to customise valid chars for hostnames.
1749 #<module name="sethost">
1751 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1752 # Setident module: Adds the /SETIDENT command.
1753 # This module is oper-only.
1754 # To use, SETIDENT must be in one of your oper class blocks.
1755 #<module name="setident">
1757 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1758 # SETNAME module: Adds the /SETNAME command.
1759 #<module name="setname">
1761 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1762 # Serverban: Implements extended ban 's', which stops anyone connected
1763 # to a server matching a mask like +b s:server.mask.here from joining.
1764 #<module name="serverban">
1766 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1767 # SHA1 module: Allows other modules to generate SHA1 hashes.
1768 # Required by the WebSocket module.
1769 #<module name="sha1">
1771 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1772 # Showfile: Provides support for showing a text file to users when #
1773 # they enter a command. #
1774 # This module adds one command for each <showfile> tag that shows the #
1775 # given file to the user as a series of messages or numerics. #
1776 #<module name="showfile"> #
1778 #-#-#-#-#-#-#-#-#-#-# SHOWFILE CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#-#
1780 # name - The name of the command which displays this file. This is #
1781 # the only mandatory setting, all others are optional. #
1782 # file - The text file to be shown to the user. #
1783 # By default same as the command name. #
1784 # method - How should the file be shown? #
1785 # * numeric: Send contents using a numeric #
1786 # (similar to /MOTD; the default). #
1787 # * notice: Send contents as a series of notices. #
1788 # * msg: Send contents as a series of private messages. #
1789 # colors - If true, color codes (\c, \b, \u, etc.) will be processed #
1790 # and sent as ANSI colors. If false (default) the file will #
1791 # be displayed as-is. #
1793 # When using the method "numeric", the following extra settings are #
1796 # introtext - Introductory line, "Showing <name>" by default. #
1797 # intronumeric - Numeric used for the introductory line. #
1798 # numeric - Numeric used for sending the text itself. #
1799 # endtext - Ending line, "End of <name>" by default. #
1800 # endnumeric - Numeric used for the ending line. #
1802 #<showfile name="RULES"
1805 # introtext="Server rules:"
1806 # endtext="End of server rules.">
1808 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1809 # Show whois module: Adds the +W usermode which allows opers to see
1810 # when they are /WHOIS'd.
1811 # This module is oper-only by default.
1812 #<module name="showwhois">
1814 # If you wish, you may also let users set this mode. Only opers with the
1815 # users/auspex priv will see real hosts of people, though.
1816 #<showwhois opersonly="yes"
1818 # You may also set whether or not users should receive whois notices,
1819 # should they be /WHOIS'd by an oper.
1820 #showfromopers="yes">
1822 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1823 # Shun module: Provides the /SHUN command, which stops a user from
1824 # executing all except configured commands.
1825 # This module is oper-only.
1826 # To use, SHUN must be in one of your oper class blocks.
1827 #<module name="shun">
1829 # You may also configure which commands you wish a user to be able to
1830 # perform when shunned. It should be noted that if a shunned user
1831 # issues QUIT or PART then their message will be removed, as if they
1832 # did not issue one.
1834 # You can optionally let the user know that their command was blocked.
1836 # You may also let SHUN affect opers (defaults to no).
1837 #<shun enabledcommands="PING PONG QUIT PART JOIN" notifyuser="yes" affectopers="no">
1839 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1840 # SSL channel mode module: Adds support for SSL-only channels via
1841 # channel mode +z and the 'z' extban which matches SSL client
1842 # certificate fingerprints.
1843 # Does not do anything useful without a working SSL module (see below).
1844 #<module name="sslmodes">
1846 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1847 # GnuTLS SSL module: Adds support for SSL connections using GnuTLS,
1848 # if enabled. You must answer 'yes' in ./configure when asked or
1849 # manually symlink the source for this module from the directory
1850 # src/modules/extra, if you want to enable this, or it will not load.
1851 #<module name="ssl_gnutls">
1853 #-#-#-#-#-#-#-#-#-#-#- GNUTLS CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#
1855 # ssl_gnutls is too complex to describe here, see the wiki: #
1856 # http://wiki.inspircd.org/Modules/ssl_gnutls #
1858 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1859 # SSL info module: Allows users to retrieve information about other
1860 # users' peer SSL certificates and keys. This can be used by client
1861 # scripts to validate users. For this to work, one of ssl_gnutls
1862 # or ssl_openssl must be loaded. This module also adds the
1863 # "* <user> is using a secure connection" whois line, the ability for
1864 # opers to use SSL cert fingerprints to verify their identity and the
1865 # ability to force opers to use SSL connections in order to oper up.
1866 # It is highly recommended to load this module if you use SSL on your
1868 # For how to use the oper features, please see the first example <oper> tag
1869 # in opers.conf.example.
1871 #<module name="sslinfo">
1873 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1874 # mbedTLS SSL module: Adds support for SSL/TLS connections using mbedTLS.
1875 #<module name="ssl_mbedtls">
1877 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1878 # OpenSSL SSL module: Adds support for SSL connections using OpenSSL,
1879 # if enabled. You must answer 'yes' in ./configure when asked or symlink
1880 # the source for this module from the directory src/modules/extra, if
1881 # you want to enable this, or it will not load.
1882 #<module name="ssl_openssl">
1884 #-#-#-#-#-#-#-#-#-#-#- OPENSSL CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#
1886 # ssl_openssl is too complex to describe here, see the wiki: #
1887 # http://wiki.inspircd.org/Modules/ssl_openssl #
1889 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1890 # Strip color module: Adds channel mode +S that strips color codes and
1891 # all control codes except CTCP from all messages sent to the channel.
1892 #<module name="stripcolor">
1894 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1895 # Silence module: Adds support for the /SILENCE command, which allows
1896 # users to have a server-side ignore list for their client.
1897 #<module name="silence">
1899 # Set the maximum number of entries allowed on a user's silence list.
1900 #<silence maxentries="32"
1902 # Whether messages from U-lined servers will bypass silence masks.
1905 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1906 # SQLite3 module: Allows other SQL modules to access SQLite3 #
1907 # databases through a unified API. #
1908 # This module is in extras. Re-run configure with: #
1909 # ./configure --enable-extras=m_sqlite.cpp
1910 # and run make install, then uncomment this module to enable it. #
1912 #<module name="sqlite3">
1914 #-#-#-#-#-#-#-#-#-#-#-#- SQL CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#-#
1916 # sqlite is more complex than described here, see the wiki for more #
1917 # info: http://wiki.inspircd.org/Modules/sqlite3 #
1919 #<database module="sqlite" hostname="/full/path/to/database.db" id="anytext">
1921 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1922 # SQL authentication module: Allows IRCd connections to be tied into
1923 # a database table (for example a forum).
1924 # This module is in extras. Re-run configure with:
1925 # ./configure --enable-extras=m_sqlauth.cpp
1926 # and run make install, then uncomment this module to enable it.
1928 #<module name="sqlauth">
1930 #-#-#-#-#-#-#-#-#-#-#- SQLAUTH CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#
1932 # sqlauth is too complex to describe here, see the wiki: #
1933 # http://wiki.inspircd.org/Modules/sqlauth #
1935 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1936 # SQL oper module: Allows you to store oper credentials in an SQL table
1937 # This module is in extras. Re-run configure with:
1938 # ./configure --enable-extras=m_sqloper.cpp
1939 # and run make install, then uncomment this module to enable it.
1941 #<module name="sqloper">
1943 #-#-#-#-#-#-#-#-#-#-#- SQLOPER CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#
1945 # dbid - Database ID to use (see SQL modules). #
1946 # hash - Hashing provider to use for password hashing. #
1948 # See also: http://wiki.inspircd.org/Modules/sqloper #
1950 #<sqloper dbid="1" hash="bcrypt">
1952 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1953 # StartTLS module: Implements STARTTLS, which allows clients #
1954 # connected to non SSL enabled ports to enable SSL, if a proper SSL #
1955 # module is loaded (either ssl_gnutls or ssl_openssl). #
1956 #<module name="starttls">
1958 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1959 # SVSHold module: Implements SVSHOLD. Like Q:Lines, but can only be #
1960 # added/removed by Services. #
1961 #<module name="svshold">
1962 # SVSHOLD does not generate server notices by default, you can turn
1963 # notices on by uncommenting the next line.
1964 #<svshold silent="false">
1966 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1967 # SWHOIS module: Allows you to add arbitrary lines to user WHOIS.
1968 # This module is oper-only.
1969 # To use, SWHOIS must be in one of your oper class blocks.
1970 #<module name="swhois">
1972 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1973 # Timed bans module: Adds timed channel bans with the /TBAN command.
1974 #<module name="timedbans">
1976 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1977 # Test line module: Adds the /TLINE command, used to test how many
1978 # users a /GLINE or /ZLINE etc. would match.
1979 # This module is oper-only.
1980 # To use, TLINE must be in one of your oper class blocks.
1981 #<module name="tline">
1983 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1984 # Topiclock module: implements server-side topic locking to achieve deeper
1985 # integration with services packages.
1986 #<module name="topiclock">
1988 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1989 # UHNAMES support module: Adds support for the IRCX style UHNAMES
1990 # extension, which displays ident and hostname in the names list for
1991 # each user, saving clients from doing a WHO on the channel.
1992 # If a client does not support UHNAMES it will not enable it, this will
1993 # not break incompatible clients.
1994 #<module name="uhnames">
1996 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1997 # Uninvite module: Adds the /UNINVITE command which lets users remove
1998 # pending invites from channels without waiting for the user to join.
1999 #<module name="uninvite">
2001 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2002 # Userip module: Adds the /USERIP command.
2003 # Allows users to query their own IP, also allows opers to query the IP
2005 #<module name="userip">
2007 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2008 # Vhost module: Adds the VHOST command which allows for adding virtual
2009 # hosts which are accessible using a username and password in the config.
2010 #<module name="vhost">
2012 #-#-#-#-#-#-#-#-#-#-#- VHOST CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#-#
2014 # user - Username for the vhost. #
2016 # pass - Password for the vhost. #
2018 # hash - The hash for the specific user (optional) #
2019 # password_hash and a hashing module must be loaded for #
2022 # host - Vhost to set. #
2024 #<vhost user="some_username" pass="some_password" host="some.host.test.cc">
2025 #<vhost user="foo" password="$2a$10$iTuYLT6BRhRlOgzfsW9oPe62etW.oXwSpyKw5rJit64SGZanLXghO" hash="bcrypt" host="some.other.host.example.com">
2027 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2028 # Watch module: Adds the WATCH command, which is used by clients to
2029 # maintain notify lists.
2030 #<module name="watch">
2032 # Set the maximum number of entries on a user's watch list below.
2033 #<watch maxentries="32">
2035 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2036 # WebSocket module: Adds HTML5 WebSocket support.
2037 # Specify hook="websocket" in a <bind> tag to make that port accept
2038 # WebSocket connections. Compatible with SSL/TLS.
2039 # Requires SHA-1 hash support available in the sha1 module.
2040 #<module name="websocket">
2042 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2043 # XLine database: Stores all *Lines (G/Z/K/R/any added by other modules)
2044 # in a file which is re-loaded on restart. This is useful
2045 # for two reasons: it keeps bans so users may not evade them, and on
2046 # bigger networks, server connections will take less time as there will
2047 # be a lot less bans to apply - as most of them will already be there.
2048 #<module name="xline_db">
2050 # Specify the filename for the xline database here.
2051 #<xlinedb filename="data/xline.db">
2053 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2054 # ____ _ _____ _ _ ____ _ _ _ #
2055 # | _ \ ___ __ _ __| | |_ _| |__ (_)___ | __ )(_) |_| | #
2056 # | |_) / _ \/ _` |/ _` | | | | '_ \| / __| | _ \| | __| | #
2057 # | _ < __/ (_| | (_| | | | | | | | \__ \ | |_) | | |_|_| #
2058 # |_| \_\___|\__,_|\__,_| |_| |_| |_|_|___/ |____/|_|\__(_) #
2060 # To link servers to InspIRCd, you MUST load the spanningtree module. #
2061 # If you don't do this, server links will NOT work at all. #
2062 # This is by design, to allow for the implementation of other linking #
2063 # protocols in modules in the future. #
2065 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2066 # Spanning tree module: Allows linking of servers using the spanning
2067 # tree protocol (see the READ THIS BIT section above).
2068 # You will almost always want to load this.
2070 #<module name="spanningtree">
projects / user / henk / code / inspircd.git / blob