README

   1
   2         Welcome to ircu2.10.11, the Undernet IRC daemon
   3
   4 Version u2.10.11 of the Undernet ircd incorporates many new features
   5 over its predecessor, and we feel that using it will make you very
   6 happy indeed.
   7
   8 New features include:
   9   - A completely rewritten network event engine, which make full use
  10     of the asynchronous event engines available in FreeBSD (kqueue)
  11     and Solaris (/dev/poll), resulting in dramaticaly improved
  12     performance.
  13   - New F: (feature) lines in ircd.conf, and the GET/SET commands allow
  14     many settings to be changed dynamically, rather than by with compile-
  15     time configuration.
  16   - The new "account" feature added to the P10 protocol, allows people to
  17     remain logged in to service bots (i.e., gnuworld) during a netsplit.
  18     This means people will not have to login again once the network rejoins.
  19
  20 INSTALLATION
  21
  22 Please see the INSTALL file for installation instructions, for hints on how
  23 to best configure your OS for running ircu under high load, see the various
  24 README.<platform> files.
  25
  26 COMPATIBILITY
  27
  28 This version of ircu will only work with servers that use the P10 protocol,
  29 some of the new features will only work between ircu2.10.11 servers.
  30
  31 GENERAL PERFORMANCE HINTS
  32
  33 For platform-specific notes and hints, see the various README.<platform>
  34 files included in this distribution. The notes below apply to servers that
  35 will serve large numbers (thousands) of clients simultaneously. If your
  36 server serves a small amount of users, you will not really have to do much
  37 of anything about performance tuning.
  38
  39  - Run an OS that supports an asynchronous network event engine; currently
  40    these are FreeBSD (kqueue), and Solaris (/dev/poll); possibly other BSDs
  41    will also support kqueue. This will have a dramatic effect on performance.
  42  - Make things as lean as possible: Make your server dedicated to ircu,
  43    disable anything that is not neccesary, and build a custom kernel (where
  44    possible).
  45  - Tune kernel parameters; see the various README.<platform> files as well
  46    as your OS documentation for more information.
  47  - With many clients connecting each second, ircu will be doing lots of DNS
  48    lookups. Make sure that the DNS server(s) in your /etc/resolv.conf are as
  49    close as possible, or run a local caching DNS server on your IRC server.
  50
  51 TIME SYNCHRONIZATION
  52
  53 Many things can and will go horribly wrong when the clocks on the servers
  54 on your network become (too far) out of sync. It is therefore highly
  55 recommended that all servers run a version of ntpd that will keep their
  56 clocks from going astray.
  57
  58 INFORMATION HIDING
  59
  60 As per undernet-admins CFV-165, this server contains code that will,
  61 by default, hide certain information from ordinary users. If you do
  62 not want this, please make sure you add -DINCLUDED_ircd_policy_h to
  63 CFLAGS prior to running ./configure, like in:
  64
  65 > CFLAGS=-DINCLUDED_ircd_policy_h ./configure
  66
  67 MORE INFORMATION
  68
  69 For more information on this software, see the included documentation
  70 in the doc/ directory, as well as http://coder-com.undernet.org.
  71
  72 For general information on the Undernet, vist http://www.undernet.org
  73
  74 Happy IRCing!