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