README.FIRST

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