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