From 9aa8f6c34d1163d2dfc636ae06bf3461b2b2eae5 Mon Sep 17 00:00:00 2001 From: Hamcha Date: Thu, 30 Nov 2023 10:42:14 +0100 Subject: [PATCH] probably not --- README.md | 37 ++++++++++++++++++++++++++++++++++--- 1 file changed, 34 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 83edb1a..22a4aa0 100644 --- a/README.md +++ b/README.md @@ -23,7 +23,38 @@ Because here at staxman your server's down six ways from Sunday! ## Usage -It doesn't work!! +Important disclaimer: **It doesn't work!!** + +### Nix flake + +- Run once: `nix run` +- Cute shell with cargo-watch: `nix develop` + +Add these lines to your flake.nix, I dare you: + +```nix +modules = [ + ... + staxman.nixosModules.default + ({ config, pkgs, ... }: { + services.staxman = { + enable = true; + stackDir = "/path/to/stacks"; + bindAddress = "1.2.3.4:3000"; + }; + }) +]; +``` + +### Manual (cringe) install + +You'll need: + +- [arion](https://github.com/hercules-ci/arion) +- [Docker](https://www.youtube.com/watch?v=y8OnoxKotPQ) (podman-socket works) +- [rust](https://rust.fandom.com/wiki/Rust_Wiki) + +then `cargo run` (you want packages? who do you think you are??) ## License @@ -41,9 +72,9 @@ Goal for this is to manage docker compose stacks from a web UI with glue code to ### Should I use this? -This is MY project, built for my needs only, if you haven't been scared off the memey readme and terrible commit message quality, this is your warning that I'm not gonna add features if people ask for them. +Probably not! This is MY project, built for my needs only, if you haven't been scared off the memey readme and terrible commit message quality, this is your warning that I'm not gonna add features if people ask for them. -However if you wanna join my adventure in trying to create a cozy way to manage a remote box and get some services up with all the pain and lack of support it entails, go nuts! +If you think you're just as brainrot as me and wanna join my adventure in trying to create a cozy way to manage a remote box and get some services up with all the pain and lack of support it entails, give it a shot I guess?? ### But kubernetes is awesome!