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 and oplevels) are
  11 not 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 A new channel mode, +D, has been added for auditorium-style channels.
  42 These are channels where most users listen but do not speak or receive
  43 ops or voice.  The effect of +D is that the server waits to send the
  44 JOIN message for new users until the user gets ops or voice or sends a
  45 message to the channel.  A list of join-delayed users in a channel may
  46 be retrieved by using /NAMES -d #channel.  The response to /NAMES -d
  47 uses the same format as numeric 353, but uses numeric 355 instead. If
  48 an op removes +D while there are still join-delayed users, the server
  49 automatically sets mode +d, and removes +d when the last user's join
  50 is shown.  It is not possible to set channel mode +d manually; its
  51 purpose is to warn channel users that there are "hidden" users in the
  52 channel.
  53
  54 More than one hashing mechanism is now supported for oper passwords,
  55 and a new tool (ircd/umkpasswd) is provided to generate them.
  56
  57 Commands that send messages to specified services may be defined in
  58 the configuration file by using Pseudo blocks.  This lets users use
  59 commands like /X or /CHANSERV from their client, without tying the
  60 admin to a particular arrangement or naming of services.
  61
  62 The /stats command accepts string identifiers in addition to
  63 single-character identifiers.  For example, "/stats access" shows the
  64 same data as "/stats i".  Supported names are shown by /stats.  New
  65 /stats options are: /stats a (nameservers), to list DNS nameservers in
  66 use; /stats L (modules), to list loaded modules; and /stats R
  67 (mappings), to list privmsg helper commands defined by Pseudo blocks.
  68 By default, all of these are hidden from normal users.
  69
  70 Client blocks (previously I: lines), Operator blocks (previously O:
  71 and o: lines), channel bans and silences may use CIDR notation instead
  72 of simple wildcards.  You may also have silence exceptions by putting
  73 '~' before the mask; for example, if you wish to silence everyone
  74 except X, you could use SILENCE *!*@*,~X!cservice@undernet.org.
  75
  76 The server will no longer kick "net riders" in keyed (+k) channels if
  77 both sides of the net join have the same key.
  78
  79 Configuration Changes:
  80
  81 As mentioned above, the configuration file format has changed
  82 radically.  Please consult doc/example.conf for details on the
  83 new format.  Some prominent changes follow.
  84
  85 The old contents of H: lines have been merged into the Connect block
  86 that describes the peer server(s) that should be allowed to hub.
  87
  88 Two default virtual host addresses may be specified, one for IPv4
  89 sockets and one for IPv6 sockets.
  90
  91 Nickname jupes have their own blocks, and do not share structure with
  92 UWorld server declarations.
  93
  94 Operator connection classes and individual operator blocks may be
  95 assigned privileges, rather than having them controlled globally.
  96 Because of this, the feature settings that controlled the privileges
  97 globally have been removed.
  98
  99 The maximum number of clients allowed per IP may be set in a Client
 100 block (the equivalent of C: lines).
 101
 102 New feature settings (see doc/readme.features for explanations):
 103 ANNOUNCE_INVITES, HIS_STATS_L, HIS_STATS_a, HIS_STATS_R,
 104 LOCAL_CHANNELS, TOPIC_BURST.
 105
 106 Deleted features, since they had no effect even in 2.10.11: AUTOHIDE,
 107 HIS_DESYNCS, TIMESEC.
 108
 109 Deleted features since they are now controlled by other configuration
 110 entries: VIRTUAL_HOST, oper and locop privilege features.
 111
 112 Compile Time Options:
 113
 114 A listing of supported compile-time options may be seen by running
 115 "./configure --help".  The defaults should be sane.  In particular,
 116 you should NOT compile with --enable-debug or with --disable-symbols
 117 on a production network.
 118
 119 Otherwise Undocumented Features:
 120
 121 Despite our preferences to keep these undocumented, they are
 122 occasionally useful, and are described here for users who may
 123 need them.
 124
 125 To enable these, you need to add them to CFLAGS prior to running
 126 ./configure, usually as in: CFLAGS="-O2 -D<option>" ./configure
 127
 128 -DNICKLEN=20
 129
 130   This allows you change the maximum nick length from 15 to 20 (or
 131 whatever number you use at the end).  It MUST be the same on all
 132 servers on your network, or bad things will happen.  You should also
 133 use the NICKLEN feature in ircd.conf.
 134
 135 -DNOTHROTTLE
 136   This disables the throttling code.  This is used for debugging
 137 *only*.  It lets you connect up to 255 clients from one host with no
 138 time considerations.  If this is enabled on a production server Kev will
 139 personally drive your server into the ground.  You have been warned.
 140
 141
 142 Operating System and Kernel Requirements:
 143
 144 If you plan allowing more than 1000 clients on your server, you may
 145 need to adjust your kernel resource limits for networking and
 146 I/O. There are two things you will need to pay particular attention
 147 to, the number of file descriptors available and the number of buffers
 148 the kernel has available to read and write data to the file
 149 descriptors.
 150
 151 To calculate kernel buffer requirements a good place to start is to
 152 multiply the expected number connections expected on the machine by
 153 the amount of data we buffer for each connection.  Doubling the result
 154 of the above calculation and dividing it by the size of the buffers
 155 the kernel uses for I/O should give you a starting place.
 156
 157 The server uses 2K kernel buffers for clients, and 64K kernel buffers
 158 for servers (actual use may be somewhat higher).
 159
 160 c_count - number of clients expected
 161 c_q     - number of bytes buffered for each client
 162 s_count - number of servers expected
 163 s_q     - number of bytes buffered for each server
 164
 165 buffer count = (2 * (c_count * c_q + s_count * s_q)) / kernel buffer size
 166
 167 If the client count is 2000 and the server count is 1 (normal leaf)
 168 and your server uses 2K as an I/O buffer size:
 169
 170 You need (2 * (2000 * 2048 + 1 * 65536)) / 2048 or a minimum of 4064
 171 buffers available, if the kernel uses 512 byte buffers you will need a
 172 minimum of 16256 kernel buffers.
 173
 174 These settings may be a bit light for net-breaks under full client
 175 load you will need to experiment a bit to find the right settings for
 176 your server.
 177
 178 FreeBSD --WildThang
 179
 180 You may want to increase your kernel resources if you want to put a
 181 lot of clients on your machine here are a few values to start with:
 182
 183 CHILD_MAX=4096
 184 OPEN_MAX=4096
 185 FD_SETSIZE=4096
 186 NMBCLUSTERS=8096
 187
 188 If you have trouble connecting *out* from your machine try:
 189  sysctl -w net.inet.ip.portrange.last=10000
 190
 191 Solaris 2.6  --Tar
 192
 193 Increase the default hard limit for file descriptors in /etc/system:
 194
 195 set rlim_fd_max = 4096
 196
 197 The server will raise the soft limit to the hard limit.
 198
 199 Linux 2.2 -- [Tri]/Isomer
 200
 201 The kernel has a kernel destination cache size of 4096.  If the kernel
 202 sees more than 4096 IP's in 60s it warns 'dst cache overflow'.  This
 203 limit can be changed by modifying /proc/sys/net/ipv4/route/max_size.
 204
 205 A patch to select is also recommended if you have regular poll/select
 206 errors.