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