-# charybdis [](https://travis-ci.org/charybdis-ircd/charybdis) [](https://ci.appveyor.com/project/kaniini/charybdis/branch/master)
+# solanum 
-Charybdis was an IRCv3 server designed to be highly scalable. It implemented IRCv3.1 and some parts of IRCv3.2.
+Solanum is an IRCv3 server designed to be highly scalable. It implements IRCv3.1 and some parts of IRCv3.2.
-It is not meant to be used at all, but if you feel the need to do so, you should use it with an IRCv3-capable services
-implementation such as [Atheme][atheme] or [Anope][anope].
+It is meant to be used with an IRCv3-capable services implementation such as [Atheme][atheme] or [Anope][anope].
- [atheme]: http://www.atheme.net/
+ [atheme]: https://atheme.github.io/
[anope]: http://www.anope.org/
-For various reasons, this project is deprecated and replaced with [ircd-seven](http://github.com/freenode/ircd-seven).
-Please direct all questions about this change to [Christel Dahlskjaer](mailto:christel@freenode.net) and
-[Stephen Bennett](mailto:spb@freenode.net) of freenode.
-
# necessary requirements
* A supported platform
# platforms
-Charybdis is designed with portability in mind, but does not target older systems nor those of solely academic
+Solanum 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.
* 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
## Tier 3
-Anything else that hasn't been tested. Charybdis may or may not work on it; patches welcome if they don't.
+Anything else that hasn't been tested. Solanum 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`
+ * **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"
+ 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.
- * **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
-# building from git
+```bash
+./autogen.sh
+./configure --prefix=/path/to/installation
+make
+make check # run tests
+make install
+```
-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.
+See `./configure --help` for build options.
# 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)
+ * 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,
# tips
- * To report bugs in charybdis, visit us at irc.charybdis.io #charybdis
+ * To report bugs in Solanum, visit us at `#solanum` on [Libera Chat](https://libera.chat)
- * Please read doc/index.txt to get an overview of the current documentation.
+ * Please read [doc/index.txt](doc/index.txt) to get an overview of the current documentation.
- * Read the NEWS file for what's new in this release.
+ * Read the [NEWS.md](NEWS.md) file for what's new in this release.
- * The files, /etc/services, /etc/protocols, and /etc/resolv.conf, SHOULD be
+ * 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.
+ the correct settings. If these files are wrong, Solanum 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`
+ * The Solanum GIT repository can be checked out using the following command:
+ `git clone https://github.com/solanum-ircd/solanum`
- * Charybdis's GIT repository depot can be browsed over the Internet at the following address:
- https://github.com/charybdis-ircd/charybdis
+ * Solanum's GIT repository depot can be browsed over the Internet at the following address:
+ https://github.com/solanum-ircd/solanum
projects / solanum.git / blobdiff