README.md

   1 # charybdis
   2
   3 Charybdis is a reference implementation of the IRCv3.1 server component.  It is meant to be
   4 used with an IRCv3-capable services implementation such as [Atheme][atheme] or [Anope][anope].
   5
   6    [atheme]: http://www.atheme.net/
   7    [anope]: http://www.anope.org/
   8
   9 # necessary requirements
  10
  11  * A supported platform
  12  * A working dynamic load library.
  13  * A working lex.  Solaris /usr/ccs/bin/lex appears to be broken, on this system flex should be used.
  14
  15 # feature specific requirements
  16
  17  * For SSL Clients, SSL Challenge controlled OPER feature, and encrypted server links,
  18    a working OpenSSL library or GnuTLS library.  CHALLENGE is not supported on GnuTLS
  19    yet.
  20
  21  * For ECDHE, OpenSSL 1.0.0 or newer is required. RHEL/Fedora and derivatives like CentOS
  22    will need to compile OpenSSL from source, as ECC/ECDHE-functionality is removed from
  23    the OpenSSL package in these distributions.
  24
  25 # tips
  26
  27  * To report bugs in charybdis, visit us at irc.freenode.net #charybdis
  28
  29  * Please read doc/index.txt to get an overview of the current documentation.
  30
  31  * The files, /etc/services, /etc/protocols, and /etc/resolv.conf, SHOULD be
  32    readable by the user running the server in order for ircd to start with
  33    the correct settings.  If these files are wrong, charybdis will try to use
  34    127.0.0.1 for a resolver as a last-ditch effort.
  35
  36  * FREEBSD USERS: if you are compiling with ipv6 you may experience
  37    problems with ipv4 due to the way the socket code is written.  To
  38    fix this you must: "sysctl net.inet6.ip6.v6only=0"
  39
  40  * SOLARIS USERS: this code appears to tickle a bug in older gcc and
  41    egcs ONLY on 64-bit Solaris7.  gcc-2.95 and SunPro C on 64bit should
  42    work fine, and any gcc or SunPro compiled on 32bit.
  43
  44  * SUPPORTED PLATFORMS: this code should compile without any warnings on:
  45
  46    * FreeBSD 10
  47    * Gentoo & Gentoo Hardened ~x86/~amd64/~fbsd
  48    * RHEL 6 / 7
  49    * Debian Jessie
  50    * OpenSuSE 11/12
  51    * OpenSolaris 2008.x?
  52    * Solaris 10 sparc.
  53
  54   Please let us know if you find otherwise.
  55   It probably does not compile on AIX, IRIX or libc5 Linux.
  56
  57  * Please read NEWS for information about what is in this release.
  58
  59  * Other files recommended for reading: BUGS, INSTALL