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