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