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