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 library system
  14  * A working lex and yacc - flex and bison should work
  15
  16 # platforms
  17
  18 Charybdis is designed with portability in mind, but does not target older systems nor those of solely academic
  19 interest.
  20
  21 Do note that operating systems are only supported if they are supported by their vendor.
  22
  23 ## Tier 1
  24
  25 These platforms are the best supported, and should always work. They are actively tested. If you encounter
  26 problems, please file a bug.
  27
  28 * FreeBSD 10.x and above (i386 and amd64)
  29 * Linux 2.6.x and above with glibc or musl (i386, x86_64, and ARM)
  30 * Mac OS X 10.7 and above
  31 * Windows Vista/Server 2008 and above (x86 or x64)
  32
  33 ## Tier 2
  34
  35 These platforms are supported, and most features should work, but this is not guaranteed. If you find any
  36 problems, file a bug, but as these are not regularly tested platforms, a timely resolution may not be
  37 possible.
  38
  39 * DragonflyBSD 4.4 and above (i386)
  40 * Linux with uClibc (i386 or x86_64)
  41 * NetBSD 6.1.x and above (i386, amd64)
  42 * OpenBSD 5.6 and above (i386, amd64)
  43 * Solaris 10 and above (i386)
  44
  45 ## Tier 3
  46
  47 These platforms should only be considered weakly supported, as they are either experimental or not actively
  48 tested. These platforms have usually been tested in the past, but they may or may not be in a useful state.
  49 Bugs for tier 3 architectures should have patches attached.
  50
  51 * Solaris 10 and above (sparc64)
  52 * Old operating system versions of tier 2 and above platforms
  53
  54 ## Tier 4
  55
  56 Platforms that are tier 4 are not supported at all. They include all platforms not included in tier 3 or
  57 above. Bugs to tier 4 platforms **must** have patches attached or will be rejected, possibly without comment.
  58
  59 # platform specific errata
  60
  61 These are known issues and workarounds for supported platforms.
  62
  63  * **FreeBSD**: if you are compiling with ipv6 you may experience
  64    problems with ipv4 due to the way the socket code is written.  To
  65    fix this you must: "sysctl net.inet6.ip6.v6only=0"
  66
  67  * **Solaris**: you may have to set your PATH to include /usr/gnu/bin and /usr/gnu/sbin before /usr/bin
  68    and /usr/sbin. Solaris's default tools don't seem to play nicely with the configure script.
  69
  70 # building from git
  71
  72 We no longer supply a prebuilt configure script in git, due to use of automake and libtool causing problems.
  73 You will need to run `autogen.sh` to build the autotools files prior to building charybdis.
  74
  75 # feature specific requirements
  76
  77  * For SSL/TLS client and server connections, one of:
  78
  79    * OpenSSL 1.0 or newer
  80    * LibreSSL
  81    * mbedTLS
  82    * GnuTLS
  83
  84  * For certificate-based oper CHALLENGE, OpenSSL 1.0 or newer.
  85    (Using CHALLENGE is not recommended for new deployments, so if you want to use a different TLS library,
  86     feel free.)
  87
  88  * For ECDHE, OpenSSL 1.0.0 or newer is required. Solaris; and RHEL/Fedora and its derivatives such as CentOS
  89    have removed support for ECC/ECDHE. You will need to compile your own OpenSSL on these systems.
  90
  91 # tips
  92
  93  * To report bugs in charybdis, visit us at irc.freenode.net #charybdis
  94
  95  * Please read doc/index.txt to get an overview of the current documentation.
  96
  97  * Read the NEWS file for what's new in this release.
  98
  99  * The files, /etc/services, /etc/protocols, and /etc/resolv.conf, SHOULD be
 100    readable by the user running the server in order for ircd to start with
 101    the correct settings.  If these files are wrong, charybdis will try to use
 102    127.0.0.1 for a resolver as a last-ditch effort.
 103