Garage
Docker app from junkerderprovinz's Repository
Garage is a lightweight, S3-API-compatible object store built for small, self-hosted deployments - Rust, Apache-2.0, actively developed.
Requirements
Overview
Readme
View on GitHub
Build Upstream Garage garage-webui Unraid License
Garage, a lightweight, S3-compatible distributed object store, plus its web admin panel, bundled into one container for Unraid. Both are the official upstream binaries, unmodified, wired together with s6-overlay. No manual CLI setup: single-node layout, S3 key and bucket are all created automatically on first boot.
A one-knight job: I build it, keep it running, work through the issues and add what people ask for, until nothing is missing. It is free, with no accounts, no telemetry, no ads and no paid tier. No asterisk anywhere. Nothing readable ever leaves your own walls. Forged on evenings and weekends, with heart and stubbornness.
If it has earned a place on your server or computer, toss a coin to your knight: it helps cover the costs and keeps the project alive. It also makes this knight's heart beat a little faster. Three ways below, whichever suits you.
The buckets, keys and files in these pictures are made up.
The admin panel lists every bucket with its size and object count
The object browser opens any bucket, with upload and download in the browser
- Garage and its admin panel in one install. Garage is a lightweight, S3-compatible object store. garage-webui runs beside it in the same container, so buckets, keys and cluster health are one click away. Garage's own Community Applications listings split the server and the panel across three templates; this is one.
- No terminal step. The container runs Garage in single-node mode, which creates the cluster layout by itself. The access key, the secret key and a first bucket come from the template fields on the first start.
- The official binaries, unmodified. Both are copied from their upstream images and wired together with s6-overlay. None of it is rebuilt from source.
- Any S3 client works. rclone, restic, Kopia, Duplicati or your backup tool of choice talk to port 3900.
On Unraid, install Garage from Community Applications, fill in an access key and a secret key, and start it. Anywhere else, one container is enough:
docker run -d --name garage -p 3900:3900 -p 3909:3909 \
-e ACCESS_KEY=GK$(openssl rand -hex 12) \
-e SECRET_KEY=$(openssl rand -hex 32) \
-e BUCKET=backups \
-v /path/to/config:/config \
-v /path/to/data:/data \
junkerderprovinz/garage:latest
The log says GARAGE IS READY once it is up. The S3 endpoint is http://<server>:3900 with the region garage, and the admin panel is on port 3909. If a client only accepts AWS region names, set S3_REGION (the S3 Region field on Unraid), for example to us-east-1. It is written into garage.toml on every start, so there is no need to edit the file. An rclone remote for it looks like this:
[garage]
type = s3
provider = Other
access_key_id = YOUR_ACCESS_KEY
secret_access_key = YOUR_SECRET_KEY
endpoint = http://<server>:3900
region = garage
Back up /config and /data together. Losing /config keeps your objects but generates a new admin token and RPC secret on the next start.
Other Docker hosts
compose.yaml runs Garage on any Linux server with Docker. Put it in a folder of its own and start it with docker compose up -d. The folders are created next to the file.
- Synology: in Container Manager, create a project from the file (DSM 7.2 or newer).
- Proxmox: run it in a VM or an LXC container that has Docker.
- MOS: install Garage from the MOS Hub.
- ZimaOS and CasaOS: add the community store and install Garage from it.
- umbrelOS: add the community app store and install Garage from it.
One knight builds this, and AI is one of the tools I work with, the same way I work with an editor or a compiler. It helps me write code and documentation and it checks my work, and that saves me a good many evenings. It does not make the decisions, though. I read and understand everything before it ships, and if something here breaks, that is on me and not on the tool.
You do not have to take my word for it. The code is open and every release note is written by hand. The issue tracker shows how problems actually get handled, including the ones I got wrong the first time. If you find something that is not right, open an issue and I will look at it.
Questions? Check the support thread. Bugs, ideas or feature requests? Please open a GitHub issue.
Garage is made by Deuxfleurs and garage-webui by khairul169; both ship here unmodified under their own licences.
Categories
Download Statistics
Related apps
Explore more like this
Explore allLinks
Details
junkerderprovinz/garage:latestRuntime arguments
- Web UI
http://[IP]:[PORT:3909]- Network
bridge- Shell
sh- Privileged
- false
- Extra Params
--restart=unless-stopped
Template configuration
The S3-compatible endpoint every client (rclone, restic, aws-cli, ...) connects to. This is the port that matters functionally.
- Target
- 3900
- Default
- 3900
- Value
- 3900
Browser-based admin panel (garage-webui): buckets, keys, cluster health. This is what WebUI opens.
- Target
- 3909
- Default
- 3909
- Value
- 3909
Optional. Static-site hosting straight from a bucket (Garage's s3_web feature).
- Target
- 3902
- Default
- 3902
- Value
- 3902
Object data and metadata. This MUST be mapped or everything is lost on recreate.
- Target
- /data
- Default
- /mnt/user/appdata/garage/data
- Value
- /mnt/user/appdata/garage/data
Generated garage.toml (RPC secret, admin token). This MUST be mapped - losing it regenerates your RPC/admin secrets on next boot and breaks the admin panel's session.
- Target
- /config
- Default
- /mnt/user/appdata/garage/config
- Value
- /mnt/user/appdata/garage/config
S3 access key, pre-seeded on first boot. Required to write anything real - leaving this and Secret Key empty means no bucket/key gets created automatically.
- Target
- ACCESS_KEY
S3 secret key, paired with Access Key above. Use a real generated secret (e.g. openssl rand -hex 24), not a short password.
- Target
- SECRET_KEY
Optional. Name of a bucket to create automatically on first boot (e.g. backups). Leave empty to create buckets later via the admin panel or any S3 client.
- Target
- BUCKET
Optional. The region your S3 clients connect with. Leave it empty to keep the region in garage.toml (garage on a new install). Set it, for example to us-east-1, when a client only accepts AWS region names. It is applied on every start.
- Target
- S3_REGION
Garage's metadata engine. 'sqlite' (default) is the safer choice; 'lmdb' is faster but less tolerant of an unclean shutdown.
- Target
- DB_ENGINE
- Default
- sqlite|lmdb
- Value
- sqlite
User ID the processes run as. Default 99 = 'nobody' on Unraid.
- Default
- 99
- Value
- 99
Group ID the processes run as. Default 100 = 'users' on Unraid.
- Default
- 100
- Value
- 100