From da3200cab6e8f8e3a2e6e04984664685b7ff0e5a Mon Sep 17 00:00:00 2001 From: decentral1se Date: Thu, 28 Aug 2025 12:00:49 +0200 Subject: [PATCH] docs: abra.yml See https://git.coopcloud.tech/toolshed/abra/issues/622 --- docs/operators/handbook.md | 20 ++++++++++++++++++++ 1 file changed, 20 insertions(+) diff --git a/docs/operators/handbook.md b/docs/operators/handbook.md index 1774547..0c88f4d 100644 --- a/docs/operators/handbook.md +++ b/docs/operators/handbook.md @@ -94,6 +94,26 @@ git commit make link ``` +## Configure `abra` with `abra.yml` + +There are few configuration options supported at this time but more can be added. We are open to requests! + +### `$ABRA_DIR` + +The lookup logic is defined like so. + +* lookup $ABRA_DIR env +* look for config file and take value from there +* $HOME/.abra as fallback + +If you create an `abra.yml` file in your `$PWD` with the following contents. + +``` +abraDir: . +``` + +Then `$ABRA_DIR` will be automatically picked up as `$PWD`. This is useful when you maintain multiple project configurations and recipes in various state of chaos and would like to separate those. `abra` will create all the usual `$HOME/.abra` state (`servers`/`recipes`/etc.) under your chosen `abraDir` value. This allows you to have multiple independent versions of specific recipes which are relevant for specific projects vs. relying on a single `$ABRA_DIR/recipes/` and constantly having to switch between different chaotic hacks. + ## Running abra server side If you're on an environment where it's hard to run Docker, or command-line programs in general, you might want to install `abra` on a server instead of your local work station.