]> git.netwichtig.de Git - user/henk/code/inspircd.git/blob - docs/inspircd.conf.example
Be a little nicer.. this die error is funny, but confusing (got me once too)
[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 # hidden        - 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       hidden="no"
556       sendpass="outgoing!password"
557       recvpass="incoming!password">
558
559 <link name="services.antarctic.com"
560       ipaddr="localhost"
561       port="7000"
562       allowmask="127.0.0.0/8"
563       sendpass="penguins"
564       recvpass="polarbears">
565
566
567 #-#-#-#-#-#-#-#-#-#-#-#- ULINES CONFIGURATION #-#-#-#-#-#-#-#-#-#-#-#-#
568 # This tag defines a ulined server. A U-Lined server has special      #
569 # permissions, and should be used with caution. Services servers are  #
570 # usually u-lined in this manner.                                     #
571 #                                                                     #
572 # The 'silent' value if set to yes indicates that this server should  #
573 # not generate quit and connect notices, which can cut down on noise  #
574 # to opers on the network.                                            #
575 #                                                                     #
576 <uline server="services.antarctic.com" silent="yes">
577
578
579 #-#-#-#-#-#-#-#-#-#-  MISCELLANEOUS CONFIGURATION  -#-#-#-#-#-#-#-#-#-#
580 #                                                                     #
581 #   These options let you define the path to your motd and rules      #
582 #   files. If these are relative paths, they are relative to the      #
583 #   configurtion directory.                                           #
584 #                                                                     #
585
586 <files motd="inspircd.motd.example"
587        rules="inspircd.rules.example">
588
589 #-#-#-#-#-#-#-#-#-#-#-# MAXIMUM CHANNELS -#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
590 #                                                                     #
591 # This optional configuration tag lets you define the maximum number  #
592 # of channels that both opers and users may be on at any one time.    #
593 # the default is 20 for user and 60 for opers if this tag is not      #
594 # defined. Remote users are not restricted in any manner.             #
595 #                                                                     #
596
597 <channels users="20"
598           opers="60">
599
600 #-#-#-#-#-#-#-#-#-#-#-#-#-#-# DNS SERVER -#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
601 #                                                                     #
602 # Define your DNS server address here. InspIRCd has its own resolver. #
603 # If you do not define this value, then then InspIRCd will attempt to #
604 # determine your DNS server from your operating system. On POSIX      #
605 # platforms, InspIRCd will read /etc/resolv.conf, and populate this   #
606 # value with the first DNS server address found. On Windows platforms #
607 # InspIRCd will check the registry, and use the DNS server of the     #
608 # first active network interface, if one exists.                      #
609 # If a DNS server cannot be determined from these checks, the default #
610 # value '127.0.0.1' is used instead. The timeout value is in seconds. #
611 #                                                                     #
612 #    ____                _   _____ _     _       ____  _ _   _        #
613 #   |  _ \ ___  __ _  __| | |_   _| |__ (_)___  | __ )(_) |_| |       #
614 #   | |_) / _ \/ _` |/ _` |   | | | '_ \| / __| |  _ \| | __| |       #
615 #   |  _ <  __/ (_| | (_| |   | | | | | | \__ \ | |_) | | |_|_|       #
616 #   |_| \_\___|\__,_|\__,_|   |_| |_| |_|_|___/ |____/|_|\__(_)       #
617 #                                                                     #
618 # When choosing a server, be sure to choose one which will do a       #
619 # RECURSIVE LOOKUP. InspIRCd's resolver does not currently do these   #
620 # recursive lookups itself, to save time and resources. The dns       #
621 # server recommended by the InspIRCd team is bind, available from the #
622 # ISC website. If your DNS server does not do a recursive lookup, you #
623 # will be able to notice this by the fact that none of your users are #
624 # resolving even though the DNS server appears to be up! Most ISP and #
625 # hosting provider DNS servers support recursive lookups.             #
626 #                                                                     #
627 # ------------------------------------------------------------------- #
628 #                                                                     #
629 # NOTE: if you have built InspIRCd with IPV6 support, then both       #
630 # ipv6 and ipv4 addresses are allowed here, and also in the system    #
631 # resolv.conf file. Remember that an ipv4 dns server can still        #
632 # resolve ipv6 addresses, and vice versa.                             #
633 #                                                                     #
634
635 <dns server="127.0.0.1" timeout="5">
636
637 # An example of using an IPV6 nameserver
638 #<dns server="::1" timeout="5">
639
640 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#  PID FILE  -#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
641 #                                                                     #
642 # Define the path to the PID file here. The PID file can be used to   #
643 # rehash the ircd from the shell or to terminate the ircd from the    #
644 # shell using shell scripts, perl scripts etc, and to monitor the     #
645 # ircd's state via cron jobs. If this is a relative path, it will be  #
646 # relative to the configuration directory, and if it is not defined,  #
647 # the default of 'inspircd.pid' is used.                              #
648 #                                                                     #
649
650 #<pid file="/path/to/inspircd.pid">
651
652 #-#-#-#-#-#-#-#-#-#-#-#-#- BANLIST LIMITS #-#-#-#-#-#-#-#-#-#-#-#-#-#-#
653 #                                                                     #
654 # Use these tags to customise the ban limits on a per channel basis.  #
655 # the tags are read from top to bottom, and any tag found which       #
656 # matches the channels name applies the banlimit to that channel.     #
657 # It is advisable to put an entry with the channel as '*' at the      #
658 # bottom of the list. If none are specified or no maxbans tag is      #
659 # matched, the banlist size defaults to 64 entries.                   #
660 #                                                                     #
661
662 <banlist chan="#morons" limit="128">
663 <banlist chan="*" limit="69">
664
665 #-#-#-#-#-#-#-#-#-#-#-  DISABLED COMMANDS  -#-#-#-#-#-#-#-#-#-#-#-#-#-#
666 #                                                                     #
667 # This tag is optional, and specifies one or more commands which are  #
668 # not available to non-operators. For example you may wish to disable #
669 # NICK and prevent non-opers from changing their nicknames.           #
670 # Note that any disabled commands take effect only after the user has #
671 # 'registered' (e.g. after the initial USER/NICK/PASS on connection)  #
672 # so for example disabling NICK will not cripple your network.        #
673 #                                                                     #
674
675 #<disabled commands="TOPIC MODE">
676
677
678 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-  RTFM LINE  -#-#-#-#-#-#-#-#-#-#-#-#-#-#
679 #                                                                     #
680 #   Just remove this... Its here to make you read ALL of the config   #
681 #   file options ;)                                                   #
682
683 <die value="You should probably edit your config *PROPERLY* and try again.">
684
685
686
687 #-#-#-#-#-#-#-#-#-#-#-#-#-  SERVER OPTIONS   -#-#-#-#-#-#-#-#-#-#-#-#-#
688 #                                                                     #
689 #   Settings to define which features are useable on your server.     #
690 #                                                                     #
691 #  prefixquit    - A prefix to be placed on the start of a client's   #
692 #                  quit message                                       #
693 #                                                                     #
694 #  suffixquit    - A suffix to be placed on the end of a client's     #
695 #                  quit message.                                      #
696 #                                                                     #
697 #  fixedquit     - A fixed quit message to display for all client     #
698 #                  QUITS. If specified, overrides both prefixquit     #
699 #                  and suffixquit options.                            #
700 #                                                                     #
701 #  loglevel      - specifies what detail of messages to log in the    #
702 #                  log file. You may select from debug, verbose,      #
703 #                  default, sparse and none.                          #
704 #                                                                     #
705 #  allowhalfop   - allows the +h channel mode                         #
706 #                                                                     #
707 #  noservices    - If noservices is true, yes, or 1, then the first   #
708 #                  user into a channel gets founder status. This is   #
709 #                  only useful on networks running the m_chanprotect  #
710 #                  module without services.                           #
711 #                                                                     #
712 #  qaprefixes    - If qaprefixes is true, yes, or 1, then users       #
713 #                  with +q or +a will get the ~ or & prefixes         #
714 #                  used in unreal. This is only useful on networks    #
715 #                  running the m_chanprotect module                   #
716 #                                                                     #
717 #  deprotectself - If this value is set to yes, true, or 1, then any  #
718 #                  user with +q or +a may remove the +q or +a from    #
719 #                  themselves. The default setting is to not enable   #
720 #                  this feature, which stops even the founder taking  #
721 #                  away their founder status without using services.  #
722 #                                                                     #
723 #  deprotectothers-If this value is set to yes, true, or 1, then any  #
724 #                  user with +q or +a may remove the +q or +a from    #
725 #                  other users. The default setting is to not enable  #
726 #                  this feature, so that only +q may remove +a, and   #
727 #                  nothing but services may remove +q.                #
728 #                                                                     #
729 #  cyclehosts    - If this is set to true, yes or 1, then when a      #
730 #                  user's hostname changes, they will appear to quit  #
731 #                  and then rejoin with their new host. This prevents #
732 #                  clients from being confused by host changes,       #
733 #                  especially in the case of bots, and it is          #
734 #                  recommended that this option is enabled.           #
735 #                                                                     #
736 #  netbuffersize - size of the buffer used to receive data from       #
737 #                  clients. The ircd may only read() this amount      #
738 #                  of text in one go at any time. (OPTIONAL)          #
739 #                                                                     #
740 #  maxwho        - The maximum number of results returned by a /WHO   #
741 #                  query. This is to prevent /WHO being used as a     #
742 #                  spam vector or means of flooding an ircd. The      #
743 #                  default is 128, it is not recommended to raise it  #
744 #                  above 1024. Values up to 65535 are permitted.      #
745 #                                                                     #
746 #  somaxconn     - The maximum number of sockets that may be waiting  #
747 #                  in the accept queue. This usually allows the ircd  #
748 #                  to soak up more connections in a shorter space of  #
749 #                  time when increased but please be aware there is a #
750 #                  system defined maximum value to this, the same way #
751 #                  there is a system defined maximum number of file   #
752 #                  descriptors. Some systems may only allow this to   #
753 #                  be up to 5 (ugh) while others such as FreeBSD will #
754 #                  default to a much nicer 128.                       #
755 #                                                                     #
756 #  moduledir     - This optional value indicates a runtime change of  #
757 #                  the location where modules are to be found. This   #
758 #                  does not add a supplementary directory. There can  #
759 #                  only be one module path.                           #
760 #                                                                     #
761 #  softlimit     - This optional feature allows a defined softlimit.  #
762 #                  if defined sets a soft maxconnections value, has   #
763 #                  to be less than the ./configure maxclients         #
764 #                                                                     #
765 #  userstats     - The userstats field is optional and specifies      #
766 #                  which stats characters in /STATS may be requested  #
767 #                  by non-operators. Stats characters in this field   #
768 #                  are case sensitive and are allowed to users        #
769 #                  independent of if they are in a module or the core #
770 #                                                                     #
771 #  operspywhois  - If this is set then when an IRC operator uses      #
772 #                  /WHOIS on a user they will see all channels, even  #
773 #                  ones if channels are secret (+s), private (+p) or  #
774 #                  if the target user is invisible +i.                #
775 #                                                                     #
776 #  customversion - If you specify this configuration item, and it is  #
777 #                  not set to an empty value, then when a user does   #
778 #                  a /VERSION command on the ircd, this string will   #
779 #                  be displayed as the second portion of the output,  #
780 #                  replacing the system 'uname', compile flags and    #
781 #                  socket engine/dns engine names. You may use this   #
782 #                  to enhance security, or simply for vanity.         #
783 #                                                                     #
784 #  maxtargets    - The maxtargets field is optional, and if not       #
785 #                  defined, defaults to 20. It indicates the maximum  #
786 #                  number of targets which may be given to commands   #
787 #                  such as PRIVMSG, KICK etc.                         #
788 #                                                                     #
789 #  hidesplits    - When set to 'yes', will hide split server names    #
790 #                  from non-opers. Non-opers will see '*.net *.split' #
791 #                  instead of the server names in the quit message,   #
792 #                  identical to the way IRCu displays them.           #
793 #                                                                     #
794 #  hidebans      - When set to 'yes', will hide gline, kline, zline   #
795 #                  and qline quit messages from non-opers. For        #
796 #                  example, user A who is not an oper will just see   #
797 #                  (G-Lined) while user B who is an oper will see the #
798 #                  text (G-Lined: Reason here) instead.               #
799 #                                                                     #
800 #  hidewhois     - When defined with a non-empty value, the given     #
801 #                  text will be used in place of the user's server    #
802 #                  in WHOIS, when a user is WHOISed by a non-oper.    #
803 #                  For example, most nets will want to set this to    #
804 #                  something like '*.netname.net' to conceal the      #
805 #                  actual server the user is on.                      #
806 #                                                                     #
807 #  flatlinks     - When you are using m_spanningtree.so, and this     #
808 #                  value is set to true, yes or 1, /MAP and /LINKS    #
809 #                  will be flattened when shown to a non-oper.        #
810 #                                                                     #
811 #  hideulines    - When you are using m_spanningtree.so, and this     #
812 #                  value is set to true, yes or 1, then U-lined       #
813 #                  servers will be hidden in /LINKS and /MAP. For non #
814 #                  opers. Please be aware that this will also hide    #
815 #                  any leaf servers of a U-lined server, e.g. jupes.  #
816 #                                                                     #
817 #  nouserdns     - If set to 'yes', 'true' or '1', no user dns        #
818 #                  lookups will be performed for connecting users.    #
819 #                  this can save a lot of resources on very busy irc  #
820 #                  servers.                                           #
821 #                                                                     #
822 #  syntaxhints   - If set to 'yes', 'true' or '1', when a user does   #
823 #                  not give enough parameters for a command, a syntax #
824 #                  hint will be given (using the RPL_TEXT numeric)    #
825 #                  as well as the standard ERR_NEEDMOREPARAMS.        #
826 #                                                                     #
827 #  announcets    - If this value is defined to 'yes', 'true' or '1',  #
828 #                  then if a channel's timestamp is updated the users #
829 #                  on the channel will be informed of the change via  #
830 #                  a server notice to the channel with the old and    #
831 #                  new TS values in the timestamp. If you think this  #
832 #                  is just pointless noise, define the value to 0.    #
833 #                                                                     #
834 #  ircumsgprefix - Use undernet style message prefix for channel      #
835 #                  NOTICE and PRIVMSG adding the prefix to the line   #
836 #                  of text sent out. Eg. NOTICE @#test :@ testing     #
837 #                  vs. the off setting: NOTICE @#test :testing        #
838 #                                                                     #
839 #  hostintopic   - If this is set to yes (the default) then the full  #
840 #                  nick!user@host is shown for who set a TOPIC last.  #
841 #                  if set to no, then only the nickname is shown.     #
842 #                                                                     #
843 # announceinvites                                                     #
844 #                - If this option is set to yes (the default), then   #
845 #                  invites are announced to the channel when a user   #
846 #                  invites annother user. If you consider this to be  #
847 #                  unnecessary noise, explicitly set this to no.      #
848 #                                                                     #
849 #  disablehmac   - If you are linking your InspIRCd to older versions #
850 #                  then you can specify this option and set it to     #
851 #                  yes. 1.1.6 and above support HMAC and challenge-   #
852 #                  response for password authentication. These can    #
853 #                  greatly enhance security of your server to server  #
854 #                  connections when you are not using SSL (as is the  #
855 #                  case with a lot of larger networks). Linking to    #
856 #                  older versions of InspIRCd should not *usually* be #
857 #                  a problem, but if you have problems with HMAC      #
858 #                  authentication, this option can be used to turn it #
859 #                  off.                                               #
860 #                                                                     #
861 #  hidemodes     - If this option is enabled, then the listmodes      #
862 #                  given (e.g. +eI), will be hidden from users below  #
863 #                  halfop. This is not recommended to be set on mode  #
864 #                  +b, as it may break some features in popular       #
865 #                  clients such as mIRC.                              #
866 #                                                                     #
867 #  quietbursts   - When synching or splitting from the network, a     #
868 #                  server can generate a lot of connect and quit      #
869 #                  snotices to the +C and +Q snomasks. Setting this   #
870 #                  value to yes squelches those messages, which can   #
871 #                  make them more useful for opers, however it will   #
872 #                  degrade their use by certain third party programs  #
873 #                  such as BOPM which rely on them to scan users when #
874 #                  a split heals in certain configurations.           #
875 #                                                                     #
876 #  pingwarning   - This should be set to a number between 1 and 59 if #
877 #                  defined, and if it is defined will cause the server#
878 #                  to send out a warning via snomask +l if a server   #
879 #                  does not answer to PING after this many seconds.   #
880 #                  This can be useful for finding servers which are   #
881 #                  at risk of pinging out due to network issues.      #
882 #                                                                     #
883 #  exemptchanops - This option allows channel operators to be exempted#
884 #                  from certain channel modes.                        #
885 #                  Supported modes are +SfgNc. Defaults to off.       #
886 #                                                                     #
887 #  defaultmodes  - The default modes to be given to each channel on   #
888 #                  creation. Defaults to 'nt'. There should be no +   #
889 #                  or - symbols in this sequence, if you add them     #
890 #                  they will be ignored. You may add parameters for   #
891 #                  parameterised modes.                               #
892 #                                                                     #
893 #  moronbanner   - The NOTICE to show to users who are glined, zlined #
894 #                  klined or qlined when they are disconnected. This  #
895 #                  is totally freeform, you may place any text here   #
896 #                  you wish.                                          #
897 #                                                                     #
898
899 <options prefixquit="Quit: "
900          loglevel="default"
901          netbuffersize="10240"
902          maxwho="128"
903          noservices="no"
904          qaprefixes="no"
905          deprotectself="no"
906          deprotectothers="no"
907          somaxconn="128"
908          softlimit="12800"
909          userstats="Pu"
910          operspywhois="no"
911          customversion=""
912          maxtargets="20"
913          hidesplits="no"
914          hidebans="no"
915          hidewhois=""
916          flatlinks="no"
917          hideulines="no"
918          nouserdns="no"
919          syntaxhints="no"
920          cyclehosts="yes"
921          ircumsgprefix="no"
922          announcets="yes"
923          disablehmac="no"
924          hostintopic="yes"
925          hidemodes="eI"
926          quietbursts="yes"
927          pingwarning="15"
928          allowhalfop="yes"
929          defaultmodes="nt"
930          moronbanner="You're banned! Email haha@abuse.com with the ERROR line below for help."
931          exemptchanops="">
932
933 #-#-#-#-#-#-#-#-#-#-#-#-#-#- TIME SYNC OPTIONS -#-#-#-#-#-#-#-#-#-#-#-#
934 # Time sychronization options for m_spanningtree linking.             #
935 #                                                                     #
936 # Because IRC is very time and clock dependent, InspIRCd provides its #
937 # own methods for syncronization of time between servers as shown     #
938 # in the example below, for servers that don't have ntpd running.     #
939 #                                                                     #
940 #  enable    -     If this value is 'yes', 'true', or '1', time       #
941 #                  synchronization is enabled on this server. This    #
942 #                  means any servers you are linked to will           #
943 #                  automatically synchronize time, however you should #
944 #                  use ntpd instead where possible, NOT this option.  #
945 #                                                                     #
946 #  master    -     If this value is set to yes, then this server will #
947 #                  act as the authoritative time source for the whole #
948 #                  network. All other servers will respect its time   #
949 #                  without question, and match their times to it.     #
950 #                  only one server should have the master value set   #
951 #                  to 'yes'.                                          #
952 #                                                                     #
953 <timesync enable="no" master="no">
954
955 #-#-#-#-#-#-#-#-#-#-#-#-#-  WHOWAS OPTIONS   -#-#-#-#-#-#-#-#-#-#-#-#-#
956 #                                                                     #
957 # This tag lets you define the behaviour of the /whowas command of    #
958 # your server.                                                        #
959 #                                                                     #
960 # groupsize      - Controls the maximum entries per nick shown when   #
961 #                  performing a /whowas nick. Setting this to 0 dis-  #
962 #                  ables whowas completely.                           #
963 #                                                                     #
964 # maxgroups      - The maximum number of nickgroups that can be added #
965 #                  to the list. If max is reached, oldest group will  #
966 #                  be deleted first like a FIFO. A groupsize of 3 and #
967 #                  a maxgroups of 5000 will allow for 5000 nicks to   #
968 #                  be stored with a history of 3, thus giving a total #
969 #                  of 3 * 5000 = 15000 entries. A setting of 0 dis-   #
970 #                  ables whowas completely.                           #
971 #                                                                     #
972 # maxkeep        - The maximum time a nick is kept in the whowas list #
973 #                  before being pruned. Time may be specified in      #
974 #                  seconds, or in the following format: 1y2w3d4h5m6s  #
975 #                  meaning one year, two weeks, three days, 4 hours,  #
976 #                  5 minutes and 6 seconds. All fields in this format #
977 #                  are optional. Minimum is 1 hour, if less InspIRCd  #
978 #                  will default back to 1 hour.                       #
979 #                                                                     #
980 #<whowas groupsize="10"                                               #
981 #        maxgroups="100000"                                           #
982 #        maxkeep="3d">                                                #
983
984
985 #-#-#-#-#-#-#-#-#-#-#-#-#-  MODULE OPTIONS   -#-#-#-#-#-#-#-#-#-#-#-#-#
986 #                                                                     #
987 #  These tags define which modules will be loaded on startup by your  #
988 #  server. Add modules without any paths. When you make your ircd     #
989 #  using the 'make' command, all compiled modules will be moved into  #
990 #  the folder you specified when you ran ./configure. The module tag  #
991 #  automatically looks for modules in this location.                  #
992 #  If you attempt to load a module outside of this location, either   #
993 #  in the config, or via /LOADMODULE, you will receive an error.      #
994 #                                                                     #
995 #  By default, ALL modules are commented out. You must uncomment them #
996 #  or add lines to your config to load modules. Please refer to       #
997 #  http://www.inspircd.org/wiki/Modules_List for a list of modules and#
998 #  each modules link for any additional conf tags they require.       #
999 #                                                                     #
1000 #  You may use wildcards in a <module> tag to load all modules which  #
1001 #  match a glob pattern (e.g. m_sa????.so would load m_sajoin,        #
1002 #  m_sapart, m_saquit and m_sanick)                                   #
1003 #                                                                     #
1004 #    ____                _   _____ _     _       ____  _ _   _        #
1005 #   |  _ \ ___  __ _  __| | |_   _| |__ (_)___  | __ )(_) |_| |       #
1006 #   | |_) / _ \/ _` |/ _` |   | | | '_ \| / __| |  _ \| | __| |       #
1007 #   |  _ <  __/ (_| | (_| |   | | | | | | \__ \ | |_) | | |_|_|       #
1008 #   |_| \_\___|\__,_|\__,_|   |_| |_| |_|_|___/ |____/|_|\__(_)       #
1009 #                                                                     #
1010 # To link servers to InspIRCd, you MUST load the m_spanningtree       #
1011 # module, as shown below. If you DO NOT do this, server links will    #
1012 # NOT work at all. ie. The ports will NOT bind, and /connect will not #
1013 # work properly. This is by design, to allow for the implementation   #
1014 # of other linking protocols in modules in the future.                #
1015
1016 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1017 # Spanning Tree module - allows linking of servers using the spanning
1018 # tree protocol (see the READ THIS BIT section above).
1019 #
1020 #<module name="m_spanningtree.so">
1021
1022
1023 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1024 # MD5 Module - Allows other modules to generate MD5 hashes, usually for
1025 # cryptographic uses and security.
1026 #
1027 # IMPORTANT:
1028 # Other modules such as m_cloaking.so and m_opermd5.so may rely on
1029 # this module being loaded to function.
1030 #
1031 #<module name="m_md5.so">
1032 #
1033 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1034 # SHA256 Module - Allows other modules to generate SHA256 hashes,
1035 # usually for cryptographic uses and security.
1036 #
1037 # IMPORTANT:
1038 # Other modules such as m_opermd5.so may rely on this module being
1039 # loaded to function.
1040 #
1041 #<module name="m_sha256.so">
1042
1043 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1044 # Alias module: Allows you to define server-side command aliases
1045 #<module name="m_alias.so">
1046 #
1047 #-#-#-#-#-#-#-#-#-#-#-  ALIAS DEFINITIONS  -#-#-#-#-#-#-#-#-#-#-#-#-#-#
1048 #                                                                     #
1049 # If you have the m_alias.so module loaded, you may also define       #
1050 # aliases as shown below. They are commonly used to provide shortcut  #
1051 # commands to services, however they are not limited to just this use.#
1052 # An alias tag requires the following values to be defined in it:     #
1053 #                                                                     #
1054 # text        -      The text to detect as the actual command line,   #
1055 #                    Cant contain spaces, but case insensitive.       #
1056 #                    You may have multiple aliases with the same      #
1057 #                    command name (text="" value), however the first  #
1058 #                    found will be executed if its format value is    #
1059 #                    matched, or it has no format value. Aliases are  #
1060 #                    read from the top of the file to the bottom.     #
1061 #                                                                     #
1062 # format      -      If this is defined, the parameters of the alias  #
1063 #                    must match this glob pattern. For example if you #
1064 #                    want the first parameter to start with a # for   #
1065 #                    the alias to be executed, set format="#*" in the #
1066 #                    alias definition. Note that the :'s which are    #
1067 #                    part of IRC formatted lines will be preserved    #
1068 #                    for matching of this text. This value is         #
1069 #                    optional.                                        #
1070 #                                                                     #
1071 # replace     -      The text to replace 'text' with. Usually this    #
1072 #                    will be "PRIVMSG ServiceName :$2-" or similar.   #
1073 #                    You may use the variables $1 through $9 in the   #
1074 #                    replace string, which refer to the first through #
1075 #                    ninth word in the original string typed by the   #
1076 #                    user. You may also use $1- through $9- which     #
1077 #                    refer to the first word onwards, through to the  #
1078 #                    ninth word onwards, e.g. if the user types the   #
1079 #                    command "foo bar baz qux quz" then $3- will hold #
1080 #                    "baz qux quz" and $2 will contain "bar". You may #
1081 #                    also use the special variables: $nick, $ident,   #
1082 #                    $host and $vhost, and you may seperate multiple  #
1083 #                    commands with \n. If you wish to use the ACTUAL  #
1084 #                    characters \ and n together in a line, you must  #
1085 #                    use the sequence "\\n".                          #
1086 #                                                                     #
1087 # requires    -      If you provide a value for 'requires' this means #
1088 #                    the given nickname MUST be online for the alias  #
1089 #                    to successfully trigger. If they are not, then   #
1090 #                    the user receives a 'no such nick' 401 numeric.  #
1091 #                                                                     #
1092 # uline       -      Defining this value with 'yes', 'true' or '1'    #
1093 #                    will ensure that the user given in 'requires'    #
1094 #                    must also be on a u-lined server, as well as     #
1095 #                    actually being on the network. If the user is    #
1096 #                    online, but not on a u-lined server, then an     #
1097 #                    oper-alert is sent out as this is possibly signs #
1098 #                    of a user trying to impersonate a service.       #
1099 #                                                                     #
1100 # operonly    -      Defining this value, with a value of 'yes', '1'  #
1101 #                    or true will make the alias oper only. If a non- #
1102 #                    oper attempts to use the alias, it will appear   #
1103 #                    to not exist.                                    #
1104 #                                                                     #
1105 #<alias text="NICKSERV" replace="PRIVMSG NickServ :$2-" requires="NickServ" uline="yes">
1106 #<alias text="CHANSERV" replace="PRIVMSG ChanServ :$2-" requires="ChanServ" uline="yes">
1107 #<alias text="OPERSERV" replace="PRIVMSG OperServ :$2-" requires="OperServ" uline="yes" operonly="yes">
1108 #<alias text="NS" replace="PRIVMSG NickServ :$2-" requires="NickServ" uline="yes">
1109 #<alias text="CS" replace="PRIVMSG ChanServ :$2-" requires="ChanServ" uline="yes">
1110 #<alias text="OS" replace="PRIVMSG OperServ :$2-" requires="OperServ" uline="yes" operonly="yes">
1111 #
1112 # An example of using the format value to create an alias with two
1113 # different behaviours depending on the format of the parameters.
1114 #
1115 #<alias text="ID" format="#*" replace="PRIVMSG ChanServ :IDENTIFY $2 $3"
1116 #  requires="ChanServ" uline="yes">
1117 #
1118 #<alias text="ID" replace="PRIVMSG NickServ :IDENTIFY $2"
1119 #  requires="NickServ" uline="yes">
1120 #
1121 # This alias fixes a glitch in xchat 2.6.x and above and the way it
1122 # assumes IDENTIFY must be prefixed by a colon (:) character. It should
1123 # be placed ABOVE the default NICKSERV alias (the first example) listed
1124 # above.
1125 #
1126 #<alias text="NICKSERV" format=":IDENTIFY *" replace="PRIVMSG NickServ :IDENTIFY $3-"
1127 #  requires="NickServ" uline="yes">
1128
1129 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1130 # Alltime module: Shows time on all connected servers at once
1131 #<module name="m_alltime.so">
1132
1133 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1134 # Antibear security module: Prevents 'bear.txt' based trojans from
1135 # connecting to your network by sending them a numeric they can't handle.
1136 #<module name="m_antibear.so">
1137
1138 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1139 # Antibottler module: Labels bottler leech bots
1140 #<module name="m_antibottler.so">
1141
1142 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1143 # Auditorium module: Adds channel mode +u which makes everyone else
1144 # except you in the channel invisible, used for large meetings etc.
1145 #<module name="m_auditorium.so">
1146 #
1147 # Auditorium settings:
1148 #
1149 #<auditorium showops="no">
1150 #
1151 # Setting this value to yes makes m_auditorium behave like unrealircd
1152 # +u channel mode, e.g. ops see users joining, parting, etc, and users
1153 # joining the channel see the ops. Without this flag, the mode acts
1154 # like ircnet's +a (anonymous channels), showing only the user in the
1155 # names list, and not even showing the ops in the list, or showing the
1156 # ops that the user has joined.
1157
1158 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1159 # Ban except module: Adds support for channel ban exceptions (+e)
1160 #<module name="m_banexception.so">
1161
1162 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1163 # Ban redirection module: Allows bans which redirect to a specified
1164 # channel. e.g. +b nick!ident@host#channelbanneduserissentto
1165 #<module name="m_banredirect.so">
1166
1167 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1168 # Block amsg module: Attempt to block all usage of /amsg and /ame
1169 #<module name="m_blockamsg.so">
1170 #
1171 #-#-#-#-#-#-#-#-#-#-#-  BLOCKAMSG CONFIGURATION  -#-#-#-#-#-#-#-#-#-#-#
1172 #                                                                     #
1173 # If you have the m_blockamsg.so module loaded, you can configure it  #
1174 # with the <blockamsg> tag:                                           #
1175 #                                                                     #
1176 # delay          -   How many seconds between two messages to force   #
1177 #                    them to be recognised as unrelated.              #
1178 # action         -   Any of 'notice', 'noticeopers', 'silent', 'kill' #
1179 #                    or 'killopers'. Define how to take action when   #
1180 #                    a user uses /amsg or /ame.                       #
1181 #
1182 #<blockamsg delay="3" action="killopers">
1183
1184 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1185 # Block CAPS module: Blocking all-CAPS messages with cmode +P
1186 #<module name="m_blockcaps.so">
1187 #                                                                     #
1188 #-#-#-#-#-#-#-#-#-#-#-  BLOCKCAPS CONFIGURATION  -#-#-#-#-#-#-#-#-#-#-#
1189 #                                                                     #
1190 # percent        - How many percent of text must be caps before text  #
1191 #                  will be blocked.                                   #
1192 #                                                                     #
1193 # minlen         - The minimum length a line must be for the block    #
1194 #                  percent to have any effect.                        #
1195 #                                                                     #
1196 # capsmap        - A list of chars to be considered CAPS, this was    #
1197 #                  you can add CAPS for your language. Also you can   #
1198 #                  add things like ! and space to further lock down   #
1199 #                  on caps usage.                                     #
1200 #<blockcaps percent="50"
1201 #           minlen="5"
1202 #           capsmap="ABCDEFGHIJKLMNOPQRSTUVWXYZ! ">
1203
1204 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1205 # Block colour module: Blocking colour-coded messages with cmode +c
1206 #<module name="m_blockcolor.so">
1207
1208 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1209 # Botmode module: Adds the user mode +B
1210 #<module name="m_botmode.so">
1211
1212 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1213 # CBAN module: Lets you disallow channels from being used at runtime.
1214 #<module name="m_cban.so">
1215
1216 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1217 # Censor module: Adds the channel mode +G
1218 #<module name="m_censor.so">
1219 #
1220 #-#-#-#-#-#-#-#-#-#-#-  CENSOR  CONFIGURATION  -#-#-#-#-#-#-#-#-#-#-#-#
1221 #                                                                     #
1222 # Optional - If you specify to use the m_censor module, then you must #
1223 # specify some censor tags. See also:                                 #
1224 # http://www.inspircd.org/wiki/Censor_Module                          #
1225 #
1226 #<include file="censor.conf">
1227
1228 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1229 # CGI:IRC module: Adds support for automatic host changing in CGI:IRC
1230 # (http://cgiirc.sourceforge.net).
1231 #<module name="m_cgiirc.so">
1232 #
1233 #-#-#-#-#-#-#-#-#-#-#-# CGIIRC  CONFIGURATION #-#-#-#-#-#-#-#-#-#-#-#-#
1234 #
1235 # Optional - If you specify to use m_cgiirc, then you must specify one
1236 # or more cgihost tags which indicate authorized CGI:IRC servers which
1237 # will be connecting to your network, and an optional cgiirc tag.
1238 # For more information see: http://www.inspircd.org/wiki/CGI-IRC_Module
1239 #
1240 # Set to yes if you want to notice opers when CGI clients connect
1241 # <cgiirc opernotice="no">
1242 #
1243 # The type field indicates where the module should get the real
1244 # client's IP address from, for further information, please see the
1245 # CGI:IRC documentation.
1246 #
1247 # <cgihost type="pass" mask="www.mysite.com">       # Get IP from PASS
1248 # <cgihost type="webirc" mask="somebox.mysite.com"> # Get IP from WEBIRC
1249 # <cgihost type="ident" mask="otherbox.mysite.com"> # Get IP from ident
1250 # <cgihost type="passfirst" mask="www.mysite.com">  # See the docs
1251
1252
1253 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1254 # Channel create module: Adds snomask +j, which will notify opers of
1255 # any new channels that are created
1256 #<module name="m_chancreate.so">
1257
1258 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1259 # Channel filter module: Allows channel-op defined message
1260 # filtering using simple string matches (channel mode +g)
1261 #<module name="m_chanfilter.so">
1262
1263 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1264 # Chanprotect module: gives +q and +a channel modes
1265 #<module name="m_chanprotect.so">
1266
1267 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1268 # Check module: gives /check
1269 # Check is useful for looking up information on channels,
1270 # users, IP addresses and hosts.
1271 #<module name="m_check.so">
1272
1273 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1274 # CHGHOST module: Adds the /CHGHOST command
1275 #<module name="m_chghost.so">
1276 #
1277 #-#-#-#-#-#-#-#-# /CHGHOST - /SETHOST  CONFIGURATION #-#-#-#-#-#-#-#-#
1278 # Optional - If you want to use special chars for hostnames you can  #
1279 # specify your own custom list of chars with the <hostname> tag:     #
1280 #                                                                    #
1281 # charmap        - A list of chars accepted as valid by the /CHGHOST #
1282 #                  and /SETHOST commands. Also note that the list is # 
1283 #                  case-sensitive.                                   #
1284 #<hostname charmap="abcdefghijklmnopqrstuvwxyz.-_/0123456789">
1285
1286 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1287 # CHGIDENT module: Adds the /CHGIDENT command
1288 #<module name="m_chgident.so">
1289
1290 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1291 # Cloaking module: Adds usermode +x and cloaking support.
1292 # Relies on the module m_md5.so being loaded before m_cloaking.so in
1293 # the configuration file.
1294 #<module name="m_cloaking.so">
1295 #
1296 #-#-#-#-#-#-#-#-#-#-#- CLOAKING  CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#
1297 #                                                                     #
1298 # Optional - If you specify the m_cloaking.so module as above, you    #
1299 # must define cloak keys, and optionally a cloak prefix as shown      #
1300 # below. When using cloaking, the cloak keys are MANDITORY and must   #
1301 # be included. However, if prefix is not included, it will default    #
1302 # to your networks name from the <server> tag.                        #
1303 #                                                                     #
1304 # <cloak key1="0x2AF39F40"                                            #
1305 #        key2="0x78E10B32"                                            #
1306 #        key3="0x4F2D2E82"                                            #
1307 #        key4="0x043A4C81"                                            #
1308 #        prefix="mynet">                                              #
1309 #                                                                     #
1310 # Please note that the key values will accept any number, and should  #
1311 # be large numbers. Using small numbers such as "7" or "1924" will    #
1312 # seriously weaken the security of your cloak. It is recommended you  #
1313 # use hexdecimal numbers prefixed by "0x", as shown in this example,  #
1314 # with each key eight hex digits long.                                #
1315
1316 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1317 # Clones module: Adds an oper command /CLONES for detecting cloned
1318 # users. Warning: This module may be resource intensive when its
1319 # command is issued, use with care.
1320 #<module name="m_clones.so">
1321
1322 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1323 # Conn-Join: Allows you to force users to join one or more channels
1324 # automatically upon connecting to the server.
1325 #<module name="m_conn_join.so">
1326 #
1327 #-#-#-#-#-#-#-#-#-#-#-#- CONNJOIN CONFIGURATION  -#-#-#-#-#-#-#-#-#-#-#
1328 #
1329 # If you have m_conn_join.so loaded, you can configure it using the
1330 # follow values:
1331 #
1332 #<autojoin channel="#one,#two,#three">
1333
1334 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1335 # Conn-Usermodes: Set modes on users when they connect
1336 # When this module is loaded <connect:allow> tags may have an optional
1337 # modes="" value, which contains modes to add or remove from users
1338 # when they connect to the server.
1339 #<module name="m_conn_umodes.so">
1340
1341 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1342 # Conn-Wait-for-Pong: Don't let a user connect until they PONG
1343 #<module name="m_conn_waitpong.so">
1344 #
1345 #-#-#-#-#-#-#-#-#-#-#-   WAITPONG CONFIGURATION  -#-#-#-#-#-#-#-#-#-#-#
1346 #                                                                     #
1347 # If you have the m_conn_waitpong.so module loaded, configure it with #
1348 # the <waitpong> tag:                                                 #
1349 #                                                                     #
1350 # sendsnotice    -   Whether to send a snotice on connect, like other #
1351 #                    older ircds                                      #
1352 #                                                                     #
1353 # killonbadreply -   Whether to kill the user if they send the wrong  #
1354 #                    PONG reply.                                      #
1355 #                                                                     #
1356 #<waitpong sendsnotice="yes" killonbadreply="yes">
1357
1358
1359 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1360 # Channel cycle module. Server side /hop, with +ilk etc bypass.
1361 #<module name="m_cycle.so">
1362
1363 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1364 # Connection throttle module. Configuration:
1365 #<module name="m_connflood.so">
1366 #
1367 #-#-#-#-#-#-#-#-#-#-#- CONTHROTTLE CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
1368 #  seconds, maxconns -  Amount of connections per <seconds>.
1369 #
1370 #  timeout           -  Time to wait after the throttle was activated
1371 #                       before deactivating it. Be aware that the time
1372 #                       is seconds + timeout.
1373 #
1374 #  quitmsg           -  The message that users get if they attempt to
1375 #                       connect while the throttle is active.
1376 #
1377 #  bootwait          -  Amount of time to wait before enforcing the
1378 #                       throttling when the server just booted.
1379 #
1380 #<connflood seconds="30" maxconns="3" timeout="30"
1381 #   quitmsg="Throttled" bootwait="10">
1382
1383 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1384 # DCCALLOW module: Adds the /DCCALLOW command
1385 #<module name="m_dccallow.so">
1386 #
1387 #-#-#-#-#-#-#-#-#-#-#-  DCCALLOW CONFIGURATION   -#-#-#-#-#-#-#-#-#-#-#
1388 #  blockchat         - Whether to block DCC CHAT as well as DCC SEND
1389 #  length            - Default duration of entries in DCCALLOW list
1390 #  action            - Default action to take if no action is specified
1391 #                      can be 'block' or 'allow'
1392 #
1393 # File configuration:
1394 #  pattern           - The glob pattern to match against
1395 #  action            - Action to take if a user attempts to send a file
1396 #                      that matches this pattern, can be 'block' or 'allow'
1397 #
1398 #<dccallow blockchat="yes" length="5m" action="block">
1399 #<banfile pattern="*.exe" action="block">
1400 #<banfile pattern="*.txt" action="allow">
1401 #
1402 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1403
1404 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1405 # Deaf module: adds support for ircu style usermode +d - deaf to
1406 # channel messages and channel notices.
1407 #<module name="m_deaf.so">
1408
1409 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1410 # Deny Channels: Deny Channels from being used by users
1411 #<module name="m_denychans.so"> 
1412 #
1413 #-#-#-#-#-#-#-#-#-#-#-   DENYCHAN DEFINITIONS  -#-#-#-#-#-#-#-#-#-#-#-#
1414 #                                                                     #
1415 # If you have the m_denychans.so module loaded, you need to specify   #
1416 # the channels to deny:                                               #
1417 #                                                                     #
1418 # name        -      The channel name to deny.                        #
1419 #                                                                     #
1420 # allowopers  -      If operators are allowed to override the deny.   #
1421 #                                                                     #
1422 # reason      -      Reason given for the deny.                       #
1423 #                                                                     #
1424 #<badchan name="#gods" allowopers="yes" reason="Tortoises!">
1425
1426 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1427 # Devoice Module: Let users devoice themselves.
1428 #<module name="m_devoice.so">
1429
1430 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1431 # DNS Blacklist Module: Provides support for looking up IPs on one or #
1432 # more blacklists.                                                    #
1433 #<module name="m_dnsbl.so">                                           #
1434 #                                                                     #
1435 # For configuration options please see the wiki page for m_dnsbl at   #
1436 # http://inspircd.org/wiki/DNS_Blacklist_Module                       #
1437
1438 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1439 # Filter module: Provides glob-based message filtering
1440 #<module name="m_filter.so">
1441 # OR
1442 # PCRE filter module: Filters messages using regular expressions
1443 #<module name="m_filter_pcre.so">
1444 #
1445 # You may only use one or the other with these modules, network-wide.
1446 #
1447 #-#-#-#-#-#-#-#-#-#-#-  FILTER  CONFIGURATION  -#-#-#-#-#-#-#-#-#-#-#-#
1448 #                                                                     #
1449 # Optional - If you specify to use the m_filter or m_filter_pcre      #
1450 # modules, then specfiy below the path to the filter.conf file,       #
1451 # or define some <filter> tags.                                       #
1452 #                                                                     #
1453 #<include file="filter.conf">
1454
1455 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1456 # Foobar module: does nothing - historical relic
1457 #<module name="m_foobar.so">
1458
1459 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1460 # Globops module: gives /GLOBOPS and usermode +g
1461 #<module name="m_globops.so">
1462
1463 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1464 # Global load module: Allows loading and unloading of modules network-
1465 # wide (USE WITH EXTREME CAUTION!)
1466 #<module name="m_globalload.so">
1467
1468 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1469 # HELPOP module: Provides the /HELPOP command
1470 #<module name="m_helpop.so">
1471 #
1472 #-#-#-#-#-#-#-#-#-#-#-#-  HELPOP  CONFIGURATION  -#-#-#-#-#-#-#-#-#-#-#
1473 #                                                                     #
1474 # Optional - If you specify to use the m_helpop.so module, then       #
1475 # specify below the path to the helpop.conf file, or if you like to   #
1476 # make a mess, define your helpop tags in this conf.                  #
1477 #                                                                     #
1478 #<include file="helpop.conf">
1479
1480 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1481 # HIDECHANS module: Allows opers to hide their channels list from non-
1482 # opers by setting user mode +I on themselves.
1483 # <module name="m_hidechans.so">
1484
1485 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1486 # HIDEOPER module: Allows opers to hide their oper status from non-
1487 # opers by setting user mode +H on themselves.
1488 # <module name="m_hideoper.so">
1489
1490 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1491 # Hostchange module: Allows a different style of cloaking
1492 #<module name="m_hostchange.so">
1493 #
1494 #-#-#-#-#-#-#-#-#-#-#-  HOSTCHANGE  CONFIGURATION  -#-#-#-#-#-#-#-#-#-#
1495 #                                                                     #
1496 # Optional - If you choose to use the m_hostchange.so module.         #
1497 # Config Help -  See http://www.inspircd.org/wiki/Host_Changer_Module #
1498 #                                                                     #
1499 #<host suffix="polarbears.org" separator="." prefix="">
1500 #<hostchange mask="*@fbi.gov" action="addnick">
1501 #<hostchange mask="*r00t@*" action="suffix">
1502 #<hostchange mask="a@b.com" action="set" value="blah.blah.blah">
1503
1504 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1505 # httpd module: Provides http server support for InspIRCd
1506 #<module name="m_httpd.so">
1507 #
1508 #-#-#-#-#-#-#-#-#-#-#-#-  HTTPD   CONFIGURATION  -#-#-#-#-#-#-#-#-#-#-#
1509 #
1510 # Optional - If you choose to use the m_httpd.so module,  then you must
1511 # specify the port number and other details of your http server:
1512 #
1513 #<http ip="192.168.1.10" host="brainwave" port="32006"
1514 #      index="/home/brain/inspircd/http/index.html">
1515 #
1516 # You may have as many of these tags as you wish, each with a different
1517 # IP, port, host or index file. Each one will act as an independent
1518 # HTTP server.
1519 #
1520
1521 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1522 # http stats module: Provides basic stats pages over HTTP
1523 # Requires m_httpd.so to be loaded for it to function.
1524 #<module name="m_httpd_stats.so">
1525 #
1526 #-#-#-#-#-#-#-#-#-#-#-#- HTTPD STATS CONFIGURATION -#-#-#-#-#-#-#-#-#-#
1527 #
1528 #<httpstats stylesheet="http://remote.style/sheet.css">
1529 #
1530
1531 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1532 # Ident: Provides RFC 1413 ident lookup support
1533 #<module name="m_ident.so">
1534 #
1535 #-#-#-#-#-#-#-#-#-#-#-#-   IDENT CONFIGURATION   -#-#-#-#-#-#-#-#-#-#-#
1536 #                                                                     #
1537 # Optional - If you are using the m_ident.so module, then you can     #
1538 # specify the timeout for ident lookups here. If not defined, it will #
1539 # default to one second. This is a non-blocking timeout which holds   #
1540 # the user in a 'connecting' state until the lookup is complete.      #
1541 # The bind value indicates which IP to bind outbound requests to.     #
1542 #                                                                     #
1543 #<ident timeout="5" bind="">                                          #
1544
1545 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1546 # Invite except module: Adds support for channel invite exceptions (+I)
1547 #<module name="m_inviteexception.so">
1548
1549 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1550 # Invisible module - Adds support for usermode +Q (quiet) which lets an
1551 # oper go 'invisible' similar to unrealircd 3.1's +I mode. Note that
1552 # opers are still able to see invisible users, and if an oper with +Q
1553 # deopers, they will become visible. 
1554
1555 # IMPORTANT NOTE: To allow this mode to be used by a type of oper, you
1556 # must first add the value canquiet="yes" to that oper's type tag.
1557 #
1558 #<module name="m_invisible.so">
1559
1560 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1561 # Join flood module: Adds support for join flood protection (+j)
1562 #<module name="m_joinflood.so">
1563
1564 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1565 # Jump Server module: Adds support for the RPL_REDIR numeric
1566 #<module name="m_jumpserver.so">
1567
1568 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1569 # Anti-Auto-Rejoin: Adds support for prevention of auto-rejoin (+J)
1570 #<module name="m_kicknorejoin.so">
1571
1572 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1573 # Knock module: adds the /KNOCK command and +K channel mode
1574 #<module name="m_knock.so">
1575
1576 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1577 # Lock server module: Adds /LOCKSERV and /UNLOCKSERV commands that is #
1578 # used to temporarily close/open for new connections to the server.   #
1579 # These commands require OPER status and that the LOCKSERV UNLOCKSERV #
1580 # are specified in a <class> tag that the oper is part of. This is so #
1581 # you can control who has access to this possible dangerous command.  #
1582 # If your server is locked and you got disconnected, do a REHASH from #
1583 # shell to open up again.
1584 #<module name="m_lockserv.so">
1585
1586 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1587 # Msg flood module: Adds message/notice flood protection (+f)
1588 #<module name="m_messageflood.so">
1589
1590 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1591 # MySQL module: Allows other SQL modules to access MySQL databases
1592 # through a unified API. You must copy the source for this module
1593 # from the directory src/modules/extra, plus the file m_sqlv2.h
1594 #<module name="m_mysql.so">
1595 #
1596 #-#-#-#-#-#-#-#-#-#-#-#- SQL CONFIGURATION   -#-#-#-#-#-#-#-#-#-#-#-#-#
1597 #                                                                     #
1598 # m_mysql.so is more complex than described here, see the wiki for    #
1599 # more: http://www.inspircd.org/wiki/SQL_Service_Provider_Module      #
1600 #
1601 #<database name="mydb" username="myuser" password="mypass" hostname="localhost" id="my_database2">
1602
1603 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1604 # NAMESX module: Provides support for the NAMESX extension which allows
1605 # clients to see all the prefixes set on a user without getting confused.
1606 # This is supported by mIRC, x-chat, klient, and maybe more.
1607 #<module name="m_namesx.so">
1608
1609 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1610 # Nicklock module: Let opers change a user's nick and then stop that
1611 # user from changing their nick again.
1612 #<module name="m_nicklock.so">
1613
1614 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1615 # No ctcp module: Adds the channel mode +C to block CTCPs
1616 #<module name="m_noctcp.so">
1617
1618 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1619 # Noinvite module: Gives channel mode +V
1620 #<module name="m_noinvite.so">
1621
1622 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1623 # No kicks module: Adds the +Q channel mode
1624 #<module name="m_nokicks.so">
1625
1626 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1627 # No nicks module: Adds the +N channel mode
1628 #<module name="m_nonicks.so">
1629
1630 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1631 # No Notice module: adds the channel mode +T
1632 #<module name="m_nonotice.so">
1633
1634 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1635 # Oper channels mode: Adds the +O channel mode
1636 #<module name="m_operchans.so">
1637
1638 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1639 # Oper hash module: Allows hashed oper passwords
1640 # Relies on the module m_md5.so and/or m_sha256.so being loaded before
1641 # m_oper_hash.so in the configuration file.
1642 #<module name="m_oper_hash.so">
1643 #
1644 #-#-#-#-#-#-#-#-#-#-# OPER HASH CONFIGURATION #-#-#-#-#-#-#-#-#-#-#-#-#
1645 #
1646 # To use this module, you must define a hash type for each oper's
1647 # password you want to hash. For example:
1648 #
1649 #     <oper name="Brain"
1650 #           host="ident@dialup15.isp.com"
1651 #           hash="sha256"
1652 #           password="a41d730937a53b79f788c0ab13e9e1d5"
1653 #           type="NetAdmin">
1654
1655 # The types of hashing available vary depending on which hashing modules
1656 # you load, but usually if you load m_sha256.so and m_md5.so, both md5
1657 # and sha256 type hashing will be available (the most secure of which
1658 # is SHA256).
1659
1660 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1661 # Oper Join module: Forces opers to join a channel on oper-up
1662 #<module name="m_operjoin.so">
1663 #
1664 #-#-#-#-#-#-#-#-#-#-#   OPERJOIN CONFIGURATION   -#-#-#-#-#-#-#-#-#-#-#
1665 #                                                                     #
1666 # If you are using the m_operjoin.so module, specify the channel here #
1667 #                                                                     #
1668 #<operjoin channel="#channel">
1669
1670 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1671 # Oper MOTD module: Provides support for seperate message of the day
1672 # on oper-up
1673 #<module name="m_opermotd.so">
1674 #
1675 #-#-#-#-#-#-#-#-#-#-#   OPERMOTD CONFIGURATION   -#-#-#-#-#-#-#-#-#-#-#
1676 #                                                                     #
1677 # If you are using the m_opermotd.so module, specify the motd here    #
1678 #                                                                     #
1679 #<opermotd file="oper.motd">
1680
1681 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1682 # Override module: Adds support for oper override
1683 #<module name="m_override.so">
1684 #
1685 #-#-#-#-#-#-#-#-#-#-#   OVERRIDE CONFIGURATION   -#-#-#-#-#-#-#-#-#-#-#
1686 #                                                                     #
1687 # m_override.so is too complex it describe here, see the wiki:        #
1688 # http://www.inspircd.org/wiki/Oper_Override_Module                   #
1689
1690 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1691 # Oper levels module: Gives each oper a level and prevents
1692 # actions being taken against higher level opers
1693 # Specify the level as the 'level' parameter of the <type> tag
1694 #<module name="m_operlevels.so">
1695
1696 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1697 # Oper modes module: Allows you to specify modes to add/remove on oper
1698 # Specify the modes as the 'modes' parameter of the <type> tag
1699 #<module name="m_opermodes.so">
1700
1701 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1702 # PostgreSQL module: Allows other SQL modules to access PgSQL databases
1703 # through a unified API. You must copy the source for this module
1704 # from the directory src/modules/extra, plus the file m_sqlv2.h
1705 #<module name="m_pgsql.so">
1706 #
1707 #-#-#-#-#-#-#-#-#-#-#-#- SQL CONFIGURATION   -#-#-#-#-#-#-#-#-#-#-#-#-#
1708 #                                                                     #
1709 # m_pgsql.so is more complex than described here, see the wiki for    #
1710 # more: http://www.inspircd.org/wiki/SQL_Service_Provider_Module      #
1711 #
1712 #<database name="mydb" username="myuser" password="mypass" hostname="localhost" id="my_database" ssl="no">
1713
1714 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1715 # Random Quote module: provides a random quote on connect.
1716 # NOTE: Some of these may mimic fatal errors and confuse users and 
1717 # opers alike! - BEWARE!
1718 #<module name="m_randquote.so">
1719 #
1720 #-#-#-#-#-#-#-#-#-#-  RANDOMQUOTES CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
1721 #                                                                     #
1722 # Optional - If you specify to use the m_randquote.so module, then    #
1723 # specify below the path to the randquotes.conf file.                 #
1724 #                                                                     #
1725 #<randquote file="randquotes.conf">
1726
1727 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1728 # Redirect module: Adds channel redirection (mode +L)
1729 #<module name="m_redirect.so">
1730
1731 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1732 # Registered users only channel creation
1733 # Allows only registered users and opers to create new channels.
1734 #<module name="m_regonlycreate.so">
1735
1736 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1737 # Remove module: Adds the /REMOVE command which is a peaceful
1738 # alternative to /KICK
1739 #<module name="m_remove.so">
1740
1741 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1742 # Restrict banned users module:
1743 # Disallows banned users on a channel from messaging the channel,
1744 # changing nick, or changing the topic, if loaded.
1745 #<module name="m_restrictbanned.so">
1746
1747 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1748 # Restricted channels module: Allows only opers to create channels
1749 #<module name="m_restrictchans.so">
1750
1751 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1752 # Restrict message module: Allows users to only message opers
1753 #<module name="m_restrictmsg.so">
1754
1755 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1756 # Provide /LIST throttling (to prevent flooding) and /LIST safety to
1757 # prevent excess flood when the list is large.
1758 #<module name="m_safelist.so">
1759 #
1760 #-#-#-#-#-#-#-#-#-#-# SAFELIST CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#-#
1761 #
1762 # When using Safelist, you may set the following values;
1763 #
1764 # The first value, 'throttle', sets the amount of time in seconds a user
1765 # must wait between LIST commands. For example, if this is set to 60
1766 # (the default) then the user may not /LIST more than once a minute.
1767 # If not defined, the default value is 60 seconds.
1768 #
1769 # The second value, 'maxlisters', indicates the maximum number of users
1770 # which may be retrieving a LIST at once. It is not recommended you raise
1771 # this value, as increasing it too high can make your network vulnerable
1772 # to floodbots which waste your bandwidth and CPU time with LIST requests.
1773 #
1774 #<safelist throttle="60" maxlisters="50">
1775
1776 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1777 # SAJOIN module: Adds the /SAJOIN command
1778 #<module name="m_sajoin.so">
1779
1780 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1781 # SAMODE module: Adds the oper /SAMODE command
1782 #<module name="m_samode.so">
1783
1784 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1785 # SANICK module: Allows opers to change user's nicks
1786 #<module name="m_sanick.so">
1787
1788 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1789 # SAPART module: Adds the oper /SAPART command
1790 #<module name="m_sapart.so">
1791
1792 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1793 # SAQUIT module: Adds the oper /SAQUIT command (abusable!!!)
1794 #<module name="m_saquit.so">
1795
1796 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1797 # Secure list module: Prevent /LIST in the first minute of connection,
1798 # crippling most spambots and trojan spreader bots.
1799 #<module name="m_securelist.so">
1800 #
1801 #-#-#-#-#-#-#-#-#-# SECURELIST CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#-#
1802 #                                                                     #
1803 # Securelist can be harmful to some irc search engines such as        #
1804 # netsplit.de and searchirc.com. To prevent securelist blocking these #
1805 # sites from listing, define exception tags as shown below:           #
1806 <securelist exception="*@*.searchirc.org">
1807 <securelist exception="*@*.netsplit.de">
1808 <securelist exception="*@echo940.server4you.de">
1809 #                                                                     #
1810 # Define the following variable to change how long a user must wait   #
1811 # before issuing a LIST. If not defined, defaults to 60 seconds.      #
1812 #                                                                     #
1813 #<securelist waittime="60">                                           #
1814
1815 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1816 # See nicks module: Allow for SNOMASK +N which shows nick changes.
1817 #<module name="m_seenicks.so">
1818
1819 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1820 # Set Idle module: Adds a command for opers to change their
1821 # idle time (mainly a toy)
1822 #<module name="m_setidle.so">
1823
1824 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1825 # Services support module: Adds several usermodes such as +R and +M
1826 # this module implements the 'identified' state via user mode +r, which
1827 # is similar to the DALnet and dreamforge systems.
1828 #<module name="m_services.so">
1829
1830 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1831 # Services support module: Adds several usermodes such as +R and +M
1832 # this module implements the 'identified' state via account names (AC)
1833 # and is similar in operation to the way asuka and ircu handle services.
1834 # it cannot be used at the same time as m_services, above.
1835 #<module name="m_services_account.so">
1836
1837 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1838 # Sethost module: Adds the /SETHOST command
1839 # See m_chghost for how to customise valid chars for hostnames
1840 #<module name="m_sethost.so">
1841
1842 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1843 # Setident module: Adds the /SETIDENT command
1844 #<module name="m_setident.so">
1845
1846 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1847 # SETNAME module: Adds the /SETNAME command
1848 #<module name="m_setname.so">
1849
1850 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1851 # Show Whois module: Adds the +W usermode which allows opers
1852 # to see when they are whois'ed (can be annoying).
1853 #<module name="m_showwhois.so">
1854
1855 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1856 # Spy module: Adds the commands SPYLIST and SPYNAMES that let opers
1857 # see who is in a +s channel, and list +s channels, show keys of keyed
1858 # channels the oper is not a member of etc. (standard 'abusive' features
1859 # of many other ircds, modulized here in InspIRCd).
1860 #<module name="m_spy.so">
1861
1862 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1863 # SSL channel mode module: Adds support for SSL-only channels (+z).
1864 # does not do anything useful without a working SSL module (see below)
1865 #<module name="m_sslmodes.so">
1866
1867 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1868 # Dummy ssl module: If you have other servers on your network which
1869 # have SSL, but your server does not have ssl enabled, you should load
1870 # this module, which will handle SSL metadata (e.g. the "Is using ssl"
1871 # field in the WHOIS information).
1872 #<module name="m_ssl_dummy.so">
1873
1874 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1875 # GnuTLS ssl module: Adds support for client-server SSL using GnuTLS,
1876 # if enabled. You must copy the source for this module from the directory
1877 # src/modules/extra, or answer 'yes' in ./configure when asked if you
1878 # want to enable this, or it will not load.
1879 #<module name="m_ssl_gnutls.so">
1880 #
1881 #-#-#-#-#-#-#-#-#-#-#-  GNUTLS CONFIGURATION   -#-#-#-#-#-#-#-#-#-#-#-#
1882 #                                                                     #
1883 # m_ssl_gnutls.so is too complex it describe here, see the wiki:      #
1884 # http://www.inspircd.org/wiki/GnuTLS_SSL_Module                      #
1885 #                                                                     #
1886 # NOTE: If you want to use this module to encrypt and sign your       #
1887 # server to server traffic, you MUST load it before m_spanningtree in #
1888 # your configuration file!                                            #
1889
1890 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1891 # SSL Info module: Allows users to retrieve information about other
1892 # user's peer SSL certificates and keys. This can be used by client
1893 # scripts to validate users. For this to work, one of m_ssl_gnutls.so
1894 # or m_ssl_openssl.so must be loaded. You must symlink the source for
1895 # this module from the directory src/modules/extra.
1896 #<module name="m_sslinfo.so">
1897
1898 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1899 # OpenSSL ssl module: Adds support for client-server SSL using OpenSSL,
1900 # if enabled. You must copy the source for this module from the directory
1901 # src/modules/extra, or answer 'yes' in ./configure when asked if you
1902 # want to enable this, or it will not load.
1903 #<module name="m_ssl_openssl.so">
1904 #
1905 #-#-#-#-#-#-#-#-#-#-#- OPENSSL CONFIGURATION   -#-#-#-#-#-#-#-#-#-#-#-#
1906 #                                                                     #
1907 # m_ssl_openssl.so is too complex it describe here, see the wiki:     #
1908 # http://www.inspircd.org/wiki/OpenSSL_SSL_Module                     #
1909 #                                                                     #
1910 # NOTE: If you want to use this module to encrypt and sign your       #
1911 # server to server traffic, you MUST load it before m_spanningtree in #
1912 # your configuration file!                                            #
1913
1914 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1915 # SSL Cert Oper module: Allows opers to oper up using the key fingerprint
1916 # stored within their SSL certificate and key pair.
1917 # When using this module, one of m_ssl_gnutls.so or m_ssl_openssl.so must
1918 # be loaded. An extra value should be added to enabled opers, which
1919 # is in the following format: fingerprint="<hash>". For more information,
1920 # see the example in the oper blocks.
1921 #<module name="m_ssl_oper_cert.so">
1922
1923 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1924 # Strip colour module: Adds the channel mode +S
1925 #<module name="m_stripcolor.so">
1926
1927 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1928 # SILENCE module: Adds support for /SILENCE
1929 #<module name="m_silence.so">
1930 #
1931 # Configuration tags:
1932 #
1933 #<silence maxentries="32">
1934 #
1935 # Sets the maximum number of entries on a users silence list.
1936
1937 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1938 # Extended SILENCE module: Adds support for /SILENCE with additional
1939 # features to silence based on invites, channel messages, etc.
1940 #<module name="m_silence_ext.so">
1941 #
1942 # The configuration tags for this module are identical to those of
1943 # m_silence, shown above.
1944
1945 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1946 # SQLite3 module: Allows other SQL modules to access SQLite3          #
1947 # databases through a unified API. You must link the source for this  #
1948 # module from the directory src/modules/extra to src/modules, plus    #
1949 # the file m_sqlv2.h                                                  #
1950 #<module name="m_sqlite3.so">
1951 #
1952 #-#-#-#-#-#-#-#-#-#-#-#- SQL CONFIGURATION   -#-#-#-#-#-#-#-#-#-#-#-#-#
1953 #                                                                     #
1954 # m_sqlite.so is more complex than described here, see the wiki for   #
1955 # more: http://www.inspircd.org/wiki/SQLite3_Service_Provider_Module  #
1956 #
1957 #<database hostname="/full/path/to/database.db" id="anytext">
1958
1959 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1960 # SQLutils module: Provides some utilities to SQL client modules, such
1961 # as mapping queries to users and channels. You must copy the source
1962 # for this module from the directory src/modules/extra/m_sqlutils.cpp
1963 # and src/modules/extra/m_sqlutils.h into /src/modules
1964 # Needed for, and loaded before: SQLauth and SQLoper
1965 #<module name="m_sqlutils.so">
1966
1967 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1968 # SQL authentication module: Allows IRCd connections to be tied into
1969 # a database table (for example a forum). You must copy the source for
1970 # this module from the directory src/modules/extra
1971 # Depends on the SQLutils module being loaded first.
1972 #<module name="m_sqlauth.so">
1973 #
1974 #-#-#-#-#-#-#-#-#-#-#- SQLAUTH CONFIGURATION   -#-#-#-#-#-#-#-#-#-#-#-#
1975 #                                                                     #
1976 # m_sqlauth.so is too complex it describe here, see the wiki:         #
1977 # http://www.inspircd.org/wiki/SQL_Authentication_Module              #
1978
1979 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1980 # SQL logging module: Allows you to log network-wide data for your
1981 # network in a fully normalized set of SQL tables. You must copy the
1982 # source for this module from the directory src/modules/extra
1983 #<module name="m_sqllog.so">
1984 #
1985 #-#-#-#-#-#-#-#-#-#-#-  SQLLOG CONFIGURATION   -#-#-#-#-#-#-#-#-#-#-#-#
1986 #                                                                     #
1987 # dbid       - Database ID to use (see m_sql)                         #
1988 #                                                                     #
1989 # See also: http://www.inspircd.org/wiki/SQL_Logging_Module           #
1990 #                                                                     #
1991 #<sqllog dbid="1">
1992
1993 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1994 # SQL oper module: Allows you to store oper credentials in an SQL table
1995 # You must copy the source for this module from the directory src/modules/extra
1996 # Depends on the SQLutils module being loaded first.
1997 #<module name="m_sqloper.so">
1998 #
1999 #-#-#-#-#-#-#-#-#-#-#- SQLOPER CONFIGURATION   -#-#-#-#-#-#-#-#-#-#-#-#
2000 #                                                                     #
2001 # dbid       - Database ID to use (see m_sql)                         #
2002 #                                                                     #
2003 # See also: http://www.inspircd.org/wiki/SQL_Oper_Storage_Module      #
2004 #                                                                     #
2005 #<sqloper dbid="1">
2006
2007 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2008 # SVSHold module: Implements SVSHOLD. Like Q:Lines, but can only be   #
2009 # added/removed by Services.                                          #
2010 #<module name="m_svshold.so">
2011
2012
2013 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2014 # SWHOIS module: Allows you to add arbitary lines to user WHOIS.
2015 #<module name="m_swhois.so">
2016
2017 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2018 # Test command module: Does nothing significant. Read: pointless.
2019 #<module name="m_testcommand.so">
2020
2021 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2022 # Timed bans module: Adds timed bans and the /TBAN command
2023 #<module name="m_timedbans.so">
2024
2025 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2026 # Test line module: Adds the /TLINE command, used to test how many
2027 # users a /GLINE or /ZLINE etc would match.
2028 #<module name="m_tline.so">
2029
2030 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2031 # UHNAMES support module: Adds support for the IRCX style UHNAMES
2032 # extension, which displays ident and hostname in the names list for
2033 # each user, saving clients from doing a WHO on the channel. Note that
2034 # this module is not widely supported yet. If a client does not support
2035 # UHNAMES it will not enable it, this will not break incompatible
2036 # clients.
2037 #<module name="m_uhnames.so">
2038
2039 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2040 # Uninvite module: Adds the /UNINVITE command which lets users remove
2041 # pending invites from channels without waiting for the user to join.
2042 #<module name="m_uninvite.so">
2043
2044 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2045 # Userip module: Adds the /USERIP command
2046 #<module name="m_userip.so">
2047
2048 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2049 # Vhost module: Adds the VHOST command which allows for adding virtual
2050 # hosts which are accessible using a username and password in the config.
2051 #<module name="m_vhost.so">
2052 #
2053 #-#-#-#-#-#-#-#-#-#-#- VHOST CONFIGURATION   -#-#-#-#-#-#-#-#-#-#-#-#-#
2054 #                                                                     #
2055 # user       - Username for the vhost.                                #
2056 #                                                                     #
2057 # pass       - Password for the vhost.                                #
2058 #                                                                     #
2059 # host       - Vhost to set.                                          #
2060 #
2061 #<vhost user="some_username" pass="some_password" host="some.host">
2062
2063 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2064 # Watch module: Adds the WATCH command, which is used by clients to 
2065 # maintain notify lists.
2066 #<module name="m_watch.so">
2067 #
2068 # Configuration tags:
2069 #
2070 #<watch maxentries="32">
2071 #
2072 # Sets the maximum number of entries on a user's watch list.
2073
2074 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2075 # XMLSocket module: Adds support for connections using the shockwave
2076 # flash XMLSocket. Note that this does not work if the client you are
2077 # using has retarded ideas of the IRC protocol. Your client must still
2078 # send RFC-correct lines to the server, this module only changes the
2079 # line ending from newlines to null terminators.
2080 #
2081 #<module name="m_xmlsocket.so">
2082
2083 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2084 # ZipLinks module: Adds support for zlib deflate on server to server
2085 # connections. Both ends of the connection must load this module.
2086 #
2087 #<module name="m_ziplink.so">
2088 #
2089 # To use this module, you must enable it as a transport type in your
2090 # <link> tags or <bind> tags using the transport name 'zip'.
2091 # See the documentation of <link> and <bind>, respectively.
2092 #
2093
2094 #-#-#-#-#-#-#-#-#-#-#-#-#-#-  BAN OPTIONS  -#-#-#-#-#-#-#-#-#-#-#-#-#-#
2095 #                                                                     #
2096 # The ban tags define nick masks, host masks and ip ranges which are  #
2097 # banned from your server. All details in these tags are local to     #
2098 # Your server.                                                        #
2099 #                                                                     #
2100 #                                                                     #
2101 # badip lines ban an ip range (same as a zline)                       #
2102 #                                                                     #
2103 # ipmask       -          The ip range to ban (wildcards possible)    #
2104 #                         CIDR is supported in the IP mask.           #
2105 # reason       -          Reason to display when disconnected         #
2106 #                                                                     #
2107 # badnick lines ban a nick mask (same as a qline)                     #
2108 #                                                                     #
2109 # nick         -          Nick mask to ban (wildcards possible)       #
2110 # reason       -          Reason to display on /NICK                  #
2111 #                                                                     #
2112 # badhost lines ban a user@host mask (same as a kline)                #
2113 #                                                                     #
2114 # host         -          ident@hostname (wildcards possible)         #
2115 #                         If you specify an IP, CIDR is supported.    #
2116 # reason       -          Reason to display on disconnection          #
2117 #                                                                     #
2118 # exception lines define a hostmask that is excempt from [kzg]lines   #
2119 #                                                                     #
2120 # host         -          ident@hostname (wildcards possible)         #
2121 #                         If you specify an IP, CIDR is supported.    #
2122 # reason       -          Reason, shown only in /stats e              #
2123 #                                                                     #
2124
2125 <badip ipmask="69.69.69.69" reason="No porn here thanks.">
2126
2127 <badnick nick="ChanServ" reason="Reserved For Services">
2128 <badnick nick="NickServ" reason="Reserved For Services">
2129 <badnick nick="OperServ" reason="Reserved For Services">
2130 <badnick nick="MemoServ" reason="Reserved For Services">
2131
2132 <badhost host="*@hundredz.n.hundredz.o.1337.kiddies.com" reason="Too many 1337 kiddiots">
2133 <badhost host="*@localhost" reason="No irc from localhost!">
2134 <badhost host="*@172.32.0.0/16" reason="This subnet is bad.">
2135
2136 <exception host="*@ircop.host.com" reason="Opers hostname">
2137
2138 #-#-#-#-#-#-#-#-#-#-#- INSANE BAN OPTIONS  -#-#-#-#-#-#-#-#-#-#-#-#-#-#
2139 #                                                                     #
2140 # This optional tag allows you to specify how wide a gline, eline,    #
2141 # kline, zline or qline can be before it is forbidden from being      #
2142 # set. By setting hostmasks="yes", you can allow all G, K, E lines,   #
2143 # no matter how many users the ban would cover. This is not           #
2144 # recommended! By setting ipmasks="yes", you can allow all Z lines,   #
2145 # no matter how many users these cover too. Needless to say we        #
2146 # don't recommend you do this, or, set nickmasks="yes", which will    #
2147 # allow any qline.                                                    #
2148 #                                                                     #
2149 # The trigger value indicates how wide any mask will be before it is  #
2150 # prevented from being set. The default value is 95.5% if this tag is #
2151 # not defined in your configuration file, meaning that if your        #
2152 # network has 1000 users, a gline matching over 955 of them will be   #
2153 # prevented from being added.                                         #
2154 #                                                                     #
2155 # Please note that remote servers (and services) are exempt from      #
2156 # these restrictions and expected to enforce their own policies       #
2157 # locally!                                                            #
2158 #                                                                     #
2159
2160 <insane hostmasks="no" ipmasks="no" nickmasks="no" trigger="95.5">
2161
2162 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#- YAWN  -#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2163 #                                                                     #
2164 #   You should already know what to do here :)                        #
2165
2166 <die value="User error. Insert new user and press any key. (you didn't edit your config properly.)">
2167
2168
2169 #########################################################################
2170 #                                                                       #
2171 #                     - InspIRCd Development Team -                     #
2172 #                        http://www.inspircd.org                        #
2173 #                                                                       #
2174 #########################################################################