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