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