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