README.FIRST

   1 ******************************* IMPORTANT *************************************
   2
   3   *********** Note for those who dont bother reading docs *****************
   4   * - Reading INSTALL is now a must, as the old DPATH is now specified    *
   5   *   when configure is run.                                              *
   6   *   You now need to ./configure --prefix="/path/to/install/it"          *
   7   *   to specify the path that will be installed with your ircd!          *
   8   *************************************************************************
   9
  10   ALSO, IF YOU ARE UPGRADING YOUR CURRENT SOURCE TREE, AND YOU TRY TO BUILD
  11   IN IT WITHOUT PERFORMING AT LEAST 'make clean', THINGS _WILL_ BREAK.  IT IS
  12   RECOMMENDED THAT YOU RUN 'make distclean' AND THEN RERUN './configure'!
  13
  14 ******************************* REQUIREMENTS **********************************
  15
  16 Necessary Requirements:
  17
  18 - A supported platform (look below)
  19
  20 - A working dynamic load library.
  21
  22 - A working lex.  Solaris /usr/ccs/bin/lex
  23   appears to be broken, on this system flex
  24   should be used.
  25
  26
  27 Feature Specific Requirements:
  28
  29 - For SSL Clients, SSL Challenge controlled OPER feature, and encrypted server links,
  30   a working OpenSSL library or GnuTLS library.  CHALLENGE is not supported on GnuTLS
  31   yet.
  32
  33 - For encrypted oper and (optional) server passwords, a working DES, MD5, or SHA library
  34   implementing crypt().
  35
  36 - For ECDHE, OpenSSL 1.0.0 or newer is required. RHEL/Fedora and derivatives like CentOS
  37   will need to compile OpenSSL from source, as ECC/ECDHE-functionality is removed from
  38   the OpenSSL package in these distributions.
  39
  40 *******************************************************************************
  41
  42 - To report bugs in charybdis, visit us at irc.atheme.org #charybdis
  43
  44 - See the INSTALL document for info on configuring and compiling
  45   charybdis.
  46
  47 - Please read doc/index.txt to get an overview of the current documentation.
  48
  49 - The files, /etc/services, /etc/protocols, and /etc/resolv.conf, SHOULD be
  50   readable by the user running the server in order for ircd to start with
  51   the correct settings.  If these files are wrong, charybdis will try to use
  52   127.0.0.1 for a resolver as a last-ditch effort.
  53
  54 - FREEBSD USERS: if you are compiling with ipv6 you may experience
  55   problems with ipv4 due to the way the socket code is written.  To
  56   fix this you must: "sysctl net.inet6.ip6.v6only=0"
  57
  58 - SOLARIS USERS: this code appears to tickle a bug in older gcc and
  59   egcs ONLY on 64-bit Solaris7.  gcc-2.95 and SunPro C on 64bit should
  60   work fine, and any gcc or SunPro compiled on 32bit.
  61
  62 - DARWIN AND MACOS X USERS: You must be using at least the December 2001
  63   Development Tools from Apple to build charybdis with shared modules.
  64   Before then you MUST disable shared modules, as we do not have the proper
  65   flags for cc(1) prior to that point to produce shared modules.
  66
  67 - SUPPORTED PLATFORMS: this code should compile without any warnings on:
  68     FreeBSD 6.x/7.x,
  69     Gentoo & Gentoo Hardened ~x86/~amd64/~fbsd
  70     Fedora 8/9 / CentOS 4/5 / Redhat Enterprise 5
  71     Debian Etch,
  72     OpenSuSE 10/11,
  73     OpenSolaris 2008.x?
  74     Solaris 10 sparc.
  75
  76   Please let us know if you find otherwise.
  77   It probably does not compile on AIX, IRIX or libc5 Linux.
  78
  79 - TESTED PLATFORMS:  The code has been tested on the following platforms, and
  80   is known to run properly.
  81   FreeBSD 6.x/7.x
  82   Linux glibc-2.6, glibc-2.7
  83   Solaris 2.6/7/8
  84   OpenBSD 2.8
  85   NetBSD 1.4
  86
  87 - Please read NEWS for information about what is in this release.
  88
  89 - Other files recommended for reading: BUGS, INSTALL