]> git.netwichtig.de Git - user/henk/code/inspircd.git/blob - docs/inspircd.conf.example
Document port range stuff
[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 #                 Last updated on : 04/09/2006                         #
24 #                 Written by      : CC  (cc@backchat.co.za)            #
25 #                 Updated by      : katsklaw (katsklaw@gmail.com)      #
26 #                 Updated by      : brain (brain@inspircd.org)         #
27 #                                                                      #
28 #    ____                _   _____ _     _       ____  _ _   _         #
29 #   |  _ \ ___  __ _  __| | |_   _| |__ (_)___  | __ )(_) |_| |        #
30 #   | |_) / _ \/ _` |/ _` |   | | | '_ \| / __| |  _ \| | __| |        #
31 #   |  _ <  __/ (_| | (_| |   | | | | | | \__ \ | |_) | | |_|_|        #
32 #   |_| \_\___|\__,_|\__,_|   |_| |_| |_|_|___/ |____/|_|\__(_)        #
33 #                                                                      #
34 #   Lines prefixed with READ THIS BIT, as shown above, are IMPORTANT   #
35 #   lines, and you REALLY SHOULD READ THEM. Yes, THIS MEANS YOU. Even  #
36 #   if you've configured InspIRCd before, these probably indicate      #
37 #   something new or different to this version and you SHOULD READ IT. #
38 #                                                                      #
39 ########################################################################
40 #                                                                      #
41 #         Unalphabeticalise the modules list at your own risk          #
42 #                                                                      #
43 ########################################################################
44
45
46 #-#-#-#-#-#-#-#-#-#-#-#-  SERVER DESCRIPTION  -#-#-#-#-#-#-#-#-#-#-#-#-
47 #                                                                     #
48 #   Here is where you enter the information about your server.        #
49 #                                                                     #
50 #  Syntax is as follows:                                              #
51 #                                                                     #
52 #     <server name="server.name"                                      #
53 #      description="Server Description"                               #
54 #      network="MyNetwork">                                           #
55 #                                                                     #
56
57 <server name="penguin.omega.org.za"
58         description="Waddle World"
59         network="Omega">
60
61
62 #-#-#-#-#-#-#-#-#-#-#-#-   ADMIN INFORMATION   -#-#-#-#-#-#-#-#-#-#-#-#
63 #                                                                     #
64 #   Describes the Server Administrator's real name, nick              #
65 #   and email address.                                                #
66 #                                                                     #
67 #  Syntax is as follows:                                              #
68 #       <admin name="real name"                                       #
69 #              nick="nick name"                                       #
70 #              email="email@address.com">                             #
71 #                                                                     #
72
73 <admin  name="Johnny English"
74         nick="MI5"
75         email="MI5@the.best.secret.agent">
76
77
78 #-#-#-#-#-#-#-#-#-#-#-#-   PORT CONFIGURATION   -#-#-#-#-#-#-#-#-#-#-#-
79 #                                                                     #
80 #   Enter the port and address bindings here.                         #
81 #                                                                     #
82 #  bind address - specifies which address ports bind to. Leaving this #
83 #                 field blank binds the port to all IPs available.    #
84 #                                                                     #
85 #  port         - The port number to bind to. You may specify a port  #
86 #                 range here, e.g. "6667-6669,7000,7001". If you do   #
87 #                 this, the server will count each port within your   #
88 #                 range as a seperate binding, making the above       #
89 #                 example equivalent to five seperate bind tags.      #
90 #                 A failure on one port in the range does not prevent #
91 #                 the entire range from being bound, just that one    #
92 #                 port number.                                        #
93 #                                                                     #
94 #  type         - can be 'clients' or 'servers'. The clients type is  #
95 #                 a standard tcp based socket, the servers type is a  #
96 #                 also a TCP based connection but of a different      #
97 #                 format. SSL support is provided by modules, to      #
98 #                 enable SSL support, please read the module section  #
99 #                 of this configuration file.                         #
100 #                                                                     #
101 #    ____                _   _____ _     _       ____  _ _   _        #
102 #   |  _ \ ___  __ _  __| | |_   _| |__ (_)___  | __ )(_) |_| |       #
103 #   | |_) / _ \/ _` |/ _` |   | | | '_ \| / __| |  _ \| | __| |       #
104 #   |  _ <  __/ (_| | (_| |   | | | | | | \__ \ | |_) | | |_|_|       #
105 #   |_| \_\___|\__,_|\__,_|   |_| |_| |_|_|___/ |____/|_|\__(_)       #
106 #                                                                     #
107 #  If you want to link servers to InspIRCd you must load the          #
108 #  m_spanningtree module! Please see the modules list below for       #
109 #  information on how to load this module! If you do not load this    #
110 #  module, server ports will NOT be bound!                            #
111 #                                                                     #
112 #  Leaving address empty binds to all available interfaces            #
113 #                                                                     #
114 #  Syntax is as follows:                                              #
115 #                                                                     #
116 # <bind address="ip or host" port="port" type="clients">              #
117 # <bind address="ip or host" port="port" type="servers">              #
118 #                                                                     #
119 # If InspIRCd is built for IPV6, and you wish to accept IPV4 clients, #
120 # then you must specify your IPV6 clients in the following form:      #
121 # ::ffff:1.2.3.4, where 1.2.3.4 is the IPV4 address to bind the       #
122 # port on. If InspIRCd is built  for IPV4 connections (this is the    #
123 # default) then you do not need to prefix your addresses like this.   #
124 #                                                                     #
125
126 <bind address="" port="6660-6669" type="clients">
127 <bind address="" port="7000,7001" type="servers">
128
129
130 #-#-#-#-#-#-#-#-#-#-  DIE/RESTART CONFIGURATION   -#-#-#-#-#-#-#-#-#-#-
131 #                                                                     #
132 #   You can configure the passwords here which you wish to use for    #
133 #   the die and restart commands. Only trusted ircops who will        #
134 #   need this ability should know the die and restart password.       #
135 #                                                                     #
136 #  Syntax is as follows:                                              #
137 #       <power diepass="die password" restartpass="restart password"  #
138 #        pause="secs before dying">                                   #
139 #                                                                     #
140
141 <power diepass="diepass" restartpass="restartpass" pause="2">
142
143
144 #-#-#-#-#-#-#-#-#-#  INCLUDE CONFIGURATION  #-#-#-#-#-#-#-#-#-#-#-#-#-#
145 #                                                                     #
146 # This optional tag allows you to include another config file         #
147 # allowing you to keep your configuration tidy. The configuration     #
148 # file you include will be treated as part of the configuration file  #
149 # which includes it, in simple terms the inclusion is transparent.    #
150 #                                                                     #
151 # All paths to config files are relative to the directory of the main #
152 # config file inspircd.conf, unless the filename starts with a forward#
153 # slash (/) in which case it is treated as an absolute path.          #
154 #                                                                     #
155 # Syntax is as follows:                                               #
156 #<include file="file.conf">                                           #
157 #                                                                     #
158
159 #-#-#-#-#-#-#-#-#-#-  CONNECTIONS CONFIGURATION  -#-#-#-#-#-#-#-#-#-#-#
160 #                                                                     #
161 #   This is where you can configure which connections are allowed     #
162 #   and denied access onto your server.                               #
163 #   The password is optional.                                         #
164 #   You may have as many of these as you require.                     #
165 #   To allow/deny all connections use a *                             #
166 #                                                                     #
167 #  Syntax is as follows:                                              #
168 #                                                                     #
169 #       <connect allow="ip mask">                                     #
170 #       <connect allow="ip mask" password="blahblah">                 #
171 #       <connect allow="ip mask" password="blah" timeout="10">        #
172 #       <connect allow="ip mask" timeout="blah" flood="5">            #
173 #       <connect allow="ip mask" threshold="8" pingfreq="120">        #
174 #       <connect allow="ip mask" sendq="99999" revcq="696969">        #
175 #       <connect allow="ip mask" localmax="3" globalmax="3">          #
176 #       <connect deny="ip mask">                                      #
177 #                                                                     #
178 #   IP masks may be specified in CIDR format or wildcard format,      #
179 #   for IPV4 and IPV6.                                                #
180 #                                                                     #
181 #   You may optionally include timeout="x" on any allow line, which   #
182 #   specifies the amount of time given before an unknown connection   #
183 #   is closed if USER/NICK/PASS are not given. This value is in secs  #
184 #                                                                     #
185 #   You should also include a flood="x" line which indicates          #
186 #   the number of lines a user may place into their buffer at once    #
187 #   before they are disconnected for excess flood. This feature can   #
188 #   not be disabled, however it can be set to exremely high values,   #
189 #   rendering it effectively disabled. A recommended value is 10.     #
190 #   A counter is maintained for each user which is reset every        #
191 #   'threshold' seconds and specifying this threshold value with      #
192 #   threshold="X" indicates how often the counter is reset. For       #
193 #   example, with flood="5" and threshold="8", the user may not send  #
194 #   more than 5 lines in 8 secs.                                      #
195 #                                                                     #
196 #   You may optionally specify the sendq size and ping frequency of   #
197 #   each connect:allow line using the pingfreq="X" and sendq="X"      #
198 #   settings as shown in the full example below.                      #
199 #   The ping frequency is specified in seconds, and the sendq size    #
200 #   in bytes. It is recommended, although not enforced, that you      #
201 #   should never set your sendq size to less than 8k. Send Queues are #
202 #   dynamically allocated and can grow as needed up to the maximum    #
203 #   size specified.                                                   #
204 #                                                                     #
205 #   The optional recvq value is the maximum size which users in this  #
206 #   group may grow their receive queue to. This is recommended to be  #
207 #   kept pretty low compared to the sendq, as users will always       #
208 #   recieve more than they send in normal circumstances. The default  #
209 #   if not specified is 4096.                                         #
210 #                                                                     #
211 #   IMPORTANT NOTE, CALL THE CONFUSION POLICE!                        #
212 #   The sendq is the data waiting to be sent TO THE USER.             #
213 #   The recvq is the data being received FROM THE USER.               #
214 #   The names sendq and recvq are from the SERVER'S PERSPECTIVE not   #
215 #   that of the user... Just to clear up any confusion or complaints  #
216 #   that these are backwards :p                                       #
217 #                                                                     #
218 #   The localmax and globalmax values can be used to enforce local    #
219 #   and global session limits on connections. The session limits are  #
220 #   counted against all users, but applied only to users within the   #
221 #   class. For example, if you had a class 'A' which has a session    #
222 #   limit of 3, and a class 'B' which has a session limit of 5, and   #
223 #   somehow, two users managed to get into class B which also match   #
224 #   class A, there is only one connection left for this IP now in A,  #
225 #   but if they can connect again to B, there are three. You get the  #
226 #   idea (i hope).                                                    #
227 #                                                                     #
228
229 <connect allow="196.12.*"  password="secret">
230 <connect allow="*" timeout="60" flood="20" threshold="1" pingfreq="120" sendq="262144" recvq="8192" localmax="3" globalmax="3">
231
232 <connect deny="69.254.*">
233 <connect deny="3ffe::0/32">
234
235
236 #-#-#-#-#-#-#-#-#-#-#-#-  CLASS CONFIGURATION   -#-#-#-#-#-#-#-#-#-#-#-
237 #                                                                     #
238 #   Classes are a group of commands which are grouped together        #
239 #   and given a unique name. They used to define which commands       #
240 #   are available to certain types of Operators.                      #
241 #                                                                     #
242 #  Syntax is as follows:                                              #
243 #                                                                     #
244 #       <class name="name" commands="oper commands">                  #
245 #                                                                     #
246 #    ____                _   _____ _     _       ____  _ _   _        #
247 #   |  _ \ ___  __ _  __| | |_   _| |__ (_)___  | __ )(_) |_| |       #
248 #   | |_) / _ \/ _` |/ _` |   | | | '_ \| / __| |  _ \| | __| |       #
249 #   |  _ <  __/ (_| | (_| |   | | | | | | \__ \ | |_) | | |_|_|       #
250 #   |_| \_\___|\__,_|\__,_|   |_| |_| |_|_|___/ |____/|_|\__(_)       #
251 #                                                                     #
252 #  You are not forced to give these classes the names given below.    #
253 #  You can create your own named classes, if you want, in fact that   #
254 #  is the whole idea of this system!                                  #
255 #                                                                     #
256 #  Note: It is possible to make a class which covers all available    #
257 #  commands. To do this, specify commands="*". This is not really     #
258 #  recommended, as it negates the whole purpose of the class system,  #
259 #  however it is provided for fast configuration (e.g. in test nets)  #
260 #                                                                     #
261
262 <class name="Shutdown" commands="DIE RESTART REHASH LOADMODULE UNLOADMODULE RELOAD">
263 <class name="ServerLink" commands="CONNECT SQUIT RCONNECT MKPASSWD MKSHA256">
264 <class name="BanControl" commands="KILL GLINE KLINE ZLINE QLINE ELINE">
265 <class name="OperChat" commands="WALLOPS GLOBOPS SETIDLE SPYLIST SPYNAMES">
266 <class name="HostCloak" commands="SETHOST SETIDENT SETNAME CHGHOST CHGIDENT">
267
268
269 #-#-#-#-#-#-#-#-#-#-#-#-  OPERATOR COMPOSITION   -#-#-#-#-#-#-#-#-#-#-#
270 #                                                                     #
271 #   This is where you specify which types of operators you have on    #
272 #   your server, as well as the commands they are allowed to use.     #
273 #   This works alongside with the classes specified above.            #
274 #                                                                     #
275 #  type name  - a name for the combined class types                   #
276 #               a type name cannot contain spaces, however if you     #
277 #               put an _ symbol in the name, it will be translated    #
278 #               to a space when displayed in a WHOIS.                 #
279 #                                                                     #
280 #  classes    - specified above, used for flexibility for the         #
281 #               server admin to decide on which operators get         #
282 #               what commands. Class names are case sensitive,        #
283 #               seperate multiple class names with spaces.            #
284 #                                                                     #
285 #  host       - optional hostmask operators will recieve on oper-up.  #
286 #                                                                     #
287 #  Syntax is as follows:                                              #
288 #                                                                     #
289 #     <type name="name" classes="class names" host="oper hostmask">   #
290 #                                                                     #
291 #    ____                _   _____ _     _       ____  _ _   _        #
292 #   |  _ \ ___  __ _  __| | |_   _| |__ (_)___  | __ )(_) |_| |       #
293 #   | |_) / _ \/ _` |/ _` |   | | | '_ \| / __| |  _ \| | __| |       #
294 #   |  _ <  __/ (_| | (_| |   | | | | | | \__ \ | |_) | | |_|_|       #
295 #   |_| \_\___|\__,_|\__,_|   |_| |_| |_|_|___/ |____/|_|\__(_)       #
296 #                                                                     #
297 #  You are not forced to give these types the names given below.      #
298 #  You can create your own named types, if you want, in fact that     #
299 #  is the whole idea of this system!                                  #
300 #                                                                     #
301
302 <type name="NetAdmin" classes="OperChat BanControl HostCloak Shutdown ServerLink" host="netadmin.omega.org.za">
303 <type name="GlobalOp" classes="OperChat BanControl HostCloak ServerLink" host="ircop.omega.org.za">
304 <type name="Helper" classes="HostCloak" host="helper.omega.org.za">
305
306
307 #-#-#-#-#-#-#-#-#-#-#-  OPERATOR CONFIGURATION   -#-#-#-#-#-#-#-#-#-#-#
308 #                                                                     #
309 #   Opers are defined here. This is a very important section.         #
310 #   Remember to only make operators out of truthworthy people.        #
311 #                                                                     #
312 #  name        - oper name, This is case sensitive, so it is best to  #
313 #                use lower-case.                                      #
314 #                                                                     #
315 #  password    - password to oper-up, also case sensitive.            #
316 #                encryption is supported via modules. You may load    #
317 #                modules for MD5 or SHA256 encryption, and if you do, #
318 #                this value will be a hash value, otherwise put a     #
319 #                plaintext password in this value.                    #
320 #                                                                     #
321 #  host        - hosts of client allowed to oper-up.                  #
322 #                wildcards accepted, seperate multiple hosts with a   #
323 #                space. You may also specify CIDR ip addresses.       #
324 #                                                                     #
325 #  fingerprint - When using the m_ssl_oper_cert.so module, you may    #
326 #                specify a key fingerprint here. This can be obtained #
327 #                using the /fingerprint command whilst the module is  #
328 #                loaded, or from the notice given to you when you     #
329 #                connect to the ircd using a client certificate,      #
330 #                and will lock this oper block to only the user who   #
331 #                has that specific key/certificate pair.              #
332 #                This enhances security a great deal, however it      #
333 #                requires that opers use clients which can send ssl   #
334 #                client certificates, if this is configured for that  #
335 #                oper. Note that if the m_ssl_oper.so module is not   #
336 #                loaded, and/or one of m_ssl_openssl or m_ssl_gnutls  #
337 #                is not loaded, this configuration option has no      #
338 #                effect and will be ignored.                          #
339 #                                                                     #
340 #  type        - Sefines the kind of operator. This must match a type #
341 #                tag you defined above, and is case sensitive.        #
342 #                                                                     #
343 #  Syntax is as follows:                                              #
344 #       <oper name="login"                                            #
345 #             password="pass"                                         #
346 #             host="hostmask@of.oper"                                 #
347 #             fingerprint="hexsequence"                               #
348 #             type="oper type">                                       #
349 #                                                                     #
350
351 <oper   name="katsklaw"
352         password="s3cret"
353         host="ident@dialup15.isp.com *@localhost *@server.com *@3ffe::0/16"
354         fingerprint="a41d730937a53b79f788c0ab13e9e1d5"
355         type="NetAdmin">
356
357
358 #-#-#-#-#-#-#-#-#-#-#-  SERVER LINK CONFIGURATION  -#-#-#-#-#-#-#-#-#-#
359 #                                                                     #
360 # Defines which servers can link to this one, and which servers this  #
361 # server may create outbound links to.                                #
362 #                                                                     #
363 # name        -   The name is the canocial name of the server, does   #
364 #                 not have to resolve - but it is expected to be set  #
365 #                 in the remote servers connection info.              #
366 #                                                                     #
367 # ipaddr      -   Valid host or ip address for remote server. These   #
368 #                 hosts are resolved on rehash, and cached, if you    #
369 #                 specify a hostname, so if you find that your server #
370 #                 is still trying to connect to an old IP after you   #
371 #                 have updated your dns, try rehashing and then       #
372 #                 attempting the connect again.                       #
373 #                                                                     #
374 # port        -   The TCP port for the remote server.                 #
375 #                                                                     #
376 # sendpass    -   Password to send to create an outbound connection   #
377 #                 to this server.                                     #
378 #                                                                     #
379 # recvpass    -   Password to receive to accept an inbound connection #
380 #                 from this server.                                   #
381 #                                                                     #
382 # autoconnect -   Sets the server to autoconnect. Where x is the num. #
383 # (optional)      of seconds between attempts. e.g. 300 = 5 minutes.  #
384 #                                                                     #
385 # encryptionkey - Encryption key to be used for AES encryption, where #
386 #                 supported. Links using the spanning tree protocol   #
387 #                 support AES. The encryption key must be EXACTLY 8,  #
388 #                 16 or 32 characters in length for a 64, 128 or 256  #
389 #                 bit key, respectively.                              #
390 #                                                                     #
391 # hidden        - When using m_spanningtree.so for linking. you may   #
392 #                 set this to 'yes', and if you do, the IP address/   #
393 #                 hostname of this connection will NEVER be shown to  #
394 #                 any opers on the network. In /STATS c its address   #
395 #                 will show as *@<hidden>, and during CONNECT and     #
396 #                 inbound connections, its IP will show as <hidden>   #
397 #                 UNLESS the connection fails (e.g. due to a bad      #
398 #                 password or servername)                             #
399 #                                                                     #
400 # allowmask     - When this is defined, it indicates a range of IP    #
401 #                 addresses to allow for this link (You may use CIDR  #
402 #                 or wildcard form for this address).                 #
403 #                 e.g. if your server is going to connect to you from #
404 #                 the range 1.2.3.1 through 1.2.3.255, put 1.2.3.0/24 #
405 #                 into this value. If it is not defined, then only    #
406 #                 the ipaddr field of the server shall be allowed.    #
407 #                                                                     #
408 # failover      - If you define this option, it must be the name of a #
409 #                 different link tag in your configuration. This      #
410 #                 option causes the ircd to attempt a connection to   #
411 #                 the failover link in the event that the connection  #
412 #                 to this server fails. For example, you could define #
413 #                 two hub uplinks to a leaf server, and set an        #
414 #                 american server to autoconnect, with a european     #
415 #                 hub as its failover. In this situation, your ircd   #
416 #                 will only try the link to the european hub if the   #
417 #                 american hub is unreachable. NOTE that for the      #
418 #                 intents and purposes of this option, an unreachable #
419 #                 server is one which DOES NOT ANSWER THE CONNECTION. #
420 #                 If the server answers the connection with accept(), #
421 #                 EVEN IF THE CREDENTIALS ARE INVALID, the failover   #
422 #                 link will not be tried! Failover settings will also #
423 #                 apply to autoconnected servers as well as manually  #
424 #                 connected ones.                                     #
425 #                                                                     #
426 # timeout       - If this is defined, then outbound connections will  #
427 #                 time out if they are not connected within this many #
428 #                 seconds. If this is not defined, the default of ten #
429 #                 seconds is used.                                    #
430 #                                                                     #
431 # to u:line a server (give it extra privilages required for running   #
432 # services, Q, etc) you must include the <uline server> tag as shown  #
433 # in the example below. You can have as many of these as you like.    #
434 #                                                                     #
435 # WARNING: Unlike other ircds, u:lining a server allows ALL users on  #
436 # that server to operoverride modes. This should only be used for     #
437 # services and protected oper servers!                                #
438 #                                                                     #
439 # NOTE: If you have built InspIRCd with IPV6 support, and you want    #
440 # to link to an IPV4 server, you must specify the IP address in the   #
441 # form '::ffff:1.2.3.4' where 1.2.3.4 is the IP address of the target #
442 # server. If you have built InspIRCd for IPV4 (this is the default)   #
443 # you should not prefix your IP addresses in this fashion.            #
444 #                                                                     #
445 #    ____                _   _____ _     _       ____  _ _   _        #
446 #   |  _ \ ___  __ _  __| | |_   _| |__ (_)___  | __ )(_) |_| |       #
447 #   | |_) / _ \/ _` |/ _` |   | | | '_ \| / __| |  _ \| | __| |       #
448 #   |  _ <  __/ (_| | (_| |   | | | | | | \__ \ | |_) | | |_|_|       #
449 #   |_| \_\___|\__,_|\__,_|   |_| |_| |_|_|___/ |____/|_|\__(_)       #
450 #                                                                     #
451 #  If you want to link servers to InspIRCd you must load the          #
452 #  m_spanningtree module! Please see the modules list below for       #
453 #  information on how to load this module! If you do not load this    #
454 #  module, server links will NOT work!                                #
455 #                                                                     #
456
457 <link name="hub.penguin.org"
458         ipaddr="penguin.box.com"
459         port="7000"
460         allowmask="69.58.44.0/24"
461         autoconnect="300"
462         failover="hub.other.net"
463         timeout="15"
464         sendpass="outgoing!password"
465         recvpass="incoming!password">
466
467 <link name="services.antarctic.com"
468         ipaddr="localhost"
469         port="7000"
470         allowmask="127.0.0.0/8"
471         sendpass="penguins"
472         recvpass="polarbears">
473
474 <uline server="services.antarctic.com">
475
476
477 #-#-#-#-#-#-#-#-#-#-  MISCELLANEOUS CONFIGURATION  -#-#-#-#-#-#-#-#-#-#
478 #                                                                     #
479 #   These options let you define the path to your motd and rules      #
480 #   files. If these are relative paths, they are relative to the      #
481 #   configurtion directory.                                           #
482 #                                                                     #
483
484 <files  motd="inspircd.motd"
485         rules="inspircd.rules">
486
487 #-#-#-#-#-#-#-#-#-#-#-#-#-#-# DNS SERVER -#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
488 #                                                                     #
489 # Define your DNS server address here. InspIRCd has its own resolver. #
490 # If you do not define this value, the first dns server from your     #
491 # /etc/resolv.conf file is read. If no entries are found in this file #
492 # or the file cannot be opened, the default value '127.0.0.1' is used #
493 # instead. The timeout value is in seconds.                           #
494 #                                                                     #
495 #    ____                _   _____ _     _       ____  _ _   _        #
496 #   |  _ \ ___  __ _  __| | |_   _| |__ (_)___  | __ )(_) |_| |       #
497 #   | |_) / _ \/ _` |/ _` |   | | | '_ \| / __| |  _ \| | __| |       #
498 #   |  _ <  __/ (_| | (_| |   | | | | | | \__ \ | |_) | | |_|_|       #
499 #   |_| \_\___|\__,_|\__,_|   |_| |_| |_|_|___/ |____/|_|\__(_)       #
500 #                                                                     #
501 # When choosing a server, be sure to choose one which will do a       #
502 # RECURSIVE LOOKUP. InspIRCd's resolver does not currently do these   #
503 # recursive lookups itself, to save time and resources. The dns       #
504 # server recommended by the InspIRCd team is bind, available from the #
505 # ISC website. If your DNS server does not do a recursive lookup, you #
506 # will be able to notice this by the fact that none of your users are #
507 # resolving even though the DNS server appears to be up! Most ISP and #
508 # hosting provider DNS servers support recursive lookups.             #
509 #                                                                     #
510 # NOTE: If you have built InspIRCd with IPV6 support, and you want    #
511 # to use an IPV4 nameserver, you must specify the IP address in the   #
512 # form '::ffff:1.2.3.4' where 1.2.3.4 is the IP address of the target #
513 # server. If you have built InspIRCd for IPV4 (this is the default)   #
514 # you should not prefix your IP addresses in this fashion.            #
515 #                                                                     #
516 # IF YOUR RESOLV.CONF CONTAINS ONLY IPV4 ADDRESSES, AND YOU ARE USING #
517 # IPV6, YOU MUST DEFINE THE <DNS SERVER> TAG, AND USE THE ::FFFF      #
518 # PREFIX NOTATION. IF YOU DO NOT, HOSTS WILL *NOT* RESOLVE.           #
519 #                                                                     #
520
521 <dns server="127.0.0.1" timeout="5">
522
523 # An example of using IPV4 nameservers over IPV6
524 #<dns server="::ffff:127.0.0.1" timeout="5">
525
526 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#  PID FILE  -#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
527 #                                                                     #
528 # Define the path to the PID file here. The PID file can be used to   #
529 # rehash the ircd from the shell or to terminate the ircd from the    #
530 # shell using shell scripts, perl scripts etc, and to monitor the     #
531 # ircd's state via cron jobs. If this is a relative path, it will be  #
532 # relative to the configuration directory, and if it is not defined,  #
533 # the default of 'inspircd.pid' is used.                              #
534 #                                                                     #
535
536 #<pid file="/path/to/inspircd.pid">
537
538 #-#-#-#-#-#-#-#-#-#-#-#-#- BANLIST LIMITS #-#-#-#-#-#-#-#-#-#-#-#-#-#-#
539 #                                                                     #
540 # Use these tags to customise the ban limits on a per channel basis.  #
541 # the tags are read from top to bottom, and any tag found which       #
542 # matches the channels name applies the banlimit to that channel.     #
543 # It is advisable to put an entry with the channel as '*' at the      #
544 # bottom of the list. If none are specified or no maxbans tag is      #
545 # matched, the banlist size defaults to 64 entries.                   #
546 #                                                                     #
547
548 <banlist chan="#morons" limit="128">
549 <banlist chan="*" limit="69">
550
551 #-#-#-#-#-#-#-#-#-#-#-  DISABLED COMMANDS  -#-#-#-#-#-#-#-#-#-#-#-#-#-#
552 #                                                                     #
553 # This tag is optional, and specifies one or more commands which are  #
554 # not available to non-operators. For example you may wish to disable #
555 # NICK and prevent non-opers from changing their nicknames.           #
556 # Note that any disabled commands take effect only after the user has #
557 # 'registered' (e.g. after the initial USER/NICK/PASS on connection)  #
558 # so for example disabling NICK will not cripple your network.        #
559 #                                                                     #
560
561 #<disabled commands="TOPIC MODE">
562
563
564 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-  RTFM LINE  -#-#-#-#-#-#-#-#-#-#-#-#-#-#
565 #                                                                     #
566 #   Just remove this... Its here to make you read ALL of the config   #
567 #   file options ;)                                                   #
568
569 <die value="You should probably edit your config *PROPERLY* and try again.">
570
571
572
573 #-#-#-#-#-#-#-#-#-#-#-#-#-  SERVER OPTIONS   -#-#-#-#-#-#-#-#-#-#-#-#-#
574 #                                                                     #
575 #   Settings to define which features are useable on your server.     #
576 #                                                                     #
577 #  prefixquit    - a prefix for a client's quit message               #
578 #                                                                     #
579 #  loglevel      - specifies what detail of messages to log in the    #
580 #                  log file. You may select from debug, verbose,      #
581 #                  default, sparse and none.                          #
582 #                                                                     #
583 #  allowhalfop   - allows the +h channel mode                         #
584 #                                                                     #
585 #  noservices    - If noservices is true, yes, or 1, then the first   #
586 #                  user into a channel gets founder status. This is   #
587 #                  only useful on networks running the m_chanprotect  #
588 #                  module without services.                           #
589 #                                                                     #
590 #  qaprefixes    - If qaprefixes is true, yes, or 1, then users       #
591 #                  with +q or +a will get the ~ or & prefixes         #
592 #                  used in unreal. This is only useful on networks    #
593 #                  running the m_chanprotect module                   #
594 #                                                                     #
595 #  deprotectself - If this value is set to yes, true, or 1, then any  #
596 #                  user with +q or +a may remove the +q or +a from    #
597 #                  themselves. The default setting is to not enable   #
598 #                  this feature, which stops even the founder taking  #
599 #                  away their founder status without using services.  #
600 #                                                                     #
601 #  cyclehosts    - If this is set to true, yes or 1, then when a      #
602 #                  user's hostname changes, they will appear to quit  #
603 #                  and then rejoin with their new host. This prevents #
604 #                  clients from being confused by host changes,       #
605 #                  especially in the case of bots, and it is          #
606 #                  recommended that this option is enabled.           #
607 #                                                                     #
608 #  netbuffersize - size of the buffer used to receive data from       #
609 #                  clients. The ircd may only read() this amount      #
610 #                  of text in one go at any time. (OPTIONAL)          #
611 #                                                                     #
612 #  maxwho        - The maximum number of results returned by a /WHO   #
613 #                  query. This is to prevent /WHO being used as a     #
614 #                  spam vector or means of flooding an ircd. The      #
615 #                  default is 128, it is not recommended to raise it  #
616 #                  above 1024. Values up to 65535 are permitted.      #
617 #                                                                     #
618 #  somaxconn     - The maximum number of sockets that may be waiting  #
619 #                  in the accept queue. This usually allows the ircd  #
620 #                  to soak up more connections in a shorter space of  #
621 #                  time when increased but please be aware there is a #
622 #                  system defined maximum value to this, the same way #
623 #                  there is a system defined maximum number of file   #
624 #                  descriptors. Some systems may only allow this to   #
625 #                  be up to 5 (ugh) while others such as FreeBSD will #
626 #                  default to a much nicer 128.                       #
627 #                                                                     #
628 #  moduledir     - This optional value indicates a runtime change of  #
629 #                  the location where modules are to be found. This   #
630 #                  does not add a supplementary directory. There can  #
631 #                  only be one module path.                           #
632 #                                                                     #
633 #  softlimit     - This optional feature allows a defined softlimit.  #
634 #                  if defined sets a soft maxconnections value, has   #
635 #                  to be less than the ./configure maxclients         #
636 #                                                                     #
637 #  userstats     - The userstats field is optional and specifies      #
638 #                  which stats characters in /STATS may be requested  #
639 #                  by non-operators. Stats characters in this field   #
640 #                  are case sensitive and are allowed to users        #
641 #                  independent of if they are in a module or the core #
642 #                                                                     #
643 #  operspywhois  - If this is set then when an IRC operator uses      #
644 #                  /WHOIS on a user they will see all channels, even  #
645 #                  ones if channels are secret (+s), private (+p) or  #
646 #                  if the target user is invisible +i.                #
647 #                                                                     #
648 #  customversion - If you specify this configuration item, and it is  #
649 #                  not set to an empty value, then when a user does   #
650 #                  a /VERSION command on the ircd, this string will   #
651 #                  be displayed as the second portion of the output,  #
652 #                  replacing the system 'uname', compile flags and    #
653 #                  socket engine/dns engine names. You may use this   #
654 #                  to enhance security, or simply for vanity.         #
655 #                                                                     #
656 #  maxtargets    - The maxtargets field is optional, and if not       #
657 #                  defined, defaults to 20. It indicates the maximum  #
658 #                  number of targets which may be given to commands   #
659 #                  such as PRIVMSG, KICK etc.                         #
660 #                                                                     #
661 #  hidesplits    - When set to 'yes', will hide split server names    #
662 #                  from non-opers. Non-opers will see '*.net *.split' #
663 #                  instead of the server names in the quit message,   #
664 #                  identical to the way IRCu displays them.           #
665 #                                                                     #
666 #  hidebans      - When set to 'yes', will hide gline, kline, zline   #
667 #                  and qline quit messages from non-opers. For        #
668 #                  example, user A who is not an oper will just see   #
669 #                  (G-Lined) while user B who is an oper will see the #
670 #                  text (G-Lined: Reason here) instead.               #
671 #                                                                     #
672 #  hidewhois     - When defined with a non-empty value, the given     #
673 #                  text will be used in place of the user's server    #
674 #                  in WHOIS, when a user is WHOISed by a non-oper.    #
675 #                  For example, most nets will want to set this to    #
676 #                  something like '*.netname.net' to conceal the      #
677 #                  actual server the user is on.                      #
678 #                                                                     #
679 #  flatlinks     - When you are using m_spanningtree.so, and this     #
680 #                  value is set to true, yes or 1, /MAP and /LINKS    #
681 #                  will be flattened when shown to a non-oper.        #
682 #                                                                     #
683 #  hideulines    - When you are using m_spanningtree.so, and this     #
684 #                  value is set to true, yes or 1, then U-lined       #
685 #                  servers will be hidden in /LINKS and /MAP. For non #
686 #                  opers. Please be aware that this will also hide    #
687 #                  any leaf servers of a U-lined server, e.g. jupes.  #
688 #                                                                     #
689 #  tempdir       - If defined, indicates a path where modules will be #
690 #                  temporarily copied before loading. If not defined, #
691 #                  defaults to /tmp.                                  #
692 #                                                                     #
693 #  nouserdns     - If set to 'yes', 'true' or '1', no user dns        #
694 #                  lookups will be performed for connecting users.    #
695 #                  this can save a lot of resources on very busy irc  #
696 #                  servers.                                           #
697 #                                                                     #
698 #  syntaxhints   - If set to 'yes', 'true' or '1', when a user does   #
699 #                  not give enough parameters for a command, a syntax #
700 #                  hint will be given (using the RPL_TEXT numeric)    #
701 #                  as well as the standard ERR_NEEDMOREPARAMS.        #
702 #                                                                     #
703 #  announcets    - If this value is defined to 'yes', 'true' or '1',  #
704 #                  then if a channel's timestamp is updated the users #
705 #                  on the channel will be informed of the change via  #
706 #                  a server notice to the channel with the old and    #
707 #                  new TS values in the timestamp. If you think this  #
708 #                  is just pointless noise, define the value to 0.    #
709 #                                                                     #
710 #  notimesync    - If this value is 'yes', 'true', or '1', time       #
711 #                  synchronization is disabled on this server. This   #
712 #                  means any servers you are linked to will not       #
713 #                  automatically synchronize time with you, and in    #
714 #                  most cases will just result in more bounced modes  #
715 #                  on netsplits. This option should be the same on    #
716 #                  all servers.                                       #
717 #                                                                     #
718
719 <options prefixquit="Quit: "
720          loglevel="default"
721          netbuffersize="10240"
722          maxwho="128"
723          noservices="no"
724          qaprefixes="no"
725          deprotectself="no"
726          somaxconn="128"
727          softlimit="12800"
728          userstats="Pu"
729          operspywhois="no"
730          customversion=""
731          maxtargets="20"
732          hidesplits="no"
733          hidebans="no"
734          hidewhois=""
735          flatlinks="no"
736          hideulines="no"
737          nouserdns="no"
738          syntaxhints="no"
739          cyclehosts="yes"
740          announcets="yes"
741          notimesync="no"
742          allowhalfop="yes">
743
744
745
746 #-#-#-#-#-#-#-#-#-#-#-#-#-  MODULE OPTIONS   -#-#-#-#-#-#-#-#-#-#-#-#-#
747 #                                                                     #
748 #  These tags define which modules will be loaded on startup by your  #
749 #  server. Add modules without any paths. When you make your ircd     #
750 #  using the 'make' command, all compiled modules will be moved into  #
751 #  the folder you specified when you ran ./configure. The module tag  #
752 #  automatically looks for modules in this location.                  #
753 #  If you attempt to load a module outside of this location, either   #
754 #  in the config, or via /LOADMODULE, you will receive an error.      #
755 #                                                                     #
756 #  By default, ALL modules are commented out. You must uncomment them #
757 #  or add lines to your config to load modules. Please refer to       #
758 #  http://www.inspircd.org/wiki/Modules_List for a list of modules and#
759 #  each modules link for any additional conf tags they require.       #
760 #                                                                     #
761 #  You may use wildcards in a <module> tag to load all modules which  #
762 #  match a glob pattern (e.g. m_sa????.so would load m_sajoin,        #
763 #  m_sapart, m_saquit and m_sanick)                                   #
764 #                                                                     #
765 #    ____                _   _____ _     _       ____  _ _   _        #
766 #   |  _ \ ___  __ _  __| | |_   _| |__ (_)___  | __ )(_) |_| |       #
767 #   | |_) / _ \/ _` |/ _` |   | | | '_ \| / __| |  _ \| | __| |       #
768 #   |  _ <  __/ (_| | (_| |   | | | | | | \__ \ | |_) | | |_|_|       #
769 #   |_| \_\___|\__,_|\__,_|   |_| |_| |_|_|___/ |____/|_|\__(_)       #
770 #                                                                     #
771 # To link servers to InspIRCd, you MUST load the m_spanningtree       #
772 # module, as shown below. If you DO NOT do this, server links will    #
773 # NOT work at all. ie. The ports will NOT bind, and /connect will not #
774 # work properly. This is by design, to allow for the implementation   #
775 # of other linking protocols in modules in the future.                #
776
777 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
778 # Spanning Tree module - allows linking of servers using the spanning
779 # tree protocol (see the READ THIS BIT section above).
780 #
781 #<module name="m_spanningtree.so">
782
783 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
784 # Alias module: Allows you to define server-side command aliases
785 #<module name="m_alias.so">
786 #
787 #-#-#-#-#-#-#-#-#-#-#-  ALIAS DEFINITIONS  -#-#-#-#-#-#-#-#-#-#-#-#-#-#
788 #                                                                     #
789 # If you have the m_alias.so module loaded, you may also define       #
790 # aliases as shown below. They are commonly used to provide shortcut  #
791 # commands to services, however they are not limited to just this use.#
792 # An alias tag requires the following values to be defined in it:     #
793 #                                                                     #
794 # text        -      The text to detect at the start of the line,     #
795 #                    must be at the start of the line to trigger the  #
796 #                    alias. Cant contain spaces, but case insensitive #
797 # replace     -      The text to replace 'text' with. Usually this    #
798 #                    will be "PRIVMSG ServiceName :$2-" or similar.   #
799 #                    You may use the variables $1 through $9 in the   #
800 #                    replace string, which refer to the first through #
801 #                    ninth word in the original string typed by the   #
802 #                    user. You may also use $1- through $9- which     #
803 #                    refer to the first word onwards, through to the  #
804 #                    ninth word onwards, e.g. if the user types the   #
805 #                    command "foo bar baz qux quz" then $3- will hold #
806 #                    "baz qux quz" and $2 will contain "bar". You may #
807 #                    also use the special variables: $nick, $ident,   #
808 #                    $host and $vhost, and you may seperate multiple  #
809 #                    commands with \n. If you wish to use the ACTUAL  #
810 #                    characters \ and n together in a line, you must  #
811 #                    use the sequence "\\n".                          #
812 # requires    -      If you provide a value for 'requires' this means #
813 #                    the given nickname MUST be online for the alias  #
814 #                    to successfully trigger. If they are not, then   #
815 #                    the user receives a 'no such nick' 401 numeric.  #
816 # uline       -      Defining this value with 'yes', 'true' or '1'    #
817 #                    will ensure that the user given in 'requires'    #
818 #                    must also be on a u-lined server, as well as     #
819 #                    actually being on the network. If the user is    #
820 #                    online, but not on a u-lined server, then an     #
821 #                    oper-alert is sent out as this is possibly signs #
822 #                    of a user trying to impersonate a service.       #
823 # operonly    -      Defining this value, with a value of 'yes', '1'  #
824 #                    or true will make the alias oper only. If a non- #
825 #                    oper attempts to use the alias, it will appear   #
826 #                    to not exist.                                    #
827 #                                                                     #
828 #<alias text="NICKSERV" replace="PRIVMSG NickServ :$2-" requires="NickServ" uline="yes">
829 #<alias text="CHANSERV" replace="PRIVMSG ChanServ :$2-" requires="ChanServ" uline="yes">
830 #<alias text="OPERSERV" replace="PRIVMSG OperServ :$2-" requires="OperServ" uline="yes" operonly="yes">
831 #<alias text="NS" replace="PRIVMSG NickServ :$2-" requires="NickServ" uline="yes">
832 #<alias text="CS" replace="PRIVMSG ChanServ :$2-" requires="ChanServ" uline="yes">
833 #<alias text="OS" replace="PRIVMSG OperServ :$2-" requires="OperServ" uline="yes" operonly="yes">
834 #<alias text="ID" replace="PRIVMSG NickServ :IDENTIFY $3" requires="NickServ" uline="yes">
835
836 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
837 # Alltime module: Shows time on all connected servers at once
838 # #<module name="m_alltime.so">
839
840 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
841 # Antibear security module: Prevents 'bear.txt' based trojans from
842 # connecting to your network by sending them a numeric they can't handle.
843 #<module name="m_antibear.so">
844
845 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
846 # Antibottler module: Labels bottler leech bots
847 #<module name="m_antibottler.so">
848
849 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
850 # Ban except module: Adds support for channel ban exceptions (+e)
851 #<module name="m_banexception.so">
852
853 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
854 # Block amsg module: Attempt to block all usage of /amsg and /ame
855 #<module name="m_blockamsg.so">
856 #
857 #-#-#-#-#-#-#-#-#-#-#-  BLOCKAMSG CONFIGURATION  -#-#-#-#-#-#-#-#-#-#-#
858 #                                                                     #
859 # If you have the m_blockamsg.so module loaded, you can configure it  #
860 # with the <blockamsg> tag:                                           #
861 #                                                                     #
862 # delay          -   How many seconds between two messages to force   #
863 #                    them to be recognised as unrelated.              #
864 # action         -   Any of 'notice', 'noticeopers', 'silent', 'kill' #
865 #                    or 'killopers'. Define how to take action when   #
866 #                    a user uses /amsg or /ame.                       #
867 #
868 #<blockamsg delay="3" action="killopers">
869
870 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
871 # Block CAPS module: Blocking all-CAPS messages with cmode +P
872 #<module name="m_blockcaps.so">
873
874 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
875 # Block colour module: Blocking colour-coded messages with cmode +c
876 #<module name="m_blockcolor.so">
877
878 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
879 # Botmode module: Adds the user mode +B
880 #<module name="m_botmode.so">
881
882 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
883 # CBAN module: Lets you disallow channels from being used at runtime.
884 #<module name="m_cban.so">
885
886 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
887 # Censor module: Adds the channel mode +G
888 #<module name="m_censor.so">
889 #
890 #-#-#-#-#-#-#-#-#-#-#-  CENSOR  CONFIGURATION  -#-#-#-#-#-#-#-#-#-#-#-#
891 #                                                                     #
892 # Optional - If you specify to use the m_censor module, then you must #
893 # specify some censor tags. See also:                                 #
894 # http://www.inspircd.org/wiki/Censor_Module                          #
895 #
896 #<include file="censor.conf">
897
898 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
899 # Channel filter module: Allows channel-op defined message
900 # filtering using simple string matches (channel mode +g)
901 #<module name="m_chanfilter.so">
902
903 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
904 # Chanprotect module: gives +q and +a channel modes
905 #<module name="m_chanprotect.so">
906
907 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
908 # CHGHOST module: Adds the /CHGHOST command
909 #<module name="m_chghost.so">
910
911 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
912 # CHGIDENT module: Adds the /CHGIDENT command
913 #<module name="m_chgident.so">
914
915 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
916 # Cloaking module: Adds usermode +x and cloaking support
917 #<module name="m_cloaking.so">
918 #
919 #-#-#-#-#-#-#-#-#-#-#- CLOAKING  CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#
920 #                                                                     #
921 # Optional - If ypu specify the m_cloaking.so module as above, you    #
922 # must define cloak keys, and optionally a cloak prefix as shown      #
923 # below. When using cloaking, the cloak keys are MANDITORY and must   #
924 # be included. However, if prefix is not included, it will default    #
925 # to your networks name from the <server> tag.                        #
926 #                                                                     #
927 # <cloak key1="543241423"                                             #
928 #        key2="5378410432"                                            #
929 #        key3="1143242382"                                            #
930 #        key4="9504324581"                                            #
931 #        prefix="mynet">                                              #
932 #                                                                     #
933 # Please note that the key values will accept any number, and should  #
934 # be large numbers. Using small numbers such as "7" or "1924" will    #
935 # seriously weaken the security of your cloak.                        #
936
937 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
938 # Conn-Lusers: Shows the LUSERS output on connect
939 #<module name="m_conn_lusers.so">
940
941 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
942 # Conn-Usermodes: Set modes on users when they connect
943 # When this module is loaded <connect:allow> tags may have an optional
944 # modes="" value, which contains modes to add or remove from users
945 # when they connect to the server.
946 #<module name="m_conn_umodes.so">
947
948 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
949 # Conn-Wait-for-Pong: Don't let a user connect until they PONG
950 #<module name="m_conn_waitpong.so">
951 #
952 #-#-#-#-#-#-#-#-#-#-#-   WAITPONG CONFIGURATION  -#-#-#-#-#-#-#-#-#-#-#
953 #                                                                     #
954 # If you have the m_conn_waitpong.so module loaded, configure it with #
955 # the <waitpong> tag:                                                 #
956 #                                                                     #
957 # sendsnotice    -   Whether to send a snotice on connect, like other #
958 #                    older ircds                                      #
959 #                                                                     #
960 # killonbadreply -   Whether to kill the user if they send the wrong  #
961 #                    PONG reply.                                      #
962 #                                                                     #
963 #<waitpong sendsnotice="yes" killonbadreply="yes">
964
965 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
966 # Connection throttle module. Configuration:
967 #<module name="m_connflood.so">
968 #
969 #-#-#-#-#-#-#-#-#-#-#- CONTHROTTLE CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
970 #  seconds, maxconns -  Amount of connections per <seconds>.
971 #
972 #  timeout           -  Time to wait after the throttle was activated
973 #                       before deactivating it. Be aware that the time
974 #                       is seconds + timeout.
975 #
976 #  quitmsg           -  The message that users get if they attempt to
977 #                       connect while the throttle is active.
978 #
979 #  bootwait          -  Amount of time to wait before enforcing the
980 #                       throttling when the server just booted.
981 #
982 #<connflood seconds="30" maxconns="3" timeout="30"
983 #   quitmsg="Throttled" bootwait="10">
984
985 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
986 # DCCALLOW module: Adds the /DCCALLOW command
987 #<module name="m_dccallow.so">
988 #
989 #-#-#-#-#-#-#-#-#-#-#-  DCCALLOW CONFIGURATION   -#-#-#-#-#-#-#-#-#-#-#
990 #  blockchat         - Whether to block DCC CHAT as well as DCC SEND
991 #  length            - Default duration of entries in DCCALLOW list
992 #  action            - Default action to take if no action is specified
993 #                      can be 'block' or 'allow'
994 #
995 # File configuration:
996 #  pattern           - The glob pattern to match against
997 #  action            - Action to take if a user attempts to send a file
998 #                      that matches this pattern, can be 'block' or 'allow'
999 #
1000 #<dccallow blockchat="yes" length="5m" action="block">
1001 #<banfile pattern="*.exe" action="block">
1002 #<banfile pattern="*.txt" action="allow">
1003 #
1004 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1005
1006 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1007 # Deny Channels: Deny Channels from being used by users
1008 #<module name="m_denychans.so"> 
1009 #
1010 #-#-#-#-#-#-#-#-#-#-#-   DENYCHAN DEFINITIONS  -#-#-#-#-#-#-#-#-#-#-#-#
1011 #                                                                     #
1012 # If you have the m_denychans.so module loaded, you need to specify   #
1013 # the channels to deny:                                               #
1014 #                                                                     #
1015 # name        -      The channel name to deny.                        #
1016 #                                                                     #
1017 # allowopers  -      If operators are allowed to override the deny.   #
1018 #                                                                     #
1019 # reason      -      Reason given for the deny.                       #
1020 #                                                                     #
1021 #<badchan name="#gods" allowopers="yes" reason="Tortoises!">
1022
1023 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1024 # Devoice Module: Let users devoice themselves.
1025 #<module name="m_devoice.so">
1026
1027 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1028 # Filter module: Provides glob-based message filtering
1029 #<module name="m_filter.so">
1030 # OR
1031 # PCRE filter module: Filters messages using regular expressions
1032 #<module name="m_filter_pcre.so">
1033 #
1034 # You may only use one or the other with these modules, network-wide.
1035 #
1036 #-#-#-#-#-#-#-#-#-#-#-  FILTER  CONFIGURATION  -#-#-#-#-#-#-#-#-#-#-#-#
1037 #                                                                     #
1038 # Optional - If you specify to use the m_filter or m_filter_pcre      #
1039 # modules, then specfiy below the path to the filter.conf file,       #
1040 # or define some <filter> tags.                                       #
1041 #                                                                     #
1042 #<include file="filter.conf">
1043
1044 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1045 # Foobar module: does nothing - historical relic
1046 #<module name="m_foobar.so">
1047
1048 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1049 # Globops module: gives /GLOBOPS and usermode +g
1050 #<module name="m_globops.so">
1051
1052 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1053 # Global load module: Allows loading and unloading of modules network-
1054 # wide (USE WITH EXTREME CAUTION!)
1055 #<module name="m_globalload.so">
1056
1057 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1058 # HELPOP module: Provides the /HELPOP command
1059 #<module name="m_helpop.so">
1060 #
1061 #-#-#-#-#-#-#-#-#-#-#-#-  HELPOP  CONFIGURATION  -#-#-#-#-#-#-#-#-#-#-#
1062 #                                                                     #
1063 # Optional - If you specify to use the m_helpop.so module, then       #
1064 # specify below the path to the helpop.conf file, or if you like to   #
1065 # make a mess, define your helpop tags in this conf.                  #
1066 #                                                                     #
1067 #<include file="helpop.conf">
1068
1069 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1070 # HIDECHANS module: Allows opers to hide their channels list from non-
1071 # opers by setting user mode +I on themselves.
1072 # <module name="m_hidechans.so">
1073
1074 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1075 # HIDEOPER module: Allows opers to hide their oper status from non-
1076 # opers by setting user mode +H on themselves.
1077 # <module name="m_hideoper.so">
1078
1079 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1080 # Hostchange module: Allows a different style of cloaking
1081 #<module name="m_hostchange.so">
1082 #
1083 #-#-#-#-#-#-#-#-#-#-#-  HOSTCHANGE  CONFIGURATION  -#-#-#-#-#-#-#-#-#-#
1084 #                                                                     #
1085 # Optional - If you choose to use the m_hostchange.so module.         #
1086 # Config Help -  See http://www.inspircd.org/wiki/Host_Changer_Module #
1087 #                                                                     #
1088 #<host suffix="polarbears.org">
1089 #<hostchange mask="*@fbi.gov" action="addnick">
1090 #<hostchange mask="*r00t@*" action="suffix">
1091 #<hostchange mask="a@b.com" action="set" value="blah.blah.blah">
1092
1093 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1094 # httpd module: Provides http server support for InspIRCd
1095 #<module name="m_httpd.so">
1096 #
1097 #-#-#-#-#-#-#-#-#-#-#-#-  HTTPD   CONFIGURATION  -#-#-#-#-#-#-#-#-#-#-#
1098 #
1099 # Optional - If you choose to use the m_httpd.so module,  then you must
1100 # specify the port number and other details of your http server:
1101 #
1102 #<http ip="192.168.1.10" host="brainwave" port="32006"
1103 #      index="/home/brain/inspircd/http/index.html">
1104 #
1105 # You may have as many of these tags as you wish, each with a different
1106 # IP, port, host or index file. Each one will act as an independent
1107 # HTTP server.
1108 #
1109
1110 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1111 # http stats module: Provides basic stats pages over HTTP
1112 # Requires m_httpd.so to be loaded for it to function.
1113 #<module name="m_httpd_stats.so">
1114 #
1115 #-#-#-#-#-#-#-#-#-#-#-#- HTTPD STATS CONFIGURATION -#-#-#-#-#-#-#-#-#-#
1116 #
1117 #<httpstats stylesheet="http://remote.style/sheet.css">
1118 #
1119
1120 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1121 # Ident: Provides RFC 1413 ident lookup support
1122 #<module name="m_ident.so">
1123 #
1124 #-#-#-#-#-#-#-#-#-#-#-#-   IDENT CONFIGURATION   -#-#-#-#-#-#-#-#-#-#-#
1125 #                                                                     #
1126 # Optional - If you are using the m_ident.so module, then you can     #
1127 # specify the timeout for ident lookups here. If not defined, it will #
1128 # default to one second. This is a non-blocking timeout which holds   #
1129 # the user in a 'connecting' state until the lookup is complete.      #
1130 #                                                                     #
1131 #<ident timeout="5">
1132
1133 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1134 # Invite except module: Adds support for channel invite exceptions (+I)
1135 #<module name="m_inviteexception.so">
1136
1137 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1138 # Join flood module: Adds support for join flood protection (+j)
1139 #<module name="m_joinflood.so">
1140
1141 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1142 # Anti-Auto-Rejoin: Adds support for prevention of auto-rejoin (+J)
1143 #<module name="m_kicknorejoin.so">
1144
1145 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1146 # Knock module: adds the /KNOCK command and +K channel mode
1147 #<module name="m_knock.so">
1148
1149 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1150 # Msg flood module: Adds message/notice flood protection (+f)
1151 #<module name="m_messageflood.so">
1152
1153 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1154 # MySQL module: Allows other SQL modules to access MySQL databases
1155 # through a unified API. You must copy the source for this module
1156 # from the directory src/modules/extra, plus the file m_sqlv2.h
1157 #<module name="m_mysql.so">
1158 #
1159 #-#-#-#-#-#-#-#-#-#-#-#- SQL CONFIGURATION   -#-#-#-#-#-#-#-#-#-#-#-#-#
1160 #                                                                     #
1161 # m_mysql.so is more complex than described here, see the wiki for    #
1162 # more: http://www.inspircd.org/wiki/SQL_Service_Provider_Module      #
1163 #
1164 #<database name="mydb" username="myuser" password="mypass" hostname="localhost" id="my_database2">
1165
1166 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1167 # NAMESX module: Provides support for the NAMESX extension which allows
1168 # clients to see all the prefixes set on a user without getting confused.
1169 # This is supported by mIRC, x-chat, klient, and maybe more.
1170 #<module name="m_namesx.so">
1171
1172 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1173 # Nicklock module: Let opers change a user's nick and then stop that
1174 # user from changing their nick again.
1175 #<module name="m_nicklock.so">
1176
1177 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1178 # No ctcp module: Adds the channel mode +C to block CTCPs
1179 #<module name="m_noctcp.so">
1180
1181 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1182 # Noinvite module: Gives channel mode +V
1183 #<module name="m_noinvite.so">
1184
1185 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1186 # No kicks module: Adds the +Q channel mode
1187 #<module name="m_nokicks.so">
1188
1189 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1190 # No nicks module: Adds the +N channel mode
1191 #<module name="m_nonicks.so">
1192
1193 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1194 # No Notice module: adds the channel mode +T
1195 #<module name="m_nonotice.so">
1196
1197 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1198 # Oper channels mode: Adds the +O channel mode
1199 #<module name="m_operchans.so">
1200
1201 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1202 # Oper Join module: Forces opers to join a channel on oper-up
1203 #<module name="m_operjoin.so">
1204 #
1205 #-#-#-#-#-#-#-#-#-#-#   OPERJOIN CONFIGURATION   -#-#-#-#-#-#-#-#-#-#-#
1206 #                                                                     #
1207 # If you are using the m_operjoin.so module, specify the channel here #
1208 #                                                                     #
1209 #<operjoin channel="#channel">
1210
1211 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1212 # Oper MOTD module: Provides support for seperate message of the day
1213 # on oper-up
1214 #<module name="m_opermotd.so">
1215 #
1216 #-#-#-#-#-#-#-#-#-#-#   OPERMOTD CONFIGURATION   -#-#-#-#-#-#-#-#-#-#-#
1217 #                                                                     #
1218 # If you are using the m_opermotd.so module, specify the motd here    #
1219 #                                                                     #
1220 #<opermotd file="/path/to/oper.motd">
1221
1222 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1223 # Override module: Adds support for oper override
1224 #<module name="m_override.so">
1225 #
1226 #-#-#-#-#-#-#-#-#-#-#   OVERRIDE CONFIGURATION   -#-#-#-#-#-#-#-#-#-#-#
1227 #                                                                     #
1228 # m_override.so is too complex it describe here, see the wiki:        #
1229 # http://www.inspircd.org/wiki/Oper_Override_Module                   #
1230
1231 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1232 # Oper levels module: Gives each oper a level and prevents
1233 # actions being taken against higher level opers
1234 # Specify the level as the 'level' parameter of the <type> tag
1235 #<module name="m_operlevels.so">
1236
1237 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1238 # Oper MD5 module: Allows MD5 hashed oper passwords
1239 #<module name="m_opermd5.so">
1240
1241 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1242 # Oper SHA256 module: Allows SHA256 hashed oper passwords
1243 # This module is in src/modules/extra
1244 #<module name="m_opersha256.so">
1245
1246 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1247 # Oper modes module: Allows you to specify modes to add/remove on oper
1248 # Specify the modes as the 'modes' parameter of the <type> tag
1249 #<module name="m_opermodes.so">
1250
1251 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1252 # PostgreSQL module: Allows other SQL modules to access PgSQL databases
1253 # through a unified API. You must copy the source for this module
1254 # from the directory src/modules/extra, plus the file m_sqlv2.h
1255 #<module name="m_pgsql.so">
1256 #
1257 #-#-#-#-#-#-#-#-#-#-#-#- SQL CONFIGURATION   -#-#-#-#-#-#-#-#-#-#-#-#-#
1258 #                                                                     #
1259 # m_pgsql.so is more complex than described here, see the wiki for    #
1260 # more: http://www.inspircd.org/wiki/SQL_Service_Provider_Module      #
1261 #
1262 #<database name="mydb" username="myuser" password="mypass" hostname="localhost" id="my_database" ssl="no">
1263
1264 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1265 # Random Quote module: provides a random quote on connect.
1266 # NOTE: Some of these may mimic fatal errors and confuse users and 
1267 # opers alike! - BEWARE!
1268 #<module name="m_randquote.so">
1269 #
1270 #-#-#-#-#-#-#-#-#-#-  RANDOMQUOTES CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
1271 #                                                                     #
1272 # Optional - If you specify to use the m_randquote.so module, then    #
1273 # specify below the path to the randquotes.conf file.                 #
1274 #                                                                     #
1275 #<randquote file="/path/to/inspircd/randquotes.conf">
1276
1277 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1278 # Redirect module: Adds channel redirection (mode +L)
1279 #<module name="m_redirect.so">
1280
1281 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1282 # Remove module: Adds the /REMOVE command which is a peaceful
1283 # alternative to /KICK
1284 #<module name="m_remove.so">
1285
1286 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1287 # Restricted channels module: Allows only opers to create channels
1288 #<module name="m_restrictchans.so">
1289
1290 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1291 # Restrict message module: Allows users to only message opers
1292 #<module name="m_restrictmsg.so">
1293
1294 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1295 # Provide /LIST throttling (to prevent flooding) and /LIST safety to
1296 # prevent excess flood when the list is large.
1297 #<module name="m_safelist.so">
1298
1299 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1300 # SAJOIN module: Adds the /SAJOIN command
1301 #<module name="m_sajoin.so">
1302
1303 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1304 # SAMODE module: Adds the oper /SAMODE command
1305 #<module name="m_samode.so">
1306
1307 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1308 # SANICK module: Allows opers to change user's nicks
1309 #<module name="m_sanick.so">
1310
1311 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1312 # SAPART module: Adds the oper /SAPART command
1313 #<module name="m_sapart.so">
1314
1315 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1316 # SAQUIT module: Adds the oper /SAQUIT command (abusable!!!)
1317 #<module name="m_saquit.so">
1318
1319 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-
1320 # Secure list module: Prevent /LIST in the first minute of connection,
1321 # crippling most spambots and trojan spreader bots.
1322 #<module name="m_securelist.so">
1323
1324 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1325 # Set Idle module: Adds a command for opers to change their
1326 # idle time (mainly a toy)
1327 #<module name="m_setidle.so">
1328
1329 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1330 # Services support module: Adds several usermodes such as +R and +M
1331 # this module implements the 'identified' state via user mode +r, which
1332 # is similar to the DALnet and dreamforge systems.
1333 #<module name="m_services.so">
1334
1335 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1336 # Services support module: Adds several usermodes such as +R and +M
1337 # this module implements the 'identified' state via account names (AC)
1338 # and is similar in operation to the way asuka and ircu handle services.
1339 # it cannot be used at the same time as m_services, above.
1340 #<module name="m_services_account.so">
1341
1342 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1343 # Sethost module: Adds the /SETHOST command
1344 #<module name="m_sethost.so">
1345
1346 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1347 # Setident module: Adds the /SETIDENT command
1348 #<module name="m_setident.so">
1349
1350 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1351 # SETNAME module: Adds the /SETNAME command
1352 #<module name="m_setname.so">
1353
1354 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1355 # Show Whois module: Adds the +W usermode which allows opers
1356 # to see when they are whois'ed (can be annoying).
1357 #<module name="m_showwhois.so">
1358
1359 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1360 # Spy module: Adds the commands SPYLIST and SPYNAMES that let opers
1361 # see who is in a +s channel, and list +s channels, show keys of keyed
1362 # channels the oper is not a member of etc. (standard 'abusive' features
1363 # of many other ircds, modulized here in InspIRCd).
1364 #<module name="m_spy.so">
1365
1366 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1367 # SSL channel mode module: Adds support for SSL-only channels (+z).
1368 # does not do anything useful without a working SSL module (see below)
1369 #<module name="m_sslmodes.so">
1370
1371 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1372 # Dummy ssl module: If you have other servers on your network which
1373 # have SSL, but your server does not have ssl enabled, you should load
1374 # this module, which will handle SSL metadata (e.g. the "Is using ssl"
1375 # field in the WHOIS information).
1376 #<module name="m_ssl_dummy.so">
1377
1378 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1379 # GnuTLS ssl module: Adds support for client-server SSL using GnuTLS,
1380 # if enabled. You must copy the source for this module from the directory
1381 # src/modules/extra, or answer 'yes' in ./configure when asked if you
1382 # want to enable this, or it will not load.
1383 #<module name="m_ssl_gnutls.so">
1384 #
1385 #-#-#-#-#-#-#-#-#-#-#-  GNUTLS CONFIGURATION   -#-#-#-#-#-#-#-#-#-#-#-#
1386 #                                                                     #
1387 # m_ssl_gnutls.so is too complex it describe here, see the wiki:      #
1388 # http://www.inspircd.org/wiki/GnuTLS_SSL_Module                      #
1389
1390 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1391 # SSL Info module: Allows users to retrieve information about other
1392 # user's peer SSL certificates and keys. This can be used by client
1393 # scripts to validate users. For this to work, one of m_ssl_gnutls.so
1394 # or m_ssl_openssl.so must be loaded. You must symlink the source for
1395 # this module from the directory src/modules/extra.
1396 #<module name="m_sslinfo.so">
1397
1398 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1399 # OpenSSL ssl module: Adds support for client-server SSL using OpenSSL,
1400 # if enabled. You must copy the source for this module from the directory
1401 # src/modules/extra, or answer 'yes' in ./configure when asked if you
1402 # want to enable this, or it will not load.
1403 #<module name="m_ssl_openssl.so">
1404 #
1405 #-#-#-#-#-#-#-#-#-#-#- OPENSSL CONFIGURATION   -#-#-#-#-#-#-#-#-#-#-#-#
1406 #                                                                     #
1407 # m_ssl_openssl.so is too complex it describe here, see the wiki:     #
1408 # http://www.inspircd.org/wiki/OpenSSL_SSL_Module                     #
1409
1410 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1411 # SSL Cert Oper module: Allows opers to oper up using the key fingerprint
1412 # stored within their SSL certificate and key pair.
1413 # When using this module, one of m_ssl_gnutls.so or m_ssl_openssl.so must
1414 # be loaded. An extra value should be added to enabled opers, which
1415 # is in the following format: fingerprint="<hash>". For more information,
1416 # see the example in the oper blocks.
1417 #<module name="m_ssl_oper_cert.so">
1418
1419 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1420 # Strip colour module: Adds the channel mode +S
1421 #<module name="m_stripcolor.so">
1422
1423 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1424 # SILENCE module: Adds support for /SILENCE
1425 #<module name="m_silence.so">
1426
1427 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1428 # SQLutils module: Provides some utilities to SQL client modules, such
1429 # as mapping queries to users and channels. You must copy the source
1430 # for this module from the directory src/modules/extra/m_sqlutils.cpp
1431 # and src/modules/extra/m_sqlutils.h into /src/modules
1432 # Needed for, and loaded before: SQLauth and SQLoper
1433 #<module name="m_sqlutils.so">
1434
1435 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1436 # SQL authentication module: Allows IRCd connections to be tied into
1437 # a database table (for example a forum). You must copy the source for
1438 # this module from the directory src/modules/extra
1439 # Depends on the SQLutils module being loaded first.
1440 #<module name="m_sqlauth.so">
1441 #
1442 #-#-#-#-#-#-#-#-#-#-#- SQLAUTH CONFIGURATION   -#-#-#-#-#-#-#-#-#-#-#-#
1443 #                                                                     #
1444 # m_sqlauth.so is too complex it describe here, see the wiki:         #
1445 # http://www.inspircd.org/wiki/SQL_Authentication_Module              #
1446
1447 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1448 # SQL logging module: Allows you to log network-wide data for your
1449 # network in a fully normalized set of SQL tables. You must copy the
1450 # source for this module from the directory src/modules/extra
1451 #<module name="m_sqllog.so">
1452 #
1453 #-#-#-#-#-#-#-#-#-#-#-  SQLLOG CONFIGURATION   -#-#-#-#-#-#-#-#-#-#-#-#
1454 #                                                                     #
1455 # dbid       - Database ID to use (see m_sql)                         #
1456 #                                                                     #
1457 # See also: http://www.inspircd.org/wiki/SQL_Logging_Module           #
1458 #                                                                     #
1459 #<sqllog dbid="1">
1460
1461 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1462 # SQL oper module: Allows you to store oper credentials in an SQL table
1463 # You must copy the source for this module from the directory src/modules/extra
1464 # Depends on the SQLutils module being loaded first.
1465 #<module name="m_sqloper.so">
1466 #
1467 #-#-#-#-#-#-#-#-#-#-#- SQLOPER CONFIGURATION   -#-#-#-#-#-#-#-#-#-#-#-#
1468 #                                                                     #
1469 # dbid       - Database ID to use (see m_sql)                         #
1470 #                                                                     #
1471 # See also: http://www.inspircd.org/wiki/SQL_Oper_Storage_Module      #
1472 #                                                                     #
1473 #<sqloper dbid="1">
1474
1475 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1476 # SWHOIS module: Allows you to add arbitary lines to user WHOIS.
1477 #<module name="m_swhois.so">
1478
1479 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1480 # Test command module: Does nothing significant. Read: pointless.
1481 #<module name="m_testcommand.so">
1482
1483 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1484 # Timed bans module: Adds timed bans and the /TBAN command
1485 #<module name="m_timedbans.so">
1486
1487 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1488 # Test line module: Adds the /TLINE command, used to test how many
1489 # users a /GLINE or /ZLINE etc would match.
1490 #<module name="m_tline.so">
1491
1492 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1493 # Uninvite module: Adds the /UNINVITE command which lets users remove
1494 # pending invites from channels without waiting for the user to join.
1495 #<module name="m_uninvite.so">
1496
1497 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1498 # Userip module: Adds the /USERIP command
1499 #<module name="m_userip.so">
1500
1501 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1502 # Vhost module: Adds the VHOST command which allows for adding virtual
1503 # hosts which are accessible using a username and password in the config.
1504 #<module name="m_vhost.so">
1505 #
1506 #-#-#-#-#-#-#-#-#-#-#- VHOST CONFIGURATION   -#-#-#-#-#-#-#-#-#-#-#-#-#
1507 #                                                                     #
1508 # user       - Username for the vhost.                                #
1509 #                                                                     #
1510 # pass       - Password for the vhost.                                #
1511 #                                                                     #
1512 # host       - Vhost to set.                                          #
1513 #
1514 #<vhost user="some_username" pass="some_password" host="some.host">
1515
1516 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1517 # Watch module: Adds the WATCH command, which is used by clients to 
1518 # maintain notify lists.
1519 #<module name="m_watch.so">
1520
1521 #-#-#-#-#-#-#-#-#-#-#-#-#-#-  BAN OPTIONS  -#-#-#-#-#-#-#-#-#-#-#-#-#-#
1522 #                                                                     #
1523 # The ban tags define nick masks, host masks and ip ranges which are  #
1524 # banned from your server. All details in these tags are local to     #
1525 # Your server.                                                        #
1526 #                                                                     #
1527 #                                                                     #
1528 # badip lines ban an ip range (same as a zline)                       #
1529 #                                                                     #
1530 # ipmask       -          The ip range to ban (wildcards possible)    #
1531 #                         CIDR is supported in the IP mask.           #
1532 # reason       -          Reason to display when disconnected         #
1533 #                                                                     #
1534 # badnick lines ban a nick mask (same as a qline)                     #
1535 #                                                                     #
1536 # nick         -          Nick mask to ban (wildcards possible)       #
1537 # reason       -          Reason to display on /NICK                  #
1538 #                                                                     #
1539 # badhost lines ban a user@host mask (same as a kline)                #
1540 #                                                                     #
1541 # host         -          ident@hostname (wildcards possible)         #
1542 #                         If you specify an IP, CIDR is supported.    #
1543 # reason       -          Reason to display on disconnection          #
1544 #                                                                     #
1545 # exception lines define a hostmask that is excempt from [kzg]lines   #
1546 #                                                                     #
1547 # host         -          ident@hostname (wildcards possible)         #
1548 #                         If you specify an IP, CIDR is supported.    #
1549 # reason       -          Reason, shown only in /stats e              #
1550 #                                                                     #
1551
1552 <badip ipmask="69.69.69.69" reason="No porn here thanks.">
1553
1554 <badnick nick="ChanServ" reason="Reserved For Services">
1555 <badnick nick="NickServ" reason="Reserved For Services">
1556 <badnick nick="OperServ" reason="Reserved For Services">
1557 <badnick nick="MemoServ" reason="Reserved For Services">
1558
1559 <badhost host="*@hundredz.n.hundredz.o.1337.kiddies.com" reason="Too many 1337 kiddiots">
1560 <badhost host="*@localhost" reason="No irc from localhost!">
1561 <badhost host="*@172.32.0.0/16" reason="This subnet is bad.">
1562
1563 <exception host="*@ircop.host.com" reason="Opers hostname">
1564
1565 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#- YAWN  -#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1566 #                                                                     #
1567 #   You should already know what to do here :)                        #
1568
1569 <die value="No, i wasnt joking. You should probably edit your config *PROPERLY* and try again.">
1570
1571
1572 #########################################################################
1573 #                                                                       #
1574 #                     - InspIRCd Development Team -                     #
1575 #                        http://www.inspircd.org                        #
1576 #                                                                       #
1577 #########################################################################