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