construct/README.md

charybdis

Charybdis is an IRCv3 server designed to be highly scalable. It implements IRCv3.1 and some parts of IRCv3.2.

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/TLS client and server connections, one of:

  • OpenSSL 1.0.0 or newer (--enable-openssl)
  • LibreSSL (--enable-openssl)
  • mbedTLS (--enable-mbedtls)
  • GnuTLS (--enable-gnutls)

• For certificate-based oper CHALLENGE, OpenSSL 1.0.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 under OpenSSL, on Solaris and RHEL/Fedora (and its derivatives such as CentOS) you will need to compile your own OpenSSL on these systems, as they have removed support for ECC/ECDHE. Alternatively, consider using another library (see above).

platforms

Charybdis is designed with portability in mind, but does not target older systems nor those of solely academic interest. Operating systems are only supported if they are supported by their vendor.

testing

This branch is testing and does not guarantee stability.

Continuously Integrated Host	Compiler	Third party	Status
Linux Ubuntu 12.04 Precise	GCC 4.8
Linux Ubuntu 12.04 Precise	GCC 4.9
Linux Ubuntu 12.04 Precise	GCC 5
Linux Ubuntu 12.04 Precise	Clang 3.4
Apple Darwin 15.5	LLVM 7.3.0
Windows	mingw 3.5

stable

Continuously Integrated Host	Compiler	Third party	Status
Linux Ubuntu 12.04 Precise	GCC 4.8
Linux Ubuntu 12.04 Precise	GCC 4.9
Linux Ubuntu 12.04 Precise	GCC 5
Linux Ubuntu 12.04 Precise	Clang 3.4
Apple Darwin 15.5	LLVM 7.3.0
Windows	mingw 3.5

• Tier 1 platforms should always work when using a release version tag. If you encounter problems, please file a bug.

  • _{FreeBSD 10+ (i386/amd64)}
  • _{Mac OS X 10.7+}
  • _{Vista/Server 2008 (x86/x64)}
  • _{Linux 2.6 (x86_64/ARM) with glibc or musl}

• Tier 2 platforms should work, but this is not guaranteed. If you find any problems, file a bug, but as these are not regularly tested platforms, a timely resolution may not be possible.

  • _{Linux (i386/x86_64) with uClibc}
  • _{DragonflyBSD 4.4+ (i386)}
  • _{NetBSD 6.1.x+ (i386/amd64)}
  • _{OpenBSD 5.6+ (i386/amd64)}
  • _{Solaris 10+ (i386)}

development

This branch is not meant for production. Use at your own risk.

Continuously Integrated Host	Compiler	Third party	Status
Linux Ubuntu 12.04 Precise	GCC 4.9	Boost 1.61
Linux Ubuntu 12.04 Precise	GCC 5	Boost 1.61
Linux Ubuntu 12.04 Precise	Clang 3.6	Boost 1.61
Linux Ubuntu 14.04 Trusty	GCC 6	Boost 1.61
Linux Ubuntu 14.04 Trusty	Clang 3.8	Boost 1.61
Apple Darwin 15.5	LLVM 7.3.0	Boost 1.61
Windows	mingw 3.5	Boost 1.61

platform specific errata

These are known issues and workarounds for supported platforms.

• FreeBSD: if you are compiling with ipv6 you may experience problems with ipv4 due to the way the socket code is written. To fix this you must: "sysctl net.inet6.ip6.v6only=0"

• Solaris: you may have to set your PATH to include /usr/gnu/bin and /usr/gnu/sbin before /usr/bin and /usr/sbin. Solaris's default tools don't seem to play nicely with the configure script.

tips

• 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.

• Read the NEWS file for what's new in this release.

• The files, /etc/services, /etc/protocols, and /etc/resolv.conf, SHOULD be readable by the user running the server in order for ircd to start with the correct settings. If these files are wrong, charybdis will try to use 127.0.0.1 for a resolver as a last-ditch effort.

git access

• The Charybdis GIT repository can be checked out using the following command: git clone https://github.com/charybdis-ircd/charybdis

• Charybdis's GIT repository depot can be browsed over the Internet at the following address: https://github.com/charybdis-ircd/charybdis