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