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