garage-ui/docs/garage-setup.md

Setting Up a Garage Cluster

This guide walks you through setting up a local Garage cluster using Docker Compose for use with Garage UI.

If you already have a running Garage cluster, skip this and go straight to the Quick Start.

Prerequisites

• Docker & Docker Compose

1. Start Garage

From the garage-ui repository root:

docker compose up -d garage
sleep 10

2. Initialize the Cluster Layout

# Assign the node to a zone with 1GB capacity
docker compose exec garage garage layout assign -z dc1 -c 1G $(docker compose exec garage garage node id -q)

# Apply the layout
docker compose exec garage garage layout apply --version 1

3. Create an Admin Key

docker compose exec garage garage key create admin-key

Save the access key and secret key from the output — you'll need them for configuration.

4. Configure Garage UI

Copy the example config and fill in your Garage endpoints and admin token:

cp config.example.yaml config.yaml

The admin_token can be found in your garage.toml file. See Garage Configuration for the required garage.toml settings.

5. Start Garage UI

docker compose up -d garage-ui

Access Garage UI at http://localhost:8080

Next Steps

• Configuration reference for all available options
• Garage official documentation for advanced Garage setup