garage

An open-source distributed object storage service tailored for selfhosting at a small-to-medium scale.

• Category: Apps
• Status: wip
• Image: garage, 4, upstream
• Healthcheck: No
• Backups: No
• Email: No
• Tests: No
• SSO: No

Quick start

• abra app new garage
• If you don't already have an RPC secret for your Garage cluster, generate one: abra app secret generate --all
  • Note: In older versions of abra you must generate the secret locally with openssl rand -hex 32 then insert the result as described below
• If this Garage node is joining a cluster with an existing RPC secret, insert it: abra app secret insert <app-domain> rpc_secret v1 <rpc-secret>

Note: all nodes must share the same rpc secret, do not lose this value if you plan to cluster garage!

• abra app config <app-domain>
• abra app deploy <app-domain>

Configuration

Allow RPC Connections

• Your ingress controller must be set up to allow connections on port 3901. We assume you're using Traefik
• abra app configure <traefik-app-name>
• Uncomment the block that starts with ## Garage
• Re-deploy Traefik: abra app undeploy -n <traefik-app-name> && sleep 5 && abra app deploy -n <traefik-app-name>

Prepare the Garage Client

Start by creating an alias for the abra run command

alias garage="abra app run <app domain> -- app /garage"

Run garage status to verify everything is working

Garage Quick Start Guide

Once garage status works, you can follow the guide here: https://garagehq.deuxfleurs.fr/documentation/quick-start/#checking-that-garage-runs-correctly

Backups

In development, not currently reliable

By default, backups will only capture a snapshot of the metadata directory, which includes bucket names, hashed secrets, and other related information. By default, the actual data will not be backed up! If you're running Garage in a cluster, when you restore the metadata, other nodes will send the new node any missing data.

To enable full data backups

• abra app config <app domain>
• Uncomment the block that starts with ## Enable Full Data Backups
• Re-deploy Garaga: abra app undeploy -n <app domain> && sleep 5 && abra app deploy -n <app domain>

For more, see garagehq.deuxfleurs.fr.