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