-# charybdis
+# charybdis [![Build Status](https://travis-ci.org/charybdis-ircd/charybdis.svg?branch=master)](https://travis-ci.org/charybdis-ircd/charybdis)
-Charybdis is a reference implementation of the IRCv3.1 server component. It is meant to be
-used with an IRCv3-capable services implementation such as [Atheme][atheme] or [Anope][anope].
+Charybdis is an IRCv3 server designed to be highly scalable. It implements IRCv3.1 and some parts of IRCv3.2.
+
+It is meant to be used with an IRCv3-capable services implementation such as [Atheme][atheme] or [Anope][anope].
[atheme]: http://www.atheme.net/
[anope]: http://www.anope.org/
* A working dynamic load library.
* A working lex. Solaris /usr/ccs/bin/lex appears to be broken, on this system flex should be used.
+# building from git
+
+We no longer supply a prebuilt configure script in git, due to use of automake and libtool causing problems.
+You will need to run `autogen.sh` to build the autotools files prior to building charybdis.
+
# feature specific requirements
- * For SSL Clients, SSL Challenge controlled OPER feature, and encrypted server links,
- a working OpenSSL library or GnuTLS library. CHALLENGE is not supported on GnuTLS
- yet.
+ * For SSL/TLS client and server connections, one of:
+
+ * OpenSSL 1.0 or newer
+ * LibreSSL
+ * mbedTLS
+ * GnuTLS
+
+ * For certificate-based oper CHALLENGE, OpenSSL 1.0 or newer.
+ (Using CHALLENGE is not recommended for new deployments, so if you want to use a different TLS library,
+ feel free.)
* For ECDHE, OpenSSL 1.0.0 or newer is required. RHEL/Fedora and derivatives like CentOS
will need to compile OpenSSL from source, as ECC/ECDHE-functionality is removed from
# tips
- * To report bugs in charybdis, visit us at irc.atheme.org #charybdis
+ * To report bugs in charybdis, visit us at irc.freenode.net #charybdis
* Please read doc/index.txt to get an overview of the current documentation.
problems with ipv4 due to the way the socket code is written. To
fix this you must: "sysctl net.inet6.ip6.v6only=0"
- * SOLARIS USERS: this code appears to tickle a bug in older gcc and
+ * SOLARIS USERS: this code appears to tickle a bug in older gcc and
egcs ONLY on 64-bit Solaris7. gcc-2.95 and SunPro C on 64bit should
work fine, and any gcc or SunPro compiled on 32bit.
* OpenSuSE 11/12
* OpenSolaris 2008.x?
* Solaris 10 sparc.
-
- Please let us know if you find otherwise.
- It probably does not compile on AIX, IRIX or libc5 Linux.
+
+ Please let us know if you find otherwise. It may work on other platforms, but this is not guaranteed.
* Please read NEWS for information about what is in this release.