From 8f6a7ab05e7cb786fe3c8b9fff68dfde0678e254 Mon Sep 17 00:00:00 2001
From: teutat3s <teutates@mailbox.org>
Date: Wed, 23 Oct 2024 20:53:05 +0200
Subject: [PATCH] docs: more garage CLI usage, avoid leaking secret

---
 docs/garage.md | 34 +++++++++++++++++++++++++++++++++-
 1 file changed, 33 insertions(+), 1 deletion(-)

diff --git a/docs/garage.md b/docs/garage.md
index e1e82fb..cc7f930 100644
--- a/docs/garage.md
+++ b/docs/garage.md
@@ -4,18 +4,45 @@
 
 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=<secret-in-keepass>
+```
+# Add a few spaces to avoid leaking the secret to the shell history
+   export GARAGE_RPC_SECRET=<secret-in-keepass>
+```
+
+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 <bucket-name>
 garage key create <bucket-name>-key
 garage bucket allow <bucket-name> --read --write --key <bucket-name>-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/)
@@ -47,3 +74,8 @@ 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