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">
685 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
686 # Deny channels module: Deny channels from being used by users.
687 #<module name="m_denychans.so">
689 #-#-#-#-#-#-#-#-#-#-#- DENYCHAN DEFINITIONS -#-#-#-#-#-#-#-#-#-#-#-#
691 # If you have the m_denychans.so module loaded, you need to specify #
692 # the channels to deny: #
694 # name - The channel name to deny (glob masks are ok). #
695 # allowopers - If operators are allowed to override the deny. #
696 # reason - Reason given for the deny. #
697 # redirect - Redirect the user to a different channel. #
699 #<badchan name="#gods*" allowopers="yes" reason="Tortoises!"> #
700 #<badchan name="#heaven" redirect="#hell" reason="Nice try!"> #
702 # Redirects will not work if the target channel is set +L. #
704 # Additionally, you may specify channels which are allowed, even if #
705 # a badchan tag specifies it would be denied: #
706 #<goodchan name="#godsleeps"> #
707 # Glob masks are accepted here also. #
709 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
710 # Devoice module: Let users devoice themselves using /DEVOICE #chan.
711 #<module name="m_devoice.so">
713 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
714 # DNS blacklist module: Provides support for looking up IPs on one or #
716 #<module name="m_dnsbl.so"> #
718 # For configuration options please see the wiki page for m_dnsbl at #
719 # http://wiki.inspircd.org/Modules/dnsbl #
721 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
722 # Exempt channel operators module: Provides support for allowing #
723 # channel operators to be exempt from some channel modes. Supported #
724 # modes are blockcaps, noctcp, blockcolor, nickflood, flood, censor, #
725 # filter, regmoderated, nonick, nonotice, and stripcolor. #
726 #<module name="m_exemptchanops.so"> #
728 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
729 # Filter module: Provides message filtering, similar to SPAMFILTER. #
730 #<module name="m_filter.so">
732 # This module depends upon a regex provider such as m_regex_pcre or #
733 # m_regex_glob to function. You must specify which of these you want #
734 # m_filter to use via the tag below. #
736 # Valid engines are: #
738 # glob - Glob patterns, provided via m_regex_glob. #
739 # pcre - PCRE regexps, provided via m_regex_pcre, needs libpcre. #
740 # tre - TRE regexps, provided via m_regex_tre, requires libtre. #
741 # posix - POSIX regexps, provided via m_regex_posix, not available #
742 # on Windows, no dependencies on other operating systems. #
743 # stdlib - stdlib regexps, provided via m_regex_stdlib, see comment #
744 # at the <module> tag for info on availability. #
746 #<filteropts engine="glob"> #
748 # Your choice of regex engine must match on all servers network-wide.
750 # To learn more about the configuration of this module, read #
751 # examples/filter.conf.example, which covers the various types of #
752 # filters and shows how to add exemptions. #
754 #-#-#-#-#-#-#-#-#-#-#- FILTER CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#
756 # Optional - If you specify to use the m_filter module, then #
757 # specify below the path to the filter.conf file, or define some #
760 #<include file="examples/filter.conf.example">
762 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
763 # Flash Policy Daemon module: Allows Flash IRC clients (e.g. LightIRC)#
764 # to connect. If no file is specified, it'll serve a default policy #
765 # allowing all IPs to connect to all plaintext IRC ports #
766 #<bind address="" port="8430" type="flashpolicyd"> #
767 #<flashpolicyd timeout="5" file=""> #
768 #<module name="m_flashpolicyd.so"> #
770 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
771 # Gecos ban: Implements extended ban 'r', which stops anyone matching
772 # a mask like +b r:*realname?here* from joining a channel.
773 #<module name="m_gecosban.so">
775 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
776 # GeoIP module: Allows the server admin to match users by country code.
777 # This module is in extras. Re-run configure with:
778 # ./configure --enable-extras=m_geoip.cpp
779 # and run make install, then uncomment this module to enable it.
780 # This module requires GeoIP to be installed on your system,
781 # use your package manager to find the appropriate packages
782 # or check the InspIRCd wiki page for this module.
783 #<module name="m_geoip.so">
785 # The actual allow/ban actions are done by connect classes, not by the
786 # GeoIP module. An example connect class to ban people from russia or
789 # <connect deny="*" geoip="TR,RU">
791 # The country code must be in capitals and should be an ISO country
792 # code such as TR, GB, or US. Unknown IPs (localhost, LAN IPs, etc)
793 # will be assigned the country code "UNK". Since connect classes are
794 # matched from top down, your deny classes must be above your allow
795 # classes for them to match.
797 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
798 # Globops module: Provides the /GLOBOPS command and snomask +g.
799 # This module is oper-only.
800 # To use, GLOBOPS must be in one of your oper class blocks.
801 #<module name="m_globops.so">
803 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
804 # Global load module: Allows loading and unloading of modules network-
805 # wide (USE WITH EXTREME CAUTION!)
806 # This module is oper-only and provides /GLOADMODULE, /GUNLOADMODULE
807 # and /GRELOADMODULE.
808 # To use, GLOADMODULE, GUNLOADMODULE and GRELOADMODULE
809 # must be in one of your oper class blocks.
810 #<module name="m_globalload.so">
812 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
813 # HELPOP module: Provides the /HELPOP command
814 #<module name="m_helpop.so">
816 #-#-#-#-#-#-#-#-#-#-#-#- HELPOP CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
818 # If you specify to use the m_helpop.so module, then specify below #
819 # the path to the helpop.conf file. #
821 #<include file="examples/inspircd.helpop-full.example">
823 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
824 # Hide chans module: Allows users to hide their channels list from non-
825 # opers by setting user mode +I on themselves.
826 #<module name="m_hidechans.so">
828 # This mode can optionally prevent opers from seeing channels on a +I
829 # user, for more privacy if set to true.
830 # This setting is not recommended for most mainstream networks.
831 #<hidechans affectsopers="false">
833 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
834 # Hide list module: Allows for hiding the list of listmodes from users
835 # who do not have sufficient channel rank.
836 #<module name="m_hidelist.so">
838 # Each <hidelist> tag configures one listmode to hide.
839 # mode: Name of the listmode to hide.
840 # rank: Minimum rank required to view the list. If set to 0, all
841 # members of the channel may view the list, but non-members may not.
842 # The rank of the built-in op and voice mode is 30000 and 10000,
843 # respectively; the rank of other prefix modes is configurable.
846 # Hiding the ban list is not recommended because it may break some
849 # Hide filter (+g) list:
850 #<hidelist mode="filter" rank="30000">
851 # Only show invite exceptions (+I) to channel members:
852 #<hidelist mode="invex" rank="0">
854 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
855 # Hide oper module: Allows opers to hide their oper status from non-
856 # opers by setting user mode +H on themselves.
857 # This module is oper-only.
858 #<module name="m_hideoper.so">
860 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
861 # Hostchange module: Allows a different style of cloaking.
862 #<module name="m_hostchange.so">
864 #-#-#-#-#-#-#-#-#-#-#- HOSTCHANGE CONFIGURATION -#-#-#-#-#-#-#-#-#-#
866 # See http://wiki.inspircd.org/Modules/hostchange for help. #
868 #<host suffix="polarbears.org" separator="." prefix="">
869 #<hostchange mask="*@fbi.gov" action="addnick">
870 #<hostchange mask="*r00t@*" action="suffix">
871 #<hostchange mask="a@b.com" action="set" value="blah.blah.blah">
872 #<hostchange mask="localhost" ports="7000,7001,7005-7007" action="set" value="blahblah.foo">
874 # hostcycle: If loaded, when a user gets a host or ident set, it will
875 # cycle them in all their channels. If not loaded it will simply change
876 # their host/ident without cycling them.
877 #<module name="m_hostcycle.so">
879 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
880 # httpd module: Provides HTTP server support for InspIRCd.
881 #<module name="m_httpd.so">
883 #-#-#-#-#-#-#-#-#-#-#-#- HTTPD CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
885 # If you choose to use the m_httpd.so module, then you will need to add
886 # a <bind> tag with type "httpd", and load at least one of the other
887 # m_httpd_* modules to provide pages to display.
889 # You can adjust the timeout for HTTP connections below. All HTTP
890 # connections will be closed after (roughly) this many seconds.
891 #<httpd timeout="20">
893 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
894 # HTTP ACL module: Provides access control lists for m_httpd dependent
895 # modules. Use this module to restrict pages by IP address and by
897 #<module name="m_httpd_acl.so">
899 #-#-#-#-#-#-#-#-#-#-#-#- HTTPD ACL CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
901 # Restrict access to the m_httpd_stats module to all but the local
902 # network and when the correct password is specified:
903 # <httpdacl path="/stats*" types="password,whitelist"
904 # username="secretstuff" password="mypasshere" whitelist="127.0.0.*,10.*">
906 # Deny all connections to all but the main index page:
907 # <httpdacl path="/*" types="blacklist" blacklist="*">
909 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
910 # HTTP config module: Allows the configuration of the server to be
911 # viewed over HTTP. Requires m_httpd.so to be loaded for it to function.
912 #<module name="m_httpd_config.so">
914 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
915 # HTTP stats module: Provides basic stats pages over HTTP.
916 # Requires m_httpd.so to be loaded for it to function.
917 #<module name="m_httpd_stats.so">
919 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
920 # Ident: Provides RFC 1413 ident lookup support.
921 # When this module is loaded <connect:allow> tags may have an optional
922 # useident="yes|no" boolean value, determining whether or not to lookup
923 # ident on users matching that connect tag.
924 #<module name="m_ident.so">
926 #-#-#-#-#-#-#-#-#-#-#-#- IDENT CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
928 # Optional - If you are using the m_ident.so module, then you can #
929 # specify the timeout for ident lookups here. If not defined, it will #
930 # default to 5 seconds. This is a non-blocking timeout which holds #
931 # the user in a 'connecting' state until the lookup is complete. #
932 # The bind value indicates which IP to bind outbound requests to. #
933 # nolookupprefix: If on, the idents of users being in a connect class #
934 # with ident lookups disabled (i.e. <connect useident="off">) will be #
935 # prefixed with a "~". If off, the ident of those users will not be #
936 # prefixed. Default is off. #
938 #<ident timeout="5" nolookupprefix="no">
940 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
941 # Invite exception module: Adds support for channel invite exceptions
943 #<module name="m_inviteexception.so">
944 # Does a +I bypass channel +k in addition to +i?
945 #<inviteexception bypasskey="yes">
947 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
948 # IRCv3 module: Provides the following IRCv3.1 extensions:
949 # extended-join, away-notify and account-notify. These are optional
950 # enhancements to the client-to-server protocol. An extension is only
951 # active for a client when the client specifically requests it, so this
952 # module needs m_cap to work.
954 # Further information on these extensions can be found at the IRCv3
955 # working group website:
956 # http://ircv3.org/extensions/
958 #<module name="m_ircv3.so">
959 # The following block can be used to control which extensions are
960 # enabled. Note that extended-join can be incompatible with m_delayjoin
962 #<ircv3 accountnotify="on" awaynotify="on" extendedjoin="on">
964 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
965 # Join flood module: Adds support for join flood protection +j X:Y.
966 # Closes the channel for 60 seconds if X users join in Y seconds.
967 #<module name="m_joinflood.so">
969 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
970 # Jump server module: Adds support for the RPL_REDIR numeric.
971 # This module is oper-only.
972 # To use, JUMPSERVER must be in one of your oper class blocks.
973 # If your server is redirecting new clients and you get disconnected,
974 # do a REHASH from shell to open up again.
975 #<module name="m_jumpserver.so">
977 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
978 # Anti auto rejoin: Adds support for prevention of auto-rejoin (+J).
979 #<module name="m_kicknorejoin.so">
981 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
982 # Knock module: Adds the /KNOCK command and channel mode +K.
983 #<module name="m_knock.so">
985 # This setting specifies what to do when someone successfully /KNOCKs.
986 # If set to "notice", then a NOTICE will be sent to the channel.
987 # This is the default and the compatible setting, as it requires no
988 # special support from the clients.
989 # If set to "numeric" then a 710 numeric will be sent to the channel.
990 # This allows easier scripting but not all clients support it.
991 # If set to "both" then (surprise!) both will be sent.
992 #<knock notify="notice">
994 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
995 # LDAP module: Allows other SQL modules to access a LDAP database
996 # through a unified API.
997 # This modules is in extras. Re-run configure with:
998 # ./configure --enable-extras=m_ldap.cpp
999 # and run make install, then uncomment this module to enable it.
1001 #<module name="m_ldap.so">
1002 #<database module="ldap" id="ldapdb" server="ldap://localhost" binddn="cn=Manager,dc=inspircd,dc=org" bindauth="mysecretpass" searchscope="subtree">
1003 # The server parameter indicates the LDAP server to connect to. The #
1004 # ldap:// style scheme before the hostname proper is MANDATORY. #
1006 # The binddn and bindauth indicate the DN to bind to for searching, #
1007 # and the password for the distinguished name. Some LDAP servers will #
1008 # allow anonymous searching in which case these two values do not #
1009 # need defining, otherwise they should be set similar to the examples #
1012 # The searchscope value indicates the subtree to search under. On our #
1013 # test system this is 'subtree'. Your mileage may vary. #
1015 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1016 # LDAP authentication module: Adds the ability to authenticate users #
1018 #<module name="m_ldapauth.so">
1022 # <ldapauth dbid="ldapdb" #
1023 # baserdn="ou=People,dc=brainbox,dc=cc" #
1025 # allowpattern="Guest* Bot*" #
1026 # killreason="Access denied" #
1028 # host="$uid.$ou.inspircd.org"> #
1030 # <ldapwhitelist cidr="10.42.0.0/16"> #
1032 # <ldaprequire attribute="attr" value="val"> #
1034 # The baserdn indicates the base DN to search in for users. Usually #
1035 # this is 'ou=People,dc=yourdomain,dc=yourtld'. #
1037 # The attribute value indicates the attribute which is used to locate #
1038 # a user account by name. On POSIX systems this is usually 'uid'. #
1040 # The allowpattern value allows you to specify a space separated list #
1041 # of wildcard masks which will always be allowed to connect #
1042 # regardless of if they have an account, for example guest and bot #
1045 # Killreason indicates the QUIT reason to give to users if they fail #
1046 # to authenticate. #
1048 # Setting the verbose value causes an oper notice to be sent out for #
1049 # every failed authentication to the server, with an error string. #
1051 # ldapwhitelist indicates that clients connecting from an IP in the #
1052 # provided CIDR do not need to authenticate against LDAP. It can be #
1053 # repeated to whitelist multiple CIDRs. #
1055 # ldaprequire allows further filtering on the LDAP user, by requiring #
1056 # certain LDAP attibutes to have a given value. It can be repeated, #
1057 # in which case the list will act as an OR list, that is, the #
1058 # authentication will succeed if any of the requirements in the list #
1061 # host allows you to change the displayed host of users connecting #
1062 # from ldap. The string supplied takes formatters which are replaced #
1063 # from the DN. For instance, if your DN looks like: #
1064 # uid=w00t,ou=people,dc=inspircd,dc=org, then the formatters uid, ou #
1065 # and dc will be available to you. If a key is given multiple times #
1066 # in the DN, the last appearance will take precedence. #
1068 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1069 # LDAP oper configuration module: Adds the ability to authenticate #
1071 #<module name="m_ldapoper.so">
1075 # <ldapoper dbid="ldapdb"
1076 # baserdn="ou=People,dc=brainbox,dc=cc"
1079 # Available configuration items are identical to the same items in #
1080 # m_ldapauth above (except for the verbose setting, that is only #
1081 # supported in m_ldapauth). #
1082 # Please always specify a password in your <oper> tags even if the #
1083 # opers are to be authenticated via LDAP, so in case this module is #
1084 # not loaded the oper accounts are still protected by a password. #
1086 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1087 # Lock server module: Adds /LOCKSERV and /UNLOCKSERV commands that #
1088 # are used to temporarily close/open the server for new connections. #
1089 # These commands require that the /LOCKSERV and /UNLOCKSERV commands #
1090 # are specified in a <class> tag that the oper is part of. This is so #
1091 # you can control who has access to this possible dangerous command. #
1092 # If your server is locked and you get disconnected, do a REHASH from #
1093 # shell to open up again. #
1094 # This module is oper-only.
1095 #<module name="m_lockserv.so">
1097 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1098 # Map hiding module: replaces /MAP and /LINKS output to users with a #
1099 # message to see a website, set by maphide="http://link.to/site" in #
1100 # the <security> tag, instead. #
1101 #<module name="m_maphide.so">
1103 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1104 # Message flood module: Adds message/notice flood protection via
1106 #<module name="m_messageflood.so">
1108 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1109 # MLOCK module: Adds support for server-side enforcement of services
1110 # side MLOCKs. Basically, this module suppresses any mode change that
1111 # would likely be immediately bounced by services.
1112 #<module name="m_mlock.so">
1114 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1115 # Modenotice module: Adds the /MODENOTICE command that allows opers to
1116 # send notices to all users having the given user mode(s) set.
1117 #<module name="m_modenotice.so">
1119 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1120 # MsSQL module: Allows other SQL modules to access MS SQL Server
1121 # through a unified API.
1122 # This module is in extras. Re-run configure with:
1123 # ./configure --enable-extras=m_mssql.cpp
1124 # and run make install, then uncomment this module to enable it.
1125 #<module name="m_mssql.so">
1127 #-#-#-#-#-#-#-#-#-#-#-#- SQL CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#-#
1129 # m_mssql.so is more complex than described here, see wiki for more #
1130 # info http://wiki.inspircd.org/Modules/mssql #
1132 #<database module="mssql" name="db" user="user" pass="pass" host="localhost" id="db1">
1134 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1135 # MySQL module: Allows other SQL modules to access MySQL databases
1136 # through a unified API.
1137 # This module is in extras. Re-run configure with:
1138 # ./configure --enable-extras=m_mysql.cpp
1139 # and run make install, then uncomment this module to enable it.
1140 #<module name="m_mysql.so">
1142 #-#-#-#-#-#-#-#-#-#-#-#- SQL CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#-#
1144 # m_mysql.so is more complex than described here, see the wiki for #
1145 # more: http://wiki.inspircd.org/Modules/mysql #
1147 #<database module="mysql" name="mydb" user="myuser" pass="mypass" host="localhost" id="my_database2">
1149 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1150 # Named modes module: Allows for the display and set/unset of channel
1151 # modes via long-form mode names via +Z and the /PROP command.
1152 # For example, to set a ban, do /mode #channel +Z ban=foo!bar@baz or
1153 # /PROP #channel ban=foo!bar@baz
1154 #<module name="m_namedmodes.so">
1156 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1157 # NAMESX module: Provides support for the NAMESX extension which allows
1158 # clients to see all the prefixes set on a user without getting confused.
1159 # This is supported by mIRC, x-chat, klient, and maybe more.
1160 #<module name="m_namesx.so">
1162 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1163 # National characters module:
1164 # 1) Allows using national characters in nicknames.
1165 # 2) Allows using custom (national) casemapping over the network.
1166 #<module name="m_nationalchars.so">
1168 # file - filename of existing file in "locales" directory
1169 # casemapping - custom value for 005 numeric (if you want it to be
1170 # different from the filename).
1171 #<nationalchars file="bynets/russian-w1251-charlink" casemapping="ru_RU.cp1251-charlink">
1173 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1174 # Nickchange flood protection module: Provides channel mode +F X:Y
1175 # which allows up to X nick changes in Y seconds.
1176 #<module name="m_nickflood.so">
1178 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1179 # Nicklock module: Let opers change a user's nick and then stop that
1180 # user from changing their nick again until unlocked.
1181 # This module is oper-only.
1182 # To use, NICKLOCK and NICKUNLOCK must be in one of your oper class blocks.
1183 #<module name="m_nicklock.so">
1185 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1186 # No CTCP module: Adds the channel mode +C to block CTCPs and extban
1187 # 'C' to block CTCPs sent by specific users.
1188 #<module name="m_noctcp.so">
1190 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1191 # No kicks module: Adds the +Q channel mode and the Q: extban to deny
1192 # certain users from kicking.
1193 #<module name="m_nokicks.so">
1195 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1196 # No nicks module: Adds the +N channel mode, as well as the 'N' extban.
1197 # +N stops all users from changing their nick, the N extban stops
1198 # anyone from matching a +b N:nick!user@host mask from changing their
1200 #<module name="m_nonicks.so">
1202 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1203 # No part message module: Adds extban 'p' to block part messages from #
1205 #<module name="m_nopartmsg.so">
1207 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1208 # No notice module: Adds the channel mode +T and the extban 'T' to
1209 # block specific users from noticing the channel.
1210 #<module name="m_nonotice.so">
1212 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1213 # Network business join module:
1214 # Allows an oper to join a channel using /OJOIN, giving them +Y on the
1215 # channel which makes them immune to kick/deop/etc.
1216 #<module name="m_ojoin.so">
1218 # Specify the prefix that +Y will grant here.
1219 # Leave 'prefix' empty if you do not wish +Y to grant a prefix.
1220 # If 'notice' is set to on, upon /OJOIN, the server will notice the
1221 # channel saying that the oper is joining on network business.
1222 # If 'op' is set to on, it will give them +o along with +Y.
1223 #<ojoin prefix="!" notice="yes" op="yes">
1225 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1226 # Oper channels mode: Adds the +O channel mode and extban O:<mask>
1227 # to ban, except, etc. specific oper types. For example
1228 # /mode #channel +iI O:* is equivalent to channel mode +O, but you
1229 # may also set +iI O:AdminTypeOnly to only allow admins.
1230 # Modes +I and +e work in a similar fashion.
1231 #<module name="m_operchans.so">
1233 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1234 # Oper join module: Auto-joins opers to a channel upon oper-up.
1235 # This module is oper-only. For the user equivalent, see m_conn_join.
1236 #<module name="m_operjoin.so">
1238 #-#-#-#-#-#-#-#-#-#-# OPERJOIN CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
1240 # If you are using the m_operjoin.so module, specify options here: #
1242 # channel - The channel name to join, can also be a comma #
1243 # separated list e.g. "#channel1,#channel2". #
1245 # override - If on, lets the oper join walking thru any modes #
1246 # that might be set, even bans. #
1248 #<operjoin channel="#channel" override="no">
1250 # Alternatively you can use the autojoin="channellist" in a <type> #
1251 # tag to set specific autojoins for a type of oper, for example: #
1253 #<type name="Helper" autojoin="#help" classes="...">
1255 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1256 # Oper log module: Logs all oper commands to the server log (with log
1257 # type "m_operlog" at default loglevel), and optionally to the 'r'
1259 # This module is oper-only.
1260 #<module name="m_operlog.so">
1262 # If the following option is on then all oper commands will be sent to
1263 # the snomask 'r'. The default is off.
1264 #<operlog tosnomask="off">
1266 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1267 # Oper prefixing module: Adds a channel prefix mode +y which is given
1268 # to all IRC operators automatically on all channels they are in.
1269 # This prefix mode is more powerful than channel op and other regular
1272 # Load this module if you want all your IRC operators to have channel
1274 #<module name="m_operprefix.so">
1276 # You may additionally customise the prefix character.
1277 #<operprefix prefix="!">
1279 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1280 # Oper MOTD module: Provides support for separate message of the day
1282 # This module is oper-only.
1283 #<module name="m_opermotd.so">
1285 #-#-#-#-#-#-#-#-#-#-# OPERMOTD CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
1287 # If you are using the m_opermotd.so module, specify the motd here. #
1289 # onoper - If on, the message is sent on /OPER, otherwise it's #
1290 # only sent when /OPERMOTD is used. #
1292 # processcolors - Allow color codes to be processed in the opermotd. #
1293 # Read the comment above <connect:allowmotdcolors> in #
1294 # inspircd.conf.example for details. #
1296 #<opermotd file="examples/opermotd.txt.example" onoper="yes" processcolors="false">
1298 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1299 # Override module: Adds support for oper override.
1300 # This module is oper-only.
1301 #<module name="m_override.so">
1303 #-#-#-#-#-#-#-#-#-#-# OVERRIDE CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
1305 # m_override.so is too complex it describe here, see the wiki: #
1306 # http://wiki.inspircd.org/Modules/override #
1308 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1309 # Oper levels module: Gives each oper a level and prevents actions
1310 # being taken by lower level opers against higher level opers.
1311 # Specify the level as the 'level' parameter of the <type> tag.
1312 # This module is oper-only.
1313 #<module name="m_operlevels.so">
1315 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1316 # Oper modes module: Allows you to specify modes to add/remove on oper.
1317 # Specify the modes as the 'modes' parameter of the <type> tag
1318 # and/or as the 'modes' parameter of the <oper> tag.
1319 # This module is oper-only. For the user equivalent, see m_conn_umodes.
1320 #<module name="m_opermodes.so">
1322 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1323 # Password forwarding module: Forwards a password users can send on
1324 # connect to the specified client below. The client is usually NickServ
1325 # and this module is usually used to authenticate users with NickServ
1326 # using their connect password.
1327 #<module name="m_passforward.so">
1330 # nick: nick to forward connect passwords to.
1333 # forwardmsg: Message to send to users using a connect password.
1334 # $nick will be the users' nick, $nickrequired will be the nick
1335 # of where the password is going (the nick above).
1336 # You can also use $user for the user ident string.
1337 forwardmsg="NOTICE $nick :*** Forwarding PASS to $nickrequired"
1339 # cmd: Command for the user to run when it receives a connect
1341 cmd="PRIVMSG $nickrequired :IDENTIFY $pass">
1343 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1344 # Password hash module: Allows hashed passwords to be used.
1345 # To be useful, a hashing module like m_sha256.so also needs to be loaded.
1346 #<module name="m_password_hash.so">
1348 #-#-#-#-#-#-#-#-#-# PASSWORD HASH CONFIGURATION #-#-#-#-#-#-#-#-#-#-#-#
1350 # To use this module, you must define a hash type for each oper's
1351 # password you want to hash. For example:
1353 # <oper name="Brain"
1354 # host="ident@dialup15.isp.com"
1356 # password="01ba4719c80b6fe911b091a7c05124b64eeece964e09c058ef8f9805daca546b"
1359 # Starting from 2.0, you can use a more secure salted hash that prevents simply
1360 # looking up the hash's value in a rainbow table built for the hash.
1361 # hash="hmac-sha256" password="lkS1Nbtp$CyLd/WPQXizsbxFUTqFRoMvaC+zhOULEeZaQkUJj+Gg"
1363 # Generate hashes using the /MKPASSWD command on the server.
1364 # Don't run it on a server you don't trust with your password.
1366 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1367 # PBKDF2 module: Allows other modules to generate PBKDF2 hashes,
1368 # usually for cryptographic uses and security.
1369 # This module relies on other hash providers (e.g. SHA256).
1370 #<module name="m_pbkdf2.so">
1372 # iterations: Iterations the hashing function runs when generating new
1374 # length: Length in bytes of the derived key.
1375 #<pbkdf2 iterations="12288" length="32">
1376 # You can override these values with specific values
1377 # for specific providers if you want to. Example given for SHA256.
1378 #<pbkdf2prov hash="sha256" iterations="24576">
1380 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1381 # Permanent channels module: Channels with the permanent channel mode
1382 # will remain open even after everyone else has left the channel, and
1383 # therefore keep things like modes, ban lists and topic. Permanent
1384 # channels -may- need support from your Services package to function
1385 # properly with them. This adds channel mode +P.
1386 # This module is oper-only.
1387 #<module name="m_permchannels.so">
1389 # If you like, m_permchannels can write a config file of permanent channels
1390 # whenever +P is set, unset, or the topic/modes on a +P channel is changed.
1391 # If you want to do this, set the filename below, and uncomment the include.
1393 # If 'listmodes' is true then all list modes (+b, +I, +e, +g...) will be
1394 # saved. Defaults to false.
1395 #<permchanneldb filename="permchannels.conf" listmodes="true">
1396 #<include file="permchannels.conf">
1398 # You may also create channels on startup by using the <permchannels> block.
1399 # Don't forget to set them +P in the modes, or they won't stay permanent.
1400 #<permchannels channel="#opers" modes="isP" topic="Opers only.">
1402 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1403 # PostgreSQL module: Allows other SQL modules to access PgSQL databases
1404 # through a unified API.
1405 # This module is in extras. Re-run configure with:
1406 # ./configure --enable-extras=m_pgsql.cpp
1407 # and run make install, then uncomment this module to enable it.
1408 #<module name="m_pgsql.so">
1410 #-#-#-#-#-#-#-#-#-#-#-#- SQL CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#-#
1412 # m_pgsql.so is more complex than described here, see the wiki for #
1413 # more: http://wiki.inspircd.org/Modules/pgsql #
1415 #<database module="pgsql" name="mydb" user="myuser" pass="mypass" host="localhost" id="my_database" ssl="no">
1417 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1418 # Muteban: Implements extended ban 'm', which stops anyone matching
1419 # a mask like +b m:nick!user@host from speaking on channel.
1420 #<module name="m_muteban.so">
1422 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1423 # Random quote module: Provides a random quote on connect.
1424 # NOTE: Some of these may mimic fatal errors and confuse users and
1425 # opers alike - BEWARE!
1426 #<module name="m_randquote.so">
1428 #-#-#-#-#-#-#-#-#-#- RANDOMQUOTES CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
1430 # Optional - If you specify to use the m_randquote.so module, then #
1431 # specify below the path to the quotes file. #
1433 #<randquote file="quotes.txt">
1435 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1436 # Redirect module: Adds channel redirection mode +L. #
1437 # Optional: <redirect:antiredirect> to add usermode +L to stop forced #
1438 # redirection and instead print an error. #
1440 # Note: You can not update this with a simple rehash, it requires #
1441 # reloading the module for it to take effect. #
1442 # This also breaks linking to servers that do not have the option. #
1443 # This defaults to false for the 2.0 version, it will be enabled in #
1444 # all the future versions. #
1445 #<module name="m_redirect.so">
1446 #<redirect antiredirect="true">
1448 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1449 # Regular expression provider for glob or wildcard (?/*) matching.
1450 # You must have at least 1 provider loaded to use m_filter or m_rline
1451 # modules. This module has no additional requirements, as it uses the
1452 # matching already present in InspIRCd core.
1453 #<module name="m_regex_glob.so">
1455 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1456 # Regular expression provider for PCRE (Perl-Compatible Regular
1457 # Expressions). You need libpcre installed to compile and load this
1458 # module. You must have at least 1 provider loaded to use m_filter or
1460 #<module name="m_regex_pcre.so">
1462 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1463 # Regular Expression Provider for RE2 Regular Expressions.
1464 # You need libre2 installed and in your include/library paths in order
1465 # to compile and load this module.
1466 #<module name="m_regex_re2.so">
1468 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1469 # Regular expression provider for POSIX regular expressions.
1470 # You shouldn't need any additional libraries on a POSIX-compatible
1471 # system (i.e.: any Linux, BSD, but not Windows). You must have at
1472 # least 1 provider loaded to use m_filter or m_rline.
1473 # On POSIX-compliant systems, regex syntax can be found by using the
1474 # command: 'man 7 regex'.
1475 #<module name="m_regex_posix.so">
1477 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1478 # Regular expression provider for C++11 std::regex regular expressions.
1479 # This module works on any fully compliant implementation of the C++11
1480 # std::regex container. Examples for such are Visual C++ 2010 and newer
1481 # but not libstdc++ (which GCC uses).
1482 # You should verify that std::regex is supported by your setup before
1483 # using this module, as it may compile normally but won't do anything
1484 # on some implementations.
1485 #<module name="m_regex_stdlib.so">
1487 # Specify the regular expression engine to use here. Valid settings are
1488 # bre, ere, awk, grep, egrep, ecmascript (default if not specified).
1489 #<stdregex type="ecmascript">
1491 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1492 # Regular expression provider for TRE regular expressions.
1493 # This is the same regular expression engine used by UnrealIRCd, so
1494 # if you are most familiar with the syntax of /SPAMFILTER from there,
1495 # this is the provider you want. You need libtre installed in order
1496 # to compile and load this module.
1497 #<module name="m_regex_tre.so">
1499 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1500 # Registered users only channel creation module. If enabled, only
1501 # registered users and opers can create new channels.
1503 # You probably *DO NOT* want to load this module on a public network.
1505 #<module name="m_regonlycreate.so">
1507 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1508 # Remove module: Adds the /REMOVE command which is a peaceful
1509 # alternative to /KICK.
1510 #<module name="m_remove.so">
1512 # supportnokicks: If true, /REMOVE is not allowed on channels where the
1513 # nokicks (+Q) mode is set. Defaults to false.
1514 # protectedrank: Members having this rank or above may not be /REMOVE'd
1515 # by anyone. Set to 0 to disable this feature. Defaults to 50000.
1516 #<remove supportnokicks="true" protectedrank="50000">
1518 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1519 # A module to block, kick or ban upon similiar messages being uttered several times.
1520 # Syntax [~*][lines]:[sec]{[:difference]}{[:matchlines]}
1521 # ~ is to block, * is to ban, default is kick.
1522 # 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
1523 # seconds - How old the message has to be before it's invalidated.
1524 # distance - Edit distance, in percent, between two strings to trigger on.
1525 # matchlines - When set, the function goes into mode 2. In this mode the function will trigger if this many of the last <lines> matches.
1527 # As this module can be rather CPU-intensive, it comes with some options.
1528 # maxbacklog - Maximum size that can be specified for backlog. 0 disables multiline matching.
1529 # maxdistance - Max percentage of difference between two lines we'll allow to match. Set to 0 to disable edit-distance matching.
1530 # maxlines - Max lines of backlog to match against.
1531 # maxsecs - Maximum value of seconds a user can set. 0 to allow any.
1532 # size - Maximum number of characters to check for, can be used to truncate messages
1533 # before they are checked, resulting in less CPU usage. Increasing this beyond 512
1534 # doesn't have any effect, as the maximum length of a message on IRC cannot exceed that.
1535 #<repeat maxbacklog="20" maxlines="20" maxdistance="50" maxsecs="0" size="512">
1536 #<module name="m_repeat.so">
1538 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1539 # Restricted channels module: Allows only opers to create channels.
1541 # You probably *DO NOT* want to load this module on a public network.
1543 #<module name="m_restrictchans.so">
1545 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1546 # Restrict message module: Allows users to only message opers.
1548 # You probably *DO NOT* want to load this module on a public network.
1550 #<module name="m_restrictmsg.so">
1552 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1553 # R-Line module: Ban users through regular expression patterns.
1554 #<module name="m_rline.so">
1556 #-#-#-#-#-#-#-#-#-#-#-#- RLINE CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#-#
1558 # If you wish to re-check a user when they change nickname (can be
1559 # useful under some situations, but *can* also use CPU with more users
1560 # on a server) then set 'matchonnickchange' to yes.
1561 # Also, this is where you set what Regular Expression engine is to be
1562 # used. If you ever change it while running, all of your R-Lines will
1563 # be wiped. This is the regex engine used by all R-Lines set, and
1564 # m_regex_<engine>.so must be loaded, or rline will be non-functional
1565 # until you load it or change the engine to one that is loaded.
1567 #<rline matchonnickchange="yes" engine="pcre">
1569 # Generally, you will NOT want to use 'glob' here, as this turns
1570 # rline into just another gline. The exceptions are that rline will
1571 # always use the full "nick!user@host realname" string, rather than only
1572 # user@host, but beware that only the ? and * wildcards are available,
1573 # and are the only way to specify where the space can occur if you do
1574 # use glob. For this reason, is recommended to use a real regex engine
1575 # so that at least \s or [[:space:]] is available.
1577 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1578 # RMODE module: Adds the /RMODE command
1579 # Allows channel mods to remove list modes en masse.
1580 # Syntax: /rmode <channel> <mode> [pattern]
1581 # E.g. '/rmode #Channel b m:*' will remove all mute-extbans on the channel.
1582 #<module name="m_rmode.so">
1584 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1585 # SAJOIN module: Adds the /SAJOIN command which forcibly joins a user
1586 # to the given channel.
1587 # This module is oper-only.
1588 # To use, SAJOIN must be in one of your oper class blocks.
1589 # Opers need the users/sajoin-others priv to be able to /SAJOIN users
1590 # other than themselves.
1591 #<module name="m_sajoin.so">
1593 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1594 # SAKICK module: Adds the /SAKICK command which kicks a user from the
1596 # This module is oper-only.
1597 # To use, SAKICK must be in one of your oper class blocks.
1598 #<module name="m_sakick.so">
1600 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1601 # SAMODE module: Adds the /SAMODE command which allows server operators
1602 # to change modes on a channel without requiring them to have any
1603 # channel priviliges. Also allows changing user modes for any user.
1604 # This module is oper-only.
1605 # To use, SAMODE must be in one of your oper class blocks.
1606 #<module name="m_samode.so">
1608 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1609 # SANICK module: Adds the /SANICK command which allows opers to change
1611 # This module is oper-only.
1612 # To use, SANICK must be in one of your oper class blocks.
1613 #<module name="m_sanick.so">
1615 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1616 # SAPART module: Adds the /SAPART command which forcibly parts a user
1618 # This module is oper-only.
1619 # To use, SAPART must be in one of your oper class blocks.
1620 #<module name="m_sapart.so">
1622 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1623 # SAQUIT module: Adds the /SAQUIT command which forcibly quits a user.
1624 # This module is oper-only.
1625 # To use, SAQUIT must be in one of your oper class blocks.
1626 #<module name="m_saquit.so">
1628 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1629 # SATOPIC module: Adds the /SATOPIC command which allows changing the
1630 # topic on a channel without requiring any channel priviliges.
1631 # This module is oper-only.
1632 # To use, SATOPIC must be in one of your oper class blocks.
1633 #<module name="m_satopic.so">
1635 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1636 # SASL authentication module: Provides support for IRC Authentication
1637 # Layer via AUTHENTICATE. Note: You also need to have m_cap.so loaded
1639 #<module name="m_sasl.so">
1641 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1642 # Secure list module: Prevent /LIST in the first minute of connection,
1643 # crippling most spambots and trojan spreader bots.
1644 #<module name="m_securelist.so">
1646 #-#-#-#-#-#-#-#-#-# SECURELIST CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#-#
1648 # Securelist can be harmful to some IRC search engines such as #
1649 # netsplit.de and searchirc.com. To prevent securelist blocking these #
1650 # sites from listing, define exception tags as shown below: #
1651 #<securehost exception="*@*.searchirc.org">
1652 #<securehost exception="*@*.netsplit.de">
1653 #<securehost exception="*@echo940.server4you.de">
1654 #<securehost exception="*@*.ircdriven.com">
1656 # Define the following variable to change how long a user must wait #
1657 # before issuing a LIST. If not defined, defaults to 60 seconds. #
1659 #<securelist waittime="60"> #
1661 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1662 # Servprotect module: Provides support for Austhex style +k /
1663 # UnrealIRCD +S services mode.
1664 #<module name="m_servprotect.so">
1666 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1667 # See nicks module: Adds snomask +n and +N which show local and remote
1669 # This module is oper-only.
1670 #<module name="m_seenicks.so">
1672 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1673 # Set idle module: Adds a command for opers to change their idle time.
1674 # This module is oper-only.
1675 # To use, SETIDLE must be in one of your oper class blocks.
1676 #<module name="m_setidle.so">
1678 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1679 # Services support module: Adds several usermodes such as +R and +M.
1680 # This module implements the 'identified' state via account names,
1681 # and is similar in operation to the way asuka and ircu handle services.
1683 # At the same time, this offers +r for users and channels to mark them
1684 # as identified separately from the idea of a master account, which
1685 # can be useful for services which are heavily nick-as-account centric.
1687 # Also of note is that this module implements three extbans:
1688 # +b R: (stop matching account names from joining)
1689 # +b M: (stop matching account names from speaking)
1690 # +b U:n!u@h (blocks matching unregistered users)
1692 #<module name="m_services_account.so">
1694 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1695 # Sethost module: Adds the /SETHOST command.
1696 # This module is oper-only.
1697 # To use, SETHOST must be in one of your oper class blocks.
1698 # See m_chghost for how to customise valid chars for hostnames.
1699 #<module name="m_sethost.so">
1701 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1702 # Setident module: Adds the /SETIDENT command.
1703 # This module is oper-only.
1704 # To use, SETIDENT must be in one of your oper class blocks.
1705 #<module name="m_setident.so">
1707 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1708 # SETNAME module: Adds the /SETNAME command.
1709 #<module name="m_setname.so">
1711 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1712 # Serverban: Implements extended ban 's', which stops anyone connected
1713 # to a server matching a mask like +b s:server.mask.here from joining.
1714 #<module name="m_serverban.so">
1716 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1717 # Showfile: Provides support for showing a text file to users when #
1718 # they enter a command. #
1719 # This module adds one command for each <showfile> tag that shows the #
1720 # given file to the user as a series of messages or numerics. #
1721 #<module name="m_showfile.so"> #
1723 #-#-#-#-#-#-#-#-#-#-# SHOWFILE CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#-#
1725 # name - The name of the command which displays this file. This is #
1726 # the only mandatory setting, all others are optional. #
1727 # file - The text file to be shown to the user. #
1728 # By default same as the command name. #
1729 # method - How should the file be shown? #
1730 # * numeric: Send contents using a numeric #
1731 # (similiar to /MOTD; the default). #
1732 # * notice: Send contents as a series of notices. #
1733 # * msg: Send contents as a series of private messages. #
1734 # colors - If true, color codes (\c, \b, \u, etc.) will be processed #
1735 # and sent as ANSI colors. If false (default) the file will #
1736 # be displayed as-is. #
1738 # When using the method "numeric", the following extra settings are #
1741 # introtext - Introductory line, "Showing <name>" by default. #
1742 # intronumeric - Numeric used for the introductory line. #
1743 # numeric - Numeric used for sending the text itself. #
1744 # endtext - Ending line, "End of <name>" by default. #
1745 # endnumeric - Numeric used for the ending line. #
1747 #<showfile name="RULES"
1750 # introtext="Server rules:"
1751 # endtext="End of server rules.">
1753 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1754 # Show whois module: Adds the +W usermode which allows opers to see
1755 # when they are /WHOIS'd.
1756 # This module is oper-only by default.
1757 #<module name="m_showwhois.so">
1759 # If you wish, you may also let users set this mode. Only opers with the
1760 # users/auspex priv will see real hosts of people, though.
1761 #<showwhois opersonly="yes"
1763 # You may also set whether or not users should receive whois notices,
1764 # should they be /WHOIS'd by an oper.
1765 #showfromopers="yes">
1767 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1768 # Shun module: Provides the /SHUN command, which stops a user from
1769 # executing all except configured commands.
1770 # This module is oper-only.
1771 # To use, SHUN must be in one of your oper class blocks.
1772 #<module name="m_shun.so">
1774 # You may also configure which commands you wish a user to be able to
1775 # perform when shunned. It should be noted that if a shunned user
1776 # issues QUIT or PART then their message will be removed, as if they
1777 # did not issue one.
1779 # You can optionally let the user know that their command was blocked.
1781 # You may also let SHUN affect opers (defaults to no).
1782 #<shun enabledcommands="PING PONG QUIT PART JOIN" notifyuser="yes" affectopers="no">
1784 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1785 # SSL channel mode module: Adds support for SSL-only channels via
1786 # channel mode +z and the 'z' extban which matches SSL client
1787 # certificate fingerprints.
1788 # Does not do anything useful without a working SSL module (see below).
1789 #<module name="m_sslmodes.so">
1791 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1792 # GnuTLS SSL module: Adds support for SSL connections using GnuTLS,
1793 # if enabled. You must answer 'yes' in ./configure when asked or
1794 # manually symlink the source for this module from the directory
1795 # src/modules/extra, if you want to enable this, or it will not load.
1796 #<module name="m_ssl_gnutls.so">
1798 #-#-#-#-#-#-#-#-#-#-#- GNUTLS CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#
1800 # m_ssl_gnutls.so is too complex to describe here, see the wiki: #
1801 # http://wiki.inspircd.org/Modules/ssl_gnutls #
1803 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1804 # SSL info module: Allows users to retrieve information about other
1805 # users' peer SSL certificates and keys. This can be used by client
1806 # scripts to validate users. For this to work, one of m_ssl_gnutls.so
1807 # or m_ssl_openssl.so must be loaded. This module also adds the
1808 # "* <user> is using a secure connection" whois line, the ability for
1809 # opers to use SSL cert fingerprints to verify their identity and the
1810 # ability to force opers to use SSL connections in order to oper up.
1811 # It is highly recommended to load this module if you use SSL on your
1813 # For how to use the oper features, please see the first example <oper> tag
1814 # in opers.conf.example.
1816 #<module name="m_sslinfo.so">
1818 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1819 # OpenSSL SSL module: Adds support for SSL connections using OpenSSL,
1820 # if enabled. You must answer 'yes' in ./configure when asked or symlink
1821 # the source for this module from the directory src/modules/extra, if
1822 # you want to enable this, or it will not load.
1823 #<module name="m_ssl_openssl.so">
1825 #-#-#-#-#-#-#-#-#-#-#- OPENSSL CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#
1827 # m_ssl_openssl.so is too complex to describe here, see the wiki: #
1828 # http://wiki.inspircd.org/Modules/ssl_openssl #
1830 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1831 # Strip color module: Adds channel mode +S that strips mIRC color
1832 # codes from all messages sent to the channel.
1833 #<module name="m_stripcolor.so">
1835 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1836 # Silence module: Adds support for the /SILENCE command, which allows
1837 # users to have a server-side ignore list for their client.
1838 #<module name="m_silence.so">
1840 # Set the maximum number of entries allowed on a user's silence list.
1841 #<silence maxentries="32">
1843 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1844 # SQLite3 module: Allows other SQL modules to access SQLite3 #
1845 # databases through a unified API. #
1846 # This module is in extras. Re-run configure with: #
1847 # ./configure --enable-extras=m_sqlite.cpp
1848 # and run make install, then uncomment this module to enable it. #
1850 #<module name="m_sqlite3.so">
1852 #-#-#-#-#-#-#-#-#-#-#-#- SQL CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#-#
1854 # m_sqlite.so is more complex than described here, see the wiki for #
1855 # more: http://wiki.inspircd.org/Modules/sqlite3 #
1857 #<database module="sqlite" hostname="/full/path/to/database.db" id="anytext">
1859 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1860 # SQL authentication module: Allows IRCd connections to be tied into
1861 # a database table (for example a forum).
1862 # This module is in extras. Re-run configure with:
1863 # ./configure --enable-extras=m_sqlauth.cpp
1864 # and run make install, then uncomment this module to enable it.
1866 #<module name="m_sqlauth.so">
1868 #-#-#-#-#-#-#-#-#-#-#- SQLAUTH CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#
1870 # m_sqlauth.so is too complex to describe here, see the wiki: #
1871 # http://wiki.inspircd.org/Modules/sqlauth #
1873 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1874 # SQL oper module: Allows you to store oper credentials in an SQL table
1875 # This module is in extras. Re-run configure with:
1876 # ./configure --enable-extras=m_sqloper.cpp
1877 # and run make install, then uncomment this module to enable it.
1879 #<module name="m_sqloper.so">
1881 #-#-#-#-#-#-#-#-#-#-#- SQLOPER CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#
1883 # dbid - Database ID to use (see SQL modules). #
1884 # hash - Hashing provider to use for password hashing. #
1886 # See also: http://wiki.inspircd.org/Modules/sqloper #
1888 #<sqloper dbid="1" hash="md5">
1890 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1891 # StartTLS module: Implements STARTTLS, which allows clients #
1892 # connected to non SSL enabled ports to enable SSL, if a proper SSL #
1893 # module is loaded (either m_ssl_gnutls or m_ssl_openssl). #
1894 #<module name="m_starttls.so">
1896 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1897 # SVSHold module: Implements SVSHOLD. Like Q:Lines, but can only be #
1898 # added/removed by Services. #
1899 #<module name="m_svshold.so">
1900 # SVSHOLD does not generate server notices by default, you can turn
1901 # notices on by uncommenting the next line.
1902 #<svshold silent="false">
1904 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1905 # SWHOIS module: Allows you to add arbitrary lines to user WHOIS.
1906 # This module is oper-only.
1907 # To use, SWHOIS must be in one of your oper class blocks.
1908 #<module name="m_swhois.so">
1910 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1911 # Test module: Enable this to create a command useful in testing
1912 # flood control. To avoid accidental use on live networks, the server
1913 # name must contain ".test" to load the module
1914 #<module name="m_testnet.so">
1916 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1917 # Timed bans module: Adds timed channel bans with the /TBAN command.
1918 #<module name="m_timedbans.so">
1920 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1921 # Test line module: Adds the /TLINE command, used to test how many
1922 # users a /GLINE or /ZLINE etc. would match.
1923 # This module is oper-only.
1924 # To use, TLINE must be in one of your oper class blocks.
1925 #<module name="m_tline.so">
1927 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1928 # Topiclock module: implements server-side topic locking to achieve deeper
1929 # integration with services packages.
1930 #<module name="m_topiclock.so">
1932 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1933 # UHNAMES support module: Adds support for the IRCX style UHNAMES
1934 # extension, which displays ident and hostname in the names list for
1935 # each user, saving clients from doing a WHO on the channel.
1936 # If a client does not support UHNAMES it will not enable it, this will
1937 # not break incompatible clients.
1938 #<module name="m_uhnames.so">
1940 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1941 # Uninvite module: Adds the /UNINVITE command which lets users remove
1942 # pending invites from channels without waiting for the user to join.
1943 #<module name="m_uninvite.so">
1945 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1946 # Userip module: Adds the /USERIP command.
1947 # Allows users to query their own IP, also allows opers to query the IP
1949 #<module name="m_userip.so">
1951 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1952 # Vhost module: Adds the VHOST command which allows for adding virtual
1953 # hosts which are accessible using a username and password in the config.
1954 #<module name="m_vhost.so">
1956 #-#-#-#-#-#-#-#-#-#-#- VHOST CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#-#
1958 # user - Username for the vhost. #
1960 # pass - Password for the vhost. #
1962 # hash - The hash for the specific user (optional) #
1963 # m_password_hash.so and a hashing module must be loaded #
1964 # for this to work. #
1966 # host - Vhost to set. #
1968 #<vhost user="some_username" pass="some_password" host="some.host">
1969 #<vhost user="foo" password="fcde2b2edba56bf408601fb721fe9b5c338d10ee429ea04fae5511b68fbf8fb9" hash="sha256" host="some.other.host">
1971 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1972 # Watch module: Adds the WATCH command, which is used by clients to
1973 # maintain notify lists.
1974 #<module name="m_watch.so">
1976 # Set the maximum number of entries on a user's watch list below.
1977 #<watch maxentries="32">
1979 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1980 # XLine database: Stores all *Lines (G/Z/K/R/any added by other modules)
1981 # in a file which is re-loaded on restart. This is useful
1982 # for two reasons: it keeps bans so users may not evade them, and on
1983 # bigger networks, server connections will take less time as there will
1984 # be a lot less bans to apply - as most of them will already be there.
1985 #<module name="m_xline_db.so">
1987 # Specify the filename for the xline database here.
1988 #<xlinedb filename="data/xline.db">
1990 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1991 # ____ _ _____ _ _ ____ _ _ _ #
1992 # | _ \ ___ __ _ __| | |_ _| |__ (_)___ | __ )(_) |_| | #
1993 # | |_) / _ \/ _` |/ _` | | | | '_ \| / __| | _ \| | __| | #
1994 # | _ < __/ (_| | (_| | | | | | | | \__ \ | |_) | | |_|_| #
1995 # |_| \_\___|\__,_|\__,_| |_| |_| |_|_|___/ |____/|_|\__(_) #
1997 # To link servers to InspIRCd, you MUST load the m_spanningtree #
1998 # module. If you don't do this, server links will NOT work at all. #
1999 # This is by design, to allow for the implementation of other linking #
2000 # protocols in modules in the future. #
2002 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2003 # Spanning tree module: Allows linking of servers using the spanning
2004 # tree protocol (see the READ THIS BIT section above).
2005 # You will almost always want to load this.
2007 #<module name="m_spanningtree.so">
projects / user / henk / code / inspircd.git / blob