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