]> git.netwichtig.de Git - user/henk/code/inspircd.git/blob - docs/inspircd.conf.example
7cdd3be70351816285ff259faaf490beb82eff41
[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 # to u:line a server (give it extra privilages required for running   #
421 # services, Q, etc) you must include the <uline server> tag as shown  #
422 # in the example below. You can have as many of these as you like.    #
423 #                                                                     #
424 # WARNING: Unlike other ircds, u:lining a server allows ALL users on  #
425 # that server to operoverride modes. This should only be used for     #
426 # services and protected oper servers!                                #
427 #                                                                     #
428 # NOTE: If you have built InspIRCd with IPV6 support, and you want    #
429 # to link to an IPV4 server, you must specify the IP address in the   #
430 # form '::ffff:1.2.3.4' where 1.2.3.4 is the IP address of the target #
431 # server. If you have built InspIRCd for IPV4 (this is the default)   #
432 # you should not prefix your IP addresses in this fashion.            #
433 #                                                                     #
434 #    ____                _   _____ _     _       ____  _ _   _        #
435 #   |  _ \ ___  __ _  __| | |_   _| |__ (_)___  | __ )(_) |_| |       #
436 #   | |_) / _ \/ _` |/ _` |   | | | '_ \| / __| |  _ \| | __| |       #
437 #   |  _ <  __/ (_| | (_| |   | | | | | | \__ \ | |_) | | |_|_|       #
438 #   |_| \_\___|\__,_|\__,_|   |_| |_| |_|_|___/ |____/|_|\__(_)       #
439 #                                                                     #
440 #  If you want to link servers to InspIRCd you must load the          #
441 #  m_spanningtree module! Please see the modules list below for       #
442 #  information on how to load this module! If you do not load this    #
443 #  module, server links will NOT work!                                #
444 #                                                                     #
445
446 <link name="hub.penguin.org"
447         ipaddr="penguin.box.com"
448         port="7000"
449         allowmask="69.58.44.0/24"
450         autoconnect="300"
451         failover="hub.other.net"
452         sendpass="outgoing!password"
453         recvpass="incoming!password">
454
455 <link name="services.antarctic.com"
456         ipaddr="localhost"
457         port="7000"
458         allowmask="127.0.0.0/8"
459         sendpass="penguins"
460         recvpass="polarbears">
461
462 <uline server="services.antarctic.com">
463
464
465 #-#-#-#-#-#-#-#-#-#-  MISCELLANEOUS CONFIGURATION  -#-#-#-#-#-#-#-#-#-#
466 #                                                                     #
467 #   These options let you define the path to your motd and rules      #
468 #   files. These should be absolute paths.                            #
469 #                                                                     #
470
471 <files  motd="/home/cc/inspircd/conf/inspircd.motd"
472         rules="/home/cc/inspircd/conf/inspircd.rules">
473
474 #-#-#-#-#-#-#-#-#-#-#-#-#-#-# DNS SERVER -#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
475 #                                                                     #
476 # Define your DNS server address here. InspIRCd has its own resolver. #
477 # If you do not define this value, the first dns server from your     #
478 # /etc/resolv.conf file is read. If no entries are found in this file #
479 # or the file cannot be opened, the default value '127.0.0.1' is used #
480 # instead. The timeout value is in seconds.                           #
481 #                                                                     #
482 #    ____                _   _____ _     _       ____  _ _   _        #
483 #   |  _ \ ___  __ _  __| | |_   _| |__ (_)___  | __ )(_) |_| |       #
484 #   | |_) / _ \/ _` |/ _` |   | | | '_ \| / __| |  _ \| | __| |       #
485 #   |  _ <  __/ (_| | (_| |   | | | | | | \__ \ | |_) | | |_|_|       #
486 #   |_| \_\___|\__,_|\__,_|   |_| |_| |_|_|___/ |____/|_|\__(_)       #
487 #                                                                     #
488 # When choosing a server, be sure to choose one which will do a       #
489 # RECURSIVE LOOKUP. InspIRCd's resolver does not currently do these   #
490 # recursive lookups itself, to save time and resources. The dns       #
491 # server recommended by the InspIRCd team is bind, available from the #
492 # ISC website. If your DNS server does not do a recursive lookup, you #
493 # will be able to notice this by the fact that none of your users are #
494 # resolving even though the DNS server appears to be up! Most ISP and #
495 # hosting provider DNS servers support recursive lookups.             #
496 #                                                                     #
497 # NOTE: If you have built InspIRCd with IPV6 support, and you want    #
498 # to use an IPV4 nameserver, you must specify the IP address in the   #
499 # form '::ffff:1.2.3.4' where 1.2.3.4 is the IP address of the target #
500 # server. If you have built InspIRCd for IPV4 (this is the default)   #
501 # you should not prefix your IP addresses in this fashion.            #
502 #                                                                     #
503 # IF YOUR RESOLV.CONF CONTAINS ONLY IPV4 ADDRESSES, AND YOU ARE USING #
504 # IPV6, YOU MUST DEFINE THE <DNS SERVER> TAG, AND USE THE ::FFFF      #
505 # PREFIX NOTATION. IF YOU DO NOT, HOSTS WILL *NOT* RESOLVE.           #
506 #                                                                     #
507
508 <dns server="127.0.0.1" timeout="5">
509
510 # An example of using IPV4 nameservers over IPV6
511 #<dns server="::ffff:127.0.0.1" timeout="5">
512
513 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#  PID FILE  -#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
514 #                                                                     #
515 # Define the path to the PID file here. The PID file can be used to   #
516 # rehash the ircd from the shell or to terminate the ircd from the    #
517 # shell using shell scripts, perl scripts etc, and to monitor the     #
518 # ircd's state via cron jobs. This is IMPORTANT and you must define   #
519 # it or the ircd will refuse to start.                                #
520 #                                                                     #
521
522 <pid file="/path/to/inspircd.pid">
523
524 #-#-#-#-#-#-#-#-#-#-#-#-#- BANLIST LIMITS #-#-#-#-#-#-#-#-#-#-#-#-#-#-#
525 #                                                                     #
526 # Use these tags to customise the ban limits on a per channel basis.  #
527 # the tags are read from top to bottom, and any tag found which       #
528 # matches the channels name applies the banlimit to that channel.     #
529 # It is advisable to put an entry with the channel as '*' at the      #
530 # bottom of the list. If none are specified or no maxbans tag is      #
531 # matched, the banlist size defaults to 64 entries.                   #
532 #                                                                     #
533
534 <banlist chan="#morons" limit="128">
535 <banlist chan="*" limit="69">
536
537 #-#-#-#-#-#-#-#-#-#-#-  DISABLED COMMANDS  -#-#-#-#-#-#-#-#-#-#-#-#-#-#
538 #                                                                     #
539 # This tag is optional, and specifies one or more commands which are  #
540 # not available to non-operators. For example you may wish to disable #
541 # NICK and prevent non-opers from changing their nicknames.           #
542 # Note that any disabled commands take effect only after the user has #
543 # 'registered' (e.g. after the initial USER/NICK/PASS on connection)  #
544 # so for example disabling NICK will not cripple your network.        #
545 #                                                                     #
546
547 #<disabled commands="TOPIC MODE">
548
549
550 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-  RTFM LINE  -#-#-#-#-#-#-#-#-#-#-#-#-#-#
551 #                                                                     #
552 #   Just remove this... Its here to make you read ALL of the config   #
553 #   file options ;)                                                   #
554
555 <die value="You should probably edit your config *PROPERLY* and try again.">
556
557
558
559 #-#-#-#-#-#-#-#-#-#-#-#-#-  SERVER OPTIONS   -#-#-#-#-#-#-#-#-#-#-#-#-#
560 #                                                                     #
561 #   Settings to define which features are useable on your server.     #
562 #                                                                     #
563 #  prefixquit    - a prefix for a client's quit message               #
564 #                                                                     #
565 #  loglevel      - specifies what detail of messages to log in the    #
566 #                  log file. You may select from debug, verbose,      #
567 #                  default, sparse and none.                          #
568 #                                                                     #
569 #  allowhalfop   - allows the +h channel mode                         #
570 #                                                                     #
571 #  noservices    - If noservices is true, yes, or 1, then the first   #
572 #                  user into a channel gets founder status. This is   #
573 #                  only useful on networks running the m_chanprotect  #
574 #                  module without services.                           #
575 #                                                                     #
576 #  qaprefixes    - If qaprefixes is true, yes, or 1, then users       #
577 #                  with +q or +a will get the ~ or & prefixes         #
578 #                  used in unreal. This is only useful on networks    #
579 #                  running the m_chanprotect module                   #
580 #                                                                     #
581 #  cyclehosts    - If this is set to true, yes or 1, then when a      #
582 #                  user's hostname changes, they will appear to quit  #
583 #                  and then rejoin with their new host. This prevents #
584 #                  clients from being confused by host changes,       #
585 #                  especially in the case of bots, and it is          #
586 #                  recommended that this option is enabled.           #
587 #                                                                     #
588 #  netbuffersize - size of the buffer used to receive data from       #
589 #                  clients. The ircd may only read() this amount      #
590 #                  of text in one go at any time. (OPTIONAL)          #
591 #                                                                     #
592 #  maxwho        - The maximum number of results returned by a /WHO   #
593 #                  query. This is to prevent /WHO being used as a     #
594 #                  spam vector or means of flooding an ircd. The      #
595 #                  default is 128, it is not recommended to raise it  #
596 #                  above 1024. Values up to 65535 are permitted.      #
597 #                                                                     #
598 #  somaxconn     - The maximum number of sockets that may be waiting  #
599 #                  in the accept queue. This usually allows the ircd  #
600 #                  to soak up more connections in a shorter space of  #
601 #                  time when increased but please be aware there is a #
602 #                  system defined maximum value to this, the same way #
603 #                  there is a system defined maximum number of file   #
604 #                  descriptors. Some systems may only allow this to   #
605 #                  be up to 5 (ugh) while others such as FreeBSD will #
606 #                  default to a much nicer 128.                       #
607 #                                                                     #
608 #  moduledir     - This optional value indicates a runtime change of  #
609 #                  the location where modules are to be found. This   #
610 #                  does not add a supplementary directory. There can  #
611 #                  only be one module path.                           #
612 #                                                                     #
613 #  softlimit     - This optional feature allows a defined softlimit.  #
614 #                  if defined sets a soft maxconnections value, has   #
615 #                  to be less than the ./configure maxclients         #
616 #                                                                     #
617 #  operonlystats - The operonlystats field is optional and specifies  #
618 #                  which stats characters in /STATS may only be       #
619 #                  requested by an IRC operator. Stats characters in  #
620 #                  this field are case sensitive and enforced as      #
621 #                  oper-only independent of if they are in a module   #
622 #                  or the core.                                       #
623 #                                                                     #
624 #  operspywhois  - If this is set then when an IRC operator uses      #
625 #                  /WHOIS on a user they will see all channels, even  #
626 #                  ones if channels are secret (+s), private (+p) or  #
627 #                  if the target user is invisible +i.                #
628 #                                                                     #
629 #  customversion - If you specify this configuration item, and it is  #
630 #                  not set to an empty value, then when a user does   #
631 #                  a /VERSION command on the ircd, this string will   #
632 #                  be displayed as the second portion of the output,  #
633 #                  replacing the system 'uname', compile flags and    #
634 #                  socket engine/dns engine names. You may use this   #
635 #                  to enhance security, or simply for vanity.         #
636 #                                                                     #
637 #  maxtargets    - The maxtargets field is optional, and if not       #
638 #                  defined, defaults to 20. It indicates the maximum  #
639 #                  number of targets which may be given to commands   #
640 #                  such as PRIVMSG, KICK etc.                         #
641 #                                                                     #
642 #  hidesplits    - When set to 'yes', will hide split server names    #
643 #                  from non-opers. Non-opers will see '*.net *.split' #
644 #                  instead of the server names in the quit message,   #
645 #                  identical to the way IRCu displays them.           #
646 #                                                                     #
647 #  hidebans      - When set to 'yes', will hide gline, kline, zline   #
648 #                  and qline quit messages from non-opers. For        #
649 #                  example, user A who is not an oper will just see   #
650 #                  (G-Lined) while user B who is an oper will see the #
651 #                  text (G-Lined: Reason here) instead.               #
652 #                                                                     #
653 #  hidewhois     - When defined with a non-empty value, the given     #
654 #                  text will be used in place of the user's server    #
655 #                  in WHOIS, when a user is WHOISed by a non-oper.    #
656 #                  For example, most nets will want to set this to    #
657 #                  something like '*.netname.net' to conceal the      #
658 #                  actual server the user is on.                      #
659 #                                                                     #
660 #  flatlinks     - When you are using m_spanningtree.so, and this     #
661 #                  value is set to true, yes or 1, /MAP and /LINKS    #
662 #                  will be flattened when shown to a non-oper.        #
663 #                                                                     #
664 #  hideulines    - When you are using m_spanningtree.so, and this     #
665 #                  value is set to true, yes or 1, then U-lined       #
666 #                  servers will be hidden in /LINKS and /MAP. For non #
667 #                  opers. Please be aware that this will also hide    #
668 #                  any leaf servers of a U-lined server, e.g. jupes.  #
669 #                                                                     #
670 #  tempdir       - If defined, indicates a path where modules will be #
671 #                  temporarily copied before loading. If not defined, #
672 #                  defaults to /tmp.                                  #
673 #                                                                     #
674 #  nouserdns     - If set to 'yes', 'true' or '1', no user dns        #
675 #                  lookups will be performed for connecting users.    #
676 #                  this can save a lot of resources on very busy irc  #
677 #                  servers.                                           #
678 #                                                                     #
679 #  syntaxhints   - If set to 'yes', 'true' or '1', when a user does    #
680 #                  not give enough parameters for a command, a syntax #
681 #                  hint will be given (using the RPL_TEXT numeric)    #
682 #                  as well as the standard ERR_NEEDMOREPARAMS.        #
683 #                                                                     #
684
685 <options prefixquit="Quit: "
686          loglevel="default"
687          netbuffersize="10240"
688          maxwho="128"
689          noservices="0"
690          qaprefixes="0"
691          somaxconn="128"
692          softlimit="128"
693          operonlystats="oclgkz"
694          operspywhois="no"
695          customversion=""
696          maxtargets="20"
697          hidesplits="no"
698          hidebans="no"
699          hidewhois=""
700          flatlinks="no"
701          hideulines="no"
702          nouserdns="no"
703          syntaxhints="no"
704          cyclehosts="yes"
705          allowhalfop="yes">
706
707
708
709 #-#-#-#-#-#-#-#-#-#-#-#-#-  MODULE OPTIONS   -#-#-#-#-#-#-#-#-#-#-#-#-#
710 #                                                                     #
711 #  These tags define which modules will be loaded on startup by your  #
712 #  server. Add modules without any paths. When you make your ircd     #
713 #  using the 'make' command, all compiled modules will be moved into  #
714 #  the folder you specified when you ran ./configure. The module tag  #
715 #  automatically looks for modules in this location.                  #
716 #  If you attempt to load a module outside of this location, either   #
717 #  in the config, or via /LOADMODULE, you will receive an error.      #
718 #                                                                     #
719 #  By default, ALL modules are commented out. You must uncomment them #
720 #  or add lines to your config to load modules. Please refer to       #
721 #  http://www.inspircd.org/wiki/Modules_List for a list of modules and#
722 #  each modules link for any additional conf tags they require.       #
723 #                                                                     #
724 #    ____                _   _____ _     _       ____  _ _   _        #
725 #   |  _ \ ___  __ _  __| | |_   _| |__ (_)___  | __ )(_) |_| |       #
726 #   | |_) / _ \/ _` |/ _` |   | | | '_ \| / __| |  _ \| | __| |       #
727 #   |  _ <  __/ (_| | (_| |   | | | | | | \__ \ | |_) | | |_|_|       #
728 #   |_| \_\___|\__,_|\__,_|   |_| |_| |_|_|___/ |____/|_|\__(_)       #
729 #                                                                     #
730 # To link servers to InspIRCd, you MUST load the m_spanningtree       #
731 # module, as shown below. If you DO NOT do this, server links will    #
732 # NOT work at all. ie. The ports will NOT bind, and /connect will not #
733 # work properly. This is by design, to allow for the implementation   #
734 # of other linking protocols in modules in the future.                #
735
736 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
737 # Spanning Tree module - allows linking of servers using the spanning
738 # tree protocol (see the READ THIS BIT section above).
739 #
740 #<module name="m_spanningtree.so">
741
742 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
743 # Alias module: Allows you to define server-side command aliases
744 #<module name="m_alias.so">
745 #
746 #-#-#-#-#-#-#-#-#-#-#-  ALIAS DEFINITIONS  -#-#-#-#-#-#-#-#-#-#-#-#-#-#
747 #                                                                     #
748 # If you have the m_alias.so module loaded, you may also define       #
749 # aliases as shown below. They are commonly used to provide shortcut  #
750 # commands to services, however they are not limited to just this use.#
751 # An alias tag requires the following values to be defined in it:     #
752 #                                                                     #
753 # text        -      The text to detect at the start of the line,     #
754 #                    must be at the start of the line to trigger the  #
755 #                    alias. Cant contain spaces, but case insensitive #
756 # replace     -      The text to replace 'text' with. Usually this    #
757 #                    will be "PRIVMSG ServiceName :$2-" or similar.   #
758 #                    You may use the variables $1 through $9 in the   #
759 #                    replace string, which refer to the first through #
760 #                    ninth word in the original string typed by the   #
761 #                    user. You may also use $1- through $9- which     #
762 #                    refer to the first word onwards, through to the  #
763 #                    ninth word onwards, e.g. if the user types the   #
764 #                    command "foo bar baz qux quz" then $3- will hold #
765 #                    "baz qux quz" and $2 will contain "bar". You may #
766 #                    also use the special variables: $nick, $ident,   #
767 #                    $host and $vhost, and you may seperate multiple  #
768 #                    commands with \n. If you wish to use the ACTUAL  #
769 #                    characters \ and n together in a line, you must  #
770 #                    use the sequence "\\n".                          #
771 # requires    -      If you provide a value for 'requires' this means #
772 #                    the given nickname MUST be online for the alias  #
773 #                    to successfully trigger. If they are not, then   #
774 #                    the user receives a 'no such nick' 401 numeric.  #
775 # uline       -      Defining this value with 'yes', 'true' or '1'    #
776 #                    will ensure that the user given in 'requires'    #
777 #                    must also be on a u-lined server, as well as     #
778 #                    actually being on the network. If the user is    #
779 #                    online, but not on a u-lined server, then an     #
780 #                    oper-alert is sent out as this is possibly signs #
781 #                    of a user trying to impersonate a service.       #
782 # operonly    -      Defining this value, with a value of 'yes', '1'  #
783 #                    or true will make the alias oper only. If a non- #
784 #                    oper attempts to use the alias, it will appear   #
785 #                    to not exist.                                    #
786 #                                                                     #
787 #<alias text="NICKSERV" replace="PRIVMSG NickServ :$2-" requires="NickServ" uline="yes">
788 #<alias text="CHANSERV" replace="PRIVMSG ChanServ :$2-" requires="ChanServ" uline="yes">
789 #<alias text="OPERSERV" replace="PRIVMSG OperServ :$2-" requires="OperServ" uline="yes" operonly="yes">
790 #<alias text="NS" replace="PRIVMSG NickServ :$2-" requires="NickServ" uline="yes">
791 #<alias text="CS" replace="PRIVMSG ChanServ :$2-" requires="ChanServ" uline="yes">
792 #<alias text="OS" replace="PRIVMSG OperServ :$2-" requires="OperServ" uline="yes" operonly="yes">
793 #<alias text="ID" replace="PRIVMSG NickServ :IDENTIFY $3" requires="NickServ" uline="yes">
794
795 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
796 # Antibear security module: Prevents 'bear.txt' based trojans from
797 # connecting to your network by sending them a numeric they can't handle.
798 #<module name="m_antibear.so">
799
800 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
801 # Antibottler module: Labels bottler leech bots
802 #<module name="m_antibottler.so">
803
804 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
805 # Ban except module: Adds support for channel ban exceptions (+e)
806 #<module name="m_banexception.so">
807
808 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
809 # Block amsg module: Attempt to block all usage of /amsg and /ame
810 #<module name="m_blockamsg.so">
811 #
812 #-#-#-#-#-#-#-#-#-#-#-  BLOCKAMSG CONFIGURATION  -#-#-#-#-#-#-#-#-#-#-#
813 #                                                                     #
814 # If you have the m_blockamsg.so module loaded, you can configure it  #
815 # with the <blockamsg> tag:                                           #
816 #                                                                     #
817 # delay          -   How many seconds between two messages to force   #
818 #                    them to be recognised as unrelated.              #
819 # action         -   Any of 'notice', 'noticeopers', 'silent', 'kill' #
820 #                    or 'killopers'. Define how to take action when   #
821 #                    a user uses /amsg or /ame.                       #
822 #
823 #<blockamsg delay="3" action="killopers">
824
825 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
826 # Block CAPS module: Blocking all-CAPS messages with cmode +P
827 #<module name="m_blockcaps.so">
828
829 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
830 # Block colour module: Blocking colour-coded messages with cmode +c
831 #<module name="m_blockcolor.so">
832
833 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
834 # Botmode module: Adds the user mode +B
835 #<module name="m_botmode.so">
836
837 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
838 # CBAN module: Lets you disallow channels from being used at runtime.
839 #<module name="m_cban.so">
840
841 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
842 # Censor module: Adds the channel mode +G
843 #<module name="m_censor.so">
844 #
845 #-#-#-#-#-#-#-#-#-#-#-  CENSOR  CONFIGURATION  -#-#-#-#-#-#-#-#-#-#-#-#
846 #                                                                     #
847 # Optional - If you specify to use the m_censor module, then specfiy  #
848 # below the path to the censor.conf file. See also:                   #
849 # Censor file, see http://www.inspircd.org/wiki/Censor_Module         #
850 #
851 #<censor file="/path/to/censor.conf">
852
853 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
854 # Channel filter module: Allows channel-op defined message
855 # filtering using simple string matches (channel mode +g)
856 #<module name="m_chanfilter.so">
857
858 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
859 # Chanprotect module: gives +q and +a channel modes
860 #<module name="m_chanprotect.so">
861
862 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
863 # CHGHOST module: Adds the /CHGHOST command
864 #<module name="m_chghost.so">
865
866 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
867 # CHGIDENT module: Adds the /CHGIDENT command
868 #<module name="m_chgident.so">
869
870 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
871 # Cloaking module: Adds usermode +x and cloaking support
872 #<module name="m_cloaking.so">
873 #
874 #-#-#-#-#-#-#-#-#-#-#- CLOAKING  CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#
875 #                                                                     #
876 # Optional - If ypu specify the m_cloaking.so module as above, you    #
877 # must define cloak keys, and optionally a cloak prefix as shown      #
878 # below. When using cloaking, the cloak keys are MANDITORY and must   #
879 # be included. However, if prefix is not included, it will default    #
880 # to your networks name from the <server> tag.                        #
881 #                                                                     #
882 # <cloak key1="543241423"                                             #
883 #        key2="5378410432"                                            #
884 #        key3="1143242382"                                            #
885 #        key4="9504324581"                                            #
886 #        prefix="mynet">                                              #
887 #                                                                     #
888 # Please note that the key values will accept any number, and should  #
889 # be large numbers. Using small numbers such as "7" or "1924" will    #
890 # seriously weaken the security of your cloak.                        #
891
892 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
893 # Conn-Lusers: Shows the LUSERS output on connect
894 #<module name="m_conn_lusers.so">
895
896 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
897 # Conn-Usermodes: Set modes on users when they connect
898 # When this module is loaded <connect:allow> tags may have an optional
899 # modes="" value, which contains modes to add or remove from users
900 # when they connect to the server.
901 #<module name="m_conn_umodes.so">
902
903 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
904 # Conn-Wait-for-Pong: Don't let a user connect until they PONG
905 #<module name="m_conn_waitpong.so">
906 #
907 #-#-#-#-#-#-#-#-#-#-#-   WAITPONG CONFIGURATION  -#-#-#-#-#-#-#-#-#-#-#
908 #                                                                     #
909 # If you have the m_conn_waitpong.so module loaded, configure it with #
910 # the <waitpong> tag:                                                 #
911 #                                                                     #
912 # sendsnotice    -   Whether to send a snotice on connect, like other #
913 #                    older ircds                                      #
914 #                                                                     #
915 # killonbadreply -   Whether to kill the user if they send the wrong  #
916 #                    PONG reply.                                      #
917 #                                                                     #
918 #<waitpong sendsnotice="yes" killonbadreply="yes">
919
920 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
921 # Connection throttle module. Configuration:
922 #<module name="m_connflood.so">
923 #
924 #-#-#-#-#-#-#-#-#-#-#- CONTHROTTLE CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
925 #  seconds, maxconns -  Amount of connections per <seconds>.
926 #
927 #  timeout           -  Time to wait after the throttle was activated
928 #                       before deactivating it. Be aware that the time
929 #                       is seconds + timeout.
930 #
931 #  quitmsg           -  The message that users get if they attempt to
932 #                       connect while the throttle is active.
933 #
934 #  bootwait          -  Amount of time to wait before enforcing the
935 #                       throttling when the server just booted.
936 #
937 #<connflood seconds="30" maxconns="3" timeout="30"
938 #   quitmsg="Throttled" bootwait="10">
939
940 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
941 # Deny Channels: Deny Channels from being used by users
942 #<module name="m_denychans.so"> 
943 #
944 #-#-#-#-#-#-#-#-#-#-#-   DENYCHAN DEFINITIONS  -#-#-#-#-#-#-#-#-#-#-#-#
945 #                                                                     #
946 # If you have the m_denychans.so module loaded, you need to specify   #
947 # the channels to deny:                                               #
948 #                                                                     #
949 # name        -      The channel name to deny.                        #
950 #                                                                     #
951 # allowopers  -      If operators are allowed to override the deny.   #
952 #                                                                     #
953 # reason      -      Reason given for the deny.                       #
954 #                                                                     #
955 #<badchan name="#gods" allowopers="yes" reason="Tortoises!">
956
957 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
958 # Devoice Module: Let users devoice themselves.
959 #<module name="m_devoice.so">
960
961 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
962 # Filter module: Provides glob-based message filtering
963 #<module name="m_filter.so">
964 #OR
965 # PCRE filter module: Filters messages using regular expressions
966 #<module name="m_filter_pcre.so">
967 #
968 #-#-#-#-#-#-#-#-#-#-#-  FILTER  CONFIGURATION  -#-#-#-#-#-#-#-#-#-#-#-#
969 #                                                                     #
970 # Optional - If you specify to use the m_filter or m_filter_pcre      #
971 # modules, then specfiy below the path to the filter.conf file.       #
972 #                                                                     #
973 #<filter file="/path/to/inspircd/filter.conf">
974
975 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
976 # Foobar module: does nothing - historical relic
977 #<module name="m_foobar.so">
978
979 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
980 # Globops module: gives /GLOBOPS and usermode +g
981 #<module name="m_globops.so">
982
983 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
984 # Global load module: Allows loading and unloading of modules network-
985 # wide (USE WITH EXTREME CAUTION!)
986 #<module name="m_globalload.so">
987
988 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
989 # HELPOP module: Provides the /HELPOP command
990 #<module name="m_helpop.so">
991 #
992 #-#-#-#-#-#-#-#-#-#-#-#-  HELPOP  CONFIGURATION  -#-#-#-#-#-#-#-#-#-#-#
993 #                                                                     #
994 # Optional - If you specify to use the m_helpop.so module, then       #
995 # specify below the path to the helpop.conf file.                     #
996 #                                                                     #
997 #<helpop file="/path/to/inspircd/helpop.conf">
998
999 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1000 # Hostchange module: Allows a different style of cloaking
1001 #<module name="m_hostchange.so">
1002 #
1003 #-#-#-#-#-#-#-#-#-#-#-  HOSTCHANGE  CONFIGURATION  -#-#-#-#-#-#-#-#-#-#
1004 #                                                                     #
1005 # Optional - If you choose to use the m_hostchange.so module.         #
1006 # Config Help -  See http://www.inspircd.org/wiki/Host_Changer_Module #
1007 #                                                                     #
1008 #<host suffix="polarbears.org">
1009 #<hostchange mask="*@fbi.gov" action="addnick">
1010 #<hostchange mask="*r00t@*" action="suffix">
1011 #<hostchange mask="a@b.com" action="set" value="blah.blah.blah">
1012
1013 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1014 # httpd module: Provides http server support for InspIRCd
1015 #<module name="m_httpd.so">
1016 #
1017 #-#-#-#-#-#-#-#-#-#-#-#-  HTTPD   CONFIGURATION  -#-#-#-#-#-#-#-#-#-#-#
1018 #
1019 # Optional - If you choose to use the m_httpd.so module,  then you must
1020 # specify the port number and other details of your http server:
1021 #
1022 #<http ip="192.168.1.10" host="brainwave" port="32006"
1023 #      index="/home/brain/inspircd/http/index.html">
1024 #
1025 # You may have as many of these tags as you wish, each with a different
1026 # IP, port, host or index file. Each one will act as an independent
1027 # HTTP server.
1028 #
1029
1030 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1031 # http stats module: Provides basic stats pages over HTTP
1032 # Requires m_httpd.so to be loaded for it to function.
1033 #<module name="m_http_stats.so">
1034 #
1035 #-#-#-#-#-#-#-#-#-#-#-#- HTTPD STATS CONFIGURATION -#-#-#-#-#-#-#-#-#-#
1036 #
1037 #<httpstats stylesheet="http://remote.style/sheet.css">
1038 #
1039
1040 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1041 # Ident: Provides RFC 1413 ident lookup support
1042 #<module name="m_ident.so">
1043 #
1044 #-#-#-#-#-#-#-#-#-#-#-#-   IDENT CONFIGURATION   -#-#-#-#-#-#-#-#-#-#-#
1045 #                                                                     #
1046 # Optional - If you are using the m_ident.so module, then you can     #
1047 # specify the timeout for ident lookups here. If not defined, it will #
1048 # default to one second. This is a non-blocking timeout which holds   #
1049 # the user in a 'connecting' state until the lookup is complete.      #
1050 #                                                                     #
1051 #<ident timeout="5">
1052
1053 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1054 # Invite except module: Adds support for channel invite exceptions (+I)
1055 #<module name="m_inviteexception.so">
1056
1057 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1058 # Join flood module: Adds support for join flood protection (+j)
1059 #<module name="m_joinflood.so">
1060
1061 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1062 # Anti-Auto-Rejoin: Adds support for prevention of auto-rejoin (+J)
1063 #<module name="m_kicknorejoin.so">
1064
1065 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1066 # Knock module: adds the /KNOCK command and +K channel mode
1067 #<module name="m_knock.so">
1068
1069 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1070 # Msg flood module: Adds message/notice flood protection (+f)
1071 #<module name="m_messageflood.so">
1072
1073 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1074 # MySQL module: Allows other SQL modules to access MySQL databases
1075 # through a unified API. You must copy the source for this module
1076 # from the directory src/modules/extra, plus the file m_sqlv2.h
1077 #<module name="m_mysql.so">
1078 #
1079 #-#-#-#-#-#-#-#-#-#-#-#- SQL CONFIGURATION   -#-#-#-#-#-#-#-#-#-#-#-#-#
1080 #                                                                     #
1081 # m_mysql.so is more complex than described here, see the wiki for    #
1082 # more: http://www.inspircd.org/wiki/SQL_Service_Provider_Module      #
1083 #
1084 #<database name="mydb" username="myuser" password="mypass" hostname="localhost" id="my_database2">
1085
1086 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1087 # NAMESX module: Provides support for the NAMESX extension which allows
1088 # clients to see all the prefixes set on a user without getting confused.
1089 # This is supported by mIRC, x-chat, klient, and maybe more.
1090 #<module name="m_namesx.so">
1091
1092 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1093 # Nicklock module: Let opers change a user's nick and then stop that
1094 # user from changing their nick again.
1095 #<module name="m_nicklock.so">
1096
1097 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1098 # No ctcp module: Adds the channel mode +C to block CTCPs
1099 #<module name="m_noctcp.so">
1100
1101 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1102 # Noinvite module: Gives channel mode +V
1103 #<module name="m_noinvite.so">
1104
1105 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1106 # No kicks module: Adds the +Q channel mode
1107 #<module name="m_nokicks.so">
1108
1109 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1110 # No nicks module: Adds the +N channel mode
1111 #<module name="m_nonicks.so">
1112
1113 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1114 # No Notice module: adds the channel mode +T
1115 #<module name="m_nonotice.so">
1116
1117 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1118 # Oper channels mode: Adds the +O channel mode
1119 #<module name="m_operchans.so">
1120
1121 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1122 # Oper Join module: Forces opers to join a channel on oper-up
1123 #<module name="m_operjoin.so">
1124 #
1125 #-#-#-#-#-#-#-#-#-#-#   OPERJOIN CONFIGURATION   -#-#-#-#-#-#-#-#-#-#-#
1126 #                                                                     #
1127 # If you are using the m_operjoin.so module, specify the channel here #
1128 #                                                                     #
1129 #<operjoin channel="#channel">
1130
1131 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1132 # Oper MOTD module: Provides support for seperate message of the day
1133 # on oper-up
1134 #<module name="m_opermotd.so">
1135 #
1136 #-#-#-#-#-#-#-#-#-#-#   OPERMOTD CONFIGURATION   -#-#-#-#-#-#-#-#-#-#-#
1137 #                                                                     #
1138 # If you are using the m_opermotd.so module, specify the motd here    #
1139 #                                                                     #
1140 #<opermotd file="/path/to/oper.motd">
1141
1142 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1143 # Override module: Adds support for oper override
1144 #<module name="m_override.so">
1145 #
1146 #-#-#-#-#-#-#-#-#-#-#   OVERRIDE CONFIGURATION   -#-#-#-#-#-#-#-#-#-#-#
1147 #                                                                     #
1148 # m_override.so is too complex it describe here, see the wiki:        #
1149 # http://www.inspircd.org/wiki/Oper_Override_Module                   #
1150
1151 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1152 # Oper levels module: Gives each oper a level and prevents
1153 # actions being taken against higher level opers
1154 # Specify the level as the 'level' parameter of the <type> tag
1155 #<module name="m_operlevels.so">
1156
1157 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1158 # Oper MD5 module: Allows MD5 hashed oper passwords
1159 #<module name="m_opermd5.so">
1160
1161 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1162 # Oper SHA256 module: Allows SHA256 hashed oper passwords
1163 # This module is in src/modules/extra
1164 #<module name="m_opersha256.so">
1165
1166 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1167 # Oper modes module: Allows you to specify modes to add/remove on oper
1168 # Specify the modes as the 'modes' parameter of the <type> tag
1169 #<module name="m_opermodes.so">
1170
1171 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1172 # PostgreSQL module: Allows other SQL modules to access PgSQL databases
1173 # through a unified API. You must copy the source for this module
1174 # from the directory src/modules/extra, plus the file m_sqlv2.h
1175 #<module name="m_pgsql.so">
1176 #
1177 #-#-#-#-#-#-#-#-#-#-#-#- SQL CONFIGURATION   -#-#-#-#-#-#-#-#-#-#-#-#-#
1178 #                                                                     #
1179 # m_pgsql.so is more complex than described here, see the wiki for    #
1180 # more: http://www.inspircd.org/wiki/SQL_Service_Provider_Module      #
1181 #
1182 #<database name="mydb" username="myuser" password="mypass" hostname="localhost" id="my_database" ssl="no">
1183
1184 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1185 # Random Quote module: provides a random quote on connect.
1186 # NOTE: Some of these may mimic fatal errors and confuse users and 
1187 # opers alike! - BEWARE!
1188 #<module name="m_randquote.so">
1189 #
1190 #-#-#-#-#-#-#-#-#-#-  RANDOMQUOTES CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
1191 #                                                                     #
1192 # Optional - If you specify to use the m_randquote.so module, then    #
1193 # specify below the path to the randquotes.conf file.                 #
1194 #                                                                     #
1195 #<randquote file="/path/to/inspircd/randquotes.conf">
1196
1197 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1198 # Redirect module: Adds channel redirection (mode +L)
1199 #<module name="m_redirect.so">
1200
1201 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1202 # Remove module: Adds the /REMOVE command which is a peaceful
1203 # alternative to /KICK
1204 #<module name="m_remove.so">
1205
1206 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1207 # Restricted channels module: Allows only opers to create channels
1208 #<module name="m_restrictchans.so">
1209
1210 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1211 # Restrict message module: Allows users to only message opers
1212 #<module name="m_restrictmsg.so">
1213
1214 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1215 # Provide /LIST throttling (to prevent flooding) and /LIST safety to
1216 # prevent excess flood when the list is large.
1217 #<module name="m_safelist.so">
1218
1219 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1220 # SAJOIN module: Adds the /SAJOIN command
1221 #<module name="m_sajoin.so">
1222
1223 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1224 # SAMODE module: Adds the oper /SAMODE command
1225 #<module name="m_samode.so">
1226
1227 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1228 # SANICK module: Allows opers to change user's nicks
1229 #<module name="m_sanick.so">
1230
1231 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1232 # SAPART module: Adds the oper /SAPART command
1233 #<module name="m_sapart.so">
1234
1235 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1236 # SAQUIT module: Adds the oper /SAQUIT command (abusable!!!)
1237 #<module name="m_saquit.so">
1238
1239 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-
1240 # Secure list module: Prevent /LIST in the first minute of connection,
1241 # crippling most spambots and trojan spreader bots.
1242 #<module name="m_securelist.so">
1243
1244 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1245 # Set Idle module: Adds a command for opers to change their
1246 # idle time (mainly a toy)
1247 #<module name="m_setidle.so">
1248
1249 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1250 # Services support module: Adds several usermodes such as +R and +M
1251 # this module implements the 'identified' state via user mode +r, which
1252 # is similar to the DALnet and dreamforge systems.
1253 #<module name="m_services.so">
1254
1255 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1256 # Services support module: Adds several usermodes such as +R and +M
1257 # this module implements the 'identified' state via account names (AC)
1258 # and is similar in operation to the way asuka and ircu handle services.
1259 # it cannot be used at the same time as m_services, above.
1260 #<module name="m_services_account.so">
1261
1262 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1263 # Sethost module: Adds the /SETHOST command
1264 #<module name="m_sethost.so">
1265
1266 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1267 # Setident module: Adds the /SETIDENT command
1268 #<module name="m_setident.so">
1269
1270 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1271 # SETNAME module: Adds the /SETNAME command
1272 #<module name="m_setname.so">
1273
1274 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1275 # Show Whois module: Adds the +W usermode which allows opers
1276 # to see when they are whois'ed (can be annoying).
1277 #<module name="m_showwhois.so">
1278
1279 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1280 # Spy module: Adds the commands SPYLIST and SPYNAMES that let opers
1281 # see who is in a +s channel, and list +s channels, show keys of keyed
1282 # channels the oper is not a member of etc. (standard 'abusive' features
1283 # of many other ircds, modulized here in InspIRCd).
1284 #<module name="m_spy.so">
1285
1286 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1287 # SSL channel mode module: Adds support for SSL-only channels (+z).
1288 # does not do anything useful without a working SSL module (see below)
1289 #<module name="m_sslmodes.so">
1290
1291 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1292 # Dummy ssl module: If you have other servers on your network which
1293 # have SSL, but your server does not have ssl enabled, you should load
1294 # this module, which will handle SSL metadata (e.g. the "Is using ssl"
1295 # field in the WHOIS information).
1296 #<module name="m_ssl_dummy.so">
1297
1298 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1299 # GnuTLS ssl module: Adds support for client-server SSL using GnuTLS,
1300 # if enabled. You must copy the source for this module from the directory
1301 # src/modules/extra, or answer 'yes' in ./configure when asked if you
1302 # want to enable this, or it will not load.
1303 #<module name="m_ssl_gnutls.so">
1304 #
1305 #-#-#-#-#-#-#-#-#-#-#-  GNUTLS CONFIGURATION   -#-#-#-#-#-#-#-#-#-#-#-#
1306 #                                                                     #
1307 # m_ssl_gnutls.so is too complex it describe here, see the wiki:      #
1308 # http://www.inspircd.org/wiki/GnuTLS_SSL_Module                      #
1309
1310 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1311 # SSL Info module: Allows users to retrieve information about other
1312 # user's peer SSL certificates and keys. This can be used by client
1313 # scripts to validate users. For this to work, one of m_ssl_gnutls.so
1314 # or m_ssl_openssl.so must be loaded. You must symlink the source for
1315 # this module from the directory src/modules/extra.
1316 #<module name="m_sslinfo.so">
1317
1318 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1319 # OpenSSL ssl module: Adds support for client-server SSL using OpenSSL,
1320 # if enabled. You must copy the source for this module from the directory
1321 # src/modules/extra, or answer 'yes' in ./configure when asked if you
1322 # want to enable this, or it will not load.
1323 #<module name="m_ssl_openssl.so">
1324 #
1325 #-#-#-#-#-#-#-#-#-#-#- OPENSSL CONFIGURATION   -#-#-#-#-#-#-#-#-#-#-#-#
1326 #                                                                     #
1327 # m_ssl_openssl.so is too complex it describe here, see the wiki:     #
1328 # http://www.inspircd.org/wiki/OpenSSL_SSL_Module                     #
1329
1330 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1331 # SSL Cert Oper module: Allows opers to oper up using the key fingerprint
1332 # stored within their SSL certificate and key pair.
1333 # When using this module, one of m_ssl_gnutls.so or m_ssl_openssl.so must
1334 # be loaded. An extra value should be added to enabled opers, which
1335 # is in the following format: fingerprint="<hash>". For more information,
1336 # see the example in the oper blocks.
1337 #<module name="m_ssl_oper_cert.so">
1338
1339 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1340 # Strip colour module: Adds the channel mode +S
1341 #<module name="m_stripcolor.so">
1342
1343 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1344 # SILENCE module: Adds support for /SILENCE
1345 #<module name="m_silence.so">
1346
1347 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1348 # SQL authentication module: Allows IRCd connections to be tied into
1349 # a database table (for example a forum). You must copy the source for
1350 # this module from the directory src/modules/extra
1351 #<module name="m_sqlauth.so">
1352 #
1353 #-#-#-#-#-#-#-#-#-#-#- SQLAUTH CONFIGURATION   -#-#-#-#-#-#-#-#-#-#-#-#
1354 #                                                                     #
1355 # m_sqlauth.so is too complex it describe here, see the wiki:         #
1356 # http://www.inspircd.org/wiki/SQL_Authentication_Module              #
1357
1358 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1359 # SQL logging module: Allows you to log network-wide data for your
1360 # network in a fully normalized set of SQL tables. You must copy the
1361 # source for this module from the directory src/modules/extra
1362 #<module name="m_sqllog.so">
1363 #
1364 #-#-#-#-#-#-#-#-#-#-#-  SQLLOG CONFIGURATION   -#-#-#-#-#-#-#-#-#-#-#-#
1365 #                                                                     #
1366 # dbid       - Database ID to use (see m_sql)                         #
1367 #                                                                     #
1368 # See also: http://www.inspircd.org/wiki/SQL_Logging_Module           #
1369 #                                                                     #
1370 #<sqllog dbid="1">
1371
1372 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1373 # SQL oper module: Allows you to store oper credentials in an SQL table
1374 # You must copy the source for this module from the directory src/modules/extra
1375 #<module name="m_sqloper.so">
1376 #
1377 #-#-#-#-#-#-#-#-#-#-#- SQLOPER CONFIGURATION   -#-#-#-#-#-#-#-#-#-#-#-#
1378 #                                                                     #
1379 # dbid       - Database ID to use (see m_sql)                         #
1380 #                                                                     #
1381 # See also: http://www.inspircd.org/wiki/SQL_Oper_Storage_Module      #
1382 #                                                                     #
1383 #<sqloper dbid="1">
1384
1385 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1386 # SWHOIS module: Allows you to add arbitary lines to user WHOIS.
1387 #<module name="m_swhois.so">
1388
1389 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1390 # Test command module: Does nothing significant. Read: pointless.
1391 #<module name="m_testcommand.so">
1392
1393 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1394 # Timed bans module: Adds timed bans and the /TBAN command
1395 #<module name="m_timedbans.so">
1396
1397 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1398 # Test line module: Adds the /TLINE command, used to test how many
1399 # users a /GLINE or /ZLINE etc would match.
1400 #<module name="m_tline.so">
1401
1402 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1403 # Uninvite module: Adds the /UNINVITE command which lets users remove
1404 # pending invites from channels without waiting for the user to join.
1405 #<module name="m_uninvite.so">
1406
1407 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1408 # Userip module: Adds the /USERIP command
1409 #<module name="m_userip.so">
1410
1411 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1412 # Vhost module: Adds the VHOST command which allows for adding virtual
1413 # hosts which are accessible using a username and password in the config.
1414 #<module name="m_vhost.so">
1415 #
1416 #-#-#-#-#-#-#-#-#-#-#- VHOST CONFIGURATION   -#-#-#-#-#-#-#-#-#-#-#-#-#
1417 #                                                                     #
1418 # user       - Username for the vhost.                                #
1419 #                                                                     #
1420 # pass       - Password for the vhost.                                #
1421 #                                                                     #
1422 # host       - Vhost to set.                                          #
1423 #
1424 #<vhost user="some_username" pass="some_password" host="some.host">
1425
1426 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1427 # Watch module: Adds the WATCH command, which is used by clients to 
1428 # maintain notify lists.
1429 #<module name="m_watch.so">
1430
1431 #-#-#-#-#-#-#-#-#-#-#-#-#-#-  BAN OPTIONS  -#-#-#-#-#-#-#-#-#-#-#-#-#-#
1432 #                                                                     #
1433 # The ban tags define nick masks, host masks and ip ranges which are  #
1434 # banned from your server. All details in these tags are local to     #
1435 # Your server.                                                        #
1436 #                                                                     #
1437 #                                                                     #
1438 # badip lines ban an ip range (same as a zline)                       #
1439 #                                                                     #
1440 # ipmask       -          The ip range to ban (wildcards possible)    #
1441 #                         CIDR is supported in the IP mask.           #
1442 # reason       -          Reason to display when disconnected         #
1443 #                                                                     #
1444 # badnick lines ban a nick mask (same as a qline)                     #
1445 #                                                                     #
1446 # nick         -          Nick mask to ban (wildcards possible)       #
1447 # reason       -          Reason to display on /NICK                  #
1448 #                                                                     #
1449 # badhost lines ban a user@host mask (same as a kline)                #
1450 #                                                                     #
1451 # host         -          ident@hostname (wildcards possible)         #
1452 #                         If you specify an IP, CIDR is supported.    #
1453 # reason       -          Reason to display on disconnection          #
1454 #                                                                     #
1455 # exception lines define a hostmask that is excempt from [kzg]lines   #
1456 #                                                                     #
1457 # host         -          ident@hostname (wildcards possible)         #
1458 #                         If you specify an IP, CIDR is supported.    #
1459 # reason       -          Reason, shown only in /stats e              #
1460 #                                                                     #
1461
1462 <badip ipmask="69.69.69.69" reason="No porn here thanks.">
1463
1464 <badnick nick="ChanServ" reason="Reserved For Services">
1465 <badnick nick="NickServ" reason="Reserved For Services">
1466 <badnick nick="OperServ" reason="Reserved For Services">
1467 <badnick nick="MemoServ" reason="Reserved For Services">
1468
1469 <badhost host="*@hundredz.n.hundredz.o.1337.kiddies.com" reason="Too many 1337 kiddiots">
1470 <badhost host="*@localhost" reason="No irc from localhost!">
1471 <badhost host="*@172.32.0.0/16" reason="This subnet is bad.">
1472
1473 <exception host="*@ircop.host.com" reason="Opers hostname">
1474
1475 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#- YAWN  -#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1476 #                                                                     #
1477 #   You should already know what to do here :)                        #
1478
1479 <die value="No, i wasnt joking. You should probably edit your config *PROPERLY* and try again.">
1480
1481
1482 #########################################################################
1483 #                                                                       #
1484 #                     - InspIRCd Development Team -                     #
1485 #                        http://www.inspircd.org                        #
1486 #                                                                       #
1487 #########################################################################