]> git.netwichtig.de Git - user/henk/code/inspircd.git/blob - conf/inspircd.conf.example
Update example configs for SSL changes [dKingston]
[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" ssl="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          # localmax: Maximum local connections per IP (or CIDR mask, see below).
245          localmax="3"
246
247          # globalmax: Maximum global (network-wide) connections per IP (or CIDR mask, see below).
248          globalmax="3"
249
250          # useident: Defines if users in this class MUST respond to a ident query or not.
251          useident="no"
252
253          # limit: How many users are allowed in this class
254          limit="5000"
255
256          # modes: Usermodes that are set on users in this block on connect.
257          # Enabling this option requires that the m_conn_umodes module be loaded.
258          # This entry is highly recommended to use for/with IP Cloaking/masking.
259          # For the example to work, this also requires that the m_cloaking
260          # module be loaded as well.
261          modes="+x"
262
263          # port: What port this user is allowed to connect on. (optional)
264          # The port MUST be set to listen in the bind blocks above.
265          port="6667">
266
267 <connect
268          # name: Name to use for this connect block. Mainly used for
269          # connect class inheriting.
270          name="main"
271
272          # allow: What IP addresses/hosts to allow for this block.
273          allow="*"
274
275          # maxchans: Maximum number of channels a user in this class
276          # be in at one time. This overrides every other maxchans setting.
277          #maxchans="30"
278
279          # timeout: How long (in seconds) the server will wait before
280          # disconnecting a user if they do not do anything on connect.
281          # (Note, this is a client-side thing, if the client does not
282          # send /nick, /user or /pass)
283          timeout="10"
284
285          # pingfreq: How often (in seconds) the server tries to ping connecting clients.
286          pingfreq="120"
287
288          # hardsendq: maximum amount of data allowed in a client's send queue
289          # before they are dropped. Keep this value higher than the length of
290          # your network's /LIST or /WHO output, or you will have lots of
291          # disconnects from sendq overruns!
292          hardsendq="1048576"
293
294          # softsendq: amount of data in a client's send queue before the server
295          # begins delaying their commands
296          softsendq="8192"
297
298          # recvq: amount of data allowed in a client's queue before they are dropped.
299          recvq="8192"
300
301          # localmax: Maximum local connections per IP.
302          localmax="3"
303
304          # globalmax: Maximum global (network-wide) connections per IP.
305          globalmax="3"
306
307          # useident: Defines if users in this class must respond to a ident query or not.
308          useident="no"
309
310          # limit: How many users are allowed in this class
311          limit="5000"
312
313          # modes: Usermodes that are set on users in this block on connect.
314          # Enabling this option requires that the m_conn_umodes module be loaded.
315          # This entry is highly recommended to use for/with IP Cloaking/masking.
316          # For the example to work, this also requires that the m_cloaking
317          # module be loaded as well.
318          modes="+x">
319
320
321 #-#-#-#-#-#-#-#-#-#-#-#-  CIDR CONFIGURATION   -#-#-#-#-#-#-#-#-#-#-#-
322 #                                                                     #
323 # CIDR configuration allows detection of clones and applying of       #
324 # throttle limits across a CIDR range. (A CIDR range is a group of    #
325 # IPs, for example, the CIDR range 192.168.1.0-192.168.1.255 may be   #
326 # represented as 192.168.1.0/24). This means that abuse across an ISP #
327 # is detected and curtailed much easier. Here is a good chart that    #
328 # shows how many IPs the different CIDRs correspond to:               #
329 # http://en.wikipedia.org/wiki/CIDR#Prefix_aggregation                #
330 #                                                                     #
331
332 <cidr
333           # ipv4clone: specifies how many bits of an IP address should be
334       # looked at for clones. The default only looks for clones on a
335       # single IP address of a user. You do not want to set this
336       # extremely low. (Values are 0-32).
337       ipv4clone="32"
338
339       # ipv6clone: specifies how many bits of an IP address should be
340       # looked at for clones. The default only looks for clones on a
341       # single IP address of a user. You do not want to set this
342       # extremely low. (Values are 0-128).
343       ipv6clone="128">
344
345 # This file has all the information about oper classes, types and o:lines.
346 # You *MUST* edit it.
347 <include file="opers.conf.example">
348
349 # This file has all the information about server links and ulined servers.
350 # You *MUST* edit it if you intend to link servers.
351 <include file="links.conf.example">
352
353 #-#-#-#-#-#-#-#-#-#-  MISCELLANEOUS CONFIGURATION  -#-#-#-#-#-#-#-#-#-#
354 #                                                                     #
355
356 <files
357        # motd: Path to your motd file. Path is relative to the conf directory.
358        motd="inspircd.motd.example"
359
360        # rules: Path to your rules file. Path is relative to the conf directory.
361        # This is optional and is displayed when a user does /rules on the network.
362        rules="inspircd.rules.example">
363
364 #-#-#-#-#-#-#-#-#-#-#-# MAXIMUM CHANNELS -#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
365 #                                                                     #
366
367 <channels
368           # users: Maximum number of channels a user can be in at once.
369           users="20"
370
371           # opers: Maximum number of channels a oper can be in at once.
372           opers="60">
373
374 #-#-#-#-#-#-#-#-#-#-#-#-#-#-# DNS SERVER -#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
375 # If these values are not defined, InspIRCd uses the default DNS resolver
376 # of your system.
377
378 <dns
379      # server: DNS server to use to attempt to resolve IP's to hostnames.
380      # in most cases, you won't need to change this, as inspircd will
381      # automatically detect the nameserver depending on /etc/resolv.conf
382      # (or, on windows, your set nameservers in the registry.)
383      # Note that this must be an IP address and not a hostname, because
384      # there is no resolver to resolve the name until this is defined!
385      #
386      # server="127.0.0.1"
387
388      # timeout: seconds to wait to try to resolve DNS/hostname.
389      timeout="5">
390
391 # An example of using an IPv6 nameserver
392 #<dns server="::1" timeout="5">
393
394 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#  PID FILE  -#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
395 #                                                                     #
396 # Define the path to the PID file here. The PID file can be used to   #
397 # rehash the ircd from the shell or to terminate the ircd from the    #
398 # shell using shell scripts, perl scripts, etc... and to monitor the  #
399 # ircd's state via cron jobs. If this is a relative path, it will be  #
400 # relative to the configuration directory, and if it is not defined,  #
401 # the default of 'inspircd.pid' is used.                              #
402 #                                                                     #
403
404 #<pid file="/path/to/inspircd.pid">
405
406 #-#-#-#-#-#-#-#-#-#-#-#-#- BANLIST LIMITS #-#-#-#-#-#-#-#-#-#-#-#-#-#-#
407 #                                                                     #
408 # Use these tags to customise the ban limits on a per channel basis.  #
409 # The tags are read from top to bottom, and any tag found which       #
410 # matches the channels name applies the banlimit to that channel.     #
411 # It is advisable to put an entry with the channel as '*' at the      #
412 # bottom of the list. If none are specified or no maxbans tag is      #
413 # matched, the banlist size defaults to 64 entries.                   #
414 #                                                                     #
415
416 <banlist chan="#morons" limit="128">
417 <banlist chan="*" limit="69">
418
419 #-#-#-#-#-#-#-#-#-#-#-  DISABLED FEATURES  -#-#-#-#-#-#-#-#-#-#-#-#-#-#
420 #                                                                     #
421 # This tag is optional, and specifies one or more features which are  #
422 # not available to non-operators.                                     #
423 #                                                                     #
424 # For example you may wish to disable NICK and prevent non-opers from #
425 # changing their nicknames.                                           #
426 # Note that any disabled commands take effect only after the user has #
427 # 'registered' (e.g. after the initial USER/NICK/PASS on connection)  #
428 # so for example disabling NICK will not cripple your network.        #
429 #                                                                     #
430 # You can also define if you want to disable any channelmodes         #
431 # or usermodes from your users.                                       #
432 #                                                                     #
433 # `fakenonexistant' will make the ircd pretend that nonexistant       #
434 # commands simply don't exist to non-opers ("no such command").       #
435 #                                                                     #
436 #<disabled commands="TOPIC MODE" usermodes="" chanmodes="" fakenonexistant="yes">
437
438
439 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-  RTFM LINE  -#-#-#-#-#-#-#-#-#-#-#-#-#-#
440 #                                                                     #
441 #   Just remove this... Its here to make you read ALL of the config   #
442 #   file options ;)                                                   #
443
444 <die value="You should probably edit your config *PROPERLY* and try again.">
445
446
447
448 #-#-#-#-#-#-#-#-#-#-#-#-#-  SERVER OPTIONS   -#-#-#-#-#-#-#-#-#-#-#-#-#
449 #                                                                     #
450 #   Settings to define which features are usable on your server.      #
451 #                                                                     #
452
453 <options
454          # prefixquit: What (if anything) a users' quit message
455          # should be prefixed with.
456          prefixquit="Quit: "
457
458          # suffixquit: What (if anything) a users' quit message
459          # should be suffixed with.
460          suffixquit=""
461
462          # prefixpart: What (if anything) a users' part message
463          # should be prefixed with.
464          prefixpart="\""
465
466          # suffixpart: What (if anything) a users' part message
467          # should be suffixed with.
468          suffixpart="\""
469
470          # fixedquit: Set all users' quit messages to this value.
471          #fixedquit=""
472
473          # fixedpart: Set all users' part messages in all channels
474          # to this value.
475          #fixedpart=""
476
477          # syntaxhints: If enabled, if a user fails to send the correct parameters
478          # for a command, the ircd will give back some help text of what
479          # the correct parameters are.
480          syntaxhints="no"
481
482          # cyclehosts: If enabled, when a user gets a host set, it will cycle
483          # them in all their channels. If not, it will simply change their host
484          # without cycling them.
485          cyclehosts="yes"
486
487          # ircumsgprefix: Use undernet-style message prefixing for NOTICE and
488          # PRIVMSG. If enabled, it will add users' prefix to the line, if not,
489          # it will just message the user normally.
490          ircumsgprefix="no"
491
492          # announcets: If set to yes, when the TimeStamp on a channel changes, all users
493          # in channel will be sent a NOTICE about it.
494          announcets="yes"
495
496          # allowmismatched: Setting this option to yes will allow servers to link even
497          # if they don't have the same VF_OPTCOMMON modules loaded. Setting this to
498          # yes may introduce some desyncs and weirdness.
499          allowmismatched="no"
500
501          # hostintopic: If enabled, channels will show the host of the topicsetter
502          # in the topic. If set to no, it will only show the nick of the topicsetter.
503          hostintopic="yes"
504
505          # pingwarning: If a server does not respond to a ping within x seconds,
506          # it will send a notice to opers with snomask +l informing that the server
507          # is about to ping timeout.
508          pingwarning="15"
509
510          # serverpingfreq: How often pings are sent between servers (in seconds).
511          serverpingfreq="60"
512
513          # allowhalfop: Allows the use of +h channelmode (halfops).
514          allowhalfop="yes"
515
516          # defaultmodes: What modes are set on a empty channel when a user
517          # joins it and it is unregistered. This is similar to Asuka's
518          # autochanmodes.
519          defaultmodes="nt"
520
521          # moronbanner: This is the text that is sent to a user when they are
522          # banned from the server.
523          moronbanner="You're banned! Email haha@abuse.com with the ERROR line below for help."
524
525          # exemptchanops: Defines what channel modes channel operators are
526          # exempt from. Supported modes are +TCGfcSFBgN. Defaults to off.
527          exemptchanops=""
528
529          # invitebypassmodes: This allows /invite to bypass other channel modes.
530          # (Such as +k, +j, +l, etc)
531          invitebypassmodes="yes">
532
533
534 #-#-#-#-#-#-#-#-#-#-#-# PERFORMANCE CONFIGURATION #-#-#-#-#-#-#-#-#-#-#
535 #                                                                     #
536
537 <performance
538              # netbuffersize: Size of the buffer used to recieve data from clients.
539              # The ircd may only read this amount of text in 1 go at any time.
540              netbuffersize="10240"
541
542              # maxwho: Maximum number of results to show in a /who query.
543              maxwho="4096"
544
545              # somaxconn: The maximum number of connections that may be waiting
546              # in the accept queue. This is *NOT* the total maximum number of
547              # connections per server. Some systems may only allow this to be up
548              # to 5, while others (such as linux and *BSD) default to 128.
549              somaxconn="128"
550
551              # softlimit: This optional feature allows a defined softlimit for
552              # connections. If defined, it sets a soft max connections value.
553              # must be lower than ./configure maxclients.
554              softlimit="12800"
555
556              # quietbursts: When syncing or splitting from a network, a server
557              # can generate a lot of connect and quit messages to opers with
558              # +C and +Q snomasks. Setting this to yes squelches those messages,
559              # which makes it easier for opers, but degrades the functionality of
560              # bots like BOPM during netsplits.
561              quietbursts="yes"
562
563              # nouserdns: If enabled, no DNS lookups will be performed on
564              # connecting users. This can save a lot of resources on very busy servers.
565              nouserdns="no">
566
567 #-#-#-#-#-#-#-#-#-#-#-# SECURITY CONFIGURATION  #-#-#-#-#-#-#-#-#-#-#-#
568 #                                                                     #
569
570 <security
571
572           # announceinvites: If this option is set, then invites are announced
573           # to the channel when a user invites another user. If you consider
574           # this to be unnecessary noise, set this to 'none'.
575           # To announce to all ops, set this to 'ops' and to announce to all users,
576           # set the value to 'all'. The value 'dynamic' will make the messages
577           # go to every user who has power of INVITE on the channel. This
578           # is the recommended setting.
579           announceinvites="dynamic"
580
581           # hidemodes: If enabled, then the listmodes given will be hidden
582           # from users below halfop. This is not recommended to be set on +b
583           # as it may break some functionality in popular clients such as mIRC.
584           hidemodes="eI"
585
586           # hideulines: If this value is set to yes, U-lined servers will
587           # be hidden from non-opers in /links and /map.
588           hideulines="no"
589
590           # flatlinks: If this value is set to yes, /map and /links will
591           # be flattened when shown to non-opers.
592           flatlinks="no"
593
594           # hidewhois: When defined, the given text will be used in place
595           # of the server a user is on when whoised by a non-oper. Most
596           # networks will want to set this to something like "*.netname.net"
597           # to conceal the actual server a user is on.
598           hidewhois=""
599
600           # hidebans: If this value is set to yes, when a user is banned ([gkz]lined)
601           # only opers will see the ban message when the user is removed
602           # from the server.
603           hidebans="no"
604
605           # hidekills: If defined, replaces who set a /kill with a custom string.
606           hidekills=""
607
608           # hidesplits: If enabled, non-opers will not be able to see which
609           # servers split in a netsplit, they will only be able to see that one
610           # occurred (If their client has netsplit detection).
611           hidesplits="no"
612
613           # maxtargets: Maximum number of targets per command.
614           # (Commands like /notice, /privmsg, /kick, etc)
615           maxtargets="20"
616
617           # customversion: Displays a custom string when a user /version's
618           # the ircd. This may be set for security reasons or vanity reasons.
619           customversion=""
620
621           # operspywhois: If this is set to yes, when a oper /whois 's a user,
622           # it will show all channels the user is in including +s and +p
623           # channels.
624           operspywhois="no"
625
626           # runasuser: If this is set, InspIRCd will attempt to setuid
627           # to run as this user- allows binding of ports under 1024.
628           # NOT SUPPORTED/NEEDED UNDER WINDOWS.
629           #runasuser=""
630
631           # runasgroup: If this is set, InspIRCd will attempt to set group
632           # to run under this group, which allows binding of ports under 1024
633           # NOT SUPPORTED/NEEDED UNDER WINDOWS.
634           #runasgroup=""
635
636           # restrictbannedusers: If this is set to yes, InspIRCd will not allow users
637           # banned on a channel to change nickname or message channels they are
638           # banned on.
639           restrictbannedusers="yes"
640
641           # genericoper: Setting this value to yes makes all opers on this server
642           # appear as 'is an IRC operator' in their WHOIS, regardless of their
643           # oper type, however oper types are still used internally. This only
644           # affects the display in WHOIS.
645           genericoper="no"
646
647           # userstats: /stats commands that users can run (opers can run all).
648           userstats="Pu">
649
650 #-#-#-#-#-#-#-#-#-#-#-#-# LIMITS CONFIGURATION  #-#-#-#-#-#-#-#-#-#-#-#
651 #                                                                     #
652 # This configuration tag defines the maximum sizes of various types   #
653 # on IRC, such as the maximum length of a channel name, and the       #
654 # maximum length of a channel. Note that with the exception of the    #
655 # identmax value all values given here are the exact values you would #
656 # expect to see on IRC. This contrasts with the older InspIRCd        #
657 # releases where these values would be one character shorter than     #
658 # defined to account for a null terminator on the end of the text.    #
659 #                                                                     #
660 # These values should match network-wide otherwise issues will occur. #
661 #                                                                     #
662 # The highest safe value you can set any of these options to is 500,  #
663 # but it is recommended that you keep them somewhat                   #
664 # near their defaults (or lower).                                     #
665
666 <limits
667         # maxnick: Maximum length of a nickname.
668         maxnick="31"
669
670         # maxchan: Maximum length of a channel name.
671         maxchan="64"
672
673         # maxmodes: Maximum number of mode changes per line.
674         maxmodes="20"
675
676         # maxident: Maximum length of a ident/username.
677         maxident="11"
678
679         # maxquit: Maximum length of a quit message.
680         maxquit="255"
681
682         # maxtopic: Maximum length of a channel topic.
683         maxtopic="307"
684
685         # maxkick: Maximum length of a kick message.
686         maxkick="255"
687
688         # maxgecos: Maximum length of a GECOS (realname).
689         maxgecos="128"
690
691         # maxaway: Maximum length of an away message.
692         maxaway="200">
693
694
695 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
696 # Logging
697 # -------
698 #
699 # Logging is covered with the <log> tag, which you may use to change
700 # the behaviour of the logging of the IRCd.
701 #
702 # In InspIRCd as of 1.2, logging is pluggable and very extensible.
703 # Different files can log the same thing, different 'types' of log can
704 # go to different places, and modules can even extend the log tag
705 # to do what they want.
706 #
707 # An example log tag would be:
708 #       <log method="file" type="OPER" level="default" target="opers.log">
709 # which  would log all information on /oper (failed and successful) to
710 # a file called opers.log.
711 #
712 # There are many different types which may be used, and modules may
713 # generate their own. A list of useful types:
714 #       - USERS - information relating to user connection and disconnection
715 #       - CHANNELS - information relating to joining and parting of channels.
716 # XXX someone doc more on this
717 #
718 # You may also log *everything* by using a type of *, and subtract things out
719 # of that by using -TYPE - for example "* -USERINPUT -USEROUTPUT".
720 #
721 # The following log tag is highly default and uncustomised. It is recommended you
722 # sort out your own log tags. This is just here so you get some output.
723
724 <log method="file" type="* -USERINPUT -USEROUTPUT -m_spanningtree" level="default" target="ircd.log">
725
726 #-#-#-#-#-#-#-#-#-#-#-#-#-  WHOWAS OPTIONS   -#-#-#-#-#-#-#-#-#-#-#-#-#
727 #                                                                     #
728 # This tag lets you define the behaviour of the /whowas command of    #
729 # your server.                                                        #
730 #                                                                     #
731
732 <whowas
733         # groupsize: Maximum entries per nick shown when performing
734         # a /whowas nick.
735         groupsize="10"
736
737         # maxgroups: Maximum number of nickgroups that can be added to
738         # the list so that /whowas does not use a lot of resources on
739         # large networks.
740         maxgroups="100000"
741
742         # maxkeep: Maximum time a nick is kept in the whowas list
743         # before being pruned. Time may be specified in seconds,
744         # or in the following format: 1y2w3d4h5m6s. Minimum is
745         # 1 hour.
746         maxkeep="3d">
747
748 #-#-#-#-#-#-#-#-#-#-#-#-#-#-  BAN OPTIONS  -#-#-#-#-#-#-#-#-#-#-#-#-#-#
749 #                                                                     #
750 # The ban tags define nick masks, host masks and ip ranges which are  #
751 # banned from your server. All details in these tags are local to     #
752 # Your server.                                                        #
753 #                                                                     #
754
755 <badip
756        # ipmask: IP range to ban. Wildcards and CIDR can be used.
757        ipmask="69.69.69.69"
758
759        # reason: Reason to display when user is disconnected.
760        reason="No porn here thanks.">
761
762 <badnick
763          # nick: Nick to disallow. Wildcards are supported.
764          nick="ChanServ"
765
766          # reason: Reason to display on /nick.
767          reason="Reserved For Services">
768
769 <badnick nick="NickServ" reason="Reserved For Services">
770 <badnick nick="OperServ" reason="Reserved For Services">
771 <badnick nick="MemoServ" reason="Reserved For Services">
772
773 <badhost
774          # host: ident@hostname to ban.
775          # Wildcards and CIDR (if you specify an IP) can be used.
776          host="*@hundredz.n.hundredz.o.1337.kiddies.com"
777
778          # reason: Reason to display when user is disconnected
779          reason="Too many 1337 kiddiots">
780
781 <badhost host="root@*" reason="Don't irc as root!">
782 <badhost host="*@172.32.0.0/16" reason="This subnet is bad.">
783
784 # exception: Hosts that are exempt from [kgz]lines.
785 <exception
786            # host: ident@hostname to exempt.
787            # Wildcards and CIDR (if you specify an IP) can be used.
788            host="*@ircop.host.com"
789
790            # reason: Reason for exception. Only shown in /stats e
791            reason="Opers hostname">
792
793 #-#-#-#-#-#-#-#-#-#-#- INSANE BAN OPTIONS  -#-#-#-#-#-#-#-#-#-#-#-#-#-#
794 #                                                                     #
795 # This optional tag allows you to specify how wide a gline, eline,    #
796 # kline, zline or qline can be before it is forbidden from being      #
797 # set. By setting hostmasks="yes", you can allow all G, K, E lines,   #
798 # no matter how many users the ban would cover. This is not           #
799 # recommended! By setting ipmasks="yes", you can allow all Z lines,   #
800 # no matter how many users these cover too. Needless to say we        #
801 # don't recommend you do this, or, set nickmasks="yes", which will    #
802 # allow any qline.                                                    #
803 #                                                                     #
804
805 <insane
806         # hostmasks: Allow bans with insane hostmasks. (over-reaching bans)
807         hostmasks="no"
808
809         # ipmasks: Allow bans with insane ipmasks. (over-reaching bans)
810         ipmasks="no"
811
812         # nickmasks: Allow bans with insane nickmasks. (over-reaching bans)
813         nickmasks="no"
814
815         # trigger: What percentage of users on the network to trigger
816         # specifying an insane ban as. The default is 95.5%, which means
817         # if you have a 1000 user network, a ban will not be allowed if it
818         # will be banning 955 or more users.
819         trigger="95.5">
820
821
822 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#- YAWN  -#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
823 #                                                                     #
824 #   You should already know what to do here :)                        #
825
826 <die value="User error. Insert new user and press any key. (you didn't edit your config properly.)">
827
828 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# MODULES #-#-#-#-#-#-#-#-#-#-#-#-#-#-#
829 #    ____                _   _____ _     _       ____  _ _   _        #
830 #   |  _ \ ___  __ _  __| | |_   _| |__ (_)___  | __ )(_) |_| |       #
831 #   | |_) / _ \/ _` |/ _` |   | | | '_ \| / __| |  _ \| | __| |       #
832 #   |  _ <  __/ (_| | (_| |   | | | | | | \__ \ | |_) | | |_|_|       #
833 #   |_| \_\___|\__,_|\__,_|   |_| |_| |_|_|___/ |____/|_|\__(_)       #
834 #                                                                     #
835 # Well done, you've reached the end of the basic configuration, your  #
836 # ircd should now start if you want to try it out! (./inspircd start) #
837 #                                                                     #
838 # We now suggest you read and edit modules.conf, as modules are what  #
839 # provide almost all the features of InspIRCd. :)                     #
840 #                                                                     #
841 # The default does nothing -- we include it for simplicity for you.   #
842 <include file="modules.conf.example">
843
844
845 #########################################################################
846 #                                                                       #
847 #                     - InspIRCd Development Team -                     #
848 #                        http://www.inspircd.org                        #
849 #                                                                       #
850 #########################################################################