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