]> git.netwichtig.de Git - user/henk/code/inspircd.git/blob - docs/modules.conf.example
Update example config for passforward and RPC module changes [jdhore]
[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 title module: Adds the /TITLE command which allows for trusted
636 #                      users to gain a custom whois line and a optional
637 #                      vhost can be specified.
638 #<module name="m_customtitle.so">
639 #
640 #-#-#-#-#-#-#-#-#-#-  CUSTOM TITLE CONFIGURATION   -#-#-#-#-#-#-#-#-#-#
641 #  name              - The username used to identify 
642 #  password          - The password used to identify
643 #  hash              - The hash for the specific user's password (optional)
644 #                      m_password_hash.so and a hashing module must be loaded for this to work
645 #  host              - Allowed hostmask [optional]
646 #  title             - Title shown in whois
647 #  vhost             - Displayed host [optional]
648 #
649 #<title name="foo" password="bar" title="Official Chat Helper">
650 #<title name="bar" password="foo" host="ident@host.name" title="Official Chat Helper" vhost="helper.network.chat">
651 #<title name="foo" password="fcde2b2edba56bf408601fb721fe9b5c338d10ee429ea04fae5511b68fbf8fb9" hash="sha256" title="Official Chat Helper">
652
653 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
654 # DCCALLOW module: Adds the /DCCALLOW command
655 #<module name="m_dccallow.so">
656 #
657 #-#-#-#-#-#-#-#-#-#-#-  DCCALLOW CONFIGURATION   -#-#-#-#-#-#-#-#-#-#-#
658 #  blockchat         - Whether to block DCC CHAT as well as DCC SEND
659 #  length            - Default duration of entries in DCCALLOW list
660 #  action            - Default action to take if no action is specified
661 #                      can be 'block' or 'allow'
662 #
663 # File configuration:
664 #  pattern           - The glob pattern to match against
665 #  action            - Action to take if a user attempts to send a file
666 #                      that matches this pattern, can be 'block' or 'allow'
667 #
668 #<dccallow blockchat="yes" length="5m" action="block">
669 #<banfile pattern="*.exe" action="block">
670 #<banfile pattern="*.txt" action="allow">
671 #
672 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
673
674 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
675 # Deaf module: adds support for ircu style usermode +d - deaf to
676 # channel messages and channel notices.
677 #<module name="m_deaf.so">
678
679 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
680 # Delay join module: Adds the channel mode +D which delays all JOIN
681 # messages from users until they speak. If they quit or part before
682 # speaking, their quit or part message will not be shown to the channel
683 # which helps cut down noise on large channels in a more friendly way
684 # than the auditorium mode. Only channel ops may set the +D mode.
685 #<module name="m_delayjoin.so">
686
687 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
688 # Delay message module: Adds the channel mode +d which disallows a user
689 # from talking in the channel unless they've been joined for X seconds.
690 # Settable a la: /mode +d 30
691 #<module name="m_delaymsg.so">
692
693 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
694 # Deny Channels: Deny Channels from being used by users
695 #<module name="m_denychans.so"> 
696 #
697 #-#-#-#-#-#-#-#-#-#-#-   DENYCHAN DEFINITIONS  -#-#-#-#-#-#-#-#-#-#-#-#
698 #                                                                     #
699 # If you have the m_denychans.so module loaded, you need to specify   #
700 # the channels to deny:                                               #
701 #                                                                     #
702 # name        -      The channel name to deny. (glob masks are ok)    #
703 #                                                                     #
704 # allowopers  -      If operators are allowed to override the deny.   #
705 #                                                                     #
706 # reason      -      Reason given for the deny.                       #
707 #                                                                     #
708 # redirect    -      Redirect the user to a different channel         #
709 #                                                                     #
710 #<badchan name="#gods*" allowopers="yes" reason="Tortoises!">         #
711 #<badchan name="#heaven" redirect="#hell" reason="Nice try!">         #
712 #                                                                     #
713 # Redirects will not work if the target channel is set +L.            #
714 #                                                                     #
715 # Additionally, you may specify channels which are allowed, even if   #
716 # a badchan tag specifies it would be denied:                         #
717 #<goodchan name="#godsleeps">                                         #
718 # Glob masks are accepted here also.
719
720 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
721 # Devoice Module: Let users devoice themselves.
722 #<module name="m_devoice.so">
723
724 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
725 # DNS Blacklist Module: Provides support for looking up IPs on one or #
726 # more blacklists.                                                    #
727 #<module name="m_dnsbl.so">                                           #
728 #                                                                     #
729 # For configuration options please see the wiki page for m_dnsbl at   #
730 # http://wiki.inspircd.org/Modules/dnsbl                              #
731
732 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
733 # Exempt Channel Operators Module: Provides support for allowing      #
734 # channel operators to be exempt from some channel modes.  Supported  #
735 # modes are blockcaps, noctcp, blockcolor, nickflood, flood, censor,  #
736 # filter, regmoderated, nonick, nonotice, and stripcolor.             #
737 #<module name="m_exemptchanops.so">                                   #
738 #                                                                     #
739 #-#-#-#-#-#-#-#-#-#-  EXEMPTCHANOPS CONFIGURATION  -#-#-#-#-#-#-#-#-#-#
740 #  alwaysexempt      - Modes channel operators are always exempt from,
741 #                      regardless of channel setting.
742 #  neverexempt       - Modes channel operators are never exempt from,
743 #                      regardless of channel setting.
744 #<exemptchanops alwaysexempt="nickflood censor flood filter" neverexempt="regmoderated">
745
746
747 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
748 # Filter module: Provides message filtering, similar to SPAMFILTER.
749 #<module name="m_filter.so">
750 #                                                                     #
751 # This module depends upon a regex provider such as m_regex_pcre or   #
752 # m_regex_glob to function. You must specify which of these you want  #
753 # m_filter to use via the tag below.                                  #
754 #                                                                     #
755 # Valid engines are:                                                  #
756 #                                                                     #
757 # glob  - Glob patterns, provided via m_regex_glob.so                 #
758 # pcre  - PCRE regexps, provided via m_regex_pcre.so, needs libpcre   #
759 # tre   - TRE regexps, provided via m_regex_tre.so, requires libtre   #
760 # posix - POSIX regexps, provided via m_regex_posix.so, not availale  #
761 #         on windows, no dependencies on other operating systems.     #
762 #                                                                     #
763 #<filteropts engine="glob">                                           #
764 #                                                                     #
765 # Your choice of regex engine must match on all servers network-wide.
766 #
767 # You may specify specific channels that are exempt from being filtered:
768 #<exemptfromfilter channel="#blah">
769 #
770 #-#-#-#-#-#-#-#-#-#-#-  FILTER  CONFIGURATION  -#-#-#-#-#-#-#-#-#-#-#-#
771 #                                                                     #
772 # Optional - If you specify to use the m_filter module, then          #
773 # specfiy below the path to the filter.conf file, or define some      #
774 # <filter> tags.                                                      #
775 #                                                                     #
776 #<include file="filter.conf">
777
778 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
779 # Gecosban: Implements extended ban r:, which stops anyone matching
780 # a mask like +b r:*realname?here* from joining a channel.
781 #<module name="m_gecosban.so">
782
783 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
784 # GeoIP module: Allows the server admin to ban users by country code.
785 # This modules is in extras. Re-run configure with: ./configure --enable-extras=m_geoip.cpp
786 # and run make install, then uncomment this module to enable it.
787 # This module requires GeoIP to be installed on your system,
788 # use your package manager to find the appropriate packages
789 # or check the InspIRCd wiki page for this module.
790 #<module name="m_geoip.so">
791 #
792 #-#-#-#-#-#-#-#-#-#-#-#  GEOIP CONFIGURATION  #-#-#-#-#-#-#-#-#-#-#-#-#
793 #                                                                     #
794 # <geoip banunknown="false">                                          #
795 #                                                                     #
796 # Set this value to true or yes to block unknown IP ranges which are  #
797 # not in the database (usually LAN addresses, localhost, etc)         #
798 #                                                                     #
799 # <geoban country="TR" reason="This country not permitted">           #
800 #                                                                     #
801 # Use one or more of these tags to ban countries by country code.     #
802 # The country code must be in capitals and should be an ISO country   #
803 # code such as TR, GB, or US.                                         #
804
805 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
806 # Globops module: gives /GLOBOPS and SNOMASK +g
807 # This module is oper-only.
808 # To use, GLOBOPS must be in one of your oper class blocks.
809 #<module name="m_globops.so">
810
811 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
812 # Global load module: Allows loading and unloading of modules network-
813 # wide (USE WITH EXTREME CAUTION!)
814 # This module is oper-only and provides /gloadmodule, /gunloadmodule
815 # and /greloadmodule.
816 # To use, GLOADMODULE, GUNLOADMODULE and GRELOADMODULE
817 # must be in one of your oper class blocks.
818 #<module name="m_globalload.so">
819
820 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
821 # Halfop module: Provides the +h (halfops) channel status mode.
822 #<module name="m_halfop.so">
823
824 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
825 # HELPOP module: Provides the /HELPOP command
826 #<module name="m_helpop.so">
827 #
828 #-#-#-#-#-#-#-#-#-#-#-#-  HELPOP  CONFIGURATION  -#-#-#-#-#-#-#-#-#-#-#
829 #                                                                     #
830 # Optional - If you specify to use the m_helpop.so module, then       #
831 # specify below the path to the helpop.conf file, or if you like to   #
832 # make a mess, define your helpop tags in this conf.                  #
833 #                                                                     #
834 #<include file="helpop.conf">
835
836 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
837 # HIDECHANS module: Allows opers to hide their channels list from non-
838 # opers by setting user mode +I on themselves.
839 # <module name="m_hidechans.so">
840 #
841 # HIDECHANS can optionally prevent opers from seeing channels on a +I
842 # user, for more privacy if set to true.
843 # This setting is not recommended for most mainstream networks.
844 #<hidechans affectsopers="false">
845
846 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
847 # HIDEOPER module: Allows opers to hide their oper status from non-
848 # opers by setting user mode +H on themselves.
849 # This module is oper-only.
850 # <module name="m_hideoper.so">
851
852 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
853 # Hostchange module: Allows a different style of cloaking
854 #<module name="m_hostchange.so">
855 #
856 #-#-#-#-#-#-#-#-#-#-#-  HOSTCHANGE  CONFIGURATION  -#-#-#-#-#-#-#-#-#-#
857 #                                                                     #
858 # Optional - If you choose to use the m_hostchange.so module.         #
859 # Config Help -  See http://wiki.inspircd.org/Modules/hostchange      #
860 #                                                                     #
861 #<host suffix="polarbears.org" separator="." prefix="">
862 #<hostchange mask="*@fbi.gov" action="addnick">
863 #<hostchange mask="*r00t@*" action="suffix">
864 #<hostchange mask="a@b.com" action="set" value="blah.blah.blah">
865 #<hostchange mask="localhost" ports="7000,7001,7005-7007" action="set" value="blahblah.foo">
866
867 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
868 # httpd module: Provides http server support for InspIRCd
869 #<module name="m_httpd.so">
870 #
871 #-#-#-#-#-#-#-#-#-#-#-#-  HTTPD   CONFIGURATION  -#-#-#-#-#-#-#-#-#-#-#
872 #
873 # If you choose to use the m_httpd.so module, then you will need to add
874 # a <bind> tag with type "httpd", and load at least one of the other
875 # m_httpd_* modules to provide pages to display.
876 #
877
878 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
879 # http ACL module: Provides access control lists for m_httpd dependent
880 # modules. Use this module to restrict pages by IP address and by
881 # password.
882 #
883 #<module name="m_httpd_acl.so">
884 #
885 #-#-#-#-#-#-#-#-#-#-#-#- HTTPD ACL CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
886 #
887 # Restrict access to the m_httpd_stats module to all but the local
888 # network and when the correct password is specified:
889 #
890 # <httpdacl path="/stats*" types="password,whitelist"
891 #    username="secretstuff" password="mypasshere" whitelist="127.0.0.*,10.*">
892
893 # Deny all connections to all but the main index page:
894 #
895 # <httpdacl path="/*" types="blacklist" blacklist="*">
896 #
897
898 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
899 # http config module: Allows the server's configuration to be viewed
900 # over HTTP. Requires m_httpd.so to be loaded for it to function.
901 #<module name="m_httpd_config.so">
902
903 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
904 # http stats module: Provides basic stats pages over HTTP
905 # Requires m_httpd.so to be loaded for it to function.
906 #<module name="m_httpd_stats.so">
907
908 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
909 # Ident: Provides RFC 1413 ident lookup support
910 # When this module is loaded <connect:allow> tags may have an optional
911 # useident="yes|no" boolean value, determining whether or not to lookup
912 # ident on users matching that connect tag.
913 #<module name="m_ident.so">
914 #
915 #-#-#-#-#-#-#-#-#-#-#-#-   IDENT CONFIGURATION   -#-#-#-#-#-#-#-#-#-#-#
916 #                                                                     #
917 # Optional - If you are using the m_ident.so module, then you can     #
918 # specify the timeout for ident lookups here. If not defined, it will #
919 # default to one second. This is a non-blocking timeout which holds   #
920 # the user in a 'connecting' state until the lookup is complete.      #
921 # The bind value indicates which IP to bind outbound requests to.     #
922 #                                                                     #
923 #<ident timeout="5">
924
925 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
926 # Invite except module: Adds support for channel invite exceptions (+I)
927 #<module name="m_inviteexception.so">
928
929 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
930 # Invisible module - Adds support for usermode +Q (quiet) which lets an
931 # oper go 'invisible' similar to unrealircd 3.1's +I mode. Note that
932 # opers are still able to see invisible users, and if an oper with +Q
933 # deopers, they will become visible. 
934 #
935 # This module is oper-only and seen by many to be quite abusive.
936 #
937 #<module name="m_invisible.so">
938
939 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
940 # Join flood module: Adds support for join flood protection (+j)
941 #<module name="m_joinflood.so">
942
943 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
944 # Jump Server module: Adds support for the RPL_REDIR numeric
945 # This module is oper-only.
946 # To use, JUMPSERVER must be in one of your oper class blocks.
947 #<module name="m_jumpserver.so">
948
949 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
950 # Anti-Auto-Rejoin: Adds support for prevention of auto-rejoin (+J)
951 #<module name="m_kicknorejoin.so">
952
953 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
954 # Knock module: adds the /KNOCK command and +K channel mode
955 #<module name="m_knock.so">
956
957 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
958 # LDAP authentication module: Adds the ability to authenticate users  #
959 # via LDAP. This is an extra module which must be enabled explicitly  #
960 # by symlinking it from modules/extra, and requires the OpenLDAP libs #
961 # This modules is in extras. Re-run configure with: ./configure --enable-extras=m_ldapauth.cpp
962 # and run make install, then uncomment this module to enable it.      #
963 #                                                                     #
964 #<module name="m_ldapauth.so">                                        #
965 #                                                                     #
966 # Configuration:                                                      #
967 #                                                                     #
968 # <ldapauth baserdn="ou=People,dc=brainbox,dc=cc"                     #
969 #           attribute="uid"                                           #
970 #           server="ldap://brainwave.brainbox.cc"                     #
971 #           allowpattern="Guest*"                                     #
972 #           killreason="Access denied"                                #
973 #           searchscope="subtree"                                     #
974 #           binddn="cn=Manager,dc=brainbox,dc=cc"                     #
975 #           bindauth="mysecretpass"                                   #
976 #           verbose="yes">                                            #
977 #                                                                     #
978 # The baserdn indicates the base DN to search in for users. Usually   #
979 # this is 'ou=People,dc=yourdomain,dc=yourtld'.                       #
980 #                                                                     #
981 # The attribute value indicates the attribute which is used to locate #
982 # a user account by name. On POSIX systems this is usually 'uid'.     #
983 #                                                                     #
984 # The server parameter indicates the LDAP server to connect to. The   #
985 # ldap:// style scheme before the hostname proper is MANDITORY.       #
986 #                                                                     #
987 # The allowpattern value allows you to specify a wildcard mask which  #
988 # will always be allowed to connect regardless of if they have an     #
989 # account, for example guest users.                                   #
990 #                                                                     #
991 # Killreason indicates the QUIT reason to give to users if they fail  #
992 # to authenticate.                                                    #
993 #                                                                     #
994 # The searchscope value indicates the subtree to search under. On our #
995 # test system this is 'subtree'. Your mileage may vary.               #
996 #                                                                     #
997 # Setting the verbose value causes an oper notice to be sent out for  #
998 # every failed authentication to the server, with an error string.    #
999 #                                                                     #
1000 # The binddn and bindauth indicate the DN to bind to for searching,   #
1001 # and the password for the distinguished name. Some LDAP servers will #
1002 # allow anonymous searching in which case these two values do not     #
1003 # need defining, otherwise they should be set similar to the examples #
1004 # above.                                                              #
1005
1006 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1007 # LDAP oper configuration module: Adds the ability to authenticate    #
1008 # opers via LDAP. This is an extra module which must be enabled       #
1009 # explicitly by symlinking it from modules/extra, and requires the    #
1010 # OpenLDAP libs. Re-run configure with: ./configure --enable-extras=m_ldapoper.cpp
1011 # and run make install, then uncomment this module to enable it.      #
1012 #                                                                     #
1013 #<module name="m_ldapoper.so">
1014 #                                                                     #
1015 # Configuration:                                                      #
1016 #                                                                     #
1017 # <ldapoper baserdn="ou=People,dc=brainbox,dc=cc"
1018 #           server="ldap://brainwave.brainbox.cc"
1019 #           searchscope="subtree"
1020 #           binddn="cn=Manager,dc=brainbox,dc=cc"
1021 #           bindauth="mysecretpass">
1022 #                                                                     #
1023 # Available configuration items are identical to the same items in    #
1024 # m_ldapauth above.                                                   #
1025
1026 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1027 # Lock server module: Adds /LOCKSERV and /UNLOCKSERV commands that is #
1028 # used to temporarily close/open for new connections to the server.   #
1029 # These commands require OPER status and that the LOCKSERV UNLOCKSERV #
1030 # are specified in a <class> tag that the oper is part of. This is so #
1031 # you can control who has access to this possible dangerous command.  #
1032 # If your server is locked and you got disconnected, do a REHASH from #
1033 # shell to open up again.
1034 #
1035 # This module is oper-only.
1036 #
1037 #<module name="m_lockserv.so">
1038
1039 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1040 # Map hiding module: replaces /MAP and /LINKS output to users with a  #
1041 # message to see a website, set by maphide="http://link.to/site" in   #
1042 # the security tag, instead.                                          #
1043 #<module name="m_maphide.so">
1044
1045 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1046 # Msg flood module: Adds message/notice flood protection (+f)
1047 #<module name="m_messageflood.so">
1048
1049 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1050 # MsSQL module: Allows other SQL modules to access MS SQL Server 
1051 # through a unified API. You must copy the source for this module
1052 # from the directory src/modules/extra, plus the file m_sqlv2.h
1053 # This modules is in extras. Re-run configure with: ./configure --enable-extras=m_mssql.cpp
1054 # and run make install, then uncomment this module to enable it.
1055 #
1056 #<module name="m_mssql.so">
1057 #
1058 #-#-#-#-#-#-#-#-#-#-#-#- SQL CONFIGURATION   -#-#-#-#-#-#-#-#-#-#-#-#-#
1059 #                                                                     #
1060 # m_mssql.so is more complex than described here, see wiki for more   #
1061 # info http://wiki.inspircd.org/Modules/mssql                         #
1062 #
1063 #<database name="db" username="user" password="pass" hostname="localhost" id="db1">
1064
1065 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1066 # MySQL module: Allows other SQL modules to access MySQL databases
1067 # through a unified API. You must copy the source for this module
1068 # from the directory src/modules/extra, plus the file m_sqlv2.h
1069 # This modules is in extras. Re-run configure with: ./configure --enable-extras=m_mysql.cpp
1070 # and run make install, then uncomment this module to enable it.
1071 #
1072 #<module name="m_mysql.so">
1073 #
1074 #-#-#-#-#-#-#-#-#-#-#-#- SQL CONFIGURATION   -#-#-#-#-#-#-#-#-#-#-#-#-#
1075 #                                                                     #
1076 # m_mysql.so is more complex than described here, see the wiki for    #
1077 # more: http://wiki.inspircd.org/Modules/mysql                        #
1078 #
1079 #<database name="mydb" username="myuser" password="mypass" hostname="localhost" id="my_database2">
1080
1081 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1082 # Named Modes module: This module allows for the display and set/unset
1083 # of channel settings and modes via long-form mode names in channels with
1084 # channelmode +Z set. For example, to set a channelban with named modes:
1085 # /mode #channel +Z ban=foo!bar@baz . Currently this doesn't serve much
1086 # purpose outside of making channel administration a bit easier in some
1087 # cases, but eventually modules will start using named modes only because
1088 # we're running out of channelmodes. :D
1089 #<module name="m_namedmodes.so">
1090
1091 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1092 # NAMESX module: Provides support for the NAMESX extension which allows
1093 # clients to see all the prefixes set on a user without getting confused.
1094 # This is supported by mIRC, x-chat, klient, and maybe more.
1095 #<module name="m_namesx.so">
1096
1097 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1098 # National characters module:
1099 # 1) Allows using national characters in nicknames.
1100 # 2) Allows using custom (national) casemapping over the network.
1101 # file -- filename of existing file in "locales" directory
1102 # casemapping -- custom value for 005 numeric (if you want it to be
1103 # different from the filename.
1104 #
1105 #<nationalchars file="bynets/russian-w1251-charlink" casemapping="ru_RU.cp1251-charlink">
1106 #<module name="m_nationalchars.so">
1107
1108 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1109 # Nickchange flood protection module: Allows up to X nick changes in Y seconds.
1110 # Provides channel mode +F.
1111 #<module name="m_nickflood.so">
1112
1113 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1114 # Nicklock module: Let opers change a user's nick and then stop that
1115 # user from changing their nick again.
1116 # This module is oper-only.
1117 # To use, NICKLOCK and NICKUNLOCK must be in one of your oper class blocks.
1118 #<module name="m_nicklock.so">
1119
1120 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1121 # No ctcp module: Adds the channel mode +C to block CTCPs and extban C
1122 # to block CTCPs sent by specific users.
1123 #<module name="m_noctcp.so">
1124
1125 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1126 # No kicks module: Adds the +Q channel mode and the Q: extban to deny
1127 # certain users from kicking.
1128 #<module name="m_nokicks.so">
1129
1130 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1131 # No nicks module: Adds the +N channel mode, as well as the +b N:
1132 # extended bantype. +N stops all users from changing their nick,
1133 # the +b N: extban stops anyone from matching a +b N:nick!user@host
1134 # mask from changing their nick.
1135 #<module name="m_nonicks.so">
1136
1137 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1138 # No part message module: adds extban 'p' to block part messages from #
1139 # matching users.                                                     #
1140 #<module name="m_nopartmsg.so">
1141
1142 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1143 # No Notice module: adds the channel mode +T and the extban T to block
1144 # specific users from noticing the channel.
1145 #<module name="m_nonotice.so">
1146
1147 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1148 # Network buisness join module
1149 # Allows an oper to join a channel using /OJOIN, giving them +Y on the
1150 # channel which makes them immune to kick/deop/etc.
1151 #<module name="m_ojoin.so">
1152 #
1153 #<ojoin prefix="!" notice="yes" op="yes">
1154 # Specify the prefix that +Y will grant here
1155 # Leave prefix empty if you do not wish +Y to grant a prefix
1156 # If notice is set to on, upon ojoin, the server will notice
1157 # the channel saying that the oper is joining on network business
1158 # If op is set to on, it will give them +o along with +Y
1159
1160
1161 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1162 # Oper channels mode: Adds the +O channel mode and +beI type O:<mask>
1163 # to ban, exempt, and invex given oper type masks.
1164 # e.g, /mode #channel +iI O:* is equivilant to chmode +O, but you
1165 # may also, e.g. /mode #channel +iI O:AdminTypeOnly to only allow admins.
1166 # +be work in a similar fashion.
1167 #
1168 #<module name="m_operchans.so">
1169
1170 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1171 # Oper Join module: Auto-joins opers to a channel upon oper-up
1172 # This module is oper-only. For the user equivalent, see m_conn_join.
1173 #<module name="m_operjoin.so">
1174 #
1175 #-#-#-#-#-#-#-#-#-#-#   OPERJOIN CONFIGURATION   -#-#-#-#-#-#-#-#-#-#-#
1176 #                                                                     #
1177 # If you are using the m_operjoin.so module, specify options here:    #
1178 #                                                                     #
1179 # channel     -      The channel name to join, can also be a comma    #
1180 #                    seperated list eg. "#channel1,#channel2".        #
1181 #                                                                     #
1182 # override    -      Lets the oper join walking thru any modes that   #
1183 #                    might be set, even bans. Use "yes" or "no".      #
1184 #                                                                     #
1185 #<operjoin channel="#channel" override="no">
1186 #
1187 # Alternatively you can use the autojoin="channellist" in a <type>    #
1188 # tag to set specific autojoins for a type of oper, for example:      #
1189 #
1190 #<type name="Helper" autojoin="#help" classes="...">
1191
1192 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1193 # Oper log module: Logs all oper commands to the ircd log at default
1194 # loglevel.
1195 # This module is oper-only.
1196 #<module name="m_operlog.so">
1197
1198 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1199 # Oper prefixing module: Gives IRC operators a prefix status character
1200 # on all channels they are in.
1201 #
1202 #<module name="m_operprefix.so">
1203 #
1204 # You may additionally customise the prefix character.
1205 #<operprefix prefix="!">
1206
1207 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1208 # Oper MOTD module: Provides support for seperate message of the day
1209 # on oper-up
1210 # This module is oper-only.
1211 #<module name="m_opermotd.so">
1212 #
1213 #-#-#-#-#-#-#-#-#-#-#   OPERMOTD CONFIGURATION   -#-#-#-#-#-#-#-#-#-#-#
1214 #                                                                     #
1215 # If you are using the m_opermotd.so module, specify the motd here    #
1216 #                                                                     #
1217 # onoper      -      Should the message be sent on /OPER or only when #
1218 #                    /OPERMOTD is used. Use "yes" or "no".            #
1219 #                                                                     #
1220 #<opermotd file="oper.motd" onoper="yes">
1221
1222 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1223 # Override module: Adds support for oper override
1224 # This module is oper-only.
1225 #<module name="m_override.so">
1226 #
1227 #-#-#-#-#-#-#-#-#-#-#   OVERRIDE CONFIGURATION   -#-#-#-#-#-#-#-#-#-#-#
1228 #                                                                     #
1229 # m_override.so is too complex it describe here, see the wiki:        #
1230 # http://wiki.inspircd.org/Modules/override                           #
1231
1232 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1233 # Oper levels module: Gives each oper a level and prevents
1234 # actions being taken against higher level opers
1235 # Specify the level as the 'level' parameter of the <type> tag
1236 # # This module is oper-only.
1237 #<module name="m_operlevels.so">
1238
1239 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1240 # Oper modes module: Allows you to specify modes to add/remove on oper
1241 # Specify the modes as the 'modes' parameter of the <type> tag
1242 # and/or as the 'modes' parameter of the <oper> tag.
1243 # This module is oper-only. For the user equivalent, see m_conn_umodes
1244 #<module name="m_opermodes.so">
1245
1246 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1247 # Password forwarding module: Forwards a password users can send on connect
1248 # to the specified client below. The client is usually nickserv and this
1249 # module is usually used to authenticate users with nickserv using their
1250 # connect password.
1251 #<module name="m_passforward.so">
1252
1253 <passforward
1254                 # nick: nick to forward connect passwords to.
1255                 nick="NickServ"
1256
1257                 # forwardmsg: Message to send to users using a connect password.
1258                 # $nick will be the users' nick, $nickrequired will be the nick
1259                 # of where the password is going (the nick above).
1260                 forwardmsg="NOTICE $nick :*** Forwarding PASS to $nickrequired"
1261
1262                 # cmd: Command for the nick to run when it recieves a connect
1263                 # password. 
1264                 cmd="PRIVMSG $nickrequired :IDENTIFY $pass">
1265
1266 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1267 # Oper password hash module: Allows hashed oper passwords
1268 # Relies on the module m_md5.so and/or m_sha256.so being loaded before
1269 # m_password_hash.so in the configuration file.
1270 # This module is oper-only.
1271 #<module name="m_password_hash.so">
1272 #
1273 #-#-#-#-#-#-#-#-#-#-# OPER HASH CONFIGURATION #-#-#-#-#-#-#-#-#-#-#-#-#
1274 #
1275 # To use this module, you must define a hash type for each oper's
1276 # password you want to hash. For example:
1277 #
1278 #     <oper name="Brain"
1279 #           host="ident@dialup15.isp.com"
1280 #           hash="sha256"
1281 #           password="a41d730937a53b79f788c0ab13e9e1d5"
1282 #           type="NetAdmin">
1283
1284 # The types of hashing available vary depending on which hashing modules
1285 # you load, but usually if you load m_sha256.so and m_md5.so, both md5
1286 # and sha256 type hashing will be available (the most secure of which
1287 # is SHA256).
1288
1289 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1290 # Permanent Channels module: Channels with the permanent channels mode
1291 # will remain open even after everyone else has left the channel, and
1292 # therefore keep things like modes, ban lists and topic. Permanent
1293 # channels -may- need support from your Services package to function
1294 # properly with them. This adds channel mode +P.
1295 # This module is oper-only.
1296 #<module name="m_permchannels.so">
1297 #
1298 # If you like, m_permchannels can write a config file of permanent channels
1299 # whenever +P is set, unset, or the topic/modes on a +P channel is changed.
1300 # If you want to do this, set the filename below, and uncomment the include.
1301 #
1302 #<permchanneldb filename="conf/permchannels.conf">
1303 #<include file="permchannels.conf">
1304 #
1305 # You may also create channels on startup by using the <permchannels> block.
1306 #<permchannels channel="#opers" modes="is" topic="Opers only.">
1307
1308 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1309 # PostgreSQL module: Allows other SQL modules to access PgSQL databases
1310 # through a unified API. You must copy the source for this module
1311 # from the directory src/modules/extra, plus the file m_sqlv2.h
1312 # This modules is in extras. Re-run configure with: ./configure --enable-extras=m_pgsql.cpp
1313 # and run make install, then uncomment this module to enable it.
1314 #
1315 #<module name="m_pgsql.so">
1316 #
1317 #-#-#-#-#-#-#-#-#-#-#-#- SQL CONFIGURATION   -#-#-#-#-#-#-#-#-#-#-#-#-#
1318 #                                                                     #
1319 # m_pgsql.so is more complex than described here, see the wiki for    #
1320 # more: http://wiki.inspircd.org/Modules/pgsql                        #
1321 #
1322 #<database name="mydb" username="myuser" password="mypass" hostname="localhost" id="my_database" ssl="no">
1323
1324 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1325 # Muteban: Implements extended ban m:, which stops anyone matching
1326 # a mask like +b m:nick!user@host from speaking on channel.
1327 #<module name="m_muteban.so">
1328 #
1329
1330 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1331 # Random Quote module: provides a random quote on connect.
1332 # NOTE: Some of these may mimic fatal errors and confuse users and 
1333 # opers alike! - BEWARE!
1334 #<module name="m_randquote.so">
1335 #
1336 #-#-#-#-#-#-#-#-#-#-  RANDOMQUOTES CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
1337 #                                                                     #
1338 # Optional - If you specify to use the m_randquote.so module, then    #
1339 # specify below the path to the randquotes.conf file.                 #
1340 #                                                                     #
1341 #<randquote file="randquotes.conf">
1342
1343 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1344 # Redirect module: Adds channel redirection (mode +L)
1345 #<module name="m_redirect.so">
1346
1347 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1348 # Regular Expression Provider for Glob or wildcard (?/*) matching.
1349 # You must have at least 1 provider loaded to use m_filter or m_rline
1350 # modules. This module has no additional requirements, as it uses the
1351 # matching already present in InspIRCd core.
1352 #<module name="m_regex_glob.so">
1353
1354 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1355 # Regular Expression Provider for PCRE (Perl-Compatible Regular
1356 # Expressions). You need libpcre installed to compile and load this
1357 # module. You must have at least 1 provider loaded to use m_filter or
1358 # m_rline.
1359 #<module name="m_regex_pcre.so">
1360
1361 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1362 # Regular Expression Provider for POSIX Regular Expressions.
1363 # You shouldn't need any additional libraries on a POSIX-compatible
1364 # system (ie: any Linux, BSD, but not Windows). You must have at least
1365 # 1 provider loaded to use m_filter or m_rline.
1366 # On POSIX-compliant systems, regex syntax can be found by using the
1367 # command: 'man 7 regex'.
1368 #<module name="m_regex_posix.so">
1369
1370 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1371 # Regular Expression Provider for TRE Regular Expressions.
1372 # This is the same regular expression engine used by UnrealIRCd, so
1373 # if you are most familiar with the syntax of /spamfilter from there,
1374 # this is the provider you want. You need libtre installed in order
1375 # to compile and load this module.
1376 #<module name="m_regex_tre.so">
1377
1378 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1379 # Registered users only channel creation
1380 # Allows only registered users and opers to create new channels.
1381 #
1382 # You probably *DO NOT* want to load this module on a public network.
1383 #
1384 #<module name="m_regonlycreate.so">
1385
1386 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1387 # Remove module: Adds the /REMOVE command which is a peaceful
1388 # alternative to /KICK
1389 #<module name="m_remove.so">
1390
1391 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1392 # Restricted channels module: Allows only opers to create channels.
1393 #
1394 # You probably *DO NOT* want to load this module on a public network.
1395 #
1396 #<module name="m_restrictchans.so">
1397
1398 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1399 # Restrict message module: Allows users to only message opers.
1400 #
1401 # You probably *DO NOT* want to load this module on a public network.
1402 #
1403 #<module name="m_restrictmsg.so">
1404
1405 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1406 # Ban users through regular expression patterns
1407 #<module name="m_rline.so">
1408 #
1409 #-#-#-#-#-#-#-#-#-#-#-#- RLINE CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#-#
1410 #
1411 # If you wish to re-check a user when they change nickname (can be
1412 # useful under some situations, but *can* also use CPU with more users
1413 # on a server) then set the following configuration value:
1414 # Also, this is where you set what Regular Expression engine is to be
1415 # used. If you ever change it while running, all of your R-Lines will be
1416 # wiped. This is the regex engine used by all R-Lines set, and
1417 # m_regex_<engine>.so must be loaded, or rline will be nonfunctional
1418 # until you load it or change the engine to one that is loaded.
1419 #
1420 #<rline matchonnickchange="yes" engine="pcre">
1421 #
1422 # Generally, you will NOT want to use 'glob' here, as this turns
1423 # rline into just another gline. The exceptions are that rline will
1424 # always use the full nick!user@host realname string, rather than only
1425 # user@host, but beware that only the ? and * wildcards are available,
1426 # and are the only way to specify where the space can occur if you do
1427 # use glob. For this reason, is recommended to use a real regex engine
1428 # so that at least \s or [[:space:]] is available.
1429
1430 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1431 # SAJOIN module: Adds the /SAJOIN command
1432 # This module is oper-only.
1433 # To use, SAJOIN must be in one of your oper class blocks.
1434 #<module name="m_sajoin.so">
1435
1436 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1437 # SAKICK module: Adds the /SAKICK command
1438 # This module is oper-only.
1439 # To use, SAKICK must be in one of your oper class blocks.
1440 #<module name="m_sakick.so">
1441
1442 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1443 # SAMODE module: Adds the oper /SAMODE command
1444 # This module is oper-only.
1445 # To use, SAMODE must be in one of your oper class blocks.
1446 #<module name="m_samode.so">
1447
1448 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1449 # SANICK module: Allows opers to change user's nicks
1450 # This module is oper-only.
1451 # To use, SANICK must be in one of your oper class blocks.
1452 #<module name="m_sanick.so">
1453
1454 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1455 # SAPART module: Adds the oper /SAPART command
1456 # This module is oper-only.
1457 # To use, SAPART must be in one of your oper class blocks.
1458 #<module name="m_sapart.so">
1459
1460 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1461 # SAQUIT module: Adds the oper /SAQUIT command (abusable!!!)
1462 # This module is oper-only.
1463 # To use, SAQUIT must be in one of your oper class blocks.
1464 #<module name="m_saquit.so">
1465
1466 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1467 # SATOPIC module: Adds the oper /SATOPIC command
1468 # This module is oper-only.
1469 # To use, SATOPIC must be in one of your oper class blocks.
1470 #<module name="m_satopic.so">
1471
1472 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1473 # SASL authentication module: Provides support for IRC Authentication 
1474 # Layer (aka: atheme SASL) via AUTHENTICATE.
1475 #<module name="m_sasl.so">
1476
1477 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1478 # Secure list module: Prevent /LIST in the first minute of connection,
1479 # crippling most spambots and trojan spreader bots.
1480 #<module name="m_securelist.so">
1481 #
1482 #-#-#-#-#-#-#-#-#-# SECURELIST CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#-#
1483 #                                                                     #
1484 # Securelist can be harmful to some irc search engines such as        #
1485 # netsplit.de and searchirc.com. To prevent securelist blocking these #
1486 # sites from listing, define exception tags as shown below:           #
1487 <securehost exception="*@*.searchirc.org">
1488 <securehost exception="*@*.netsplit.de">
1489 <securehost exception="*@echo940.server4you.de">
1490 <securehost exception="*@*.ircdriven.com">
1491 #                                                                     #
1492 # Define the following variable to change how long a user must wait   #
1493 # before issuing a LIST. If not defined, defaults to 60 seconds.      #
1494 #                                                                     #
1495 #<securelist waittime="60">                                           #
1496
1497 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1498 # Servprotect module: Provides support for Austhex style +k /
1499 # UnrealIRCD +S services mode
1500 #<module name="m_servprotect.so">
1501
1502 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1503 # See nicks module: Allow for SNOMASK +N which shows nick changes.
1504 # This module is oper-only.
1505 #<module name="m_seenicks.so">
1506
1507 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1508 # Set Idle module: Adds a command for opers to change their
1509 # idle time (mainly a toy)
1510 # This module is oper-only.
1511 # To use, SETIDLE must be in one of your oper class blocks.
1512 #<module name="m_setidle.so">
1513
1514 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1515 # Services support module: Adds several usermodes such as +R and +M
1516 # this module implements the 'identified' state via account names (AC)
1517 # and is similar in operation to the way asuka and ircu handle services.
1518 #
1519 # At the same time, this offers +r for users and channels to mark them
1520 # as identified seperately from the idea of a master account, which
1521 # can be useful for services which are heavily nick-as-account centric.
1522 #
1523 # This replaces m_services from 1.1 and earlier.
1524 #
1525 # Also of note is that this module implements two extbans:
1526 # +b R: (stop matching account names from joining)
1527 # +b M: (stop matching account names from speaking)
1528 #                                                                       
1529 #<module name="m_services_account.so">
1530
1531 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1532 # Sethost module: Adds the /SETHOST command
1533 # This module is oper-only.
1534 # To use, SETHOST must be in one of your oper class blocks.
1535 # See m_chghost for how to customise valid chars for hostnames
1536 #<module name="m_sethost.so">
1537
1538 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1539 # Setident module: Adds the /SETIDENT command
1540 # This module is oper-only.
1541 # To use, SETIDENT must be in one of your oper class blocks.
1542 #<module name="m_setident.so">
1543
1544 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1545 # SETNAME module: Adds the /SETNAME command
1546 # This module is oper-only.
1547 # To use, SETNAME must be in one of your oper class blocks.
1548 #<module name="m_setname.so">
1549
1550 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1551 # Serverban: Implements extended ban s:, which stops anyone connected
1552 # to a server matching a mask like +b s:server.mask.here from joining.
1553 #<module name="m_serverban.so">
1554
1555 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1556 # Show Whois module: Adds the +W usermode which allows opers
1557 # to see when they are whois'ed (can be annoying).
1558 # This module is oper-only.
1559 #<module name="m_showwhois.so">
1560 #
1561 # If you wish, you may also let users set this mode. Only opers with the
1562 # users/auspex priv will see real hosts of people, though. This setting
1563 # is not reloadable via /rehash, and will require /reloadmodule, as
1564 # it directly affects the mode object itself.
1565 #<showwhois opersonly="yes"
1566 #
1567 # You may also set whether or not users should recieve whois notices, should
1568 # they be /whois'd by an oper.
1569 # showfromopers="yes">
1570
1571 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1572 # Shun module: Provides the /shun command, which stops a user executing 
1573 # most commands.
1574 # This module is oper-only.
1575 # To use, SHUN must be in one of your oper class blocks.
1576 #<module name="m_shun.so">
1577 #
1578 # You may also configure which commands you wish a user to be able to
1579 # perform. It should be noted that if a shunned user issues QUIT or PART
1580 # then their message will be removed, as if they did not issue one.
1581 #
1582 # You can (optionally) let the user know that their command was blocked.
1583 #
1584 # You may also let SHUN affect opers (defaults to no).
1585 #<shun enabledcommands="PING PONG QUIT PART JOIN" notifyuser="yes" affectopers="no">
1586
1587 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1588 # Spy module: Provides the ability to see the complete names list of 
1589 # channels an oper is not a member of
1590 # This module is oper-only.
1591 #<module name="m_spy.so">
1592
1593 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1594 # SSL channel mode module: Adds support for SSL-only channels (+z).
1595 # does not do anything useful without a working SSL module (see below)
1596 #<module name="m_sslmodes.so">
1597
1598 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1599 # GnuTLS ssl module: Adds support for client-server SSL using GnuTLS,
1600 # if enabled. You must copy the source for this module from the directory
1601 # src/modules/extra, or answer 'yes' in ./configure when asked if you
1602 # want to enable this, or it will not load.
1603 #<module name="m_ssl_gnutls.so">
1604 #
1605 #-#-#-#-#-#-#-#-#-#-#-  GNUTLS CONFIGURATION   -#-#-#-#-#-#-#-#-#-#-#-#
1606 #                                                                     #
1607 # m_ssl_gnutls.so is too complex it describe here, see the wiki:      #
1608 # http://wiki.inspircd.org/Modules/ssl_gnutls                         #
1609 #                                                                     #
1610 # NOTE: If you want to use this module to encrypt and sign your       #
1611 # server to server traffic, you MUST load it before m_spanningtree in #
1612 # your configuration file!                                            #
1613
1614 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1615 # SSL Info module: Allows users to retrieve information about other
1616 # user's peer SSL certificates and keys. This can be used by client
1617 # scripts to validate users. For this to work, one of m_ssl_gnutls.so
1618 # or m_ssl_openssl.so must be loaded. This module also adds the 
1619 # "* <user> is using a secure connection" whois line, the ability for
1620 # opers to use SSL fingerprints to verify their identity and the ability
1621 # to force opers to use SSL connections in order to oper up.
1622 # It is highly recommended to load this module especially if
1623 # you use SSL on your network.
1624 # For how to use the oper features, please see the first example <oper> tag
1625 # in opers.conf.example.
1626 #
1627 #<module name="m_sslinfo.so">
1628
1629 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1630 # OpenSSL ssl module: Adds support for client-server SSL using OpenSSL,
1631 # if enabled. You must copy the source for this module from the directory
1632 # src/modules/extra, or answer 'yes' in ./configure when asked if you
1633 # want to enable this, or it will not load.
1634 #<module name="m_ssl_openssl.so">
1635 #
1636 #-#-#-#-#-#-#-#-#-#-#- OPENSSL CONFIGURATION   -#-#-#-#-#-#-#-#-#-#-#-#
1637 #                                                                     #
1638 # m_ssl_openssl.so is too complex it describe here, see the wiki:     #
1639 # http://wiki.inspircd.org/Modules/ssl_openssl                        #
1640 #                                                                     #
1641 # NOTE: If you want to use this module to encrypt and sign your       #
1642 # server to server traffic, you MUST load it before m_spanningtree in #
1643 # your configuration file!                                            #
1644
1645 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1646 # Status prefix: Adds the channel mode +V
1647 #<module name="m_statusprefix.so">
1648
1649 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1650 # Strip colour module: Adds the channel mode +S
1651 #<module name="m_stripcolor.so">
1652
1653 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1654 # SILENCE module: Adds support for /SILENCE
1655 #<module name="m_silence.so">
1656 #
1657 # Configuration tags:
1658 #
1659 #<silence maxentries="32">
1660 #
1661 # Sets the maximum number of entries on a users silence list.
1662
1663 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1664 # SQLite3 module: Allows other SQL modules to access SQLite3          #
1665 # databases through a unified API. You must link the source for this  #
1666 # module from the directory src/modules/extra to src/modules, plus    #
1667 # the file m_sqlv2.h                                                  #
1668 # This modules is in extras. Re-run configure with: ./configure --enable-extras=m_aqlite.cpp
1669 # and run make install, then uncomment this module to enable it.      #
1670 #
1671 #<module name="m_sqlite3.so">
1672 #
1673 #-#-#-#-#-#-#-#-#-#-#-#- SQL CONFIGURATION   -#-#-#-#-#-#-#-#-#-#-#-#-#
1674 #                                                                     #
1675 # m_sqlite.so is more complex than described here, see the wiki for   #
1676 # more: http://wiki.inspircd.org/Modules/sqlite3                      #
1677 #
1678 #<database hostname="/full/path/to/database.db" id="anytext">
1679
1680 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1681 # SQLutils module: Provides some utilities to SQL client modules, such
1682 # as mapping queries to users and channels. You must copy the source
1683 # for this module from the directory src/modules/extra/m_sqlutils.cpp
1684 # and src/modules/extra/m_sqlutils.h into /src/modules
1685 # Needed for, and loaded before: SQLauth and SQLoper
1686 # This modules is in extras. Re-run configure with: ./configure --enable-extras=m_sqlutils.cpp
1687 # and run make install, then uncomment this module to enable it.
1688 #
1689 #<module name="m_sqlutils.so">
1690
1691 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1692 # SQL authentication module: Allows IRCd connections to be tied into
1693 # a database table (for example a forum). You must copy the source for
1694 # this module from the directory src/modules/extra
1695 # Depends on the SQLutils module being loaded first.
1696 # This modules is in extras. Re-run configure with: ./configure --enable-extras=m_sqlauth.cpp
1697 # and run make install, then uncomment this module to enable it.
1698 #
1699 #<module name="m_sqlauth.so">
1700 #
1701 #-#-#-#-#-#-#-#-#-#-#- SQLAUTH CONFIGURATION   -#-#-#-#-#-#-#-#-#-#-#-#
1702 #                                                                     #
1703 # m_sqlauth.so is too complex it describe here, see the wiki:         #
1704 # http://wiki.inspircd.org/Modules/sqlauth                            #
1705
1706 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1707 # SQL logging module: Allows you to log network-wide data for your
1708 # network in a fully normalised set of SQL tables. You must copy the
1709 # source for this module from the directory src/modules/extra
1710 # This modules is in extras. Re-run configure with: ./configure --enable-extras=m_sqllog.cpp
1711 # and run make install, then uncomment this module to enable it.
1712 #
1713 #<module name="m_sqllog.so">
1714 #
1715 #-#-#-#-#-#-#-#-#-#-#-  SQLLOG CONFIGURATION   -#-#-#-#-#-#-#-#-#-#-#-#
1716 #                                                                     #
1717 # dbid       - Database ID to use (see m_sql)                         #
1718 #                                                                     #
1719 # See also: http://wiki.inspircd.org/Modules/sqllog                   #
1720 #                                                                     #
1721 #<sqllog dbid="1">
1722
1723 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1724 # SQL oper module: Allows you to store oper credentials in an SQL table
1725 # You must copy the source for this module from the directory src/modules/extra
1726 # Depends on the SQLutils module being loaded first.
1727 # This modules is in extras. Re-run configure with: ./configure --enable-extras=m_sqloper.cpp
1728 # and run make install, then uncomment this module to enable it.
1729 #
1730 #<module name="m_sqloper.so">
1731 #
1732 #-#-#-#-#-#-#-#-#-#-#- SQLOPER CONFIGURATION   -#-#-#-#-#-#-#-#-#-#-#-#
1733 #                                                                     #
1734 # dbid       - Database ID to use (see m_sql)                         #
1735 # hash       - Hashing provider to use for password hashing           #
1736 #                                                                     #
1737 # See also: http://wiki.inspircd.org/Modules/sqloper                  #
1738 #                                                                     #
1739 #<sqloper dbid="1" hash="md5">
1740
1741 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1742 # SVSHold module: Implements SVSHOLD. Like Q:Lines, but can only be   #
1743 # added/removed by Services.                                          #
1744 #<module name="m_svshold.so">
1745
1746 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1747 # SWHOIS module: Allows you to add arbitary lines to user WHOIS.
1748 # This module is oper-only.
1749 # To use, SWHOIS must be in one of your oper class blocks.
1750 #<module name="m_swhois.so">
1751
1752 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1753 # Test module: enable this to create a command useful in testing
1754 # flood control. To avoid accidental use on live networks, the server
1755 # name must contain ".test" to load the module
1756 #<module name="m_testnet.so">
1757
1758 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1759 # Timed bans module: Adds timed channel bans and the /TBAN command
1760 #<module name="m_timedbans.so">
1761
1762 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1763 # Test line module: Adds the /TLINE command, used to test how many
1764 # users a /GLINE or /ZLINE etc would match.
1765 # This module is oper-only.
1766 # To use, TLINE must be in one of your oper class blocks.
1767 #<module name="m_tline.so">
1768
1769 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1770 # UHNAMES support module: Adds support for the IRCX style UHNAMES
1771 # extension, which displays ident and hostname in the names list for
1772 # each user, saving clients from doing a WHO on the channel. Note that
1773 # this module is not widely supported yet. If a client does not support
1774 # UHNAMES it will not enable it, this will not break incompatible
1775 # clients.
1776 #<module name="m_uhnames.so">
1777
1778 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1779 # Uninvite module: Adds the /UNINVITE command which lets users remove
1780 # pending invites from channels without waiting for the user to join.
1781 #<module name="m_uninvite.so">
1782
1783 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1784 # Userip module: Adds the /USERIP command
1785 # This module is oper-only.
1786 # To use, USERIP must be in one of your oper class blocks.
1787 #<module name="m_userip.so">
1788
1789 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1790 # Vhost module: Adds the VHOST command which allows for adding virtual
1791 # hosts which are accessible using a username and password in the config.
1792 #<module name="m_vhost.so">
1793 #
1794 #-#-#-#-#-#-#-#-#-#-#- VHOST CONFIGURATION   -#-#-#-#-#-#-#-#-#-#-#-#-#
1795 #                                                                     #
1796 # user       - Username for the vhost.                                #
1797 #                                                                     #
1798 # pass       - Password for the vhost.                                #
1799 #                                                                     #
1800 # hash       - The hash for the specific user (optional)
1801 #              m_password_hash.so and a hashing module must be loaded for this to work
1802 #                                                                     #
1803 # host       - Vhost to set.                                          #
1804 #
1805 #<vhost user="some_username" pass="some_password" host="some.host">
1806 #<vhost user="foo" password="fcde2b2edba56bf408601fb721fe9b5c338d10ee429ea04fae5511b68fbf8fb9" hash="sha256" host="some.other.host">
1807
1808 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1809 # Watch module: Adds the WATCH command, which is used by clients to 
1810 # maintain notify lists.
1811 #<module name="m_watch.so">
1812 #
1813 # Configuration tags:
1814 #
1815 #<watch maxentries="32">
1816 #
1817 # Sets the maximum number of entries on a user's watch list.
1818
1819 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1820 # XLine database: Stores all *Lines (G/Z/K/R/any added by other modules)
1821 # in a file "xline.db" which can be re-loaded on restart. This is useful
1822 # for two reasons: it keeps bans so users may not evade them, and on
1823 # bigger networks, server connections will take less time as there will
1824 # be a lot less bans to apply - as most of them will already be there.
1825 #<module name="m_xline_db.so">
1826
1827 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1828 # ZipLinks module: Adds support for zlib deflate on server to server
1829 # connections. Both ends of the connection must load this module.
1830 # This modules is in extras. Re-run configure with: ./configure --enable-extras=m_ziplink.cpp
1831 # and run make install, then uncomment this module to enable it.
1832 #
1833 #<module name="m_ziplink.so">
1834 #
1835 # To use this module, you must enable it as a ssl type in your
1836 # <link> tags or <bind> tags using the ssl name 'ziplinks'.
1837 # See the documentation of <link> and <bind>, respectively.
1838 #
1839
1840
1841 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1842 #    ____                _   _____ _     _       ____  _ _   _        #
1843 #   |  _ \ ___  __ _  __| | |_   _| |__ (_)___  | __ )(_) |_| |       #
1844 #   | |_) / _ \/ _` |/ _` |   | | | '_ \| / __| |  _ \| | __| |       #
1845 #   |  _ <  __/ (_| | (_| |   | | | | | | \__ \ | |_) | | |_|_|       #
1846 #   |_| \_\___|\__,_|\__,_|   |_| |_| |_|_|___/ |____/|_|\__(_)       #
1847 #                                                                     #
1848 # To link servers to InspIRCd, you MUST load the m_spanningtree       #
1849 # module. Since several features (like SSL server links) rely on      #
1850 # other modules being loaded before m_spanningtree, the module itself #
1851 # is at the bottom of this file. DO NOT forget to load it. If you DO  #
1852 # NOT do this, server links will NOT work at all. ie. The ports will  #
1853 # NOT bind, and /connect will not work properly. This is by design,   #
1854 # to allow for the implementation of other linking protocols in       #
1855 # modules in the future.                                              #
1856 #                                                                     #
1857
1858 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1859 # Spanning Tree module - allows linking of servers using the spanning
1860 # tree protocol (see the READ THIS BIT section above).
1861 # You will almost always want to load this.
1862 #
1863 #<module name="m_spanningtree.so">
1864
1865