~brettgilio/orcircd-web

8c67114cda4fde012484f07ecb3235751204264f — Brett Gilio 16 days ago eafc1a9
Contain INSTALLATION instructions.

* site/org/installation.org: Simplify formatting, make clear
delineations.
1 files changed, 143 insertions(+), 12 deletions(-)

M site/org/installation.org
M site/org/installation.org => site/org/installation.org +143 -12
@@ 4,16 4,14 @@
#+export_file_name: ../installation.md

#+BEGIN_EXPORT HTML
<time id="last-modified">2020-09-27</time>
<time id="last-modified">2020-10-02</time>
#+END_EXPORT

There are a plethora of options available for installing =orcircd= to your
favorite operating system / distribution (target platform). 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).
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 [[mailto:~brettgilio/orcircd-discuss@lists.sr.ht][~brettgilio/orcircd-discuss@lists.sr.ht]].


@@ 26,8 24,11 @@ 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 [[https://orcircd.org/faq/][FAQ]].

----------

#+BEGIN_EXPORT HTML
<h3>Source / <code>opam</code></h3>
<details>
<summary>Source</summary>
#+END_EXPORT
Building =orcircd= from source is best achieved by using the =opam= tooling.
This will enable you to manage your OCaml installation, and automate the


@@ 41,7 42,7 @@ dependencies:
- =make=

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

#+BEGIN_SRC bash
$ opam init


@@ 57,14 58,144 @@ $ 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 [[https://git.sr.ht/~brettgilio/orcircd/tree/master/HACKING.md][HACKING]].
#+BEGIN_EXPORT HTML
</details>
#+END_EXPORT

----------

/GNU/Linux & non-GNU Linux/

#+BEGIN_EXPORT HTML
<details>
<summary>
Alpine
</summary>
#+END_EXPORT
#+BEGIN_EXPORT HTML
</details>
#+END_EXPORT

#+BEGIN_EXPORT HTML
<details>
<summary>CentOS</summary>
#+END_EXPORT
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:
#+BEGIN_SRC bash
$ dnf config-manager --add-repo https://repo.orcircd.org/centos.repo
$ dnf install orcircd
#+END_SRC
#+BEGIN_EXPORT HTML
</details>
#+END_EXPORT

#+BEGIN_EXPORT HTML
<details open>
<summary>
Debian
</summary>
#+END_EXPORT
First, add our signing key to your keyring.
#+BEGIN_SRC bash
wget -qO - https://repo.orcircd.org/signing-key.gpg.key | apt-key add -
#+END_SRC

Supported Versions of Debian:
- Buster (10.x)
- Stretch (9.x)

To install on Debian, using the Buster release:
#+BEGIN_SRC bash
$ echo "deb https://repo.orcircd.org/debian buster main" > /etc/apt/sources.list.d/orcircd.list
$ apt update && apt install orcircd
#+END_SRC
#+BEGIN_EXPORT HTML
</details>
#+END_EXPORT

#+BEGIN_EXPORT HTML
<details>
<summary>Fedora</summary>
#+END_EXPORT
Supported Versions of Fedora:
- 32
- 31

To install on Fedora:
#+BEGIN_SRC bash
$ dnf config-manager --add-repo https://repo.orcircd.org/fedora.repo
$ dnf install orcircd
#+END_SRC
#+BEGIN_EXPORT HTML
</details>
#+END_EXPORT

#+BEGIN_EXPORT HTML
<details>
<summary>GNU Guix</summary>
#+END_EXPORT
#+BEGIN_EXPORT HTML
</details>
#+END_EXPORT

#+BEGIN_EXPORT HTML
<details>
<summary>
Ubuntu
</summary>
#+END_EXPORT
First, add our signing key to your keyring.
#+BEGIN_SRC bash
wget -qO - https://repo.orcircd.org/signing-key.gpg.key | apt-key add -
#+END_SRC

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:
#+BEGIN_SRC bash
$ echo "deb https://repo.orcircd.org/ubuntu focal main" > /etc/apt/sources.list.d/orcircd.list
$ apt update && apt install orcircd
#+END_SRC
#+BEGIN_EXPORT HTML
</details>
#+END_EXPORT

----------

/*BSD Operating Systems/

#+BEGIN_EXPORT HTML
<details>
<summary>FreeBSD</summary>
#+END_EXPORT
#+BEGIN_EXPORT HTML
</details>
#+END_EXPORT

#+BEGIN_EXPORT HTML
<h3>Debian GNU/Linux</h3>
<details>
<summary>NetBSD</summary>
#+END_EXPORT
#+BEGIN_EXPORT HTML
</details>
#+END_EXPORT

#+BEGIN_EXPORT HTML
<h3>Guix GNU/Linux</h3>
<details>
<summary>OpenBSD</summary>
#+END_EXPORT
#+BEGIN_EXPORT HTML
</details>
#+END_EXPORT

* COMMENT Local variables