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