Note: This software is still in early-phase development, and has not been released.

We strive to provide first-class support to all of the common GNU glibc or musl-based Linux distributions, as well as the *BSD operating systems on a when-possible basis. Regardless, if your target platform is not listed here, or the package is out-of-date, you have a series of options on how to proceed (ranked from most to least preferred).

  • Contact upstream: If orcircd is supported through official channels, contact those maintainers and request an update.
  • Contact us: If you are using a package maintained by us, write an email to ~brettgilio/orcircd-discuss@lists.sr.ht.
  • Build from source / use opam: Continue reading…

Generally, we recommend using the package which was built against your target platform. These packages are carefully crafted, and take into account possible defects particular to your target platform. If you choose to proceed with a source build / opam and experience a defect, please let us know! If you are targeting Microsoft Windows or macOS, please read the relevant entry in the FAQ.


Source

Building orcircd from source is best achieved by using the opam tooling. This will enable you to manage your OCaml installation, and automate the process of compiling orcircd. Additionally, you will need a C compiler capable of compiling at least C99. Proceed to install the following dependencies:

  • opam
  • pkg-config / pkgconf
  • gcc (or another C99-compliant compiler)
  • make

Next, initialize opam. Create a switch tracking a recent version of OCaml, we recommend >=4.10.0.

$ opam init
$ opam switch create 4.10.0

Now, we can use opam to build and install orcircd.

$ opam install orcircd

If you wish to build and install a development version of orcircd, or are using a platform without official support, please follow the instructions outlined in HACKING.


GNU/Linux & non-GNU Linux

Alpine
CentOS

These instructions work for both CentOS and RHEL. If you are using CentOS 7.x, you will need to install dnf.

Supported Versions of CentOS:

  • 8.x
  • 7.x

To install on CentOS:

$ dnf config-manager --add-repo https://repo.orcircd.org/centos.repo
$ dnf install orcircd
Debian

First, add our signing key to your keyring.

wget -qO - https://repo.orcircd.org/signing-key.gpg.key | apt-key add -

Supported Versions of Debian:

  • Buster (10.x)
  • Stretch (9.x)

To install on Debian, using the Buster release:

$ echo "deb https://repo.orcircd.org/debian buster main" > /etc/apt/sources.list.d/orcircd.list
$ apt update && apt install orcircd
Fedora

Supported Versions of Fedora:

  • 32
  • 31

To install on Fedora:

$ dnf config-manager --add-repo https://repo.orcircd.org/fedora.repo
$ dnf install orcircd
GNU Guix
Ubuntu

First, add our signing key to your keyring.

wget -qO - https://repo.orcircd.org/signing-key.gpg.key | apt-key add -

Supported Versions of Ubuntu:

  • Focal Fossa (20.04.x LTS)
  • Bionic Beaver (18.04.x LTS)
  • Xenial Xerus (16.04.x LTS)

To install on Ubuntu, using the Focal Fossa release:

$ echo "deb https://repo.orcircd.org/ubuntu focal main" > /etc/apt/sources.list.d/orcircd.list
$ apt update && apt install orcircd

*BSD Operating Systems

FreeBSD
NetBSD
OpenBSD
This page was last modified: