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