diff --git a/docs/garage.md b/docs/garage.md index e1e82fb2..6671d7b4 100644 --- a/docs/garage.md +++ b/docs/garage.md @@ -4,29 +4,64 @@ 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 +``` + +Creating a new bucket and access keys: + +``` garage bucket create garage key create -key garage bucket allow --read --write --key -key ``` -Docs: https://garagehq.deuxfleurs.fr/documentation/quick-start/#creating-buckets-and-keys +Full example for `mastodon` bucket: + +``` +garage bucket create mastodon + +garage key create mastodon-key + +garage bucket allow mastodon --read --write --key mastodon-key +``` Then [setup your favourite S3 client](https://garagehq.deuxfleurs.fr/documentation/connect/cli/) or use the bucket with any [S3 compatible software](https://garagehq.deuxfleurs.fr/documentation/connect/). +Further reading: + +- https://garagehq.deuxfleurs.fr/documentation/quick-start/ +- https://garagehq.deuxfleurs.fr/documentation/connect/ +- https://garagehq.deuxfleurs.fr/documentation/connect/apps/#mastodon + ### Notes on manual setup steps ``` 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