]> git.netwichtig.de Git - user/henk/code/inspircd.git/blob - conf/modules.conf.example
Revert some files accidentally committed in r11371. I'm apparently doing a very bad...
[user/henk/code/inspircd.git] / conf / modules.conf.example
1 #-#-#-#-#-#-#-#-#-#-#-#-#-  MODULE OPTIONS   -#-#-#-#-#-#-#-#-#-#-#-#-#
2 #                                                                     #
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.      #
10 #                                                                     #
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.       #
15 #                                                                     #
16 #  You may use wildcards in a <module> tag to load all modules which  #
17 #  match a glob pattern (e.g. m_sa????.so would load m_sajoin,        #
18 #  m_sapart, m_saquit and m_sanick)                                   #
19 #                                                                     #
20 #    ____                _   _____ _     _       ____  _ _   _        #
21 #   |  _ \ ___  __ _  __| | |_   _| |__ (_)___  | __ )(_) |_| |       #
22 #   | |_) / _ \/ _` |/ _` |   | | | '_ \| / __| |  _ \| | __| |       #
23 #   |  _ <  __/ (_| | (_| |   | | | | | | \__ \ | |_) | | |_|_|       #
24 #   |_| \_\___|\__,_|\__,_|   |_| |_| |_|_|___/ |____/|_|\__(_)       #
25 #                                                                     #
26 # To link servers to InspIRCd, you MUST load the m_spanningtree       #
27 # module. Since several features (like SSL server links) rely on      #
28 # other modules being loaded before m_spanningtree, the module itself #
29 # is at the bottom of this file. DO NOT forget to load it. If you DO  #
30 # NOT do this, server links will NOT work at all. ie. The ports will  #
31 # NOT bind, and /connect will not work properly. This is by design,   #
32 # to allow for the implementation of other linking protocols in       #
33 # modules in the future.                                              #
34 #                                                                     #
35
36 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
37 # MD5 Module - Allows other modules to generate MD5 hashes, usually for
38 # cryptographic uses and security.
39 #
40 # IMPORTANT:
41 # Other modules such as m_cloaking.so and m_password_hash.so may rely on
42 # this module being loaded to function.
43 #
44 #<module name="m_md5.so">
45 #
46 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
47 # SHA256 Module - Allows other modules to generate SHA256 hashes,
48 # usually for cryptographic uses and security.
49 #
50 # IMPORTANT:
51 # Other modules such as m_password_hash.so may rely on this module being
52 # loaded to function. Certain modules such as m_spanningtree.so will
53 # function without this module but when it is loaded their features will
54 # be enhanced (for example the addition of HMAC authentication).
55 #
56 #<module name="m_sha256.so">
57 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
58 # RIPEMD160 Module - Allows other modules to generate RIPEMD160 hashes,
59 # usually for cryptographic uses and security.
60
61 # IMPORTANT:
62 # Other modules may rely on this module being loaded to function.
63 #<module name="m_ripemd160.so">
64
65 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
66 # Abbreviation module: Provides the ability to abbreviate commands a-la 
67 # BBC BASIC keywords.
68 #<module name="m_abbreviation.so">
69
70 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
71 # Alias module: Allows you to define server-side command aliases
72 #<module name="m_alias.so">
73 #
74 # Fantasy settings:
75 #
76 #<fantasy prefix="!" allowbots="no">
77 #
78 # prefix:
79 #  Set the prefix for in-channel aliases (fantasy commands) to the
80 #  specified character. If not set, the default is "!".
81 # allowbots:
82 #  If this is set to no, +B clients will not be able to use fantasy
83 #  commands. If not set, the default is no.
84 #
85 #-#-#-#-#-#-#-#-#-#-#-  ALIAS DEFINITIONS  -#-#-#-#-#-#-#-#-#-#-#-#-#-#
86 #                                                                     #
87 # If you have the m_alias.so module loaded, you may also define       #
88 # aliases as shown below. They are commonly used to provide shortcut  #
89 # commands to services, however they are not limited to just this use.#
90 # An alias tag requires the following values to be defined in it:     #
91 #                                                                     #
92 # text        -      The text to detect as the actual command line,   #
93 #                    Cant contain spaces, but case insensitive.       #
94 #                    You may have multiple aliases with the same      #
95 #                    command name (text="" value), however the first  #
96 #                    found will be executed if its format value is    #
97 #                    matched, or it has no format value. Aliases are  #
98 #                    read from the top of the file to the bottom.     #
99 #                                                                     #
100 # usercommand -      If this is true, the alias can be run simply as  #
101 #                    /aliasname. Defaults to true.                    #
102 #                                                                     #
103 # channelcommand -   If this is true, the alias can be used as an     #
104 #                    in-channel alias or 'fantasy command', prefixed  #
105 #                    by the fantasy prefix character, !aliasname by   #
106 #                    default. Defaults to false.                      #
107 #                                                                     #
108 # format      -      If this is defined, the parameters of the alias  #
109 #                    must match this glob pattern. For example if you #
110 #                    want the first parameter to start with a # for   #
111 #                    the alias to be executed, set format="#*" in the #
112 #                    alias definition. Note that the :'s which are    #
113 #                    part of IRC formatted lines will be preserved    #
114 #                    for matching of this text. This value is         #
115 #                    optional.                                        #
116 #                                                                     #
117 # replace     -      The text to replace 'text' with. Usually this    #
118 #                    will be "PRIVMSG ServiceName :$2-" or similar.   #
119 #                    You may use the variables $1 through $9 in the   #
120 #                    replace string, which refer to the first through #
121 #                    ninth word in the original string typed by the   #
122 #                    user. You may also use $1- through $9- which     #
123 #                    refer to the first word onwards, through to the  #
124 #                    ninth word onwards, e.g. if the user types the   #
125 #                    command "foo bar baz qux quz" then $3- will hold #
126 #                    "baz qux quz" and $2 will contain "bar". You may #
127 #                    also use the special variables: $nick, $ident,   #
128 #                    $host and $vhost, and you may separate multiple  #
129 #                    commands with \n. If you wish to use the ACTUAL  #
130 #                    characters \ and n together in a line, you must  #
131 #                    use the sequence "\\n".                          #
132 #                                                                     #
133 # requires    -      If you provide a value for 'requires' this means #
134 #                    the given nickname MUST be online for the alias  #
135 #                    to successfully trigger. If they are not, then   #
136 #                    the user receives a 'no such nick' 401 numeric.  #
137 #                                                                     #
138 # uline       -      Defining this value with 'yes', 'true' or '1'    #
139 #                    will ensure that the user given in 'requires'    #
140 #                    must also be on a u-lined server, as well as     #
141 #                    actually being on the network. If the user is    #
142 #                    online, but not on a u-lined server, then an     #
143 #                    oper-alert is sent out as this is possibly signs #
144 #                    of a user trying to impersonate a service.       #
145 #                                                                     #
146 # operonly    -      Defining this value, with a value of 'yes', '1'  #
147 #                    or true will make the alias oper only. If a non- #
148 #                    oper attempts to use the alias, it will appear   #
149 #                    to not exist.                                    #
150 #                                                                     #
151 #<alias text="NICKSERV" replace="PRIVMSG NickServ :$2-" requires="NickServ" uline="yes">
152 #<alias text="CHANSERV" replace="PRIVMSG ChanServ :$2-" requires="ChanServ" uline="yes">
153 #<alias text="OPERSERV" replace="PRIVMSG OperServ :$2-" requires="OperServ" uline="yes" operonly="yes">
154 #<alias text="NS" replace="PRIVMSG NickServ :$2-" requires="NickServ" uline="yes">
155 #<alias text="CS" replace="PRIVMSG ChanServ :$2-" requires="ChanServ" uline="yes">
156 #<alias text="OS" replace="PRIVMSG OperServ :$2-" requires="OperServ" uline="yes" operonly="yes">
157 #
158 # An example of using the format value to create an alias with two
159 # different behaviours depending on the format of the parameters.
160 #
161 #<alias text="ID" format="#*" replace="PRIVMSG ChanServ :IDENTIFY $2 $3"
162 #  requires="ChanServ" uline="yes">
163 #
164 #<alias text="ID" replace="PRIVMSG NickServ :IDENTIFY $2"
165 #  requires="NickServ" uline="yes">
166 #
167 # This alias fixes a glitch in xchat 2.6.x and above and the way it
168 # assumes IDENTIFY must be prefixed by a colon (:) character. It should
169 # be placed ABOVE the default NICKSERV alias (the first example) listed
170 # above.
171 #
172 #<alias text="NICKSERV" format=":IDENTIFY *" replace="PRIVMSG NickServ :IDENTIFY $3-"
173 #  requires="NickServ" uline="yes">
174 #
175 # You may also add aliases to trigger based on something said in a
176 # channel, aka 'fantasy' commands, configured in the same manner as any
177 # other alias, with usercommand="no" and channelcommand="yes" The
178 # command must be preceded by the fantasy prefix when used.
179 #
180 #<alias text="CS" usercommand="no" channelcommand="yes"
181 #  replace="PRIVMSG ChanServ :$1 $chan $2-" requires="ChanServ" uline="yes">
182 #
183 # This would be used as "!cs <command> <options>", with the channel
184 # being automatically inserted after the command in the message to
185 # ChanServ, assuming the fantasy prefix is "!".
186
187 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
188 # Allowinvite module: Gives channel mode +A to allow all users to use
189 # /invite, and extban A to deny invite from specific masks
190 #<module name="m_allowinvite.so">
191
192 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
193 # Alltime module: Shows time on all connected servers at once.
194 # This module is oper-only and provides /alltime.
195 # To use, ALLTIME must be in one of your oper class blocks.
196 #<module name="m_alltime.so">
197
198 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
199 # Antibear security module: Prevents 'bear.txt' based trojans from
200 # connecting to your network by sending them a numeric they can't handle.
201 #<module name="m_antibear.so">
202
203 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
204 # Antibottler module: Labels bottler leech bots
205 #<module name="m_antibottler.so">
206
207 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
208 # Auditorium module: Adds channel mode +u which makes everyone else
209 # except you in the channel invisible, used for large meetings etc.
210 #<module name="m_auditorium.so">
211 #
212 # Auditorium settings:
213 #
214 #<auditorium showops="no" operoverride="no">
215 #
216 # showops:
217 #   Setting this value to yes makes m_auditorium behave like unrealircd
218 #   +u channel mode, e.g. ops see users joining, parting, etc, and users
219 #   joining the channel see the ops. Without this flag, the mode acts
220 #   like ircnet's +a (anonymous channels), showing only the user in the
221 #   names list, and not even showing the ops in the list, or showing the
222 #   ops that the user has joined.
223 # operoverride:
224 #   Setting this value to yes makes m_auditorium affect the userlist for
225 #   regular users only. Opers will view all users in the channel normally.
226
227 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
228 # Ban except module: Adds support for channel ban exceptions (+e)
229 #<module name="m_banexception.so">
230
231 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
232 # Ban redirection module: Allows bans which redirect to a specified
233 # channel. e.g. +b nick!ident@host#channelbanneduserissentto
234 #<module name="m_banredirect.so">
235
236 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
237 # Block amsg module: Attempt to block all usage of /amsg and /ame
238 #<module name="m_blockamsg.so">
239 #
240 #-#-#-#-#-#-#-#-#-#-#-  BLOCKAMSG CONFIGURATION  -#-#-#-#-#-#-#-#-#-#-#
241 #                                                                     #
242 # If you have the m_blockamsg.so module loaded, you can configure it  #
243 # with the <blockamsg> tag:                                           #
244 #                                                                     #
245 # delay          -   How many seconds between two messages to force   #
246 #                    them to be recognised as unrelated.              #
247 # action         -   Any of 'notice', 'noticeopers', 'silent', 'kill' #
248 #                    or 'killopers'. Define how to take action when   #
249 #                    a user uses /amsg or /ame.                       #
250 #
251 #<blockamsg delay="3" action="killopers">
252
253 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
254 # Block CAPS module: Blocking all-CAPS messages with cmode +B
255 #<module name="m_blockcaps.so">
256 #                                                                     #
257 #-#-#-#-#-#-#-#-#-#-#-  BLOCKCAPS CONFIGURATION  -#-#-#-#-#-#-#-#-#-#-#
258 #                                                                     #
259 # percent        - How many percent of text must be caps before text  #
260 #                  will be blocked.                                   #
261 #                                                                     #
262 # minlen         - The minimum length a line must be for the block    #
263 #                  percent to have any effect.                        #
264 #                                                                     #
265 # capsmap        - A list of chars to be considered CAPS, this was    #
266 #                  you can add CAPS for your language. Also you can   #
267 #                  add things like ! and space to further lock down   #
268 #                  on caps usage.                                     #
269 #<blockcaps percent="50"
270 #           minlen="5"
271 #           capsmap="ABCDEFGHIJKLMNOPQRSTUVWXYZ! ">
272
273 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
274 # Block colour module: Blocking colour-coded messages with cmode +c
275 #<module name="m_blockcolor.so">
276
277 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
278 # Botmode module: Adds the user mode +B
279 #<module name="m_botmode.so">
280
281 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
282 # CallerID module: Adds usermode +g which activates hybrid-style 
283 # callerid (== block all private messages unless you /accept first)
284 #<module name="m_callerid.so">
285
286 #-#-#-#-#-#-#-#-#-#-#- CALLERID  CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#
287 # maxaccepts     - Maximum number of entires a user can add to his    #
288 #                  /accept list. Default is 16 entries.               #
289 # operoverride   - Can opers (note: ALL opers) ignore callerid mode?  #
290 #                  Default is no.                                     #
291 # tracknick      - Preserve /accept entries when a user changes nick? #
292 #                  If no (the default), the user is removed from      #
293 #                  everyone's accept list if he changes nickname.     #
294 # cooldown       - Amount of time (in seconds) that must pass since   #
295 #                  the last notification sent to a user before he can #
296 #                  be sent another. Default is 60 (1 minute).         #
297 #<callerid maxaccepts="16"
298 #          operoverride="no"
299 #          tracknick="no"
300 #          cooldown="60">
301
302 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
303 # CAP module: Provides the CAP negotiation mechanism seen in
304 # ratbox-derived ircds
305 #<module name="m_cap.so">
306
307 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
308 # CBAN module: Lets you disallow channels from being used at runtime.
309 # This module is oper-only and provides /cban.
310 # To use, CBAN must be in one of your oper class blocks.
311 #<module name="m_cban.so">
312
313 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
314 # Censor module: Adds the channel mode +G
315 #<module name="m_censor.so">
316 #
317 #-#-#-#-#-#-#-#-#-#-#-  CENSOR  CONFIGURATION  -#-#-#-#-#-#-#-#-#-#-#-#
318 #                                                                     #
319 # Optional - If you specify to use the m_censor module, then you must #
320 # specify some censor tags. See also:                                 #
321 # http://wiki.inspircd.org/Modules/censor                             #
322 #
323 #<include file="censor.conf">
324
325 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
326 # CGI:IRC module: Adds support for automatic host changing in CGI:IRC
327 # (http://cgiirc.sourceforge.net).
328 #<module name="m_cgiirc.so">
329 #
330 #-#-#-#-#-#-#-#-#-#-#-# CGIIRC  CONFIGURATION #-#-#-#-#-#-#-#-#-#-#-#-#
331 #
332 # Optional - If you specify to use m_cgiirc, then you must specify one
333 # or more cgihost tags which indicate authorised CGI:IRC servers which
334 # will be connecting to your network, and an optional cgiirc tag.
335 # For more information see: http://wiki.inspircd.org/Modules/cgiirc
336 #
337 # Set to yes if you want to notice opers when CGI clients connect
338 # <cgiirc opernotice="no">
339 #
340 # The type field indicates where the module should get the real
341 # client's IP address from, for further information, please see the
342 # CGI:IRC documentation.
343 #
344 # Old style:
345 # <cgihost type="pass" mask="www.mysite.com">       # Get IP from PASS
346 # <cgihost type="ident" mask="otherbox.mysite.com"> # Get IP from ident
347 # <cgihost type="passfirst" mask="www.mysite.com">  # See the docs
348 # New style:
349 # <cgihost type="webirc" password="foobar"
350 #   mask="somebox.mysite.com">                      # Get IP from WEBIRC
351 #
352 # IMPORTANT NOTE:
353 # ---------------
354 #
355 # When you connect CGI:IRC clients, there are two connect classes which
356 # apply to these clients. When the client initially connects, the connect
357 # class which matches the cgi:irc site's host is checked. Therefore you
358 # must raise the maximum local/global clients for this ip as high as you
359 # want to allow cgi clients. After the client has connected and is
360 # determined to be a cgi:irc client, the class which matches the client's
361 # real IP is then checked. You may set this class to a lower value, so that
362 # the real IP of the client can still be restricted to, for example, 3
363 # sessions maximum.
364 #
365
366
367 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
368 # Channel create module: Adds snomask +j, which will notify opers of
369 # any new channels that are created.
370 # This module is oper-only.
371 #<module name="m_chancreate.so">
372
373 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
374 # Channel filter module: Allows channel-op defined message
375 # filtering using simple string matches (channel mode +g)
376 #<module name="m_chanfilter.so">
377 #
378 # If hidemask is set to yes, the user will not be shown the mask when
379 # his/her message is blocked.
380 #<chanfilter hidemask="yes">
381
382 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
383 # Channel logging module: used to send snotice output to channels, to
384 # allow staff to centrally monitor and discuss network activity.
385 #
386 # The "channel" field is where you want the messages to go, "snomasks"
387 # is what snomasks you want to be sent to that channel. Multiple tags
388 # are allowed.
389 #<module name="m_chanlog.so">
390 #<chanlog snomasks="AOcC" channel="#opers">
391
392 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
393 # Channelban: Implements extended ban j:, which stops anyone in already
394 # in a channel matching a mask like +b j:#channel*mask from joining.
395 #<module name="m_channelban.so">
396
397 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
398 # Chanprotect module: gives +q and +a channel modes
399 #<module name="m_chanprotect.so">
400
401 <chanprotect
402         # noservices: With this set to yes, when a user joins a empty channel,
403         # the server will set +q on them. If set to no, it will only set +o
404         # on them until they register the channel.
405         noservices="no"
406
407         # qprefix: Prefix (symbol) to use for +q users.
408         qprefix="~"
409
410         # aprefix: Prefix (symbol) to use for +a users.
411         aprefix="&"
412
413         # deprotectself: If this value is set (true, yes or 1), it will allow
414         # +a and +q users to remove the +a and +q from themselves, otherwise,
415         # the status will have to be removed by services.
416         deprotectself="yes"
417
418         # deprotectothers: If this value is set to yes, true, or 1, then any
419         # user with +q or +a may remove the +q or +a from other users.
420         deprotectothers="yes">
421
422
423 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
424 # Check module: gives /check
425 # Check is useful for looking up information on channels,
426 # users, IP addresses and hosts.
427 # This module is oper-only.
428 # To use, CHECK must be in one of your oper class blocks.
429 #<module name="m_check.so">
430
431 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
432 # CHGHOST module: Adds the /CHGHOST command
433 # This module is oper-only.
434 # To use, CHGHOST must be in one of your oper class blocks.
435 #<module name="m_chghost.so">
436 #
437 #-#-#-#-#-#-#-#-# /CHGHOST - /SETHOST  CONFIGURATION #-#-#-#-#-#-#-#-#
438 # Optional - If you want to use special chars for hostnames you can  #
439 # specify your own custom list of chars with the <hostname> tag:     #
440 #                                                                    #
441 # charmap        - A list of chars accepted as valid by the /CHGHOST #
442 #                  and /SETHOST commands. Also note that the list is # 
443 #                  case-sensitive.                                   #
444 #<hostname charmap="abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ.-_/0123456789">
445
446 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
447 # CHGIDENT module: Adds the /CHGIDENT command
448 # This module is oper-only.
449 # To use, CHGIDENT must be in one of your oper class blocks.
450 #<module name="m_chgident.so">
451
452 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
453 # CHGNAME module: Adds the /CHGNAME command
454 # This module is oper-only.
455 # To use, CHGNAME must be in one of your oper class blocks.
456 #<module name="m_chgname.so">
457
458 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
459 # Cloaking module: Adds usermode +x and cloaking support.
460 # Relies on the module m_md5.so being loaded before m_cloaking.so in
461 # the configuration file.
462 # To use, you should enable m_conn_umodes and add +x as
463 # an enabled mode. See the m_conn_umodes module for more information.
464 #<module name="m_cloaking.so">
465 #
466 #-#-#-#-#-#-#-#-#-#-#- CLOAKING  CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#
467 #                                                                     #
468 # Optional - If you specify the m_cloaking.so module as above, you    #
469 # must define cloak keys, and optionally a cloak prefix as shown      #
470 # below. When using cloaking, the cloak keys are MANDITORY and must   #
471 # be included. However, if prefix is not included, it will default    #
472 # to your networks name from the <server> tag. You can also include   #
473 # the following optional values:                                      #
474 #                                                                     #
475 #   ipalways         - Always cloak the IP address, not the hostname, #
476 #                      which doesn't reveal the user's ISP, but       #
477 #                      results in hosts that are harder to read and   #
478 #                      ban.                                           #
479 #                                                                     #
480 #   lowercase        - Display the cloaked hostnames in lowercase     #
481 #                      characters instead of uppercase                #
482 #                                                                     #
483 # <cloak key1="0x2AF39F40"                                            #
484 #        key2="0x78E10B32"                                            #
485 #        key3="0x4F2D2E82"                                            #
486 #        key4="0x043A4C81"                                            #
487 #        prefix="mynet"                                               #
488 #        ipalways="false"                                             #
489 #        lowercase="false">                                           #
490 #                                                                     #
491 # Please note that the key values will accept any number, and should  #
492 # be large numbers. Using small numbers such as "7" or "1924" will    #
493 # seriously weaken the security of your cloak. It is recommended you  #
494 # use hexdecimal numbers prefixed by "0x", as shown in this example,  #
495 # with each key eight hex digits long.                                #
496
497 #-#-#-#-#-#-#-#-#-#-#-#- CLOSE MODULE #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
498 # Close module: Allows an oper to close all unregistered connections.
499 # This module is oper-only and provides /close.
500 # To use, CLOSE must be in one of your oper class blocks.
501 #<module name="m_close.so">
502
503 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
504 # Clones module: Adds an oper command /CLONES for detecting cloned
505 # users. Warning: This module may be resource intensive when its
506 # command is issued, use with care.
507 # This module is oper-only.
508 # To use, CLONES must be in one of your oper class blocks.
509 #<module name="m_clones.so">
510
511 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
512 # Common channels module: Adds user mode +c, which, when set, requires
513 # that users must share a common channel with you to PRIVMSG or NOTICE
514 # you.
515 #<module name="m_commonchans.so">
516
517 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
518 # Conn-Join: Allows you to force users to join one or more channels
519 # automatically upon connecting to the server.
520 #<module name="m_conn_join.so">
521 #
522 #-#-#-#-#-#-#-#-#-#-#-#- CONNJOIN CONFIGURATION  -#-#-#-#-#-#-#-#-#-#-#
523 #
524 # If you have m_conn_join.so loaded, you can configure it using the
525 # follow values:
526 #
527 #<autojoin channel="#one,#two,#three">
528
529 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
530 # Conn-Usermodes: Set modes on users when they connect
531 # When this module is loaded <connect:allow> tags may have an optional
532 # modes="" value, which contains modes to add or remove from users
533 # when they connect to the server.
534 #<module name="m_conn_umodes.so">
535
536 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
537 # Conn-Wait-for-Pong: Don't let a user connect until they PONG
538 #<module name="m_conn_waitpong.so">
539 #
540 #-#-#-#-#-#-#-#-#-#-#-   WAITPONG CONFIGURATION  -#-#-#-#-#-#-#-#-#-#-#
541 #                                                                     #
542 # If you have the m_conn_waitpong.so module loaded, configure it with #
543 # the <waitpong> tag:                                                 #
544 #                                                                     #
545 # sendsnotice    -   Whether to send a snotice on connect, like other #
546 #                    older ircds                                      #
547 #                                                                     #
548 # killonbadreply -   Whether to kill the user if they send the wrong  #
549 #                    PONG reply.                                      #
550 #                                                                     #
551 #<waitpong sendsnotice="yes" killonbadreply="yes">
552
553
554 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
555 # Channel cycle module. Server side /hop, with +ilk etc bypass.
556 #<module name="m_cycle.so">
557
558 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
559 # Connectban: Provides IP connection throttling. Any IP range that connects
560 # too many times (configurable) in an hour is zlined for a (configurable)
561 # duration, and their count resets to 0.
562 #
563 # ipv4cidr and ipv6cidr allow you to turn the comparison from individual
564 # IP addresses (32 and 128 bits) into CIDR masks, to allow for throttling
565 # over whole ISPs/blocks of IPs, which may be needed to prevent attacks.
566 #
567 #<connectban threshold="10" duration="10m" ipv4cidr="32" ipv6cidr="128">
568 # This allows for 10 connections in an hour with a 10 minute ban if that is exceeded.
569 #
570 #<module name="m_connectban.so">
571
572 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
573 # Connection throttle module. Configuration:
574 #<module name="m_connflood.so">
575 #
576 #-#-#-#-#-#-#-#-#-#-#- CONTHROTTLE CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
577 #  seconds, maxconns -  Amount of connections per <seconds>.
578 #
579 #  timeout           -  Time to wait after the throttle was activated
580 #                       before deactivating it. Be aware that the time
581 #                       is seconds + timeout.
582 #
583 #  quitmsg           -  The message that users get if they attempt to
584 #                       connect while the throttle is active.
585 #
586 #  bootwait          -  Amount of time to wait before enforcing the
587 #                       throttling when the server just booted.
588 #
589 #<connflood seconds="30" maxconns="3" timeout="30"
590 #   quitmsg="Throttled" bootwait="10">
591
592 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
593 # Custom title module: Adds the /TITLE command which allows for trusted
594 #                      users to gain a custom whois line and a optional
595 #                      vhost can be specified.
596 #<module name="m_customtitle.so">
597 #
598 #-#-#-#-#-#-#-#-#-#-  CUSTOM TITLE CONFIGURATION   -#-#-#-#-#-#-#-#-#-#
599 #  name              - The username used to identify 
600 #  password          - The password used to identify
601 #  hash              - The hash for the specific user's password (optional)
602 #                      m_password_hash.so and a hashing module must be loaded for this to work
603 #  host              - Allowed hostmask [optional]
604 #  title             - Title shown in whois
605 #  vhost             - Displayed host [optional]
606 #
607 #<title name="foo" password="bar" title="Official Chat Helper">
608 #<title name="bar" password="foo" host="ident@host.name" title="Official Chat Helper" vhost="helper.network.chat">
609 #<title name="foo" password="fcde2b2edba56bf408601fb721fe9b5c338d10ee429ea04fae5511b68fbf8fb9" hash="sha256" title="Official Chat Helper">
610
611 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
612 # DCCALLOW module: Adds the /DCCALLOW command
613 #<module name="m_dccallow.so">
614 #
615 #-#-#-#-#-#-#-#-#-#-#-  DCCALLOW CONFIGURATION   -#-#-#-#-#-#-#-#-#-#-#
616 #  blockchat         - Whether to block DCC CHAT as well as DCC SEND
617 #  length            - Default duration of entries in DCCALLOW list
618 #  action            - Default action to take if no action is specified
619 #                      can be 'block' or 'allow'
620 #
621 # File configuration:
622 #  pattern           - The glob pattern to match against
623 #  action            - Action to take if a user attempts to send a file
624 #                      that matches this pattern, can be 'block' or 'allow'
625 #
626 #<dccallow blockchat="yes" length="5m" action="block">
627 #<banfile pattern="*.exe" action="block">
628 #<banfile pattern="*.txt" action="allow">
629 #
630 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
631
632 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
633 # Deaf module: adds support for ircu style usermode +d - deaf to
634 # channel messages and channel notices.
635 #<module name="m_deaf.so">
636
637 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
638 # Delay join module: Adds the channel mode +D which delays all JOIN
639 # messages from users until they speak. If they quit or part before
640 # speaking, their quit or part message will not be shown to the channel
641 # which helps cut down noise on large channels in a more friendly way
642 # than the auditorium mode. Only channel ops may set the +D mode.
643 #<module name="m_delayjoin.so">
644
645 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
646 # Deny Channels: Deny Channels from being used by users
647 #<module name="m_denychans.so"> 
648 #
649 #-#-#-#-#-#-#-#-#-#-#-   DENYCHAN DEFINITIONS  -#-#-#-#-#-#-#-#-#-#-#-#
650 #                                                                     #
651 # If you have the m_denychans.so module loaded, you need to specify   #
652 # the channels to deny:                                               #
653 #                                                                     #
654 # name        -      The channel name to deny. (glob masks are ok)    #
655 #                                                                     #
656 # allowopers  -      If operators are allowed to override the deny.   #
657 #                                                                     #
658 # reason      -      Reason given for the deny.                       #
659 #                                                                     #
660 # redirect    -      Redirect the user to a different channel         #
661 #                                                                     #
662 #<badchan name="#gods*" allowopers="yes" reason="Tortoises!">         #
663 #<badchan name="#heaven" redirect="#hell" reason="Nice try!">         #
664 #                                                                     #
665 # Redirects will not work if the target channel is set +L.            #
666 #                                                                     #
667 # Additionally, you may specify channels which are allowed, even if   #
668 # a badchan tag specifies it would be denied:                         #
669 #<goodchan name="#godsleeps">                                         #
670 # Glob masks are accepted here also.
671
672 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
673 # Devoice Module: Let users devoice themselves.
674 #<module name="m_devoice.so">
675
676 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
677 # DNS Blacklist Module: Provides support for looking up IPs on one or #
678 # more blacklists.                                                    #
679 #<module name="m_dnsbl.so">                                           #
680 #                                                                     #
681 # For configuration options please see the wiki page for m_dnsbl at   #
682 # http://wiki.inspircd.org/Modules/dnsbl                              #
683
684 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
685 # Filter module: Provides message filtering, similar to SPAMFILTER.
686 #<module name="m_filter.so">
687 #                                                                     #
688 # This module depends upon a regex provider such as m_regex_pcre or   #
689 # m_regex_glob to function. You must specify which of these you want  #
690 # m_filter to use via the tag below.                                  #
691 #                                                                     #
692 # Valid engines are:                                                  #
693 #                                                                     #
694 # glob  - Glob patterns, provided via m_regex_glob.so                 #
695 # pcre  - PCRE regexps, provided via m_regex_pcre.so, needs libpcre   #
696 # tre   - TRE regexps, provided via m_regex_tre.so, requires libtre   #
697 # posix - POSIX regexps, provided via m_regex_posix.so, not availale  #
698 #         on windows, no dependencies on other operating systems.     #
699 #                                                                     #
700 #<filteropts engine="glob">                                           #
701 #                                                                     #
702 # Your choice of regex engine must match on all servers network-wide.
703 #
704 # You may specify specific channels that are exempt from being filtered:
705 #<exemptfromfilter channel="#blah">
706 #
707 #-#-#-#-#-#-#-#-#-#-#-  FILTER  CONFIGURATION  -#-#-#-#-#-#-#-#-#-#-#-#
708 #                                                                     #
709 # Optional - If you specify to use the m_filter module, then          #
710 # specfiy below the path to the filter.conf file, or define some      #
711 # <filter> tags.                                                      #
712 #                                                                     #
713 #<include file="filter.conf">
714
715 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
716 # Foobar module: does nothing - historical relic
717 #<module name="m_foobar.so">
718
719 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
720 # Gecosban: Implements extended ban r:, which stops anyone matching
721 # a mask like +b r:*realname?here* from joining a channel.
722 #<module name="m_gecosban.so">
723
724 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
725 # GeoIP module: Allows the server admin to ban users by country code.
726 # This modules is in extras. Re-run configure with: ./configure --enable-extras=m_geoip.cpp
727 # and run make install, then uncomment this module to enable it.
728 #<module name="m_geoip.so">
729 #
730 #-#-#-#-#-#-#-#-#-#-#-#  GEOIP CONFIGURATION  #-#-#-#-#-#-#-#-#-#-#-#-#
731 #                                                                     #
732 # <geoip banunknown="false">                                          #
733 #                                                                     #
734 # Set this value to true or yes to block unknown IP ranges which are  #
735 # not in the database (usually LAN addresses, localhost, etc)         #
736 #                                                                     #
737 # <geoban country="TR" reason="This country not permitted">           #
738 #                                                                     #
739 # Use one or more of these tags to ban countries by country code.     #
740 # The country code must be in capitals and should be an ISO country   #
741 # code such as TR, GB, or US.                                         #
742
743 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
744 # Globops module: gives /GLOBOPS and SNOMASK +g
745 # This module is oper-only.
746 # To use, GLOBOPS must be in one of your oper class blocks.
747 #<module name="m_globops.so">
748
749 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
750 # Global load module: Allows loading and unloading of modules network-
751 # wide (USE WITH EXTREME CAUTION!)
752 # This module is oper-only and provides /gloadmodule, /gunloadmodule
753 # and /greloadmodule.
754 # To use, GLOADMODULE, GUNLOADMODULE and GRELOADMODULE
755 # must be in one of your oper class blocks.
756 #<module name="m_globalload.so">
757
758 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
759 # HELPOP module: Provides the /HELPOP command
760 #<module name="m_helpop.so">
761 #
762 #-#-#-#-#-#-#-#-#-#-#-#-  HELPOP  CONFIGURATION  -#-#-#-#-#-#-#-#-#-#-#
763 #                                                                     #
764 # Optional - If you specify to use the m_helpop.so module, then       #
765 # specify below the path to the helpop.conf file, or if you like to   #
766 # make a mess, define your helpop tags in this conf.                  #
767 #                                                                     #
768 #<include file="helpop.conf">
769
770 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
771 # HIDECHANS module: Allows opers to hide their channels list from non-
772 # opers by setting user mode +I on themselves.
773 # <module name="m_hidechans.so">
774 #
775 # HIDECHANS can optionally prevent opers from seeing channels on a +I
776 # user, for more privacy if set to true.
777 # This setting is not recommended for most mainstream networks.
778 #<hidechans affectsopers="false">
779
780 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
781 # HIDEOPER module: Allows opers to hide their oper status from non-
782 # opers by setting user mode +H on themselves.
783 # This module is oper-only.
784 # <module name="m_hideoper.so">
785
786 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
787 # Hostchange module: Allows a different style of cloaking
788 #<module name="m_hostchange.so">
789 #
790 #-#-#-#-#-#-#-#-#-#-#-  HOSTCHANGE  CONFIGURATION  -#-#-#-#-#-#-#-#-#-#
791 #                                                                     #
792 # Optional - If you choose to use the m_hostchange.so module.         #
793 # Config Help -  See http://wiki.inspircd.org/Modules/hostchange      #
794 #                                                                     #
795 #<host suffix="polarbears.org" separator="." prefix="">
796 #<hostchange mask="*@fbi.gov" action="addnick">
797 #<hostchange mask="*r00t@*" action="suffix">
798 #<hostchange mask="a@b.com" action="set" value="blah.blah.blah">
799 #<hostchange mask="localhost" ports="7000,7001,7005-7007" action="set" value="blahblah.foo">
800
801 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
802 # httpd module: Provides http server support for InspIRCd
803 #<module name="m_httpd.so">
804 #
805 #-#-#-#-#-#-#-#-#-#-#-#-  HTTPD   CONFIGURATION  -#-#-#-#-#-#-#-#-#-#-#
806 #
807 # Optional - If you choose to use the m_httpd.so module,  then you must
808 # specify the port number and other details of your http server:
809 #
810 #<http ip="192.168.1.10" host="brainwave" port="32006"
811 #      index="/home/brain/inspircd/http/index.html">
812 #
813 # You may have as many of these tags as you wish, each with a different
814 # IP, port, host or index file. Each one will act as an independent
815 # HTTP server.
816 #
817
818 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
819 # http ACL module: Provides access control lists for m_httpd dependent
820 # modules. Use this module to restrict pages by IP address and by
821 # password.
822 #
823 #<module name="m_httpd_acl.so">
824 #
825 #-#-#-#-#-#-#-#-#-#-#-#- HTTPD ACL CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
826 #
827 # Restrict access to the m_httpd_stats module to all but the local
828 # network and when the correct password is specified:
829 #
830 # <httpdacl path="/stats*" types="password,whitelist"
831 #    username="secretstuff" password="mypasshere" whitelist="127.0.0.*,10.*">
832
833 # Deny all connections to all but the main index page:
834 #
835 # <httpdacl path="/*" types="blacklist" blacklist="*">
836 #
837
838 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
839 # http config module: Allows the server's configuration to be viewed
840 # over HTTP. Requires m_httpd.so to be loaded for it to function.
841 #<module name="m_httpd_config.so">
842
843 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
844 # http stats module: Provides basic stats pages over HTTP
845 # Requires m_httpd.so to be loaded for it to function.
846 #<module name="m_httpd_stats.so">
847
848 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
849 # Ident: Provides RFC 1413 ident lookup support
850 # When this module is loaded <connect:allow> tags may have an optional
851 # useident="yes|no" boolean value, determining whether or not to lookup
852 # ident on users matching that connect tag.
853 #<module name="m_ident.so">
854 #
855 #-#-#-#-#-#-#-#-#-#-#-#-   IDENT CONFIGURATION   -#-#-#-#-#-#-#-#-#-#-#
856 #                                                                     #
857 # Optional - If you are using the m_ident.so module, then you can     #
858 # specify the timeout for ident lookups here. If not defined, it will #
859 # default to one second. This is a non-blocking timeout which holds   #
860 # the user in a 'connecting' state until the lookup is complete.      #
861 # The bind value indicates which IP to bind outbound requests to.     #
862 #                                                                     #
863 #<ident timeout="5">
864
865 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
866 # Invite except module: Adds support for channel invite exceptions (+I)
867 #<module name="m_inviteexception.so">
868
869 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
870 # Invisible module - Adds support for usermode +Q (quiet) which lets an
871 # oper go 'invisible' similar to unrealircd 3.1's +I mode. Note that
872 # opers are still able to see invisible users, and if an oper with +Q
873 # deopers, they will become visible. 
874 #
875 # This module is oper-only.
876 #
877 #<module name="m_invisible.so">
878
879 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
880 # Join flood module: Adds support for join flood protection (+j)
881 #<module name="m_joinflood.so">
882
883 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
884 # Jump Server module: Adds support for the RPL_REDIR numeric
885 # This module is oper-only.
886 # To use, JUMPSERVER must be in one of your oper class blocks.
887 #<module name="m_jumpserver.so">
888
889 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
890 # Anti-Auto-Rejoin: Adds support for prevention of auto-rejoin (+J)
891 #<module name="m_kicknorejoin.so">
892
893 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
894 # Knock module: adds the /KNOCK command and +K channel mode
895 #<module name="m_knock.so">
896
897 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
898 # LDAP authentication module: Adds the ability to authenticate users  #
899 # via LDAP. This is an extra module which must be enabled explicitly  #
900 # by symlinking it from modules/extra, and requires the OpenLDAP libs #
901 # This modules is in extras. Re-run configure with: ./configure --enable-extras=m_ldapauth.cpp
902 # and run make install, then uncomment this module to enable it.      #
903 #                                                                     #
904 #<module name="m_ldapauth.so">                                        #
905 #                                                                     #
906 # Configuration:                                                      #
907 #                                                                     #
908 # <ldapauth baserdn="ou=People,dc=brainbox,dc=cc"                     #
909 #           attribute="uid"                                           #
910 #           server="ldap://brainwave.brainbox.cc"                     #
911 #           allowpattern="Guest*"                                     #
912 #           killreason="Access denied"                                #
913 #           searchscope="subtree"                                     #
914 #           binddn="cn=Manager,dc=brainbox,dc=cc"                     #
915 #           bindauth="mysecretpass"                                   #
916 #           verbose="yes">                                            #
917 #                                                                     #
918 # The baserdn indicates the base DN to search in for users. Usually   #
919 # this is 'ou=People,dc=yourdomain,dc=yourtld'.                       #
920 #                                                                     #
921 # The attribute value indicates the attribute which is used to locate #
922 # a user account by name. On POSIX systems this is usually 'uid'.     #
923 #                                                                     #
924 # The server parameter indicates the LDAP server to connect to. The   #
925 # ldap:// style scheme before the hostname proper is MANDITORY.       #
926 #                                                                     #
927 # The allowpattern value allows you to specify a wildcard mask which  #
928 # will always be allowed to connect regardless of if they have an     #
929 # account, for example guest users.                                   #
930 #                                                                     #
931 # Killreason indicates the QUIT reason to give to users if they fail  #
932 # to authenticate.                                                    #
933 #                                                                     #
934 # The searchscope value indicates the subtree to search under. On our #
935 # test system this is 'subtree'. Your mileage may vary.               #
936 #                                                                     #
937 # Setting the verbose value causes an oper notice to be sent out for  #
938 # every failed authentication to the server, with an error string.    #
939 #                                                                     #
940 # The binddn and bindauth indicate the DN to bind to for searching,   #
941 # and the password for the distinguished name. Some LDAP servers will #
942 # allow anonymous searching in which case these two values do not     #
943 # need defining, otherwise they should be set similar to the examples #
944 # above.                                                              #
945
946 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
947 # LDAP oper configuration module: Adds the ability to authenticate    #
948 # opers via LDAP. This is an extra module which must be enabled       #
949 # explicitly by symlinking it from modules/extra, and requires the    #
950 # OpenLDAP libs. Re-run configure with: ./configure --enable-extras=m_ldapoper.cpp
951 # and run make install, then uncomment this module to enable it.      #
952 #                                                                     #
953 #<module name="m_ldapoper.so">
954 #                                                                     #
955 # Configuration:                                                      #
956 #                                                                     #
957 # <ldapoper baserdn="ou=People,dc=brainbox,dc=cc"
958 #           server="ldap://brainwave.brainbox.cc"
959 #           searchscope="subtree"
960 #           binddn="cn=Manager,dc=brainbox,dc=cc"
961 #           bindauth="mysecretpass">
962 #                                                                     #
963 # Available configuration items are identical to the same items in    #
964 # m_ldapauth above.                                                   #
965
966 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
967 # Lock server module: Adds /LOCKSERV and /UNLOCKSERV commands that is #
968 # used to temporarily close/open for new connections to the server.   #
969 # These commands require OPER status and that the LOCKSERV UNLOCKSERV #
970 # are specified in a <class> tag that the oper is part of. This is so #
971 # you can control who has access to this possible dangerous command.  #
972 # If your server is locked and you got disconnected, do a REHASH from #
973 # shell to open up again.
974 #
975 # This module is oper-only.
976 #
977 #<module name="m_lockserv.so">
978
979 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
980 # Map hiding module: replaces /MAP and /LINKS output to users with a  #
981 # message to see a website, set by maphide="http://link.to/site" in   #
982 # the security tag, instead.                                          #
983 #<module name="m_maphide.so">
984
985 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
986 # Msg flood module: Adds message/notice flood protection (+f)
987 #<module name="m_messageflood.so">
988
989 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
990 # MsSQL module: Allows other SQL modules to access MS SQL Server 
991 # through a unified API. You must copy the source for this module
992 # from the directory src/modules/extra, plus the file m_sqlv2.h
993 # This modules is in extras. Re-run configure with: ./configure --enable-extras=m_mssql.cpp
994 # and run make install, then uncomment this module to enable it.
995 #
996 #<module name="m_mssql.so">
997 #
998 #-#-#-#-#-#-#-#-#-#-#-#- SQL CONFIGURATION   -#-#-#-#-#-#-#-#-#-#-#-#-#
999 #                                                                     #
1000 # m_mssql.so is more complex than described here, see wiki for more   #
1001 # info http://wiki.inspircd.org/Modules/mssql                         #
1002 #
1003 #<database name="db" username="user" password="pass" hostname="localhost" id="db1">
1004
1005 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1006 # MySQL module: Allows other SQL modules to access MySQL databases
1007 # through a unified API. You must copy the source for this module
1008 # from the directory src/modules/extra, plus the file m_sqlv2.h
1009 # This modules is in extras. Re-run configure with: ./configure --enable-extras=m_mysql.cpp
1010 # and run make install, then uncomment this module to enable it.
1011 #
1012 #<module name="m_mysql.so">
1013 #
1014 #-#-#-#-#-#-#-#-#-#-#-#- SQL CONFIGURATION   -#-#-#-#-#-#-#-#-#-#-#-#-#
1015 #                                                                     #
1016 # m_mysql.so is more complex than described here, see the wiki for    #
1017 # more: http://wiki.inspircd.org/Modules/mysql                        #
1018 #
1019 #<database name="mydb" username="myuser" password="mypass" hostname="localhost" id="my_database2">
1020
1021 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1022 # NAMESX module: Provides support for the NAMESX extension which allows
1023 # clients to see all the prefixes set on a user without getting confused.
1024 # This is supported by mIRC, x-chat, klient, and maybe more.
1025 #<module name="m_namesx.so">
1026
1027 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1028 # National characters module:
1029 # 1) Allows using national characters in nicknames.
1030 # 2) Allows using custom (national) casemapping over the network.
1031 # file -- filename of existing file in "locales" directory
1032 # casemapping -- custom value for 005 numeric (if you want it to be
1033 # different from the filename.
1034 #
1035 #<nationalchars file="bynets/russian-w1251-charlink" casemapping="ru_RU.cp1251-charlink">
1036 #<module name="m_nationalchars.so">
1037
1038 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1039 # Nickchange flood protection module: Allows up to X nick changes in Y seconds.
1040 # Provides channel mode +F.
1041 #<module name="m_nickflood.so">
1042
1043 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1044 # Nicklock module: Let opers change a user's nick and then stop that
1045 # user from changing their nick again.
1046 # This module is oper-only.
1047 # To use, NICKLOCK and NICKUNLOCK must be in one of your oper class blocks.
1048 #<module name="m_nicklock.so">
1049
1050 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1051 # No ctcp module: Adds the channel mode +C to block CTCPs and extban C
1052 # to block CTCPs sent by specific users.
1053 #<module name="m_noctcp.so">
1054
1055 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1056 # No kicks module: Adds the +Q channel mode and the Q: extban to deny
1057 # certain users from kicking.
1058 #<module name="m_nokicks.so">
1059
1060 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1061 # No nicks module: Adds the +N channel mode, as well as the +b N:
1062 # extended bantype. +N stops all users from changing their nick,
1063 # the +b N: extban stops anyone from matching a +b N:nick!user@host
1064 # mask from changing their nick.
1065 #<module name="m_nonicks.so">
1066
1067 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1068 # No part message module: adds extban 'p' to block part messages from #
1069 # matching users.                                                     #
1070 #<module name="m_nopartmsg.so">
1071
1072 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1073 # No Notice module: adds the channel mode +T and the extban T to block
1074 # specific users from noticing the channel.
1075 #<module name="m_nonotice.so">
1076
1077 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1078 # Oper channels mode: Adds the +O channel mode
1079 # This module is oper-only.
1080 #<module name="m_operchans.so">
1081
1082 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1083 # Oper invex/extban module: Adds +beI type O, to ban, exempt, and invex
1084 # given oper type masks.
1085 # e.g, /mode #channel +iI O:* is equivilant to chmode +O, but you
1086 # may also, e.g. /mode #channel +iI O:AdminTypeOnly to only allow admins.
1087 # +be work in a similar fashion.
1088 # This module is oper-only.
1089 #
1090 #<module name="m_operinvex.so">
1091
1092 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1093 # Oper Join module: Auto-joins opers to a channel upon oper-up
1094 # This module is oper-only. For the user equivalent, see m_conn_join.
1095 #<module name="m_operjoin.so">
1096 #
1097 #-#-#-#-#-#-#-#-#-#-#   OPERJOIN CONFIGURATION   -#-#-#-#-#-#-#-#-#-#-#
1098 #                                                                     #
1099 # If you are using the m_operjoin.so module, specify options here:    #
1100 #                                                                     #
1101 # channel     -      The channel name to join, can also be a comma    #
1102 #                    seperated list eg. "#channel1,#channel2".        #
1103 #                                                                     #
1104 # override    -      Lets the oper join walking thru any modes that   #
1105 #                    might be set, even bans. Use "yes" or "no".      #
1106 #                                                                     #
1107 #<operjoin channel="#channel" override="no">
1108 #
1109 # Alternatively you can use the autojoin="channellist" in a <type>    #
1110 # tag to set specific autojoins for a type of oper, for example:      #
1111 #
1112 #<type name="Helper" autojoin="#help" classes="...">
1113
1114 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1115 # Oper log module: Logs all oper commands to the ircd log at default
1116 # loglevel.
1117 # This module is oper-only.
1118 #<module name="m_operlog.so">
1119
1120 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1121 # Oper prefixing module: Gives IRC operators a prefix status character
1122 # on all channels they are in.
1123 #
1124 #<module name="m_operprefix.so">
1125 #
1126 # You may additionally customise the prefix character.
1127 #<operprefix prefix="!">
1128
1129 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1130 # Oper MOTD module: Provides support for seperate message of the day
1131 # on oper-up
1132 # This module is oper-only.
1133 #<module name="m_opermotd.so">
1134 #
1135 #-#-#-#-#-#-#-#-#-#-#   OPERMOTD CONFIGURATION   -#-#-#-#-#-#-#-#-#-#-#
1136 #                                                                     #
1137 # If you are using the m_opermotd.so module, specify the motd here    #
1138 #                                                                     #
1139 # onoper      -      Should the message be sent on /OPER or only when #
1140 #                    /OPERMOTD is used. Use "yes" or "no".            #
1141 #                                                                     #
1142 #<opermotd file="oper.motd" onoper="yes">
1143
1144 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1145 # Override module: Adds support for oper override
1146 # This module is oper-only.
1147 #<module name="m_override.so">
1148 #
1149 #-#-#-#-#-#-#-#-#-#-#   OVERRIDE CONFIGURATION   -#-#-#-#-#-#-#-#-#-#-#
1150 #                                                                     #
1151 # m_override.so is too complex it describe here, see the wiki:        #
1152 # http://wiki.inspircd.org/Modules/override                           #
1153
1154 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1155 # Oper levels module: Gives each oper a level and prevents
1156 # actions being taken against higher level opers
1157 # Specify the level as the 'level' parameter of the <type> tag
1158 # # This module is oper-only.
1159 #<module name="m_operlevels.so">
1160
1161 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1162 # Oper modes module: Allows you to specify modes to add/remove on oper
1163 # Specify the modes as the 'modes' parameter of the <type> tag
1164 # and/or as the 'modes' parameter of the <oper> tag.
1165 # This module is oper-only. For the user equivalent, see m_conn_umodes
1166 #<module name="m_opermodes.so">
1167
1168 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1169 # Oper password hash module: Allows hashed oper passwords
1170 # Relies on the module m_md5.so and/or m_sha256.so being loaded before
1171 # m_password_hash.so in the configuration file.
1172 # This module is oper-only.
1173 #<module name="m_password_hash.so">
1174 #
1175 #-#-#-#-#-#-#-#-#-#-# OPER HASH CONFIGURATION #-#-#-#-#-#-#-#-#-#-#-#-#
1176 #
1177 # To use this module, you must define a hash type for each oper's
1178 # password you want to hash. For example:
1179 #
1180 #     <oper name="Brain"
1181 #           host="ident@dialup15.isp.com"
1182 #           hash="sha256"
1183 #           password="a41d730937a53b79f788c0ab13e9e1d5"
1184 #           type="NetAdmin">
1185
1186 # The types of hashing available vary depending on which hashing modules
1187 # you load, but usually if you load m_sha256.so and m_md5.so, both md5
1188 # and sha256 type hashing will be available (the most secure of which
1189 # is SHA256).
1190
1191 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1192 # Permanent Channels module: Channels with the permanent channels mode
1193 # will remain open even after everyone else has left the channel, and
1194 # therefore keep things like modes, ban lists and topic. Permanent
1195 # channels -may- need support from your Services package to function
1196 # properly with them. This adds channel mode +P.
1197 # This module is oper-only.
1198 #<module name="m_permchannels.so">
1199 #
1200 # You may also create channels on startup by using the <permchannels> block.
1201 #<permchannels channel="#opers" modes="is" topic="Opers only.">
1202
1203 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1204 # PostgreSQL module: Allows other SQL modules to access PgSQL databases
1205 # through a unified API. You must copy the source for this module
1206 # from the directory src/modules/extra, plus the file m_sqlv2.h
1207 # This modules is in extras. Re-run configure with: ./configure --enable-extras=m_pgsql.cpp
1208 # and run make install, then uncomment this module to enable it.
1209 #
1210 #<module name="m_pgsql.so">
1211 #
1212 #-#-#-#-#-#-#-#-#-#-#-#- SQL CONFIGURATION   -#-#-#-#-#-#-#-#-#-#-#-#-#
1213 #                                                                     #
1214 # m_pgsql.so is more complex than described here, see the wiki for    #
1215 # more: http://wiki.inspircd.org/Modules/pgsql                        #
1216 #
1217 #<database name="mydb" username="myuser" password="mypass" hostname="localhost" id="my_database" ssl="no">
1218
1219 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1220 # Muteban: Implements extended ban m:, which stops anyone matching
1221 # a mask like +b m:nick!user@host from speaking on channel.
1222 #<module name="m_muteban.so">
1223 #
1224
1225 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1226 # Random Quote module: provides a random quote on connect.
1227 # NOTE: Some of these may mimic fatal errors and confuse users and 
1228 # opers alike! - BEWARE!
1229 #<module name="m_randquote.so">
1230 #
1231 #-#-#-#-#-#-#-#-#-#-  RANDOMQUOTES CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
1232 #                                                                     #
1233 # Optional - If you specify to use the m_randquote.so module, then    #
1234 # specify below the path to the randquotes.conf file.                 #
1235 #                                                                     #
1236 #<randquote file="randquotes.conf">
1237
1238 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1239 # Redirect module: Adds channel redirection (mode +L)
1240 #<module name="m_redirect.so">
1241
1242 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1243 # Regular Expression Provider for Glob or wildcard (?/*) matching.
1244 # You must have at least 1 provider loaded to use m_filter or m_rline
1245 # modules. This module has no additional requirements, as it uses the
1246 # matching already present in InspIRCd core.
1247 #<module name="m_regex_glob.so">
1248
1249 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1250 # Regular Expression Provider for PCRE (Perl-Compatible Regular
1251 # Expressions). You need libpcre installed to compile and load this
1252 # module. You must have at least 1 provider loaded to use m_filter or
1253 # m_rline.
1254 #<module name="m_regex_pcre.so">
1255
1256 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1257 # Regular Expression Provider for POSIX Regular Expressions.
1258 # You shouldn't need any additional libraries on a POSIX-compatible
1259 # system (ie: any Linux, BSD, but not Windows). You must have at least
1260 # 1 provider loaded to use m_filter or m_rline.
1261 # On POSIX-compliant systems, regex syntax can be found by using the
1262 # command: 'man 7 regex'.
1263 #<module name="m_regex_posix.so">
1264
1265 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1266 # Regular Expression Provider for TRE Regular Expressions.
1267 # This is the same regular expression engine used by UnrealIRCd, so
1268 # if you are most familiar with the syntax of /spamfilter from there,
1269 # this is the provider you want. You need libtre installed in order
1270 # to compile and load this module.
1271 #<module name="m_regex_tre.so">
1272
1273 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1274 # Registered users only channel creation
1275 # Allows only registered users and opers to create new channels.
1276 #<module name="m_regonlycreate.so">
1277
1278 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1279 # Remove module: Adds the /REMOVE command which is a peaceful
1280 # alternative to /KICK
1281 #<module name="m_remove.so">
1282
1283 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1284 # Restricted channels module: Allows only opers to create channels
1285 #<module name="m_restrictchans.so">
1286
1287 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1288 # Restrict message module: Allows users to only message opers
1289 #<module name="m_restrictmsg.so">
1290
1291 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1292 # Ban users through regular expression patterns
1293 #<module name="m_rline.so">
1294 #
1295 #-#-#-#-#-#-#-#-#-#-#-#- RLINE CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#-#
1296 #
1297 # If you wish to re-check a user when they change nickname (can be
1298 # useful under some situations, but *can* also use CPU with more users
1299 # on a server) then set the following configuration value:
1300 # Also, this is where you set what Regular Expression engine is to be
1301 # used. If you ever change it while running, all of your R-Lines will be
1302 # wiped. This is the regex engine used by all R-Lines set, and
1303 # m_regex_<engine>.so must be loaded, or rline will be nonfunctional
1304 # until you load it or change the engine to one that is loaded.
1305 #
1306 #<rline matchonnickchange="yes" engine="pcre">
1307 #
1308 # Generally, you will NOT want to use 'glob' here, as this turns
1309 # rline into just another gline. The exceptions are that rline will
1310 # always use the full nick!user@host realname string, rather than only
1311 # user@host, but beware that only the ? and * wildcards are available,
1312 # and are the only way to specify where the space can occur if you do
1313 # use glob. For this reason, is recommended to use a real regex engine
1314 # so that at least \s or [[:space:]] is available.
1315
1316 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1317 # JSON-RPC module: Encode and decode JSON-RPC requests for modules
1318 #<module name="m_rpc_json.so">
1319
1320 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1321 # RPC test module: A test of the RPC API
1322 #<module name="m_rpctest.so">
1323
1324 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1325 # Provide /LIST throttling (to prevent flooding) and /LIST safety to
1326 # prevent excess flood when the list is large.
1327 #<module name="m_safelist.so">
1328 #
1329 #-#-#-#-#-#-#-#-#-#-# SAFELIST CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#-#
1330 #
1331 # When using Safelist, you may set the following values;
1332 #
1333 # The first value, 'throttle', sets the amount of time in seconds a user
1334 # must wait between LIST commands. For example, if this is set to 60
1335 # (the default) then the user may not /LIST more than once a minute.
1336 # If not defined, the default value is 60 seconds.
1337 #
1338 # The second value, 'maxlisters', indicates the maximum number of users
1339 # which may be retrieving a LIST at once. It is not recommended you raise
1340 # this value, as increasing it too high can make your network vulnerable
1341 # to floodbots which waste your bandwidth and CPU time with LIST requests.
1342 #
1343 #<safelist throttle="60" maxlisters="50">
1344
1345 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1346 # SAJOIN module: Adds the /SAJOIN command
1347 # This module is oper-only.
1348 # To use, SAJOIN must be in one of your oper class blocks.
1349 #<module name="m_sajoin.so">
1350
1351 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1352 # SAKICK module: Adds the /SAKICK command
1353 # This module is oper-only.
1354 # To use, SAKICK must be in one of your oper class blocks.
1355 #<module name="m_sakick.so">
1356
1357 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1358 # SAMODE module: Adds the oper /SAMODE command
1359 # This module is oper-only.
1360 # To use, SAMODE must be in one of your oper class blocks.
1361 #<module name="m_samode.so">
1362
1363 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1364 # SANICK module: Allows opers to change user's nicks
1365 # This module is oper-only.
1366 # To use, SANICK must be in one of your oper class blocks.
1367 #<module name="m_sanick.so">
1368
1369 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1370 # SAPART module: Adds the oper /SAPART command
1371 # This module is oper-only.
1372 # To use, SAPART must be in one of your oper class blocks.
1373 #<module name="m_sapart.so">
1374
1375 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1376 # SAQUIT module: Adds the oper /SAQUIT command (abusable!!!)
1377 # This module is oper-only.
1378 # To use, SAQUIT must be in one of your oper class blocks.
1379 #<module name="m_saquit.so">
1380
1381 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1382 # SATOPIC module: Adds the oper /SATOPIC command
1383 # This module is oper-only.
1384 # To use, SATOPIC must be in one of your oper class blocks.
1385 #<module name="m_satopic.so">
1386
1387 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1388 # SASL authentication module: Provides support for IRC Authentication 
1389 # Layer (aka: atheme SASL) via AUTHENTICATE.
1390 #<module name="m_sasl.so">
1391
1392 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1393 # Secure list module: Prevent /LIST in the first minute of connection,
1394 # crippling most spambots and trojan spreader bots.
1395 #<module name="m_securelist.so">
1396 #
1397 #-#-#-#-#-#-#-#-#-# SECURELIST CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#-#
1398 #                                                                     #
1399 # Securelist can be harmful to some irc search engines such as        #
1400 # netsplit.de and searchirc.com. To prevent securelist blocking these #
1401 # sites from listing, define exception tags as shown below:           #
1402 <securehost exception="*@*.searchirc.org">
1403 <securehost exception="*@*.netsplit.de">
1404 <securehost exception="*@echo940.server4you.de">
1405 #                                                                     #
1406 # Define the following variable to change how long a user must wait   #
1407 # before issuing a LIST. If not defined, defaults to 60 seconds.      #
1408 #                                                                     #
1409 #<securelist waittime="60">                                           #
1410
1411 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1412 # Servprotect module: Provides support for Austhex style +k /
1413 # UnrealIRCD +S services mode
1414 #<module name="m_servprotect.so">
1415
1416 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1417 # See nicks module: Allow for SNOMASK +N which shows nick changes.
1418 # This module is oper-only.
1419 #<module name="m_seenicks.so">
1420
1421 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1422 # Set Idle module: Adds a command for opers to change their
1423 # idle time (mainly a toy)
1424 # This module is oper-only.
1425 # To use, SETIDLE must be in one of your oper class blocks.
1426 #<module name="m_setidle.so">
1427
1428 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1429 # Services support module: Adds several usermodes such as +R and +M
1430 # this module implements the 'identified' state via account names (AC)
1431 # and is similar in operation to the way asuka and ircu handle services.
1432 #
1433 # At the same time, this offers +r for users and channels to mark them
1434 # as identified seperately from the idea of a master account, which
1435 # can be useful for services which are heavily nick-as-account centric.
1436 #
1437 # This replaces m_services from 1.1 and earlier.
1438 #
1439 # Also of note is that this module implements two extbans:
1440 # +b R: (stop matching account names from joining)
1441 # +b M: (stop matching account names from speaking)
1442 #                                                                       
1443 #<module name="m_services_account.so">
1444
1445 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1446 # Sethost module: Adds the /SETHOST command
1447 # This module is oper-only.
1448 # To use, SETHOST must be in one of your oper class blocks.
1449 # See m_chghost for how to customise valid chars for hostnames
1450 #<module name="m_sethost.so">
1451
1452 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1453 # Setident module: Adds the /SETIDENT command
1454 # This module is oper-only.
1455 # To use, SETIDENT must be in one of your oper class blocks.
1456 #<module name="m_setident.so">
1457
1458 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1459 # SETNAME module: Adds the /SETNAME command
1460 # This module is oper-only.
1461 # To use, SETNAME must be in one of your oper class blocks.
1462 #<module name="m_setname.so">
1463
1464 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1465 # Serverban: Implements extended ban s:, which stops anyone connected
1466 # to a server matching a mask like +b s:server.mask.here from joining.
1467 #<module name="m_serverban.so">
1468
1469 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1470 # Show Whois module: Adds the +W usermode which allows opers
1471 # to see when they are whois'ed (can be annoying).
1472 # This module is oper-only.
1473 #<module name="m_showwhois.so">
1474 #
1475 # If you wish, you may also let users set this mode. Only opers with the
1476 # users/auspex priv will see real hosts of people, though. This setting
1477 # is not reloadable via /rehash, and will require /reloadmodule, as
1478 # it directly affects the mode object itself.
1479 #<showwhois opersonly="yes"
1480 #
1481 # You may also set whether or not users should recieve whois notices, should
1482 # they be /whois'd by an oper.
1483 # showfromopers="yes">
1484
1485 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1486 # Shun module: Provides the /shun command, which stops a user executing 
1487 # most commands.
1488 # This module is oper-only.
1489 # To use, SHUN must be in one of your oper class blocks.
1490 #<module name="m_shun.so">
1491 #
1492 # You may also configure which commands you wish a user to be able to
1493 # perform. It should be noted that if a shunned user issues QUIT or PART
1494 # then their message will be removed, as if they did not issue one.
1495 #
1496 # You can (optionally) let the user know that their command was blocked.
1497 #
1498 # You may also let SHUN affect opers (defaults to no).
1499 #<shun enabledcommands="PING PONG QUIT PART JOIN" notifyuser="yes" affectopers="no">
1500
1501 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1502 # Spy module: Provides the ability to see the complete names list of 
1503 # channels an oper is not a member of
1504 # This module is oper-only.
1505 #<module name="m_spy.so">
1506
1507 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1508 # SSL channel mode module: Adds support for SSL-only channels (+z).
1509 # does not do anything useful without a working SSL module (see below)
1510 #<module name="m_sslmodes.so">
1511
1512 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1513 # Dummy ssl module: If you have other servers on your network which
1514 # have SSL, but your server does not have ssl enabled, you should load
1515 # this module, which will handle SSL metadata (e.g. the "Is using ssl"
1516 # field in the WHOIS information).
1517 #<module name="m_ssl_dummy.so">
1518
1519 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1520 # GnuTLS ssl module: Adds support for client-server SSL using GnuTLS,
1521 # if enabled. You must copy the source for this module from the directory
1522 # src/modules/extra, or answer 'yes' in ./configure when asked if you
1523 # want to enable this, or it will not load.
1524 #<module name="m_ssl_gnutls.so">
1525 #
1526 #-#-#-#-#-#-#-#-#-#-#-  GNUTLS CONFIGURATION   -#-#-#-#-#-#-#-#-#-#-#-#
1527 #                                                                     #
1528 # m_ssl_gnutls.so is too complex it describe here, see the wiki:      #
1529 # http://wiki.inspircd.org/Modules/ssl_gnutls                         #
1530 #                                                                     #
1531 # NOTE: If you want to use this module to encrypt and sign your       #
1532 # server to server traffic, you MUST load it before m_spanningtree in #
1533 # your configuration file!                                            #
1534
1535 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1536 # SSL Info module: Allows users to retrieve information about other
1537 # user's peer SSL certificates and keys. This can be used by client
1538 # scripts to validate users. For this to work, one of m_ssl_gnutls.so
1539 # or m_ssl_openssl.so must be loaded. You must symlink the source for
1540 # this module from the directory src/modules/extra.
1541 # This modules is in extras. Re-run configure with: ./configure --enable-extras=m_sslinfo.cpp
1542 # and run make install, then uncomment this module to enable it.
1543 #
1544 #<module name="m_sslinfo.so">
1545
1546 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1547 # OpenSSL ssl module: Adds support for client-server SSL using OpenSSL,
1548 # if enabled. You must copy the source for this module from the directory
1549 # src/modules/extra, or answer 'yes' in ./configure when asked if you
1550 # want to enable this, or it will not load.
1551 #<module name="m_ssl_openssl.so">
1552 #
1553 #-#-#-#-#-#-#-#-#-#-#- OPENSSL CONFIGURATION   -#-#-#-#-#-#-#-#-#-#-#-#
1554 #                                                                     #
1555 # m_ssl_openssl.so is too complex it describe here, see the wiki:     #
1556 # http://wiki.inspircd.org/Modules/ssl_openssl                        #
1557 #                                                                     #
1558 # NOTE: If you want to use this module to encrypt and sign your       #
1559 # server to server traffic, you MUST load it before m_spanningtree in #
1560 # your configuration file!                                            #
1561
1562 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1563 # SSL Cert Oper module: Allows opers to oper up using the key fingerprint
1564 # stored within their SSL certificate and key pair.
1565 # When using this module, one of m_ssl_gnutls.so or m_ssl_openssl.so must
1566 # be loaded. An extra value should be added to enabled opers, which
1567 # is in the following format: fingerprint="<hash>". For more information,
1568 # see the example in the oper blocks.
1569 # This module is oper-only.
1570 #<module name="m_ssl_oper_cert.so">
1571
1572 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1573 # Strip colour module: Adds the channel mode +S
1574 #<module name="m_stripcolor.so">
1575
1576 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1577 # SILENCE module: Adds support for /SILENCE
1578 #<module name="m_silence.so">
1579 #
1580 # Configuration tags:
1581 #
1582 #<silence maxentries="32">
1583 #
1584 # Sets the maximum number of entries on a users silence list.
1585
1586 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1587 # SQLite3 module: Allows other SQL modules to access SQLite3          #
1588 # databases through a unified API. You must link the source for this  #
1589 # module from the directory src/modules/extra to src/modules, plus    #
1590 # the file m_sqlv2.h                                                  #
1591 # This modules is in extras. Re-run configure with: ./configure --enable-extras=m_aqlite.cpp
1592 # and run make install, then uncomment this module to enable it.      #
1593 #
1594 #<module name="m_sqlite3.so">
1595 #
1596 #-#-#-#-#-#-#-#-#-#-#-#- SQL CONFIGURATION   -#-#-#-#-#-#-#-#-#-#-#-#-#
1597 #                                                                     #
1598 # m_sqlite.so is more complex than described here, see the wiki for   #
1599 # more: http://wiki.inspircd.org/Modules/sqlite3                      #
1600 #
1601 #<database hostname="/full/path/to/database.db" id="anytext">
1602
1603 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1604 # SQLutils module: Provides some utilities to SQL client modules, such
1605 # as mapping queries to users and channels. You must copy the source
1606 # for this module from the directory src/modules/extra/m_sqlutils.cpp
1607 # and src/modules/extra/m_sqlutils.h into /src/modules
1608 # Needed for, and loaded before: SQLauth and SQLoper
1609 # This modules is in extras. Re-run configure with: ./configure --enable-extras=m_sqlutils.cpp
1610 # and run make install, then uncomment this module to enable it.
1611 #
1612 #<module name="m_sqlutils.so">
1613
1614 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1615 # SQL authentication module: Allows IRCd connections to be tied into
1616 # a database table (for example a forum). You must copy the source for
1617 # this module from the directory src/modules/extra
1618 # Depends on the SQLutils module being loaded first.
1619 # This modules is in extras. Re-run configure with: ./configure --enable-extras=m_sqlauth.cpp
1620 # and run make install, then uncomment this module to enable it.
1621 #
1622 #<module name="m_sqlauth.so">
1623 #
1624 #-#-#-#-#-#-#-#-#-#-#- SQLAUTH CONFIGURATION   -#-#-#-#-#-#-#-#-#-#-#-#
1625 #                                                                     #
1626 # m_sqlauth.so is too complex it describe here, see the wiki:         #
1627 # http://wiki.inspircd.org/Modules/sqlauth                            #
1628
1629 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1630 # SQL logging module: Allows you to log network-wide data for your
1631 # network in a fully normalised set of SQL tables. You must copy the
1632 # source for this module from the directory src/modules/extra
1633 # This modules is in extras. Re-run configure with: ./configure --enable-extras=m_sqllog.cpp
1634 # and run make install, then uncomment this module to enable it.
1635 #
1636 #<module name="m_sqllog.so">
1637 #
1638 #-#-#-#-#-#-#-#-#-#-#-  SQLLOG CONFIGURATION   -#-#-#-#-#-#-#-#-#-#-#-#
1639 #                                                                     #
1640 # dbid       - Database ID to use (see m_sql)                         #
1641 #                                                                     #
1642 # See also: http://wiki.inspircd.org/Modules/sqllog                   #
1643 #                                                                     #
1644 #<sqllog dbid="1">
1645
1646 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1647 # SQL oper module: Allows you to store oper credentials in an SQL table
1648 # You must copy the source for this module from the directory src/modules/extra
1649 # Depends on the SQLutils module being loaded first.
1650 # This modules is in extras. Re-run configure with: ./configure --enable-extras=m_sqloper.cpp
1651 # and run make install, then uncomment this module to enable it.
1652 #
1653 #<module name="m_sqloper.so">
1654 #
1655 #-#-#-#-#-#-#-#-#-#-#- SQLOPER CONFIGURATION   -#-#-#-#-#-#-#-#-#-#-#-#
1656 #                                                                     #
1657 # dbid       - Database ID to use (see m_sql)                         #
1658 # hash       - Hashing provider to use for password hashing           #
1659 #                                                                     #
1660 # See also: http://wiki.inspircd.org/Modules/sqloper                  #
1661 #                                                                     #
1662 #<sqloper dbid="1" hash="md5">
1663
1664 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1665 # SVSHold module: Implements SVSHOLD. Like Q:Lines, but can only be   #
1666 # added/removed by Services.                                          #
1667 #<module name="m_svshold.so">
1668
1669 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1670 # SWHOIS module: Allows you to add arbitary lines to user WHOIS.
1671 # This module is oper-only.
1672 # To use, SWHOIS must be in one of your oper class blocks.
1673 #<module name="m_swhois.so">
1674
1675 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1676 # Taxonomy module: Adds the /TAXONOMY command, used to view all
1677 #                  metadata attached to a user.
1678 # This module is oper-only.
1679 # To use, TAXONOMY must be in one of your oper class blocks.
1680 #<module name="m_taxonomy.so">
1681
1682 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1683 # Test command module: Does nothing significant. Read: pointless.
1684 #<module name="m_testcommand.so">
1685
1686 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1687 # Timed bans module: Adds timed channel bans and the /TBAN command
1688 #<module name="m_timedbans.so">
1689
1690 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1691 # Test line module: Adds the /TLINE command, used to test how many
1692 # users a /GLINE or /ZLINE etc would match.
1693 # This module is oper-only.
1694 # To use, TLINE must be in one of your oper class blocks.
1695 #<module name="m_tline.so">
1696
1697 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1698 # UHNAMES support module: Adds support for the IRCX style UHNAMES
1699 # extension, which displays ident and hostname in the names list for
1700 # each user, saving clients from doing a WHO on the channel. Note that
1701 # this module is not widely supported yet. If a client does not support
1702 # UHNAMES it will not enable it, this will not break incompatible
1703 # clients.
1704 #<module name="m_uhnames.so">
1705
1706 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1707 # Uninvite module: Adds the /UNINVITE command which lets users remove
1708 # pending invites from channels without waiting for the user to join.
1709 #<module name="m_uninvite.so">
1710
1711 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1712 # Userip module: Adds the /USERIP command
1713 # This module is oper-only.
1714 # To use, USERIP must be in one of your oper class blocks.
1715 #<module name="m_userip.so">
1716
1717 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1718 # Vhost module: Adds the VHOST command which allows for adding virtual
1719 # hosts which are accessible using a username and password in the config.
1720 #<module name="m_vhost.so">
1721 #
1722 #-#-#-#-#-#-#-#-#-#-#- VHOST CONFIGURATION   -#-#-#-#-#-#-#-#-#-#-#-#-#
1723 #                                                                     #
1724 # user       - Username for the vhost.                                #
1725 #                                                                     #
1726 # pass       - Password for the vhost.                                #
1727 #                                                                     #
1728 # hash       - The hash for the specific user (optional)
1729 #              m_password_hash.so and a hashing module must be loaded for this to work
1730 #                                                                     #
1731 # host       - Vhost to set.                                          #
1732 #
1733 #<vhost user="some_username" pass="some_password" host="some.host">
1734 #<vhost user="foo" password="fcde2b2edba56bf408601fb721fe9b5c338d10ee429ea04fae5511b68fbf8fb9" hash="sha256" host="some.other.host">
1735
1736 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1737 # Watch module: Adds the WATCH command, which is used by clients to 
1738 # maintain notify lists.
1739 #<module name="m_watch.so">
1740 #
1741 # Configuration tags:
1742 #
1743 #<watch maxentries="32">
1744 #
1745 # Sets the maximum number of entries on a user's watch list.
1746
1747 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1748 # XLine database: Stores all *Lines (G/Z/K/R/any added by other modules)
1749 # in a file "xline.db" which can be re-loaded on restart. This is useful
1750 # for two reasons: it keeps bans so users may not evade them, and on
1751 # bigger networks, server connections will take less time as there will
1752 # be a lot less bans to apply - as most of them will already be there.
1753 #<module name="m_xline_db.so">
1754
1755 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1756 # ZipLinks module: Adds support for zlib deflate on server to server
1757 # connections. Both ends of the connection must load this module.
1758 # This modules is in extras. Re-run configure with: ./configure --enable-extras=m_ziplink.cpp
1759 # and run make install, then uncomment this module to enable it.
1760 #
1761 #<module name="m_ziplink.so">
1762 #
1763 # To use this module, you must enable it as a transport type in your
1764 # <link> tags or <bind> tags using the transport name 'zip'.
1765 # See the documentation of <link> and <bind>, respectively.
1766 #
1767
1768
1769 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1770 #    ____                _   _____ _     _       ____  _ _   _        #
1771 #   |  _ \ ___  __ _  __| | |_   _| |__ (_)___  | __ )(_) |_| |       #
1772 #   | |_) / _ \/ _` |/ _` |   | | | '_ \| / __| |  _ \| | __| |       #
1773 #   |  _ <  __/ (_| | (_| |   | | | | | | \__ \ | |_) | | |_|_|       #
1774 #   |_| \_\___|\__,_|\__,_|   |_| |_| |_|_|___/ |____/|_|\__(_)       #
1775 #                                                                     #
1776 # To link servers to InspIRCd, you MUST load the m_spanningtree       #
1777 # module. Since several features (like SSL server links) rely on      #
1778 # other modules being loaded before m_spanningtree, the module itself #
1779 # is at the bottom of this file. DO NOT forget to load it. If you DO  #
1780 # NOT do this, server links will NOT work at all. ie. The ports will  #
1781 # NOT bind, and /connect will not work properly. This is by design,   #
1782 # to allow for the implementation of other linking protocols in       #
1783 # modules in the future.                                              #
1784 #                                                                     #
1785
1786 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1787 # Spanning Tree module - allows linking of servers using the spanning
1788 # tree protocol (see the READ THIS BIT section above).
1789 # You will almost always want to load this.
1790 #
1791 #<module name="m_spanningtree.so">
1792
1793