1 ########################################################################
3 # ___ ___ ____ ____ _ #
4 # |_ _|_ __ ___ _ __|_ _| _ \ / ___|__| | #
5 # | || '_ \/ __| '_ \| || |_) | | / _` | #
6 # | || | | \__ \ |_) | || _ <| |__| (_| | #
7 # |___|_| |_|___/ .__/___|_| \_\\____\__,_| #
10 # / ___|___ _ __ / _(_) __ _ _ _ _ __ __ _| |_(_) ___ _ __ #
11 # | | / _ \| '_ \| |_| |/ _` | | | | '__/ _` | __| |/ _ \| '_ \ #
12 # | |__| (_) | | | | _| | (_| | |_| | | | (_| | |_| | (_) | | | | #
13 # \____\___/|_| |_|_| |_|\__, |\__,_|_| \__,_|\__|_|\___/|_| |_| #
16 ##################################||####################################
18 ##################################||####################################
20 # This is an example of the config file for InspIRCd. #
21 # Change the options to suit your network #
25 # ____ _ _____ _ _ ____ _ _ _ #
26 # | _ \ ___ __ _ __| | |_ _| |__ (_)___ | __ )(_) |_| | #
27 # | |_) / _ \/ _` |/ _` | | | | '_ \| / __| | _ \| | __| | #
28 # | _ < __/ (_| | (_| | | | | | | | \__ \ | |_) | | |_|_| #
29 # |_| \_\___|\__,_|\__,_| |_| |_| |_|_|___/ |____/|_|\__(_) #
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. #
36 ########################################################################
38 # Unalphabeticalise the modules list at your own risk #
40 ########################################################################
43 #-#-#-#-#-#-#-#-#-#-#-#- SERVER DESCRIPTION -#-#-#-#-#-#-#-#-#-#-#-#-
45 # Here is where you enter the information about your server. #
47 # Syntax is as follows: #
49 # <server name="server.name" #
50 # description="Server Description" #
52 # network="MyNetwork"> #
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. #
57 # The description is freeform text. Remember you may put quotes in #
58 # this field by escaping it using \". #
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. #
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- #
79 <server name="penguin.omega.org.za"
80 description="Waddle World"
84 #-#-#-#-#-#-#-#-#-#-#-#- ADMIN INFORMATION -#-#-#-#-#-#-#-#-#-#-#-#
86 # Describes the Server Administrator's real name (optionally), #
87 # nick, and email address. #
89 # Syntax is as follows: #
90 # <admin name="real name" #
92 # email="email@address.com"> #
95 <admin name="Johnny English"
97 email="MI5@the.best.secret.agent">
100 #-#-#-#-#-#-#-#-#-#-#-#- PORT CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-
102 # Enter the port and address bindings here. #
104 # bind address - Specifies which address ports bind to. Leaving this #
105 # field blank binds the port to all IP's available. #
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 #
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. #
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. #
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 # |_| \_\___|\__,_|\__,_| |_| |_| |_|_|___/ |____/|_|\__(_) #
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! #
153 # Leaving address empty binds to all available interfaces #
155 # Syntax is as follows: #
157 # <bind address="ip address" port="port" type="clients"> #
158 # <bind address="ip address" port="port" type="servers"> #
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 #
166 # ------------------------------------------------------------------- #
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. #
177 <bind address="" port="6000" type="clients">
178 <bind address="" port="6660-6669" type="clients" ssl="gnutls">
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.
184 <bind address="" port="7000,7001" type="servers">
185 <bind address="1.2.3.4" port="7005" type="servers" transport="openssl">
188 #-#-#-#-#-#-#-#-#-#- DIE/RESTART CONFIGURATION -#-#-#-#-#-#-#-#-#-#-
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. #
194 # Syntax is as follows: #
195 # <power diepass="die password" restartpass="restart password" #
196 # pause="secs before dying"> #
199 <power diepass="" restartpass="" pause="2">
202 #-#-#-#-#-#-#-#-#-# INCLUDE CONFIGURATION #-#-#-#-#-#-#-#-#-#-#-#-#-#
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. #
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. #
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. #
217 # Syntax is as follows: #
218 #<include file="file.conf"> #
219 #<include executable="/path/to/executable parameters"> #
222 #-#-#-#-#-#-#-#-#-#- CONNECTIONS CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
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. #
229 # Syntax is as follows: #
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"> #
237 # <connect name="blocked" deny="127.0.0.1" port="6667"> #
239 # <connect name="something" parent="myallow" pingfreq="60"> #
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 #
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. #
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. #
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. #
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. #
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. #
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 #
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. #
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 #
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 #
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. #
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. #
318 <connect allow="196.12.*" password="secret" port="6667">
331 <connect deny="69.254.*">
332 <connect deny="3ffe::0/32">
335 #-#-#-#-#-#-#-#-#-#-#-#- CLASS CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-
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. #
341 # Syntax is as follows: #
343 # <class name="name" commands="oper commands" #
344 # usermodes="allowed oper only usermodes" #
345 # chanmodes="allowed oper only channelmodes"> #
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 # |_| \_\___|\__,_|\__,_| |_| |_| |_|_|___/ |____/|_|\__(_) #
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! #
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) #
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="*">
376 #-#-#-#-#-#-#-#-#-#-#-#- OPERATOR COMPOSITION -#-#-#-#-#-#-#-#-#-#-#
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. #
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. #
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. #
392 # host - Optional hostmask operators will receive on oper-up. #
394 # Syntax is as follows: #
396 # <type name="name" classes="class names" host="oper hostmask"> #
398 # ____ _ _____ _ _ ____ _ _ _ #
399 # | _ \ ___ __ _ __| | |_ _| |__ (_)___ | __ )(_) |_| | #
400 # | |_) / _ \/ _` |/ _` | | | | '_ \| / __| | _ \| | __| | #
401 # | _ < __/ (_| | (_| | | | | | | | \__ \ | |_) | | |_|_| #
402 # |_| \_\___|\__,_|\__,_| |_| |_| |_|_|___/ |____/|_|\__(_) #
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! #
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">
414 #-#-#-#-#-#-#-#-#-#-#- OPERATOR CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
416 # Opers are defined here. This is a very important section. #
417 # Remember to only make operators out of trust worthy people. #
419 # name - Oper name, this is case sensitive, so it is best to #
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. #
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. #
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. #
447 # type - Defines the kind of operator. This must match a type #
448 # tag you defined above, and is case sensitive. #
450 # Syntax is as follows: #
451 # <oper name="login" #
453 # host="hostmask@of.oper" #
454 # fingerprint="hexsequence" #
455 # type="oper type"> #
460 host="ident@dialup15.isp.com *@localhost *@server.com *@3ffe::0/16"
464 #-#-#-#-#-#-#-#-#-#-#- SERVER LINK CONFIGURATION -#-#-#-#-#-#-#-#-#-#
466 # Defines which servers can link to this one, and which servers this #
467 # server may create outbound links to. #
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. #
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. #
480 # port - The TCP port for the remote server. #
482 # sendpass - Password to send to create an outbound connection #
485 # recvpass - Password to receive to accept an inbound connection #
486 # from this server. #
488 # autoconnect - Sets the server to autoconnect. Where x is the num. #
489 # (optional) of seconds between attempts. e.g. 300 = 5 minutes. #
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. #
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) #
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. #
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 #
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 #
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. #
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. #
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. #
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! #
576 # ------------------------------------------------------------------- #
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. #
586 # ------------------------------------------------------------------- #
588 # ____ _ _____ _ _ ____ _ _ _ #
589 # | _ \ ___ __ _ __| | |_ _| |__ (_)___ | __ )(_) |_| | #
590 # | |_) / _ \/ _` |/ _` | | | | '_ \| / __| | _ \| | __| | #
591 # | _ < __/ (_| | (_| | | | | | | | \__ \ | |_) | | |_|_| #
592 # |_| \_\___|\__,_|\__,_| |_| |_| |_|_|___/ |____/|_|\__(_) #
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! #
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. #
606 <link name="hub.penguin.org"
607 ipaddr="penguin.box.com"
609 allowmask="69.58.44.0/24"
611 failover="hub.other.net"
617 sendpass="outgoing!password"
618 recvpass="incoming!password">
620 <link name="services.antarctic.com"
623 allowmask="127.0.0.0/8"
625 recvpass="polarbears">
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. #
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. #
637 <uline server="services.antarctic.com" silent="yes">
640 #-#-#-#-#-#-#-#-#-#- MISCELLANEOUS CONFIGURATION -#-#-#-#-#-#-#-#-#-#
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. #
647 <files motd="inspircd.motd.example"
648 rules="inspircd.rules.example">
650 #-#-#-#-#-#-#-#-#-#-#-# MAXIMUM CHANNELS -#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
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. #
661 #-#-#-#-#-#-#-#-#-#-#-#-#-#-# DNS SERVER -#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
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. #
673 # ____ _ _____ _ _ ____ _ _ _ #
674 # | _ \ ___ __ _ __| | |_ _| |__ (_)___ | __ )(_) |_| | #
675 # | |_) / _ \/ _` |/ _` | | | | '_ \| / __| | _ \| | __| | #
676 # | _ < __/ (_| | (_| | | | | | | | \__ \ | |_) | | |_|_| #
677 # |_| \_\___|\__,_|\__,_| |_| |_| |_|_|___/ |____/|_|\__(_) #
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. #
688 # ------------------------------------------------------------------- #
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. #
696 <dns server="127.0.0.1" timeout="5">
698 # An example of using an IPv6 nameserver
699 #<dns server="::1" timeout="5">
701 #-#-#-#-#-#-#-#-#-#-#-#-#-#-# PID FILE -#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
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. #
711 #<pid file="/path/to/inspircd.pid">
713 #-#-#-#-#-#-#-#-#-#-#-#-#- BANLIST LIMITS #-#-#-#-#-#-#-#-#-#-#-#-#-#-#
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. #
723 <banlist chan="#morons" limit="128">
724 <banlist chan="*" limit="69">
726 #-#-#-#-#-#-#-#-#-#-#- DISABLED COMMANDS -#-#-#-#-#-#-#-#-#-#-#-#-#-#
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. #
736 #<disabled commands="TOPIC MODE">
739 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#- RTFM LINE -#-#-#-#-#-#-#-#-#-#-#-#-#-#
741 # Just remove this... Its here to make you read ALL of the config #
744 <die value="You should probably edit your config *PROPERLY* and try again.">
748 #-#-#-#-#-#-#-#-#-#-#-#-#- SERVER OPTIONS -#-#-#-#-#-#-#-#-#-#-#-#-#
750 # Settings to define which features are usable on your server. #
752 # prefixquit - A prefix to be placed on the start of a client's #
755 # suffixquit - A suffix to be placed on the end of a client's #
758 # fixedquit - A fixed quit message to display for all client #
759 # QUITS. If specified, overrides both prefixquit #
760 # and suffixquit options. #
762 # prefixpart - A prefix to be placed on the start of a client's #
765 # suffixpart - A suffix to be placed on the end of a client's #
768 # fixedpart - A fixed part message to display for all client #
769 # parts. If specified, overrides both prefixpart #
770 # and suffixpart options. #
772 # allowhalfop - Allows the +h channel mode #
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. #
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 #
784 # aprefix - aprefix is the same as qprefix, except it is for #
785 # giving users with mode +a (protected) a prefix #
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. #
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. #
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. #
806 # netbuffersize - Size of the buffer used to receive data from #
807 # clients. The ircd may only read() this amount #
808 # of text in one go at any time. (OPTIONAL) #
810 # maxwho - The maximum number of results returned by a /WHO #
811 # query. This is to prevent /WHO being used as a #
812 # spam vector or means of flooding an ircd. The #
813 # default is 128, it is not recommended to raise it #
814 # above 1024. Values up to 65535 are permitted. If #
815 # this value is omitted, any size WHO is allowed by #
818 # somaxconn - The maximum number of sockets that may be waiting #
819 # in the accept queue. This usually allows the ircd #
820 # to soak up more connections in a shorter space of #
821 # time when increased but please be aware there is a #
822 # system defined maximum value to this, the same way #
823 # there is a system defined maximum number of file #
824 # descriptors. Some systems may only allow this to #
825 # be up to 5 (ugh) while others such as FreeBSD will #
826 # default to a much nicer 128. #
828 # moduledir - This optional value indicates a runtime change of #
829 # the location where modules are to be found. This #
830 # does not add a supplementary directory. There can #
831 # only be one module path. #
833 # softlimit - This optional feature allows a defined softlimit. #
834 # if defined sets a soft maxconnections value, has #
835 # to be less than the ./configure maxclients #
837 # userstats - The userstats field is optional and specifies #
838 # which stats characters in /STATS may be requested #
839 # by non-operators. Stats characters in this field #
840 # are case sensitive and are allowed to users #
841 # independent of if they are in a module or the core #
843 # operspywhois - If this is set then when an IRC operator uses #
844 # /WHOIS on a user they will see all channels, even #
845 # ones if channels are secret (+s), private (+p) or #
846 # if the target user is invisible +i. #
848 # customversion - If you specify this configuration item, and it is #
849 # not set to an empty value, then when a user does #
850 # a /VERSION command on the ircd, this string will #
851 # be displayed as the second portion of the output, #
852 # replacing the system 'uname', compile flags and #
853 # socket engine/dns engine names. You may use this #
854 # to enhance security, or simply for vanity. #
856 # maxtargets - The maxtargets field is optional, and if not #
857 # defined, defaults to 20. It indicates the maximum #
858 # number of targets which may be given to commands #
859 # such as PRIVMSG, KICK etc. #
861 # hidesplits - When set to 'yes', will hide split server names #
862 # from non-opers. Non-opers will see '*.net *.split' #
863 # instead of the server names in the quit message, #
864 # identical to the way IRCu displays them. #
866 # hidebans - When set to 'yes', will hide gline, kline, zline #
867 # and qline quit messages from non-opers. For #
868 # example, user A who is not an oper will just see #
869 # (G-Lined) while user B who is an oper will see the #
870 # text (G-Lined: Reason here) instead. #
872 # hidewhois - When defined with a non-empty value, the given #
873 # text will be used in place of the user's server #
874 # in WHOIS, when a user is WHOISed by a non-oper. #
875 # For example, most nets will want to set this to #
876 # something like '*.netname.net' to conceal the #
877 # actual server the user is on. #
879 # flatlinks - When you are using m_spanningtree.so, and this #
880 # value is set to yes, true or 1, /MAP and /LINKS #
881 # will be flattened when shown to a non-opers. #
883 # hideulines - When you are using m_spanningtree.so, and this #
884 # value is set to yes, true or 1, then U-lined #
885 # servers will be hidden in /LINKS and /MAP for non #
886 # opers. Please be aware that this will also hide #
887 # any leaf servers of a U-lined server, e.g. jupes. #
889 # nouserdns - If set to yes, true or 1, no user DNS lookups #
890 # will be performed for connecting users. This can #
891 # save a lot of resources on very busy IRC servers. #
893 # syntaxhints - If set to yes, true or 1, when a user does not #
894 # give enough parameters for a command, a syntax #
895 # hint will be given (using the RPL_TEXT numeric) #
896 # as well as the standard ERR_NEEDMOREPARAMS. #
898 # announcets - If this value is defined to yes, true, or 1, then #
899 # a channels' timestamp is updated, the users on #
900 # the channel will be informed of the change via #
901 # a server notice to the channel with the old and #
902 # new TS values in the timestamp. If you think this #
903 # is just pointless noise, define the value to 0. #
905 # ircumsgprefix - Use undernet style message prefix for channel #
906 # NOTICE and PRIVMSG adding the prefix to the line #
907 # of text sent out. Eg. NOTICE @#test :@ testing #
908 # vs. the off setting: NOTICE @#test :testing #
910 # hostintopic - If this is set to yes (the default) then the full #
911 # nick!user@host is shown for who set a TOPIC last. #
912 # if set to no, then only the nickname is shown. #
915 # - If this option is set, then invites are announced #
916 # to the channel when a user invites another user. #
917 # If you consider this to be unnecessary noise, #
918 # set this to 'none'. To announce to all ops, set #
919 # this to 'ops' and to announce to all users set the #
922 # The value 'dynamic' varies between 'ops' and 'all' #
923 # settings depending on if the channel is +i or not. #
924 # When the channel is +i, messages go only to ops, #
925 # and when the channel is not +i, messages go to #
926 # everyone. In short, the messages will go to every #
927 # user who has power of INVITE on the channel. This #
928 # is the recommended setting. #
930 # disablehmac - If you are linking your InspIRCd to older versions #
931 # then you can specify this option and set it to #
932 # yes. 1.1.6 and above support HMAC and challenge- #
933 # response for password authentication. These can #
934 # greatly enhance security of your server to server #
935 # connections when you are not using SSL (as is the #
936 # case with a lot of larger networks). Linking to #
937 # older versions of InspIRCd should not *usually* be #
938 # a problem, but if you have problems with HMAC #
939 # authentication, this option can be used to turn it #
942 # hidemodes - If this option is enabled, then the listmodes #
943 # given (e.g. +eI), will be hidden from users below #
944 # halfop. This is not recommended to be set on mode #
945 # +b, as it may break some features in popular #
946 # clients such as mIRC. #
948 # quietbursts - When synching or splitting from the network, a #
949 # server can generate a lot of connect and quit #
950 # snotices to the +C and +Q snomasks. Setting this #
951 # value to yes squelches those messages, which can #
952 # make them more useful for opers, however it will #
953 # degrade their use by certain third party programs #
954 # such as BOPM which rely on them to scan users when #
955 # a split heals in certain configurations. #
957 # serverpingfreq- This value, when set, allows you to change the #
958 # frequency of server to server PING messages. This #
959 # can help if you are having certain network issues. #
961 # pingwarning - This should be set to a number between 1 and 59 if #
962 # defined, and if it is defined will cause the server#
963 # to send out a warning via snomask +l if a server #
964 # does not answer to PING after this many seconds. #
965 # This can be useful for finding servers which are #
966 # at risk of pinging out due to network issues. #
968 # exemptchanops - This option allows channel operators to be exempted#
969 # from certain channel modes. #
970 # Supported modes are +SfFgNc. Defaults to off. #
972 # defaultmodes - The default modes to be given to each channel on #
973 # creation. Defaults to 'nt'. There should be no + #
974 # or - symbols in this sequence, if you add them #
975 # they will be ignored. You may add parameters for #
976 # modes which take them. #
978 # moronbanner - The NOTICE to show to users who are glined, zlined #
979 # klined or qlined when they are disconnected. This #
980 # is totally freeform, you may place any text here #
984 <options prefixquit="Quit: "
988 netbuffersize="10240"
1019 announceinvites="dynamic"
1020 moronbanner="You're banned! Email haha@abuse.com with the ERROR line below for help."
1023 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1027 # Logging is covered with the <log> tag, which you may use to change
1028 # the behaviour of the logging of the IRCd.
1030 # In InspIRCd as of 1.2, logging is pluggable and very extensible.
1031 # Different files can log the same thing, different 'types' of log can
1032 # go to different places, and modules can even extend the log tag
1033 # to do what they want.
1035 # An example log tag would be:
1036 # <log method="file" type="OPER" level="default" target="opers.log">
1037 # which would log all information on /oper (failed and successful) to
1038 # a file called opers.log.
1040 # There are many different types which may be used, and modules may
1041 # generate their own. A list of useful types:
1042 # - USERS - information relating to user connection and disconnection
1043 # - CHANNELS - information relating to joining and parting of channels.
1044 # XXX someone doc more on this
1046 # You may also log *everything* by using a type of *, and subtract things out
1047 # of that by using -TYPE - for example "* -USERINPUT -USEROUTPUT".
1052 # I'm aware this would probably better belong in the modules section, but this
1053 # is heavily interrelated to logging, and as such will be documented here.
1055 # m_chanlog is one of the modules which can alter logging to it's own thing.
1056 # An example of this may be:
1058 #<module name="m_chanlog.so">
1059 #<log method="channel" type="OPER USERS CHANNELS" level="default" target="#services">
1061 # The following log tag is highly default and uncustomised. It is recommended you
1062 # sort out your own log tags. This is just here so you get some output.
1063 <log method="file" type="* -USERINPUT -USEROUTPUT -m_spanningtree" level="default" target="ircd.log">
1065 #-#-#-#-#-#-#-#-#-#-#-#-#- WHOWAS OPTIONS -#-#-#-#-#-#-#-#-#-#-#-#-#
1067 # This tag lets you define the behaviour of the /whowas command of #
1070 # groupsize - Controls the maximum entries per nick shown when #
1071 # performing a /whowas nick. Setting this to 0 dis- #
1072 # ables whowas completely. #
1074 # maxgroups - The maximum number of nickgroups that can be added #
1075 # to the list. If max is reached, oldest group will #
1076 # be deleted first like a FIFO. A groupsize of 3 and #
1077 # a maxgroups of 5000 will allow for 5000 nicks to #
1078 # be stored with a history of 3, thus giving a total #
1079 # of 3 * 5000 = 15000 entries. A setting of 0 dis- #
1080 # ables whowas completely. #
1082 # maxkeep - The maximum time a nick is kept in the whowas list #
1083 # before being pruned. Time may be specified in #
1084 # seconds, or in the following format: 1y2w3d4h5m6s #
1085 # meaning one year, two weeks, three days, 4 hours, #
1086 # 5 minutes and 6 seconds. All fields in this format #
1087 # are optional. Minimum is 1 hour, if less InspIRCd #
1088 # will default back to 1 hour. #
1090 #<whowas groupsize="10" #
1091 # maxgroups="100000" #
1095 #-#-#-#-#-#-#-#-#-#-#-#-#- MODULE OPTIONS -#-#-#-#-#-#-#-#-#-#-#-#-#
1097 # These tags define which modules will be loaded on startup by your #
1098 # server. Add modules without any paths. When you make your ircd #
1099 # using the 'make' command, all compiled modules will be moved into #
1100 # the folder you specified when you ran ./configure. The module tag #
1101 # automatically looks for modules in this location. #
1102 # If you attempt to load a module outside of this location, either #
1103 # in the config, or via /LOADMODULE, you will receive an error. #
1105 # By default, ALL modules are commented out. You must uncomment them #
1106 # or add lines to your config to load modules. Please refer to #
1107 # http://www.inspircd.org/wiki/Modules_List for a list of modules and#
1108 # each modules link for any additional conf tags they require. #
1110 # You may use wildcards in a <module> tag to load all modules which #
1111 # match a glob pattern (e.g. m_sa????.so would load m_sajoin, #
1112 # m_sapart, m_saquit and m_sanick) #
1114 # ____ _ _____ _ _ ____ _ _ _ #
1115 # | _ \ ___ __ _ __| | |_ _| |__ (_)___ | __ )(_) |_| | #
1116 # | |_) / _ \/ _` |/ _` | | | | '_ \| / __| | _ \| | __| | #
1117 # | _ < __/ (_| | (_| | | | | | | | \__ \ | |_) | | |_|_| #
1118 # |_| \_\___|\__,_|\__,_| |_| |_| |_|_|___/ |____/|_|\__(_) #
1120 # To link servers to InspIRCd, you MUST load the m_spanningtree #
1121 # module, as shown below. If you DO NOT do this, server links will #
1122 # NOT work at all. ie. The ports will NOT bind, and /connect will not #
1123 # work properly. This is by design, to allow for the implementation #
1124 # of other linking protocols in modules in the future. #
1126 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1127 # Spanning Tree module - allows linking of servers using the spanning
1128 # tree protocol (see the READ THIS BIT section above).
1130 #<module name="m_spanningtree.so">
1133 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1134 # MD5 Module - Allows other modules to generate MD5 hashes, usually for
1135 # cryptographic uses and security.
1138 # Other modules such as m_cloaking.so and m_opermd5.so may rely on
1139 # this module being loaded to function.
1141 #<module name="m_md5.so">
1143 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1144 # SHA256 Module - Allows other modules to generate SHA256 hashes,
1145 # usually for cryptographic uses and security.
1148 # Other modules such as m_password_hash.so may rely on this module being
1149 # loaded to function. Certain modules such as m_spanningtree.so will
1150 # function without this module but when it is loaded their features will
1151 # be enhanced (for example the addition of HMAC authentication).
1153 #<module name="m_sha256.so">
1155 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1156 # Alias module: Allows you to define server-side command aliases
1157 #<module name="m_alias.so">
1159 #-#-#-#-#-#-#-#-#-#-#- ALIAS DEFINITIONS -#-#-#-#-#-#-#-#-#-#-#-#-#-#
1161 # If you have the m_alias.so module loaded, you may also define #
1162 # aliases as shown below. They are commonly used to provide shortcut #
1163 # commands to services, however they are not limited to just this use.#
1164 # An alias tag requires the following values to be defined in it: #
1166 # text - The text to detect as the actual command line, #
1167 # Cant contain spaces, but case insensitive. #
1168 # You may have multiple aliases with the same #
1169 # command name (text="" value), however the first #
1170 # found will be executed if its format value is #
1171 # matched, or it has no format value. Aliases are #
1172 # read from the top of the file to the bottom. #
1174 # format - If this is defined, the parameters of the alias #
1175 # must match this glob pattern. For example if you #
1176 # want the first parameter to start with a # for #
1177 # the alias to be executed, set format="#*" in the #
1178 # alias definition. Note that the :'s which are #
1179 # part of IRC formatted lines will be preserved #
1180 # for matching of this text. This value is #
1183 # replace - The text to replace 'text' with. Usually this #
1184 # will be "PRIVMSG ServiceName :$2-" or similar. #
1185 # You may use the variables $1 through $9 in the #
1186 # replace string, which refer to the first through #
1187 # ninth word in the original string typed by the #
1188 # user. You may also use $1- through $9- which #
1189 # refer to the first word onwards, through to the #
1190 # ninth word onwards, e.g. if the user types the #
1191 # command "foo bar baz qux quz" then $3- will hold #
1192 # "baz qux quz" and $2 will contain "bar". You may #
1193 # also use the special variables: $nick, $ident, #
1194 # $host and $vhost, and you may separate multiple #
1195 # commands with \n. If you wish to use the ACTUAL #
1196 # characters \ and n together in a line, you must #
1197 # use the sequence "\\n". #
1199 # requires - If you provide a value for 'requires' this means #
1200 # the given nickname MUST be online for the alias #
1201 # to successfully trigger. If they are not, then #
1202 # the user receives a 'no such nick' 401 numeric. #
1204 # uline - Defining this value with 'yes', 'true' or '1' #
1205 # will ensure that the user given in 'requires' #
1206 # must also be on a u-lined server, as well as #
1207 # actually being on the network. If the user is #
1208 # online, but not on a u-lined server, then an #
1209 # oper-alert is sent out as this is possibly signs #
1210 # of a user trying to impersonate a service. #
1212 # operonly - Defining this value, with a value of 'yes', '1' #
1213 # or true will make the alias oper only. If a non- #
1214 # oper attempts to use the alias, it will appear #
1217 #<alias text="NICKSERV" replace="PRIVMSG NickServ :$2-" requires="NickServ" uline="yes">
1218 #<alias text="CHANSERV" replace="PRIVMSG ChanServ :$2-" requires="ChanServ" uline="yes">
1219 #<alias text="OPERSERV" replace="PRIVMSG OperServ :$2-" requires="OperServ" uline="yes" operonly="yes">
1220 #<alias text="NS" replace="PRIVMSG NickServ :$2-" requires="NickServ" uline="yes">
1221 #<alias text="CS" replace="PRIVMSG ChanServ :$2-" requires="ChanServ" uline="yes">
1222 #<alias text="OS" replace="PRIVMSG OperServ :$2-" requires="OperServ" uline="yes" operonly="yes">
1224 # An example of using the format value to create an alias with two
1225 # different behaviours depending on the format of the parameters.
1227 #<alias text="ID" format="#*" replace="PRIVMSG ChanServ :IDENTIFY $2 $3"
1228 # requires="ChanServ" uline="yes">
1230 #<alias text="ID" replace="PRIVMSG NickServ :IDENTIFY $2"
1231 # requires="NickServ" uline="yes">
1233 # This alias fixes a glitch in xchat 2.6.x and above and the way it
1234 # assumes IDENTIFY must be prefixed by a colon (:) character. It should
1235 # be placed ABOVE the default NICKSERV alias (the first example) listed
1238 #<alias text="NICKSERV" format=":IDENTIFY *" replace="PRIVMSG NickServ :IDENTIFY $3-"
1239 # requires="NickServ" uline="yes">
1241 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1242 # Alltime module: Shows time on all connected servers at once
1243 #<module name="m_alltime.so">
1245 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1246 # Antibear security module: Prevents 'bear.txt' based trojans from
1247 # connecting to your network by sending them a numeric they can't handle.
1248 #<module name="m_antibear.so">
1250 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1251 # Antibottler module: Labels bottler leech bots
1252 #<module name="m_antibottler.so">
1254 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1255 # Auditorium module: Adds channel mode +u which makes everyone else
1256 # except you in the channel invisible, used for large meetings etc.
1257 #<module name="m_auditorium.so">
1259 # Auditorium settings:
1261 #<auditorium showops="no" operoverride="no">
1264 # Setting this value to yes makes m_auditorium behave like unrealircd
1265 # +u channel mode, e.g. ops see users joining, parting, etc, and users
1266 # joining the channel see the ops. Without this flag, the mode acts
1267 # like ircnet's +a (anonymous channels), showing only the user in the
1268 # names list, and not even showing the ops in the list, or showing the
1269 # ops that the user has joined.
1271 # Setting this value to yes makes m_auditorium affect the userlist for
1272 # regular users only. Opers will view all users in the channel normally.
1274 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1275 # Ban except module: Adds support for channel ban exceptions (+e)
1276 #<module name="m_banexception.so">
1278 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1279 # Ban redirection module: Allows bans which redirect to a specified
1280 # channel. e.g. +b nick!ident@host#channelbanneduserissentto
1281 #<module name="m_banredirect.so">
1283 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1284 # Block amsg module: Attempt to block all usage of /amsg and /ame
1285 #<module name="m_blockamsg.so">
1287 #-#-#-#-#-#-#-#-#-#-#- BLOCKAMSG CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
1289 # If you have the m_blockamsg.so module loaded, you can configure it #
1290 # with the <blockamsg> tag: #
1292 # delay - How many seconds between two messages to force #
1293 # them to be recognised as unrelated. #
1294 # action - Any of 'notice', 'noticeopers', 'silent', 'kill' #
1295 # or 'killopers'. Define how to take action when #
1296 # a user uses /amsg or /ame. #
1298 #<blockamsg delay="3" action="killopers">
1300 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1301 # Block CAPS module: Blocking all-CAPS messages with cmode +B
1302 #<module name="m_blockcaps.so">
1304 #-#-#-#-#-#-#-#-#-#-#- BLOCKCAPS CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
1306 # percent - How many percent of text must be caps before text #
1307 # will be blocked. #
1309 # minlen - The minimum length a line must be for the block #
1310 # percent to have any effect. #
1312 # capsmap - A list of chars to be considered CAPS, this was #
1313 # you can add CAPS for your language. Also you can #
1314 # add things like ! and space to further lock down #
1316 #<blockcaps percent="50"
1318 # capsmap="ABCDEFGHIJKLMNOPQRSTUVWXYZ! ">
1320 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1321 # Block colour module: Blocking colour-coded messages with cmode +c
1322 #<module name="m_blockcolor.so">
1324 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1325 # Botmode module: Adds the user mode +B
1326 #<module name="m_botmode.so">
1328 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1329 # CallerID module: Adds usermode +g which activates hybrid-style
1330 # callerid (== block all private messages unless you /accept first)
1331 #<module name="m_callerid.so">
1333 #-#-#-#-#-#-#-#-#-#-#- CALLERID CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#
1334 # maxaccepts - Maximum number of entires a user can add to his #
1335 # /accept list. Default is 16 entries. #
1336 # operoverride - Can opers (note: ALL opers) ignore callerid mode? #
1338 # tracknick - Preserve /accept entries when a user changes nick? #
1339 # If no (the default), the user is removed from #
1340 # everyone's accept list if he changes nickname. #
1341 # cooldown - Amount of time (in seconds) that must pass since #
1342 # the last notification sent to a user before he can #
1343 # be sent another. Default is 60 (1 minute). #
1344 #<callerid maxaccepts="16"
1349 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1350 # CBAN module: Lets you disallow channels from being used at runtime.
1351 #<module name="m_cban.so">
1353 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1354 # Censor module: Adds the channel mode +G
1355 #<module name="m_censor.so">
1357 #-#-#-#-#-#-#-#-#-#-#- CENSOR CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#
1359 # Optional - If you specify to use the m_censor module, then you must #
1360 # specify some censor tags. See also: #
1361 # http://www.inspircd.org/wiki/Censor_Module #
1363 #<include file="censor.conf">
1365 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1366 # CGI:IRC module: Adds support for automatic host changing in CGI:IRC
1367 # (http://cgiirc.sourceforge.net).
1368 #<module name="m_cgiirc.so">
1370 #-#-#-#-#-#-#-#-#-#-#-# CGIIRC CONFIGURATION #-#-#-#-#-#-#-#-#-#-#-#-#
1372 # Optional - If you specify to use m_cgiirc, then you must specify one
1373 # or more cgihost tags which indicate authorised CGI:IRC servers which
1374 # will be connecting to your network, and an optional cgiirc tag.
1375 # For more information see: http://www.inspircd.org/wiki/CGI-IRC_Module
1377 # Set to yes if you want to notice opers when CGI clients connect
1378 # <cgiirc opernotice="no">
1380 # The type field indicates where the module should get the real
1381 # client's IP address from, for further information, please see the
1382 # CGI:IRC documentation.
1385 # <cgihost type="pass" mask="www.mysite.com"> # Get IP from PASS
1386 # <cgihost type="ident" mask="otherbox.mysite.com"> # Get IP from ident
1387 # <cgihost type="passfirst" mask="www.mysite.com"> # See the docs
1389 # <cgihost type="webirc" pass="foobar"
1390 # mask="somebox.mysite.com"> # Get IP from WEBIRC
1395 # When you connect CGI:IRC clients, there are two connect classes which
1396 # apply to these clients. When the client initially connects, the connect
1397 # class which matches the cgi:irc site's host is checked. Therefore you
1398 # must raise the maximum local/global clients for this ip as high as you
1399 # want to allow cgi clients. After the client has connected and is
1400 # determined to be a cgi:irc client, the class which matches the client's
1401 # real IP is then checked. You may set this class to a lower value, so that
1402 # the real IP of the client can still be restricted to, for example, 3
1407 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1408 # Channel create module: Adds snomask +j, which will notify opers of
1409 # any new channels that are created
1410 #<module name="m_chancreate.so">
1412 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1413 # Channel filter module: Allows channel-op defined message
1414 # filtering using simple string matches (channel mode +g)
1415 #<module name="m_chanfilter.so">
1417 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1418 # Chanprotect module: gives +q and +a channel modes
1419 #<module name="m_chanprotect.so">
1421 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1422 # Check module: gives /check
1423 # Check is useful for looking up information on channels,
1424 # users, IP addresses and hosts.
1425 #<module name="m_check.so">
1427 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1428 # CHGHOST module: Adds the /CHGHOST command
1429 #<module name="m_chghost.so">
1431 #-#-#-#-#-#-#-#-# /CHGHOST - /SETHOST CONFIGURATION #-#-#-#-#-#-#-#-#
1432 # Optional - If you want to use special chars for hostnames you can #
1433 # specify your own custom list of chars with the <hostname> tag: #
1435 # charmap - A list of chars accepted as valid by the /CHGHOST #
1436 # and /SETHOST commands. Also note that the list is #
1438 #<hostname charmap="abcdefghijklmnopqrstuvwxyz.-_/0123456789">
1440 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1441 # CHGIDENT module: Adds the /CHGIDENT command
1442 #<module name="m_chgident.so">
1444 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1445 # CHGNAME module: Adds the /CHGNAME command
1446 #<module name="m_chgname.so">
1448 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1449 # Cloaking module: Adds usermode +x and cloaking support.
1450 # Relies on the module m_md5.so being loaded before m_cloaking.so in
1451 # the configuration file.
1452 #<module name="m_cloaking.so">
1454 #-#-#-#-#-#-#-#-#-#-#- CLOAKING CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#
1456 # Optional - If you specify the m_cloaking.so module as above, you #
1457 # must define cloak keys, and optionally a cloak prefix as shown #
1458 # below. When using cloaking, the cloak keys are MANDITORY and must #
1459 # be included. However, if prefix is not included, it will default #
1460 # to your networks name from the <server> tag. You can also include #
1461 # the following optional values: #
1463 # ipalways - Always cloak the IP address, not the hostname, #
1464 # which doesn't reveal the user's ISP, but #
1465 # results in hosts that are harder to read and #
1468 # lowercase - Display the cloaked hostnames in lowercase #
1469 # characters instead of uppercase #
1471 # <cloak key1="0x2AF39F40" #
1472 # key2="0x78E10B32" #
1473 # key3="0x4F2D2E82" #
1474 # key4="0x043A4C81" #
1476 # ipalways="false" #
1477 # lowercase="false"> #
1479 # Please note that the key values will accept any number, and should #
1480 # be large numbers. Using small numbers such as "7" or "1924" will #
1481 # seriously weaken the security of your cloak. It is recommended you #
1482 # use hexdecimal numbers prefixed by "0x", as shown in this example, #
1483 # with each key eight hex digits long. #
1485 #-#-#-#-#-#-#-#-#-#-#-#- CLOSE MODULE #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1486 # Close module: Allows an oper to close all unregistered connections.
1487 #<module name="m_close.so">
1489 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1490 # Clones module: Adds an oper command /CLONES for detecting cloned
1491 # users. Warning: This module may be resource intensive when its
1492 # command is issued, use with care.
1493 #<module name="m_clones.so">
1495 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1496 # Common channels module: Adds user mode +c, which, when set, requires
1497 # that users must share a common channel with you to PRIVMSG or NOTICE
1499 #<module name="m_commonchans.so">
1501 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1502 # Conn-Join: Allows you to force users to join one or more channels
1503 # automatically upon connecting to the server.
1504 #<module name="m_conn_join.so">
1506 #-#-#-#-#-#-#-#-#-#-#-#- CONNJOIN CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
1508 # If you have m_conn_join.so loaded, you can configure it using the
1511 #<autojoin channel="#one,#two,#three">
1513 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1514 # Conn-Usermodes: Set modes on users when they connect
1515 # When this module is loaded <connect:allow> tags may have an optional
1516 # modes="" value, which contains modes to add or remove from users
1517 # when they connect to the server.
1518 #<module name="m_conn_umodes.so">
1520 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1521 # Conn-Wait-for-Pong: Don't let a user connect until they PONG
1522 #<module name="m_conn_waitpong.so">
1524 #-#-#-#-#-#-#-#-#-#-#- WAITPONG CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
1526 # If you have the m_conn_waitpong.so module loaded, configure it with #
1527 # the <waitpong> tag: #
1529 # sendsnotice - Whether to send a snotice on connect, like other #
1532 # killonbadreply - Whether to kill the user if they send the wrong #
1535 #<waitpong sendsnotice="yes" killonbadreply="yes">
1538 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1539 # Channel cycle module. Server side /hop, with +ilk etc bypass.
1540 #<module name="m_cycle.so">
1542 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1543 # Connection throttle module. Configuration:
1544 #<module name="m_connflood.so">
1546 #-#-#-#-#-#-#-#-#-#-#- CONTHROTTLE CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
1547 # seconds, maxconns - Amount of connections per <seconds>.
1549 # timeout - Time to wait after the throttle was activated
1550 # before deactivating it. Be aware that the time
1551 # is seconds + timeout.
1553 # quitmsg - The message that users get if they attempt to
1554 # connect while the throttle is active.
1556 # bootwait - Amount of time to wait before enforcing the
1557 # throttling when the server just booted.
1559 #<connflood seconds="30" maxconns="3" timeout="30"
1560 # quitmsg="Throttled" bootwait="10">
1562 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1563 # Custom title module: Adds the /TITLE command which allows for trusted
1564 # users to gain a custom whois line and a optional
1565 # vhost can be specified.
1566 #<module name="m_customtitle.so">
1568 #-#-#-#-#-#-#-#-#-#- CUSTOM TITLE CONFIGURATION -#-#-#-#-#-#-#-#-#-#
1569 # name - The username used to identify
1570 # password - The password used to identify
1571 # host - Allowed hostmask [optional]
1572 # title - Title shown in whois
1573 # vhost - Displayed host [optional]
1575 #<title name="foo" password="bar" title="Official Chat Helper">
1576 #<title name="bar" password="foo" host="ident@host.name" title="Official Chat Helper" vhost="helper.network.chat">
1578 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1579 # DCCALLOW module: Adds the /DCCALLOW command
1580 #<module name="m_dccallow.so">
1582 #-#-#-#-#-#-#-#-#-#-#- DCCALLOW CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
1583 # blockchat - Whether to block DCC CHAT as well as DCC SEND
1584 # length - Default duration of entries in DCCALLOW list
1585 # action - Default action to take if no action is specified
1586 # can be 'block' or 'allow'
1588 # File configuration:
1589 # pattern - The glob pattern to match against
1590 # action - Action to take if a user attempts to send a file
1591 # that matches this pattern, can be 'block' or 'allow'
1593 #<dccallow blockchat="yes" length="5m" action="block">
1594 #<banfile pattern="*.exe" action="block">
1595 #<banfile pattern="*.txt" action="allow">
1597 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1599 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1600 # Deaf module: adds support for ircu style usermode +d - deaf to
1601 # channel messages and channel notices.
1602 #<module name="m_deaf.so">
1604 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1605 # Delay join module: Adds the channel mode +D which delays all JOIN
1606 # messages from users until they speak. If they quit or part before
1607 # speaking, their quit or part message will not be shown to the channel
1608 # which helps cut down noise on large channels in a more friendly way
1609 # than the auditorium mode. Only channel ops may set the +D mode.
1610 #<module name="m_delayjoin.so">
1612 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1613 # Deny Channels: Deny Channels from being used by users
1614 #<module name="m_denychans.so">
1616 #-#-#-#-#-#-#-#-#-#-#- DENYCHAN DEFINITIONS -#-#-#-#-#-#-#-#-#-#-#-#
1618 # If you have the m_denychans.so module loaded, you need to specify #
1619 # the channels to deny: #
1621 # name - The channel name to deny. (glob masks are ok) #
1623 # allowopers - If operators are allowed to override the deny. #
1625 # reason - Reason given for the deny. #
1627 # redirect - Redirect the user to a different channel #
1629 #<badchan name="#gods*" allowopers="yes" reason="Tortoises!"> #
1630 #<badchan name="#heaven" redirect="#hell" reason="Nice try!"> #
1632 # Redirects will not work if the target channel is set +L. #
1634 # Additionally, you may specify channels which are allowed, even if #
1635 # a badchan tag specifies it would be denied: #
1636 #<goodchan name="#godsleeps"> #
1637 # Glob masks are accepted here also.
1639 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1640 # Devoice Module: Let users devoice themselves.
1641 #<module name="m_devoice.so">
1643 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1644 # DNS Blacklist Module: Provides support for looking up IPs on one or #
1645 # more blacklists. #
1646 #<module name="m_dnsbl.so"> #
1648 # For configuration options please see the wiki page for m_dnsbl at #
1649 # http://inspircd.org/wiki/DNS_Blacklist_Module #
1651 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1652 # Filter module: Provides glob-based message filtering
1653 #<module name="m_filter.so">
1655 # PCRE filter module: Filters messages using regular expressions
1656 #<module name="m_filter_pcre.so">
1658 # You may only use one or the other with these modules, network-wide.
1660 #-#-#-#-#-#-#-#-#-#-#- FILTER CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#
1662 # Optional - If you specify to use the m_filter or m_filter_pcre #
1663 # modules, then specfiy below the path to the filter.conf file, #
1664 # or define some <filter> tags. #
1666 #<include file="filter.conf">
1668 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1669 # Foobar module: does nothing - historical relic
1670 #<module name="m_foobar.so">
1672 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1673 # GeoIP module: Allows the server admin to ban users by country code.
1674 #<module name="m_geoip.so">
1676 #-#-#-#-#-#-#-#-#-#-#-# GEOIP CONFIGURATION #-#-#-#-#-#-#-#-#-#-#-#-#
1678 # <geoip banunknown="false"> #
1680 # Set this value to true or yes to block unknown IP ranges which are #
1681 # not in the database (usually LAN addresses, localhost, etc) #
1683 # <geoban country="TR" reason="This country not permitted"> #
1685 # Use one or more of these tags to ban countries by country code. #
1686 # The country code must be in capitals and should be an ISO country #
1687 # code such as TR, GB, or US. #
1689 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1690 # Globops module: gives /GLOBOPS and usermode +g
1691 #<module name="m_globops.so">
1693 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1694 # Global load module: Allows loading and unloading of modules network-
1695 # wide (USE WITH EXTREME CAUTION!)
1696 #<module name="m_globalload.so">
1698 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1699 # HELPOP module: Provides the /HELPOP command
1700 #<module name="m_helpop.so">
1702 #-#-#-#-#-#-#-#-#-#-#-#- HELPOP CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
1704 # Optional - If you specify to use the m_helpop.so module, then #
1705 # specify below the path to the helpop.conf file, or if you like to #
1706 # make a mess, define your helpop tags in this conf. #
1708 #<include file="helpop.conf">
1710 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1711 # HIDECHANS module: Allows opers to hide their channels list from non-
1712 # opers by setting user mode +I on themselves.
1713 # <module name="m_hidechans.so">
1715 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1716 # HIDEOPER module: Allows opers to hide their oper status from non-
1717 # opers by setting user mode +H on themselves.
1718 # <module name="m_hideoper.so">
1720 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1721 # Hostchange module: Allows a different style of cloaking
1722 #<module name="m_hostchange.so">
1724 #-#-#-#-#-#-#-#-#-#-#- HOSTCHANGE CONFIGURATION -#-#-#-#-#-#-#-#-#-#
1726 # Optional - If you choose to use the m_hostchange.so module. #
1727 # Config Help - See http://www.inspircd.org/wiki/Host_Changer_Module #
1729 #<host suffix="polarbears.org" separator="." prefix="">
1730 #<hostchange mask="*@fbi.gov" action="addnick">
1731 #<hostchange mask="*r00t@*" action="suffix">
1732 #<hostchange mask="a@b.com" action="set" value="blah.blah.blah">
1733 #<hostchange mask="localhost" ports="7000,7001,7005-7007" action="set" value="blahblah.foo">
1735 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1736 # httpd module: Provides http server support for InspIRCd
1737 #<module name="m_httpd.so">
1739 #-#-#-#-#-#-#-#-#-#-#-#- HTTPD CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
1741 # Optional - If you choose to use the m_httpd.so module, then you must
1742 # specify the port number and other details of your http server:
1744 #<http ip="192.168.1.10" host="brainwave" port="32006"
1745 # index="/home/brain/inspircd/http/index.html">
1747 # You may have as many of these tags as you wish, each with a different
1748 # IP, port, host or index file. Each one will act as an independent
1752 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1753 # http stats module: Provides basic stats pages over HTTP
1754 # Requires m_httpd.so to be loaded for it to function.
1755 #<module name="m_httpd_stats.so">
1757 #-#-#-#-#-#-#-#-#-#-#-#- HTTPD STATS CONFIGURATION -#-#-#-#-#-#-#-#-#-#
1759 #<httpstats stylesheet="http://remote.style/sheet.css">
1762 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1763 # Ident: Provides RFC 1413 ident lookup support
1764 #<module name="m_ident.so">
1766 #-#-#-#-#-#-#-#-#-#-#-#- IDENT CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
1768 # Optional - If you are using the m_ident.so module, then you can #
1769 # specify the timeout for ident lookups here. If not defined, it will #
1770 # default to one second. This is a non-blocking timeout which holds #
1771 # the user in a 'connecting' state until the lookup is complete. #
1772 # The bind value indicates which IP to bind outbound requests to. #
1774 #<ident timeout="5" bind="">
1776 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1777 # Invite except module: Adds support for channel invite exceptions (+I)
1778 #<module name="m_inviteexception.so">
1780 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1781 # Invisible module - Adds support for usermode +Q (quiet) which lets an
1782 # oper go 'invisible' similar to unrealircd 3.1's +I mode. Note that
1783 # opers are still able to see invisible users, and if an oper with +Q
1784 # deopers, they will become visible.
1786 # IMPORTANT NOTE: To allow this mode to be used by a type of oper, you
1787 # must first add the value canquiet="yes" to that oper's type tag.
1789 #<module name="m_invisible.so">
1791 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1792 # Join flood module: Adds support for join flood protection (+j)
1793 #<module name="m_joinflood.so">
1795 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1796 # Jump Server module: Adds support for the RPL_REDIR numeric
1797 #<module name="m_jumpserver.so">
1799 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1800 # Anti-Auto-Rejoin: Adds support for prevention of auto-rejoin (+J)
1801 #<module name="m_kicknorejoin.so">
1803 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1804 # Knock module: adds the /KNOCK command and +K channel mode
1805 #<module name="m_knock.so">
1807 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1808 # LDAP authentication module: Adds the ability to authenticate users #
1809 # via LDAP. This is an extra module which must be enabled explicitly #
1810 # by symlinking it from modules/extra, and requires the OpenLDAP libs #
1812 #<module name="m_ldapauth.so"> #
1816 # <ldapauth baserdn="ou=People,dc=brainbox,dc=cc" #
1818 # server="ldap://brainwave.brainbox.cc" #
1819 # allowpattern="Guest*" #
1820 # killreason="Access denied" #
1821 # searchscope="subtree" #
1822 # binddn="cn=Manager,dc=brainbox,dc=cc" #
1823 # bindauth="mysecretpass" #
1826 # The baserdn indicates the base DN to search in for users. Usually #
1827 # this is 'ou=People,dc=yourdomain,dc=yourtld'. #
1829 # The attribute value indicates the attribute which is used to locate #
1830 # a user account by name. On POSIX systems this is usually 'uid'. #
1832 # The server parameter indicates the LDAP server to connect to. The #
1833 # ldap:// style scheme before the hostname proper is MANDITORY. #
1835 # The allowpattern value allows you to specify a wildcard mask which #
1836 # will always be allowed to connect regardless of if they have an #
1837 # account, for example guest users. #
1839 # Killreason indicates the QUIT reason to give to users if they fail #
1840 # to authenticate. #
1842 # The searchscope value indicates the subtree to search under. On our #
1843 # test system this is 'subtree'. Your mileage may vary. #
1845 # Setting the verbose value causes an oper notice to be sent out for #
1846 # every failed authentication to the server, with an error string. #
1848 # The binddn and bindauth indicate the DN to bind to for searching, #
1849 # and the password for the distinguished name. Some LDAP servers will #
1850 # allow anonymous searching in which case these two values do not #
1851 # need defining, otherwise they should be set similar to the examples #
1854 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1855 # Lock server module: Adds /LOCKSERV and /UNLOCKSERV commands that is #
1856 # used to temporarily close/open for new connections to the server. #
1857 # These commands require OPER status and that the LOCKSERV UNLOCKSERV #
1858 # are specified in a <class> tag that the oper is part of. This is so #
1859 # you can control who has access to this possible dangerous command. #
1860 # If your server is locked and you got disconnected, do a REHASH from #
1861 # shell to open up again.
1862 #<module name="m_lockserv.so">
1864 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1865 # Msg flood module: Adds message/notice flood protection (+f)
1866 #<module name="m_messageflood.so">
1868 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1869 # MsSQL module: Allows other SQL modules to access MS SQL Server
1870 # through a unified API. You must copy the source for this module
1871 # from the directory src/modules/extra, plus the file m_sqlv2.h
1872 #<module name="m_mssql.so">
1874 #-#-#-#-#-#-#-#-#-#-#-#- SQL CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#-#
1876 # m_mssql.so is more complex than described here, see wiki for more #
1877 # info http://www.inspircd.org/wiki/SQLServer_Service_Provider_Module #
1879 #<database name="db" username="user" password="pass" hostname="localhost" id="db1">
1881 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1882 # MySQL module: Allows other SQL modules to access MySQL databases
1883 # through a unified API. You must copy the source for this module
1884 # from the directory src/modules/extra, plus the file m_sqlv2.h
1885 #<module name="m_mysql.so">
1887 #-#-#-#-#-#-#-#-#-#-#-#- SQL CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#-#
1889 # m_mysql.so is more complex than described here, see the wiki for #
1890 # more: http://www.inspircd.org/wiki/SQL_Service_Provider_Module #
1892 #<database name="mydb" username="myuser" password="mypass" hostname="localhost" id="my_database2">
1894 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1895 # NAMESX module: Provides support for the NAMESX extension which allows
1896 # clients to see all the prefixes set on a user without getting confused.
1897 # This is supported by mIRC, x-chat, klient, and maybe more.
1898 #<module name="m_namesx.so">
1900 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1901 # Nickban: Implements extended ban n:, which stops anyone matching
1902 # a mask like +b n:nick!user@host from changing their nick on channel.
1903 #<module name="m_nickban.so">
1906 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1907 # Nickchange flood protection module: Allows up to X nick changes in Y seconds.
1908 # Provides channel mode +F.
1909 #<module name="m_nickflood.so">
1911 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1912 # Nicklock module: Let opers change a user's nick and then stop that
1913 # user from changing their nick again.
1914 #<module name="m_nicklock.so">
1916 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1917 # No ctcp module: Adds the channel mode +C to block CTCPs
1918 #<module name="m_noctcp.so">
1920 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1921 # Noinvite module: Gives channel mode +V
1922 #<module name="m_noinvite.so">
1924 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1925 # No kicks module: Adds the +Q channel mode
1926 #<module name="m_nokicks.so">
1928 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1929 # No nicks module: Adds the +N channel mode
1930 #<module name="m_nonicks.so">
1932 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1933 # No Notice module: adds the channel mode +T
1934 #<module name="m_nonotice.so">
1936 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1937 # Oper channels mode: Adds the +O channel mode
1938 #<module name="m_operchans.so">
1940 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1941 # Oper Join module: Forces opers to join a channel on oper-up
1942 #<module name="m_operjoin.so">
1944 #-#-#-#-#-#-#-#-#-#-# OPERJOIN CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
1946 # If you are using the m_operjoin.so module, specify options here: #
1948 # channel - The channel name to join, can also be a comma #
1949 # seperated list eg. "#channel1,#channel2". #
1951 # override - Lets the oper join walking thru any modes that #
1952 # might be set, even bans. Use "yes" or "no". #
1954 #<operjoin channel="#channel" override="no">
1956 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1957 # Oper MOTD module: Provides support for seperate message of the day
1959 #<module name="m_opermotd.so">
1961 #-#-#-#-#-#-#-#-#-#-# OPERMOTD CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
1963 # If you are using the m_opermotd.so module, specify the motd here #
1965 #<opermotd file="oper.motd">
1967 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1968 # Override module: Adds support for oper override
1969 #<module name="m_override.so">
1971 #-#-#-#-#-#-#-#-#-#-# OVERRIDE CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
1973 # m_override.so is too complex it describe here, see the wiki: #
1974 # http://www.inspircd.org/wiki/Oper_Override_Module #
1976 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1977 # Oper levels module: Gives each oper a level and prevents
1978 # actions being taken against higher level opers
1979 # Specify the level as the 'level' parameter of the <type> tag
1980 #<module name="m_operlevels.so">
1982 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1983 # Oper modes module: Allows you to specify modes to add/remove on oper
1984 # Specify the modes as the 'modes' parameter of the <type> tag
1985 # and/or as the 'modes' parameter of the <oper> tag.
1986 #<module name="m_opermodes.so">
1988 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1989 # Oper password hash module: Allows hashed oper passwords
1990 # Relies on the module m_md5.so and/or m_sha256.so being loaded before
1991 # m_password_hash.so in the configuration file.
1992 #<module name="m_password_hash.so">
1994 #-#-#-#-#-#-#-#-#-#-# OPER HASH CONFIGURATION #-#-#-#-#-#-#-#-#-#-#-#-#
1996 # To use this module, you must define a hash type for each oper's
1997 # password you want to hash. For example:
1999 # <oper name="Brain"
2000 # host="ident@dialup15.isp.com"
2002 # password="a41d730937a53b79f788c0ab13e9e1d5"
2005 # The types of hashing available vary depending on which hashing modules
2006 # you load, but usually if you load m_sha256.so and m_md5.so, both md5
2007 # and sha256 type hashing will be available (the most secure of which
2010 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2011 # Permanent Channels module: Channels with the permanent channels mode
2012 # will remain open even after everyone else has left the channel, and
2013 # therefore keep things like modes, ban lists and topic. Permanent
2014 # channels -may- need support from your Services package to function
2015 # properly with them. This adds channel mode +P.
2016 #<module name="m_permchannels.so">
2018 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2019 # PostgreSQL module: Allows other SQL modules to access PgSQL databases
2020 # through a unified API. You must copy the source for this module
2021 # from the directory src/modules/extra, plus the file m_sqlv2.h
2022 #<module name="m_pgsql.so">
2024 #-#-#-#-#-#-#-#-#-#-#-#- SQL CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#-#
2026 # m_pgsql.so is more complex than described here, see the wiki for #
2027 # more: http://www.inspircd.org/wiki/SQL_Service_Provider_Module #
2029 #<database name="mydb" username="myuser" password="mypass" hostname="localhost" id="my_database" ssl="no">
2031 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2032 # Quietban: Implements extended ban q:, which stops anyone matching
2033 # a mask like +b q:nick!user@host from speaking on channel.
2034 #<module name="m_quietban.so">
2037 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2038 # Quitban: Provides per-IP connection throttling. Any IP that disconnects
2039 # too many times (configurable) in an hour is zlined for a (configurable)
2040 # duration, and their count resets to 0.
2042 # NOTE: This module may change name/behaviour later in 1.2. Please make sure
2043 # you read release announcements!
2045 #<quitban threshold="10" duration="10m">
2046 # This allows for 10 quits in an hour with a 10 minute ban if that is exceeded.
2048 #<module name="m_quitban.so">
2050 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2051 # Random Quote module: provides a random quote on connect.
2052 # NOTE: Some of these may mimic fatal errors and confuse users and
2053 # opers alike! - BEWARE!
2054 #<module name="m_randquote.so">
2056 #-#-#-#-#-#-#-#-#-#- RANDOMQUOTES CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#
2058 # Optional - If you specify to use the m_randquote.so module, then #
2059 # specify below the path to the randquotes.conf file. #
2061 #<randquote file="randquotes.conf">
2063 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2064 # Redirect module: Adds channel redirection (mode +L)
2065 #<module name="m_redirect.so">
2067 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2068 # Registered users only channel creation
2069 # Allows only registered users and opers to create new channels.
2070 #<module name="m_regonlycreate.so">
2072 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2073 # Remove module: Adds the /REMOVE command which is a peaceful
2074 # alternative to /KICK
2075 #<module name="m_remove.so">
2077 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2078 # Restrict banned users module:
2079 # Disallows banned users on a channel from messaging the channel,
2080 # changing nick, or changing the topic, if loaded.
2081 #<module name="m_restrictbanned.so">
2083 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2084 # Restricted channels module: Allows only opers to create channels
2085 #<module name="m_restrictchans.so">
2087 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2088 # Restrict message module: Allows users to only message opers
2089 #<module name="m_restrictmsg.so">
2091 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2092 # Ban users through regular expression patterns
2093 #<module name="m_rline.so">
2095 #-#-#-#-#-#-#-#-#-#-#-#- RLINE CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#-#
2096 # If you wish to re-check a user when they change nickname (can be
2097 # useful under some situations, but *can* also use CPU with more users
2098 # on a server) then set the following configuration value:
2099 #<rline matchonnickchange="yes">
2101 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2102 # Provide /LIST throttling (to prevent flooding) and /LIST safety to
2103 # prevent excess flood when the list is large.
2104 #<module name="m_safelist.so">
2106 #-#-#-#-#-#-#-#-#-#-# SAFELIST CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#-#
2108 # When using Safelist, you may set the following values;
2110 # The first value, 'throttle', sets the amount of time in seconds a user
2111 # must wait between LIST commands. For example, if this is set to 60
2112 # (the default) then the user may not /LIST more than once a minute.
2113 # If not defined, the default value is 60 seconds.
2115 # The second value, 'maxlisters', indicates the maximum number of users
2116 # which may be retrieving a LIST at once. It is not recommended you raise
2117 # this value, as increasing it too high can make your network vulnerable
2118 # to floodbots which waste your bandwidth and CPU time with LIST requests.
2120 #<safelist throttle="60" maxlisters="50">
2122 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2123 # SAJOIN module: Adds the /SAJOIN command
2124 #<module name="m_sajoin.so">
2126 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2127 # SAMODE module: Adds the oper /SAMODE command
2128 #<module name="m_samode.so">
2130 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2131 # SANICK module: Allows opers to change user's nicks
2132 #<module name="m_sanick.so">
2134 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2135 # SAPART module: Adds the oper /SAPART command
2136 #<module name="m_sapart.so">
2138 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2139 # SAQUIT module: Adds the oper /SAQUIT command (abusable!!!)
2140 #<module name="m_saquit.so">
2142 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2143 # Secure list module: Prevent /LIST in the first minute of connection,
2144 # crippling most spambots and trojan spreader bots.
2145 #<module name="m_securelist.so">
2147 #-#-#-#-#-#-#-#-#-# SECURELIST CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#-#
2149 # Securelist can be harmful to some irc search engines such as #
2150 # netsplit.de and searchirc.com. To prevent securelist blocking these #
2151 # sites from listing, define exception tags as shown below: #
2152 <securehost exception="*@*.searchirc.org">
2153 <securehost exception="*@*.netsplit.de">
2154 <securehost exception="*@echo940.server4you.de">
2156 # Define the following variable to change how long a user must wait #
2157 # before issuing a LIST. If not defined, defaults to 60 seconds. #
2159 #<securelist waittime="60"> #
2161 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2162 # See nicks module: Allow for SNOMASK +N which shows nick changes.
2163 #<module name="m_seenicks.so">
2165 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2166 # Set Idle module: Adds a command for opers to change their
2167 # idle time (mainly a toy)
2168 #<module name="m_setidle.so">
2170 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2171 # Services support module: Adds several usermodes such as +R and +M
2172 # this module implements the 'identified' state via user mode +r, which
2173 # is similar to the DALnet and dreamforge systems.
2176 # >> This CAN NOT be used at the same time as m_services_account <<
2178 #<module name="m_services.so">
2180 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2181 # Services support module: Adds several usermodes such as +R and +M
2182 # this module implements the 'identified' state via account names (AC)
2183 # and is similar in operation to the way asuka and ircu handle services.
2186 # >> This CAN NOT be used at the same time as m_services <<
2188 #<module name="m_services_account.so">
2190 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2191 # Sethost module: Adds the /SETHOST command
2192 # See m_chghost for how to customise valid chars for hostnames
2193 #<module name="m_sethost.so">
2195 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2196 # Setident module: Adds the /SETIDENT command
2197 #<module name="m_setident.so">
2199 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2200 # SETNAME module: Adds the /SETNAME command
2201 #<module name="m_setname.so">
2203 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2204 # Show Whois module: Adds the +W usermode which allows opers
2205 # to see when they are whois'ed (can be annoying).
2206 #<module name="m_showwhois.so">
2208 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2209 # Spy module: Adds the commands SPYLIST and SPYNAMES that let opers
2210 # see who is in a +s channel, and list +s channels, show keys of keyed
2211 # channels the oper is not a member of etc. Like most standard 'abusive'
2212 # features of many other ircds, this is modular in InspIRCd.
2213 #<module name="m_spy.so">
2215 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2216 # SSL channel mode module: Adds support for SSL-only channels (+z).
2217 # does not do anything useful without a working SSL module (see below)
2218 #<module name="m_sslmodes.so">
2220 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2221 # Dummy ssl module: If you have other servers on your network which
2222 # have SSL, but your server does not have ssl enabled, you should load
2223 # this module, which will handle SSL metadata (e.g. the "Is using ssl"
2224 # field in the WHOIS information).
2225 #<module name="m_ssl_dummy.so">
2227 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2228 # GnuTLS ssl module: Adds support for client-server SSL using GnuTLS,
2229 # if enabled. You must copy the source for this module from the directory
2230 # src/modules/extra, or answer 'yes' in ./configure when asked if you
2231 # want to enable this, or it will not load.
2232 #<module name="m_ssl_gnutls.so">
2234 #-#-#-#-#-#-#-#-#-#-#- GNUTLS CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#
2236 # m_ssl_gnutls.so is too complex it describe here, see the wiki: #
2237 # http://www.inspircd.org/wiki/GnuTLS_SSL_Module #
2239 # NOTE: If you want to use this module to encrypt and sign your #
2240 # server to server traffic, you MUST load it before m_spanningtree in #
2241 # your configuration file! #
2243 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2244 # SSL Info module: Allows users to retrieve information about other
2245 # user's peer SSL certificates and keys. This can be used by client
2246 # scripts to validate users. For this to work, one of m_ssl_gnutls.so
2247 # or m_ssl_openssl.so must be loaded. You must symlink the source for
2248 # this module from the directory src/modules/extra.
2249 #<module name="m_sslinfo.so">
2251 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2252 # OpenSSL ssl module: Adds support for client-server SSL using OpenSSL,
2253 # if enabled. You must copy the source for this module from the directory
2254 # src/modules/extra, or answer 'yes' in ./configure when asked if you
2255 # want to enable this, or it will not load.
2256 #<module name="m_ssl_openssl.so">
2258 #-#-#-#-#-#-#-#-#-#-#- OPENSSL CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#
2260 # m_ssl_openssl.so is too complex it describe here, see the wiki: #
2261 # http://www.inspircd.org/wiki/OpenSSL_SSL_Module #
2263 # NOTE: If you want to use this module to encrypt and sign your #
2264 # server to server traffic, you MUST load it before m_spanningtree in #
2265 # your configuration file! #
2267 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2268 # SSL Cert Oper module: Allows opers to oper up using the key fingerprint
2269 # stored within their SSL certificate and key pair.
2270 # When using this module, one of m_ssl_gnutls.so or m_ssl_openssl.so must
2271 # be loaded. An extra value should be added to enabled opers, which
2272 # is in the following format: fingerprint="<hash>". For more information,
2273 # see the example in the oper blocks.
2274 #<module name="m_ssl_oper_cert.so">
2276 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2277 # Strip colour module: Adds the channel mode +S
2278 #<module name="m_stripcolor.so">
2280 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2281 # SILENCE module: Adds support for /SILENCE
2282 #<module name="m_silence.so">
2284 # Configuration tags:
2286 #<silence maxentries="32">
2288 # Sets the maximum number of entries on a users silence list.
2290 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2291 # SQLite3 module: Allows other SQL modules to access SQLite3 #
2292 # databases through a unified API. You must link the source for this #
2293 # module from the directory src/modules/extra to src/modules, plus #
2294 # the file m_sqlv2.h #
2295 #<module name="m_sqlite3.so">
2297 #-#-#-#-#-#-#-#-#-#-#-#- SQL CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#-#
2299 # m_sqlite.so is more complex than described here, see the wiki for #
2300 # more: http://www.inspircd.org/wiki/SQLite3_Service_Provider_Module #
2302 #<database hostname="/full/path/to/database.db" id="anytext">
2304 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2305 # SQLutils module: Provides some utilities to SQL client modules, such
2306 # as mapping queries to users and channels. You must copy the source
2307 # for this module from the directory src/modules/extra/m_sqlutils.cpp
2308 # and src/modules/extra/m_sqlutils.h into /src/modules
2309 # Needed for, and loaded before: SQLauth and SQLoper
2310 #<module name="m_sqlutils.so">
2312 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2313 # SQL authentication module: Allows IRCd connections to be tied into
2314 # a database table (for example a forum). You must copy the source for
2315 # this module from the directory src/modules/extra
2316 # Depends on the SQLutils module being loaded first.
2317 #<module name="m_sqlauth.so">
2319 #-#-#-#-#-#-#-#-#-#-#- SQLAUTH CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#
2321 # m_sqlauth.so is too complex it describe here, see the wiki: #
2322 # http://www.inspircd.org/wiki/SQL_Authentication_Module #
2324 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2325 # SQL logging module: Allows you to log network-wide data for your
2326 # network in a fully normalised set of SQL tables. You must copy the
2327 # source for this module from the directory src/modules/extra
2328 #<module name="m_sqllog.so">
2330 #-#-#-#-#-#-#-#-#-#-#- SQLLOG CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#
2332 # dbid - Database ID to use (see m_sql) #
2334 # See also: http://www.inspircd.org/wiki/SQL_Logging_Module #
2338 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2339 # SQL oper module: Allows you to store oper credentials in an SQL table
2340 # You must copy the source for this module from the directory src/modules/extra
2341 # Depends on the SQLutils module being loaded first.
2342 #<module name="m_sqloper.so">
2344 #-#-#-#-#-#-#-#-#-#-#- SQLOPER CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#
2346 # dbid - Database ID to use (see m_sql) #
2347 # hash - Hashing provider to use for password hashing #
2349 # See also: http://www.inspircd.org/wiki/SQL_Oper_Storage_Module #
2351 #<sqloper dbid="1" hash="md5">
2353 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2354 # SVSHold module: Implements SVSHOLD. Like Q:Lines, but can only be #
2355 # added/removed by Services. #
2356 #<module name="m_svshold.so">
2358 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2359 # SWHOIS module: Allows you to add arbitary lines to user WHOIS.
2360 #<module name="m_swhois.so">
2362 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2363 # Taxonomy module: Adds the /TAXONOMY command, used to view all
2364 # metadata attached to a user.
2365 #<module name="m_taxonomy.so">
2367 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2368 # Test command module: Does nothing significant. Read: pointless.
2369 #<module name="m_testcommand.so">
2371 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2372 # Timed bans module: Adds timed bans and the /TBAN command
2373 #<module name="m_timedbans.so">
2375 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2376 # Test line module: Adds the /TLINE command, used to test how many
2377 # users a /GLINE or /ZLINE etc would match.
2378 #<module name="m_tline.so">
2380 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2381 # UHNAMES support module: Adds support for the IRCX style UHNAMES
2382 # extension, which displays ident and hostname in the names list for
2383 # each user, saving clients from doing a WHO on the channel. Note that
2384 # this module is not widely supported yet. If a client does not support
2385 # UHNAMES it will not enable it, this will not break incompatible
2387 #<module name="m_uhnames.so">
2389 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2390 # Uninvite module: Adds the /UNINVITE command which lets users remove
2391 # pending invites from channels without waiting for the user to join.
2392 #<module name="m_uninvite.so">
2394 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2395 # Userip module: Adds the /USERIP command
2396 #<module name="m_userip.so">
2398 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2399 # Vhost module: Adds the VHOST command which allows for adding virtual
2400 # hosts which are accessible using a username and password in the config.
2401 #<module name="m_vhost.so">
2403 #-#-#-#-#-#-#-#-#-#-#- VHOST CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#-#
2405 # user - Username for the vhost. #
2407 # pass - Password for the vhost. #
2409 # host - Vhost to set. #
2411 #<vhost user="some_username" pass="some_password" host="some.host">
2413 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2414 # Watch module: Adds the WATCH command, which is used by clients to
2415 # maintain notify lists.
2416 #<module name="m_watch.so">
2418 # Configuration tags:
2420 #<watch maxentries="32">
2422 # Sets the maximum number of entries on a user's watch list.
2424 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2425 # XLine database: Stores all *Lines (G/Z/K/R/any added by other modules)
2426 # in a file "xline.db" which can be re-loaded on restart. This is useful
2427 # for two reasons: it keeps bans so users may not evade them, and on
2428 # bigger networks, server connections will take less time as there will
2429 # be a lot less bans to apply - as most of them will already be there.
2430 #<module name="m_xline_db.so">
2432 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2433 # XMLSocket module: Adds support for connections using the shockwave
2434 # flash XMLSocket. Note that this does not work if the client you are
2435 # using has retarded ideas of the IRC protocol. Your client must still
2436 # send RFC-correct lines to the server, this module only changes the
2437 # line ending from newlines to null terminators.
2439 #<module name="m_xmlsocket.so">
2441 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2442 # ZipLinks module: Adds support for zlib deflate on server to server
2443 # connections. Both ends of the connection must load this module.
2445 #<module name="m_ziplink.so">
2447 # To use this module, you must enable it as a transport type in your
2448 # <link> tags or <bind> tags using the transport name 'zip'.
2449 # See the documentation of <link> and <bind>, respectively.
2452 #-#-#-#-#-#-#-#-#-#-#-#-#-#- BAN OPTIONS -#-#-#-#-#-#-#-#-#-#-#-#-#-#
2454 # The ban tags define nick masks, host masks and ip ranges which are #
2455 # banned from your server. All details in these tags are local to #
2459 # badip lines ban an ip range (same as a zline) #
2461 # ipmask - The ip range to ban (wildcards possible) #
2462 # CIDR is supported in the IP mask. #
2463 # reason - Reason to display when disconnected #
2465 # badnick lines ban a nick mask (same as a qline) #
2467 # nick - Nick mask to ban (wildcards possible) #
2468 # reason - Reason to display on /NICK #
2470 # badhost lines ban a user@host mask (same as a kline) #
2472 # host - ident@hostname (wildcards possible) #
2473 # If you specify an IP, CIDR is supported. #
2474 # reason - Reason to display on disconnection #
2476 # exception lines define a hostmask that is excempt from [kzg]lines #
2478 # host - ident@hostname (wildcards possible) #
2479 # If you specify an IP, CIDR is supported. #
2480 # reason - Reason, shown only in /stats e #
2483 <badip ipmask="69.69.69.69" reason="No porn here thanks.">
2485 <badnick nick="ChanServ" reason="Reserved For Services">
2486 <badnick nick="NickServ" reason="Reserved For Services">
2487 <badnick nick="OperServ" reason="Reserved For Services">
2488 <badnick nick="MemoServ" reason="Reserved For Services">
2490 <badhost host="*@hundredz.n.hundredz.o.1337.kiddies.com" reason="Too many 1337 kiddiots">
2491 <badhost host="*@localhost" reason="No irc from localhost!">
2492 <badhost host="*@172.32.0.0/16" reason="This subnet is bad.">
2494 <exception host="*@ircop.host.com" reason="Opers hostname">
2496 #-#-#-#-#-#-#-#-#-#-#- INSANE BAN OPTIONS -#-#-#-#-#-#-#-#-#-#-#-#-#-#
2498 # This optional tag allows you to specify how wide a gline, eline, #
2499 # kline, zline or qline can be before it is forbidden from being #
2500 # set. By setting hostmasks="yes", you can allow all G, K, E lines, #
2501 # no matter how many users the ban would cover. This is not #
2502 # recommended! By setting ipmasks="yes", you can allow all Z lines, #
2503 # no matter how many users these cover too. Needless to say we #
2504 # don't recommend you do this, or, set nickmasks="yes", which will #
2505 # allow any qline. #
2507 # The trigger value indicates how wide any mask will be before it is #
2508 # prevented from being set. The default value is 95.5% if this tag is #
2509 # not defined in your configuration file, meaning that if your #
2510 # network has 1000 users, a gline matching over 955 of them will be #
2511 # prevented from being added. #
2513 # Please note that remote servers (and services) are exempt from #
2514 # these restrictions and expected to enforce their own policies #
2518 <insane hostmasks="no" ipmasks="no" nickmasks="no" trigger="95.5">
2520 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#- YAWN -#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
2522 # You should already know what to do here :) #
2524 <die value="User error. Insert new user and press any key. (you didn't edit your config properly.)">
2527 #########################################################################
2529 # - InspIRCd Development Team - #
2530 # http://www.inspircd.org #
2532 #########################################################################
projects / user / henk / code / inspircd.git / blob