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