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