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