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/TLS client and server connections, one of:
  18
  19    * OpenSSL 1.0 or newer
  20    * LibreSSL
  21    * mbedTLS
  22    * GnuTLS
  23
  24  * For certificate-based oper CHALLENGE, OpenSSL 1.0 or newer.
  25    (Using CHALLENGE is not recommended for new deployments, so if you want to use a different TLS library,
  26     feel free.)
  27
  28  * For ECDHE, OpenSSL 1.0.0 or newer is required. RHEL/Fedora and derivatives like CentOS
  29    will need to compile OpenSSL from source, as ECC/ECDHE-functionality is removed from
  30    the OpenSSL package in these distributions.
  31
  32 # tips
  33
  34  * To report bugs in charybdis, visit us at irc.freenode.net #charybdis
  35
  36  * Please read doc/index.txt to get an overview of the current documentation.
  37
  38  * The files, /etc/services, /etc/protocols, and /etc/resolv.conf, SHOULD be
  39    readable by the user running the server in order for ircd to start with
  40    the correct settings.  If these files are wrong, charybdis will try to use
  41    127.0.0.1 for a resolver as a last-ditch effort.
  42
  43  * FREEBSD USERS: if you are compiling with ipv6 you may experience
  44    problems with ipv4 due to the way the socket code is written.  To
  45    fix this you must: "sysctl net.inet6.ip6.v6only=0"
  46
  47  * SOLARIS USERS: this code appears to tickle a bug in older gcc and
  48    egcs ONLY on 64-bit Solaris7.  gcc-2.95 and SunPro C on 64bit should
  49    work fine, and any gcc or SunPro compiled on 32bit.
  50
  51  * SUPPORTED PLATFORMS: this code should compile without any warnings on:
  52
  53    * FreeBSD 10
  54    * Gentoo & Gentoo Hardened ~x86/~amd64/~fbsd
  55    * RHEL 6 / 7
  56    * Debian Jessie
  57    * OpenSuSE 11/12
  58    * OpenSolaris 2008.x?
  59    * Solaris 10 sparc.
  60
  61   Please let us know if you find otherwise.
  62   It probably does not compile on AIX, IRIX or libc5 Linux.
  63
  64  * Please read NEWS for information about what is in this release.
  65
  66  * Other files recommended for reading: BUGS, INSTALL