MirrorHub/construct
0
0
Fork 0
mirror of https://github.com/matrix-construct/construct synced 2024-12-28 00:14:07 +01:00
Code Issues Releases Wiki Activity

Merge pull request #204 from jevolk/README

Browse source 
Update README. charybdis-5-dev.
This commit is contained in:
William Pitcock 2016-07-27 02:34:49 -05:00 committed by GitHub
commit 8aa152eea7
1 changed files with 79 additions and 61 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

140
README.md
View file

@ -1,68 +1,13 @@
# 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) # charybdis
Charybdis is an IRCv3 server designed to be highly scalable. It implements IRCv3.1 and some parts of IRCv3.2. Charybdis is an 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]. ## building from git
[atheme]: http://www.atheme.net/
[anope]: http://www.anope.org/
# necessary requirements
* 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.
Do note that operating systems are only supported if they are supported by their vendor.
## Tier 1
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)
## 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.
* 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
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.
* **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. 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. You will need to run `autogen.sh` to build the autotools files prior to building charybdis.
# feature specific requirements ## feature specific requirements
* For SSL/TLS client and server connections, one of: * For SSL/TLS client and server connections, one of:
@ -78,7 +23,80 @@ You will need to run `autogen.sh` to build the autotools files prior to building
* For ECDHE, OpenSSL 1.0.0 or newer is required. Solaris; and RHEL/Fedora and its derivatives such as CentOS * 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. have removed support for ECC/ECDHE. You will need to compile your own OpenSSL on these systems.
# tips ## platforms
Charybdis is designed with portability in mind, but does not target older systems nor those of solely academic
interest. Operating systems are only supported if they are supported by their vendor.
#### testing
[![SemVer](http://img.shields.io/SemVer/v4.0.0-rc2.png)](https://github.com/charybdis-ircd/charybdis/tree/release/4)
*This branch is testing and does not guarantee stability.*
| <sub> Continuously Integrated Host </sub> | <sub> Compiler </sub> | <sub> Third party </sub> | <sub> Status </sub> |
|:------------------------------------------- |:------------------------ |:------------------------ |:------------------- |
| <sub> Linux Ubuntu 12.04 Precise </sub> | <sub> GCC 4.8 </sub> | | <sub> [![POSIX Build Status](https://travis-ci.org/charybdis-ircd/charybdis.svg?branch=release/4)](https://travis-ci.org/charybdis-ircd/charybdis) </sub> |
| <sub> Linux Ubuntu 12.04 Precise </sub> | <sub> GCC 4.9 </sub> | | <sub> [![POSIX Build Status](https://travis-ci.org/charybdis-ircd/charybdis.svg?branch=release/4)](https://travis-ci.org/charybdis-ircd/charybdis) </sub> |
| <sub> Linux Ubuntu 12.04 Precise </sub> | <sub> GCC 5 </sub> | | [![POSIX Build Status](https://travis-ci.org/charybdis-ircd/charybdis.svg?branch=release/4)](https://travis-ci.org/charybdis-ircd/charybdis) |
| <sub> Linux Ubuntu 12.04 Precise </sub> | <sub> Clang 3.4 </sub> | | [![POSIX Build Status](https://travis-ci.org/charybdis-ircd/charybdis.svg?branch=release/4)](https://travis-ci.org/charybdis-ircd/charybdis) |
| <sub> Apple Darwin 15.5 </sub> | <sub> LLVM 7.3.0 </sub> | | [![POSIX Build Status](https://travis-ci.org/charybdis-ircd/charybdis.svg?branch=release/4)](https://travis-ci.org/charybdis-ircd/charybdis) |
| <sub> Windows </sub> | <sub> mingw 3.5 </sub> | | [![Windows Build Status](https://ci.appveyor.com/api/projects/status/is0obsml8xyq2qk7/branch/release/4?svg=true)](https://ci.appveyor.com/project/kaniini/charybdis/branch/release/4) |
#### stable
[![SemVer](http://img.shields.io/SemVer/v3.5.0.png)](https://github.com/charybdis-ircd/charybdis/tree/release/3.5)
| <sub> Continuously Integrated Host </sub> | <sub> Compiler </sub> | <sub> Third party </sub> | <sub> Status </sub> |
|:------------------------------------------- |:------------------------ |:------------------------ |:------------------- |
| <sub> Linux Ubuntu 12.04 Precise </sub> | <sub> GCC 4.8 </sub> | | [![POSIX Build Status](https://travis-ci.org/charybdis-ircd/charybdis.svg?branch=release/3.5)](https://travis-ci.org/charybdis-ircd/charybdis) |
| <sub> Linux Ubuntu 12.04 Precise </sub> | <sub> GCC 4.9 </sub> | | [![POSIX Build Status](https://travis-ci.org/charybdis-ircd/charybdis.svg?branch=release/3.5)](https://travis-ci.org/charybdis-ircd/charybdis) |
| <sub> Linux Ubuntu 12.04 Precise </sub> | <sub> GCC 5 </sub> | | [![POSIX Build Status](https://travis-ci.org/charybdis-ircd/charybdis.svg?branch=release/3.5)](https://travis-ci.org/charybdis-ircd/charybdis) |
| <sub> Linux Ubuntu 12.04 Precise </sub> | <sub> Clang 3.4 </sub> | | [![POSIX Build Status](https://travis-ci.org/charybdis-ircd/charybdis.svg?branch=release/3.5)](https://travis-ci.org/charybdis-ircd/charybdis) |
| <sub> Apple Darwin 15.5 </sub> | <sub> LLVM 7.3.0 </sub> | | [![POSIX Build Status](https://travis-ci.org/charybdis-ircd/charybdis.svg?branch=release/3.5)](https://travis-ci.org/charybdis-ircd/charybdis) |
| <sub> Windows </sub> | <sub> mingw 3.5 </sub> | | [![Windows Build Status](https://ci.appveyor.com/api/projects/status/is0obsml8xyq2qk7/branch/release/3.5?svg=true)](https://ci.appveyor.com/project/kaniini/charybdis/branch/release/3.5) |
* Tier 1 platforms should always work **when using a release version tag.** If you encounter problems, please file a bug.
* <sub> FreeBSD 10+ (i386/amd64) </sub>
* <sub> Mac OS X 10.7+ </sub>
* <sub> Vista/Server 2008 (x86/x64) </sub>
* <sub> Linux 2.6 (x86_64/ARM) with glibc or musl </sub>
* Tier 2 platforms 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.
* <sub> Linux (i386/x86_64) with uClibc </sub>
* <sub> DragonflyBSD 4.4+ (i386) </sub>
* <sub> NetBSD 6.1.x+ (i386/amd64) </sub>
* <sub> OpenBSD 5.6+ (i386/amd64) </sub>
* <sub> Solaris 10+ (i386) </sub>
#### development
[![Charybdis](http://img.shields.io/SemVer/v5.0.0-dev.png)](https://github.com/charybdis-ircd/charybdis/tree/master)
*This branch is not meant for production. Use at your own risk.*
| <sub> Continuously Integrated Host </sub> | <sub> Compiler </sub> | <sub> Third party </sub> | <sub> Status </sub> |
|:------------------------------------------- |:------------------------ |:------------------------ |:------------------- |
| <sub> Linux Ubuntu 12.04 Precise </sub> | <sub> GCC 4.9 </sub> | <sub> Boost 1.61 </sub> | [![POSIX Build Status](https://travis-ci.org/charybdis-ircd/charybdis.svg?branch=master)](https://travis-ci.org/charybdis-ircd/charybdis) |
| <sub> Linux Ubuntu 12.04 Precise </sub> | <sub> GCC 5 </sub> | <sub> Boost 1.61 </sub> | [![POSIX Build Status](https://travis-ci.org/charybdis-ircd/charybdis.svg?branch=master)](https://travis-ci.org/charybdis-ircd/charybdis) |
| <sub> Linux Ubuntu 12.04 Precise </sub> | <sub> Clang 3.6 </sub> | <sub> Boost 1.61 </sub> | [![POSIX Build Status](https://travis-ci.org/charybdis-ircd/charybdis.svg?branch=master)](https://travis-ci.org/charybdis-ircd/charybdis) |
| <sub> Linux Ubuntu 14.04 Trusty </sub> | <sub> GCC 6 </sub> | <sub> Boost 1.61 </sub> | [![POSIX Build Status](https://travis-ci.org/charybdis-ircd/charybdis.svg?branch=master)](https://travis-ci.org/charybdis-ircd/charybdis) |
| <sub> Linux Ubuntu 14.04 Trusty </sub> | <sub> Clang 3.8 </sub> | <sub> Boost 1.61 </sub> | [![POSIX Build Status](https://travis-ci.org/charybdis-ircd/charybdis.svg?branch=master)](https://travis-ci.org/charybdis-ircd/charybdis) |
| <sub> Apple Darwin 15.5 </sub> | <sub> LLVM 7.3.0 </sub> | <sub> Boost 1.61 </sub> | [![POSIX Build Status](https://travis-ci.org/charybdis-ircd/charybdis.svg?branch=master)](https://travis-ci.org/charybdis-ircd/charybdis) |
| <sub> Windows </sub> | <sub> mingw 3.5 </sub> | <sub> Boost 1.61 </sub> | [![Windows Build Status](https://ci.appveyor.com/api/projects/status/is0obsml8xyq2qk7/branch/master?svg=true)](https://ci.appveyor.com/project/kaniini/charybdis/branch/master) |
## platform specific errata
These are known issues and workarounds for supported platforms.
* **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.
## tips
* To report bugs in charybdis, visit us at irc.freenode.net #charybdis * To report bugs in charybdis, visit us at irc.freenode.net #charybdis
@ -91,7 +109,7 @@ 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 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. 127.0.0.1 for a resolver as a last-ditch effort.
# git access ## git access
* The Charybdis GIT repository can be checked out using the following command: * The Charybdis GIT repository can be checked out using the following command:
`git clone https://github.com/charybdis-ircd/charybdis` `git clone https://github.com/charybdis-ircd/charybdis`