README.md

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