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