]> git.netwichtig.de Git - user/henk/code/inspircd.git/blob - docs/inspircd.conf.example
Rename to m_connectban
[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 #  serverpingfreq- This value, when set, allows you to change the     #
833 #                  frequency of server to server PING messages. This  #
834 #                  can help if you are having certain network issues. #
835 #                                                                     #
836 #  pingwarning   - This should be set to a number between 1 and 59 if #
837 #                  defined, and if it is defined will cause the server#
838 #                  to send out a warning via snomask +l if a server   #
839 #                  does not answer to PING after this many seconds.   #
840 #                  This can be useful for finding servers which are   #
841 #                  at risk of pinging out due to network issues.      #
842 #                                                                     #
843 #  exemptchanops - This option allows channel operators to be exempted#
844 #                  from certain channel modes.                        #
845 #                  Supported modes are +SfFgNc. Defaults to off.      #
846 #                                                                     #
847 #  defaultmodes  - The default modes to be given to each channel on   #
848 #                  creation. Defaults to 'nt'. There should be no +   #
849 #                  or - symbols in this sequence, if you add them     #
850 #                  they will be ignored. You may add parameters for   #
851 #                  modes which take them.                             #
852 #                                                                     #
853 #  moronbanner   - The NOTICE to show to users who are glined, zlined #
854 #                  klined or qlined when they are disconnected. This  #
855 #                  is totally freeform, you may place any text here   #
856 #                  you wish.                                          #
857 #                                                                     #
858
859 <options prefixquit="Quit: "
860          suffixquit=""
861          prefixpart="\""
862          suffixpart="\""
863          noservices="no"
864          qprefix="~"
865          aprefix="&"
866          deprotectself="no"
867          deprotectothers="no"
868          syntaxhints="no"
869          cyclehosts="yes"
870          ircumsgprefix="no"
871          announcets="yes"
872          hostintopic="yes"
873          pingwarning="15"
874          serverpingfreq="60"
875          allowhalfop="yes"
876          defaultmodes="nt"
877          moronbanner="You're banned! Email haha@abuse.com with the ERROR line below for help."
878          exemptchanops="">
879
880
881 #-#-#-#-#-#-#-#-#-#-#-# PERFORMANCE CONFIGURATION #-#-#-#-#-#-#-#-#-#-#
882 #                                                                     #
883 #  maxwho        - The maximum number of results returned by a /WHO   #
884 #                  query. This is to prevent /WHO being used as a     #
885 #                  spam vector or means of flooding an ircd. The      #
886 #                  default is 128, it is not recommended to raise it  #
887 #                  above 1024. Values up to 65535 are permitted. If   #
888 #                  this value is omitted, any size WHO is allowed by  #
889 #                  anyone.                                            #
890 #                                                                     #
891 #  somaxconn     - The maximum number of sockets that may be waiting  #
892 #                  in the accept queue. This usually allows the ircd  #
893 #                  to soak up more connections in a shorter space of  #
894 #                  time when increased but please be aware there is a #
895 #                  system defined maximum value to this, the same way #
896 #                  there is a system defined maximum number of file   #
897 #                  descriptors. Some systems may only allow this to   #
898 #                  be up to 5 (ugh) while others such as FreeBSD will #
899 #                  default to a much nicer 128.                       #
900 #                                                                     #
901 #  softlimit     - This optional feature allows a defined softlimit.  #
902 #                  if defined sets a soft maxconnections value, has   #
903 #                  to be less than the ./configure maxclients         #
904 #                                                                     #
905 #  nouserdns     - If set to yes, true or 1, no user DNS lookups      #
906 #                  will be performed for connecting users. This can   #
907 #                  save a lot of resources on very busy IRC servers.  #
908 #                                                                     #
909 #  quietbursts   - When synching or splitting from the network, a     #
910 #                  server can generate a lot of connect and quit      #
911 #                  snotices to the +C and +Q snomasks. Setting this   #
912 #                  value to yes squelches those messages, which can   #
913 #                  make them more useful for opers, however it will   #
914 #                  degrade their use by certain third party programs  #
915 #                  such as BOPM which rely on them to scan users when #
916 #                  a split heals in certain configurations.           #
917 #                                                                     #
918 #  netbuffersize - Size of the buffer used to receive data from       #
919 #                  clients. The ircd may only read() this amount      #
920 #                  of text in one go at any time. (OPTIONAL)          #
921 #                                                                     #
922
923 <performance netbuffersize="10240"
924              maxwho="128"
925              somaxconn="128"
926              softlimit="12800"
927              quietbursts="yes"
928              nouserdns="no">
929
930 #-#-#-#-#-#-#-#-#-#-#-# SECURITY CONFIGURATION  #-#-#-#-#-#-#-#-#-#-#-#
931 #                                                                     #
932 # announceinvites                                                     #
933 #                - If this option is set, then invites are announced  #
934 #                  to the channel when a user invites another user.   #
935 #                  If you consider this to be unnecessary noise,      #
936 #                  set this to 'none'. To announce to all ops, set    #
937 #                  this to 'ops' and to announce to all users set the #
938 #                  value to 'all'.                                    #
939 #                                                                     #
940 #                  The value 'dynamic' varies between 'ops' and 'all' #
941 #                  settings depending on if the channel is +i or not. #
942 #                  When the channel is +i, messages go only to ops,   #
943 #                  and when the channel is not +i, messages go to     #
944 #                  everyone. In short, the messages will go to every  #
945 #                  user who has power of INVITE on the channel. This  #
946 #                  is the recommended setting.                        #
947 #                                                                     #
948 #  disablehmac   - If you are linking your InspIRCd to older versions #
949 #                  then you can specify this option and set it to     #
950 #                  yes. 1.1.6 and above support HMAC and challenge-   #
951 #                  response for password authentication. These can    #
952 #                  greatly enhance security of your server to server  #
953 #                  connections when you are not using SSL (as is the  #
954 #                  case with a lot of larger networks). Linking to    #
955 #                  older versions of InspIRCd should not *usually* be #
956 #                  a problem, but if you have problems with HMAC      #
957 #                  authentication, this option can be used to turn it #
958 #                  off.                                               #
959 #                                                                     #
960 #  hidemodes     - If this option is enabled, then the listmodes      #
961 #                  given (e.g. +eI), will be hidden from users below  #
962 #                  halfop. This is not recommended to be set on mode  #
963 #                  +b, as it may break some features in popular       #
964 #                  clients such as mIRC.                              #
965 #                                                                     #
966 #  hidesplits    - When set to 'yes', will hide split server names    #
967 #                  from non-opers. Non-opers will see '*.net *.split' #
968 #                  instead of the server names in the quit message,   #
969 #                  identical to the way IRCu displays them.           #
970 #                                                                     #
971 #  hidebans      - When set to 'yes', will hide gline, kline, zline   #
972 #                  and qline quit messages from non-opers. For        #
973 #                  example, user A who is not an oper will just see   #
974 #                  (G-Lined) while user B who is an oper will see the #
975 #                  text (G-Lined: Reason here) instead.               #
976 #                                                                     #
977 #  hidewhois     - When defined with a non-empty value, the given     #
978 #                  text will be used in place of the user's server    #
979 #                  in WHOIS, when a user is WHOISed by a non-oper.    #
980 #                  For example, most nets will want to set this to    #
981 #                  something like '*.netname.net' to conceal the      #
982 #                  actual server the user is on.                      #
983 #                                                                     #
984 #  flatlinks     - When you are using m_spanningtree.so, and this     #
985 #                  value is set to yes, true or 1, /MAP and /LINKS    #
986 #                  will be flattened when shown to a non-opers.       #
987 #                                                                     #
988 #  hideulines    - When you are using m_spanningtree.so, and this     #
989 #                  value is set to yes, true or 1, then U-lined       #
990 #                  servers will be hidden in /LINKS and /MAP for non  #
991 #                  opers. Please be aware that this will also hide    #
992 #                  any leaf servers of a U-lined server, e.g. jupes.  #
993 #                                                                     #
994 #  userstats     - The userstats field is optional and specifies      #
995 #                  which stats characters in /STATS may be requested  #
996 #                  by non-operators. Stats characters in this field   #
997 #                  are case sensitive and are allowed to users        #
998 #                  independent of if they are in a module or the core #
999 #                                                                     #
1000 #  operspywhois  - If this is set then when an IRC operator uses      #
1001 #                  /WHOIS on a user they will see all channels, even  #
1002 #                  ones if channels are secret (+s), private (+p) or  #
1003 #                  if the target user is invisible +i.                #
1004 #                                                                     #
1005 #  customversion - If you specify this configuration item, and it is  #
1006 #                  not set to an empty value, then when a user does   #
1007 #                  a /VERSION command on the ircd, this string will   #
1008 #                  be displayed as the second portion of the output,  #
1009 #                  replacing the system 'uname', compile flags and    #
1010 #                  socket engine/dns engine names. You may use this   #
1011 #                  to enhance security, or simply for vanity.         #
1012 #                                                                     #
1013 #  maxtargets    - The maxtargets field is optional, and if not       #
1014 #                  defined, defaults to 20. It indicates the maximum  #
1015 #                  number of targets which may be given to commands   #
1016 #                  such as PRIVMSG, KICK etc.                         #
1017 #                                                                     #
1018
1019 <security announceinvites="dynamic"
1020           hidemodes="eI"
1021           disablehmac="no"
1022           hideulines="no"
1023           flatlinks="no"
1024           hidewhois=""
1025           hidebans="no"
1026           hidekills=""
1027           hidesplits="no"
1028           maxtargets="20"
1029           customversion=""
1030           operspywhois="no"
1031           userstats="Pu">
1032
1033 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1034 # Logging
1035 # -------
1036 #
1037 # Logging is covered with the <log> tag, which you may use to change
1038 # the behaviour of the logging of the IRCd.
1039 #
1040 # In InspIRCd as of 1.2, logging is pluggable and very extensible.
1041 # Different files can log the same thing, different 'types' of log can
1042 # go to different places, and modules can even extend the log tag
1043 # to do what they want.
1044 #
1045 # An example log tag would be:
1046 #       <log method="file" type="OPER" level="default" target="opers.log">
1047 # which  would log all information on /oper (failed and successful) to
1048 # a file called opers.log.
1049 #
1050 # There are many different types which may be used, and modules may
1051 # generate their own. A list of useful types:
1052 #       - USERS - information relating to user connection and disconnection
1053 #       - CHANNELS - information relating to joining and parting of channels.
1054 # XXX someone doc more on this
1055 #
1056 # You may also log *everything* by using a type of *, and subtract things out
1057 # of that by using -TYPE - for example "* -USERINPUT -USEROUTPUT".
1058 #
1059 # Channel Logging
1060 # ---------------
1061 #
1062 # I'm aware this would probably better belong in the modules section, but this
1063 # is heavily interrelated to logging, and as such will be documented here.
1064 #
1065 # m_chanlog is one of the modules which can alter logging to it's own thing.
1066 # An example of this may be:
1067 #
1068 #<module name="m_chanlog.so">
1069 #<log method="channel" type="OPER USERS CHANNELS" level="default" target="#services">
1070 #
1071 # The following log tag is highly default and uncustomised. It is recommended you
1072 # sort out your own log tags. This is just here so you get some output.
1073 <log method="file" type="* -USERINPUT -USEROUTPUT -m_spanningtree" level="default" target="ircd.log">
1074
1075 #-#-#-#-#-#-#-#-#-#-#-#-#-  WHOWAS OPTIONS   -#-#-#-#-#-#-#-#-#-#-#-#-#
1076 #                                                                     #
1077 # This tag lets you define the behaviour of the /whowas command of    #
1078 # your server.                                                        #
1079 #                                                                     #
1080 # groupsize      - Controls the maximum entries per nick shown when   #
1081 #                  performing a /whowas nick. Setting this to 0 dis-  #
1082 #                  ables whowas completely.                           #
1083 #                                                                     #
1084 # maxgroups      - The maximum number of nickgroups that can be added #
1085 #                  to the list. If max is reached, oldest group will  #
1086 #                  be deleted first like a FIFO. A groupsize of 3 and #
1087 #                  a maxgroups of 5000 will allow for 5000 nicks to   #
1088 #                  be stored with a history of 3, thus giving a total #
1089 #                  of 3 * 5000 = 15000 entries. A setting of 0 dis-   #
1090 #                  ables whowas completely.                           #
1091 #                                                                     #
1092 # maxkeep        - The maximum time a nick is kept in the whowas list #
1093 #                  before being pruned. Time may be specified in      #
1094 #                  seconds, or in the following format: 1y2w3d4h5m6s  #
1095 #                  meaning one year, two weeks, three days, 4 hours,  #
1096 #                  5 minutes and 6 seconds. All fields in this format #
1097 #                  are optional. Minimum is 1 hour, if less InspIRCd  #
1098 #                  will default back to 1 hour.                       #
1099 #                                                                     #
1100 #<whowas groupsize="10"                                               #
1101 #        maxgroups="100000"                                           #
1102 #        maxkeep="3d">                                                #
1103
1104
1105 #-#-#-#-#-#-#-#-#-#-#-#-#-  MODULE OPTIONS   -#-#-#-#-#-#-#-#-#-#-#-#-#
1106 #                                                                     #
1107 #  These tags define which modules will be loaded on startup by your  #
1108 #  server. Add modules without any paths. When you make your ircd     #
1109 #  using the 'make' command, all compiled modules will be moved into  #
1110 #  the folder you specified when you ran ./configure. The module tag  #
1111 #  automatically looks for modules in this location.                  #
1112 #  If you attempt to load a module outside of this location, either   #
1113 #  in the config, or via /LOADMODULE, you will receive an error.      #
1114 #                                                                     #
1115 #  By default, ALL modules are commented out. You must uncomment them #
1116 #  or add lines to your config to load modules. Please refer to       #
1117 #  http://www.inspircd.org/wiki/Modules_List for a list of modules and#
1118 #  each modules link for any additional conf tags they require.       #
1119 #                                                                     #
1120 #  You may use wildcards in a <module> tag to load all modules which  #
1121 #  match a glob pattern (e.g. m_sa????.so would load m_sajoin,        #
1122 #  m_sapart, m_saquit and m_sanick)                                   #
1123 #                                                                     #
1124 #    ____                _   _____ _     _       ____  _ _   _        #
1125 #   |  _ \ ___  __ _  __| | |_   _| |__ (_)___  | __ )(_) |_| |       #
1126 #   | |_) / _ \/ _` |/ _` |   | | | '_ \| / __| |  _ \| | __| |       #
1127 #   |  _ <  __/ (_| | (_| |   | | | | | | \__ \ | |_) | | |_|_|       #
1128 #   |_| \_\___|\__,_|\__,_|   |_| |_| |_|_|___/ |____/|_|\__(_)       #
1129 #                                                                     #
1130 # To link servers to InspIRCd, you MUST load the m_spanningtree       #
1131 # module, as shown below. If you DO NOT do this, server links will    #
1132 # NOT work at all. ie. The ports will NOT bind, and /connect will not #
1133 # work properly. This is by design, to allow for the implementation   #
1134 # of other linking protocols in modules in the future.                #
1135
1136 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1137 # Spanning Tree module - allows linking of servers using the spanning
1138 # tree protocol (see the READ THIS BIT section above).
1139 #
1140 #<module name="m_spanningtree.so">
1141
1142
1143 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1144 # MD5 Module - Allows other modules to generate MD5 hashes, usually for
1145 # cryptographic uses and security.
1146 #
1147 # IMPORTANT:
1148 # Other modules such as m_cloaking.so and m_opermd5.so may rely on
1149 # this module being loaded to function.
1150 #
1151 #<module name="m_md5.so">
1152 #
1153 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1154 # SHA256 Module - Allows other modules to generate SHA256 hashes,
1155 # usually for cryptographic uses and security.
1156 #
1157 # IMPORTANT:
1158 # Other modules such as m_password_hash.so may rely on this module being
1159 # loaded to function. Certain modules such as m_spanningtree.so will
1160 # function without this module but when it is loaded their features will
1161 # be enhanced (for example the addition of HMAC authentication).
1162 #
1163 #<module name="m_sha256.so">
1164
1165 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1166 # Alias module: Allows you to define server-side command aliases
1167 #<module name="m_alias.so">
1168 #
1169 #-#-#-#-#-#-#-#-#-#-#-  ALIAS DEFINITIONS  -#-#-#-#-#-#-#-#-#-#-#-#-#-#
1170 #                                                                     #
1171 # If you have the m_alias.so module loaded, you may also define       #
1172 # aliases as shown below. They are commonly used to provide shortcut  #
1173 # commands to services, however they are not limited to just this use.#
1174 # An alias tag requires the following values to be defined in it:     #
1175 #                                                                     #
1176 # text        -      The text to detect as the actual command line,   #
1177 #                    Cant contain spaces, but case insensitive.       #
1178 #                    You may have multiple aliases with the same      #
1179 #                    command name (text="" value), however the first  #
1180 #                    found will be executed if its format value is    #
1181 #                    matched, or it has no format value. Aliases are  #
1182 #                    read from the top of the file to the bottom.     #
1183 #                                                                     #
1184 # format      -      If this is defined, the parameters of the alias  #
1185 #                    must match this glob pattern. For example if you #
1186 #                    want the first parameter to start with a # for   #
1187 #                    the alias to be executed, set format="#*" in the #
1188 #                    alias definition. Note that the :'s which are    #
1189 #                    part of IRC formatted lines will be preserved    #
1190 #                    for matching of this text. This value is         #
1191 #                    optional.                                        #
1192 #                                                                     #
1193 # replace     -      The text to replace 'text' with. Usually this    #
1194 #                    will be "PRIVMSG ServiceName :$2-" or similar.   #
1195 #                    You may use the variables $1 through $9 in the   #
1196 #                    replace string, which refer to the first through #
1197 #                    ninth word in the original string typed by the   #
1198 #                    user. You may also use $1- through $9- which     #
1199 #                    refer to the first word onwards, through to the  #
1200 #                    ninth word onwards, e.g. if the user types the   #
1201 #                    command "foo bar baz qux quz" then $3- will hold #
1202 #                    "baz qux quz" and $2 will contain "bar". You may #
1203 #                    also use the special variables: $nick, $ident,   #
1204 #                    $host and $vhost, and you may separate multiple  #
1205 #                    commands with \n. If you wish to use the ACTUAL  #
1206 #                    characters \ and n together in a line, you must  #
1207 #                    use the sequence "\\n".                          #
1208 #                                                                     #
1209 # requires    -      If you provide a value for 'requires' this means #
1210 #                    the given nickname MUST be online for the alias  #
1211 #                    to successfully trigger. If they are not, then   #
1212 #                    the user receives a 'no such nick' 401 numeric.  #
1213 #                                                                     #
1214 # uline       -      Defining this value with 'yes', 'true' or '1'    #
1215 #                    will ensure that the user given in 'requires'    #
1216 #                    must also be on a u-lined server, as well as     #
1217 #                    actually being on the network. If the user is    #
1218 #                    online, but not on a u-lined server, then an     #
1219 #                    oper-alert is sent out as this is possibly signs #
1220 #                    of a user trying to impersonate a service.       #
1221 #                                                                     #
1222 # operonly    -      Defining this value, with a value of 'yes', '1'  #
1223 #                    or true will make the alias oper only. If a non- #
1224 #                    oper attempts to use the alias, it will appear   #
1225 #                    to not exist.                                    #
1226 #                                                                     #
1227 #<alias text="NICKSERV" replace="PRIVMSG NickServ :$2-" requires="NickServ" uline="yes">
1228 #<alias text="CHANSERV" replace="PRIVMSG ChanServ :$2-" requires="ChanServ" uline="yes">
1229 #<alias text="OPERSERV" replace="PRIVMSG OperServ :$2-" requires="OperServ" uline="yes" operonly="yes">
1230 #<alias text="NS" replace="PRIVMSG NickServ :$2-" requires="NickServ" uline="yes">
1231 #<alias text="CS" replace="PRIVMSG ChanServ :$2-" requires="ChanServ" uline="yes">
1232 #<alias text="OS" replace="PRIVMSG OperServ :$2-" requires="OperServ" uline="yes" operonly="yes">
1233 #
1234 # An example of using the format value to create an alias with two
1235 # different behaviours depending on the format of the parameters.
1236 #
1237 #<alias text="ID" format="#*" replace="PRIVMSG ChanServ :IDENTIFY $2 $3"
1238 #  requires="ChanServ" uline="yes">
1239 #
1240 #<alias text="ID" replace="PRIVMSG NickServ :IDENTIFY $2"
1241 #  requires="NickServ" uline="yes">
1242 #
1243 # This alias fixes a glitch in xchat 2.6.x and above and the way it
1244 # assumes IDENTIFY must be prefixed by a colon (:) character. It should
1245 # be placed ABOVE the default NICKSERV alias (the first example) listed
1246 # above.
1247 #
1248 #<alias text="NICKSERV" format=":IDENTIFY *" replace="PRIVMSG NickServ :IDENTIFY $3-"
1249 #  requires="NickServ" uline="yes">
1250
1251 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1252 # Alltime module: Shows time on all connected servers at once
1253 #<module name="m_alltime.so">
1254
1255 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1256 # Antibear security module: Prevents 'bear.txt' based trojans from
1257 # connecting to your network by sending them a numeric they can't handle.
1258 #<module name="m_antibear.so">
1259
1260 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1261 # Antibottler module: Labels bottler leech bots
1262 #<module name="m_antibottler.so">
1263
1264 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1265 # Auditorium module: Adds channel mode +u which makes everyone else
1266 # except you in the channel invisible, used for large meetings etc.
1267 #<module name="m_auditorium.so">
1268 #
1269 # Auditorium settings:
1270 #
1271 #<auditorium showops="no" operoverride="no">
1272 #
1273 # showops:
1274 #   Setting this value to yes makes m_auditorium behave like unrealircd
1275 #   +u channel mode, e.g. ops see users joining, parting, etc, and users
1276 #   joining the channel see the ops. Without this flag, the mode acts
1277 #   like ircnet's +a (anonymous channels), showing only the user in the
1278 #   names list, and not even showing the ops in the list, or showing the
1279 #   ops that the user has joined.
1280 # operoverride:
1281 #   Setting this value to yes makes m_auditorium affect the userlist for
1282 #   regular users only. Opers will view all users in the channel normally.
1283
1284 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1285 # Ban except module: Adds support for channel ban exceptions (+e)
1286 #<module name="m_banexception.so">
1287
1288 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1289 # Ban redirection module: Allows bans which redirect to a specified
1290 # channel. e.g. +b nick!ident@host#channelbanneduserissentto
1291 #<module name="m_banredirect.so">
1292
1293 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1294 # Block amsg module: Attempt to block all usage of /amsg and /ame
1295 #<module name="m_blockamsg.so">
1296 #
1297 #-#-#-#-#-#-#-#-#-#-#-  BLOCKAMSG CONFIGURATION  -#-#-#-#-#-#-#-#-#-#-#
1298 #                                                                     #
1299 # If you have the m_blockamsg.so module loaded, you can configure it  #
1300 # with the <blockamsg> tag:                                           #
1301 #                                                                     #
1302 # delay          -   How many seconds between two messages to force   #
1303 #                    them to be recognised as unrelated.              #
1304 # action         -   Any of 'notice', 'noticeopers', 'silent', 'kill' #
1305 #                    or 'killopers'. Define how to take action when   #
1306 #                    a user uses /amsg or /ame.                       #
1307 #
1308 #<blockamsg delay="3" action="killopers">
1309
1310 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1311 # Block CAPS module: Blocking all-CAPS messages with cmode +B
1312 #<module name="m_blockcaps.so">
1313 #                                                                     #
1314 #-#-#-#-#-#-#-#-#-#-#-  BLOCKCAPS CONFIGURATION  -#-#-#-#-#-#-#-#-#-#-#
1315 #                                                                     #
1316 # percent        - How many percent of text must be caps before text  #
1317 #                  will be blocked.                                   #
1318 #                                                                     #
1319 # minlen         - The minimum length a line must be for the block    #
1320 #                  percent to have any effect.                        #
1321 #                                                                     #
1322 # capsmap        - A list of chars to be considered CAPS, this was    #
1323 #                  you can add CAPS for your language. Also you can   #
1324 #                  add things like ! and space to further lock down   #
1325 #                  on caps usage.                                     #
1326 #<blockcaps percent="50"
1327 #           minlen="5"
1328 #           capsmap="ABCDEFGHIJKLMNOPQRSTUVWXYZ! ">
1329
1330 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1331 # Block colour module: Blocking colour-coded messages with cmode +c
1332 #<module name="m_blockcolor.so">
1333
1334 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1335 # Botmode module: Adds the user mode +B
1336 #<module name="m_botmode.so">
1337
1338 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1339 # CallerID module: Adds usermode +g which activates hybrid-style 
1340 # callerid (== block all private messages unless you /accept first)
1341 #<module name="m_callerid.so">
1342
1343 #-#-#-#-#-#-#-#-#-#-#- CALLERID  CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#
1344 # maxaccepts     - Maximum number of entires a user can add to his    #
1345 #                  /accept list. Default is 16 entries.               #
1346 # operoverride   - Can opers (note: ALL opers) ignore callerid mode?  #
1347 #                  Default is no.                                     #
1348 # tracknick      - Preserve /accept entries when a user changes nick? #
1349 #                  If no (the default), the user is removed from      #
1350 #                  everyone's accept list if he changes nickname.     #
1351 # cooldown       - Amount of time (in seconds) that must pass since   #
1352 #                  the last notification sent to a user before he can #
1353 #                  be sent another. Default is 60 (1 minute).         #
1354 #<callerid maxaccepts="16"
1355 #          operoverride="no"
1356 #          tracknick="no"
1357 #          cooldown="60"
1358
1359 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1360 # CBAN module: Lets you disallow channels from being used at runtime.
1361 #<module name="m_cban.so">
1362
1363 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1364 # Censor module: Adds the channel mode +G
1365 #<module name="m_censor.so">
1366 #
1367 #-#-#-#-#-#-#-#-#-#-#-  CENSOR  CONFIGURATION  -#-#-#-#-#-#-#-#-#-#-#-#
1368 #                                                                     #
1369 # Optional - If you specify to use the m_censor module, then you must #
1370 # specify some censor tags. See also:                                 #
1371 # http://www.inspircd.org/wiki/Censor_Module                          #
1372 #
1373 #<include file="censor.conf">
1374
1375 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1376 # CGI:IRC module: Adds support for automatic host changing in CGI:IRC
1377 # (http://cgiirc.sourceforge.net).
1378 #<module name="m_cgiirc.so">
1379 #
1380 #-#-#-#-#-#-#-#-#-#-#-# CGIIRC  CONFIGURATION #-#-#-#-#-#-#-#-#-#-#-#-#
1381 #
1382 # Optional - If you specify to use m_cgiirc, then you must specify one
1383 # or more cgihost tags which indicate authorised CGI:IRC servers which
1384 # will be connecting to your network, and an optional cgiirc tag.
1385 # For more information see: http://www.inspircd.org/wiki/CGI-IRC_Module
1386 #
1387 # Set to yes if you want to notice opers when CGI clients connect
1388 # <cgiirc opernotice="no">
1389 #
1390 # The type field indicates where the module should get the real
1391 # client's IP address from, for further information, please see the
1392 # CGI:IRC documentation.
1393 #
1394 # Old style:
1395 # <cgihost type="pass" mask="www.mysite.com">       # Get IP from PASS
1396 # <cgihost type="ident" mask="otherbox.mysite.com"> # Get IP from ident
1397 # <cgihost type="passfirst" mask="www.mysite.com">  # See the docs
1398 # New style:
1399 # <cgihost type="webirc" pass="foobar"
1400 #   mask="somebox.mysite.com">                      # Get IP from WEBIRC
1401 #
1402 # IMPORTANT NOTE:
1403 # ---------------
1404 #
1405 # When you connect CGI:IRC clients, there are two connect classes which
1406 # apply to these clients. When the client initially connects, the connect
1407 # class which matches the cgi:irc site's host is checked. Therefore you
1408 # must raise the maximum local/global clients for this ip as high as you
1409 # want to allow cgi clients. After the client has connected and is
1410 # determined to be a cgi:irc client, the class which matches the client's
1411 # real IP is then checked. You may set this class to a lower value, so that
1412 # the real IP of the client can still be restricted to, for example, 3
1413 # sessions maximum.
1414 #
1415
1416
1417 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1418 # Channel create module: Adds snomask +j, which will notify opers of
1419 # any new channels that are created
1420 #<module name="m_chancreate.so">
1421
1422 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1423 # Channel filter module: Allows channel-op defined message
1424 # filtering using simple string matches (channel mode +g)
1425 #<module name="m_chanfilter.so">
1426
1427 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1428 # Chanprotect module: gives +q and +a channel modes
1429 #<module name="m_chanprotect.so">
1430
1431 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1432 # Check module: gives /check
1433 # Check is useful for looking up information on channels,
1434 # users, IP addresses and hosts.
1435 #<module name="m_check.so">
1436
1437 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1438 # CHGHOST module: Adds the /CHGHOST command
1439 #<module name="m_chghost.so">
1440 #
1441 #-#-#-#-#-#-#-#-# /CHGHOST - /SETHOST  CONFIGURATION #-#-#-#-#-#-#-#-#
1442 # Optional - If you want to use special chars for hostnames you can  #
1443 # specify your own custom list of chars with the <hostname> tag:     #
1444 #                                                                    #
1445 # charmap        - A list of chars accepted as valid by the /CHGHOST #
1446 #                  and /SETHOST commands. Also note that the list is # 
1447 #                  case-sensitive.                                   #
1448 #<hostname charmap="abcdefghijklmnopqrstuvwxyz.-_/0123456789">
1449
1450 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1451 # CHGIDENT module: Adds the /CHGIDENT command
1452 #<module name="m_chgident.so">
1453
1454 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1455 # CHGNAME module: Adds the /CHGNAME command
1456 #<module name="m_chgname.so">
1457
1458 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1459 # Cloaking module: Adds usermode +x and cloaking support.
1460 # Relies on the module m_md5.so being loaded before m_cloaking.so in
1461 # the configuration file.
1462 #<module name="m_cloaking.so">
1463 #
1464 #-#-#-#-#-#-#-#-#-#-#- CLOAKING  CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#
1465 #                                                                     #
1466 # Optional - If you specify the m_cloaking.so module as above, you    #
1467 # must define cloak keys, and optionally a cloak prefix as shown      #
1468 # below. When using cloaking, the cloak keys are MANDITORY and must   #
1469 # be included. However, if prefix is not included, it will default    #
1470 # to your networks name from the <server> tag. You can also include   #
1471 # the following optional values:                                      #
1472 #                                                                     #
1473 #   ipalways         - Always cloak the IP address, not the hostname, #
1474 #                      which doesn't reveal the user's ISP, but       #
1475 #                      results in hosts that are harder to read and   #
1476 #                      ban.                                           #
1477 #                                                                     #
1478 #   lowercase        - Display the cloaked hostnames in lowercase     #
1479 #                      characters instead of uppercase                #
1480 #                                                                     #
1481 # <cloak key1="0x2AF39F40"                                            #
1482 #        key2="0x78E10B32"                                            #
1483 #        key3="0x4F2D2E82"                                            #
1484 #        key4="0x043A4C81"                                            #
1485 #        prefix="mynet"                                               #
1486 #        ipalways="false"                                             #
1487 #        lowercase="false">                                           #
1488 #                                                                     #
1489 # Please note that the key values will accept any number, and should  #
1490 # be large numbers. Using small numbers such as "7" or "1924" will    #
1491 # seriously weaken the security of your cloak. It is recommended you  #
1492 # use hexdecimal numbers prefixed by "0x", as shown in this example,  #
1493 # with each key eight hex digits long.                                #
1494
1495 #-#-#-#-#-#-#-#-#-#-#-#- CLOSE MODULE #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1496 # Close module: Allows an oper to close all unregistered connections.
1497 #<module name="m_close.so">
1498
1499 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1500 # Clones module: Adds an oper command /CLONES for detecting cloned
1501 # users. Warning: This module may be resource intensive when its
1502 # command is issued, use with care.
1503 #<module name="m_clones.so">
1504
1505 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1506 # Common channels module: Adds user mode +c, which, when set, requires
1507 # that users must share a common channel with you to PRIVMSG or NOTICE
1508 # you.
1509 #<module name="m_commonchans.so">
1510
1511 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1512 # Conn-Join: Allows you to force users to join one or more channels
1513 # automatically upon connecting to the server.
1514 #<module name="m_conn_join.so">
1515 #
1516 #-#-#-#-#-#-#-#-#-#-#-#- CONNJOIN CONFIGURATION  -#-#-#-#-#-#-#-#-#-#-#
1517 #
1518 # If you have m_conn_join.so loaded, you can configure it using the
1519 # follow values:
1520 #
1521 #<autojoin channel="#one,#two,#three">
1522
1523 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1524 # Conn-Usermodes: Set modes on users when they connect
1525 # When this module is loaded <connect:allow> tags may have an optional
1526 # modes="" value, which contains modes to add or remove from users
1527 # when they connect to the server.
1528 #<module name="m_conn_umodes.so">
1529
1530 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1531 # Conn-Wait-for-Pong: Don't let a user connect until they PONG
1532 #<module name="m_conn_waitpong.so">
1533 #
1534 #-#-#-#-#-#-#-#-#-#-#-   WAITPONG CONFIGURATION  -#-#-#-#-#-#-#-#-#-#-#
1535 #                                                                     #
1536 # If you have the m_conn_waitpong.so module loaded, configure it with #
1537 # the <waitpong> tag:                                                 #
1538 #                                                                     #
1539 # sendsnotice    -   Whether to send a snotice on connect, like other #
1540 #                    older ircds                                      #
1541 #                                                                     #
1542 # killonbadreply -   Whether to kill the user if they send the wrong  #
1543 #                    PONG reply.                                      #
1544 #                                                                     #
1545 #<waitpong sendsnotice="yes" killonbadreply="yes">
1546
1547
1548 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1549 # Channel cycle module. Server side /hop, with +ilk etc bypass.
1550 #<module name="m_cycle.so">
1551
1552 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1553 # Connectban: Provides per-IP connection throttling. Any IP that disconnects
1554 # too many times (configurable) in an hour is zlined for a (configurable)
1555 # duration, and their count resets to 0.
1556 #
1557 # NOTE: This module may change name/behaviour later in 1.2. Please make sure
1558 # you read release announcements!
1559 #
1560 #<connectban threshold="10" duration="10m">
1561 # This allows for 10 quits in an hour with a 10 minute ban if that is exceeded.
1562 #
1563 #<module name="m_connectbanban.so">
1564
1565 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1566 # Connection throttle module. Configuration:
1567 #<module name="m_connflood.so">
1568 #
1569 #-#-#-#-#-#-#-#-#-#-#- CONTHROTTLE CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
1570 #  seconds, maxconns -  Amount of connections per <seconds>.
1571 #
1572 #  timeout           -  Time to wait after the throttle was activated
1573 #                       before deactivating it. Be aware that the time
1574 #                       is seconds + timeout.
1575 #
1576 #  quitmsg           -  The message that users get if they attempt to
1577 #                       connect while the throttle is active.
1578 #
1579 #  bootwait          -  Amount of time to wait before enforcing the
1580 #                       throttling when the server just booted.
1581 #
1582 #<connflood seconds="30" maxconns="3" timeout="30"
1583 #   quitmsg="Throttled" bootwait="10">
1584
1585 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1586 # Custom title module: Adds the /TITLE command which allows for trusted
1587 #                      users to gain a custom whois line and a optional
1588 #                      vhost can be specified.
1589 #<module name="m_customtitle.so">
1590 #
1591 #-#-#-#-#-#-#-#-#-#-  CUSTOM TITLE CONFIGURATION   -#-#-#-#-#-#-#-#-#-#
1592 #  name              - The username used to identify 
1593 #  password          - The password used to identify
1594 #  host              - Allowed hostmask [optional]
1595 #  title             - Title shown in whois
1596 #  vhost             - Displayed host [optional]
1597 #
1598 #<title name="foo" password="bar" title="Official Chat Helper">
1599 #<title name="bar" password="foo" host="ident@host.name" title="Official Chat Helper" vhost="helper.network.chat">
1600
1601 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1602 # DCCALLOW module: Adds the /DCCALLOW command
1603 #<module name="m_dccallow.so">
1604 #
1605 #-#-#-#-#-#-#-#-#-#-#-  DCCALLOW CONFIGURATION   -#-#-#-#-#-#-#-#-#-#-#
1606 #  blockchat         - Whether to block DCC CHAT as well as DCC SEND
1607 #  length            - Default duration of entries in DCCALLOW list
1608 #  action            - Default action to take if no action is specified
1609 #                      can be 'block' or 'allow'
1610 #
1611 # File configuration:
1612 #  pattern           - The glob pattern to match against
1613 #  action            - Action to take if a user attempts to send a file
1614 #                      that matches this pattern, can be 'block' or 'allow'
1615 #
1616 #<dccallow blockchat="yes" length="5m" action="block">
1617 #<banfile pattern="*.exe" action="block">
1618 #<banfile pattern="*.txt" action="allow">
1619 #
1620 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1621
1622 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1623 # Deaf module: adds support for ircu style usermode +d - deaf to
1624 # channel messages and channel notices.
1625 #<module name="m_deaf.so">
1626
1627 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1628 # Delay join module: Adds the channel mode +D which delays all JOIN
1629 # messages from users until they speak. If they quit or part before
1630 # speaking, their quit or part message will not be shown to the channel
1631 # which helps cut down noise on large channels in a more friendly way
1632 # than the auditorium mode. Only channel ops may set the +D mode.
1633 #<module name="m_delayjoin.so">
1634
1635 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1636 # Deny Channels: Deny Channels from being used by users
1637 #<module name="m_denychans.so"> 
1638 #
1639 #-#-#-#-#-#-#-#-#-#-#-   DENYCHAN DEFINITIONS  -#-#-#-#-#-#-#-#-#-#-#-#
1640 #                                                                     #
1641 # If you have the m_denychans.so module loaded, you need to specify   #
1642 # the channels to deny:                                               #
1643 #                                                                     #
1644 # name        -      The channel name to deny. (glob masks are ok)    #
1645 #                                                                     #
1646 # allowopers  -      If operators are allowed to override the deny.   #
1647 #                                                                     #
1648 # reason      -      Reason given for the deny.                       #
1649 #                                                                     #
1650 # redirect    -      Redirect the user to a different channel         #
1651 #                                                                     #
1652 #<badchan name="#gods*" allowopers="yes" reason="Tortoises!">         #
1653 #<badchan name="#heaven" redirect="#hell" reason="Nice try!">         #
1654 #                                                                     #
1655 # Redirects will not work if the target channel is set +L.            #
1656 #                                                                     #
1657 # Additionally, you may specify channels which are allowed, even if   #
1658 # a badchan tag specifies it would be denied:                         #
1659 #<goodchan name="#godsleeps">                                         #
1660 # Glob masks are accepted here also.
1661
1662 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1663 # Devoice Module: Let users devoice themselves.
1664 #<module name="m_devoice.so">
1665
1666 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1667 # DNS Blacklist Module: Provides support for looking up IPs on one or #
1668 # more blacklists.                                                    #
1669 #<module name="m_dnsbl.so">                                           #
1670 #                                                                     #
1671 # For configuration options please see the wiki page for m_dnsbl at   #
1672 # http://inspircd.org/wiki/DNS_Blacklist_Module                       #
1673
1674 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1675 # Filter module: Provides glob-based message filtering
1676 #<module name="m_filter.so">
1677 # OR
1678 # PCRE filter module: Filters messages using regular expressions
1679 #<module name="m_filter_pcre.so">
1680 #
1681 # You may only use one or the other with these modules, network-wide.
1682 #
1683 #-#-#-#-#-#-#-#-#-#-#-  FILTER  CONFIGURATION  -#-#-#-#-#-#-#-#-#-#-#-#
1684 #                                                                     #
1685 # Optional - If you specify to use the m_filter or m_filter_pcre      #
1686 # modules, then specfiy below the path to the filter.conf file,       #
1687 # or define some <filter> tags.                                       #
1688 #                                                                     #
1689 #<include file="filter.conf">
1690
1691 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1692 # Foobar module: does nothing - historical relic
1693 #<module name="m_foobar.so">
1694
1695 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1696 # GeoIP module: Allows the server admin to ban users by country code.
1697 #<module name="m_geoip.so">
1698 #
1699 #-#-#-#-#-#-#-#-#-#-#-#  GEOIP CONFIGURATION  #-#-#-#-#-#-#-#-#-#-#-#-#
1700 #                                                                     #
1701 # <geoip banunknown="false">                                          #
1702 #                                                                     #
1703 # Set this value to true or yes to block unknown IP ranges which are  #
1704 # not in the database (usually LAN addresses, localhost, etc)         #
1705 #                                                                     #
1706 # <geoban country="TR" reason="This country not permitted">           #
1707 #                                                                     #
1708 # Use one or more of these tags to ban countries by country code.     #
1709 # The country code must be in capitals and should be an ISO country   #
1710 # code such as TR, GB, or US.                                         #
1711
1712 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1713 # Globops module: gives /GLOBOPS and usermode +g
1714 #<module name="m_globops.so">
1715
1716 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1717 # Global load module: Allows loading and unloading of modules network-
1718 # wide (USE WITH EXTREME CAUTION!)
1719 #<module name="m_globalload.so">
1720
1721 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1722 # HELPOP module: Provides the /HELPOP command
1723 #<module name="m_helpop.so">
1724 #
1725 #-#-#-#-#-#-#-#-#-#-#-#-  HELPOP  CONFIGURATION  -#-#-#-#-#-#-#-#-#-#-#
1726 #                                                                     #
1727 # Optional - If you specify to use the m_helpop.so module, then       #
1728 # specify below the path to the helpop.conf file, or if you like to   #
1729 # make a mess, define your helpop tags in this conf.                  #
1730 #                                                                     #
1731 #<include file="helpop.conf">
1732
1733 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1734 # HIDECHANS module: Allows opers to hide their channels list from non-
1735 # opers by setting user mode +I on themselves.
1736 # <module name="m_hidechans.so">
1737
1738 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1739 # HIDEOPER module: Allows opers to hide their oper status from non-
1740 # opers by setting user mode +H on themselves.
1741 # <module name="m_hideoper.so">
1742
1743 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1744 # Hostchange module: Allows a different style of cloaking
1745 #<module name="m_hostchange.so">
1746 #
1747 #-#-#-#-#-#-#-#-#-#-#-  HOSTCHANGE  CONFIGURATION  -#-#-#-#-#-#-#-#-#-#
1748 #                                                                     #
1749 # Optional - If you choose to use the m_hostchange.so module.         #
1750 # Config Help -  See http://www.inspircd.org/wiki/Host_Changer_Module #
1751 #                                                                     #
1752 #<host suffix="polarbears.org" separator="." prefix="">
1753 #<hostchange mask="*@fbi.gov" action="addnick">
1754 #<hostchange mask="*r00t@*" action="suffix">
1755 #<hostchange mask="a@b.com" action="set" value="blah.blah.blah">
1756 #<hostchange mask="localhost" ports="7000,7001,7005-7007" action="set" value="blahblah.foo">
1757
1758 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1759 # httpd module: Provides http server support for InspIRCd
1760 #<module name="m_httpd.so">
1761 #
1762 #-#-#-#-#-#-#-#-#-#-#-#-  HTTPD   CONFIGURATION  -#-#-#-#-#-#-#-#-#-#-#
1763 #
1764 # Optional - If you choose to use the m_httpd.so module,  then you must
1765 # specify the port number and other details of your http server:
1766 #
1767 #<http ip="192.168.1.10" host="brainwave" port="32006"
1768 #      index="/home/brain/inspircd/http/index.html">
1769 #
1770 # You may have as many of these tags as you wish, each with a different
1771 # IP, port, host or index file. Each one will act as an independent
1772 # HTTP server.
1773 #
1774
1775 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1776 # http stats module: Provides basic stats pages over HTTP
1777 # Requires m_httpd.so to be loaded for it to function.
1778 #<module name="m_httpd_stats.so">
1779 #
1780 #-#-#-#-#-#-#-#-#-#-#-#- HTTPD STATS CONFIGURATION -#-#-#-#-#-#-#-#-#-#
1781 #
1782 #<httpstats stylesheet="http://remote.style/sheet.css">
1783 #
1784
1785 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1786 # Ident: Provides RFC 1413 ident lookup support
1787 #<module name="m_ident.so">
1788 #
1789 #-#-#-#-#-#-#-#-#-#-#-#-   IDENT CONFIGURATION   -#-#-#-#-#-#-#-#-#-#-#
1790 #                                                                     #
1791 # Optional - If you are using the m_ident.so module, then you can     #
1792 # specify the timeout for ident lookups here. If not defined, it will #
1793 # default to one second. This is a non-blocking timeout which holds   #
1794 # the user in a 'connecting' state until the lookup is complete.      #
1795 # The bind value indicates which IP to bind outbound requests to.     #
1796 #                                                                     #
1797 #<ident timeout="5" bind="">
1798
1799 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1800 # Invite except module: Adds support for channel invite exceptions (+I)
1801 #<module name="m_inviteexception.so">
1802
1803 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1804 # Invisible module - Adds support for usermode +Q (quiet) which lets an
1805 # oper go 'invisible' similar to unrealircd 3.1's +I mode. Note that
1806 # opers are still able to see invisible users, and if an oper with +Q
1807 # deopers, they will become visible. 
1808
1809 # IMPORTANT NOTE: To allow this mode to be used by a type of oper, you
1810 # must first add the value canquiet="yes" to that oper's type tag.
1811 #
1812 #<module name="m_invisible.so">
1813
1814 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1815 # Join flood module: Adds support for join flood protection (+j)
1816 #<module name="m_joinflood.so">
1817
1818 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1819 # Jump Server module: Adds support for the RPL_REDIR numeric
1820 #<module name="m_jumpserver.so">
1821
1822 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1823 # Anti-Auto-Rejoin: Adds support for prevention of auto-rejoin (+J)
1824 #<module name="m_kicknorejoin.so">
1825
1826 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1827 # Knock module: adds the /KNOCK command and +K channel mode
1828 #<module name="m_knock.so">
1829
1830 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1831 # LDAP authentication module: Adds the ability to authenticate users  #
1832 # via LDAP. This is an extra module which must be enabled explicitly  #
1833 # by symlinking it from modules/extra, and requires the OpenLDAP libs #
1834 #                                                                     #
1835 #<module name="m_ldapauth.so">                                        #
1836 #                                                                     #
1837 # Configuration:                                                      #
1838 #                                                                     #
1839 # <ldapauth baserdn="ou=People,dc=brainbox,dc=cc"                     #
1840 #           attribute="uid"                                           #
1841 #           server="ldap://brainwave.brainbox.cc"                     #
1842 #           allowpattern="Guest*"                                     #
1843 #           killreason="Access denied"                                #
1844 #           searchscope="subtree"                                     #
1845 #           binddn="cn=Manager,dc=brainbox,dc=cc"                     #
1846 #           bindauth="mysecretpass"                                   #
1847 #           verbose="yes">                                            #
1848 #                                                                     #
1849 # The baserdn indicates the base DN to search in for users. Usually   #
1850 # this is 'ou=People,dc=yourdomain,dc=yourtld'.                       #
1851 #                                                                     #
1852 # The attribute value indicates the attribute which is used to locate #
1853 # a user account by name. On POSIX systems this is usually 'uid'.     #
1854 #                                                                     #
1855 # The server parameter indicates the LDAP server to connect to. The   #
1856 # ldap:// style scheme before the hostname proper is MANDITORY.       #
1857 #                                                                     #
1858 # The allowpattern value allows you to specify a wildcard mask which  #
1859 # will always be allowed to connect regardless of if they have an     #
1860 # account, for example guest users.                                   #
1861 #                                                                     #
1862 # Killreason indicates the QUIT reason to give to users if they fail  #
1863 # to authenticate.                                                    #
1864 #                                                                     #
1865 # The searchscope value indicates the subtree to search under. On our #
1866 # test system this is 'subtree'. Your mileage may vary.               #
1867 #                                                                     #
1868 # Setting the verbose value causes an oper notice to be sent out for  #
1869 # every failed authentication to the server, with an error string.    #
1870 #                                                                     #
1871 # The binddn and bindauth indicate the DN to bind to for searching,   #
1872 # and the password for the distinguished name. Some LDAP servers will #
1873 # allow anonymous searching in which case these two values do not     #
1874 # need defining, otherwise they should be set similar to the examples #
1875 # above.                                                              #
1876
1877 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1878 # Lock server module: Adds /LOCKSERV and /UNLOCKSERV commands that is #
1879 # used to temporarily close/open for new connections to the server.   #
1880 # These commands require OPER status and that the LOCKSERV UNLOCKSERV #
1881 # are specified in a <class> tag that the oper is part of. This is so #
1882 # you can control who has access to this possible dangerous command.  #
1883 # If your server is locked and you got disconnected, do a REHASH from #
1884 # shell to open up again.
1885 #<module name="m_lockserv.so">
1886
1887 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1888 # Msg flood module: Adds message/notice flood protection (+f)
1889 #<module name="m_messageflood.so">
1890
1891 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1892 # MsSQL module: Allows other SQL modules to access MS SQL Server 
1893 # through a unified API. You must copy the source for this module
1894 # from the directory src/modules/extra, plus the file m_sqlv2.h
1895 #<module name="m_mssql.so">
1896 #
1897 #-#-#-#-#-#-#-#-#-#-#-#- SQL CONFIGURATION   -#-#-#-#-#-#-#-#-#-#-#-#-#
1898 #                                                                     #
1899 # m_mssql.so is more complex than described here, see wiki for more   #
1900 # info http://www.inspircd.org/wiki/SQLServer_Service_Provider_Module #
1901 #
1902 #<database name="db" username="user" password="pass" hostname="localhost" id="db1">
1903
1904 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1905 # MySQL module: Allows other SQL modules to access MySQL databases
1906 # through a unified API. You must copy the source for this module
1907 # from the directory src/modules/extra, plus the file m_sqlv2.h
1908 #<module name="m_mysql.so">
1909 #
1910 #-#-#-#-#-#-#-#-#-#-#-#- SQL CONFIGURATION   -#-#-#-#-#-#-#-#-#-#-#-#-#
1911 #                                                                     #
1912 # m_mysql.so is more complex than described here, see the wiki for    #
1913 # more: http://www.inspircd.org/wiki/SQL_Service_Provider_Module      #
1914 #
1915 #<database name="mydb" username="myuser" password="mypass" hostname="localhost" id="my_database2">
1916
1917 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1918 # NAMESX module: Provides support for the NAMESX extension which allows
1919 # clients to see all the prefixes set on a user without getting confused.
1920 # This is supported by mIRC, x-chat, klient, and maybe more.
1921 #<module name="m_namesx.so">
1922
1923 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1924 # Nickban: Implements extended ban n:, which stops anyone matching
1925 # a mask like +b n:nick!user@host from changing their nick on channel.
1926 #<module name="m_nickban.so">
1927 #
1928
1929 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1930 # Nickchange flood protection module: Allows up to X nick changes in Y seconds.
1931 # Provides channel mode +F.
1932 #<module name="m_nickflood.so">
1933
1934 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1935 # Nicklock module: Let opers change a user's nick and then stop that
1936 # user from changing their nick again.
1937 #<module name="m_nicklock.so">
1938
1939 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1940 # No ctcp module: Adds the channel mode +C to block CTCPs
1941 #<module name="m_noctcp.so">
1942
1943 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1944 # Noinvite module: Gives channel mode +V
1945 #<module name="m_noinvite.so">
1946
1947 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1948 # No kicks module: Adds the +Q channel mode
1949 #<module name="m_nokicks.so">
1950
1951 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1952 # No nicks module: Adds the +N channel mode
1953 #<module name="m_nonicks.so">
1954
1955 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1956 # No Notice module: adds the channel mode +T
1957 #<module name="m_nonotice.so">
1958
1959 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1960 # Oper channels mode: Adds the +O channel mode
1961 #<module name="m_operchans.so">
1962
1963 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1964 # Oper Join module: Forces opers to join a channel on oper-up
1965 #<module name="m_operjoin.so">
1966 #
1967 #-#-#-#-#-#-#-#-#-#-#   OPERJOIN CONFIGURATION   -#-#-#-#-#-#-#-#-#-#-#
1968 #                                                                     #
1969 # If you are using the m_operjoin.so module, specify options here:    #
1970 #                                                                     #
1971 # channel     -      The channel name to join, can also be a comma    #
1972 #                    seperated list eg. "#channel1,#channel2".        #
1973 #                                                                     #
1974 # override    -      Lets the oper join walking thru any modes that   #
1975 #                    might be set, even bans. Use "yes" or "no".      #
1976 #                                                                     #
1977 #<operjoin channel="#channel" override="no">
1978
1979 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1980 # Oper MOTD module: Provides support for seperate message of the day
1981 # on oper-up
1982 #<module name="m_opermotd.so">
1983 #
1984 #-#-#-#-#-#-#-#-#-#-#   OPERMOTD CONFIGURATION   -#-#-#-#-#-#-#-#-#-#-#
1985 #                                                                     #
1986 # If you are using the m_opermotd.so module, specify the motd here    #
1987 #                                                                     #
1988 #<opermotd file="oper.motd">
1989
1990 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1991 # Override module: Adds support for oper override
1992 #<module name="m_override.so">
1993 #
1994 #-#-#-#-#-#-#-#-#-#-#   OVERRIDE CONFIGURATION   -#-#-#-#-#-#-#-#-#-#-#
1995 #                                                                     #
1996 # m_override.so is too complex it describe here, see the wiki:        #
1997 # http://www.inspircd.org/wiki/Oper_Override_Module                   #
1998
1999 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2000 # Oper levels module: Gives each oper a level and prevents
2001 # actions being taken against higher level opers
2002 # Specify the level as the 'level' parameter of the <type> tag
2003 #<module name="m_operlevels.so">
2004
2005 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2006 # Oper modes module: Allows you to specify modes to add/remove on oper
2007 # Specify the modes as the 'modes' parameter of the <type> tag
2008 # and/or as the 'modes' parameter of the <oper> tag.
2009 #<module name="m_opermodes.so">
2010
2011 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2012 # Oper password hash module: Allows hashed oper passwords
2013 # Relies on the module m_md5.so and/or m_sha256.so being loaded before
2014 # m_password_hash.so in the configuration file.
2015 #<module name="m_password_hash.so">
2016 #
2017 #-#-#-#-#-#-#-#-#-#-# OPER HASH CONFIGURATION #-#-#-#-#-#-#-#-#-#-#-#-#
2018 #
2019 # To use this module, you must define a hash type for each oper's
2020 # password you want to hash. For example:
2021 #
2022 #     <oper name="Brain"
2023 #           host="ident@dialup15.isp.com"
2024 #           hash="sha256"
2025 #           password="a41d730937a53b79f788c0ab13e9e1d5"
2026 #           type="NetAdmin">
2027
2028 # The types of hashing available vary depending on which hashing modules
2029 # you load, but usually if you load m_sha256.so and m_md5.so, both md5
2030 # and sha256 type hashing will be available (the most secure of which
2031 # is SHA256).
2032
2033 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2034 # Permanent Channels module: Channels with the permanent channels mode
2035 # will remain open even after everyone else has left the channel, and
2036 # therefore keep things like modes, ban lists and topic. Permanent
2037 # channels -may- need support from your Services package to function
2038 # properly with them. This adds channel mode +P.
2039 #<module name="m_permchannels.so">
2040
2041 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2042 # PostgreSQL module: Allows other SQL modules to access PgSQL databases
2043 # through a unified API. You must copy the source for this module
2044 # from the directory src/modules/extra, plus the file m_sqlv2.h
2045 #<module name="m_pgsql.so">
2046 #
2047 #-#-#-#-#-#-#-#-#-#-#-#- SQL CONFIGURATION   -#-#-#-#-#-#-#-#-#-#-#-#-#
2048 #                                                                     #
2049 # m_pgsql.so is more complex than described here, see the wiki for    #
2050 # more: http://www.inspircd.org/wiki/SQL_Service_Provider_Module      #
2051 #
2052 #<database name="mydb" username="myuser" password="mypass" hostname="localhost" id="my_database" ssl="no">
2053
2054 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2055 # Quietban: Implements extended ban q:, which stops anyone matching
2056 # a mask like +b q:nick!user@host from speaking on channel.
2057 #<module name="m_quietban.so">
2058 #
2059
2060 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2061 # Random Quote module: provides a random quote on connect.
2062 # NOTE: Some of these may mimic fatal errors and confuse users and 
2063 # opers alike! - BEWARE!
2064 #<module name="m_randquote.so">
2065 #
2066 #-#-#-#-#-#-#-#-#-#-  RANDOMQUOTES CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
2067 #                                                                     #
2068 # Optional - If you specify to use the m_randquote.so module, then    #
2069 # specify below the path to the randquotes.conf file.                 #
2070 #                                                                     #
2071 #<randquote file="randquotes.conf">
2072
2073 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2074 # Redirect module: Adds channel redirection (mode +L)
2075 #<module name="m_redirect.so">
2076
2077 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2078 # Registered users only channel creation
2079 # Allows only registered users and opers to create new channels.
2080 #<module name="m_regonlycreate.so">
2081
2082 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2083 # Remove module: Adds the /REMOVE command which is a peaceful
2084 # alternative to /KICK
2085 #<module name="m_remove.so">
2086
2087 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2088 # Restrict banned users module:
2089 # Disallows banned users on a channel from messaging the channel,
2090 # changing nick, or changing the topic, if loaded.
2091 #<module name="m_restrictbanned.so">
2092
2093 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2094 # Restricted channels module: Allows only opers to create channels
2095 #<module name="m_restrictchans.so">
2096
2097 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2098 # Restrict message module: Allows users to only message opers
2099 #<module name="m_restrictmsg.so">
2100
2101 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2102 # Ban users through regular expression patterns
2103 #<module name="m_rline.so">
2104 #
2105 #-#-#-#-#-#-#-#-#-#-#-#- RLINE CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#-#
2106 # If you wish to re-check a user when they change nickname (can be
2107 # useful under some situations, but *can* also use CPU with more users
2108 # on a server) then set the following configuration value:
2109 #<rline matchonnickchange="yes">
2110
2111 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2112 # Provide /LIST throttling (to prevent flooding) and /LIST safety to
2113 # prevent excess flood when the list is large.
2114 #<module name="m_safelist.so">
2115 #
2116 #-#-#-#-#-#-#-#-#-#-# SAFELIST CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#-#
2117 #
2118 # When using Safelist, you may set the following values;
2119 #
2120 # The first value, 'throttle', sets the amount of time in seconds a user
2121 # must wait between LIST commands. For example, if this is set to 60
2122 # (the default) then the user may not /LIST more than once a minute.
2123 # If not defined, the default value is 60 seconds.
2124 #
2125 # The second value, 'maxlisters', indicates the maximum number of users
2126 # which may be retrieving a LIST at once. It is not recommended you raise
2127 # this value, as increasing it too high can make your network vulnerable
2128 # to floodbots which waste your bandwidth and CPU time with LIST requests.
2129 #
2130 #<safelist throttle="60" maxlisters="50">
2131
2132 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2133 # SAJOIN module: Adds the /SAJOIN command
2134 #<module name="m_sajoin.so">
2135
2136 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2137 # SAMODE module: Adds the oper /SAMODE command
2138 #<module name="m_samode.so">
2139
2140 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2141 # SANICK module: Allows opers to change user's nicks
2142 #<module name="m_sanick.so">
2143
2144 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2145 # SAPART module: Adds the oper /SAPART command
2146 #<module name="m_sapart.so">
2147
2148 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2149 # SAQUIT module: Adds the oper /SAQUIT command (abusable!!!)
2150 #<module name="m_saquit.so">
2151
2152 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2153 # Secure list module: Prevent /LIST in the first minute of connection,
2154 # crippling most spambots and trojan spreader bots.
2155 #<module name="m_securelist.so">
2156 #
2157 #-#-#-#-#-#-#-#-#-# SECURELIST CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#-#
2158 #                                                                     #
2159 # Securelist can be harmful to some irc search engines such as        #
2160 # netsplit.de and searchirc.com. To prevent securelist blocking these #
2161 # sites from listing, define exception tags as shown below:           #
2162 <securehost exception="*@*.searchirc.org">
2163 <securehost exception="*@*.netsplit.de">
2164 <securehost exception="*@echo940.server4you.de">
2165 #                                                                     #
2166 # Define the following variable to change how long a user must wait   #
2167 # before issuing a LIST. If not defined, defaults to 60 seconds.      #
2168 #                                                                     #
2169 #<securelist waittime="60">                                           #
2170
2171 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2172 # See nicks module: Allow for SNOMASK +N which shows nick changes.
2173 #<module name="m_seenicks.so">
2174
2175 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2176 # Set Idle module: Adds a command for opers to change their
2177 # idle time (mainly a toy)
2178 #<module name="m_setidle.so">
2179
2180 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2181 # Services support module: Adds several usermodes such as +R and +M
2182 # this module implements the 'identified' state via user mode +r, which
2183 # is similar to the DALnet and dreamforge systems.
2184 #     
2185 # N O T E!!
2186 #  >>  This CAN NOT be used at the same time as m_services_account <<
2187 # N O T E!!
2188 #<module name="m_services.so">
2189
2190 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2191 # Services support module: Adds several usermodes such as +R and +M
2192 # this module implements the 'identified' state via account names (AC)
2193 # and is similar in operation to the way asuka and ircu handle services.
2194 #                                                                       
2195 # N O T E!!
2196 #  >>  This CAN NOT be used at the same time as m_services <<
2197 # N O T E!!
2198 #<module name="m_services_account.so">
2199
2200 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2201 # Sethost module: Adds the /SETHOST command
2202 # See m_chghost for how to customise valid chars for hostnames
2203 #<module name="m_sethost.so">
2204
2205 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2206 # Setident module: Adds the /SETIDENT command
2207 #<module name="m_setident.so">
2208
2209 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2210 # SETNAME module: Adds the /SETNAME command
2211 #<module name="m_setname.so">
2212
2213 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2214 # Show Whois module: Adds the +W usermode which allows opers
2215 # to see when they are whois'ed (can be annoying).
2216 #<module name="m_showwhois.so">
2217
2218 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2219 # Spy module: Adds the commands SPYLIST and SPYNAMES that let opers
2220 # see who is in a +s channel, and list +s channels, show keys of keyed
2221 # channels the oper is not a member of etc. Like most standard 'abusive'
2222 # features of many other ircds, this is modular in InspIRCd.
2223 #<module name="m_spy.so">
2224
2225 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2226 # SSL channel mode module: Adds support for SSL-only channels (+z).
2227 # does not do anything useful without a working SSL module (see below)
2228 #<module name="m_sslmodes.so">
2229
2230 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2231 # Dummy ssl module: If you have other servers on your network which
2232 # have SSL, but your server does not have ssl enabled, you should load
2233 # this module, which will handle SSL metadata (e.g. the "Is using ssl"
2234 # field in the WHOIS information).
2235 #<module name="m_ssl_dummy.so">
2236
2237 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2238 # GnuTLS ssl module: Adds support for client-server SSL using GnuTLS,
2239 # if enabled. You must copy the source for this module from the directory
2240 # src/modules/extra, or answer 'yes' in ./configure when asked if you
2241 # want to enable this, or it will not load.
2242 #<module name="m_ssl_gnutls.so">
2243 #
2244 #-#-#-#-#-#-#-#-#-#-#-  GNUTLS CONFIGURATION   -#-#-#-#-#-#-#-#-#-#-#-#
2245 #                                                                     #
2246 # m_ssl_gnutls.so is too complex it describe here, see the wiki:      #
2247 # http://www.inspircd.org/wiki/GnuTLS_SSL_Module                      #
2248 #                                                                     #
2249 # NOTE: If you want to use this module to encrypt and sign your       #
2250 # server to server traffic, you MUST load it before m_spanningtree in #
2251 # your configuration file!                                            #
2252
2253 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2254 # SSL Info module: Allows users to retrieve information about other
2255 # user's peer SSL certificates and keys. This can be used by client
2256 # scripts to validate users. For this to work, one of m_ssl_gnutls.so
2257 # or m_ssl_openssl.so must be loaded. You must symlink the source for
2258 # this module from the directory src/modules/extra.
2259 #<module name="m_sslinfo.so">
2260
2261 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2262 # OpenSSL ssl module: Adds support for client-server SSL using OpenSSL,
2263 # if enabled. You must copy the source for this module from the directory
2264 # src/modules/extra, or answer 'yes' in ./configure when asked if you
2265 # want to enable this, or it will not load.
2266 #<module name="m_ssl_openssl.so">
2267 #
2268 #-#-#-#-#-#-#-#-#-#-#- OPENSSL CONFIGURATION   -#-#-#-#-#-#-#-#-#-#-#-#
2269 #                                                                     #
2270 # m_ssl_openssl.so is too complex it describe here, see the wiki:     #
2271 # http://www.inspircd.org/wiki/OpenSSL_SSL_Module                     #
2272 #                                                                     #
2273 # NOTE: If you want to use this module to encrypt and sign your       #
2274 # server to server traffic, you MUST load it before m_spanningtree in #
2275 # your configuration file!                                            #
2276
2277 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2278 # SSL Cert Oper module: Allows opers to oper up using the key fingerprint
2279 # stored within their SSL certificate and key pair.
2280 # When using this module, one of m_ssl_gnutls.so or m_ssl_openssl.so must
2281 # be loaded. An extra value should be added to enabled opers, which
2282 # is in the following format: fingerprint="<hash>". For more information,
2283 # see the example in the oper blocks.
2284 #<module name="m_ssl_oper_cert.so">
2285
2286 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2287 # Strip colour module: Adds the channel mode +S
2288 #<module name="m_stripcolor.so">
2289
2290 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2291 # SILENCE module: Adds support for /SILENCE
2292 #<module name="m_silence.so">
2293 #
2294 # Configuration tags:
2295 #
2296 #<silence maxentries="32">
2297 #
2298 # Sets the maximum number of entries on a users silence list.
2299
2300 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2301 # SQLite3 module: Allows other SQL modules to access SQLite3          #
2302 # databases through a unified API. You must link the source for this  #
2303 # module from the directory src/modules/extra to src/modules, plus    #
2304 # the file m_sqlv2.h                                                  #
2305 #<module name="m_sqlite3.so">
2306 #
2307 #-#-#-#-#-#-#-#-#-#-#-#- SQL CONFIGURATION   -#-#-#-#-#-#-#-#-#-#-#-#-#
2308 #                                                                     #
2309 # m_sqlite.so is more complex than described here, see the wiki for   #
2310 # more: http://www.inspircd.org/wiki/SQLite3_Service_Provider_Module  #
2311 #
2312 #<database hostname="/full/path/to/database.db" id="anytext">
2313
2314 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2315 # SQLutils module: Provides some utilities to SQL client modules, such
2316 # as mapping queries to users and channels. You must copy the source
2317 # for this module from the directory src/modules/extra/m_sqlutils.cpp
2318 # and src/modules/extra/m_sqlutils.h into /src/modules
2319 # Needed for, and loaded before: SQLauth and SQLoper
2320 #<module name="m_sqlutils.so">
2321
2322 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2323 # SQL authentication module: Allows IRCd connections to be tied into
2324 # a database table (for example a forum). You must copy the source for
2325 # this module from the directory src/modules/extra
2326 # Depends on the SQLutils module being loaded first.
2327 #<module name="m_sqlauth.so">
2328 #
2329 #-#-#-#-#-#-#-#-#-#-#- SQLAUTH CONFIGURATION   -#-#-#-#-#-#-#-#-#-#-#-#
2330 #                                                                     #
2331 # m_sqlauth.so is too complex it describe here, see the wiki:         #
2332 # http://www.inspircd.org/wiki/SQL_Authentication_Module              #
2333
2334 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2335 # SQL logging module: Allows you to log network-wide data for your
2336 # network in a fully normalised set of SQL tables. You must copy the
2337 # source for this module from the directory src/modules/extra
2338 #<module name="m_sqllog.so">
2339 #
2340 #-#-#-#-#-#-#-#-#-#-#-  SQLLOG CONFIGURATION   -#-#-#-#-#-#-#-#-#-#-#-#
2341 #                                                                     #
2342 # dbid       - Database ID to use (see m_sql)                         #
2343 #                                                                     #
2344 # See also: http://www.inspircd.org/wiki/SQL_Logging_Module           #
2345 #                                                                     #
2346 #<sqllog dbid="1">
2347
2348 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2349 # SQL oper module: Allows you to store oper credentials in an SQL table
2350 # You must copy the source for this module from the directory src/modules/extra
2351 # Depends on the SQLutils module being loaded first.
2352 #<module name="m_sqloper.so">
2353 #
2354 #-#-#-#-#-#-#-#-#-#-#- SQLOPER CONFIGURATION   -#-#-#-#-#-#-#-#-#-#-#-#
2355 #                                                                     #
2356 # dbid       - Database ID to use (see m_sql)                         #
2357 # hash       - Hashing provider to use for password hashing           #
2358 #                                                                     #
2359 # See also: http://www.inspircd.org/wiki/SQL_Oper_Storage_Module      #
2360 #                                                                     #
2361 #<sqloper dbid="1" hash="md5">
2362
2363 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2364 # SVSHold module: Implements SVSHOLD. Like Q:Lines, but can only be   #
2365 # added/removed by Services.                                          #
2366 #<module name="m_svshold.so">
2367
2368 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2369 # SWHOIS module: Allows you to add arbitary lines to user WHOIS.
2370 #<module name="m_swhois.so">
2371
2372 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2373 # Taxonomy module: Adds the /TAXONOMY command, used to view all
2374 #                  metadata attached to a user.
2375 #<module name="m_taxonomy.so">
2376
2377 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2378 # Test command module: Does nothing significant. Read: pointless.
2379 #<module name="m_testcommand.so">
2380
2381 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2382 # Timed bans module: Adds timed bans and the /TBAN command
2383 #<module name="m_timedbans.so">
2384
2385 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2386 # Test line module: Adds the /TLINE command, used to test how many
2387 # users a /GLINE or /ZLINE etc would match.
2388 #<module name="m_tline.so">
2389
2390 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2391 # UHNAMES support module: Adds support for the IRCX style UHNAMES
2392 # extension, which displays ident and hostname in the names list for
2393 # each user, saving clients from doing a WHO on the channel. Note that
2394 # this module is not widely supported yet. If a client does not support
2395 # UHNAMES it will not enable it, this will not break incompatible
2396 # clients.
2397 #<module name="m_uhnames.so">
2398
2399 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2400 # Uninvite module: Adds the /UNINVITE command which lets users remove
2401 # pending invites from channels without waiting for the user to join.
2402 #<module name="m_uninvite.so">
2403
2404 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2405 # Userip module: Adds the /USERIP command
2406 #<module name="m_userip.so">
2407
2408 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2409 # Vhost module: Adds the VHOST command which allows for adding virtual
2410 # hosts which are accessible using a username and password in the config.
2411 #<module name="m_vhost.so">
2412 #
2413 #-#-#-#-#-#-#-#-#-#-#- VHOST CONFIGURATION   -#-#-#-#-#-#-#-#-#-#-#-#-#
2414 #                                                                     #
2415 # user       - Username for the vhost.                                #
2416 #                                                                     #
2417 # pass       - Password for the vhost.                                #
2418 #                                                                     #
2419 # host       - Vhost to set.                                          #
2420 #
2421 #<vhost user="some_username" pass="some_password" host="some.host">
2422
2423 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2424 # Watch module: Adds the WATCH command, which is used by clients to 
2425 # maintain notify lists.
2426 #<module name="m_watch.so">
2427 #
2428 # Configuration tags:
2429 #
2430 #<watch maxentries="32">
2431 #
2432 # Sets the maximum number of entries on a user's watch list.
2433
2434 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2435 # XLine database: Stores all *Lines (G/Z/K/R/any added by other modules)
2436 # in a file "xline.db" which can be re-loaded on restart. This is useful
2437 # for two reasons: it keeps bans so users may not evade them, and on
2438 # bigger networks, server connections will take less time as there will
2439 # be a lot less bans to apply - as most of them will already be there.
2440 #<module name="m_xline_db.so">
2441
2442 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2443 # XMLSocket module: Adds support for connections using the shockwave
2444 # flash XMLSocket. Note that this does not work if the client you are
2445 # using has retarded ideas of the IRC protocol. Your client must still
2446 # send RFC-correct lines to the server, this module only changes the
2447 # line ending from newlines to null terminators.
2448 #
2449 #<module name="m_xmlsocket.so">
2450
2451 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2452 # ZipLinks module: Adds support for zlib deflate on server to server
2453 # connections. Both ends of the connection must load this module.
2454 #
2455 #<module name="m_ziplink.so">
2456 #
2457 # To use this module, you must enable it as a transport type in your
2458 # <link> tags or <bind> tags using the transport name 'zip'.
2459 # See the documentation of <link> and <bind>, respectively.
2460 #
2461
2462 #-#-#-#-#-#-#-#-#-#-#-#-#-#-  BAN OPTIONS  -#-#-#-#-#-#-#-#-#-#-#-#-#-#
2463 #                                                                     #
2464 # The ban tags define nick masks, host masks and ip ranges which are  #
2465 # banned from your server. All details in these tags are local to     #
2466 # Your server.                                                        #
2467 #                                                                     #
2468 #                                                                     #
2469 # badip lines ban an ip range (same as a zline)                       #
2470 #                                                                     #
2471 # ipmask       -          The ip range to ban (wildcards possible)    #
2472 #                         CIDR is supported in the IP mask.           #
2473 # reason       -          Reason to display when disconnected         #
2474 #                                                                     #
2475 # badnick lines ban a nick mask (same as a qline)                     #
2476 #                                                                     #
2477 # nick         -          Nick mask to ban (wildcards possible)       #
2478 # reason       -          Reason to display on /NICK                  #
2479 #                                                                     #
2480 # badhost lines ban a user@host mask (same as a kline)                #
2481 #                                                                     #
2482 # host         -          ident@hostname (wildcards possible)         #
2483 #                         If you specify an IP, CIDR is supported.    #
2484 # reason       -          Reason to display on disconnection          #
2485 #                                                                     #
2486 # exception lines define a hostmask that is excempt from [kzg]lines   #
2487 #                                                                     #
2488 # host         -          ident@hostname (wildcards possible)         #
2489 #                         If you specify an IP, CIDR is supported.    #
2490 # reason       -          Reason, shown only in /stats e              #
2491 #                                                                     #
2492
2493 <badip ipmask="69.69.69.69" reason="No porn here thanks.">
2494
2495 <badnick nick="ChanServ" reason="Reserved For Services">
2496 <badnick nick="NickServ" reason="Reserved For Services">
2497 <badnick nick="OperServ" reason="Reserved For Services">
2498 <badnick nick="MemoServ" reason="Reserved For Services">
2499
2500 <badhost host="*@hundredz.n.hundredz.o.1337.kiddies.com" reason="Too many 1337 kiddiots">
2501 <badhost host="*@localhost" reason="No irc from localhost!">
2502 <badhost host="*@172.32.0.0/16" reason="This subnet is bad.">
2503
2504 <exception host="*@ircop.host.com" reason="Opers hostname">
2505
2506 #-#-#-#-#-#-#-#-#-#-#- INSANE BAN OPTIONS  -#-#-#-#-#-#-#-#-#-#-#-#-#-#
2507 #                                                                     #
2508 # This optional tag allows you to specify how wide a gline, eline,    #
2509 # kline, zline or qline can be before it is forbidden from being      #
2510 # set. By setting hostmasks="yes", you can allow all G, K, E lines,   #
2511 # no matter how many users the ban would cover. This is not           #
2512 # recommended! By setting ipmasks="yes", you can allow all Z lines,   #
2513 # no matter how many users these cover too. Needless to say we        #
2514 # don't recommend you do this, or, set nickmasks="yes", which will    #
2515 # allow any qline.                                                    #
2516 #                                                                     #
2517 # The trigger value indicates how wide any mask will be before it is  #
2518 # prevented from being set. The default value is 95.5% if this tag is #
2519 # not defined in your configuration file, meaning that if your        #
2520 # network has 1000 users, a gline matching over 955 of them will be   #
2521 # prevented from being added.                                         #
2522 #                                                                     #
2523 # Please note that remote servers (and services) are exempt from      #
2524 # these restrictions and expected to enforce their own policies       #
2525 # locally!                                                            #
2526 #                                                                     #
2527
2528 <insane hostmasks="no" ipmasks="no" nickmasks="no" trigger="95.5">
2529
2530
2531 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#- YAWN  -#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2532 #                                                                     #
2533 #   You should already know what to do here :)                        #
2534
2535 <die value="User error. Insert new user and press any key. (you didn't edit your config properly.)">
2536
2537
2538 #########################################################################
2539 #                                                                       #
2540 #                     - InspIRCd Development Team -                     #
2541 #                        http://www.inspircd.org                        #
2542 #                                                                       #
2543 #########################################################################