RELEASE.NOTES

   1 Release notes for ircu2.10.12
   2 Last updated: 14 Jan 2005
   3 Written by Michael Poole <mdpoole@troilus.org>
   4 Based on earlier documents by Kev <klmitch@mit.edu> and
   5 Braden <dbtem@yahoo.com>.
   6
   7 This document briefly describes changes in ircu2.10.12 relative to
   8 ircu2.10.11.  ircu2.10.12 is only compatible with servers that
   9 implement the P10 protocol.  It has been tested to link against
  10 ircu2.10.11, but some features (notably IPv6 support) are not
  11 supported by ircu2.10.11.
  12
  13 Enhancements:
  14
  15 The configuration file format has changed to one that is easier to
  16 read.  It is based on the configuration parser found in ircd-hybrid.
  17 As usual, an example configuration file can be found in the doc
  18 subdirectory.
  19
  20 ircu now supports IPv6 clients.  If your operating system provides
  21 IPv6 socket support, ircu can accept connections on IPv6 addresses.
  22 Even if your operating system does not support IPv6 sockets, you can
  23 link (using IPv4) to a server that has IPv6 clients, and ircu will
  24 treat the IPv6 clients correctly.
  25
  26 The DNS resolver has been replaced with a streamlined version (also
  27 from ircd-hybrid) that avoids some of the complications from using
  28 the full libresolv or adns libraries.
  29
  30 The server can query an IAUTH external authorization server.  The
  31 protocol is described in doc/readme.iauth.  This allows an external
  32 program to accept or reject any client that connects to the server
  33 and allows that external program to assign an account stamp to the
  34 incoming user.
  35
  36 A new feature called "oplevels" has been added.  It uses new channel
  37 keys (+A for the administrator, +U for users) to grant chanop status
  38 when you join using those keys.  Part of this channel protection is
  39 that you cannot be deopped in channel by someone who you opped.
  40
  41 More than one hashing mechanism is now supported for oper passwords,
  42 and a new tool (ircd/umkpasswd) is provided to generate them.
  43
  44 Commands that send messages to specified services may be defined in
  45 the configuration file by using Pseudo blocks.  This lets users use
  46 commands like /X or /CHANSERV from their client, without tying the
  47 admin to a particular arrangement or naming of services.
  48
  49 Clients may negotiate extensions and changes to the standard IRC
  50 client protocol by using the CAP command during registration.  There
  51 does not appear to be any documentation for the protocol, which should
  52 not matter since ircu does not currently implement capabilities that
  53 affect the protocol.
  54
  55 The /stats command accepts string identifiers in addition to
  56 single-character identifiers.  For example, "/stats access" shows the
  57 same data as "/stats i".  Supported names are shown by /stats.  New
  58 /stats options are: /stats a (nameservers), to list DNS nameservers in
  59 use; /stats L (modules), to list loaded modules; and /stats R
  60 (mappings), to list privmsg helper commands defined by Pseudo blocks.
  61 By default, all of these are hidden from normal users.
  62
  63 Configuration Changes:
  64
  65 As mentioned above, the configuration file format has changed
  66 radically.  Please consult doc/example.conf for details on the
  67 new format.  Some prominent changes follow.
  68
  69 The old contents of H: lines have been merged into the Connect block
  70 that describes the peer server(s) that should be allowed to hub.
  71
  72 Two default virtual host addresses may be specified, one for IPv4
  73 sockets and one for IPv6 sockets.
  74
  75 Nickname jupes have their own blocks, and do not share structure with
  76 UWorld server declarations.
  77
  78 Operator connection classes and individual operator blocks may be
  79 assigned privileges, rather than having them controlled globally.
  80 Because of this, the feature settings that controlled the privileges
  81 globally have been removed.
  82
  83 The maximum number of clients allowed per IP may be set in a Client
  84 block (the equivalent of C: lines).
  85
  86 New feature settings (see doc/readme.features for explanations):
  87 ANNOUNCE_INVITES, HIS_STATS_L, HIS_STATS_a, HIS_STATS_R,
  88 LOCAL_CHANNELS, TOPIC_BURST.
  89
  90 Deleted features, since they had no effect even in 2.10.11: AUTOHIDE,
  91 HIS_DESYNCS, TIMESEC.
  92
  93 Deleted features since they are now controlled by other configuration
  94 entries: VIRTUAL_HOST, oper and locop privilege features.
  95
  96 Compile Time Options:
  97
  98 A listing of supported compile-time options may be seen by running
  99 "./configure --help".  The defaults should be sane.  In particular,
 100 you should NOT compile with --enable-debug or with --disable-symbols
 101 on a production network.
 102
 103 Otherwise Undocumented Features:
 104
 105 Despite our preferences to keep these undocumented, they are
 106 occasionally useful, and are described here for users who may
 107 need them.
 108
 109 To enable these, you need to add them to CFLAGS prior to running
 110 ./configure, usually as in: CFLAGS="-O2 -D<option>" ./configure
 111
 112 -DNICKLEN=20
 113
 114   This allows you change the maximum nick length from 15 to 20 (or
 115 whatever number you use at the end).  It MUST be the same on all
 116 servers on your network, or bad things will happen.  You should also
 117 use the NICKLEN feature in ircd.conf.
 118
 119 -DNOTHROTTLE
 120   This disables the throttling code.  This is used for debugging
 121 *only*.  It lets you connect up to 255 clients from one host with no
 122 time considerations.  If this is enabled on a production server Kev will
 123 personally drive your server into the ground.  You have been warned.
 124
 125
 126 Operating System and Kernel Requirements:
 127
 128 If you plan allowing more than 1000 clients on your server, you may
 129 need to adjust your kernel resource limits for networking and
 130 I/O. There are two things you will need to pay particular attention
 131 to, the number of file descriptors available and the number of buffers
 132 the kernel has available to read and write data to the file
 133 descriptors.
 134
 135 To calculate kernel buffer requirements a good place to start is to
 136 multiply the expected number connections expected on the machine by
 137 the amount of data we buffer for each connection.  Doubling the result
 138 of the above calculation and dividing it by the size of the buffers
 139 the kernel uses for I/O should give you a starting place.
 140
 141 The server uses 2K kernel buffers for clients, and 64K kernel buffers
 142 for servers (actual use may be somewhat higher).
 143
 144 c_count - number of clients expected
 145 c_q     - number of bytes buffered for each client
 146 s_count - number of servers expected
 147 s_q     - number of bytes buffered for each server
 148
 149 buffer count = (2 * (c_count * c_q + s_count * s_q)) / kernel buffer size
 150
 151 If the client count is 2000 and the server count is 1 (normal leaf)
 152 and your server uses 2K as an I/O buffer size:
 153
 154 You need (2 * (2000 * 2048 + 1 * 65536)) / 2048 or a minimum of 4064
 155 buffers available, if the kernel uses 512 byte buffers you will need a
 156 minimum of 16256 kernel buffers.
 157
 158 These settings may be a bit light for net-breaks under full client
 159 load you will need to experiment a bit to find the right settings for
 160 your server.
 161
 162 FreeBSD --WildThang
 163
 164 You may want to increase your kernel resources if you want to put a
 165 lot of clients on your machine here are a few values to start with:
 166
 167 CHILD_MAX=4096
 168 OPEN_MAX=4096
 169 FD_SETSIZE=4096
 170 NMBCLUSTERS=8096
 171
 172 If you have trouble connecting *out* from your machine try:
 173  sysctl -w net.inet.ip.portrange.last=10000
 174
 175 Solaris 2.6  --Tar
 176
 177 Increase the default hard limit for file descriptors in /etc/system:
 178
 179 set rlim_fd_max = 4096
 180
 181 The server will raise the soft limit to the hard limit.
 182
 183 Linux 2.2 -- [Tri]/Isomer
 184
 185 The kernel has a kernel destination cache size of 4096.  If the kernel
 186 sees more than 4096 IP's in 60s it warns 'dst cache overflow'.  This
 187 limit can be changed by modifying /proc/sys/net/ipv4/route/max_size.
 188
 189 A patch to select is also recommended if you have regular poll/select
 190 errors.