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