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