Scalable IRCv3.2 server for large, community-oriented networks
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
authd authd: always use an empty buffer to read ident reply Aug 12, 2018
bandb bandb/bandb: functions that call exit(3) should be marked noreturn, a… Jun 1, 2016
doc doc: there is no _static directory Aug 12, 2018
extensions gcc7 fixes: NICKLEN -> NAMELEN Jan 19, 2018
help help/Makefile.am: silence construction of indexes, make build depend … Oct 30, 2017
include m_pass: store unverified SID in preClient for use in m_server Aug 15, 2018
ircd m_sasl: check if the agent is present after every client_exit Aug 12, 2018
librb MbedTLS: Support ChaCha20-Poly1305 in TLSv1.2+ Aug 13, 2018
m4 Remove more $Id tags. Mar 6, 2016
modules m_nick/m_sasl/m_user: restore check for mixing of client and server p… Aug 15, 2018
scripts makerelease: fix DATECODE output May 14, 2016
ssld ssld: avoid clang static analysis warning Aug 4, 2017
tests tests: add serv_connect1 (exit_unknown_client) Aug 24, 2017
testsuite testsuite: Update startall.sh Mar 28, 2016
tools mkpasswd: avoid strdup(NULL) and the like if rb_crypt() fails Dec 20, 2016
wsockd wsockd: avoid clang static analysis warning Jul 29, 2017
.appveyor-build.sh appveyor: make the build less hacky Mar 25, 2016
.appveyor.yml appveyor: correct version May 15, 2016
.gitignore tests: add serv_connect1 (exit_unknown_client) Aug 24, 2017
.mailmap mailmap: Sam is Christine now apparently. Mar 17, 2016
.travis.yml travis: don't build docs on osx Aug 12, 2018
CREDITS CREDITS: update to match reality Aug 17, 2017
LICENSE Remove more $Id tags. Mar 6, 2016
Makefile.am tests: add C TAP harness Jul 29, 2017
NEWS.md set version back to -dev Aug 15, 2018
README.md Revert "no really, it's dead people" Jul 27, 2017
autogen.sh *sigh* comment these out until travis is fixed. Apr 10, 2016
configure.ac set version back to -dev Aug 15, 2018
shtool Add these for now until travis actually gets their shit together. Apr 10, 2016

README.md

charybdis POSIX Build Status Windows Build Status

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 or Anope.

necessary requirements

  • A supported platform
  • A working dynamic library system
  • A working lex and yacc - flex and bison should work

platforms

Charybdis is designed with portability in mind, but does not target older systems nor those of solely academic interest.

Do note that operating systems are only supported if they are supported by their vendor.

Tier 1

These platforms are the best supported, and should always work. They are actively tested. If you encounter problems, please file a bug.

  • FreeBSD 10.x and above (i386 and amd64)
  • Linux 2.6.x and above with glibc or musl (i386, x86_64, and ARM)
  • Mac OS X 10.7 and above
  • Windows Vista/Server 2008 and above (x86 or x64)

Tier 2

These platforms are supported and occasionally tested, and most features 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.

  • DragonflyBSD 4.4 and above (i386)
  • Linux with uClibc (i386 or x86_64)
  • NetBSD 6.1.x and above (i386, amd64)
  • OpenBSD 5.6 and above (i386, amd64)
  • Solaris 10 and above (i386)

Tier 3

Anything else that hasn't been tested. Charybdis may or may not work on it; patches welcome if they don't.

platform specific errata

These are known issues and workarounds for supported platforms.

  • **Mac OS X and macOS **: you must set the LIBTOOLIZE environment variable to point to glibtoolize before running autogen.sh: $ brew install libtool $ LIBTOOLIZE="/opt/local/bin/glibtoolize" $ export LIBTOOLIZE $ ./autogen.sh

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

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

tips

  • To report bugs in charybdis, visit us at irc.charybdis.io #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