From 3ce0003315f465e6bf80d903e63e27658a9c7994 Mon Sep 17 00:00:00 2001 From: Alex Clarke Date: Mon, 30 Dec 2024 11:25:15 -0700 Subject: [PATCH] docs: Added installation instructions for Nix and a note for Unraid users until the template is corrected by the maintainer --- README.md | 24 ++++++++++++++++++++++++ 1 file changed, 24 insertions(+) diff --git a/README.md b/README.md index 4959bc8..507f137 100644 --- a/README.md +++ b/README.md @@ -76,6 +76,16 @@ To upgrade to a newer version of Managarr: brew upgrade managarr ``` +### Nix (Externally Maintained) +To install Managarr on NixOS, you can use the following command: + +```shell +nix-env --install managarr + +# Alternatively, for non-NixOS users, you can spawn a temporary shell with Managarr available like so: +nix-shell -p managarr +``` + ### Chocolatey (Windows) The Managarr Chocolatey package is located [here](https://community.chocolatey.org/packages/managarr). Please note that validation of Chocolatey packages take quite some time, and thus the package may not be available immediately after a new release. @@ -95,6 +105,20 @@ choco upgrade managarr choco upgrade managarr --version=0.4.2 ``` +### Unraid CA Template (Externally Maintained and a note) +The [Managarr Unraid CA Template](https://unraid.net/community/apps?q=managarr#r) is maintained exterally and by a third party. There's currently an [issue open](https://github.com/Dark-Alex-17/managarr/issues/13) +where the Managarr Unraid CA Template cannot start and errors out with the following message: + +``` + Error: No such device or address (os error 6) +``` + +This happens because the Unraid template does not allocate a pseudo-tty when starting the Managarr container. + +To correct this, add `-it` to the `Extra Parameters` in the template config. + +Since I don't know who created the template nor how to contact them, I can't directly tell the maintainer to fix this. So, until this is fixed, this note will remain here in the `README`, and issue #13 will remain open until I can confirm the template is updated and the issue is fixed. + ### Manual Binaries are available on the [releases](https://github.com/Dark-Alex-17/managarr/releases) page for the following platforms: