From 68461d7a8e4cc1714503e8dec850fe5868f97d00 Mon Sep 17 00:00:00 2001 From: teutat3s Date: Wed, 23 Oct 2024 20:53:05 +0200 Subject: [PATCH] docs: more garage CLI usage, avoid leaking secret --- docs/garage.md | 40 ++++++++++++++++++++++++++++++++++++++-- 1 file changed, 38 insertions(+), 2 deletions(-) diff --git a/docs/garage.md b/docs/garage.md index e1e82fb..74f31bc 100644 --- a/docs/garage.md +++ b/docs/garage.md @@ -4,18 +4,47 @@ Requirements: +- `garage` RPC credentials, in the shared keepass, search for 'garage rpc secret'. - [Setup WireGuard](./administrative-access.md#ssh-access) for hosts: `trinkgenossin`, optionally: `delite`, `blue-shell` ``` ssh barkeeper@trinkgenossin.wg.pub.solar +``` -export GARAGE_RPC_SECRET= +# Add a few spaces to avoid leaking the secret to the shell history +``` + export GARAGE_RPC_SECRET= +``` + +Now, you can run the following command to check the cluster status: + +``` +garage status +``` + +Command to list all existing buckets: + +``` +garage bucket list +``` + +``` garage bucket create garage key create -key garage bucket allow --read --write --key -key ``` +Full example for `mastodon` bucket: + +``` +garage bucket create mastodon + +garage key create mastodon-key + +garage bucket allow mastodon --read --write --key mastodon-key +``` + Docs: https://garagehq.deuxfleurs.fr/documentation/quick-start/#creating-buckets-and-keys Then [setup your favourite S3 client](https://garagehq.deuxfleurs.fr/documentation/connect/cli/) @@ -26,7 +55,8 @@ or use the bucket with any [S3 compatible software](https://garagehq.deuxfleurs. ``` ssh barkeeper@trinkgenossin.wg.pub.solar -export GARAGE_RPC_SECRET= +# Add a few spaces to avoid leaking the secret to the shell history + export GARAGE_RPC_SECRET= # Uses the default config /etc/garage.toml garage node id @@ -47,3 +77,9 @@ garage layout apply --version 1 ``` Source: https://garagehq.deuxfleurs.fr/documentation/cookbook/real-world/#creating-a-cluster-layout + +Further reading: + +- https://garagehq.deuxfleurs.fr/documentation/quick-start/ +- https://garagehq.deuxfleurs.fr/documentation/connect/ +- https://garagehq.deuxfleurs.fr/documentation/connect/apps/#mastodon