]> git.netwichtig.de Git - user/henk/code/inspircd.git/blob - docs/inspircd.conf.example
572ef93c8d4f8971c1d0d983f2eb48145228a8da
[user/henk/code/inspircd.git] / docs / inspircd.conf.example
1 ########################################################################
2 #                                                                      #
3 #               ___                ___ ____   ____    _                #
4 #              |_ _|_ __  ___ _ __|_ _|  _ \ / ___|__| |               #
5 #               | || '_ \/ __| '_ \| || |_) | |   / _` |               #
6 #               | || | | \__ \ |_) | ||  _ <| |__| (_| |               #
7 #              |___|_| |_|___/ .__/___|_| \_\\____\__,_|               #
8 #                            |_|                                       #
9 #      ____             __ _                       _   _               #
10 #     / ___|___  _ __  / _(_) __ _ _   _ _ __ __ _| |_(_) ___  _ __    #
11 #    | |   / _ \| '_ \| |_| |/ _` | | | | '__/ _` | __| |/ _ \| '_ \   #
12 #    | |__| (_) | | | |  _| | (_| | |_| | | | (_| | |_| | (_) | | | |  #
13 #     \____\___/|_| |_|_| |_|\__, |\__,_|_|  \__,_|\__|_|\___/|_| |_|  #
14 #                            |___/                                     #
15 #                                                                      #
16 ##################################||####################################
17                                  #||#                                   
18 ##################################||####################################
19 #                                                                      #
20 #         This is an example of the config file for InspIRCd.          #
21 #             Change the options to suit your network                  #
22 #                                                                      #
23 #     $Id$
24 #                                                                      #
25 #    ____                _   _____ _     _       ____  _ _   _         #
26 #   |  _ \ ___  __ _  __| | |_   _| |__ (_)___  | __ )(_) |_| |        #
27 #   | |_) / _ \/ _` |/ _` |   | | | '_ \| / __| |  _ \| | __| |        #
28 #   |  _ <  __/ (_| | (_| |   | | | | | | \__ \ | |_) | | |_|_|        #
29 #   |_| \_\___|\__,_|\__,_|   |_| |_| |_|_|___/ |____/|_|\__(_)        #
30 #                                                                      #
31 #   Lines prefixed with READ THIS BIT, as shown above, are IMPORTANT   #
32 #   lines, and you REALLY SHOULD READ THEM. Yes, THIS MEANS YOU. Even  #
33 #   if you've configured InspIRCd before, these probably indicate      #
34 #   something new or different to this version and you SHOULD READ IT. #
35 #                                                                      #
36 ########################################################################
37 #                                                                      #
38 #         Unalphabeticalise the modules list at your own risk          #
39 #                                                                      #
40 ########################################################################
41
42
43 #-#-#-#-#-#-#-#-#-#-#-#-  SERVER DESCRIPTION  -#-#-#-#-#-#-#-#-#-#-#-#-
44 #                                                                     #
45 #   Here is where you enter the information about your server.        #
46 #                                                                     #
47 #  Syntax is as follows:                                              #
48 #                                                                     #
49 #     <server name="server.name"                                      #
50 #      description="Server Description"                               #
51 #      networkemail="Email address shown on g/k/z/q lines"            #
52 #      id="serverid"                                                  #
53 #      network="MyNetwork">                                           #
54 #                                                                     #
55 #  The server ID is optional, and if omitted or set to 0, is auto-    #
56 #  matically calculated from the server name and description. This is #
57 #  similar in behaviour to the server id on ircu and charybdis ircds. #
58 #  You should only need to set this manually if there is a collision  #
59 #  between two server IDs on the network. The server ID must be       #
60 #  between 1 and 999, if it is not, it will be wrapped to this range. #
61 #  There is a range of server IDs which are suffixed by two letters   #
62 #  rather than two numbers, e.g. 1AA, 2FF, 3ZZ, which are reserved    #
63 #  for use by non-inspircd servers such as services and stats servers.#
64 #                                                                     #
65
66 <server name="penguin.omega.org.za"
67         description="Waddle World"
68         id="0"
69         network="Omega">
70
71
72 #-#-#-#-#-#-#-#-#-#-#-#-   ADMIN INFORMATION   -#-#-#-#-#-#-#-#-#-#-#-#
73 #                                                                     #
74 #   Describes the Server Administrator's real name (optionally),      #
75 #   nick, and email address.                                          #
76 #                                                                     #
77 #  Syntax is as follows:                                              #
78 #       <admin name="real name"                                       #
79 #              nick="nick name"                                       #
80 #              email="email@address.com">                             #
81 #                                                                     #
82
83 <admin name="Johnny English"
84        nick="MI5"
85        email="MI5@the.best.secret.agent">
86
87
88 #-#-#-#-#-#-#-#-#-#-#-#-   PORT CONFIGURATION   -#-#-#-#-#-#-#-#-#-#-#-
89 #                                                                     #
90 #   Enter the port and address bindings here.                         #
91 #                                                                     #
92 #  bind address - specifies which address ports bind to. Leaving this #
93 #                 field blank binds the port to all IPs available.    #
94 #                                                                     #
95 #  port         - The port number to bind to. You may specify a port  #
96 #                 range here, e.g. "6667-6669,7000,7001". If you do   #
97 #                 this, the server will count each port within your   #
98 #                 range as a seperate binding, making the above       #
99 #                 example equivalent to five seperate bind tags.      #
100 #                 A failure on one port in the range does not prevent #
101 #                 the entire range from being bound, just that one    #
102 #                 port number.                                        #
103 #                                                                     #
104 #  type         - can be 'clients' or 'servers'. The clients type is  #
105 #                 a standard tcp based socket, the servers type is a  #
106 #                 also a TCP based connection but of a different      #
107 #                 format. SSL support is provided by modules, to      #
108 #                 enable SSL support, please read the module section  #
109 #                 of this configuration file.                         #
110 #                                                                     #
111 #  ssl          - When using m_ssl_gnutls.so or m_ssl_openssl.so      #
112 #                 modules, you must define this value to use ssl on   #
113 #                 that port. valid values are 'gnutls' or 'openssl'   #
114 #                 respectively. If the module is not loaded, this     #
115 #                 setting is ignored.                                 #
116 #                                                                     #
117 #  transport    - If you have m_spanningtree.so loaded, along with    #
118 #                 either of the SSL modules (m_ssl_gnutls or          #
119 #                 m_ssl_openssl) or m_ziplinks.so, then you may make  #
120 #                 use of this value.                                  #
121 #                 setting it to 'openssl' or 'gnutls' or 'zip'        #
122 #                 indicates that the port should accept connections   #
123 #                 using the given transport name. Transports are      #
124 #                 layers which sit on top of a socket and change the  #
125 #                 way data is sent and received, e.g. encryption,     #
126 #                 compression, and other such things. Because this    #
127 #                 may not be limited in use to just encryption,       #
128 #                 the 'ssl' value used for client ports does not      #
129 #                 exist for servers, and this value is used instead.  #
130 #    ____                _   _____ _     _       ____  _ _   _        #
131 #   |  _ \ ___  __ _  __| | |_   _| |__ (_)___  | __ )(_) |_| |       #
132 #   | |_) / _ \/ _` |/ _` |   | | | '_ \| / __| |  _ \| | __| |       #
133 #   |  _ <  __/ (_| | (_| |   | | | | | | \__ \ | |_) | | |_|_|       #
134 #   |_| \_\___|\__,_|\__,_|   |_| |_| |_|_|___/ |____/|_|\__(_)       #
135 #                                                                     #
136 #  If you want to link servers to InspIRCd you must load the          #
137 #  m_spanningtree module! Please see the modules list below for       #
138 #  information on how to load this module! If you do not load this    #
139 #  module, server ports will NOT be bound!                            #
140 #                                                                     #
141 #  Leaving address empty binds to all available interfaces            #
142 #                                                                     #
143 #  Syntax is as follows:                                              #
144 #                                                                     #
145 # <bind address="ip address" port="port" type="clients">              #
146 # <bind address="ip address" port="port" type="servers">              #
147 #                                                                     #
148 # If InspIRCd is built for IPV6, and you wish to accept IPV4 clients, #
149 # then you can specify IPV4 ip addresses here to bind. You may also   #
150 # use the 4in6 notation, ::ffff:1.2.3.4, where 1.2.3.4 is the IPV4    #
151 # address to bind the port, but as of InspIRCd 1.1.1, this is not     #
152 # required.                                                           #
153 #                                                                     #
154 # ------------------------------------------------------------------- #
155 #                                                                     #
156 # PLEASE NOTE: If you have build InspIRCd as an ipv6 server, and you  #
157 # specify an empty bind address, the binding will be bound to ALL THE #
158 # IPV6 IP ADDRESSES, and not the ipv4 addresses. If you are using an  #
159 # ipv6 enabled InspIRCd and want to bind to multiple IPV4 addresses   #
160 # in this way, you must specify them by hand. If you have built the   #
161 # server for ipv4 connections only, then specifying an empty bind     #
162 # address binds the port to all ipv4 IP addresses, as expected.       #
163 #                                                                     #
164
165 <bind address="" port="6000" type="clients">
166 <bind address="" port="6660-6669" type="clients" ssl="gnutls">
167
168 # When linking servers, the openssl and gnutls transports are largely
169 # link-compatible and can be used alongside each other or either/or
170 # on each end of the link without any significant issues.
171
172 <bind address="" port="7000,7001" type="servers">
173 <bind address="1.2.3.4" port="7005" type="servers" transport="openssl">
174
175
176 #-#-#-#-#-#-#-#-#-#-  DIE/RESTART CONFIGURATION   -#-#-#-#-#-#-#-#-#-#-
177 #                                                                     #
178 #   You can configure the passwords here which you wish to use for    #
179 #   the die and restart commands. Only trusted ircops who will        #
180 #   need this ability should know the die and restart password.       #
181 #                                                                     #
182 #  Syntax is as follows:                                              #
183 #       <power diepass="die password" restartpass="restart password"  #
184 #        pause="secs before dying">                                   #
185 #                                                                     #
186
187 <power diepass="" restartpass="" pause="2">
188
189
190 #-#-#-#-#-#-#-#-#-#  INCLUDE CONFIGURATION  #-#-#-#-#-#-#-#-#-#-#-#-#-#
191 #                                                                     #
192 # This optional tag allows you to include another config file         #
193 # allowing you to keep your configuration tidy. The configuration     #
194 # file you include will be treated as part of the configuration file  #
195 # which includes it, in simple terms the inclusion is transparent.    #
196 #                                                                     #
197 # All paths to config files are relative to the directory of the main #
198 # config file inspircd.conf, unless the filename starts with a forward#
199 # slash (/) in which case it is treated as an absolute path.          #
200 #                                                                     #
201 # Syntax is as follows:                                               #
202 #<include file="file.conf">                                           #
203 #                                                                     #
204
205 #-#-#-#-#-#-#-#-#-#-  CONNECTIONS CONFIGURATION  -#-#-#-#-#-#-#-#-#-#-#
206 #                                                                     #
207 #   This is where you can configure which connections are allowed     #
208 #   and denied access onto your server. The password is optional.     #
209 #   You may have as many of these as you require. To allow/deny all   #
210 #   connections, use a '*' or 0.0.0.0/0.                              #
211 #                                                                     #
212 #  Syntax is as follows:                                              #
213 #                                                                     #
214 #       <connect name="myallow" allow="1.2.3.0/24"                    #
215 #                password="blahblah" timeout="10" timeout="blah"      #
216 #                flood="5" threshold="8" pingfreq="120" sendq="99999" #
217 #                revcq="696969" localmax="3" globalmax="3"            #
218 #                port="6660" maxchans="50">                           #
219 #                                                                     #
220 #       <connect name="blocked" deny="127.0.0.1" port="6667">         #
221 #                                                                     #
222 #       <connect name="something" parent="myallow" pingfreq="60">     #
223 #                                                                     #
224 #   IP masks may be specified in CIDR format or wildcard format,      #
225 #   for IPV4 and IPV6. You *cannot* use hostnames in the allow or     #
226 #   deny field, as the state is applied before the user's DNS has     #
227 #   been resolved.                                                    #
228 #                                                                     #
229 #   You can optionally name your connect allow/deny tags. If you do   #
230 #   this, you may reference this connect tag as the parent of another #
231 #   connect tag with the <connect:parent> option as shown above. If   #
232 #   you do this, any options not explicitly specified in the tag will #
233 #   be copied from the parent.                                        #
234 #                                                                     #
235 #   If the value maxchans is included, this overrides all other max   #
236 #   channels related settings, including the seperate oper maximum.   #
237 #   You may set this to any (sane) value you wish and it applies to   #
238 #   all users within this connect tag.                                #
239 #                                                                     #
240 #   You may optionally include timeout="x" on any allow line, which   #
241 #   specifies the amount of time given before an unknown connection   #
242 #   is closed if USER/NICK/PASS are not given. This value is in secs  #
243 #                                                                     #
244 #   You should also include a flood="x" line which indicates          #
245 #   the number of lines a user may place into their buffer at once    #
246 #   before they are disconnected for excess flood. This feature can   #
247 #   not be disabled, however it can be set to extremely high values,  #
248 #   rendering it effectively disabled. A recommended value is 10.     #
249 #   A counter is maintained for each user which is reset every        #
250 #   'threshold' seconds and specifying this threshold value with      #
251 #   threshold="X" indicates how often the counter is reset. For       #
252 #   example, with flood="5" and threshold="8", the user may not send  #
253 #   more than 5 lines in 8 secs.                                      #
254 #                                                                     #
255 #   You may optionally specify the sendq size and ping frequency of   #
256 #   each connect:allow line using the pingfreq="X" and sendq="X"      #
257 #   settings as shown in the full example below.                      #
258 #   The ping frequency is specified in seconds, and the sendq size    #
259 #   in bytes. It is recommended, although not enforced, that you      #
260 #   should never set your sendq size to less than 8k. Send Queues are #
261 #   dynamically allocated and can grow as needed up to the maximum    #
262 #   size specified.                                                   #
263 #                                                                     #
264 #   The optional recvq value is the maximum size which users in this  #
265 #   group may grow their receive queue to. This is recommended to be  #
266 #   kept pretty low compared to the sendq, as users will always       #
267 #   receive more than they send in normal circumstances. The default  #
268 #   if not specified is 4096.                                         #
269 #                                                                     #
270 #   The sendq is the data waiting to be sent TO THE USER.             #
271 #   The recvq is the data being received FROM THE USER.               #
272 #   The names sendq and recvq are from the SERVER'S PERSPECTIVE not   #
273 #   that of the user... Just to clear up any confusion or complaints  #
274 #   that these are backwards :p                                       #
275 #                                                                     #
276 #   The localmax and globalmax values can be used to enforce local    #
277 #   and global session limits on connections. The session limits are  #
278 #   counted against all users, but applied only to users within the   #
279 #   class. For example, if you had a class 'A' which has a session    #
280 #   limit of 3, and a class 'B' which has a session limit of 5, and   #
281 #   somehow, two users managed to get into class B which also match   #
282 #   class A, there is only one connection left for this IP now in A,  #
283 #   but if they can connect again to B, there are three. You get the  #
284 #   idea (i hope).                                                    #
285 #                                                                     #
286 #   The optional port value determines which port the connect tag is  #
287 #   handling. If left out the connect tag covers all bound ports else #
288 #   only incoming connections on the specified port will match. Port  #
289 #   tags may be used on connect allow and connect deny tags.          #
290 #                                                                     #
291
292 <connect allow="196.12.*"  password="secret" port="6667">
293
294 <connect allow="*"
295          timeout="60"
296          flood="20"
297          threshold="1"
298          pingfreq="120"
299          sendq="262144"
300          recvq="8192"
301          localmax="3"
302          globalmax="3">
303
304 <connect deny="69.254.*">
305 <connect deny="3ffe::0/32">
306
307
308 #-#-#-#-#-#-#-#-#-#-#-#-  CLASS CONFIGURATION   -#-#-#-#-#-#-#-#-#-#-#-
309 #                                                                     #
310 #   Classes are a group of commands which are grouped together        #
311 #   and given a unique name. They used to define which commands       #
312 #   are available to certain types of Operators.                      #
313 #                                                                     #
314 #  Syntax is as follows:                                              #
315 #                                                                     #
316 #       <class name="name" commands="oper commands">                  #
317 #                                                                     #
318 #    ____                _   _____ _     _       ____  _ _   _        #
319 #   |  _ \ ___  __ _  __| | |_   _| |__ (_)___  | __ )(_) |_| |       #
320 #   | |_) / _ \/ _` |/ _` |   | | | '_ \| / __| |  _ \| | __| |       #
321 #   |  _ <  __/ (_| | (_| |   | | | | | | \__ \ | |_) | | |_|_|       #
322 #   |_| \_\___|\__,_|\__,_|   |_| |_| |_|_|___/ |____/|_|\__(_)       #
323 #                                                                     #
324 #  You are not forced to give these classes the names given below.    #
325 #  You can create your own named classes, if you want, in fact that   #
326 #  is the whole idea of this system!                                  #
327 #                                                                     #
328 #  Note: It is possible to make a class which covers all available    #
329 #  commands. To do this, specify commands="*". This is not really     #
330 #  recommended, as it negates the whole purpose of the class system,  #
331 #  however it is provided for fast configuration (e.g. in test nets)  #
332 #                                                                     #
333
334 <class name="Shutdown" commands="DIE RESTART REHASH LOADMODULE UNLOADMODULE RELOAD">
335 <class name="ServerLink" commands="CONNECT SQUIT RCONNECT MKPASSWD MKSHA256">
336 <class name="BanControl" commands="KILL GLINE KLINE ZLINE QLINE ELINE">
337 <class name="OperChat" commands="WALLOPS GLOBOPS SETIDLE SPYLIST SPYNAMES">
338 <class name="HostCloak" commands="SETHOST SETIDENT SETNAME CHGHOST CHGIDENT">
339
340
341 #-#-#-#-#-#-#-#-#-#-#-#-  OPERATOR COMPOSITION   -#-#-#-#-#-#-#-#-#-#-#
342 #                                                                     #
343 #   This is where you specify which types of operators you have on    #
344 #   your server, as well as the commands they are allowed to use.     #
345 #   This works alongside with the classes specified above.            #
346 #                                                                     #
347 #  type name  - a name for the combined class types                   #
348 #               a type name cannot contain spaces, however if you     #
349 #               put an _ symbol in the name, it will be translated    #
350 #               to a space when displayed in a WHOIS.                 #
351 #                                                                     #
352 #  classes    - specified above, used for flexibility for the         #
353 #               server admin to decide on which operators get         #
354 #               what commands. Class names are case sensitive,        #
355 #               seperate multiple class names with spaces.            #
356 #                                                                     #
357 #  host       - optional hostmask operators will receive on oper-up.  #
358 #                                                                     #
359 #  Syntax is as follows:                                              #
360 #                                                                     #
361 #     <type name="name" classes="class names" host="oper hostmask">   #
362 #                                                                     #
363 #    ____                _   _____ _     _       ____  _ _   _        #
364 #   |  _ \ ___  __ _  __| | |_   _| |__ (_)___  | __ )(_) |_| |       #
365 #   | |_) / _ \/ _` |/ _` |   | | | '_ \| / __| |  _ \| | __| |       #
366 #   |  _ <  __/ (_| | (_| |   | | | | | | \__ \ | |_) | | |_|_|       #
367 #   |_| \_\___|\__,_|\__,_|   |_| |_| |_|_|___/ |____/|_|\__(_)       #
368 #                                                                     #
369 #  You are not forced to give these types the names given below.      #
370 #  You can create your own named types, if you want, in fact that     #
371 #  is the whole idea of this system!                                  #
372 #                                                                     #
373
374 <type name="NetAdmin" classes="OperChat BanControl HostCloak Shutdown ServerLink" host="netadmin.omega.org.za">
375 <type name="GlobalOp" classes="OperChat BanControl HostCloak ServerLink" host="ircop.omega.org.za">
376 <type name="Helper" classes="HostCloak" host="helper.omega.org.za">
377
378
379 #-#-#-#-#-#-#-#-#-#-#-  OPERATOR CONFIGURATION   -#-#-#-#-#-#-#-#-#-#-#
380 #                                                                     #
381 #   Opers are defined here. This is a very important section.         #
382 #   Remember to only make operators out of truthworthy people.        #
383 #                                                                     #
384 #  name        - oper name, This is case sensitive, so it is best to  #
385 #                use lower-case.                                      #
386 #                                                                     #
387 #  password    - password to oper-up, also case sensitive.            #
388 #                encryption is supported via modules. You may load    #
389 #                modules for MD5 or SHA256 encryption, and if you do, #
390 #                this value will be a hash value, otherwise put a     #
391 #                plaintext password in this value.                    #
392 #                                                                     #
393 #  host        - hosts of client allowed to oper-up.                  #
394 #                wildcards accepted, seperate multiple hosts with a   #
395 #                space. You may also specify CIDR ip addresses.       #
396 #                                                                     #
397 #  fingerprint - When using the m_ssl_oper_cert.so module, you may    #
398 #                specify a key fingerprint here. This can be obtained #
399 #                using the /fingerprint command whilst the module is  #
400 #                loaded, or from the notice given to you when you     #
401 #                connect to the ircd using a client certificate,      #
402 #                and will lock this oper block to only the user who   #
403 #                has that specific key/certificate pair.              #
404 #                This enhances security a great deal, however it      #
405 #                requires that opers use clients which can send ssl   #
406 #                client certificates, if this is configured for that  #
407 #                oper. Note that if the m_ssl_oper.so module is not   #
408 #                loaded, and/or one of m_ssl_openssl or m_ssl_gnutls  #
409 #                is not loaded, this configuration option has no      #
410 #                effect and will be ignored.                          #
411 #                                                                     #
412 #  type        - Defines the kind of operator. This must match a type #
413 #                tag you defined above, and is case sensitive.        #
414 #                                                                     #
415 #  Syntax is as follows:                                              #
416 #       <oper name="login"                                            #
417 #             password="pass"                                         #
418 #             host="hostmask@of.oper"                                 #
419 #           fingerprint="hexsequence"                               #
420 #             type="oper type">                                       #
421 #                                                                     #
422
423 <oper name="Brain"
424       password="s3cret"
425       host="ident@dialup15.isp.com *@localhost *@server.com *@3ffe::0/16"
426       type="NetAdmin">
427
428
429 #-#-#-#-#-#-#-#-#-#-#-  SERVER LINK CONFIGURATION  -#-#-#-#-#-#-#-#-#-#
430 #                                                                     #
431 # Defines which servers can link to this one, and which servers this  #
432 # server may create outbound links to.                                #
433 #                                                                     #
434 # name        -   The name is the canocial name of the server, does   #
435 #                 not have to resolve - but it is expected to be set  #
436 #                 in the remote servers connection info.              #
437 #                                                                     #
438 # ipaddr      -   Valid host or ip address for remote server. These   #
439 #                 hosts are resolved on rehash, and cached, if you    #
440 #                 specify a hostname, so if you find that your server #
441 #                 is still trying to connect to an old IP after you   #
442 #                 have updated your dns, try rehashing and then       #
443 #                 attempting the connect again.                       #
444 #                                                                     #
445 # port        -   The TCP port for the remote server.                 #
446 #                                                                     #
447 # sendpass    -   Password to send to create an outbound connection   #
448 #                 to this server.                                     #
449 #                                                                     #
450 # recvpass    -   Password to receive to accept an inbound connection #
451 #                 from this server.                                   #
452 #                                                                     #
453 # autoconnect -   Sets the server to autoconnect. Where x is the num. #
454 # (optional)      of seconds between attempts. e.g. 300 = 5 minutes.  #
455 #                                                                     #
456 # transport     - If defined, this is a transport name implemented by #
457 #                 another module. Transports are layers on top of     #
458 #                 plaintext connections, which alter them in certain  #
459 #                 ways. Currently the three supported transports are  #
460 #                 'openssl' and 'gnutls' which are types of SSL       #
461 #                 encryption, and 'zip' which is for compression.     #
462 #                 If you define a transport, both ends of the         #
463 #                 connection must use a compatible transport for the  #
464 #                 link to succeed. OpenSSL and GnuTLS are link-       #
465 #                 compatible with each other.                         #
466 #                                                                     #
467 # statshidden   - When using m_spanningtree.so for linking. you may   #
468 #                 set this to 'yes', and if you do, the IP address/   #
469 #                 hostname of this connection will NEVER be shown to  #
470 #                 any opers on the network. In /STATS c its address   #
471 #                 will show as *@<hidden>, and during CONNECT and     #
472 #                 inbound connections, its IP will show as <hidden>   #
473 #                 UNLESS the connection fails (e.g. due to a bad      #
474 #                 password or servername)                             #
475 #                                                                     #
476 # allowmask     - When this is defined, it indicates a range of IP    #
477 #                 addresses to allow for this link (You may use CIDR  #
478 #                 or wildcard form for this address).                 #
479 #                 e.g. if your server is going to connect to you from #
480 #                 the range 1.2.3.1 through 1.2.3.255, put 1.2.3.0/24 #
481 #                 into this value. If it is not defined, then only    #
482 #                 the ipaddr field of the server shall be allowed.    #
483 #                                                                     #
484 # failover      - If you define this option, it must be the name of a #
485 #                 different link tag in your configuration. This      #
486 #                 option causes the ircd to attempt a connection to   #
487 #                 the failover link in the event that the connection  #
488 #                 to this server fails. For example, you could define #
489 #                 two hub uplinks to a leaf server, and set an        #
490 #                 american server to autoconnect, with a european     #
491 #                 hub as its failover. In this situation, your ircd   #
492 #                 will only try the link to the european hub if the   #
493 #                 american hub is unreachable. NOTE that for the      #
494 #                 intents and purposes of this option, an unreachable #
495 #                 server is one which DOES NOT ANSWER THE CONNECTION. #
496 #                 If the server answers the connection with accept(), #
497 #                 EVEN IF THE CREDENTIALS ARE INVALID, the failover   #
498 #                 link will not be tried! Failover settings will also #
499 #                 apply to autoconnected servers as well as manually  #
500 #                 connected ones.                                     #
501 #                                                                     #
502 # timeout       - If this is defined, then outbound connections will  #
503 #                 time out if they are not connected within this many #
504 #                 seconds. If this is not defined, the default of ten #
505 #                 seconds is used.                                    #
506 #                                                                     #
507 # bind          - If you specify this value, then when creating an    #
508 #                 outbound connection to the given server, the IP you #
509 #                 place here will be bound to. This is for multi-     #
510 #                 homed servers which may have multiple IP addresses. #
511 #                 If you do not define this value, the first IP that  #
512 #                 is not empty or localhost from your <bind> tags     #
513 #                 will be bound to. This is usually acceptable,       #
514 #                 however if your server has multiple network cards   #
515 #                 then you may have to manually specify the bind      #
516 #                 value instead of leaving it to automatic binding.   #
517 #                 You can usually tell if you need to set this by     #
518 #                 looking for the error 'Could not assign requested   #
519 #                 address' in your log when connecting to servers.    #
520 #                                                                     #
521 # hidden        - If this is set to true, yes, or 1, then the server  #
522 #                 is completely hidden from non-opers. It does not    #
523 #                 show in LINKS and it does not show in MAP. Also,    #
524 #                 any servers which are child servers of this one     #
525 #                 in the network will *also* be hidden. Use with      #
526 #                 care! You can use this to 'mask off' sections of    #
527 #                 the network so that users only see a small portion  #
528 #                 of a much larger net. It should NOT be relied upon  #
529 #                 as a security tool, unless it is being used for     #
530 #                 example to hide a non-client hub, for which clients #
531 #                 do not have an IP address or resolvable hostname.   #
532 #                                                                     #
533 # to u:line a server (give it extra privilages required for running   #
534 # services, Q, etc) you must include the <uline server> tag as shown  #
535 # in the example below. You can have as many of these as you like.    #
536 #                                                                     #
537 # WARNING: Unlike other ircds, u:lining a server allows ALL users on  #
538 # that server to operoverride modes. This should only be used for     #
539 # services and protected oper servers!                                #
540 #                                                                     #
541 # ------------------------------------------------------------------- #
542 #                                                                     #
543 # NOTE: If you have built your server as an ipv6 server, then when a  #
544 # DNS lookup of a server's host occurs, AAAA records (ipv6) are       #
545 # priorotized over A records (ipv4). Therefore, if the server you are #
546 # connecting to has both an IPV6 ip address and an IPV4 ip address in #
547 # its DNS entry, the IPV6 address will *always* be selected. To       #
548 # change this behaviour simply specify the IPV4 IP address rather     #
549 # than the hostname of the server.                                    #
550 #                                                                     #
551 # ------------------------------------------------------------------- #
552 #                                                                     #
553 #    ____                _   _____ _     _       ____  _ _   _        #
554 #   |  _ \ ___  __ _  __| | |_   _| |__ (_)___  | __ )(_) |_| |       #
555 #   | |_) / _ \/ _` |/ _` |   | | | '_ \| / __| |  _ \| | __| |       #
556 #   |  _ <  __/ (_| | (_| |   | | | | | | \__ \ | |_) | | |_|_|       #
557 #   |_| \_\___|\__,_|\__,_|   |_| |_| |_|_|___/ |____/|_|\__(_)       #
558 #                                                                     #
559 #  If you want to link servers to InspIRCd you must load the          #
560 #  m_spanningtree module! Please see the modules list below for       #
561 #  information on how to load this module! If you do not load this    #
562 #  module, server links will NOT work!                                #
563 #                                                                     #
564 #  Also, if you define any transports, you must load the modules for  #
565 #  these transports BEFORE you load m_spanningtree, e.g. place them   #
566 #  above it in the configuration file. Currently this means the three #
567 #  modules m_ssl_gnutls, m_ziplinks and m_ssl_openssl, depending on   #
568 #  which you choose to use.                                           #
569 #                                                                     #
570
571 <link name="hub.penguin.org"
572       ipaddr="penguin.box.com"
573       port="7000"
574       allowmask="69.58.44.0/24"
575       autoconnect="300"
576       failover="hub.other.net"
577       timeout="15"
578       transport="gnutls"
579       bind="1.2.3.4"
580       statshidden="no"
581       hidden="no"
582       sendpass="outgoing!password"
583       recvpass="incoming!password">
584
585 <link name="services.antarctic.com"
586       ipaddr="localhost"
587       port="7000"
588       allowmask="127.0.0.0/8"
589       sendpass="penguins"
590       recvpass="polarbears">
591
592
593 #-#-#-#-#-#-#-#-#-#-#-#- ULINES CONFIGURATION #-#-#-#-#-#-#-#-#-#-#-#-#
594 # This tag defines a ulined server. A U-Lined server has special      #
595 # permissions, and should be used with caution. Services servers are  #
596 # usually u-lined in this manner.                                     #
597 #                                                                     #
598 # The 'silent' value if set to yes indicates that this server should  #
599 # not generate quit and connect notices, which can cut down on noise  #
600 # to opers on the network.                                            #
601 #                                                                     #
602 <uline server="services.antarctic.com" silent="yes">
603
604
605 #-#-#-#-#-#-#-#-#-#-  MISCELLANEOUS CONFIGURATION  -#-#-#-#-#-#-#-#-#-#
606 #                                                                     #
607 #   These options let you define the path to your motd and rules      #
608 #   files. If these are relative paths, they are relative to the      #
609 #   configurtion directory.                                           #
610 #                                                                     #
611
612 <files motd="inspircd.motd.example"
613        rules="inspircd.rules.example">
614
615 #-#-#-#-#-#-#-#-#-#-#-# MAXIMUM CHANNELS -#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
616 #                                                                     #
617 # This optional configuration tag lets you define the maximum number  #
618 # of channels that both opers and users may be on at any one time.    #
619 # the default is 20 for user and 60 for opers if this tag is not      #
620 # defined. Remote users are not restricted in any manner.             #
621 #                                                                     #
622
623 <channels users="20"
624           opers="60">
625
626 #-#-#-#-#-#-#-#-#-#-#-#-#-#-# DNS SERVER -#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
627 #                                                                     #
628 # Define your DNS server address here. InspIRCd has its own resolver. #
629 # If you do not define this value, then then InspIRCd will attempt to #
630 # determine your DNS server from your operating system. On POSIX      #
631 # platforms, InspIRCd will read /etc/resolv.conf, and populate this   #
632 # value with the first DNS server address found. On Windows platforms #
633 # InspIRCd will check the registry, and use the DNS server of the     #
634 # first active network interface, if one exists.                      #
635 # If a DNS server cannot be determined from these checks, the default #
636 # value '127.0.0.1' is used instead. The timeout value is in seconds. #
637 #                                                                     #
638 #    ____                _   _____ _     _       ____  _ _   _        #
639 #   |  _ \ ___  __ _  __| | |_   _| |__ (_)___  | __ )(_) |_| |       #
640 #   | |_) / _ \/ _` |/ _` |   | | | '_ \| / __| |  _ \| | __| |       #
641 #   |  _ <  __/ (_| | (_| |   | | | | | | \__ \ | |_) | | |_|_|       #
642 #   |_| \_\___|\__,_|\__,_|   |_| |_| |_|_|___/ |____/|_|\__(_)       #
643 #                                                                     #
644 # When choosing a server, be sure to choose one which will do a       #
645 # RECURSIVE LOOKUP. InspIRCd's resolver does not currently do these   #
646 # recursive lookups itself, to save time and resources. The dns       #
647 # server recommended by the InspIRCd team is bind, available from the #
648 # ISC website. If your DNS server does not do a recursive lookup, you #
649 # will be able to notice this by the fact that none of your users are #
650 # resolving even though the DNS server appears to be up! Most ISP and #
651 # hosting provider DNS servers support recursive lookups.             #
652 #                                                                     #
653 # ------------------------------------------------------------------- #
654 #                                                                     #
655 # NOTE: if you have built InspIRCd with IPV6 support, then both       #
656 # ipv6 and ipv4 addresses are allowed here, and also in the system    #
657 # resolv.conf file. Remember that an ipv4 dns server can still        #
658 # resolve ipv6 addresses, and vice versa.                             #
659 #                                                                     #
660
661 <dns server="127.0.0.1" timeout="5">
662
663 # An example of using an IPV6 nameserver
664 #<dns server="::1" timeout="5">
665
666 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#  PID FILE  -#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
667 #                                                                     #
668 # Define the path to the PID file here. The PID file can be used to   #
669 # rehash the ircd from the shell or to terminate the ircd from the    #
670 # shell using shell scripts, perl scripts etc, and to monitor the     #
671 # ircd's state via cron jobs. If this is a relative path, it will be  #
672 # relative to the configuration directory, and if it is not defined,  #
673 # the default of 'inspircd.pid' is used.                              #
674 #                                                                     #
675
676 #<pid file="/path/to/inspircd.pid">
677
678 #-#-#-#-#-#-#-#-#-#-#-#-#- BANLIST LIMITS #-#-#-#-#-#-#-#-#-#-#-#-#-#-#
679 #                                                                     #
680 # Use these tags to customise the ban limits on a per channel basis.  #
681 # the tags are read from top to bottom, and any tag found which       #
682 # matches the channels name applies the banlimit to that channel.     #
683 # It is advisable to put an entry with the channel as '*' at the      #
684 # bottom of the list. If none are specified or no maxbans tag is      #
685 # matched, the banlist size defaults to 64 entries.                   #
686 #                                                                     #
687
688 <banlist chan="#morons" limit="128">
689 <banlist chan="*" limit="69">
690
691 #-#-#-#-#-#-#-#-#-#-#-  DISABLED COMMANDS  -#-#-#-#-#-#-#-#-#-#-#-#-#-#
692 #                                                                     #
693 # This tag is optional, and specifies one or more commands which are  #
694 # not available to non-operators. For example you may wish to disable #
695 # NICK and prevent non-opers from changing their nicknames.           #
696 # Note that any disabled commands take effect only after the user has #
697 # 'registered' (e.g. after the initial USER/NICK/PASS on connection)  #
698 # so for example disabling NICK will not cripple your network.        #
699 #                                                                     #
700
701 #<disabled commands="TOPIC MODE">
702
703
704 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-  RTFM LINE  -#-#-#-#-#-#-#-#-#-#-#-#-#-#
705 #                                                                     #
706 #   Just remove this... Its here to make you read ALL of the config   #
707 #   file options ;)                                                   #
708
709 <die value="You should probably edit your config *PROPERLY* and try again.">
710
711
712
713 #-#-#-#-#-#-#-#-#-#-#-#-#-  SERVER OPTIONS   -#-#-#-#-#-#-#-#-#-#-#-#-#
714 #                                                                     #
715 #   Settings to define which features are useable on your server.     #
716 #                                                                     #
717 #  prefixquit    - A prefix to be placed on the start of a client's   #
718 #                  quit message                                       #
719 #                                                                     #
720 #  suffixquit    - A suffix to be placed on the end of a client's     #
721 #                  quit message.                                      #
722 #                                                                     #
723 #  fixedquit     - A fixed quit message to display for all client     #
724 #                  QUITS. If specified, overrides both prefixquit     #
725 #                  and suffixquit options.                            #
726 #                                                                     #
727 #  loglevel      - specifies what detail of messages to log in the    #
728 #                  log file. You may select from debug, verbose,      #
729 #                  default, sparse and none.                          #
730 #                                                                     #
731 #  allowhalfop   - allows the +h channel mode                         #
732 #                                                                     #
733 #  noservices    - If noservices is true, yes, or 1, then the first   #
734 #                  user into a channel gets founder status. This is   #
735 #                  only useful on networks running the m_chanprotect  #
736 #                  module without services.                           #
737 #                                                                     #
738 #  qaprefixes    - If qaprefixes is true, yes, or 1, then users       #
739 #                  with +q or +a will get the ~ or & prefixes         #
740 #                  used in unreal. This is only useful on networks    #
741 #                  running the m_chanprotect module                   #
742 #                                                                     #
743 #  deprotectself - If this value is set to yes, true, or 1, then any  #
744 #                  user with +q or +a may remove the +q or +a from    #
745 #                  themselves. The default setting is to not enable   #
746 #                  this feature, which stops even the founder taking  #
747 #                  away their founder status without using services.  #
748 #                                                                     #
749 #  deprotectothers-If this value is set to yes, true, or 1, then any  #
750 #                  user with +q or +a may remove the +q or +a from    #
751 #                  other users. The default setting is to not enable  #
752 #                  this feature, so that only +q may remove +a, and   #
753 #                  nothing but services may remove +q.                #
754 #                                                                     #
755 #  cyclehosts    - If this is set to true, yes or 1, then when a      #
756 #                  user's hostname changes, they will appear to quit  #
757 #                  and then rejoin with their new host. This prevents #
758 #                  clients from being confused by host changes,       #
759 #                  especially in the case of bots, and it is          #
760 #                  recommended that this option is enabled.           #
761 #                                                                     #
762 #  netbuffersize - size of the buffer used to receive data from       #
763 #                  clients. The ircd may only read() this amount      #
764 #                  of text in one go at any time. (OPTIONAL)          #
765 #                                                                     #
766 #  maxwho        - The maximum number of results returned by a /WHO   #
767 #                  query. This is to prevent /WHO being used as a     #
768 #                  spam vector or means of flooding an ircd. The      #
769 #                  default is 128, it is not recommended to raise it  #
770 #                  above 1024. Values up to 65535 are permitted. If   #
771 #                  this value is omitted, any size WHO is allowed by  #
772 #                  anyone.                                            #
773 #                                                                     #
774 #  somaxconn     - The maximum number of sockets that may be waiting  #
775 #                  in the accept queue. This usually allows the ircd  #
776 #                  to soak up more connections in a shorter space of  #
777 #                  time when increased but please be aware there is a #
778 #                  system defined maximum value to this, the same way #
779 #                  there is a system defined maximum number of file   #
780 #                  descriptors. Some systems may only allow this to   #
781 #                  be up to 5 (ugh) while others such as FreeBSD will #
782 #                  default to a much nicer 128.                       #
783 #                                                                     #
784 #  moduledir     - This optional value indicates a runtime change of  #
785 #                  the location where modules are to be found. This   #
786 #                  does not add a supplementary directory. There can  #
787 #                  only be one module path.                           #
788 #                                                                     #
789 #  softlimit     - This optional feature allows a defined softlimit.  #
790 #                  if defined sets a soft maxconnections value, has   #
791 #                  to be less than the ./configure maxclients         #
792 #                                                                     #
793 #  userstats     - The userstats field is optional and specifies      #
794 #                  which stats characters in /STATS may be requested  #
795 #                  by non-operators. Stats characters in this field   #
796 #                  are case sensitive and are allowed to users        #
797 #                  independent of if they are in a module or the core #
798 #                                                                     #
799 #  operspywhois  - If this is set then when an IRC operator uses      #
800 #                  /WHOIS on a user they will see all channels, even  #
801 #                  ones if channels are secret (+s), private (+p) or  #
802 #                  if the target user is invisible +i.                #
803 #                                                                     #
804 #  customversion - If you specify this configuration item, and it is  #
805 #                  not set to an empty value, then when a user does   #
806 #                  a /VERSION command on the ircd, this string will   #
807 #                  be displayed as the second portion of the output,  #
808 #                  replacing the system 'uname', compile flags and    #
809 #                  socket engine/dns engine names. You may use this   #
810 #                  to enhance security, or simply for vanity.         #
811 #                                                                     #
812 #  maxtargets    - The maxtargets field is optional, and if not       #
813 #                  defined, defaults to 20. It indicates the maximum  #
814 #                  number of targets which may be given to commands   #
815 #                  such as PRIVMSG, KICK etc.                         #
816 #                                                                     #
817 #  hidesplits    - When set to 'yes', will hide split server names    #
818 #                  from non-opers. Non-opers will see '*.net *.split' #
819 #                  instead of the server names in the quit message,   #
820 #                  identical to the way IRCu displays them.           #
821 #                                                                     #
822 #  hidebans      - When set to 'yes', will hide gline, kline, zline   #
823 #                  and qline quit messages from non-opers. For        #
824 #                  example, user A who is not an oper will just see   #
825 #                  (G-Lined) while user B who is an oper will see the #
826 #                  text (G-Lined: Reason here) instead.               #
827 #                                                                     #
828 #  hidewhois     - When defined with a non-empty value, the given     #
829 #                  text will be used in place of the user's server    #
830 #                  in WHOIS, when a user is WHOISed by a non-oper.    #
831 #                  For example, most nets will want to set this to    #
832 #                  something like '*.netname.net' to conceal the      #
833 #                  actual server the user is on.                      #
834 #                                                                     #
835 #  flatlinks     - When you are using m_spanningtree.so, and this     #
836 #                  value is set to true, yes or 1, /MAP and /LINKS    #
837 #                  will be flattened when shown to a non-oper.        #
838 #                                                                     #
839 #  hideulines    - When you are using m_spanningtree.so, and this     #
840 #                  value is set to true, yes or 1, then U-lined       #
841 #                  servers will be hidden in /LINKS and /MAP. For non #
842 #                  opers. Please be aware that this will also hide    #
843 #                  any leaf servers of a U-lined server, e.g. jupes.  #
844 #                                                                     #
845 #  nouserdns     - If set to 'yes', 'true' or '1', no user dns        #
846 #                  lookups will be performed for connecting users.    #
847 #                  this can save a lot of resources on very busy irc  #
848 #                  servers.                                           #
849 #                                                                     #
850 #  syntaxhints   - If set to 'yes', 'true' or '1', when a user does   #
851 #                  not give enough parameters for a command, a syntax #
852 #                  hint will be given (using the RPL_TEXT numeric)    #
853 #                  as well as the standard ERR_NEEDMOREPARAMS.        #
854 #                                                                     #
855 #  announcets    - If this value is defined to 'yes', 'true' or '1',  #
856 #                  then if a channel's timestamp is updated the users #
857 #                  on the channel will be informed of the change via  #
858 #                  a server notice to the channel with the old and    #
859 #                  new TS values in the timestamp. If you think this  #
860 #                  is just pointless noise, define the value to 0.    #
861 #                                                                     #
862 #  ircumsgprefix - Use undernet style message prefix for channel      #
863 #                  NOTICE and PRIVMSG adding the prefix to the line   #
864 #                  of text sent out. Eg. NOTICE @#test :@ testing     #
865 #                  vs. the off setting: NOTICE @#test :testing        #
866 #                                                                     #
867 #  hostintopic   - If this is set to yes (the default) then the full  #
868 #                  nick!user@host is shown for who set a TOPIC last.  #
869 #                  if set to no, then only the nickname is shown.     #
870 #                                                                     #
871 # announceinvites                                                     #
872 #                - If this option is set, then invites are announced  #
873 #                  to the channel when a user invites annother user.  #
874 #                  If you consider this to be unnecessary noise,      #
875 #                  set this to 'none'. To announce to all ops, set    #
876 #                  this to 'ops' and to announce to all users set the #
877 #                  value to 'all'.                                    #
878 #                                                                     #
879 #                  The value 'dynamic' varies between 'ops' and 'all' #
880 #                  settings depending on if the channel is +i or not. #
881 #                  When the channel is +i, messages go only to ops,   #
882 #                  and when the channel is not +i, messages go to     #
883 #                  everyone. In short, the messages will go to every  #
884 #                  user who has power of INVITE on the channel. This  #
885 #                  is the recommended setting.                        #
886 #                                                                     #
887 #  disablehmac   - If you are linking your InspIRCd to older versions #
888 #                  then you can specify this option and set it to     #
889 #                  yes. 1.1.6 and above support HMAC and challenge-   #
890 #                  response for password authentication. These can    #
891 #                  greatly enhance security of your server to server  #
892 #                  connections when you are not using SSL (as is the  #
893 #                  case with a lot of larger networks). Linking to    #
894 #                  older versions of InspIRCd should not *usually* be #
895 #                  a problem, but if you have problems with HMAC      #
896 #                  authentication, this option can be used to turn it #
897 #                  off.                                               #
898 #                                                                     #
899 #  hidemodes     - If this option is enabled, then the listmodes      #
900 #                  given (e.g. +eI), will be hidden from users below  #
901 #                  halfop. This is not recommended to be set on mode  #
902 #                  +b, as it may break some features in popular       #
903 #                  clients such as mIRC.                              #
904 #                                                                     #
905 #  quietbursts   - When synching or splitting from the network, a     #
906 #                  server can generate a lot of connect and quit      #
907 #                  snotices to the +C and +Q snomasks. Setting this   #
908 #                  value to yes squelches those messages, which can   #
909 #                  make them more useful for opers, however it will   #
910 #                  degrade their use by certain third party programs  #
911 #                  such as BOPM which rely on them to scan users when #
912 #                  a split heals in certain configurations.           #
913 #                                                                     #
914 #  serverpingfreq- This value, when set, allows you to change the     #
915 #                  frequency of server to server PING messages. This  #
916 #                  can help if you are having certain network issues. #
917 #                                                                     #
918 #  pingwarning   - This should be set to a number between 1 and 59 if #
919 #                  defined, and if it is defined will cause the server#
920 #                  to send out a warning via snomask +l if a server   #
921 #                  does not answer to PING after this many seconds.   #
922 #                  This can be useful for finding servers which are   #
923 #                  at risk of pinging out due to network issues.      #
924 #                                                                     #
925 #  exemptchanops - This option allows channel operators to be exempted#
926 #                  from certain channel modes.                        #
927 #                  Supported modes are +SfFgNc. Defaults to off.      #
928 #                                                                     #
929 #  defaultmodes  - The default modes to be given to each channel on   #
930 #                  creation. Defaults to 'nt'. There should be no +   #
931 #                  or - symbols in this sequence, if you add them     #
932 #                  they will be ignored. You may add parameters for   #
933 #                  parameterised modes.                               #
934 #                                                                     #
935 #  moronbanner   - The NOTICE to show to users who are glined, zlined #
936 #                  klined or qlined when they are disconnected. This  #
937 #                  is totally freeform, you may place any text here   #
938 #                  you wish.                                          #
939 #                                                                     #
940
941 <options prefixquit="Quit: "
942          loglevel="default"
943          netbuffersize="10240"
944          maxwho="128"
945          noservices="no"
946          qaprefixes="no"
947          deprotectself="no"
948          deprotectothers="no"
949          somaxconn="128"
950          softlimit="12800"
951          userstats="Pu"
952          operspywhois="no"
953          customversion=""
954          maxtargets="20"
955          hidesplits="no"
956          hidebans="no"
957          hidewhois=""
958          flatlinks="no"
959          hideulines="no"
960          nouserdns="no"
961          syntaxhints="no"
962          cyclehosts="yes"
963          ircumsgprefix="no"
964          announcets="yes"
965          disablehmac="no"
966          hostintopic="yes"
967          hidemodes="eI"
968          quietbursts="yes"
969          pingwarning="15"
970          serverpingfreq="60"
971          allowhalfop="yes"
972          defaultmodes="nt"
973          announceinvites="dynamic"
974          moronbanner="You're banned! Email haha@abuse.com with the ERROR line below for help."
975          exemptchanops="">
976
977 #-#-#-#-#-#-#-#-#-#-#-#-#-#- TIME SYNC OPTIONS -#-#-#-#-#-#-#-#-#-#-#-#
978 # Time sychronization options for m_spanningtree linking.             #
979 #                                                                     #
980 # Because IRC is very time and clock dependent, InspIRCd provides its #
981 # own methods for syncronization of time between servers as shown     #
982 # in the example below, for servers that don't have ntpd running.     #
983 #                                                                     #
984 #  enable    -     If this value is 'yes', 'true', or '1', time       #
985 #                  synchronization is enabled on this server. This    #
986 #                  means any servers you are linked to will           #
987 #                  automatically synchronize time, however you should #
988 #                  use ntpd instead where possible, NOT this option.  #
989 #                                                                     #
990 #  master    -     If this value is set to yes, then this server will #
991 #                  act as the authoritative time source for the whole #
992 #                  network. All other servers will respect its time   #
993 #                  without question, and match their times to it.     #
994 #                  only one server should have the master value set   #
995 #                  to 'yes'.                                          #
996 #                                                                     #
997 <timesync enable="no" master="no">
998
999 #-#-#-#-#-#-#-#-#-#-#-#-#-  WHOWAS OPTIONS   -#-#-#-#-#-#-#-#-#-#-#-#-#
1000 #                                                                     #
1001 # This tag lets you define the behaviour of the /whowas command of    #
1002 # your server.                                                        #
1003 #                                                                     #
1004 # groupsize      - Controls the maximum entries per nick shown when   #
1005 #                  performing a /whowas nick. Setting this to 0 dis-  #
1006 #                  ables whowas completely.                           #
1007 #                                                                     #
1008 # maxgroups      - The maximum number of nickgroups that can be added #
1009 #                  to the list. If max is reached, oldest group will  #
1010 #                  be deleted first like a FIFO. A groupsize of 3 and #
1011 #                  a maxgroups of 5000 will allow for 5000 nicks to   #
1012 #                  be stored with a history of 3, thus giving a total #
1013 #                  of 3 * 5000 = 15000 entries. A setting of 0 dis-   #
1014 #                  ables whowas completely.                           #
1015 #                                                                     #
1016 # maxkeep        - The maximum time a nick is kept in the whowas list #
1017 #                  before being pruned. Time may be specified in      #
1018 #                  seconds, or in the following format: 1y2w3d4h5m6s  #
1019 #                  meaning one year, two weeks, three days, 4 hours,  #
1020 #                  5 minutes and 6 seconds. All fields in this format #
1021 #                  are optional. Minimum is 1 hour, if less InspIRCd  #
1022 #                  will default back to 1 hour.                       #
1023 #                                                                     #
1024 #<whowas groupsize="10"                                               #
1025 #        maxgroups="100000"                                           #
1026 #        maxkeep="3d">                                                #
1027
1028
1029 #-#-#-#-#-#-#-#-#-#-#-#-#-  MODULE OPTIONS   -#-#-#-#-#-#-#-#-#-#-#-#-#
1030 #                                                                     #
1031 #  These tags define which modules will be loaded on startup by your  #
1032 #  server. Add modules without any paths. When you make your ircd     #
1033 #  using the 'make' command, all compiled modules will be moved into  #
1034 #  the folder you specified when you ran ./configure. The module tag  #
1035 #  automatically looks for modules in this location.                  #
1036 #  If you attempt to load a module outside of this location, either   #
1037 #  in the config, or via /LOADMODULE, you will receive an error.      #
1038 #                                                                     #
1039 #  By default, ALL modules are commented out. You must uncomment them #
1040 #  or add lines to your config to load modules. Please refer to       #
1041 #  http://www.inspircd.org/wiki/Modules_List for a list of modules and#
1042 #  each modules link for any additional conf tags they require.       #
1043 #                                                                     #
1044 #  You may use wildcards in a <module> tag to load all modules which  #
1045 #  match a glob pattern (e.g. m_sa????.so would load m_sajoin,        #
1046 #  m_sapart, m_saquit and m_sanick)                                   #
1047 #                                                                     #
1048 #    ____                _   _____ _     _       ____  _ _   _        #
1049 #   |  _ \ ___  __ _  __| | |_   _| |__ (_)___  | __ )(_) |_| |       #
1050 #   | |_) / _ \/ _` |/ _` |   | | | '_ \| / __| |  _ \| | __| |       #
1051 #   |  _ <  __/ (_| | (_| |   | | | | | | \__ \ | |_) | | |_|_|       #
1052 #   |_| \_\___|\__,_|\__,_|   |_| |_| |_|_|___/ |____/|_|\__(_)       #
1053 #                                                                     #
1054 # To link servers to InspIRCd, you MUST load the m_spanningtree       #
1055 # module, as shown below. If you DO NOT do this, server links will    #
1056 # NOT work at all. ie. The ports will NOT bind, and /connect will not #
1057 # work properly. This is by design, to allow for the implementation   #
1058 # of other linking protocols in modules in the future.                #
1059
1060 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1061 # Spanning Tree module - allows linking of servers using the spanning
1062 # tree protocol (see the READ THIS BIT section above).
1063 #
1064 #<module name="m_spanningtree.so">
1065
1066
1067 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1068 # MD5 Module - Allows other modules to generate MD5 hashes, usually for
1069 # cryptographic uses and security.
1070 #
1071 # IMPORTANT:
1072 # Other modules such as m_cloaking.so and m_opermd5.so may rely on
1073 # this module being loaded to function.
1074 #
1075 #<module name="m_md5.so">
1076 #
1077 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1078 # SHA256 Module - Allows other modules to generate SHA256 hashes,
1079 # usually for cryptographic uses and security.
1080 #
1081 # IMPORTANT:
1082 # Other modules such as m_opermd5.so may rely on this module being
1083 # loaded to function.
1084 #
1085 #<module name="m_sha256.so">
1086
1087 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1088 # Alias module: Allows you to define server-side command aliases
1089 #<module name="m_alias.so">
1090 #
1091 #-#-#-#-#-#-#-#-#-#-#-  ALIAS DEFINITIONS  -#-#-#-#-#-#-#-#-#-#-#-#-#-#
1092 #                                                                     #
1093 # If you have the m_alias.so module loaded, you may also define       #
1094 # aliases as shown below. They are commonly used to provide shortcut  #
1095 # commands to services, however they are not limited to just this use.#
1096 # An alias tag requires the following values to be defined in it:     #
1097 #                                                                     #
1098 # text        -      The text to detect as the actual command line,   #
1099 #                    Cant contain spaces, but case insensitive.       #
1100 #                    You may have multiple aliases with the same      #
1101 #                    command name (text="" value), however the first  #
1102 #                    found will be executed if its format value is    #
1103 #                    matched, or it has no format value. Aliases are  #
1104 #                    read from the top of the file to the bottom.     #
1105 #                                                                     #
1106 # format      -      If this is defined, the parameters of the alias  #
1107 #                    must match this glob pattern. For example if you #
1108 #                    want the first parameter to start with a # for   #
1109 #                    the alias to be executed, set format="#*" in the #
1110 #                    alias definition. Note that the :'s which are    #
1111 #                    part of IRC formatted lines will be preserved    #
1112 #                    for matching of this text. This value is         #
1113 #                    optional.                                        #
1114 #                                                                     #
1115 # replace     -      The text to replace 'text' with. Usually this    #
1116 #                    will be "PRIVMSG ServiceName :$2-" or similar.   #
1117 #                    You may use the variables $1 through $9 in the   #
1118 #                    replace string, which refer to the first through #
1119 #                    ninth word in the original string typed by the   #
1120 #                    user. You may also use $1- through $9- which     #
1121 #                    refer to the first word onwards, through to the  #
1122 #                    ninth word onwards, e.g. if the user types the   #
1123 #                    command "foo bar baz qux quz" then $3- will hold #
1124 #                    "baz qux quz" and $2 will contain "bar". You may #
1125 #                    also use the special variables: $nick, $ident,   #
1126 #                    $host and $vhost, and you may seperate multiple  #
1127 #                    commands with \n. If you wish to use the ACTUAL  #
1128 #                    characters \ and n together in a line, you must  #
1129 #                    use the sequence "\\n".                          #
1130 #                                                                     #
1131 # requires    -      If you provide a value for 'requires' this means #
1132 #                    the given nickname MUST be online for the alias  #
1133 #                    to successfully trigger. If they are not, then   #
1134 #                    the user receives a 'no such nick' 401 numeric.  #
1135 #                                                                     #
1136 # uline       -      Defining this value with 'yes', 'true' or '1'    #
1137 #                    will ensure that the user given in 'requires'    #
1138 #                    must also be on a u-lined server, as well as     #
1139 #                    actually being on the network. If the user is    #
1140 #                    online, but not on a u-lined server, then an     #
1141 #                    oper-alert is sent out as this is possibly signs #
1142 #                    of a user trying to impersonate a service.       #
1143 #                                                                     #
1144 # operonly    -      Defining this value, with a value of 'yes', '1'  #
1145 #                    or true will make the alias oper only. If a non- #
1146 #                    oper attempts to use the alias, it will appear   #
1147 #                    to not exist.                                    #
1148 #                                                                     #
1149 #<alias text="NICKSERV" replace="PRIVMSG NickServ :$2-" requires="NickServ" uline="yes">
1150 #<alias text="CHANSERV" replace="PRIVMSG ChanServ :$2-" requires="ChanServ" uline="yes">
1151 #<alias text="OPERSERV" replace="PRIVMSG OperServ :$2-" requires="OperServ" uline="yes" operonly="yes">
1152 #<alias text="NS" replace="PRIVMSG NickServ :$2-" requires="NickServ" uline="yes">
1153 #<alias text="CS" replace="PRIVMSG ChanServ :$2-" requires="ChanServ" uline="yes">
1154 #<alias text="OS" replace="PRIVMSG OperServ :$2-" requires="OperServ" uline="yes" operonly="yes">
1155 #
1156 # An example of using the format value to create an alias with two
1157 # different behaviours depending on the format of the parameters.
1158 #
1159 #<alias text="ID" format="#*" replace="PRIVMSG ChanServ :IDENTIFY $2 $3"
1160 #  requires="ChanServ" uline="yes">
1161 #
1162 #<alias text="ID" replace="PRIVMSG NickServ :IDENTIFY $2"
1163 #  requires="NickServ" uline="yes">
1164 #
1165 # This alias fixes a glitch in xchat 2.6.x and above and the way it
1166 # assumes IDENTIFY must be prefixed by a colon (:) character. It should
1167 # be placed ABOVE the default NICKSERV alias (the first example) listed
1168 # above.
1169 #
1170 #<alias text="NICKSERV" format=":IDENTIFY *" replace="PRIVMSG NickServ :IDENTIFY $3-"
1171 #  requires="NickServ" uline="yes">
1172
1173 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1174 # Alltime module: Shows time on all connected servers at once
1175 #<module name="m_alltime.so">
1176
1177 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1178 # Antibear security module: Prevents 'bear.txt' based trojans from
1179 # connecting to your network by sending them a numeric they can't handle.
1180 #<module name="m_antibear.so">
1181
1182 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1183 # Antibottler module: Labels bottler leech bots
1184 #<module name="m_antibottler.so">
1185
1186 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1187 # Auditorium module: Adds channel mode +u which makes everyone else
1188 # except you in the channel invisible, used for large meetings etc.
1189 #<module name="m_auditorium.so">
1190 #
1191 # Auditorium settings:
1192 #
1193 #<auditorium showops="no">
1194 #
1195 # Setting this value to yes makes m_auditorium behave like unrealircd
1196 # +u channel mode, e.g. ops see users joining, parting, etc, and users
1197 # joining the channel see the ops. Without this flag, the mode acts
1198 # like ircnet's +a (anonymous channels), showing only the user in the
1199 # names list, and not even showing the ops in the list, or showing the
1200 # ops that the user has joined.
1201
1202 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1203 # Ban except module: Adds support for channel ban exceptions (+e)
1204 #<module name="m_banexception.so">
1205
1206 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1207 # Ban redirection module: Allows bans which redirect to a specified
1208 # channel. e.g. +b nick!ident@host#channelbanneduserissentto
1209 #<module name="m_banredirect.so">
1210
1211 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1212 # Block amsg module: Attempt to block all usage of /amsg and /ame
1213 #<module name="m_blockamsg.so">
1214 #
1215 #-#-#-#-#-#-#-#-#-#-#-  BLOCKAMSG CONFIGURATION  -#-#-#-#-#-#-#-#-#-#-#
1216 #                                                                     #
1217 # If you have the m_blockamsg.so module loaded, you can configure it  #
1218 # with the <blockamsg> tag:                                           #
1219 #                                                                     #
1220 # delay          -   How many seconds between two messages to force   #
1221 #                    them to be recognised as unrelated.              #
1222 # action         -   Any of 'notice', 'noticeopers', 'silent', 'kill' #
1223 #                    or 'killopers'. Define how to take action when   #
1224 #                    a user uses /amsg or /ame.                       #
1225 #
1226 #<blockamsg delay="3" action="killopers">
1227
1228 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1229 # Block CAPS module: Blocking all-CAPS messages with cmode +P
1230 #<module name="m_blockcaps.so">
1231 #                                                                     #
1232 #-#-#-#-#-#-#-#-#-#-#-  BLOCKCAPS CONFIGURATION  -#-#-#-#-#-#-#-#-#-#-#
1233 #                                                                     #
1234 # percent        - How many percent of text must be caps before text  #
1235 #                  will be blocked.                                   #
1236 #                                                                     #
1237 # minlen         - The minimum length a line must be for the block    #
1238 #                  percent to have any effect.                        #
1239 #                                                                     #
1240 # capsmap        - A list of chars to be considered CAPS, this was    #
1241 #                  you can add CAPS for your language. Also you can   #
1242 #                  add things like ! and space to further lock down   #
1243 #                  on caps usage.                                     #
1244 #<blockcaps percent="50"
1245 #           minlen="5"
1246 #           capsmap="ABCDEFGHIJKLMNOPQRSTUVWXYZ! ">
1247
1248 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1249 # Block colour module: Blocking colour-coded messages with cmode +c
1250 #<module name="m_blockcolor.so">
1251
1252 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1253 # Botmode module: Adds the user mode +B
1254 #<module name="m_botmode.so">
1255
1256 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1257 # CBAN module: Lets you disallow channels from being used at runtime.
1258 #<module name="m_cban.so">
1259
1260 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1261 # Censor module: Adds the channel mode +G
1262 #<module name="m_censor.so">
1263 #
1264 #-#-#-#-#-#-#-#-#-#-#-  CENSOR  CONFIGURATION  -#-#-#-#-#-#-#-#-#-#-#-#
1265 #                                                                     #
1266 # Optional - If you specify to use the m_censor module, then you must #
1267 # specify some censor tags. See also:                                 #
1268 # http://www.inspircd.org/wiki/Censor_Module                          #
1269 #
1270 #<include file="censor.conf">
1271
1272 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1273 # CGI:IRC module: Adds support for automatic host changing in CGI:IRC
1274 # (http://cgiirc.sourceforge.net).
1275 #<module name="m_cgiirc.so">
1276 #
1277 #-#-#-#-#-#-#-#-#-#-#-# CGIIRC  CONFIGURATION #-#-#-#-#-#-#-#-#-#-#-#-#
1278 #
1279 # Optional - If you specify to use m_cgiirc, then you must specify one
1280 # or more cgihost tags which indicate authorized CGI:IRC servers which
1281 # will be connecting to your network, and an optional cgiirc tag.
1282 # For more information see: http://www.inspircd.org/wiki/CGI-IRC_Module
1283 #
1284 # Set to yes if you want to notice opers when CGI clients connect
1285 # <cgiirc opernotice="no">
1286 #
1287 # The type field indicates where the module should get the real
1288 # client's IP address from, for further information, please see the
1289 # CGI:IRC documentation.
1290 #
1291 # <cgihost type="pass" mask="www.mysite.com">       # Get IP from PASS
1292 # <cgihost type="webirc" mask="somebox.mysite.com"> # Get IP from WEBIRC
1293 # <cgihost type="ident" mask="otherbox.mysite.com"> # Get IP from ident
1294 # <cgihost type="passfirst" mask="www.mysite.com">  # See the docs
1295 #
1296 # IMPORTANT NOTE:
1297 # ---------------
1298 #
1299 # When you connect CGI:IRC clients, there are two connect classes which
1300 # apply to these clients. When the client initially connects, the connect
1301 # class which matches the cgi:irc site's host is checked. Therefore you
1302 # must raise the maximum local/global clients for this ip as high as you
1303 # want to allow cgi clients. After the client has connected and is
1304 # determined to be a cgi:irc client, the class which matches the client's
1305 # real IP is then checked. You may set this class to a lower value, so that
1306 # the real IP of the client can still be restricted to, for example, 3
1307 # sessions maximum.
1308 #
1309
1310
1311 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1312 # Channel create module: Adds snomask +j, which will notify opers of
1313 # any new channels that are created
1314 #<module name="m_chancreate.so">
1315
1316 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1317 # Channel filter module: Allows channel-op defined message
1318 # filtering using simple string matches (channel mode +g)
1319 #<module name="m_chanfilter.so">
1320
1321 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1322 # Chanprotect module: gives +q and +a channel modes
1323 #<module name="m_chanprotect.so">
1324
1325 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1326 # Check module: gives /check
1327 # Check is useful for looking up information on channels,
1328 # users, IP addresses and hosts.
1329 #<module name="m_check.so">
1330
1331 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1332 # CHGHOST module: Adds the /CHGHOST command
1333 #<module name="m_chghost.so">
1334 #
1335 #-#-#-#-#-#-#-#-# /CHGHOST - /SETHOST  CONFIGURATION #-#-#-#-#-#-#-#-#
1336 # Optional - If you want to use special chars for hostnames you can  #
1337 # specify your own custom list of chars with the <hostname> tag:     #
1338 #                                                                    #
1339 # charmap        - A list of chars accepted as valid by the /CHGHOST #
1340 #                  and /SETHOST commands. Also note that the list is # 
1341 #                  case-sensitive.                                   #
1342 #<hostname charmap="abcdefghijklmnopqrstuvwxyz.-_/0123456789">
1343
1344 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1345 # CHGIDENT module: Adds the /CHGIDENT command
1346 #<module name="m_chgident.so">
1347
1348 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1349 # CHGNAME module: Adds the /CHGNAME command
1350 #<module name="m_chgname.so">
1351
1352 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1353 # Cloaking module: Adds usermode +x and cloaking support.
1354 # Relies on the module m_md5.so being loaded before m_cloaking.so in
1355 # the configuration file.
1356 #<module name="m_cloaking.so">
1357 #
1358 #-#-#-#-#-#-#-#-#-#-#- CLOAKING  CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#
1359 #                                                                     #
1360 # Optional - If you specify the m_cloaking.so module as above, you    #
1361 # must define cloak keys, and optionally a cloak prefix as shown      #
1362 # below. When using cloaking, the cloak keys are MANDITORY and must   #
1363 # be included. However, if prefix is not included, it will default    #
1364 # to your networks name from the <server> tag. You can also include   #
1365 # the following optional values:                                      #
1366 #                                                                     #
1367 #   ipalways         - Always cloak the IP address, not the hostname, #
1368 #                      which doesn't reveal the user's ISP, but       #
1369 #                      results in hosts that are harder to read and   #
1370 #                      ban.                                           #
1371 #                                                                     #
1372 #   lowercase        - Display the cloaked hostnames in lowercase     #
1373 #                      characters instead of uppercase                #
1374 #                                                                     #
1375 # <cloak key1="0x2AF39F40"                                            #
1376 #        key2="0x78E10B32"                                            #
1377 #        key3="0x4F2D2E82"                                            #
1378 #        key4="0x043A4C81"                                            #
1379 #        prefix="mynet"                                               #
1380 #        ipalways="false"                                             #
1381 #        lowercase="false">                                           #
1382 #                                                                     #
1383 # Please note that the key values will accept any number, and should  #
1384 # be large numbers. Using small numbers such as "7" or "1924" will    #
1385 # seriously weaken the security of your cloak. It is recommended you  #
1386 # use hexdecimal numbers prefixed by "0x", as shown in this example,  #
1387 # with each key eight hex digits long.                                #
1388
1389 #-#-#-#-#-#-#-#-#-#-#-#- CLOSE MODULE #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1390 # Close module: Allows an oper to close all unregistered connections.
1391 #<module name="m_close.so">
1392
1393 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1394 # Clones module: Adds an oper command /CLONES for detecting cloned
1395 # users. Warning: This module may be resource intensive when its
1396 # command is issued, use with care.
1397 #<module name="m_clones.so">
1398
1399 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1400 # Common channels module: Adds user mode +c, which, when set, requires
1401 # that users must share a common channel with you to PRIVMSG or NOTICE
1402 # you.
1403 #<module name="m_commonchans.so">
1404
1405 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1406 # Conn-Join: Allows you to force users to join one or more channels
1407 # automatically upon connecting to the server.
1408 #<module name="m_conn_join.so">
1409 #
1410 #-#-#-#-#-#-#-#-#-#-#-#- CONNJOIN CONFIGURATION  -#-#-#-#-#-#-#-#-#-#-#
1411 #
1412 # If you have m_conn_join.so loaded, you can configure it using the
1413 # follow values:
1414 #
1415 #<autojoin channel="#one,#two,#three">
1416
1417 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1418 # Conn-Usermodes: Set modes on users when they connect
1419 # When this module is loaded <connect:allow> tags may have an optional
1420 # modes="" value, which contains modes to add or remove from users
1421 # when they connect to the server.
1422 #<module name="m_conn_umodes.so">
1423
1424 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1425 # Conn-Wait-for-Pong: Don't let a user connect until they PONG
1426 #<module name="m_conn_waitpong.so">
1427 #
1428 #-#-#-#-#-#-#-#-#-#-#-   WAITPONG CONFIGURATION  -#-#-#-#-#-#-#-#-#-#-#
1429 #                                                                     #
1430 # If you have the m_conn_waitpong.so module loaded, configure it with #
1431 # the <waitpong> tag:                                                 #
1432 #                                                                     #
1433 # sendsnotice    -   Whether to send a snotice on connect, like other #
1434 #                    older ircds                                      #
1435 #                                                                     #
1436 # killonbadreply -   Whether to kill the user if they send the wrong  #
1437 #                    PONG reply.                                      #
1438 #                                                                     #
1439 #<waitpong sendsnotice="yes" killonbadreply="yes">
1440
1441
1442 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1443 # Channel cycle module. Server side /hop, with +ilk etc bypass.
1444 #<module name="m_cycle.so">
1445
1446 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1447 # Connection throttle module. Configuration:
1448 #<module name="m_connflood.so">
1449 #
1450 #-#-#-#-#-#-#-#-#-#-#- CONTHROTTLE CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
1451 #  seconds, maxconns -  Amount of connections per <seconds>.
1452 #
1453 #  timeout           -  Time to wait after the throttle was activated
1454 #                       before deactivating it. Be aware that the time
1455 #                       is seconds + timeout.
1456 #
1457 #  quitmsg           -  The message that users get if they attempt to
1458 #                       connect while the throttle is active.
1459 #
1460 #  bootwait          -  Amount of time to wait before enforcing the
1461 #                       throttling when the server just booted.
1462 #
1463 #<connflood seconds="30" maxconns="3" timeout="30"
1464 #   quitmsg="Throttled" bootwait="10">
1465
1466 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1467 # Custom title module: Adds the /TITLE command which allows for trusted
1468 #                      users to gain a custom whois line and a optional
1469 #                      vhost can be specified.
1470 #<module name="m_customtitle.so">
1471 #
1472 #-#-#-#-#-#-#-#-#-#-  CUSTOM TITLE CONFIGURATION   -#-#-#-#-#-#-#-#-#-#
1473 #  name              - The username used to identify 
1474 #  password          - The password used to identify
1475 #  host              - Allowed hostmask [optional]
1476 #  title             - Title shown in whois
1477 #  vhost             - Displayed host [optional]
1478 #
1479 #<title name="foo" password="bar" title="Official Chat Helper">
1480 #<title name="bar" password="foo" host="ident@host.name" title="Official Chat Helper" vhost="helper.network.chat">
1481
1482 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1483 # DCCALLOW module: Adds the /DCCALLOW command
1484 #<module name="m_dccallow.so">
1485 #
1486 #-#-#-#-#-#-#-#-#-#-#-  DCCALLOW CONFIGURATION   -#-#-#-#-#-#-#-#-#-#-#
1487 #  blockchat         - Whether to block DCC CHAT as well as DCC SEND
1488 #  length            - Default duration of entries in DCCALLOW list
1489 #  action            - Default action to take if no action is specified
1490 #                      can be 'block' or 'allow'
1491 #
1492 # File configuration:
1493 #  pattern           - The glob pattern to match against
1494 #  action            - Action to take if a user attempts to send a file
1495 #                      that matches this pattern, can be 'block' or 'allow'
1496 #
1497 #<dccallow blockchat="yes" length="5m" action="block">
1498 #<banfile pattern="*.exe" action="block">
1499 #<banfile pattern="*.txt" action="allow">
1500 #
1501 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1502
1503 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1504 # Deaf module: adds support for ircu style usermode +d - deaf to
1505 # channel messages and channel notices.
1506 #<module name="m_deaf.so">
1507
1508 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1509 # Deny Channels: Deny Channels from being used by users
1510 #<module name="m_denychans.so"> 
1511 #
1512 #-#-#-#-#-#-#-#-#-#-#-   DENYCHAN DEFINITIONS  -#-#-#-#-#-#-#-#-#-#-#-#
1513 #                                                                     #
1514 # If you have the m_denychans.so module loaded, you need to specify   #
1515 # the channels to deny:                                               #
1516 #                                                                     #
1517 # name        -      The channel name to deny.                        #
1518 #                                                                     #
1519 # allowopers  -      If operators are allowed to override the deny.   #
1520 #                                                                     #
1521 # reason      -      Reason given for the deny.                       #
1522 #                                                                     #
1523 #<badchan name="#gods" allowopers="yes" reason="Tortoises!">
1524
1525 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1526 # Devoice Module: Let users devoice themselves.
1527 #<module name="m_devoice.so">
1528
1529 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1530 # DNS Blacklist Module: Provides support for looking up IPs on one or #
1531 # more blacklists.                                                    #
1532 #<module name="m_dnsbl.so">                                           #
1533 #                                                                     #
1534 # For configuration options please see the wiki page for m_dnsbl at   #
1535 # http://inspircd.org/wiki/DNS_Blacklist_Module                       #
1536
1537 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1538 # Filter module: Provides glob-based message filtering
1539 #<module name="m_filter.so">
1540 # OR
1541 # PCRE filter module: Filters messages using regular expressions
1542 #<module name="m_filter_pcre.so">
1543 #
1544 # You may only use one or the other with these modules, network-wide.
1545 #
1546 #-#-#-#-#-#-#-#-#-#-#-  FILTER  CONFIGURATION  -#-#-#-#-#-#-#-#-#-#-#-#
1547 #                                                                     #
1548 # Optional - If you specify to use the m_filter or m_filter_pcre      #
1549 # modules, then specfiy below the path to the filter.conf file,       #
1550 # or define some <filter> tags.                                       #
1551 #                                                                     #
1552 #<include file="filter.conf">
1553
1554 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1555 # Foobar module: does nothing - historical relic
1556 #<module name="m_foobar.so">
1557
1558 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1559 # Globops module: gives /GLOBOPS and usermode +g
1560 #<module name="m_globops.so">
1561
1562 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1563 # Global load module: Allows loading and unloading of modules network-
1564 # wide (USE WITH EXTREME CAUTION!)
1565 #<module name="m_globalload.so">
1566
1567 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1568 # HELPOP module: Provides the /HELPOP command
1569 #<module name="m_helpop.so">
1570 #
1571 #-#-#-#-#-#-#-#-#-#-#-#-  HELPOP  CONFIGURATION  -#-#-#-#-#-#-#-#-#-#-#
1572 #                                                                     #
1573 # Optional - If you specify to use the m_helpop.so module, then       #
1574 # specify below the path to the helpop.conf file, or if you like to   #
1575 # make a mess, define your helpop tags in this conf.                  #
1576 #                                                                     #
1577 #<include file="helpop.conf">
1578
1579 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1580 # HIDECHANS module: Allows opers to hide their channels list from non-
1581 # opers by setting user mode +I on themselves.
1582 # <module name="m_hidechans.so">
1583
1584 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1585 # HIDEOPER module: Allows opers to hide their oper status from non-
1586 # opers by setting user mode +H on themselves.
1587 # <module name="m_hideoper.so">
1588
1589 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1590 # Hostchange module: Allows a different style of cloaking
1591 #<module name="m_hostchange.so">
1592 #
1593 #-#-#-#-#-#-#-#-#-#-#-  HOSTCHANGE  CONFIGURATION  -#-#-#-#-#-#-#-#-#-#
1594 #                                                                     #
1595 # Optional - If you choose to use the m_hostchange.so module.         #
1596 # Config Help -  See http://www.inspircd.org/wiki/Host_Changer_Module #
1597 #                                                                     #
1598 #<host suffix="polarbears.org" separator="." prefix="">
1599 #<hostchange mask="*@fbi.gov" action="addnick">
1600 #<hostchange mask="*r00t@*" action="suffix">
1601 #<hostchange mask="a@b.com" action="set" value="blah.blah.blah">
1602 #<hostchange mask="localhost" ports="7000,7001,7005-7007" action="set" value="blahblah.foo">
1603
1604 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1605 # httpd module: Provides http server support for InspIRCd
1606 #<module name="m_httpd.so">
1607 #
1608 #-#-#-#-#-#-#-#-#-#-#-#-  HTTPD   CONFIGURATION  -#-#-#-#-#-#-#-#-#-#-#
1609 #
1610 # Optional - If you choose to use the m_httpd.so module,  then you must
1611 # specify the port number and other details of your http server:
1612 #
1613 #<http ip="192.168.1.10" host="brainwave" port="32006"
1614 #      index="/home/brain/inspircd/http/index.html">
1615 #
1616 # You may have as many of these tags as you wish, each with a different
1617 # IP, port, host or index file. Each one will act as an independent
1618 # HTTP server.
1619 #
1620
1621 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1622 # http stats module: Provides basic stats pages over HTTP
1623 # Requires m_httpd.so to be loaded for it to function.
1624 #<module name="m_httpd_stats.so">
1625 #
1626 #-#-#-#-#-#-#-#-#-#-#-#- HTTPD STATS CONFIGURATION -#-#-#-#-#-#-#-#-#-#
1627 #
1628 #<httpstats stylesheet="http://remote.style/sheet.css">
1629 #
1630
1631 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1632 # Ident: Provides RFC 1413 ident lookup support
1633 #<module name="m_ident.so">
1634 #
1635 #-#-#-#-#-#-#-#-#-#-#-#-   IDENT CONFIGURATION   -#-#-#-#-#-#-#-#-#-#-#
1636 #                                                                     #
1637 # Optional - If you are using the m_ident.so module, then you can     #
1638 # specify the timeout for ident lookups here. If not defined, it will #
1639 # default to one second. This is a non-blocking timeout which holds   #
1640 # the user in a 'connecting' state until the lookup is complete.      #
1641 # The bind value indicates which IP to bind outbound requests to.     #
1642 #                                                                     #
1643 #<ident timeout="5" bind="">                                          #
1644
1645 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1646 # Invite except module: Adds support for channel invite exceptions (+I)
1647 #<module name="m_inviteexception.so">
1648
1649 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1650 # Invisible module - Adds support for usermode +Q (quiet) which lets an
1651 # oper go 'invisible' similar to unrealircd 3.1's +I mode. Note that
1652 # opers are still able to see invisible users, and if an oper with +Q
1653 # deopers, they will become visible. 
1654
1655 # IMPORTANT NOTE: To allow this mode to be used by a type of oper, you
1656 # must first add the value canquiet="yes" to that oper's type tag.
1657 #
1658 #<module name="m_invisible.so">
1659
1660 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1661 # Join flood module: Adds support for join flood protection (+j)
1662 #<module name="m_joinflood.so">
1663
1664 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1665 # Jump Server module: Adds support for the RPL_REDIR numeric
1666 #<module name="m_jumpserver.so">
1667
1668 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1669 # Anti-Auto-Rejoin: Adds support for prevention of auto-rejoin (+J)
1670 #<module name="m_kicknorejoin.so">
1671
1672 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1673 # Knock module: adds the /KNOCK command and +K channel mode
1674 #<module name="m_knock.so">
1675
1676 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1677 # Lock server module: Adds /LOCKSERV and /UNLOCKSERV commands that is #
1678 # used to temporarily close/open for new connections to the server.   #
1679 # These commands require OPER status and that the LOCKSERV UNLOCKSERV #
1680 # are specified in a <class> tag that the oper is part of. This is so #
1681 # you can control who has access to this possible dangerous command.  #
1682 # If your server is locked and you got disconnected, do a REHASH from #
1683 # shell to open up again.
1684 #<module name="m_lockserv.so">
1685
1686 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1687 # Msg flood module: Adds message/notice flood protection (+f)
1688 #<module name="m_messageflood.so">
1689
1690 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1691 # MySQL module: Allows other SQL modules to access MySQL databases
1692 # through a unified API. You must copy the source for this module
1693 # from the directory src/modules/extra, plus the file m_sqlv2.h
1694 #<module name="m_mysql.so">
1695 #
1696 #-#-#-#-#-#-#-#-#-#-#-#- SQL CONFIGURATION   -#-#-#-#-#-#-#-#-#-#-#-#-#
1697 #                                                                     #
1698 # m_mysql.so is more complex than described here, see the wiki for    #
1699 # more: http://www.inspircd.org/wiki/SQL_Service_Provider_Module      #
1700 #
1701 #<database name="mydb" username="myuser" password="mypass" hostname="localhost" id="my_database2">
1702
1703 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1704 # NAMESX module: Provides support for the NAMESX extension which allows
1705 # clients to see all the prefixes set on a user without getting confused.
1706 # This is supported by mIRC, x-chat, klient, and maybe more.
1707 #<module name="m_namesx.so">
1708
1709 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1710 # Nickchange flood protection module: Allows up to X nick changes in Y seconds.
1711 # Provides channel mode +F.
1712 #<module name="m_nickflood.so">
1713
1714 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1715 # Nicklock module: Let opers change a user's nick and then stop that
1716 # user from changing their nick again.
1717 #<module name="m_nicklock.so">
1718
1719 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1720 # No ctcp module: Adds the channel mode +C to block CTCPs
1721 #<module name="m_noctcp.so">
1722
1723 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1724 # Noinvite module: Gives channel mode +V
1725 #<module name="m_noinvite.so">
1726
1727 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1728 # No kicks module: Adds the +Q channel mode
1729 #<module name="m_nokicks.so">
1730
1731 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1732 # No nicks module: Adds the +N channel mode
1733 #<module name="m_nonicks.so">
1734
1735 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1736 # No Notice module: adds the channel mode +T
1737 #<module name="m_nonotice.so">
1738
1739 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1740 # Oper channels mode: Adds the +O channel mode
1741 #<module name="m_operchans.so">
1742
1743 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1744 # Oper hash module: Allows hashed oper passwords
1745 # Relies on the module m_md5.so and/or m_sha256.so being loaded before
1746 # m_oper_hash.so in the configuration file.
1747 #<module name="m_oper_hash.so">
1748 #
1749 #-#-#-#-#-#-#-#-#-#-# OPER HASH CONFIGURATION #-#-#-#-#-#-#-#-#-#-#-#-#
1750 #
1751 # To use this module, you must define a hash type for each oper's
1752 # password you want to hash. For example:
1753 #
1754 #     <oper name="Brain"
1755 #           host="ident@dialup15.isp.com"
1756 #           hash="sha256"
1757 #           password="a41d730937a53b79f788c0ab13e9e1d5"
1758 #           type="NetAdmin">
1759
1760 # The types of hashing available vary depending on which hashing modules
1761 # you load, but usually if you load m_sha256.so and m_md5.so, both md5
1762 # and sha256 type hashing will be available (the most secure of which
1763 # is SHA256).
1764
1765 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1766 # Oper Join module: Forces opers to join a channel on oper-up
1767 #<module name="m_operjoin.so">
1768 #
1769 #-#-#-#-#-#-#-#-#-#-#   OPERJOIN CONFIGURATION   -#-#-#-#-#-#-#-#-#-#-#
1770 #                                                                     #
1771 # If you are using the m_operjoin.so module, specify the channel here #
1772 #                                                                     #
1773 #<operjoin channel="#channel">
1774
1775 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1776 # Oper MOTD module: Provides support for seperate message of the day
1777 # on oper-up
1778 #<module name="m_opermotd.so">
1779 #
1780 #-#-#-#-#-#-#-#-#-#-#   OPERMOTD CONFIGURATION   -#-#-#-#-#-#-#-#-#-#-#
1781 #                                                                     #
1782 # If you are using the m_opermotd.so module, specify the motd here    #
1783 #                                                                     #
1784 #<opermotd file="oper.motd">
1785
1786 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1787 # Override module: Adds support for oper override
1788 #<module name="m_override.so">
1789 #
1790 #-#-#-#-#-#-#-#-#-#-#   OVERRIDE CONFIGURATION   -#-#-#-#-#-#-#-#-#-#-#
1791 #                                                                     #
1792 # m_override.so is too complex it describe here, see the wiki:        #
1793 # http://www.inspircd.org/wiki/Oper_Override_Module                   #
1794
1795 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1796 # Oper levels module: Gives each oper a level and prevents
1797 # actions being taken against higher level opers
1798 # Specify the level as the 'level' parameter of the <type> tag
1799 #<module name="m_operlevels.so">
1800
1801 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1802 # Oper modes module: Allows you to specify modes to add/remove on oper
1803 # Specify the modes as the 'modes' parameter of the <type> tag
1804 #<module name="m_opermodes.so">
1805
1806 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1807 # PostgreSQL module: Allows other SQL modules to access PgSQL databases
1808 # through a unified API. You must copy the source for this module
1809 # from the directory src/modules/extra, plus the file m_sqlv2.h
1810 #<module name="m_pgsql.so">
1811 #
1812 #-#-#-#-#-#-#-#-#-#-#-#- SQL CONFIGURATION   -#-#-#-#-#-#-#-#-#-#-#-#-#
1813 #                                                                     #
1814 # m_pgsql.so is more complex than described here, see the wiki for    #
1815 # more: http://www.inspircd.org/wiki/SQL_Service_Provider_Module      #
1816 #
1817 #<database name="mydb" username="myuser" password="mypass" hostname="localhost" id="my_database" ssl="no">
1818
1819 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1820 # Random Quote module: provides a random quote on connect.
1821 # NOTE: Some of these may mimic fatal errors and confuse users and 
1822 # opers alike! - BEWARE!
1823 #<module name="m_randquote.so">
1824 #
1825 #-#-#-#-#-#-#-#-#-#-  RANDOMQUOTES CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
1826 #                                                                     #
1827 # Optional - If you specify to use the m_randquote.so module, then    #
1828 # specify below the path to the randquotes.conf file.                 #
1829 #                                                                     #
1830 #<randquote file="randquotes.conf">
1831
1832 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1833 # Redirect module: Adds channel redirection (mode +L)
1834 #<module name="m_redirect.so">
1835
1836 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1837 # Registered users only channel creation
1838 # Allows only registered users and opers to create new channels.
1839 #<module name="m_regonlycreate.so">
1840
1841 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1842 # Remove module: Adds the /REMOVE command which is a peaceful
1843 # alternative to /KICK
1844 #<module name="m_remove.so">
1845
1846 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1847 # Restrict banned users module:
1848 # Disallows banned users on a channel from messaging the channel,
1849 # changing nick, or changing the topic, if loaded.
1850 #<module name="m_restrictbanned.so">
1851
1852 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1853 # Restricted channels module: Allows only opers to create channels
1854 #<module name="m_restrictchans.so">
1855
1856 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1857 # Restrict message module: Allows users to only message opers
1858 #<module name="m_restrictmsg.so">
1859
1860 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1861 # Provide /LIST throttling (to prevent flooding) and /LIST safety to
1862 # prevent excess flood when the list is large.
1863 #<module name="m_safelist.so">
1864 #
1865 #-#-#-#-#-#-#-#-#-#-# SAFELIST CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#-#
1866 #
1867 # When using Safelist, you may set the following values;
1868 #
1869 # The first value, 'throttle', sets the amount of time in seconds a user
1870 # must wait between LIST commands. For example, if this is set to 60
1871 # (the default) then the user may not /LIST more than once a minute.
1872 # If not defined, the default value is 60 seconds.
1873 #
1874 # The second value, 'maxlisters', indicates the maximum number of users
1875 # which may be retrieving a LIST at once. It is not recommended you raise
1876 # this value, as increasing it too high can make your network vulnerable
1877 # to floodbots which waste your bandwidth and CPU time with LIST requests.
1878 #
1879 #<safelist throttle="60" maxlisters="50">
1880
1881 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1882 # SAJOIN module: Adds the /SAJOIN command
1883 #<module name="m_sajoin.so">
1884
1885 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1886 # SAMODE module: Adds the oper /SAMODE command
1887 #<module name="m_samode.so">
1888
1889 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1890 # SANICK module: Allows opers to change user's nicks
1891 #<module name="m_sanick.so">
1892
1893 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1894 # SAPART module: Adds the oper /SAPART command
1895 #<module name="m_sapart.so">
1896
1897 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1898 # SAQUIT module: Adds the oper /SAQUIT command (abusable!!!)
1899 #<module name="m_saquit.so">
1900
1901 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1902 # Secure list module: Prevent /LIST in the first minute of connection,
1903 # crippling most spambots and trojan spreader bots.
1904 #<module name="m_securelist.so">
1905 #
1906 #-#-#-#-#-#-#-#-#-# SECURELIST CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#-#
1907 #                                                                     #
1908 # Securelist can be harmful to some irc search engines such as        #
1909 # netsplit.de and searchirc.com. To prevent securelist blocking these #
1910 # sites from listing, define exception tags as shown below:           #
1911 <securehost exception="*@*.searchirc.org">
1912 <securehost exception="*@*.netsplit.de">
1913 <securehost exception="*@echo940.server4you.de">
1914 #                                                                     #
1915 # Define the following variable to change how long a user must wait   #
1916 # before issuing a LIST. If not defined, defaults to 60 seconds.      #
1917 #                                                                     #
1918 #<securelist waittime="60">                                           #
1919
1920 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1921 # See nicks module: Allow for SNOMASK +N which shows nick changes.
1922 #<module name="m_seenicks.so">
1923
1924 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1925 # Set Idle module: Adds a command for opers to change their
1926 # idle time (mainly a toy)
1927 #<module name="m_setidle.so">
1928
1929 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1930 # Services support module: Adds several usermodes such as +R and +M
1931 # this module implements the 'identified' state via user mode +r, which
1932 # is similar to the DALnet and dreamforge systems.
1933 #     
1934 # N O T E!!
1935 #  >>  This CAN NOT be used at the same time as m_services_account <<
1936 # N O T E!!
1937 #<module name="m_services.so">
1938
1939 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1940 # Services support module: Adds several usermodes such as +R and +M
1941 # this module implements the 'identified' state via account names (AC)
1942 # and is similar in operation to the way asuka and ircu handle services.
1943 #                                                                       
1944 # N O T E!!
1945 #  >>  This CAN NOT be used at the same time as m_services <<
1946 # N O T E!!
1947 #<module name="m_services_account.so">
1948
1949 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1950 # Sethost module: Adds the /SETHOST command
1951 # See m_chghost for how to customise valid chars for hostnames
1952 #<module name="m_sethost.so">
1953
1954 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1955 # Setident module: Adds the /SETIDENT command
1956 #<module name="m_setident.so">
1957
1958 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1959 # SETNAME module: Adds the /SETNAME command
1960 #<module name="m_setname.so">
1961
1962 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1963 # Show Whois module: Adds the +W usermode which allows opers
1964 # to see when they are whois'ed (can be annoying).
1965 #<module name="m_showwhois.so">
1966
1967 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1968 # Spy module: Adds the commands SPYLIST and SPYNAMES that let opers
1969 # see who is in a +s channel, and list +s channels, show keys of keyed
1970 # channels the oper is not a member of etc. (standard 'abusive' features
1971 # of many other ircds, modulized here in InspIRCd).
1972 #<module name="m_spy.so">
1973
1974 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1975 # SSL channel mode module: Adds support for SSL-only channels (+z).
1976 # does not do anything useful without a working SSL module (see below)
1977 #<module name="m_sslmodes.so">
1978
1979 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1980 # Dummy ssl module: If you have other servers on your network which
1981 # have SSL, but your server does not have ssl enabled, you should load
1982 # this module, which will handle SSL metadata (e.g. the "Is using ssl"
1983 # field in the WHOIS information).
1984 #<module name="m_ssl_dummy.so">
1985
1986 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1987 # GnuTLS ssl module: Adds support for client-server SSL using GnuTLS,
1988 # if enabled. You must copy the source for this module from the directory
1989 # src/modules/extra, or answer 'yes' in ./configure when asked if you
1990 # want to enable this, or it will not load.
1991 #<module name="m_ssl_gnutls.so">
1992 #
1993 #-#-#-#-#-#-#-#-#-#-#-  GNUTLS CONFIGURATION   -#-#-#-#-#-#-#-#-#-#-#-#
1994 #                                                                     #
1995 # m_ssl_gnutls.so is too complex it describe here, see the wiki:      #
1996 # http://www.inspircd.org/wiki/GnuTLS_SSL_Module                      #
1997 #                                                                     #
1998 # NOTE: If you want to use this module to encrypt and sign your       #
1999 # server to server traffic, you MUST load it before m_spanningtree in #
2000 # your configuration file!                                            #
2001
2002 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2003 # SSL Info module: Allows users to retrieve information about other
2004 # user's peer SSL certificates and keys. This can be used by client
2005 # scripts to validate users. For this to work, one of m_ssl_gnutls.so
2006 # or m_ssl_openssl.so must be loaded. You must symlink the source for
2007 # this module from the directory src/modules/extra.
2008 #<module name="m_sslinfo.so">
2009
2010 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2011 # OpenSSL ssl module: Adds support for client-server SSL using OpenSSL,
2012 # if enabled. You must copy the source for this module from the directory
2013 # src/modules/extra, or answer 'yes' in ./configure when asked if you
2014 # want to enable this, or it will not load.
2015 #<module name="m_ssl_openssl.so">
2016 #
2017 #-#-#-#-#-#-#-#-#-#-#- OPENSSL CONFIGURATION   -#-#-#-#-#-#-#-#-#-#-#-#
2018 #                                                                     #
2019 # m_ssl_openssl.so is too complex it describe here, see the wiki:     #
2020 # http://www.inspircd.org/wiki/OpenSSL_SSL_Module                     #
2021 #                                                                     #
2022 # NOTE: If you want to use this module to encrypt and sign your       #
2023 # server to server traffic, you MUST load it before m_spanningtree in #
2024 # your configuration file!                                            #
2025
2026 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2027 # SSL Cert Oper module: Allows opers to oper up using the key fingerprint
2028 # stored within their SSL certificate and key pair.
2029 # When using this module, one of m_ssl_gnutls.so or m_ssl_openssl.so must
2030 # be loaded. An extra value should be added to enabled opers, which
2031 # is in the following format: fingerprint="<hash>". For more information,
2032 # see the example in the oper blocks.
2033 #<module name="m_ssl_oper_cert.so">
2034
2035 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2036 # Strip colour module: Adds the channel mode +S
2037 #<module name="m_stripcolor.so">
2038
2039 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2040 # SILENCE module: Adds support for /SILENCE
2041 #<module name="m_silence.so">
2042 #
2043 # Configuration tags:
2044 #
2045 #<silence maxentries="32">
2046 #
2047 # Sets the maximum number of entries on a users silence list.
2048
2049 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2050 # Extended SILENCE module: Adds support for /SILENCE with additional
2051 # features to silence based on invites, channel messages, etc.
2052 #<module name="m_silence_ext.so">
2053 #
2054 # The configuration tags for this module are identical to those of
2055 # m_silence, shown above.
2056
2057 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2058 # SQLite3 module: Allows other SQL modules to access SQLite3          #
2059 # databases through a unified API. You must link the source for this  #
2060 # module from the directory src/modules/extra to src/modules, plus    #
2061 # the file m_sqlv2.h                                                  #
2062 #<module name="m_sqlite3.so">
2063 #
2064 #-#-#-#-#-#-#-#-#-#-#-#- SQL CONFIGURATION   -#-#-#-#-#-#-#-#-#-#-#-#-#
2065 #                                                                     #
2066 # m_sqlite.so is more complex than described here, see the wiki for   #
2067 # more: http://www.inspircd.org/wiki/SQLite3_Service_Provider_Module  #
2068 #
2069 #<database hostname="/full/path/to/database.db" id="anytext">
2070
2071 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2072 # SQLutils module: Provides some utilities to SQL client modules, such
2073 # as mapping queries to users and channels. You must copy the source
2074 # for this module from the directory src/modules/extra/m_sqlutils.cpp
2075 # and src/modules/extra/m_sqlutils.h into /src/modules
2076 # Needed for, and loaded before: SQLauth and SQLoper
2077 #<module name="m_sqlutils.so">
2078
2079 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2080 # SQL authentication module: Allows IRCd connections to be tied into
2081 # a database table (for example a forum). You must copy the source for
2082 # this module from the directory src/modules/extra
2083 # Depends on the SQLutils module being loaded first.
2084 #<module name="m_sqlauth.so">
2085 #
2086 #-#-#-#-#-#-#-#-#-#-#- SQLAUTH CONFIGURATION   -#-#-#-#-#-#-#-#-#-#-#-#
2087 #                                                                     #
2088 # m_sqlauth.so is too complex it describe here, see the wiki:         #
2089 # http://www.inspircd.org/wiki/SQL_Authentication_Module              #
2090
2091 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2092 # SQL logging module: Allows you to log network-wide data for your
2093 # network in a fully normalized set of SQL tables. You must copy the
2094 # source for this module from the directory src/modules/extra
2095 #<module name="m_sqllog.so">
2096 #
2097 #-#-#-#-#-#-#-#-#-#-#-  SQLLOG CONFIGURATION   -#-#-#-#-#-#-#-#-#-#-#-#
2098 #                                                                     #
2099 # dbid       - Database ID to use (see m_sql)                         #
2100 #                                                                     #
2101 # See also: http://www.inspircd.org/wiki/SQL_Logging_Module           #
2102 #                                                                     #
2103 #<sqllog dbid="1">
2104
2105 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2106 # SQL oper module: Allows you to store oper credentials in an SQL table
2107 # You must copy the source for this module from the directory src/modules/extra
2108 # Depends on the SQLutils module being loaded first.
2109 #<module name="m_sqloper.so">
2110 #
2111 #-#-#-#-#-#-#-#-#-#-#- SQLOPER CONFIGURATION   -#-#-#-#-#-#-#-#-#-#-#-#
2112 #                                                                     #
2113 # dbid       - Database ID to use (see m_sql)                         #
2114 #                                                                     #
2115 # See also: http://www.inspircd.org/wiki/SQL_Oper_Storage_Module      #
2116 #                                                                     #
2117 #<sqloper dbid="1">
2118
2119 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2120 # SVSHold module: Implements SVSHOLD. Like Q:Lines, but can only be   #
2121 # added/removed by Services.                                          #
2122 #<module name="m_svshold.so">
2123
2124 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2125 # SWHOIS module: Allows you to add arbitary lines to user WHOIS.
2126 #<module name="m_swhois.so">
2127
2128 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2129 # Taxonomy module: Adds the /TAXONOMY command, used to view all
2130 #                  metadata attached to a user.
2131 #<module name="m_taxonomy.so">
2132
2133 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2134 # Test command module: Does nothing significant. Read: pointless.
2135 #<module name="m_testcommand.so">
2136
2137 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2138 # Timed bans module: Adds timed bans and the /TBAN command
2139 #<module name="m_timedbans.so">
2140
2141 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2142 # Test line module: Adds the /TLINE command, used to test how many
2143 # users a /GLINE or /ZLINE etc would match.
2144 #<module name="m_tline.so">
2145
2146 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2147 # UHNAMES support module: Adds support for the IRCX style UHNAMES
2148 # extension, which displays ident and hostname in the names list for
2149 # each user, saving clients from doing a WHO on the channel. Note that
2150 # this module is not widely supported yet. If a client does not support
2151 # UHNAMES it will not enable it, this will not break incompatible
2152 # clients.
2153 #<module name="m_uhnames.so">
2154
2155 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2156 # Uninvite module: Adds the /UNINVITE command which lets users remove
2157 # pending invites from channels without waiting for the user to join.
2158 #<module name="m_uninvite.so">
2159
2160 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2161 # Userip module: Adds the /USERIP command
2162 #<module name="m_userip.so">
2163
2164 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2165 # Vhost module: Adds the VHOST command which allows for adding virtual
2166 # hosts which are accessible using a username and password in the config.
2167 #<module name="m_vhost.so">
2168 #
2169 #-#-#-#-#-#-#-#-#-#-#- VHOST CONFIGURATION   -#-#-#-#-#-#-#-#-#-#-#-#-#
2170 #                                                                     #
2171 # user       - Username for the vhost.                                #
2172 #                                                                     #
2173 # pass       - Password for the vhost.                                #
2174 #                                                                     #
2175 # host       - Vhost to set.                                          #
2176 #
2177 #<vhost user="some_username" pass="some_password" host="some.host">
2178
2179 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2180 # Watch module: Adds the WATCH command, which is used by clients to 
2181 # maintain notify lists.
2182 #<module name="m_watch.so">
2183 #
2184 # Configuration tags:
2185 #
2186 #<watch maxentries="32">
2187 #
2188 # Sets the maximum number of entries on a user's watch list.
2189
2190 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2191 # XMLSocket module: Adds support for connections using the shockwave
2192 # flash XMLSocket. Note that this does not work if the client you are
2193 # using has retarded ideas of the IRC protocol. Your client must still
2194 # send RFC-correct lines to the server, this module only changes the
2195 # line ending from newlines to null terminators.
2196 #
2197 #<module name="m_xmlsocket.so">
2198
2199 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2200 # ZipLinks module: Adds support for zlib deflate on server to server
2201 # connections. Both ends of the connection must load this module.
2202 #
2203 #<module name="m_ziplink.so">
2204 #
2205 # To use this module, you must enable it as a transport type in your
2206 # <link> tags or <bind> tags using the transport name 'zip'.
2207 # See the documentation of <link> and <bind>, respectively.
2208 #
2209
2210 #-#-#-#-#-#-#-#-#-#-#-#-#-#-  BAN OPTIONS  -#-#-#-#-#-#-#-#-#-#-#-#-#-#
2211 #                                                                     #
2212 # The ban tags define nick masks, host masks and ip ranges which are  #
2213 # banned from your server. All details in these tags are local to     #
2214 # Your server.                                                        #
2215 #                                                                     #
2216 #                                                                     #
2217 # badip lines ban an ip range (same as a zline)                       #
2218 #                                                                     #
2219 # ipmask       -          The ip range to ban (wildcards possible)    #
2220 #                         CIDR is supported in the IP mask.           #
2221 # reason       -          Reason to display when disconnected         #
2222 #                                                                     #
2223 # badnick lines ban a nick mask (same as a qline)                     #
2224 #                                                                     #
2225 # nick         -          Nick mask to ban (wildcards possible)       #
2226 # reason       -          Reason to display on /NICK                  #
2227 #                                                                     #
2228 # badhost lines ban a user@host mask (same as a kline)                #
2229 #                                                                     #
2230 # host         -          ident@hostname (wildcards possible)         #
2231 #                         If you specify an IP, CIDR is supported.    #
2232 # reason       -          Reason to display on disconnection          #
2233 #                                                                     #
2234 # exception lines define a hostmask that is excempt from [kzg]lines   #
2235 #                                                                     #
2236 # host         -          ident@hostname (wildcards possible)         #
2237 #                         If you specify an IP, CIDR is supported.    #
2238 # reason       -          Reason, shown only in /stats e              #
2239 #                                                                     #
2240
2241 <badip ipmask="69.69.69.69" reason="No porn here thanks.">
2242
2243 <badnick nick="ChanServ" reason="Reserved For Services">
2244 <badnick nick="NickServ" reason="Reserved For Services">
2245 <badnick nick="OperServ" reason="Reserved For Services">
2246 <badnick nick="MemoServ" reason="Reserved For Services">
2247
2248 <badhost host="*@hundredz.n.hundredz.o.1337.kiddies.com" reason="Too many 1337 kiddiots">
2249 <badhost host="*@localhost" reason="No irc from localhost!">
2250 <badhost host="*@172.32.0.0/16" reason="This subnet is bad.">
2251
2252 <exception host="*@ircop.host.com" reason="Opers hostname">
2253
2254 #-#-#-#-#-#-#-#-#-#-#- INSANE BAN OPTIONS  -#-#-#-#-#-#-#-#-#-#-#-#-#-#
2255 #                                                                     #
2256 # This optional tag allows you to specify how wide a gline, eline,    #
2257 # kline, zline or qline can be before it is forbidden from being      #
2258 # set. By setting hostmasks="yes", you can allow all G, K, E lines,   #
2259 # no matter how many users the ban would cover. This is not           #
2260 # recommended! By setting ipmasks="yes", you can allow all Z lines,   #
2261 # no matter how many users these cover too. Needless to say we        #
2262 # don't recommend you do this, or, set nickmasks="yes", which will    #
2263 # allow any qline.                                                    #
2264 #                                                                     #
2265 # The trigger value indicates how wide any mask will be before it is  #
2266 # prevented from being set. The default value is 95.5% if this tag is #
2267 # not defined in your configuration file, meaning that if your        #
2268 # network has 1000 users, a gline matching over 955 of them will be   #
2269 # prevented from being added.                                         #
2270 #                                                                     #
2271 # Please note that remote servers (and services) are exempt from      #
2272 # these restrictions and expected to enforce their own policies       #
2273 # locally!                                                            #
2274 #                                                                     #
2275
2276 <insane hostmasks="no" ipmasks="no" nickmasks="no" trigger="95.5">
2277
2278 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#- YAWN  -#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2279 #                                                                     #
2280 #   You should already know what to do here :)                        #
2281
2282 <die value="User error. Insert new user and press any key. (you didn't edit your config properly.)">
2283
2284
2285 #########################################################################
2286 #                                                                       #
2287 #                     - InspIRCd Development Team -                     #
2288 #                        http://www.inspircd.org                        #
2289 #                                                                       #
2290 #########################################################################