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