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