~brettgilio/orcircd

A modern, high-performance IRC server (ircd)

d7969cd Replace section in SECTIONS

25 days ago

7a801c3 Move files.

25 days ago
orcircd logo

#orcircd

A modern, high-performance IRC server (ircd)

#Supported Platforms

As orcircd is implemented in OCaml (and a bit of C) and makes use of the Unix module, the compilation and runtime depends on a POSIX-compliant environment. Native compilation is supported across many architectures, with first-class support provided to the Linux kernel. Linking C libraries (dynamically by default) is supported with both glibc on GNU/Linux, and musl on Alpine or Void Linux.

First-class support for the Linux kernel is available on the following architectures:

  • x86/x86_64
  • ARM 32/64
  • Power 64
  • RISC-V 64
  • s390x

Second-class support for FreeBSD, NetBSD, and OpenBSD is provided on a when-possible basis. As such, results may vary. Issues related to compilation on the *BSDs should be directed upstream to the compiler maintainers. This project does not provide official support for Windows or macOS.

#Contributing

This project is proudly hosted on sourcehut which makes extensive use of the built-in git send-email patch functionality. In order to participate effectively with patch-exchanges consider subscribing to the development mailing list. Additionally, confirmed bugs and feature requests may be opened on the project ticket tracker.

General project discussion is accepted on the discussion mailing list, or #orcircd on freenode.

#Hacking

General recommendations on modifying or developing orcircd are available in the HACKING documentation.

#Components

  • ident: OCaml implementation of RFC 1413 (“Identification Protocol”) [GPLv3+]
  • precis: OCaml implementation of RFC 8264, 8265, and 8266 (“PRECIS”) [GPLv3+]

#License

orcircd is licensed under the GNU Affero General Public License, version 3 or any later version. See LICENSE for more details.

AGPL