]>
Commit | Line | Data |
---|---|---|
e44504eb | 1 | # charybdis [![Build Status](https://travis-ci.org/charybdis-ircd/charybdis.svg?branch=master)](https://travis-ci.org/charybdis-ircd/charybdis) |
67603230 | 2 | |
41976628 AC |
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]. | |
67603230 AC |
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 | ||
0409e18f AC |
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 | ||
67603230 AC |
21 | # feature specific requirements |
22 | ||
354fd351 AC |
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.) | |
67603230 AC |
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 | ||
61f156ba | 40 | * To report bugs in charybdis, visit us at irc.freenode.net #charybdis |
67603230 AC |
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 | ||
e44504eb | 53 | * SOLARIS USERS: this code appears to tickle a bug in older gcc and |
67603230 AC |
54 | egcs ONLY on 64-bit Solaris7. gcc-2.95 and SunPro C on 64bit should |
55 | work fine, and any gcc or SunPro compiled on 32bit. | |
56 | ||
57 | * SUPPORTED PLATFORMS: this code should compile without any warnings on: | |
58 | ||
59 | * FreeBSD 10 | |
60 | * Gentoo & Gentoo Hardened ~x86/~amd64/~fbsd | |
61 | * RHEL 6 / 7 | |
62 | * Debian Jessie | |
63 | * OpenSuSE 11/12 | |
64 | * OpenSolaris 2008.x? | |
65 | * Solaris 10 sparc. | |
e44504eb | 66 | |
1cabc01c | 67 | Please let us know if you find otherwise. It may work on other platforms, but this is not guaranteed. |
67603230 AC |
68 | |
69 | * Please read NEWS for information about what is in this release. | |
70 | ||
71 | * Other files recommended for reading: BUGS, INSTALL |