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