]> git.netwichtig.de Git - user/henk/code/inspircd.git/blob - docs/conf/inspircd.conf.example
bd4629ecae7083511feb772039f3e521de737e88
[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://mynet.net/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.org.za"
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 this bind section to use SSL, define either
152       # gnutls or openssl here. The appropriate SSL modules must be loaded
153       # for ssl to work. If you do not want this bind section to support ssl,
154       # 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 IRCop's 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 is hit (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 # http://en.wikipedia.org/wiki/CIDR#Prefix_aggregation                #
398 #                                                                     #
399
400 <cidr
401       # ipv4clone: specifies how many bits of an IP address should be
402       # looked at for clones. The default only looks for clones on a
403       # single IP address of a user. You do not want to set this
404       # extremely low. (Values are 0-32).
405       ipv4clone="32"
406
407       # ipv6clone: specifies how many bits of an IP address should be
408       # looked at for clones. The default only looks for clones on a
409       # single IP address of a user. You do not want to set this
410       # extremely low. (Values are 0-128).
411       ipv6clone="128">
412
413 # This file has all the information about oper classes, types and o:lines.
414 # You *MUST* edit it.
415 <include file="conf/examples/opers.conf.example">
416
417 # This file has all the information about server links and ulined servers.
418 # You *MUST* edit it if you intend to link servers.
419 <include file="conf/examples/links.conf.example">
420
421 #-#-#-#-#-#-#-#-#-#-  MISCELLANEOUS CONFIGURATION  -#-#-#-#-#-#-#-#-#-#
422 #                                                                     #
423
424 # Files block - contains files whose contents are used by the ircd
425 #
426 #   motd - displayed on connect and when a user executes /MOTD
427 #   rules - displayed when the user executes /RULES
428 # Modules can also define their own files
429 <files motd="conf/examples/motd.txt.example" rules="conf/examples/rules.txt.example">
430
431 # Example of an executable file include. Note this will be read on rehash,
432 # not when the command is run.
433 #<execfiles rules="wget -O - http://www.example.com/rules.txt">
434
435 #-#-#-#-#-#-#-#-#-#-#-# MAXIMUM CHANNELS -#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
436 #                                                                     #
437
438 <channels
439           # users: Maximum number of channels a user can be in at once.
440           users="20"
441
442           # opers: Maximum number of channels an oper can be in at once.
443           opers="60">
444
445 #-#-#-#-#-#-#-#-#-#-#-#-#-#-# DNS SERVER -#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
446 # If these values are not defined, InspIRCd uses the default DNS resolver
447 # of your system.
448
449 <dns
450      # server: DNS server to use to attempt to resolve IP's to hostnames.
451      # in most cases, you won't need to change this, as inspircd will
452      # automatically detect the nameserver depending on /etc/resolv.conf
453      # (or, on windows, your set nameservers in the registry.)
454      # Note that this must be an IP address and not a hostname, because
455      # there is no resolver to resolve the name until this is defined!
456      #
457      # server="127.0.0.1"
458
459      # timeout: seconds to wait to try to resolve DNS/hostname.
460      timeout="5">
461
462 # An example of using an IPv6 nameserver
463 #<dns server="::1" timeout="5">
464
465 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#  PID FILE  -#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
466 #                                                                     #
467 # Define the path to the PID file here. The PID file can be used to   #
468 # rehash the ircd from the shell or to terminate the ircd from the    #
469 # shell using shell scripts, perl scripts, etc... and to monitor the  #
470 # ircd's state via cron jobs. If this is a relative path, it will be  #
471 # relative to the configuration directory, and if it is not defined,  #
472 # the default of 'inspircd.pid' is used.                              #
473 #                                                                     #
474
475 #<pid file="/path/to/inspircd.pid">
476
477 #-#-#-#-#-#-#-#-#-#-#-#-#- BANLIST LIMITS #-#-#-#-#-#-#-#-#-#-#-#-#-#-#
478 #                                                                     #
479 # Use these tags to customise the ban limits on a per channel basis.  #
480 # The tags are read from top to bottom, and any tag found which       #
481 # matches the channels name applies the banlimit to that channel.     #
482 # It is advisable to put an entry with the channel as '*' at the      #
483 # bottom of the list. If none are specified or no maxbans tag is      #
484 # matched, the banlist size defaults to 64 entries.                   #
485 #                                                                     #
486
487 <banlist chan="#morons" limit="128">
488 <banlist chan="*" limit="69">
489
490 #-#-#-#-#-#-#-#-#-#-#-  DISABLED FEATURES  -#-#-#-#-#-#-#-#-#-#-#-#-#-#
491 #                                                                     #
492 # This tag is optional, and specifies one or more features which are  #
493 # not available to non-operators.                                     #
494 #                                                                     #
495 # For example you may wish to disable NICK and prevent non-opers from #
496 # changing their nicknames.                                           #
497 # Note that any disabled commands take effect only after the user has #
498 # 'registered' (e.g. after the initial USER/NICK/PASS on connection)  #
499 # so for example disabling NICK will not cripple your network.        #
500 #                                                                     #
501 # You can also define if you want to disable any channelmodes         #
502 # or usermodes from your users.                                       #
503 #                                                                     #
504 # `fakenonexistant' will make the ircd pretend that nonexistant       #
505 # commands simply don't exist to non-opers ("no such command").       #
506 #                                                                     #
507 #<disabled commands="TOPIC MODE" usermodes="" chanmodes="" fakenonexistant="yes">
508
509
510 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-  RTFM LINE  -#-#-#-#-#-#-#-#-#-#-#-#-#-#
511 #                                                                     #
512 #   Just remove this... Its here to make you read ALL of the config   #
513 #   file options ;)                                                   #
514
515 <die value="You should probably edit your config *PROPERLY* and try again.">
516
517
518
519 #-#-#-#-#-#-#-#-#-#-#-#-#-  SERVER OPTIONS   -#-#-#-#-#-#-#-#-#-#-#-#-#
520 #                                                                     #
521 #   Settings to define which features are usable on your server.      #
522 #                                                                     #
523
524 <options
525          # prefixquit: What (if anything) users' quit messages
526          # should be prefixed with.
527          prefixquit="Quit: "
528
529          # suffixquit: What (if anything) users' quit messages
530          # should be suffixed with.
531          suffixquit=""
532
533          # prefixpart: What (if anything) users' part messages
534          # should be prefixed with.
535          prefixpart="&quot;"
536          # NOTE: Use "\"" instead of "&quot;" if not using <config format="xml">
537
538          # suffixpart: What (if anything) users' part message
539          # should be suffixed with.
540          suffixpart="&quot;"
541
542          # fixedquit: Set all users' quit messages to this value.
543          #fixedquit=""
544
545          # fixedpart: Set all users' part messages in all channels
546          # to this value.
547          #fixedpart=""
548
549          # syntaxhints: If enabled, if a user fails to send the correct parameters
550          # for a command, the ircd will give back some help text of what
551          # the correct parameters are.
552          syntaxhints="no"
553
554          # cyclehosts: If enabled, when a user gets a host set, it will cycle
555          # them in all their channels. If not, it will simply change their host
556          # without cycling them.
557          cyclehosts="yes"
558
559          # cyclehostsfromuser: If enabled, the source of the mode change for
560          # cyclehosts will be the user who cycled. This can look nicer, but
561          # triggers anti-takeover mechanisms of some obsolete bots.
562          cyclehostsfromuser="no"
563
564          # ircumsgprefix: Use undernet-style message prefixing for NOTICE and
565          # PRIVMSG. If enabled, it will add users' prefix to the line, if not,
566          # it will just message the user normally.
567          ircumsgprefix="no"
568
569          # announcets: If set to yes, when the timestamp on a channel changes, all users
570          # in the channel will be sent a NOTICE about it.
571          announcets="yes"
572
573          # allowmismatch: Setting this option to yes will allow servers to link even
574          # if they don't have the same "optionally common" modules loaded. Setting this to
575          # yes may introduce some desyncs and weirdness.
576          allowmismatch="no"
577
578          # defaultbind: Sets the default for <bind> tags without an address. Choices are
579          # ipv4 or ipv6; if not specified, IPv6 will be used if your system has support,
580          # falling back to IPv4 otherwise.
581          defaultbind="auto"
582
583          # hostintopic: If enabled, channels will show the host of the topic setter
584          # in the topic. If set to no, it will only show the nick of the topic setter.
585          hostintopic="yes"
586
587          # pingwarning: If a server does not respond to a ping within x seconds,
588          # it will send a notice to opers with snomask +l informing that the server
589          # is about to ping timeout.
590          pingwarning="15"
591
592          # serverpingfreq: How often pings are sent between servers (in seconds).
593          serverpingfreq="60"
594
595          # defaultmodes: What modes are set on a empty channel when a user
596          # joins it and it is unregistered.
597          defaultmodes="nt"
598
599          # moronbanner: This is the text that is sent to a user when they are
600          # banned from the server.
601          moronbanner="You're banned! Email abuse@example.com with the ERROR line below for help."
602
603          # exemptchanops: exemptions for channel access restrictions based on prefix.
604          exemptchanops="nonick:v flood:o"
605
606          # invitebypassmodes: This allows /invite to bypass other channel modes.
607          # (Such as +k, +j, +l, etc.)
608          invitebypassmodes="yes"
609
610          # nosnoticestack: This prevents snotices from 'stacking' and giving you
611          # the message saying '(last message repeated X times)'. Defaults to no.
612          nosnoticestack="no"
613
614          # welcomenotice: When turned on, this sends a NOTICE to connecting users
615          # with the text Welcome to <networkname>! after successful registration.
616          # Defaults to yes.
617          welcomenotice="yes">
618
619
620 #-#-#-#-#-#-#-#-#-#-#-# PERFORMANCE CONFIGURATION #-#-#-#-#-#-#-#-#-#-#
621 #                                                                     #
622
623 <performance
624              # netbuffersize: Size of the buffer used to receive data from clients.
625              # The ircd may only read this amount of text in 1 go at any time.
626              netbuffersize="10240"
627
628              # somaxconn: The maximum number of connections that may be waiting
629              # in the accept queue. This is *NOT* the total maximum number of
630              # connections per server. Some systems may only allow this to be up
631              # to 5, while others (such as linux and *BSD) default to 128.
632              somaxconn="128"
633
634              # limitsomaxconn: By default, somaxconn (see above) is limited to a
635              # safe maximum value in the 2.0 branch for compatibility reasons.
636              # This setting can be used to disable this limit, forcing InspIRCd
637              # to use the value specified above.
638              limitsomaxconn="true"
639
640              # softlimit: This optional feature allows a defined softlimit for
641              # connections. If defined, it sets a soft max connections value.
642              softlimit="12800"
643
644              # quietbursts: When syncing or splitting from a network, a server
645              # can generate a lot of connect and quit messages to opers with
646              # +C and +Q snomasks. Setting this to yes squelches those messages,
647              # which makes it easier for opers, but degrades the functionality of
648              # bots like BOPM during netsplits.
649              quietbursts="yes"
650
651              # nouserdns: If enabled, no DNS lookups will be performed on
652              # connecting users. This can save a lot of resources on very busy servers.
653              nouserdns="no">
654
655 #-#-#-#-#-#-#-#-#-#-#-# SECURITY CONFIGURATION  #-#-#-#-#-#-#-#-#-#-#-#
656 #                                                                     #
657
658 <security
659
660           # announceinvites: This option controls which members of the channel
661           # receive an announcement when someone is INVITEd. Available values:
662           # 'none' - don't send invite announcements
663           # 'all' - send invite announcements to all members
664           # 'ops' - send invite announcements to ops and higher ranked users
665           # 'dynamic' - send invite announcements to halfops (if available) and
666           #             higher ranked users. This is the recommended setting.
667           announceinvites="dynamic"
668
669           # hidemodes: If enabled, then the listmodes given will be hidden
670           # from users below halfop. This is not recommended to be set on +b
671           # as it may break some functionality in popular clients such as mIRC.
672           hidemodes="eI"
673
674           # hideulines: If this value is set to yes, U-lined servers will
675           # be hidden from non-opers in /links and /map.
676           hideulines="no"
677
678           # flatlinks: If this value is set to yes, /map and /links will
679           # be flattened when shown to non-opers.
680           flatlinks="no"
681
682           # hidewhois: When defined, the given text will be used in place
683           # of the server a user is on when whoised by a non-oper. Most
684           # networks will want to set this to something like "*.netname.net"
685           # to conceal the actual server a user is on.
686           # Note that enabling this will cause users' idle times to only be
687           # shown when the format /WHOIS <nick> <nick> is used.
688           hidewhois=""
689
690           # hidebans: If this value is set to yes, when a user is banned ([gkz]lined)
691           # only opers will see the ban message when the user is removed
692           # from the server.
693           hidebans="no"
694
695           # hidekills: If defined, replaces who set a /kill with a custom string.
696           hidekills=""
697
698           # hidesplits: If enabled, non-opers will not be able to see which
699           # servers split in a netsplit, they will only be able to see that one
700           # occurred (If their client has netsplit detection).
701           hidesplits="no"
702
703           # maxtargets: Maximum number of targets per command.
704           # (Commands like /notice, /privmsg, /kick, etc)
705           maxtargets="20"
706
707           # customversion: Displays a custom string when a user /version's
708           # the ircd. This may be set for security reasons or vanity reasons.
709           customversion=""
710
711           # operspywhois: show opers (users/auspex) the +s channels a user is in. Values:
712           #  splitmsg  Split with an explanatory message
713           #  yes       Split with no explanatory message
714           #  no        Do not show
715           operspywhois="no"
716
717           # runasuser: If this is set, InspIRCd will attempt to switch
718           # to run as this user, which allows binding of ports under 1024.
719           # You should NOT set this unless you are starting as root.
720           # NOT SUPPORTED/NEEDED UNDER WINDOWS.
721           #runasuser=""
722
723           # runasgroup: If this is set, InspIRCd will attempt to switch
724           # to run as this group, which allows binding of ports under 1024.
725           # You should NOT set this unless you are starting as root.
726           # NOT SUPPORTED/NEEDED UNDER WINDOWS.
727           #runasgroup=""
728
729           # restrictbannedusers: If this is set to yes, InspIRCd will not allow users
730           # banned on a channel to change nickname or message channels they are
731           # banned on.
732           restrictbannedusers="yes"
733
734           # genericoper: Setting this value to yes makes all opers on this server
735           # appear as 'is an IRC operator' in their WHOIS, regardless of their
736           # oper type, however oper types are still used internally. This only
737           # affects the display in WHOIS.
738           genericoper="no"
739
740           # userstats: /stats commands that users can run (opers can run all).
741           userstats="Pu">
742
743 #-#-#-#-#-#-#-#-#-#-#-#-# LIMITS CONFIGURATION  #-#-#-#-#-#-#-#-#-#-#-#
744 #                                                                     #
745 # This configuration tag defines the maximum sizes of various types   #
746 # on IRC, such as the maximum length of a channel name, and the       #
747 # maximum length of a channel. Note that with the exception of the    #
748 # identmax value all values given here are the exact values you would #
749 # expect to see on IRC. This contrasts with the older InspIRCd        #
750 # releases where these values would be one character shorter than     #
751 # defined to account for a null terminator on the end of the text.    #
752 #                                                                     #
753 # These values should match network-wide otherwise issues will occur. #
754 #                                                                     #
755 # The highest safe value you can set any of these options to is 500,  #
756 # but it is recommended that you keep them somewhat                   #
757 # near their defaults (or lower).                                     #
758
759 <limits
760         # maxnick: Maximum length of a nickname.
761         maxnick="31"
762
763         # maxchan: Maximum length of a channel name.
764         maxchan="64"
765
766         # maxmodes: Maximum number of mode changes per line.
767         maxmodes="20"
768
769         # maxident: Maximum length of a ident/username.
770         maxident="11"
771
772         # maxquit: Maximum length of a quit message.
773         maxquit="255"
774
775         # maxtopic: Maximum length of a channel topic.
776         maxtopic="307"
777
778         # maxkick: Maximum length of a kick message.
779         maxkick="255"
780
781         # maxgecos: Maximum length of a GECOS (realname).
782         maxgecos="128"
783
784         # maxaway: Maximum length of an away message.
785         maxaway="200">
786
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="logs/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 (m_filter)
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="logs/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="*@hundredz.n.hundredz.o.1337.kiddies.example.net"
891
892          # reason: Reason to display when user is disconnected
893          reason="Too many 1337 kiddiots">
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. Insert new user and press any key. (you didn't edit your config properly.)">
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="conf/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="conf/examples/modules/unrealircd.conf.example">
969
970 # Settings similar to Charybdis IRCd defaults.
971 #<include file="conf/examples/modules/charybdis.conf.example">
972
973
974 #########################################################################
975 #                                                                       #
976 #                     - InspIRCd Development Team -                     #
977 #                        http://www.inspircd.org                        #
978 #                                                                       #
979 #########################################################################