This repository has been archived by the owner on Jun 24, 2021. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 102
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Showing
4 changed files
with
59 additions
and
76 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,108 +1,91 @@ | ||
| # charybdis [](https://travis-ci.org/charybdis-ircd/charybdis) | ||
| # charybdis [](https://travis-ci.org/charybdis-ircd/charybdis) | ||
|
|
||
| Charybdis is an IRCv3 server designed to be highly scalable. It implements IRCv3.1 and some parts of IRCv3.2. | ||
| [Charybdis][charybdis] is an [IRCv3][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/ | ||
| [charybdis]: https://charybdis-ircd.github.io/ | ||
| [ircv3]: https://ircv3.net/ | ||
| [atheme]: https://atheme.github.io/ | ||
| [anope]: https://anope.org/ | ||
|
|
||
| # necessary requirements | ||
| # necessary requirements: | ||
|
|
||
| * A supported platform | ||
| * A working dynamic library system | ||
| * A working lex and yacc - flex and bison should work | ||
| * 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. | ||
| 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 | ||
| ## tier 1 | ||
|
|
||
| These platforms are the best supported, and should always work. They are actively tested. If you encounter | ||
| problems, please file a bug. | ||
| 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) | ||
| * 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 | ||
| ## 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. | ||
| 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) | ||
| * 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 | ||
| ## 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. | ||
| 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. | ||
| * **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. | ||
| 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). | ||
| * 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. | ||
| * to report bugs in charybdis, visit us on freenode in [#charybdis][freenode] | ||
| * please, read [doc/index.txt][index] to get an overview of the current documentation; | ||
| * read the [NEWS.md][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. | ||
|
|
||
| * 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. | ||
| [freenode]: https://webchat.freenode.net/?randomnick=1&channels=%23charybdis | ||
| [index]: https://github.com/charybdis-ircd/charybdis/blob/release/4/doc/index.txt | ||
| [news]: https://github.com/charybdis-ircd/charybdis/blob/release/4/NEWS.md | ||
|
|
||
| # 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 | ||
| * the charybdis git repository can be checked-out using the following command: | ||
| `git clone https://github.com/charybdis-ircd/charybdis.git` | ||
| * the charybdis git repository depot can be browsed over the Internet at https://github.com/charybdis-ircd/charybdis |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters