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