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