]> git.netwichtig.de Git - user/henk/code/inspircd.git/blob - docs/conf/inspircd.conf.example
Move <performance:nouserdns> to <connect:nouserdns>.
[user/henk/code/inspircd.git] / docs / conf / inspircd.conf.example
1 ########################################################################
2 #                                                                      #
3 #               ___                ___ ____   ____    _                #
4 #              |_ _|_ __  ___ _ __|_ _|  _ \ / ___|__| |               #
5 #               | || '_ \/ __| '_ \| || |_) | |   / _` |               #
6 #               | || | | \__ \ |_) | ||  _ <| |__| (_| |               #
7 #              |___|_| |_|___/ .__/___|_| \_\\____\__,_|               #
8 #                            |_|                                       #
9 #      ____             __ _                       _   _               #
10 #     / ___|___  _ __  / _(_) __ _ _   _ _ __ __ _| |_(_) ___  _ __    #
11 #    | |   / _ \| '_ \| |_| |/ _` | | | | '__/ _` | __| |/ _ \| '_ \   #
12 #    | |__| (_) | | | |  _| | (_| | |_| | | | (_| | |_| | (_) | | | |  #
13 #     \____\___/|_| |_|_| |_|\__, |\__,_|_|  \__,_|\__|_|\___/|_| |_|  #
14 #                            |___/                                     #
15 #                                                                      #
16 ##################################||####################################
17                                  #||#                                   
18 ##################################||####################################
19 #                                                                      #
20 #         This is an example of the config file for InspIRCd.          #
21 #             Change the options to suit your network                  #
22 #                                                                      #
23 #                                                                      #
24 #    ____                _   _____ _     _       ____  _ _   _         #
25 #   |  _ \ ___  __ _  __| | |_   _| |__ (_)___  | __ )(_) |_| |        #
26 #   | |_) / _ \/ _` |/ _` |   | | | '_ \| / __| |  _ \| | __| |        #
27 #   |  _ <  __/ (_| | (_| |   | | | | | | \__ \ | |_) | | |_|_|        #
28 #   |_| \_\___|\__,_|\__,_|   |_| |_| |_|_|___/ |____/|_|\__(_)        #
29 #                                                                      #
30 #   Lines prefixed with READ THIS BIT, as shown above, are IMPORTANT   #
31 #   lines, and you REALLY SHOULD READ THEM. Yes, THIS MEANS YOU. Even  #
32 #   if you've configured InspIRCd before, these probably indicate      #
33 #   something new or different to this version and you SHOULD READ IT. #
34 #                                                                      #
35 ########################################################################
36 #                                                                      #
37 #         Unalphabeticalise the modules list at your own risk          #
38 #                                                                      #
39 ########################################################################
40
41 #-#-#-#-#-#-#-#-#-#  CONFIGURATION FORMAT  #-#-#-#-#-#-#-#-#-#-#-#-#-#-
42 #                                                                     #
43 # In order to maintain compatibility with older configuration files,  #
44 # you can change the configuration parser to parse as it did in       #
45 # previous releases. When using the "compat" format, you need to use  #
46 # C++ escape sequences (e.g. \n) instead of XML ones (e.g. &nl;) and  #
47 # can not use <define> to create macros.                              #
48 #<config format="compat">
49
50 #-#-#-#-#-#-#-#-#-#  INCLUDE CONFIGURATION  #-#-#-#-#-#-#-#-#-#-#-#-#-#
51 #                                                                     #
52 # This optional tag allows you to include another config file         #
53 # allowing you to keep your configuration tidy. The configuration     #
54 # file you include will be treated as part of the configuration file  #
55 # which includes it, in simple terms the inclusion is transparent.    #
56 #                                                                     #
57 # All paths to config files are relative to the directory that the    #
58 # process runs in.                                                    #
59 #                                                                     #
60 # You may also include an executable file, in which case if you do so #
61 # the output of the executable on the standard output will be added   #
62 # to your config at the point of the include tag.                     #
63 #                                                                     #
64 # Syntax is as follows:                                               #
65 #<include file="file.conf">                                           #
66 #<include executable="/path/to/executable parameters">                #
67 #                                                                     #
68 # Executable Include Example:                                         #
69 #<include executable="/usr/bin/wget -q -O - http://mynet.net/inspircd.conf">
70 #                                                                     #
71
72
73 #-#-#-#-#-#-#-#-#-#-#-#  VARIABLE DEFINITIONS  -#-#-#-#-#-#-#-#-#-#-#-#
74 #                                                                     #
75 # You can define variables that will be substituted later in the      #
76 # configuration file. This can be useful to allow settings to be      #
77 # easily changed, or to parameterize a remote includes.               #
78 #                                                                     #
79 # Variables may be redefined and may reference other variables.       #
80 # Value expansion happens at the time the tag is read.                #
81 <define name="bindip" value="1.2.2.3">
82 <define name="localips" value="&bindip;/24">
83
84 #-#-#-#-#-#-#-#-#-#-#-#-  SERVER DESCRIPTION  -#-#-#-#-#-#-#-#-#-#-#-#-
85 #                                                                     #
86 #   Here is where you enter the information about your server.        #
87 #                                                                     #
88
89 <server
90         # name: Hostname of your server. Does not need to resolve, but
91         # does need to be correct syntax (something.somethingelse.tld).
92         name="penguin.omega.org.za"
93
94         # description: Server description. Spaces are allowed.
95         description="Waddle World"
96
97         # id: The SID to use for this server. This should not be uncommented
98         # unless there is a SID conflict. This must be three characters long.
99         # The first character must be a digit [0-9], the remaining two chars
100         # may be letters [A-Z] or digits.
101         #id="97K"
102
103         # network: Network name given on connect to clients.
104         # Should be the same on all servers on the network and
105         # not contain spaces.
106         network="Omega">
107
108
109 #-#-#-#-#-#-#-#-#-#-#-#-   ADMIN INFORMATION   -#-#-#-#-#-#-#-#-#-#-#-#
110 #                                                                     #
111 #   Describes the Server Administrator's real name (optionally),      #
112 #   nick, and email address.                                          #
113 #                                                                     #
114
115 <admin
116        # name: Real Name
117        name="Johnny English"
118
119        # nick: Nickname (preferably what you use on the network)
120        nick="MI5"
121
122        # email: email address. Does not have to be valid
123        # but should be for the users to be able to contact you.
124        email="MI5@the.best.secret.agent">
125
126
127 #-#-#-#-#-#-#-#-#-#-#-#-   PORT CONFIGURATION   -#-#-#-#-#-#-#-#-#-#-#-
128 #                                                                     #
129 #   Enter the port and address bindings here.                         #
130 #                                                                     #
131 #                                                                     #
132 #    ____                _   _____ _     _       ____  _ _   _        #
133 #   |  _ \ ___  __ _  __| | |_   _| |__ (_)___  | __ )(_) |_| |       #
134 #   | |_) / _ \/ _` |/ _` |   | | | '_ \| / __| |  _ \| | __| |       #
135 #   |  _ <  __/ (_| | (_| |   | | | | | | \__ \ | |_) | | |_|_|       #
136 #   |_| \_\___|\__,_|\__,_|   |_| |_| |_|_|___/ |____/|_|\__(_)       #
137 #                                                                     #
138 #  If you want to link servers to InspIRCd you must load the          #
139 #  m_spanningtree.so module! Please see the modules list below for    #
140 #  information on how to load this module! If you do not load this    #
141 #  module, server ports will NOT be bound!                            #
142 #                                                                     #
143 # PLEASE NOTE: If you have build InspIRCd with IPv6 support, you MUST #
144 # specify a bind address if you want the IRCd to bind to a IPv4 IP.   #
145
146 <bind
147       # address: IP address to bind to if the box that you are hosting
148       # on has more than one IP, else the ircd will try to bind to all
149       # IP's on the box if this is not defined.
150       address=""
151
152       # port: Port for users or servers to be able to connect to.
153       # you can select multiple ports by separating them
154       # with a - character like the example below.
155       port="6697"
156
157       # type: Type of bind block this is. It can either be clients or
158       # servers. Whichever you select will be the only type able to connect
159       # to this bind section.
160       type="clients"
161
162       # ssl: If you want this bind section to use SSL, define either
163       # gnutls or openssl here. The appropriate SSL modules must be loaded
164       # for ssl to work. If you do not want this bind section to support ssl,
165       # just remove or comment out this option.
166       ssl="gnutls"
167 >
168
169 <bind address="" port="6660-6669" type="clients">
170
171 # When linking servers, the openssl and gnutls implementations are completely
172 # link-compatible and can be used alongside each other
173 # on each end of the link without any significant issues.
174 # Supported ssl types are: "openssl" and "gnutls".
175 # You must load, m_ssl_openssl for openssl
176 # or m_ssl_gnutls for gnutls.
177
178 <bind address="" port="7000,7001" type="servers">
179 <bind address="1.2.3.4" port="7005" type="servers" ssl="openssl">
180
181
182 #-#-#-#-#-#-#-#-#-#-  DIE/RESTART CONFIGURATION   -#-#-#-#-#-#-#-#-#-#-
183 #                                                                     #
184 #   You can configure the passwords here which you wish to use for    #
185 #   the die and restart commands. Only trusted IRCop's who will       #
186 #   need this ability should know the die and restart password.       #
187 #                                                                     #
188
189 <power
190        # hash: what hash these passwords are hashed with. requires the module
191        # for selected hash (m_md5.so, m_sha256.so or m_ripemd160.so) be
192        # loaded and the password hashing module (m_password_hash.so)
193        # loaded. Options here are: "md5", "sha256" and "ripemd160".
194        # Optional, but recommended. Create hashed password with:
195        # /mkpasswd <hash> <password>
196        #hash="sha256"
197
198        # diepass: Password for opers to use if they need to shutdown (die)
199        # a server.
200        diepass=""
201
202        # restartpass: Password for opers to use if they need to restart
203        # a server.
204        restartpass="">
205
206
207 #-#-#-#-#-#-#-#-#-#-  CONNECTIONS CONFIGURATION  -#-#-#-#-#-#-#-#-#-#-#
208 #                                                                     #
209 #   This is where you can configure which connections are allowed     #
210 #   and denied access onto your server. The password is optional.     #
211 #   You may have as many of these as you require. To allow/deny all   #
212 #   connections, use a '*' or 0.0.0.0/0.                              #
213 #                                                                     #
214 #  -- It is important to note that connect tags are read from the  -- #
215 #     TOP DOWN. This means that you should have more specific deny    #
216 #    and allow tags at the top, progressively more general, followed  #
217 #        by a <connect allow="*" (should you wish to have one).       #
218 #                                                                     #
219 # Connect blocks are searched twice for each user - once when the TCP #
220 # connection is accepted, and once when the user completes their      #
221 # registration. Most of the information (hostname, ident response,    #
222 # password, SSL when using STARTTLS, etc) is only available during    #
223 # the second search, so if you are trying to make a closed server,    #
224 # you will probably need a connect block just for user registration.  #
225 # This can be done by using <connect registered="no">                 #
226
227 <connect
228          # deny: Will not let people connect if they have specified host/IP.
229          deny="69.254.*">
230
231 # connect:reason is the message that users will see if they match a deny block
232 <connect deny="3ffe::0/32" reason="The 6bone address space is deprecated">
233
234 <connect
235          # name: Name to use for this connect block. Mainly used for
236          # connect class inheriting.
237          name="secret"
238
239          # parent: This setting is to specify if this connect class
240          # inherits settings from any other. Put the other class's name
241          # in here to use its settings as a template - for example,  if
242          # you only want to adjust sendq and a password
243          parent="main"
244
245          # allow: What IP addresses/hosts to allow for this block.
246          allow="196.12.*"
247
248          # hash: what hash this password is hashed with. requires the module
249          # for selected hash (m_md5.so, m_sha256.so or m_ripemd160.so) be
250          # loaded and the password hashing module (m_password_hash.so)
251          # loaded. Options here are: "md5", "sha256" and "ripemd160".
252          # Optional, but recommended. Create hashed password with:
253          # /mkpasswd <hash> <password>
254          #hash="sha256"
255
256          # password: Password to use for this block/user(s)
257          password="secret"
258
259          # maxchans: Maximum number of channels a user in this class
260          # be in at one time. This overrides every other maxchans setting.
261          #maxchans="30"
262
263          # timeout: How long (in seconds) the server will wait before
264          # disconnecting a user if they do not do anything on connect.
265          # (Note, this is a client-side thing, if the client does not
266          # send /nick, /user or /pass)
267          timeout="10"
268
269          # localmax: Maximum local connections per IP (or CIDR mask, see below).
270          localmax="3"
271
272          # globalmax: Maximum global (network-wide) connections per IP (or CIDR mask, see below).
273          globalmax="3"
274
275          # maxconnwarn: Enable warnings when localmax or globalmax is hit (defaults to on)
276          maxconnwarn="off"
277
278          # nouserdns: If enabled, no DNS lookups will be performed on connecting users
279          # in this class. This can save a lot of resources on very busy servers.
280          nouserdns="no"
281
282          # usednsbl: Defines whether or not users in this class are subject to DNSBL. Default is yes.
283          # This setting only has effect when m_dnsbl is loaded.
284          #usednsbl="yes"
285
286          # useident: Defines if users in this class MUST respond to a ident query or not.
287          useident="no"
288
289          # limit: How many users are allowed in this class
290          limit="5000"
291
292          # modes: Usermodes that are set on users in this block on connect.
293          # Enabling this option requires that the m_conn_umodes module be loaded.
294          # This entry is highly recommended to use for/with IP Cloaking/masking.
295          # For the example to work, this also requires that the m_cloaking
296          # module be loaded as well.
297          modes="+x"
298
299          # requireident, requiressl, requireaccount: require that users of this
300          # block have a valid ident response, use SSL, or have authenticated.
301          # Requires m_ident, m_sslinfo, or m_services_account respectively.
302          requiressl="on"
303          # NOTE: For requireaccount, you must complete the signon prior to full
304          # connection. Currently, this is only possible by using SASL
305          # authentication; passforward and PRIVMSG NickServ happen after
306          # your final connect block has been found.
307
308          # Alternate MOTD file for this connect class. The contents of this file are
309          # specified using <files secretmotd="filename"> or <execfiles ...>
310          motd="secretmotd"
311
312          # Allow color codes to be processed in the message of the day file.
313          # the following characters are valid color code escapes:
314          #   \002 or \b = Bold
315          #   \037 or \u = Underline
316          #   \003 or \c = Color (with a code postfixed to this char)
317          #   \017 or \x = Stop all color sequences
318          allowmotdcolors="false"
319
320          # port: What port this user is allowed to connect on. (optional)
321          # The port MUST be set to listen in the bind blocks above.
322          port="6697">
323
324 <connect
325          # name: Name to use for this connect block. Mainly used for
326          # connect class inheriting.
327          name="main"
328
329          # allow: What IP addresses/hosts to allow for this block.
330          allow="*"
331
332          # maxchans: Maximum number of channels a user in this class
333          # be in at one time. This overrides every other maxchans setting.
334          #maxchans="30"
335
336          # timeout: How long (in seconds) the server will wait before
337          # disconnecting a user if they do not do anything on connect.
338          # (Note, this is a client-side thing, if the client does not
339          # send /nick, /user or /pass)
340          timeout="10"
341
342          # pingfreq: How often (in seconds) the server tries to ping connecting clients.
343          pingfreq="120"
344
345          # hardsendq: maximum amount of data allowed in a client's send queue
346          # before they are dropped. Keep this value higher than the length of
347          # your network's /LIST or /WHO output, or you will have lots of
348          # disconnects from sendq overruns!
349          hardsendq="1048576"
350
351          # softsendq: amount of data in a client's send queue before the server
352          # begins delaying their commands in order to allow the sendq to drain
353          softsendq="8192"
354
355          # recvq: amount of data allowed in a client's queue before they are dropped.
356          recvq="8192"
357
358          # threshold: This specifies the amount of command penalty a user is allowed to have
359          # before being quit or fakelagged due to flood. Normal commands have a penalty of 1,
360          # ones such as /OPER have penalties up to 10.
361          #
362          # If you are not using fakelag, this should be at least 20 to avoid excess flood kills
363          # from processing some commands.
364          threshold="10"
365
366          # commandrate: This specifies the maximum rate that commands can be processed.
367          # If commands are sent more rapidly, the user's penalty will increase and they will
368          # either be fakelagged or killed when they reach the threshold
369          #
370          # Units are millicommands per second, so 1000 means one line per second.
371          commandrate="1000"
372
373          # fakelag: Use fakelag instead of killing users for excessive flood
374          #
375          # Fake lag stops command processing for a user when a flood is detected rather than
376          # immediately killing them; their commands are held in the recvq and processed later
377          # as the user's command penalty drops. Note that if this is enabled, flooders will
378          # quit with "RecvQ exceeded" rather than "Excess Flood".
379          fakelag="on"
380
381          # localmax: Maximum local connections per IP.
382          localmax="3"
383
384          # globalmax: Maximum global (network-wide) connections per IP.
385          globalmax="3"
386
387          # nouserdns: If enabled, no DNS lookups will be performed on connecting users
388          # in this class. This can save a lot of resources on very busy servers.
389          nouserdns="no"
390
391          # useident: Defines if users in this class must respond to a ident query or not.
392          useident="no"
393
394          # limit: How many users are allowed in this class
395          limit="5000"
396
397          # modes: Usermodes that are set on users in this block on connect.
398          # Enabling this option requires that the m_conn_umodes module be loaded.
399          # This entry is highly recommended to use for/with IP Cloaking/masking.
400          # For the example to work, this also requires that the m_cloaking
401          # module be loaded as well.
402          modes="+x">
403
404
405 #-#-#-#-#-#-#-#-#-#-#-#-  CIDR CONFIGURATION   -#-#-#-#-#-#-#-#-#-#-#-
406 #                                                                     #
407 # CIDR configuration allows detection of clones and applying of       #
408 # throttle limits across a CIDR range. (A CIDR range is a group of    #
409 # IPs, for example, the CIDR range 192.168.1.0-192.168.1.255 may be   #
410 # represented as 192.168.1.0/24). This means that abuse across an ISP #
411 # is detected and curtailed much easier. Here is a good chart that    #
412 # shows how many IPs the different CIDRs correspond to:               #
413 # http://en.wikipedia.org/wiki/CIDR#Prefix_aggregation                #
414 #                                                                     #
415
416 <cidr
417       # ipv4clone: specifies how many bits of an IP address should be
418       # looked at for clones. The default only looks for clones on a
419       # single IP address of a user. You do not want to set this
420       # extremely low. (Values are 0-32).
421       ipv4clone="32"
422
423       # ipv6clone: specifies how many bits of an IP address should be
424       # looked at for clones. The default only looks for clones on a
425       # single IP address of a user. You do not want to set this
426       # extremely low. (Values are 0-128).
427       ipv6clone="128">
428
429 # This file has all the information about oper classes, types and o:lines.
430 # You *MUST* edit it.
431 <include file="conf/examples/opers.conf.example">
432
433 # This file has all the information about server links and ulined servers.
434 # You *MUST* edit it if you intend to link servers.
435 <include file="conf/examples/links.conf.example">
436
437 #-#-#-#-#-#-#-#-#-#-  MISCELLANEOUS CONFIGURATION  -#-#-#-#-#-#-#-#-#-#
438 #                                                                     #
439
440 # Files block - contains files whose contents are used by the ircd
441 #
442 #   motd - displayed on connect and when a user executes /MOTD
443 #   rules - displayed when the user executes /RULES
444 # Modules can also define their own files
445 <files motd="conf/examples/motd.txt.example" rules="conf/examples/rules.txt.example">
446
447 # Example of an executable file include. Note this will be read on rehash,
448 # not when the command is run.
449 #<execfiles rules="wget -O - http://www.example.com/rules.txt">
450
451 #-#-#-#-#-#-#-#-#-#-#-# MAXIMUM CHANNELS -#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
452 #                                                                     #
453
454 <channels
455           # users: Maximum number of channels a user can be in at once.
456           users="20"
457
458           # opers: Maximum number of channels a oper can be in at once.
459           opers="60">
460
461 #-#-#-#-#-#-#-#-#-#-#-#-#-#-# DNS SERVER -#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
462 # If these values are not defined, InspIRCd uses the default DNS resolver
463 # of your system.
464
465 <dns
466      # server: DNS server to use to attempt to resolve IP's to hostnames.
467      # in most cases, you won't need to change this, as inspircd will
468      # automatically detect the nameserver depending on /etc/resolv.conf
469      # (or, on windows, your set nameservers in the registry.)
470      # Note that this must be an IP address and not a hostname, because
471      # there is no resolver to resolve the name until this is defined!
472      #
473      # server="127.0.0.1"
474
475      # timeout: seconds to wait to try to resolve DNS/hostname.
476      timeout="5">
477
478 # An example of using an IPv6 nameserver
479 #<dns server="::1" timeout="5">
480
481 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#  PID FILE  -#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
482 #                                                                     #
483 # Define the path to the PID file here. The PID file can be used to   #
484 # rehash the ircd from the shell or to terminate the ircd from the    #
485 # shell using shell scripts, perl scripts, etc... and to monitor the  #
486 # ircd's state via cron jobs. If this is a relative path, it will be  #
487 # relative to the configuration directory, and if it is not defined,  #
488 # the default of 'inspircd.pid' is used.                              #
489 #                                                                     #
490
491 #<pid file="/path/to/inspircd.pid">
492
493 #-#-#-#-#-#-#-#-#-#-#-#-#- BANLIST LIMITS #-#-#-#-#-#-#-#-#-#-#-#-#-#-#
494 #                                                                     #
495 # Use these tags to customise the ban limits on a per channel basis.  #
496 # The tags are read from top to bottom, and any tag found which       #
497 # matches the channels name applies the banlimit to that channel.     #
498 # It is advisable to put an entry with the channel as '*' at the      #
499 # bottom of the list. If none are specified or no maxbans tag is      #
500 # matched, the banlist size defaults to 64 entries.                   #
501 #                                                                     #
502
503 <banlist chan="#morons" limit="128">
504 <banlist chan="*" limit="69">
505
506 #-#-#-#-#-#-#-#-#-#-#-  DISABLED FEATURES  -#-#-#-#-#-#-#-#-#-#-#-#-#-#
507 #                                                                     #
508 # This tag is optional, and specifies one or more features which are  #
509 # not available to non-operators.                                     #
510 #                                                                     #
511 # For example you may wish to disable NICK and prevent non-opers from #
512 # changing their nicknames.                                           #
513 # Note that any disabled commands take effect only after the user has #
514 # 'registered' (e.g. after the initial USER/NICK/PASS on connection)  #
515 # so for example disabling NICK will not cripple your network.        #
516 #                                                                     #
517 # You can also define if you want to disable any channelmodes         #
518 # or usermodes from your users.                                       #
519 #                                                                     #
520 # `fakenonexistant' will make the ircd pretend that nonexistant       #
521 # commands simply don't exist to non-opers ("no such command").       #
522 #                                                                     #
523 #<disabled commands="TOPIC MODE" usermodes="" chanmodes="" fakenonexistant="yes">
524
525
526 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-  RTFM LINE  -#-#-#-#-#-#-#-#-#-#-#-#-#-#
527 #                                                                     #
528 #   Just remove this... Its here to make you read ALL of the config   #
529 #   file options ;)                                                   #
530
531 <die value="You should probably edit your config *PROPERLY* and try again.">
532
533
534
535 #-#-#-#-#-#-#-#-#-#-#-#-#-  SERVER OPTIONS   -#-#-#-#-#-#-#-#-#-#-#-#-#
536 #                                                                     #
537 #   Settings to define which features are usable on your server.      #
538 #                                                                     #
539
540 <options
541          # prefixquit: What (if anything) a users' quit message
542          # should be prefixed with.
543          prefixquit="Quit: "
544
545          # suffixquit: What (if anything) a users' quit message
546          # should be suffixed with.
547          suffixquit=""
548
549          # prefixpart: What (if anything) a users' part message
550          # should be prefixed with.
551          prefixpart="&quot;"
552          # NOTE: Use "\"" instead of "&quot;" if not using <config format="xml">
553
554          # suffixpart: What (if anything) a users' part message
555          # should be suffixed with.
556          suffixpart="&quot;"
557
558          # fixedquit: Set all users' quit messages to this value.
559          #fixedquit=""
560
561          # fixedpart: Set all users' part messages in all channels
562          # to this value.
563          #fixedpart=""
564
565          # syntaxhints: If enabled, if a user fails to send the correct parameters
566          # for a command, the ircd will give back some help text of what
567          # the correct parameters are.
568          syntaxhints="no"
569
570          # cyclehosts: If enabled, when a user gets a host set, it will cycle
571          # them in all their channels. If not, it will simply change their host
572          # without cycling them.
573          cyclehosts="no"
574
575          # cyclehostsfromuser: If enabled, the source of the mode change for
576          # cyclehosts will be the user who cycled. This can look nicer, but
577          # triggers anti-takeover mechanisms of some obsolete bots.
578          cyclehostsfromuser="no"
579
580          # ircumsgprefix: Use undernet-style message prefixing for NOTICE and
581          # PRIVMSG. If enabled, it will add users' prefix to the line, if not,
582          # it will just message the user normally.
583          ircumsgprefix="no"
584
585          # announcets: If set to yes, when the TimeStamp on a channel changes, all users
586          # in channel will be sent a NOTICE about it.
587          announcets="yes"
588
589          # allowmismatch: Setting this option to yes will allow servers to link even
590          # if they don't have the same VF_OPTCOMMON modules loaded. Setting this to
591          # yes may introduce some desyncs and weirdness.
592          allowmismatch="no"
593
594          # defaultbind: Sets the default for <bind> tags without an address. Choices are
595          # ipv4 or ipv6; if not specified, IPv6 will be used if your system has support,
596          # falling back to IPv4 otherwise.
597          defaultbind="auto"
598
599          # hostintopic: If enabled, channels will show the host of the topicsetter
600          # in the topic. If set to no, it will only show the nick of the topicsetter.
601          hostintopic="yes"
602
603          # pingwarning: If a server does not respond to a ping within x seconds,
604          # it will send a notice to opers with snomask +l informing that the server
605          # is about to ping timeout.
606          pingwarning="15"
607
608          # serverpingfreq: How often pings are sent between servers (in seconds).
609          serverpingfreq="60"
610
611          # defaultmodes: What modes are set on a empty channel when a user
612          # joins it and it is unregistered. This is similar to Asuka's
613          # autochanmodes.
614          defaultmodes="nt"
615
616          # moronbanner: This is the text that is sent to a user when they are
617          # banned from the server.
618          moronbanner="You're banned! Email haha@abuse.com with the ERROR line below for help."
619
620          # exemptchanops: exemptions for channel access restrictions based on prefix.
621          exemptchanops="nonick:v flood:o"
622
623          # invitebypassmodes: This allows /invite to bypass other channel modes.
624          # (Such as +k, +j, +l, etc)
625          invitebypassmodes="yes"
626
627          # nosnoticestack: This prevents snotices from 'stacking' and giving you
628          # the message saying '(last message repeated X times)'. Defaults to no.
629          nosnoticestack="no">
630
631
632 #-#-#-#-#-#-#-#-#-#-#-# PERFORMANCE CONFIGURATION #-#-#-#-#-#-#-#-#-#-#
633 #                                                                     #
634
635 <performance
636              # netbuffersize: Size of the buffer used to recieve data from clients.
637              # The ircd may only read this amount of text in 1 go at any time.
638              netbuffersize="10240"
639
640              # maxwho: Maximum number of results to show in a /who query.
641              maxwho="4096"
642
643              # somaxconn: The maximum number of connections that may be waiting
644              # in the accept queue. This is *NOT* the total maximum number of
645              # connections per server. Some systems may only allow this to be up
646              # to 5, while others (such as linux and *BSD) default to 128.
647              somaxconn="128"
648
649              # softlimit: This optional feature allows a defined softlimit for
650              # connections. If defined, it sets a soft max connections value.
651              softlimit="12800"
652
653              # quietbursts: When syncing or splitting from a network, a server
654              # can generate a lot of connect and quit messages to opers with
655              # +C and +Q snomasks. Setting this to yes squelches those messages,
656              # which makes it easier for opers, but degrades the functionality of
657              # bots like BOPM during netsplits.
658              quietbursts="yes">
659
660 #-#-#-#-#-#-#-#-#-#-#-# SECURITY CONFIGURATION  #-#-#-#-#-#-#-#-#-#-#-#
661 #                                                                     #
662
663 <security
664           # allowcoreunload: If this value is set to yes, Opers will be able to
665           # unload core modules (e.g. cmd_privmsg.so).
666           allowcoreunload="no"
667
668           # announceinvites: This option controls which members of the channel
669           # receive an announcement when someone is INVITEd. Available values:
670           # 'none' - don't send invite announcements
671           # 'all' - send invite announcements to all members
672           # 'ops' - send invite announcements to ops and higher ranked users
673           # 'dynamic' - send invite announcements to halfops (if available) and
674           #             higher ranked users. This is the recommended setting.
675           announceinvites="dynamic"
676
677           # hidemodes: If enabled, then the listmodes given will be hidden
678           # from users below halfop. This is not recommended to be set on +b
679           # as it may break some functionality in popular clients such as mIRC.
680           hidemodes="eI"
681
682           # hideulines: If this value is set to yes, U-lined servers will
683           # be hidden from non-opers in /links and /map.
684           hideulines="no"
685
686           # flatlinks: If this value is set to yes, /map and /links will
687           # be flattened when shown to non-opers.
688           flatlinks="no"
689
690           # hidewhois: When defined, the given text will be used in place
691           # of the server a user is on when whoised by a non-oper. Most
692           # networks will want to set this to something like "*.netname.net"
693           # to conceal the actual server a user is on.
694           # Note that enabling this will cause users' idle times to only be
695           # shown when the format /WHOIS <nick> <nick> is used.
696           hidewhois=""
697
698           # hidebans: If this value is set to yes, when a user is banned ([gkz]lined)
699           # only opers will see the ban message when the user is removed
700           # from the server.
701           hidebans="no"
702
703           # hidekills: If defined, replaces who set a /kill with a custom string.
704           hidekills=""
705
706           # hidesplits: If enabled, non-opers will not be able to see which
707           # servers split in a netsplit, they will only be able to see that one
708           # occurred (If their client has netsplit detection).
709           hidesplits="no"
710
711           # maxtargets: Maximum number of targets per command.
712           # (Commands like /notice, /privmsg, /kick, etc)
713           maxtargets="20"
714
715           # customversion: Displays a custom string when a user /version's
716           # the ircd. This may be set for security reasons or vanity reasons.
717           customversion=""
718
719           # operspywhois: show opers (users/auspex) the +s channels a user is in. Values:
720           #  splitmsg  Split with an explanatory message
721           #  yes       Split with no explanatory message
722           #  no        Do not show
723           operspywhois="no"
724
725           # runasuser: If this is set, InspIRCd will attempt to setuid
726           # to run as this user- allows binding of ports under 1024.
727           # NOT SUPPORTED/NEEDED UNDER WINDOWS.
728           #runasuser=""
729
730           # runasgroup: If this is set, InspIRCd will attempt to set group
731           # to run under this group, which allows binding of ports under 1024
732           # NOT SUPPORTED/NEEDED UNDER WINDOWS.
733           #runasgroup=""
734
735           # restrictbannedusers: If this is set to yes, InspIRCd will not allow users
736           # banned on a channel to change nickname or message channels they are
737           # banned on.
738           restrictbannedusers="yes"
739
740           # genericoper: Setting this value to yes makes all opers on this server
741           # appear as 'is an IRC operator' in their WHOIS, regardless of their
742           # oper type, however oper types are still used internally. This only
743           # affects the display in WHOIS.
744           genericoper="no"
745
746           # userstats: /stats commands that users can run (opers can run all).
747           userstats="Pu">
748
749 #-#-#-#-#-#-#-#-#-#-#-#-# LIMITS CONFIGURATION  #-#-#-#-#-#-#-#-#-#-#-#
750 #                                                                     #
751 # This configuration tag defines the maximum sizes of various types   #
752 # on IRC, such as the maximum length of a channel name, and the       #
753 # maximum length of a channel. Note that with the exception of the    #
754 # identmax value all values given here are the exact values you would #
755 # expect to see on IRC. This contrasts with the older InspIRCd        #
756 # releases where these values would be one character shorter than     #
757 # defined to account for a null terminator on the end of the text.    #
758 #                                                                     #
759 # These values should match network-wide otherwise issues will occur. #
760 #                                                                     #
761 # The highest safe value you can set any of these options to is 500,  #
762 # but it is recommended that you keep them somewhat                   #
763 # near their defaults (or lower).                                     #
764
765 <limits
766         # maxnick: Maximum length of a nickname.
767         maxnick="31"
768
769         # maxchan: Maximum length of a channel name.
770         maxchan="64"
771
772         # maxmodes: Maximum number of mode changes per line.
773         maxmodes="20"
774
775         # maxident: Maximum length of a ident/username.
776         maxident="11"
777
778         # maxquit: Maximum length of a quit message.
779         maxquit="255"
780
781         # maxtopic: Maximum length of a channel topic.
782         maxtopic="307"
783
784         # maxkick: Maximum length of a kick message.
785         maxkick="255"
786
787         # maxgecos: Maximum length of a GECOS (realname).
788         maxgecos="128"
789
790         # maxaway: Maximum length of an away message.
791         maxaway="200">
792
793
794 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
795 # Logging
796 # -------
797 #
798 # Logging is covered with the <log> tag, which you may use to change
799 # the behaviour of the logging of the IRCd.
800 #
801 # In InspIRCd as of 1.2, logging is pluggable and very extensible.
802 # Different files can log the same thing, different 'types' of log can
803 # go to different places, and modules can even extend the log tag
804 # to do what they want.
805 #
806 # An example log tag would be:
807 #  <log method="file" type="OPER" level="default" target="opers.log">
808 # which would log all information on /oper (failed and successful) to
809 # a file called opers.log.
810 #
811 # There are many different types which may be used, and modules may
812 # generate their own. A list of useful types:
813 #  - USERS - information relating to user connection and disconnection
814 #  - OPER - succesful and failed oper attempts
815 #  - KILL - kill related messages
816 #  - snomask - server notices (*all* snomasks will be logged)
817 #  - FILTER - messages related to filter matches (m_filter)
818 #  - CONFIG - configuration related messages
819 #  - COMMAND - die and restart messages, and messages related to unknown user types
820 #  - SOCKET - socket engine informational/error messages
821 #  - MODULE - module related messages
822 #  - STARTUP - messages related to starting up the server
823 #
824 # You may also log *everything* by using a type of *, and subtract things out
825 # of that by using -TYPE - for example "* -USERINPUT -USEROUTPUT".
826 #
827 # Useful levels are:
828 #  - default (general messages, including errors)
829 #  - sparse (misc error messages)
830 #  - debug (debug messages)
831 #
832 # Some types only produce output in the debug level, those are:
833 #  - BANCACHE - ban cache debug messages
834 #  - CHANNELS - information relating to joining/creating channels
835 #  - CULLLIST - debug messages related to issues with removing users
836 #  - RESOLVER - DNS related debug messages
837 #  - CONNECTCLASS - Connection class debug messages
838 #  - USERINPUT
839 #  - USEROUTPUT
840 #
841 # The following log tag is highly default and uncustomised. It is recommended you
842 # sort out your own log tags. This is just here so you get some output.
843
844 <log method="file" type="* -USERINPUT -USEROUTPUT" level="default" target="ircd.log">
845
846 #-#-#-#-#-#-#-#-#-#-#-#-#-  WHOWAS OPTIONS   -#-#-#-#-#-#-#-#-#-#-#-#-#
847 #                                                                     #
848 # This tag lets you define the behaviour of the /whowas command of    #
849 # your server.                                                        #
850 #                                                                     #
851
852 <whowas
853         # groupsize: Maximum entries per nick shown when performing
854         # a /whowas nick.
855         groupsize="10"
856
857         # maxgroups: Maximum number of nickgroups that can be added to
858         # the list so that /whowas does not use a lot of resources on
859         # large networks.
860         maxgroups="100000"
861
862         # maxkeep: Maximum time a nick is kept in the whowas list
863         # before being pruned. Time may be specified in seconds,
864         # or in the following format: 1y2w3d4h5m6s. Minimum is
865         # 1 hour.
866         maxkeep="3d">
867
868 #-#-#-#-#-#-#-#-#-#-#-#-#-#-  BAN OPTIONS  -#-#-#-#-#-#-#-#-#-#-#-#-#-#
869 #                                                                     #
870 # The ban tags define nick masks, host masks and ip ranges which are  #
871 # banned from your server. All details in these tags are local to     #
872 # Your server.                                                        #
873 #                                                                     #
874
875 <badip
876        # ipmask: IP range to ban. Wildcards and CIDR can be used.
877        ipmask="69.69.69.69"
878
879        # reason: Reason to display when user is disconnected.
880        reason="No porn here thanks.">
881
882 <badnick
883          # nick: Nick to disallow. Wildcards are supported.
884          nick="ChanServ"
885
886          # reason: Reason to display on /nick.
887          reason="Reserved For Services">
888
889 <badnick nick="NickServ" reason="Reserved For Services">
890 <badnick nick="OperServ" reason="Reserved For Services">
891 <badnick nick="MemoServ" reason="Reserved For Services">
892
893 <badhost
894          # host: ident@hostname to ban.
895          # Wildcards and CIDR (if you specify an IP) can be used.
896          host="*@hundredz.n.hundredz.o.1337.kiddies.com"
897
898          # reason: Reason to display when user is disconnected
899          reason="Too many 1337 kiddiots">
900
901 <badhost host="root@*" reason="Don't irc as root!">
902 <badhost host="*@172.32.0.0/16" reason="This subnet is bad.">
903
904 # exception: Hosts that are exempt from [kgz]lines.
905 <exception
906            # host: ident@hostname to exempt.
907            # Wildcards and CIDR (if you specify an IP) can be used.
908            host="*@ircop.host.com"
909
910            # reason: Reason for exception. Only shown in /stats e
911            reason="Opers hostname">
912
913 #-#-#-#-#-#-#-#-#-#-#- INSANE BAN OPTIONS  -#-#-#-#-#-#-#-#-#-#-#-#-#-#
914 #                                                                     #
915 # This optional tag allows you to specify how wide a gline, eline,    #
916 # kline, zline or qline can be before it is forbidden from being      #
917 # set. By setting hostmasks="yes", you can allow all G, K, E lines,   #
918 # no matter how many users the ban would cover. This is not           #
919 # recommended! By setting ipmasks="yes", you can allow all Z lines,   #
920 # no matter how many users these cover too. Needless to say we        #
921 # don't recommend you do this, or, set nickmasks="yes", which will    #
922 # allow any qline.                                                    #
923 #                                                                     #
924
925 <insane
926         # hostmasks: Allow bans with insane hostmasks. (over-reaching bans)
927         hostmasks="no"
928
929         # ipmasks: Allow bans with insane ipmasks. (over-reaching bans)
930         ipmasks="no"
931
932         # nickmasks: Allow bans with insane nickmasks. (over-reaching bans)
933         nickmasks="no"
934
935         # trigger: What percentage of users on the network to trigger
936         # specifying an insane ban as. The default is 95.5%, which means
937         # if you have a 1000 user network, a ban will not be allowed if it
938         # will be banning 955 or more users.
939         trigger="95.5">
940
941
942 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#- YAWN  -#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
943 #                                                                     #
944 #   You should already know what to do here :)                        #
945
946 <die value="User error. Insert new user and press any key. (you didn't edit your config properly.)">
947
948 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# MODULES #-#-#-#-#-#-#-#-#-#-#-#-#-#-#
949 #    ____                _   _____ _     _       ____  _ _   _        #
950 #   |  _ \ ___  __ _  __| | |_   _| |__ (_)___  | __ )(_) |_| |       #
951 #   | |_) / _ \/ _` |/ _` |   | | | '_ \| / __| |  _ \| | __| |       #
952 #   |  _ <  __/ (_| | (_| |   | | | | | | \__ \ | |_) | | |_|_|       #
953 #   |_| \_\___|\__,_|\__,_|   |_| |_| |_|_|___/ |____/|_|\__(_)       #
954 #                                                                     #
955 # Well done, you've reached the end of the basic configuration, your  #
956 # ircd should now start if you want to try it out! (./inspircd start) #
957 #                                                                     #
958 # We now suggest you read and edit modules.conf, as modules are what  #
959 # provide almost all the features of InspIRCd. :)                     #
960 #                                                                     #
961 # The default does nothing -- we include it for simplicity for you.   #
962 <include file="conf/examples/modules.conf.example">
963
964 # Here are some pre-built modules.conf files that closely match the
965 # default configurations of some popular IRCd's. You still may want to
966 # look over them and make sure if everything is correct for you and setup
967 # the proper SSL information.
968 #
969 # *NOTE*: These files have no comments for what the modules do. If you
970 # are interested in that, please read the modules.conf.example. It is also
971 # recommended that you make your own modules file based on modules.conf.example.
972
973 # Settings similar to UnrealIRCd defaults.
974 #<include file="conf/examples/modules/unrealircd.conf.example">
975
976 # Settings similar to Charybdis IRCd defaults.
977 #<include file="conf/examples/modules/charybdis.conf.example">
978
979
980 #########################################################################
981 #                                                                       #
982 #                     - InspIRCd Development Team -                     #
983 #                        http://www.inspircd.org                        #
984 #                                                                       #
985 #########################################################################