README.md

   1 # charybdis [![POSIX Build Status](https://travis-ci.org/charybdis-ircd/charybdis.svg?branch=master)](https://travis-ci.org/charybdis-ircd/charybdis) [![Windows Build Status](https://ci.appveyor.com/api/projects/status/is0obsml8xyq2qk7/branch/master?svg=true)](https://ci.appveyor.com/project/kaniini/charybdis/branch/master)
   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 # building from git
  17
  18 We no longer supply a prebuilt configure script in git, due to use of automake and libtool causing problems.
  19 You will need to run `autogen.sh` to build the autotools files prior to building charybdis.
  20
  21 # feature specific requirements
  22
  23  * For SSL/TLS client and server connections, one of:
  24
  25    * OpenSSL 1.0 or newer
  26    * LibreSSL
  27    * mbedTLS
  28    * GnuTLS
  29
  30  * For certificate-based oper CHALLENGE, OpenSSL 1.0 or newer.
  31    (Using CHALLENGE is not recommended for new deployments, so if you want to use a different TLS library,
  32     feel free.)
  33
  34  * For ECDHE, OpenSSL 1.0.0 or newer is required. RHEL/Fedora and derivatives like CentOS
  35    will need to compile OpenSSL from source, as ECC/ECDHE-functionality is removed from
  36    the OpenSSL package in these distributions.
  37
  38 # tips
  39
  40  * To report bugs in charybdis, visit us at irc.freenode.net #charybdis
  41
  42  * Please read doc/index.txt to get an overview of the current documentation.
  43
  44  * The files, /etc/services, /etc/protocols, and /etc/resolv.conf, SHOULD be
  45    readable by the user running the server in order for ircd to start with
  46    the correct settings.  If these files are wrong, charybdis will try to use
  47    127.0.0.1 for a resolver as a last-ditch effort.
  48
  49  * FREEBSD USERS: if you are compiling with ipv6 you may experience
  50    problems with ipv4 due to the way the socket code is written.  To
  51    fix this you must: "sysctl net.inet6.ip6.v6only=0"
  52
  53  * SOLARIS USERS: you may have to set your PATH to include /usr/gnu/bin before /usr/bin. Solaris versions
  54    older than 10 are not supported.
  55
  56  * SUPPORTED PLATFORMS: this code should compile without any warnings on:
  57
  58    * FreeBSD 10
  59    * Gentoo & Gentoo Hardened ~x86/~amd64/~fbsd
  60    * RHEL 6 / 7
  61    * Debian Jessie
  62    * OpenSuSE 11/12
  63    * OpenSolaris 2008.x?
  64    * Solaris 10 sparc.
  65    * Solaris 11 x86
  66
  67   Please let us know if you find otherwise. It may work on other platforms, but this is not guaranteed.
  68
  69  * Please read NEWS for information about what is in this release.