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