A web UI for Garage S3 clusters, focused on the operational views other Garage UIs lack: per-node resync queues, replication progress, and blocks that are not yet fully replicated — plus full bucket, access key, and cluster layout management.
Built with Next.js (App Router) and shadcn/ui, talking to the Garage admin API v2 (Garage 2.x). The admin token stays server-side; the browser only ever talks to this app.
- Dashboard — cluster health, partition replication status, per-node disk usage and resync queue at a glance, cluster statistics.
- Replication — per-node view of every node's resync queue length, resync errors, background worker states with progress bars, errored blocks with retry ("retry all now"), and metadata table queues (merkle/GC/insert).
- Buckets — create buckets, global aliases, quotas, static website hosting config, per-bucket stats, incomplete-upload cleanup, delete (empty buckets only).
- Access keys — create, import, rename, delete keys; grant/revoke per-bucket read/write/owner permissions from both the key page and the bucket page.
- Cluster layout — assign/edit/remove node roles (zone, capacity, tags, gateway), preview staged changes, apply/revert layout versions with confirmation, connect new nodes.
Copy .env.example to .env.local (dev) or set environment variables (prod):
| Variable | Default | Purpose |
|---|---|---|
GARAGE_ADMIN_ENDPOINT |
http://localhost:3903 |
Garage admin API v2 base URL |
GARAGE_ADMIN_TOKEN |
— | Admin bearer token (server-side only) |
GARAGE_ADMIN_TIMEOUT_MS |
8000 |
Max wait per admin API call before erroring |
GARAGE_ADMIN_SLOW_TIMEOUT_MS |
180000 |
Timeout for expensive per-node stats endpoints |
GARAGEDOOR_READ_ONLY |
false |
Refuse all mutating admin calls server-side |
GARAGEDOOR_DATA_DIR |
./data (/data in Docker) |
Persisted resync history location |
GARAGEDOOR_SAMPLE_INTERVAL_MS |
300000 |
Background stats sampling cadence (5 min) |
GARAGEDOOR_HISTORY_RETENTION_DAYS |
30 |
History retention window |
The server samples per-node resync queues on the configured cadence and persists
them, powering the chart's 1h/6h/24h/7d ranges and the convergence ETA. Mount a
volume at /data (Docker) to keep history across restarts:
docker run -p 3000:3000 -v garagedoor-data:/data \
-e GARAGE_ADMIN_ENDPOINT=... -e GARAGE_ADMIN_TOKEN=... garagedoorSecurity note: the UI itself has no authentication — deploy it on a trusted network or behind an authenticating reverse proxy.
Requires Node 20+ and Docker.
npm install
docker compose -f dev/docker-compose.yml up -d # 3-node Garage 2.x cluster
./dev/setup.sh # connect nodes + apply layout
node dev/seed.mjs # demo bucket, key, and objects
npm run dev # http://localhost:3000The dev cluster publishes node 1's S3 API on :3900 and admin API on :3903
(token garagedoor-dev-admin-token), which matches the defaults in .env.example.
docker build -t garagedoor .
docker run -p 3000:3000 \
-e GARAGE_ADMIN_ENDPOINT=http://your-garage:3903 \
-e GARAGE_ADMIN_TOKEN=your-admin-token \
garagedoor- Block rebuilds ("Force resync") require typing every target node's name in a confirmation dialog. The server checks each name against current cluster status and accepts only explicit node IDs, so newly joined nodes are not included.
- The server-side proxy only forwards an explicit allowlist of admin endpoints.
PurgeBlocks(permanent data deletion) and admin-token management are excluded. - Layout changes are staged first and require an explicit, confirmed apply.
- Bucket deletion is only possible for empty buckets (enforced by Garage).