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