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 m_spanningtree #
23 # module. If you don't do this, server links will NOT work at all. #
24 # This is by design, to allow for the implementation of other linking #
25 # protocols in modules in the future. #
28 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
29 # MD5 module: Allows other modules to generate MD5 hashes, usually for
30 # cryptographic uses and security.
33 # Other modules such as m_cloaking.so and m_password_hash.so may rely on
34 # this module being loaded to function.
36 #<module name="m_md5.so">
38 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
39 # SHA256 module: Allows other modules to generate SHA256 hashes,
40 # usually for cryptographic uses and security.
43 # Other modules such as m_password_hash.so may rely on this module being
44 # loaded to function. Certain modules such as m_spanningtree.so will
45 # function without this module but when it is loaded their features will
46 # be enhanced (for example the addition of HMAC authentication).
48 #<module name="m_sha256.so">
49 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
50 # RIPEMD160 module: Allows other modules to generate RIPEMD160 hashes,
51 # usually for cryptographic uses and security.
54 # Other modules may rely on this module being loaded to function.
55 #<module name="m_ripemd160.so">
57 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
58 # Abbreviation module: Provides the ability to abbreviate commands a-la
60 #<module name="m_abbreviation.so">
62 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
63 # Alias module: Allows you to define server-side command aliases.
64 #<module name="m_alias.so">
66 # Set the 'prefix' for in-channel aliases (fantasy commands) to the
67 # specified character. If not set, the default is "!".
68 # If 'allowbots' is disabled, +B clients will not be able to use
69 # fantasy commands. If not set, the default is no.
70 #<fantasy prefix="!" allowbots="no">
72 #-#-#-#-#-#-#-#-#-#-#- ALIAS DEFINITIONS -#-#-#-#-#-#-#-#-#-#-#-#-#-#
74 # If you have the m_alias.so module loaded, you may also define #
75 # aliases as shown below. They are commonly used to provide shortcut #
76 # commands to services, however they are not limited to just this use.#
77 # An alias tag requires the following values to be defined in it: #
79 # text - The text to detect as the actual command line. #
80 # Can't contain spaces, but case insensitive. #
81 # You may have multiple aliases with the same #
82 # command name (text="" value), however the first #
83 # found will be executed if its format value is #
84 # matched, or it has no format value. Aliases are #
85 # read from the top of the file to the bottom. #
87 # usercommand - If this is true, the alias can be run simply as #
88 # /aliasname. Defaults to true. #
90 # channelcommand - If this is true, the alias can be used as an #
91 # in-channel alias or 'fantasy command', prefixed #
92 # by the fantasy prefix character, !aliasname by #
93 # default. Defaults to false. #
95 # format - If this is defined, the parameters of the alias #
96 # must match this glob pattern. For example if you #
97 # want the first parameter to start with a # for #
98 # the alias to be executed, set format="#*" in the #
99 # alias definition. Note that the :'s which are #
100 # part of IRC formatted lines will be preserved #
101 # for matching of this text. This value is #
104 # replace - The text to replace 'text' with. Usually this #
105 # will be "PRIVMSG ServiceName :$2-" or similar. #
106 # You may use the variables $1 through $9 in the #
107 # replace string, which refer to the first through #
108 # ninth word in the original string typed by the #
109 # user. You may also use $1- through $9- which #
110 # refer to the first word onwards, through to the #
111 # ninth word onwards, e.g. if the user types the #
112 # command "foo bar baz qux quz" then $3- will hold #
113 # "baz qux quz" and $2 will contain "bar". You may #
114 # also use the special variables: $nick, $ident, #
115 # $host and $vhost, and you may separate multiple #
116 # commands with a newline (which can be written in #
117 # the file literally, or encoded as &nl; or \n #
118 # depending on the config format setting). #
120 # requires - If you provide a value for 'requires' this means #
121 # the given nickname MUST be online for the alias #
122 # to successfully trigger. If they are not, then #
123 # the user receives a 'no such nick' 401 numeric. #
125 # uline - Setting this to true will ensure that the user #
126 # given in 'requires' is also on a u-lined server, #
127 # as well as actually being on the network. If the #
128 # user is online, but not on a u-lined server, #
129 # then an oper alert is sent out as this is #
130 # possibly a sign of a user trying to impersonate #
133 # operonly - If true, this will make the alias oper only. #
134 # If a non-oper attempts to use the alias, it will #
135 # appear to not exist. #
137 #<alias text="NICKSERV" replace="PRIVMSG NickServ :$2-" requires="NickServ" uline="yes">
138 #<alias text="CHANSERV" replace="PRIVMSG ChanServ :$2-" requires="ChanServ" uline="yes">
139 #<alias text="OPERSERV" replace="PRIVMSG OperServ :$2-" requires="OperServ" uline="yes" operonly="yes">
140 #<alias text="BOTSERV" replace="PRIVMSG BotServ :$2-" requires="BotServ" uline="yes">
141 #<alias text="HOSTSERV" replace="PRIVMSG HostServ :$2-" requires="HostServ" uline="yes">
142 #<alias text="MEMOSERV" replace="PRIVMSG MemoServ :$2-" requires="MemoServ" uline="yes">
143 #<alias text="NS" replace="PRIVMSG NickServ :$2-" requires="NickServ" uline="yes">
144 #<alias text="CS" replace="PRIVMSG ChanServ :$2-" requires="ChanServ" uline="yes">
145 #<alias text="OS" replace="PRIVMSG OperServ :$2-" requires="OperServ" uline="yes" operonly="yes">
146 #<alias text="BS" replace="PRIVMSG BotServ :$2-" requires="BotServ" uline="yes">
147 #<alias text="HS" replace="PRIVMSG HostServ :$2-" requires="HostServ" uline="yes">
148 #<alias text="MS" replace="PRIVMSG MemoServ :$2-" requires="MemoServ" uline="yes">
150 # An example of using the format value to create an alias with two
151 # different behaviours depending on the format of the parameters.
153 #<alias text="ID" format="#*" replace="PRIVMSG ChanServ :IDENTIFY $2 $3"
154 # requires="ChanServ" uline="yes">
156 #<alias text="ID" replace="PRIVMSG NickServ :IDENTIFY $2"
157 # requires="NickServ" uline="yes">
159 # This alias fixes a glitch in xchat 2.6.x and above and the way it
160 # assumes IDENTIFY must be prefixed by a colon (:) character. It should
161 # be placed ABOVE the default NICKSERV alias (the first example) listed
164 #<alias text="NICKSERV" format=":IDENTIFY *" replace="PRIVMSG NickServ :IDENTIFY $3-"
165 # requires="NickServ" uline="yes">
167 # You may also add aliases to trigger based on something said in a
168 # channel, aka 'fantasy' commands, configured in the same manner as any
169 # other alias, with usercommand="no" and channelcommand="yes" The
170 # command must be preceded by the fantasy prefix when used.
172 #<alias text="CS" usercommand="no" channelcommand="yes"
173 # replace="PRIVMSG ChanServ :$1 $chan $2-" requires="ChanServ" uline="yes">
175 # This would be used as "!cs <command> <options>", with the channel
176 # being automatically inserted after the command in the message to
177 # ChanServ, assuming the fantasy prefix is "!".
179 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
180 # Allowinvite module: Gives channel mode +A to allow all users to use
181 # /INVITE, and extban A to deny invite from specific masks.
182 #<module name="m_allowinvite.so">
184 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
185 # Alltime module: Shows time on all connected servers at once.
186 # This module is oper-only and provides /ALLTIME.
187 # To use, ALLTIME must be in one of your oper class blocks.
188 #<module name="m_alltime.so">
190 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
191 # Auditorium module: Adds channel mode +u which makes everyone else
192 # except you in the channel invisible, used for large meetings etc.
193 #<module name="m_auditorium.so">
195 # Auditorium settings:
197 #<auditorium opvisible="no" opcansee="no" opercansee="yes">
199 # opvisible (auditorium-vis in exemptchanops):
200 # Show channel ops to all users
201 # opcansee (auditorium-see in exemptchanops):
202 # Allow ops to see all joins/parts/kicks in the channel
204 # Allow opers (channels/auspex) to see see all joins/parts/kicks in the channel
206 # Exemptchanops can be used to adjust the level at which users become visible or
207 # the level at which they can see the full member list of the channel.
209 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
210 # Autoop module: Adds basic channel access controls via the +w listmode.
211 # For example +w o:*!Attila@127.0.0.1 will op anyone matching that mask
212 # on join. This can be combined with extbans, for example +w o:R:Brain
213 # will op anyone identified to the account "Brain".
214 # Another useful combination is with SSL client certificate
215 # fingerprints: +w h:z:72db600734bb9546c1bdd02377bc21d2a9690d48 will
216 # give halfop to the user(s) having the given certificate.
217 #<module name="m_autoop.so">
219 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
220 # Ban except module: Adds support for channel ban exceptions (+e).
221 #<module name="m_banexception.so">
223 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
224 # Ban redirection module: Allows bans which redirect to a specified
225 # channel. e.g. +b nick!ident@host#channelbanneduserissentto
226 #<module name="m_banredirect.so">
228 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
229 # bcrypt module: Allows other modules to generate bcrypt hashes,
230 # usually for cryptographic uses and security.
231 #<module name="m_bcrypt.so">
233 # rounds: Defines how many rounds the bcrypt function will run when
234 # generating new hashes.
235 #<bcrypt rounds="10">
237 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
238 # Block amsg module: Attempt to block all usage of /amsg and /ame.
239 #<module name="m_blockamsg.so">
241 #-#-#-#-#-#-#-#-#-#-#- BLOCKAMSG CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
243 # If you have the m_blockamsg.so module loaded, you can configure it #
244 # with the <blockamsg> tag: #
246 # delay - How many seconds between two messages to force #
247 # them to be recognised as unrelated. #
248 # action - Any of 'notice', 'noticeopers', 'silent', 'kill' #
249 # or 'killopers'. Define how to take action when #
250 # a user uses /amsg or /ame. #
252 #<blockamsg delay="3" action="killopers">
254 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
255 # Block CAPS module: Adds channel mode +B, blocks all-CAPS messages.
256 #<module name="m_blockcaps.so">
258 #-#-#-#-#-#-#-#-#-#-#- BLOCKCAPS CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
260 # percent - How many percent of text must be caps before text #
263 # minlen - The minimum length a line must be for the block #
264 # percent to have any effect. #
266 # capsmap - A list of chars to be considered CAPS. Can be used #
267 # to add CAPS characters for your language. Also you #
268 # can add things like ! and space to further lock #
269 # down on caps usage. #
270 #<blockcaps percent="50"
272 # capsmap="ABCDEFGHIJKLMNOPQRSTUVWXYZ! ">
274 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
275 # Block color module: Blocking color-coded messages with chan mode +c.
276 #<module name="m_blockcolor.so">
278 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
279 # Botmode module: Adds the user mode +B. If set on a user, it will
280 # show that the user is a bot in /WHOIS.
281 #<module name="m_botmode.so">
283 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
284 # CallerID module: Adds usermode +g which activates hybrid-style
285 # callerid: block all private messages unless you /ACCEPT first.
286 #<module name="m_callerid.so">
288 #-#-#-#-#-#-#-#-#-#-#- CALLERID CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#
289 # maxaccepts - Maximum number of entries a user can add to his #
290 # /ACCEPT list. Default is 16 entries. #
291 # operoverride - Can opers (note: ALL opers) override callerid? #
293 # tracknick - Preserve /accept entries when a user changes nick? #
294 # If no (the default), the user is removed from #
295 # everyone's accept list if he changes nickname. #
296 # cooldown - Amount of time (in seconds) that must pass since #
297 # the last notification sent to a user before he can #
298 # be sent another. Default is 60 (1 minute). #
299 #<callerid maxaccepts="16"
304 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
305 # CAP module: Provides the CAP negotiation mechanism seen in
306 # ratbox-derived ircds.
307 #<module name="m_cap.so">
309 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
310 # CBAN module: Lets you disallow channels from being used at runtime.
311 # This module is oper-only and provides /CBAN.
312 # To use, CBAN must be in one of your oper class blocks.
313 #<module name="m_cban.so">
315 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
316 # Censor module: Adds channel and user mode +G.
317 #<module name="m_censor.so">
319 #-#-#-#-#-#-#-#-#-#-#- CENSOR CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#
321 # Optional - If you specify to use the m_censor module, then you must #
322 # specify some censor tags. See also: #
323 # http://wiki.inspircd.org/Modules/censor #
325 #<include file="examples/censor.conf.example">
327 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
328 # CGI:IRC module: Adds support for automatic host changing in CGI:IRC
329 # (http://cgiirc.sourceforge.net).
330 # Adds snomask +w for monitoring CGI:IRC connections.
331 #<module name="m_cgiirc.so">
333 #-#-#-#-#-#-#-#-#-#-#-# CGIIRC CONFIGURATION #-#-#-#-#-#-#-#-#-#-#-#-#
335 # Optional - If you specify to use m_cgiirc, then you must specify one
336 # or more cgihost tags which indicate authorised CGI:IRC servers which
337 # will be connecting to your network, and an optional cgiirc tag.
338 # For more information see: http://wiki.inspircd.org/Modules/cgiirc
340 # Set to yes if you want to notice opers when CGI:IRC clients connect.
341 # <cgiirc opernotice="no">
343 # The type field indicates where the module should get the real
344 # client's IP address from, for further information, please see the
345 # CGI:IRC documentation.
348 # <cgihost type="pass" mask="www.mysite.com"> # Get IP from PASS
349 # <cgihost type="ident" mask="otherbox.mysite.com"> # Get IP from ident
350 # <cgihost type="passfirst" mask="www.mysite.com"> # See the docs
352 # <cgihost type="webirc" password="foobar"
353 # mask="somebox.mysite.com"> # Get IP from WEBIRC
358 # When you connect CGI:IRC clients, there are two connect classes which
359 # apply to these clients. When the client initially connects, the connect
360 # class which matches the CGI:IRC site's host is checked. Therefore you
361 # must raise the maximum local/global clients for this ip as high as you
362 # want to allow cgi clients. After the client has connected and is
363 # determined to be a cgi:irc client, the class which matches the client's
364 # real IP is then checked. You may set this class to a lower value, so that
365 # the real IP of the client can still be restricted to, for example, 3
368 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
369 # Channel create module: Adds snomask +j, which will notify opers of
370 # any new channels that are created.
371 # This module is oper-only.
372 #<module name="m_chancreate.so">
374 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
375 # Channel filter module: Allows channel-op defined message filtering
376 # using simple string matches (channel mode +g).
377 #<module name="m_chanfilter.so">
379 # If hidemask is set to yes, the user will not be shown the mask when
380 # his/her message is blocked.
381 #<chanfilter hidemask="yes">
383 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
384 # Channel history module: Displays the last 'X' lines of chat to a user
385 # joining a channel with +H 'X:T' set; 'T' is the maximum time to keep
386 # lines in the history buffer. Designed so that the new user knows what
387 # the current topic of conversation is when joining the channel.
388 #<module name="m_chanhistory.so">
390 # Set the maximum number of lines allowed to be stored per channel below.
391 # This is the hard limit for 'X'.
392 # If notice is set to yes, joining users will get a NOTICE before playback
393 # telling them about the following lines being the pre-join history.
394 # If bots is set to yes, it will also send to users marked with +B
395 #<chanhistory maxlines="20" notice="yes" bots="yes">
397 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
398 # Channel logging module: Used to send snotice output to channels, to
399 # allow staff to centrally monitor and discuss network activity.
401 # The "channel" field is where you want the messages to go, "snomasks"
402 # is what snomasks you want to be sent to that channel. Multiple tags
404 #<module name="m_chanlog.so">
405 #<chanlog snomasks="AOcC" channel="#opers">
407 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
408 # Channel names module: Allows disabling channels which have certain
409 # characters in the channel name such as bold, colorcodes, etc. which
410 # can be quite annoying and allow users to on occasion have a channel
411 # that looks like the name of another channel on the network.
412 #<module name="m_channames.so">
415 # denyrange: characters or range of characters to deny in channel
419 # allowrange: characters or range of characters to specifically allow
423 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
424 # Channelban: Implements extended ban j:, which stops anyone already
425 # in a channel matching a ban like +b j:#channel*mask from joining.
426 #<module name="m_channelban.so">
428 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
429 # Check module: Adds the /CHECK command.
430 # Check is useful for looking up information on channels, users,
431 # IP addresses and hosts.
432 # This module is oper-only.
433 # To use, CHECK must be in one of your oper class blocks.
434 #<module name="m_check.so">
436 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
437 # CHGHOST module: Adds the /CHGHOST command.
438 # This module is oper-only.
439 # To use, CHGHOST must be in one of your oper class blocks.
440 # NOTE: Services will not be able to set vhosts on users if this module
441 # isn't loaded. If you're planning on running services, you probably
443 #<module name="m_chghost.so">
445 #-#-#-#-#-#-#-#-# /CHGHOST - /SETHOST CONFIGURATION #-#-#-#-#-#-#-#-#
446 # Optional - If you want to use special chars for hostnames you can #
447 # specify your own custom list of chars with the <hostname> tag: #
449 # charmap - A list of chars accepted as valid by the /CHGHOST #
450 # and /SETHOST commands. Also note that the list is #
452 #<hostname charmap="abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ.-_/0123456789">
454 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
455 # CHGIDENT module: Adds the /CHGIDENT command.
456 # This module is oper-only.
457 # To use, CHGIDENT must be in one of your oper class blocks.
458 #<module name="m_chgident.so">
460 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
461 # CHGNAME module: Adds the /CHGNAME command.
462 # This module is oper-only.
463 # To use, CHGNAME must be in one of your oper class blocks.
464 #<module name="m_chgname.so">
466 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
467 # Clear chan module: Allows opers to masskick, masskill or mass-G/ZLine
468 # all users on a channel using /CLEARCHAN.
469 #<module name="m_clearchan.so">
471 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
472 # Cloaking module: Adds usermode +x and cloaking support.
473 # Relies on the module m_md5.so being loaded.
474 # To cloak users when they connect, load m_conn_umodes and set
475 # <connect:modes> to include the +x mode. The example <connect> tag
476 # shows this. See the m_conn_umodes module for more information.
477 #<module name="m_cloaking.so">
479 #-#-#-#-#-#-#-#-#-#-#- CLOAKING CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#
481 # To use m_cloaking, you must define a cloak key, and optionally a #
482 # cloak prefix as shown below. The cloak key must be shared across #
483 # the network for correct cloaking. #
485 # There are two methods of cloaking: #
487 # half Cloak only the "unique" portion of a host; show #
488 # the last 2 parts of the domain, /16 subnet of IPv4 #
489 # or /48 subnet of the IPv6 address. #
491 # full Cloak the users completely, using three slices for #
492 # common CIDR bans (IPv4: /16, /24; IPv6: /48, /64). #
494 # The methods use a single key that can be any length of text. #
495 # An optional prefix may be specified to mark cloaked hosts. #
496 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
502 #-#-#-#-#-#-#-#-#-#-#-#- CLOSE MODULE #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
503 # Close module: Allows an oper to close all unregistered connections.
504 # This module is oper-only and provides the /CLOSE command.
505 # To use, CLOSE must be in one of your oper class blocks.
506 #<module name="m_close.so">
508 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
509 # Clones module: Adds an oper command /CLONES for detecting cloned
510 # users. Warning: This command may be resource intensive when it is
511 # issued, use with care.
512 # This module is oper-only.
513 # To use, CLONES must be in one of your oper class blocks.
514 #<module name="m_clones.so">
516 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
517 # Common channels module: Adds user mode +c, which, when set, requires
518 # that users must share a common channel with you to PRIVMSG or NOTICE
520 #<module name="m_commonchans.so">
522 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
523 # Auto join on connect module: Allows you to force users to join one
524 # or more channels automatically upon connecting to the server, or
525 # join them in case they aren't on any channels after being online
527 #<module name="m_conn_join.so">
529 #-#-#-#-#-#-#-#-#-#-#-#- CONNJOIN CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
531 # If you have m_conn_join.so loaded, you can configure it using the
532 # following values, or set autojoin="#chat,#help" in <connect> blocks.
534 # Join users immediately after connection to #one #two and #three.
535 #<autojoin channel="#one,#two,#three">
536 # Join users to #chat after 15 seconds if they aren't on any channels.
537 #<autojoin channel="#chat" delay="15">
539 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
540 # Set modes on connect module: When this module is loaded <connect>
541 # blocks may have an optional modes="" value, which contains modes to
542 # add or remove from users when they connect to the server.
543 #<module name="m_conn_umodes.so">
545 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
546 # Wait for PONG on connect module: Send a PING to all connecting users
547 # and don't let them connect until they reply with a PONG.
548 # This is useful to stop certain kinds of bots and proxies.
549 #<module name="m_conn_waitpong.so">
551 #-#-#-#-#-#-#-#-#-#-#- WAITPONG CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
553 # If you have the m_conn_waitpong.so module loaded, configure it with #
554 # the <waitpong> tag: #
556 # sendsnotice - Whether to send a helpful notice to users on #
557 # connect telling them how to connect, should #
558 # their client not reply PONG automatically. #
560 # killonbadreply - Whether to kill the user if they send the wrong #
563 #<waitpong sendsnotice="yes" killonbadreply="yes">
565 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
566 # Channel cycle module: Adds the /CYCLE command which is a server-side
567 # /HOP that bypasses restrictive modes.
568 #<module name="m_cycle.so">
570 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
571 # Connectban: Provides IP connection throttling. Any IP range that
572 # connects too many times (configurable) in an hour is Z-Lined for a
573 # (configurable) duration, and their count resets to 0.
574 #<module name="m_connectban.so">
576 # ipv4cidr and ipv6cidr allow you to turn the comparison from
577 # individual IP addresses (32 and 128 bits) into CIDR masks, to allow
578 # for throttling over whole ISPs/blocks of IPs, which may be needed to
581 # This allows for 10 connections in an hour with a 10 minute ban if
583 #<connectban threshold="10" duration="10m" ipv4cidr="32" ipv6cidr="128"
584 # A custom ban message may optionally be specified.
585 # 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.">
587 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
588 # Connection throttle module.
589 #<module name="m_connflood.so">
591 #-#-#-#-#-#-#-#-#-#-#- CONNTHROTTLE CONFIGURATION -#-#-#-#-#-#-#-#-#-#
592 # seconds, maxconns - Amount of connections per <seconds>.
594 # timeout - Time to wait after the throttle was activated
595 # before deactivating it. Be aware that the time
596 # is seconds + timeout.
598 # quitmsg - The message that users get if they attempt to
599 # connect while the throttle is active.
601 # bootwait - Amount of time in seconds to wait before enforcing
602 # the throttling when the server just booted.
604 #<connflood seconds="30" maxconns="3" timeout="30"
605 # quitmsg="Throttled" bootwait="10">
607 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
608 # Custom prefixes: Allows for channel prefixes to be added.
609 #<module name="m_customprefix.so">
611 # name The name of the mode, must be unique from other modes.
612 # letter The letter used for this mode. Required.
613 # prefix The prefix used for nicks with this mode. Not required.
614 # rank A numeric rank for this prefix, defining what permissions it gives.
615 # The rank of voice, halfop and op is 10000, 20000, and 30000,
617 # ranktoset The numeric rank required to set/unset this mode. Defaults to rank.
618 # depriv Can you remove the mode from yourself? Defaults to yes.
619 #<customprefix name="founder" letter="q" prefix="~" rank="50000" ranktoset="50000">
620 #<customprefix name="admin" letter="a" prefix="&" rank="40000" ranktoset="50000">
621 #<customprefix name="halfop" letter="h" prefix="%" rank="20000" ranktoset="30000">
622 #<customprefix name="halfvoice" letter="V" prefix="-" rank="1" ranktoset="20000">
624 # Do /RELOADMODULE m_customprefix.so after changing the settings of this module.
626 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
627 # Custom title module: Adds the /TITLE command which allows for trusted
628 # users to gain a custom whois line and an optional vhost can be
630 #<module name="m_customtitle.so">
632 #-#-#-#-#-#-#-#-#-#- CUSTOM TITLE CONFIGURATION -#-#-#-#-#-#-#-#-#-#
633 # name - The username used to identify.
634 # password - The password used to identify.
635 # hash - The hash for the specific user's password (optional).
636 # m_password_hash.so and a hashing module must be loaded
638 # host - Allowed hostmask (optional).
639 # title - Title shown in whois.
640 # vhost - Displayed host (optional).
642 #<title name="foo" password="bar" title="Official Chat Helper">
643 #<title name="bar" password="foo" host="ident@host.name" title="Official Chat Helper" vhost="helper.network.chat">
644 #<title name="foo" password="fcde2b2edba56bf408601fb721fe9b5c338d10ee429ea04fae5511b68fbf8fb9" hash="sha256" title="Official Chat Helper">
646 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
647 # DCCALLOW module: Adds the /DCCALLOW command.
648 #<module name="m_dccallow.so">
650 #-#-#-#-#-#-#-#-#-#-#- DCCALLOW CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
651 # blockchat - Whether to block DCC CHAT as well as DCC SEND.
652 # length - Default duration of entries in DCCALLOW list.
653 # action - Default action to take if no action is
654 # specified, can be 'block' or 'allow'.
656 # File configuration:
657 # pattern - The glob pattern to match against.
658 # action - Action to take if a user attempts to send a file
659 # that matches this pattern, can be 'block' or
662 #<dccallow blockchat="yes" length="5m" action="block">
663 #<banfile pattern="*.exe" action="block">
664 #<banfile pattern="*.txt" action="allow">
666 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
667 # Deaf module: Adds support for the usermode +d - deaf to channel
668 # messages and channel notices.
669 #<module name="m_deaf.so">
671 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
672 # Delay join module: Adds the channel mode +D which delays all JOIN
673 # messages from users until they speak. If they quit or part before
674 # speaking, their quit or part message will not be shown to the channel
675 # which helps cut down noise on large channels in a more friendly way
676 # than the auditorium mode. Only channel ops may set the +D mode.
677 #<module name="m_delayjoin.so">
679 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
680 # Delay message module: Adds the channel mode +d which disallows a user
681 # from talking in the channel unless they've been joined for X seconds.
682 # Settable using /MODE #chan +d 30
683 #<module name="m_delaymsg.so">
684 # Set allownotice to no to disallow NOTICEs too. Defaults to yes.
685 #<delaymsg allownotice="no">
687 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
688 # Deny channels module: Deny channels from being used by users.
689 #<module name="m_denychans.so">
691 #-#-#-#-#-#-#-#-#-#-#- DENYCHAN DEFINITIONS -#-#-#-#-#-#-#-#-#-#-#-#
693 # If you have the m_denychans.so module loaded, you need to specify #
694 # the channels to deny: #
696 # name - The channel name to deny (glob masks are ok). #
697 # allowopers - If operators are allowed to override the deny. #
698 # reason - Reason given for the deny. #
699 # redirect - Redirect the user to a different channel. #
701 #<badchan name="#gods*" allowopers="yes" reason="Tortoises!"> #
702 #<badchan name="#heaven" redirect="#hell" reason="Nice try!"> #
704 # Redirects will not work if the target channel is set +L. #
706 # Additionally, you may specify channels which are allowed, even if #
707 # a badchan tag specifies it would be denied: #
708 #<goodchan name="#godsleeps"> #
709 # Glob masks are accepted here also. #
711 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
712 # Devoice module: Let users devoice themselves using /DEVOICE #chan.
713 #<module name="m_devoice.so">
715 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
716 # DNS blacklist module: Provides support for looking up IPs on one or #
718 #<module name="m_dnsbl.so"> #
720 # For configuration options please see the wiki page for m_dnsbl at #
721 # http://wiki.inspircd.org/Modules/dnsbl #
723 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
724 # Exempt channel operators module: Provides support for allowing #
725 # channel operators to be exempt from some channel modes. Supported #
726 # modes are blockcaps, noctcp, blockcolor, nickflood, flood, censor, #
727 # filter, regmoderated, nonick, nonotice, and stripcolor. #
728 #<module name="m_exemptchanops.so"> #
730 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
731 # Filter module: Provides message filtering, similar to SPAMFILTER. #
732 #<module name="m_filter.so">
734 # This module depends upon a regex provider such as m_regex_pcre or #
735 # m_regex_glob to function. You must specify which of these you want #
736 # m_filter to use via the tag below. #
738 # Valid engines are: #
740 # glob - Glob patterns, provided via m_regex_glob. #
741 # pcre - PCRE regexps, provided via m_regex_pcre, needs libpcre. #
742 # tre - TRE regexps, provided via m_regex_tre, requires libtre. #
743 # posix - POSIX regexps, provided via m_regex_posix, not available #
744 # on Windows, no dependencies on other operating systems. #
745 # stdlib - stdlib regexps, provided via m_regex_stdlib, see comment #
746 # at the <module> tag for info on availability. #
748 #<filteropts engine="glob"> #
750 # Your choice of regex engine must match on all servers network-wide.
752 # To learn more about the configuration of this module, read #
753 # examples/filter.conf.example, which covers the various types of #
754 # filters and shows how to add exemptions. #
756 #-#-#-#-#-#-#-#-#-#-#- FILTER CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#
758 # Optional - If you specify to use the m_filter module, then #
759 # specify below the path to the filter.conf file, or define some #
762 #<include file="examples/filter.conf.example">
764 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
765 # Flash Policy Daemon module: Allows Flash IRC clients (e.g. LightIRC)#
766 # to connect. If no file is specified, it'll serve a default policy #
767 # allowing all IPs to connect to all plaintext IRC ports #
768 #<bind address="" port="8430" type="flashpolicyd"> #
769 #<flashpolicyd timeout="5" file=""> #
770 #<module name="m_flashpolicyd.so"> #
772 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
773 # Gecos ban: Implements extended ban 'r', which stops anyone matching
774 # a mask like +b r:*realname?here* from joining a channel.
775 #<module name="m_gecosban.so">
777 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
778 # GeoIP module: Allows the server admin to match users by country code.
779 # This module is in extras. Re-run configure with:
780 # ./configure --enable-extras=m_geoip.cpp
781 # and run make install, then uncomment this module to enable it.
782 # This module requires GeoIP to be installed on your system,
783 # use your package manager to find the appropriate packages
784 # or check the InspIRCd wiki page for this module.
785 #<module name="m_geoip.so">
787 # The actual allow/ban actions are done by connect classes, not by the
788 # GeoIP module. An example connect class to ban people from russia or
791 # <connect deny="*" geoip="TR,RU">
793 # The country code must be in capitals and should be an ISO country
794 # code such as TR, GB, or US. Unknown IPs (localhost, LAN IPs, etc)
795 # will be assigned the country code "UNK". Since connect classes are
796 # matched from top down, your deny classes must be above your allow
797 # classes for them to match.
799 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
800 # Globops module: Provides the /GLOBOPS command and snomask +g.
801 # This module is oper-only.
802 # To use, GLOBOPS must be in one of your oper class blocks.
803 #<module name="m_globops.so">
805 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
806 # Global load module: Allows loading and unloading of modules network-
807 # wide (USE WITH EXTREME CAUTION!)
808 # This module is oper-only and provides /GLOADMODULE, /GUNLOADMODULE
809 # and /GRELOADMODULE.
810 # To use, GLOADMODULE, GUNLOADMODULE and GRELOADMODULE
811 # must be in one of your oper class blocks.
812 #<module name="m_globalload.so">
814 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
815 # HELPOP module: Provides the /HELPOP command
816 #<module name="m_helpop.so">
818 #-#-#-#-#-#-#-#-#-#-#-#- HELPOP CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
820 # If you specify to use the m_helpop.so module, then specify below #
821 # the path to the helpop.conf file. #
823 #<include file="examples/inspircd.helpop-full.example">
825 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
826 # Hide chans module: Allows users to hide their channels list from non-
827 # opers by setting user mode +I on themselves.
828 #<module name="m_hidechans.so">
830 # This mode can optionally prevent opers from seeing channels on a +I
831 # user, for more privacy if set to true.
832 # This setting is not recommended for most mainstream networks.
833 #<hidechans affectsopers="false">
835 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
836 # Hide list module: Allows for hiding the list of listmodes from users
837 # who do not have sufficient channel rank.
838 #<module name="m_hidelist.so">
840 # Each <hidelist> tag configures one listmode to hide.
841 # mode: Name of the listmode to hide.
842 # rank: Minimum rank required to view the list. If set to 0, all
843 # members of the channel may view the list, but non-members may not.
844 # The rank of the built-in op and voice mode is 30000 and 10000,
845 # respectively; the rank of other prefix modes is configurable.
848 # Hiding the ban list is not recommended because it may break some
851 # Hide filter (+g) list:
852 #<hidelist mode="filter" rank="30000">
853 # Only show invite exceptions (+I) to channel members:
854 #<hidelist mode="invex" rank="0">
856 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
857 # Hide oper module: Allows opers to hide their oper status from non-
858 # opers by setting user mode +H on themselves.
859 # This module is oper-only.
860 #<module name="m_hideoper.so">
862 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
863 # Hostchange module: Allows a different style of cloaking.
864 #<module name="m_hostchange.so">
866 #-#-#-#-#-#-#-#-#-#-#- HOSTCHANGE CONFIGURATION -#-#-#-#-#-#-#-#-#-#
868 # See http://wiki.inspircd.org/Modules/hostchange for help. #
870 #<host suffix="polarbears.org" separator="." prefix="">
871 #<hostchange mask="*@fbi.gov" action="addnick">
872 #<hostchange mask="*r00t@*" action="suffix">
873 #<hostchange mask="a@b.com" action="set" value="blah.blah.blah">
874 #<hostchange mask="localhost" ports="7000,7001,7005-7007" action="set" value="blahblah.foo">
876 # hostcycle: If loaded, when a user gets a host or ident set, it will
877 # cycle them in all their channels. If not loaded it will simply change
878 # their host/ident without cycling them.
879 #<module name="m_hostcycle.so">
881 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
882 # httpd module: Provides HTTP server support for InspIRCd.
883 #<module name="m_httpd.so">
885 #-#-#-#-#-#-#-#-#-#-#-#- HTTPD CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
887 # If you choose to use the m_httpd.so module, then you will need to add
888 # a <bind> tag with type "httpd", and load at least one of the other
889 # m_httpd_* modules to provide pages to display.
891 # You can adjust the timeout for HTTP connections below. All HTTP
892 # connections will be closed after (roughly) this many seconds.
893 #<httpd timeout="20">
895 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
896 # HTTP ACL module: Provides access control lists for m_httpd dependent
897 # modules. Use this module to restrict pages by IP address and by
899 #<module name="m_httpd_acl.so">
901 #-#-#-#-#-#-#-#-#-#-#-#- HTTPD ACL CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
903 # Restrict access to the m_httpd_stats module to all but the local
904 # network and when the correct password is specified:
905 # <httpdacl path="/stats*" types="password,whitelist"
906 # username="secretstuff" password="mypasshere" whitelist="127.0.0.*,10.*">
908 # Deny all connections to all but the main index page:
909 # <httpdacl path="/*" types="blacklist" blacklist="*">
911 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
912 # HTTP config module: Allows the configuration of the server to be
913 # viewed over HTTP. Requires m_httpd.so to be loaded for it to function.
914 #<module name="m_httpd_config.so">
916 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
917 # HTTP stats module: Provides basic stats pages over HTTP.
918 # Requires m_httpd.so to be loaded for it to function.
919 #<module name="m_httpd_stats.so">
921 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
922 # Ident: Provides RFC 1413 ident lookup support.
923 # When this module is loaded <connect:allow> tags may have an optional
924 # useident="yes|no" boolean value, determining whether or not to lookup
925 # ident on users matching that connect tag.
926 #<module name="m_ident.so">
928 #-#-#-#-#-#-#-#-#-#-#-#- IDENT CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
930 # Optional - If you are using the m_ident.so module, then you can #
931 # specify the timeout for ident lookups here. If not defined, it will #
932 # default to 5 seconds. This is a non-blocking timeout which holds #
933 # the user in a 'connecting' state until the lookup is complete. #
934 # The bind value indicates which IP to bind outbound requests to. #
935 # nolookupprefix: If on, the idents of users being in a connect class #
936 # with ident lookups disabled (i.e. <connect useident="off">) will be #
937 # prefixed with a "~". If off, the ident of those users will not be #
938 # prefixed. Default is off. #
940 #<ident timeout="5" nolookupprefix="no">
942 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
943 # Invite exception module: Adds support for channel invite exceptions
945 #<module name="m_inviteexception.so">
946 # Does a +I bypass channel +k in addition to +i?
947 #<inviteexception bypasskey="yes">
949 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
950 # IRCv3 module: Provides the following IRCv3.1 extensions:
951 # extended-join, away-notify and account-notify. These are optional
952 # enhancements to the client-to-server protocol. An extension is only
953 # active for a client when the client specifically requests it, so this
954 # module needs m_cap to work.
956 # Further information on these extensions can be found at the IRCv3
957 # working group website:
958 # http://ircv3.org/extensions/
960 #<module name="m_ircv3.so">
961 # The following block can be used to control which extensions are
962 # enabled. Note that extended-join can be incompatible with m_delayjoin
964 #<ircv3 accountnotify="on" awaynotify="on" extendedjoin="on">
966 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
967 # Join flood module: Adds support for join flood protection +j X:Y.
968 # Closes the channel for 60 seconds if X users join in Y seconds.
969 #<module name="m_joinflood.so">
971 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
972 # Jump server module: Adds support for the RPL_REDIR numeric.
973 # This module is oper-only.
974 # To use, JUMPSERVER must be in one of your oper class blocks.
975 # If your server is redirecting new clients and you get disconnected,
976 # do a REHASH from shell to open up again.
977 #<module name="m_jumpserver.so">
979 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
980 # Anti auto rejoin: Adds support for prevention of auto-rejoin (+J).
981 #<module name="m_kicknorejoin.so">
983 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
984 # Knock module: Adds the /KNOCK command and channel mode +K.
985 #<module name="m_knock.so">
987 # This setting specifies what to do when someone successfully /KNOCKs.
988 # If set to "notice", then a NOTICE will be sent to the channel.
989 # This is the default and the compatible setting, as it requires no
990 # special support from the clients.
991 # If set to "numeric" then a 710 numeric will be sent to the channel.
992 # This allows easier scripting but not all clients support it.
993 # If set to "both" then (surprise!) both will be sent.
994 #<knock notify="notice">
996 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
997 # LDAP module: Allows other SQL modules to access a LDAP database
998 # through a unified API.
999 # This modules is in extras. Re-run configure with:
1000 # ./configure --enable-extras=m_ldap.cpp
1001 # and run make install, then uncomment this module to enable it.
1003 #<module name="m_ldap.so">
1004 #<database module="ldap" id="ldapdb" server="ldap://localhost" binddn="cn=Manager,dc=inspircd,dc=org" bindauth="mysecretpass" searchscope="subtree">
1005 # The server parameter indicates the LDAP server to connect to. The #
1006 # ldap:// style scheme before the hostname proper is MANDATORY. #
1008 # The binddn and bindauth indicate the DN to bind to for searching, #
1009 # and the password for the distinguished name. Some LDAP servers will #
1010 # allow anonymous searching in which case these two values do not #
1011 # need defining, otherwise they should be set similar to the examples #
1014 # The searchscope value indicates the subtree to search under. On our #
1015 # test system this is 'subtree'. Your mileage may vary. #
1017 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1018 # LDAP authentication module: Adds the ability to authenticate users #
1020 #<module name="m_ldapauth.so">
1024 # <ldapauth dbid="ldapdb" #
1025 # baserdn="ou=People,dc=brainbox,dc=cc" #
1027 # allowpattern="Guest* Bot*" #
1028 # killreason="Access denied" #
1030 # host="$uid.$ou.inspircd.org"> #
1032 # <ldapwhitelist cidr="10.42.0.0/16"> #
1034 # <ldaprequire attribute="attr" value="val"> #
1036 # The baserdn indicates the base DN to search in for users. Usually #
1037 # this is 'ou=People,dc=yourdomain,dc=yourtld'. #
1039 # The attribute value indicates the attribute which is used to locate #
1040 # a user account by name. On POSIX systems this is usually 'uid'. #
1042 # The allowpattern value allows you to specify a space separated list #
1043 # of wildcard masks which will always be allowed to connect #
1044 # regardless of if they have an account, for example guest and bot #
1047 # Killreason indicates the QUIT reason to give to users if they fail #
1048 # to authenticate. #
1050 # Setting the verbose value causes an oper notice to be sent out for #
1051 # every failed authentication to the server, with an error string. #
1053 # ldapwhitelist indicates that clients connecting from an IP in the #
1054 # provided CIDR do not need to authenticate against LDAP. It can be #
1055 # repeated to whitelist multiple CIDRs. #
1057 # ldaprequire allows further filtering on the LDAP user, by requiring #
1058 # certain LDAP attibutes to have a given value. It can be repeated, #
1059 # in which case the list will act as an OR list, that is, the #
1060 # authentication will succeed if any of the requirements in the list #
1063 # host allows you to change the displayed host of users connecting #
1064 # from ldap. The string supplied takes formatters which are replaced #
1065 # from the DN. For instance, if your DN looks like: #
1066 # uid=w00t,ou=people,dc=inspircd,dc=org, then the formatters uid, ou #
1067 # and dc will be available to you. If a key is given multiple times #
1068 # in the DN, the last appearance will take precedence. #
1070 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1071 # LDAP oper configuration module: Adds the ability to authenticate #
1073 #<module name="m_ldapoper.so">
1077 # <ldapoper dbid="ldapdb"
1078 # baserdn="ou=People,dc=brainbox,dc=cc"
1081 # Available configuration items are identical to the same items in #
1082 # m_ldapauth above (except for the verbose setting, that is only #
1083 # supported in m_ldapauth). #
1084 # Please always specify a password in your <oper> tags even if the #
1085 # opers are to be authenticated via LDAP, so in case this module is #
1086 # not loaded the oper accounts are still protected by a password. #
1088 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1089 # Lock server module: Adds /LOCKSERV and /UNLOCKSERV commands that #
1090 # are used to temporarily close/open the server for new connections. #
1091 # These commands require that the /LOCKSERV and /UNLOCKSERV commands #
1092 # are specified in a <class> tag that the oper is part of. This is so #
1093 # you can control who has access to this possible dangerous command. #
1094 # If your server is locked and you get disconnected, do a REHASH from #
1095 # shell to open up again. #
1096 # This module is oper-only.
1097 #<module name="m_lockserv.so">
1099 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1100 # Map hiding module: replaces /MAP and /LINKS output to users with a #
1101 # message to see a website, set by maphide="http://link.to/site" in #
1102 # the <security> tag, instead. #
1103 #<module name="m_maphide.so">
1105 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1106 # Message flood module: Adds message/notice flood protection via
1108 #<module name="m_messageflood.so">
1110 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1111 # MLOCK module: Adds support for server-side enforcement of services
1112 # side MLOCKs. Basically, this module suppresses any mode change that
1113 # would likely be immediately bounced by services.
1114 #<module name="m_mlock.so">
1116 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1117 # Modenotice module: Adds the /MODENOTICE command that allows opers to
1118 # send notices to all users having the given user mode(s) set.
1119 #<module name="m_modenotice.so">
1121 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1122 # MsSQL module: Allows other SQL modules to access MS SQL Server
1123 # through a unified API.
1124 # This module is in extras. Re-run configure with:
1125 # ./configure --enable-extras=m_mssql.cpp
1126 # and run make install, then uncomment this module to enable it.
1127 #<module name="m_mssql.so">
1129 #-#-#-#-#-#-#-#-#-#-#-#- SQL CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#-#
1131 # m_mssql.so is more complex than described here, see wiki for more #
1132 # info http://wiki.inspircd.org/Modules/mssql #
1134 #<database module="mssql" name="db" user="user" pass="pass" host="localhost" id="db1">
1136 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1137 # MySQL module: Allows other SQL modules to access MySQL databases
1138 # through a unified API.
1139 # This module is in extras. Re-run configure with:
1140 # ./configure --enable-extras=m_mysql.cpp
1141 # and run make install, then uncomment this module to enable it.
1142 #<module name="m_mysql.so">
1144 #-#-#-#-#-#-#-#-#-#-#-#- SQL CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#-#
1146 # m_mysql.so is more complex than described here, see the wiki for #
1147 # more: http://wiki.inspircd.org/Modules/mysql #
1149 #<database module="mysql" name="mydb" user="myuser" pass="mypass" host="localhost" id="my_database2">
1151 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1152 # Named modes module: Allows for the display and set/unset of channel
1153 # modes via long-form mode names via +Z and the /PROP command.
1154 # For example, to set a ban, do /mode #channel +Z ban=foo!bar@baz or
1155 # /PROP #channel ban=foo!bar@baz
1156 #<module name="m_namedmodes.so">
1158 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1159 # NAMESX module: Provides support for the NAMESX extension which allows
1160 # clients to see all the prefixes set on a user without getting confused.
1161 # This is supported by mIRC, x-chat, klient, and maybe more.
1162 #<module name="m_namesx.so">
1164 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1165 # National characters module:
1166 # 1) Allows using national characters in nicknames.
1167 # 2) Allows using custom (national) casemapping over the network.
1168 #<module name="m_nationalchars.so">
1170 # file - filename of existing file in "locales" directory
1171 # casemapping - custom value for 005 numeric (if you want it to be
1172 # different from the filename). Set this to the name of
1173 # the locale if you are specifying an absolute path.
1174 #<nationalchars file="bynets/russian-w1251-charlink" casemapping="ru_RU.cp1251-charlink">
1176 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1177 # Nickchange flood protection module: Provides channel mode +F X:Y
1178 # which allows up to X nick changes in Y seconds.
1179 #<module name="m_nickflood.so">
1181 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1182 # Nicklock module: Let opers change a user's nick and then stop that
1183 # user from changing their nick again until unlocked.
1184 # This module is oper-only.
1185 # To use, NICKLOCK and NICKUNLOCK must be in one of your oper class blocks.
1186 #<module name="m_nicklock.so">
1188 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1189 # No CTCP module: Adds the channel mode +C to block CTCPs and extban
1190 # 'C' to block CTCPs sent by specific users.
1191 #<module name="m_noctcp.so">
1193 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1194 # No kicks module: Adds the +Q channel mode and the Q: extban to deny
1195 # certain users from kicking.
1196 #<module name="m_nokicks.so">
1198 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1199 # No nicks module: Adds the +N channel mode, as well as the 'N' extban.
1200 # +N stops all users from changing their nick, the N extban stops
1201 # anyone from matching a +b N:nick!user@host mask from changing their
1203 #<module name="m_nonicks.so">
1205 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1206 # No part message module: Adds extban 'p' to block part messages from #
1208 #<module name="m_nopartmsg.so">
1210 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1211 # No notice module: Adds the channel mode +T and the extban 'T' to
1212 # block specific users from noticing the channel.
1213 #<module name="m_nonotice.so">
1215 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1216 # Network business join module:
1217 # Allows an oper to join a channel using /OJOIN, giving them +Y on the
1218 # channel which makes them immune to kick/deop/etc.
1219 #<module name="m_ojoin.so">
1221 # Specify the prefix that +Y will grant here.
1222 # Leave 'prefix' empty if you do not wish +Y to grant a prefix.
1223 # If 'notice' is set to on, upon /OJOIN, the server will notice the
1224 # channel saying that the oper is joining on network business.
1225 # If 'op' is set to on, it will give them +o along with +Y.
1226 #<ojoin prefix="!" notice="yes" op="yes">
1228 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1229 # Oper channels mode: Adds the +O channel mode and extban O:<mask>
1230 # to ban, except, etc. specific oper types. For example
1231 # /mode #channel +iI O:* is equivalent to channel mode +O, but you
1232 # may also set +iI O:AdminTypeOnly to only allow admins.
1233 # Modes +I and +e work in a similar fashion.
1234 #<module name="m_operchans.so">
1236 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1237 # Oper join module: Auto-joins opers to a channel upon oper-up.
1238 # This module is oper-only. For the user equivalent, see m_conn_join.
1239 #<module name="m_operjoin.so">
1241 #-#-#-#-#-#-#-#-#-#-# OPERJOIN CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
1243 # If you are using the m_operjoin.so module, specify options here: #
1245 # channel - The channel name to join, can also be a comma #
1246 # separated list e.g. "#channel1,#channel2". #
1248 # override - If on, lets the oper join walking thru any modes #
1249 # that might be set, even bans. #
1251 #<operjoin channel="#channel" override="no">
1253 # Alternatively you can use the autojoin="channellist" in a <type> #
1254 # tag to set specific autojoins for a type of oper, for example: #
1256 #<type name="Helper" autojoin="#help" classes="...">
1258 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1259 # Oper log module: Logs all oper commands to the server log (with log
1260 # type "m_operlog" at default loglevel), and optionally to the 'r'
1262 # This module is oper-only.
1263 #<module name="m_operlog.so">
1265 # If the following option is on then all oper commands will be sent to
1266 # the snomask 'r'. The default is off.
1267 #<operlog tosnomask="off">
1269 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1270 # Oper prefixing module: Adds a channel prefix mode +y which is given
1271 # to all IRC operators automatically on all channels they are in.
1272 # This prefix mode is more powerful than channel op and other regular
1275 # Load this module if you want all your IRC operators to have channel
1277 #<module name="m_operprefix.so">
1279 # You may additionally customise the prefix character.
1280 #<operprefix prefix="!">
1282 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1283 # Oper MOTD module: Provides support for separate message of the day
1285 # This module is oper-only.
1286 #<module name="m_opermotd.so">
1288 #-#-#-#-#-#-#-#-#-#-# OPERMOTD CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
1290 # If you are using the m_opermotd.so module, specify the motd here. #
1292 # onoper - If on, the message is sent on /OPER, otherwise it's #
1293 # only sent when /OPERMOTD is used. #
1295 # processcolors - Allow color codes to be processed in the opermotd. #
1296 # Read the comment above <connect:allowmotdcolors> in #
1297 # inspircd.conf.example for details. #
1299 #<opermotd file="examples/opermotd.txt.example" onoper="yes" processcolors="false">
1301 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1302 # Override module: Adds support for oper override.
1303 # This module is oper-only.
1304 #<module name="m_override.so">
1306 #-#-#-#-#-#-#-#-#-#-# OVERRIDE CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
1308 # m_override.so is too complex it describe here, see the wiki: #
1309 # http://wiki.inspircd.org/Modules/override #
1311 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1312 # Oper levels module: Gives each oper a level and prevents actions
1313 # being taken by lower level opers against higher level opers.
1314 # Specify the level as the 'level' parameter of the <type> tag.
1315 # This module is oper-only.
1316 #<module name="m_operlevels.so">
1318 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1319 # Oper modes module: Allows you to specify modes to add/remove on oper.
1320 # Specify the modes as the 'modes' parameter of the <type> tag
1321 # and/or as the 'modes' parameter of the <oper> tag.
1322 # This module is oper-only. For the user equivalent, see m_conn_umodes.
1323 #<module name="m_opermodes.so">
1325 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1326 # Password forwarding module: Forwards a password users can send on
1327 # connect to the specified client below. The client is usually NickServ
1328 # and this module is usually used to authenticate users with NickServ
1329 # using their connect password.
1330 #<module name="m_passforward.so">
1333 # nick: nick to forward connect passwords to.
1336 # forwardmsg: Message to send to users using a connect password.
1337 # $nick will be the users' nick, $nickrequired will be the nick
1338 # of where the password is going (the nick above).
1339 # You can also use $user for the user ident string.
1340 forwardmsg="NOTICE $nick :*** Forwarding PASS to $nickrequired"
1342 # cmd: Command for the user to run when it receives a connect
1344 cmd="PRIVMSG $nickrequired :IDENTIFY $pass">
1346 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1347 # Password hash module: Allows hashed passwords to be used.
1348 # To be useful, a hashing module like m_sha256.so also needs to be loaded.
1349 #<module name="m_password_hash.so">
1351 #-#-#-#-#-#-#-#-#-# PASSWORD HASH CONFIGURATION #-#-#-#-#-#-#-#-#-#-#-#
1353 # To use this module, you must define a hash type for each oper's
1354 # password you want to hash. For example:
1356 # <oper name="Brain"
1357 # host="ident@dialup15.isp.com"
1359 # password="01ba4719c80b6fe911b091a7c05124b64eeece964e09c058ef8f9805daca546b"
1362 # Starting from 2.0, you can use a more secure salted hash that prevents simply
1363 # looking up the hash's value in a rainbow table built for the hash.
1364 # hash="hmac-sha256" password="lkS1Nbtp$CyLd/WPQXizsbxFUTqFRoMvaC+zhOULEeZaQkUJj+Gg"
1366 # Generate hashes using the /MKPASSWD command on the server.
1367 # Don't run it on a server you don't trust with your password.
1369 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1370 # PBKDF2 module: Allows other modules to generate PBKDF2 hashes,
1371 # usually for cryptographic uses and security.
1372 # This module relies on other hash providers (e.g. SHA256).
1373 #<module name="m_pbkdf2.so">
1375 # iterations: Iterations the hashing function runs when generating new
1377 # length: Length in bytes of the derived key.
1378 #<pbkdf2 iterations="12288" length="32">
1379 # You can override these values with specific values
1380 # for specific providers if you want to. Example given for SHA256.
1381 #<pbkdf2prov hash="sha256" iterations="24576">
1383 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1384 # Permanent channels module: Channels with the permanent channel mode
1385 # will remain open even after everyone else has left the channel, and
1386 # therefore keep things like modes, ban lists and topic. Permanent
1387 # channels -may- need support from your Services package to function
1388 # properly with them. This adds channel mode +P.
1389 # This module is oper-only.
1390 #<module name="m_permchannels.so">
1392 # If you like, m_permchannels can write a config file of permanent channels
1393 # whenever +P is set, unset, or the topic/modes on a +P channel is changed.
1394 # If you want to do this, set the filename below, and uncomment the include.
1396 # If 'listmodes' is true then all list modes (+b, +I, +e, +g...) will be
1397 # saved. Defaults to false.
1398 #<permchanneldb filename="permchannels.conf" listmodes="true">
1399 #<include file="permchannels.conf">
1401 # You may also create channels on startup by using the <permchannels> block.
1402 # Don't forget to set them +P in the modes, or they won't stay permanent.
1403 #<permchannels channel="#opers" modes="isP" topic="Opers only.">
1405 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1406 # PostgreSQL module: Allows other SQL modules to access PgSQL databases
1407 # through a unified API.
1408 # This module is in extras. Re-run configure with:
1409 # ./configure --enable-extras=m_pgsql.cpp
1410 # and run make install, then uncomment this module to enable it.
1411 #<module name="m_pgsql.so">
1413 #-#-#-#-#-#-#-#-#-#-#-#- SQL CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#-#
1415 # m_pgsql.so is more complex than described here, see the wiki for #
1416 # more: http://wiki.inspircd.org/Modules/pgsql #
1418 #<database module="pgsql" name="mydb" user="myuser" pass="mypass" host="localhost" id="my_database" ssl="no">
1420 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1421 # Muteban: Implements extended ban 'm', which stops anyone matching
1422 # a mask like +b m:nick!user@host from speaking on channel.
1423 #<module name="m_muteban.so">
1425 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1426 # Random quote module: Provides a random quote on connect.
1427 # NOTE: Some of these may mimic fatal errors and confuse users and
1428 # opers alike - BEWARE!
1429 #<module name="m_randquote.so">
1431 #-#-#-#-#-#-#-#-#-#- RANDOMQUOTES CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
1433 # Optional - If you specify to use the m_randquote.so module, then #
1434 # specify below the path to the quotes file. #
1436 #<randquote file="quotes.txt">
1438 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1439 # Redirect module: Adds channel redirection mode +L. #
1440 # Optional: <redirect:antiredirect> to add usermode +L to stop forced #
1441 # redirection and instead print an error. #
1443 # Note: You can not update this with a simple rehash, it requires #
1444 # reloading the module for it to take effect. #
1445 # This also breaks linking to servers that do not have the option. #
1446 # This defaults to false for the 2.0 version, it will be enabled in #
1447 # all the future versions. #
1448 #<module name="m_redirect.so">
1449 #<redirect antiredirect="true">
1451 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1452 # Regular expression provider for glob or wildcard (?/*) matching.
1453 # You must have at least 1 provider loaded to use m_filter or m_rline
1454 # modules. This module has no additional requirements, as it uses the
1455 # matching already present in InspIRCd core.
1456 #<module name="m_regex_glob.so">
1458 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1459 # Regular expression provider for PCRE (Perl-Compatible Regular
1460 # Expressions). You need libpcre installed to compile and load this
1461 # module. You must have at least 1 provider loaded to use m_filter or
1463 #<module name="m_regex_pcre.so">
1465 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1466 # Regular Expression Provider for RE2 Regular Expressions.
1467 # You need libre2 installed and in your include/library paths in order
1468 # to compile and load this module.
1469 #<module name="m_regex_re2.so">
1471 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1472 # Regular expression provider for POSIX regular expressions.
1473 # You shouldn't need any additional libraries on a POSIX-compatible
1474 # system (i.e.: any Linux, BSD, but not Windows). You must have at
1475 # least 1 provider loaded to use m_filter or m_rline.
1476 # On POSIX-compliant systems, regex syntax can be found by using the
1477 # command: 'man 7 regex'.
1478 #<module name="m_regex_posix.so">
1480 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1481 # Regular expression provider for C++11 std::regex regular expressions.
1482 # This module works on any fully compliant implementation of the C++11
1483 # std::regex container. Examples for such are Visual C++ 2010 and newer
1484 # but not libstdc++ (which GCC uses).
1485 # You should verify that std::regex is supported by your setup before
1486 # using this module, as it may compile normally but won't do anything
1487 # on some implementations.
1488 #<module name="m_regex_stdlib.so">
1490 # Specify the regular expression engine to use here. Valid settings are
1491 # bre, ere, awk, grep, egrep, ecmascript (default if not specified).
1492 #<stdregex type="ecmascript">
1494 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1495 # Regular expression provider for TRE regular expressions.
1496 # This is the same regular expression engine used by UnrealIRCd, so
1497 # if you are most familiar with the syntax of /SPAMFILTER from there,
1498 # this is the provider you want. You need libtre installed in order
1499 # to compile and load this module.
1500 #<module name="m_regex_tre.so">
1502 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1503 # Registered users only channel creation module. If enabled, only
1504 # registered users and opers can create new channels.
1506 # You probably *DO NOT* want to load this module on a public network.
1508 #<module name="m_regonlycreate.so">
1510 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1511 # Remove module: Adds the /REMOVE command which is a peaceful
1512 # alternative to /KICK.
1513 #<module name="m_remove.so">
1515 # supportnokicks: If true, /REMOVE is not allowed on channels where the
1516 # nokicks (+Q) mode is set. Defaults to false.
1517 # protectedrank: Members having this rank or above may not be /REMOVE'd
1518 # by anyone. Set to 0 to disable this feature. Defaults to 50000.
1519 #<remove supportnokicks="true" protectedrank="50000">
1521 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1522 # A module to block, kick or ban upon similiar messages being uttered several times.
1523 # Syntax [~*][lines]:[sec]{[:difference]}{[:matchlines]}
1524 # ~ is to block, * is to ban, default is kick.
1525 # 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
1526 # seconds - How old the message has to be before it's invalidated.
1527 # distance - Edit distance, in percent, between two strings to trigger on.
1528 # matchlines - When set, the function goes into mode 2. In this mode the function will trigger if this many of the last <lines> matches.
1530 # As this module can be rather CPU-intensive, it comes with some options.
1531 # maxbacklog - Maximum size that can be specified for backlog. 0 disables multiline matching.
1532 # maxdistance - Max percentage of difference between two lines we'll allow to match. Set to 0 to disable edit-distance matching.
1533 # maxlines - Max lines of backlog to match against.
1534 # maxsecs - Maximum value of seconds a user can set. 0 to allow any.
1535 # size - Maximum number of characters to check for, can be used to truncate messages
1536 # before they are checked, resulting in less CPU usage. Increasing this beyond 512
1537 # doesn't have any effect, as the maximum length of a message on IRC cannot exceed that.
1538 #<repeat maxbacklog="20" maxlines="20" maxdistance="50" maxsecs="0" size="512">
1539 #<module name="m_repeat.so">
1541 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1542 # Restricted channels module: Allows only opers to create channels.
1544 # You probably *DO NOT* want to load this module on a public network.
1546 #<module name="m_restrictchans.so">
1548 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1549 # Restrict message module: Allows users to only message opers.
1551 # You probably *DO NOT* want to load this module on a public network.
1553 #<module name="m_restrictmsg.so">
1555 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1556 # R-Line module: Ban users through regular expression patterns.
1557 #<module name="m_rline.so">
1559 #-#-#-#-#-#-#-#-#-#-#-#- RLINE CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#-#
1561 # If you wish to re-check a user when they change nickname (can be
1562 # useful under some situations, but *can* also use CPU with more users
1563 # on a server) then set 'matchonnickchange' to yes.
1564 # Also, this is where you set what Regular Expression engine is to be
1565 # used. If you ever change it while running, all of your R-Lines will
1566 # be wiped. This is the regex engine used by all R-Lines set, and
1567 # m_regex_<engine>.so must be loaded, or rline will be non-functional
1568 # until you load it or change the engine to one that is loaded.
1570 #<rline matchonnickchange="yes" engine="pcre">
1572 # Generally, you will NOT want to use 'glob' here, as this turns
1573 # rline into just another gline. The exceptions are that rline will
1574 # always use the full "nick!user@host realname" string, rather than only
1575 # user@host, but beware that only the ? and * wildcards are available,
1576 # and are the only way to specify where the space can occur if you do
1577 # use glob. For this reason, is recommended to use a real regex engine
1578 # so that at least \s or [[:space:]] is available.
1580 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1581 # RMODE module: Adds the /RMODE command
1582 # Allows channel mods to remove list modes en masse.
1583 # Syntax: /rmode <channel> <mode> [pattern]
1584 # E.g. '/rmode #Channel b m:*' will remove all mute-extbans on the channel.
1585 #<module name="m_rmode.so">
1587 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1588 # SAJOIN module: Adds the /SAJOIN command which forcibly joins a user
1589 # to the given channel.
1590 # This module is oper-only.
1591 # To use, SAJOIN must be in one of your oper class blocks.
1592 # Opers need the users/sajoin-others priv to be able to /SAJOIN users
1593 # other than themselves.
1594 #<module name="m_sajoin.so">
1596 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1597 # SAKICK module: Adds the /SAKICK command which kicks a user from the
1599 # This module is oper-only.
1600 # To use, SAKICK must be in one of your oper class blocks.
1601 #<module name="m_sakick.so">
1603 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1604 # SAMODE module: Adds the /SAMODE command which allows server operators
1605 # to change modes on a channel without requiring them to have any
1606 # channel priviliges. Also allows changing user modes for any user.
1607 # This module is oper-only.
1608 # To use, SAMODE must be in one of your oper class blocks.
1609 #<module name="m_samode.so">
1611 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1612 # SANICK module: Adds the /SANICK command which allows opers to change
1614 # This module is oper-only.
1615 # To use, SANICK must be in one of your oper class blocks.
1616 #<module name="m_sanick.so">
1618 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1619 # SAPART module: Adds the /SAPART command which forcibly parts a user
1621 # This module is oper-only.
1622 # To use, SAPART must be in one of your oper class blocks.
1623 #<module name="m_sapart.so">
1625 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1626 # SAQUIT module: Adds the /SAQUIT command which forcibly quits a user.
1627 # This module is oper-only.
1628 # To use, SAQUIT must be in one of your oper class blocks.
1629 #<module name="m_saquit.so">
1631 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1632 # SATOPIC module: Adds the /SATOPIC command which allows changing the
1633 # topic on a channel without requiring any channel priviliges.
1634 # This module is oper-only.
1635 # To use, SATOPIC must be in one of your oper class blocks.
1636 #<module name="m_satopic.so">
1638 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1639 # SASL authentication module: Provides support for IRC Authentication
1640 # Layer via AUTHENTICATE. Note: You also need to have m_cap.so loaded
1642 #<module name="m_sasl.so">
1644 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1645 # Secure list module: Prevent /LIST in the first minute of connection,
1646 # crippling most spambots and trojan spreader bots.
1647 #<module name="m_securelist.so">
1649 #-#-#-#-#-#-#-#-#-# SECURELIST CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#-#
1651 # Securelist can be harmful to some IRC search engines such as #
1652 # netsplit.de and searchirc.com. To prevent securelist blocking these #
1653 # sites from listing, define exception tags as shown below: #
1654 #<securehost exception="*@*.searchirc.org">
1655 #<securehost exception="*@*.netsplit.de">
1656 #<securehost exception="*@echo940.server4you.de">
1657 #<securehost exception="*@*.ircdriven.com">
1659 # Define the following variable to change how long a user must wait #
1660 # before issuing a LIST. If not defined, defaults to 60 seconds. #
1662 #<securelist waittime="60"> #
1664 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1665 # Servprotect module: Provides support for Austhex style +k /
1666 # UnrealIRCD +S services mode.
1667 #<module name="m_servprotect.so">
1669 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1670 # See nicks module: Adds snomask +n and +N which show local and remote
1672 # This module is oper-only.
1673 #<module name="m_seenicks.so">
1675 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1676 # Set idle module: Adds a command for opers to change their idle time.
1677 # This module is oper-only.
1678 # To use, SETIDLE must be in one of your oper class blocks.
1679 #<module name="m_setidle.so">
1681 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1682 # Services support module: Adds several usermodes such as +R and +M.
1683 # This module implements the 'identified' state via account names,
1684 # and is similar in operation to the way asuka and ircu handle services.
1686 # At the same time, this offers +r for users and channels to mark them
1687 # as identified separately from the idea of a master account, which
1688 # can be useful for services which are heavily nick-as-account centric.
1690 # Also of note is that this module implements three extbans:
1691 # +b R: (stop matching account names from joining)
1692 # +b M: (stop matching account names from speaking)
1693 # +b U:n!u@h (blocks matching unregistered users)
1695 #<module name="m_services_account.so">
1697 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1698 # Sethost module: Adds the /SETHOST command.
1699 # This module is oper-only.
1700 # To use, SETHOST must be in one of your oper class blocks.
1701 # See m_chghost for how to customise valid chars for hostnames.
1702 #<module name="m_sethost.so">
1704 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1705 # Setident module: Adds the /SETIDENT command.
1706 # This module is oper-only.
1707 # To use, SETIDENT must be in one of your oper class blocks.
1708 #<module name="m_setident.so">
1710 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1711 # SETNAME module: Adds the /SETNAME command.
1712 #<module name="m_setname.so">
1714 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1715 # Serverban: Implements extended ban 's', which stops anyone connected
1716 # to a server matching a mask like +b s:server.mask.here from joining.
1717 #<module name="m_serverban.so">
1719 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1720 # Showfile: Provides support for showing a text file to users when #
1721 # they enter a command. #
1722 # This module adds one command for each <showfile> tag that shows the #
1723 # given file to the user as a series of messages or numerics. #
1724 #<module name="m_showfile.so"> #
1726 #-#-#-#-#-#-#-#-#-#-# SHOWFILE CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#-#
1728 # name - The name of the command which displays this file. This is #
1729 # the only mandatory setting, all others are optional. #
1730 # file - The text file to be shown to the user. #
1731 # By default same as the command name. #
1732 # method - How should the file be shown? #
1733 # * numeric: Send contents using a numeric #
1734 # (similiar to /MOTD; the default). #
1735 # * notice: Send contents as a series of notices. #
1736 # * msg: Send contents as a series of private messages. #
1737 # colors - If true, color codes (\c, \b, \u, etc.) will be processed #
1738 # and sent as ANSI colors. If false (default) the file will #
1739 # be displayed as-is. #
1741 # When using the method "numeric", the following extra settings are #
1744 # introtext - Introductory line, "Showing <name>" by default. #
1745 # intronumeric - Numeric used for the introductory line. #
1746 # numeric - Numeric used for sending the text itself. #
1747 # endtext - Ending line, "End of <name>" by default. #
1748 # endnumeric - Numeric used for the ending line. #
1750 #<showfile name="RULES"
1753 # introtext="Server rules:"
1754 # endtext="End of server rules.">
1756 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1757 # Show whois module: Adds the +W usermode which allows opers to see
1758 # when they are /WHOIS'd.
1759 # This module is oper-only by default.
1760 #<module name="m_showwhois.so">
1762 # If you wish, you may also let users set this mode. Only opers with the
1763 # users/auspex priv will see real hosts of people, though.
1764 #<showwhois opersonly="yes"
1766 # You may also set whether or not users should receive whois notices,
1767 # should they be /WHOIS'd by an oper.
1768 #showfromopers="yes">
1770 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1771 # Shun module: Provides the /SHUN command, which stops a user from
1772 # executing all except configured commands.
1773 # This module is oper-only.
1774 # To use, SHUN must be in one of your oper class blocks.
1775 #<module name="m_shun.so">
1777 # You may also configure which commands you wish a user to be able to
1778 # perform when shunned. It should be noted that if a shunned user
1779 # issues QUIT or PART then their message will be removed, as if they
1780 # did not issue one.
1782 # You can optionally let the user know that their command was blocked.
1784 # You may also let SHUN affect opers (defaults to no).
1785 #<shun enabledcommands="PING PONG QUIT PART JOIN" notifyuser="yes" affectopers="no">
1787 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1788 # SSL channel mode module: Adds support for SSL-only channels via
1789 # channel mode +z and the 'z' extban which matches SSL client
1790 # certificate fingerprints.
1791 # Does not do anything useful without a working SSL module (see below).
1792 #<module name="m_sslmodes.so">
1794 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1795 # GnuTLS SSL module: Adds support for SSL connections using GnuTLS,
1796 # if enabled. You must answer 'yes' in ./configure when asked or
1797 # manually symlink the source for this module from the directory
1798 # src/modules/extra, if you want to enable this, or it will not load.
1799 #<module name="m_ssl_gnutls.so">
1801 #-#-#-#-#-#-#-#-#-#-#- GNUTLS CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#
1803 # m_ssl_gnutls.so is too complex to describe here, see the wiki: #
1804 # http://wiki.inspircd.org/Modules/ssl_gnutls #
1806 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1807 # SSL info module: Allows users to retrieve information about other
1808 # users' peer SSL certificates and keys. This can be used by client
1809 # scripts to validate users. For this to work, one of m_ssl_gnutls.so
1810 # or m_ssl_openssl.so must be loaded. This module also adds the
1811 # "* <user> is using a secure connection" whois line, the ability for
1812 # opers to use SSL cert fingerprints to verify their identity and the
1813 # ability to force opers to use SSL connections in order to oper up.
1814 # It is highly recommended to load this module if you use SSL on your
1816 # For how to use the oper features, please see the first example <oper> tag
1817 # in opers.conf.example.
1819 #<module name="m_sslinfo.so">
1821 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1822 # OpenSSL SSL module: Adds support for SSL connections using OpenSSL,
1823 # if enabled. You must answer 'yes' in ./configure when asked or symlink
1824 # the source for this module from the directory src/modules/extra, if
1825 # you want to enable this, or it will not load.
1826 #<module name="m_ssl_openssl.so">
1828 #-#-#-#-#-#-#-#-#-#-#- OPENSSL CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#
1830 # m_ssl_openssl.so is too complex to describe here, see the wiki: #
1831 # http://wiki.inspircd.org/Modules/ssl_openssl #
1833 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1834 # Strip color module: Adds channel mode +S that strips mIRC color
1835 # codes from all messages sent to the channel.
1836 #<module name="m_stripcolor.so">
1838 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1839 # Silence module: Adds support for the /SILENCE command, which allows
1840 # users to have a server-side ignore list for their client.
1841 #<module name="m_silence.so">
1843 # Set the maximum number of entries allowed on a user's silence list.
1844 #<silence maxentries="32"
1846 # Whether messages from U-lined servers will bypass silence masks.
1849 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1850 # SQLite3 module: Allows other SQL modules to access SQLite3 #
1851 # databases through a unified API. #
1852 # This module is in extras. Re-run configure with: #
1853 # ./configure --enable-extras=m_sqlite.cpp
1854 # and run make install, then uncomment this module to enable it. #
1856 #<module name="m_sqlite3.so">
1858 #-#-#-#-#-#-#-#-#-#-#-#- SQL CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#-#
1860 # m_sqlite.so is more complex than described here, see the wiki for #
1861 # more: http://wiki.inspircd.org/Modules/sqlite3 #
1863 #<database module="sqlite" hostname="/full/path/to/database.db" id="anytext">
1865 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1866 # SQL authentication module: Allows IRCd connections to be tied into
1867 # a database table (for example a forum).
1868 # This module is in extras. Re-run configure with:
1869 # ./configure --enable-extras=m_sqlauth.cpp
1870 # and run make install, then uncomment this module to enable it.
1872 #<module name="m_sqlauth.so">
1874 #-#-#-#-#-#-#-#-#-#-#- SQLAUTH CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#
1876 # m_sqlauth.so is too complex to describe here, see the wiki: #
1877 # http://wiki.inspircd.org/Modules/sqlauth #
1879 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1880 # SQL oper module: Allows you to store oper credentials in an SQL table
1881 # This module is in extras. Re-run configure with:
1882 # ./configure --enable-extras=m_sqloper.cpp
1883 # and run make install, then uncomment this module to enable it.
1885 #<module name="m_sqloper.so">
1887 #-#-#-#-#-#-#-#-#-#-#- SQLOPER CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#
1889 # dbid - Database ID to use (see SQL modules). #
1890 # hash - Hashing provider to use for password hashing. #
1892 # See also: http://wiki.inspircd.org/Modules/sqloper #
1894 #<sqloper dbid="1" hash="md5">
1896 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1897 # StartTLS module: Implements STARTTLS, which allows clients #
1898 # connected to non SSL enabled ports to enable SSL, if a proper SSL #
1899 # module is loaded (either m_ssl_gnutls or m_ssl_openssl). #
1900 #<module name="m_starttls.so">
1902 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1903 # SVSHold module: Implements SVSHOLD. Like Q:Lines, but can only be #
1904 # added/removed by Services. #
1905 #<module name="m_svshold.so">
1906 # SVSHOLD does not generate server notices by default, you can turn
1907 # notices on by uncommenting the next line.
1908 #<svshold silent="false">
1910 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1911 # SWHOIS module: Allows you to add arbitrary lines to user WHOIS.
1912 # This module is oper-only.
1913 # To use, SWHOIS must be in one of your oper class blocks.
1914 #<module name="m_swhois.so">
1916 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1917 # Test module: Enable this to create a command useful in testing
1918 # flood control. To avoid accidental use on live networks, the server
1919 # name must contain ".test" to load the module
1920 #<module name="m_testnet.so">
1922 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1923 # Timed bans module: Adds timed channel bans with the /TBAN command.
1924 #<module name="m_timedbans.so">
1926 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1927 # Test line module: Adds the /TLINE command, used to test how many
1928 # users a /GLINE or /ZLINE etc. would match.
1929 # This module is oper-only.
1930 # To use, TLINE must be in one of your oper class blocks.
1931 #<module name="m_tline.so">
1933 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1934 # Topiclock module: implements server-side topic locking to achieve deeper
1935 # integration with services packages.
1936 #<module name="m_topiclock.so">
1938 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1939 # UHNAMES support module: Adds support for the IRCX style UHNAMES
1940 # extension, which displays ident and hostname in the names list for
1941 # each user, saving clients from doing a WHO on the channel.
1942 # If a client does not support UHNAMES it will not enable it, this will
1943 # not break incompatible clients.
1944 #<module name="m_uhnames.so">
1946 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1947 # Uninvite module: Adds the /UNINVITE command which lets users remove
1948 # pending invites from channels without waiting for the user to join.
1949 #<module name="m_uninvite.so">
1951 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1952 # Userip module: Adds the /USERIP command.
1953 # Allows users to query their own IP, also allows opers to query the IP
1955 #<module name="m_userip.so">
1957 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1958 # Vhost module: Adds the VHOST command which allows for adding virtual
1959 # hosts which are accessible using a username and password in the config.
1960 #<module name="m_vhost.so">
1962 #-#-#-#-#-#-#-#-#-#-#- VHOST CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#-#
1964 # user - Username for the vhost. #
1966 # pass - Password for the vhost. #
1968 # hash - The hash for the specific user (optional) #
1969 # m_password_hash.so and a hashing module must be loaded #
1970 # for this to work. #
1972 # host - Vhost to set. #
1974 #<vhost user="some_username" pass="some_password" host="some.host">
1975 #<vhost user="foo" password="fcde2b2edba56bf408601fb721fe9b5c338d10ee429ea04fae5511b68fbf8fb9" hash="sha256" host="some.other.host">
1977 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1978 # Watch module: Adds the WATCH command, which is used by clients to
1979 # maintain notify lists.
1980 #<module name="m_watch.so">
1982 # Set the maximum number of entries on a user's watch list below.
1983 #<watch maxentries="32">
1985 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1986 # XLine database: Stores all *Lines (G/Z/K/R/any added by other modules)
1987 # in a file which is re-loaded on restart. This is useful
1988 # for two reasons: it keeps bans so users may not evade them, and on
1989 # bigger networks, server connections will take less time as there will
1990 # be a lot less bans to apply - as most of them will already be there.
1991 #<module name="m_xline_db.so">
1993 # Specify the filename for the xline database here.
1994 #<xlinedb filename="data/xline.db">
1996 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1997 # ____ _ _____ _ _ ____ _ _ _ #
1998 # | _ \ ___ __ _ __| | |_ _| |__ (_)___ | __ )(_) |_| | #
1999 # | |_) / _ \/ _` |/ _` | | | | '_ \| / __| | _ \| | __| | #
2000 # | _ < __/ (_| | (_| | | | | | | | \__ \ | |_) | | |_|_| #
2001 # |_| \_\___|\__,_|\__,_| |_| |_| |_|_|___/ |____/|_|\__(_) #
2003 # To link servers to InspIRCd, you MUST load the m_spanningtree #
2004 # module. If you don't do this, server links will NOT work at all. #
2005 # This is by design, to allow for the implementation of other linking #
2006 # protocols in modules in the future. #
2008 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2009 # Spanning tree module: Allows linking of servers using the spanning
2010 # tree protocol (see the READ THIS BIT section above).
2011 # You will almost always want to load this.
2013 #<module name="m_spanningtree.so">