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