X-Git-Url: https://jfr.im/git/solanum.git/blobdiff_plain/fcf13f6d32f7404ba4066bf460200074bfd42ea3..c0d82abefc9e2817d80d38f487c79b522b62a6da:/README.md diff --git a/README.md b/README.md index 7d9c9645..962f8526 100644 --- a/README.md +++ b/README.md @@ -27,14 +27,14 @@ 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 +* macOS 10.7 and above * Windows Vista/Server 2008 and above (x86 or x64) ## Tier 2 -These platforms are supported, 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) @@ -44,22 +44,20 @@ possible. ## Tier 3 -These platforms should only be considered weakly supported, as they are either experimental or not actively -tested. These platforms have usually been tested in the past, but they may or may not be in a useful state. -Bugs for tier 3 architectures should have patches attached. - -* Solaris 10 and above (sparc64) -* Old operating system versions of tier 2 and above platforms - -## Tier 4 - -Platforms that are tier 4 are not supported at all. They include all platforms not included in tier 3 or -above. Bugs to tier 4 platforms **must** have patches attached or will be rejected, possibly without comment. +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. + * **macOS**: you must set the `LIBTOOLIZE` environment variable to point to glibtoolize before running autogen.sh: + + ```bash + brew install libtool + export LIBTOOLIZE="/usr/local/bin/glibtoolize" + ./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" @@ -76,21 +74,22 @@ You will need to run `autogen.sh` to build the autotools files prior to building * For SSL/TLS client and server connections, one of: - * OpenSSL 1.0 or newer - * LibreSSL - * mbedTLS - * GnuTLS + * 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 or newer. + * 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, OpenSSL 1.0.0 or newer is required. Solaris; and RHEL/Fedora and its derivatives such as CentOS - have removed support for ECC/ECDHE. You will need to compile your own OpenSSL on these systems. + * 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.freenode.net #charybdis + * 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. @@ -101,3 +100,10 @@ You will need to run `autogen.sh` to build the autotools files prior to building 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