mirror of
https://github.com/Noooste/garage-ui.git
synced 2026-07-26 07:48:13 +00:00
docs: add garage setup guide and update config example filename
Signed-off-by: Noooste <83548733+Noooste@users.noreply.github.com>
This commit is contained in:
+2
-2
@@ -52,7 +52,7 @@ dist-ssr
|
||||
*.sw?
|
||||
|
||||
.env*
|
||||
!config.yaml.example
|
||||
!config.example.yaml
|
||||
docker-compose.*.yml
|
||||
!backend/tests/smoke/docker-compose.test.yml
|
||||
|
||||
@@ -64,6 +64,6 @@ garage.toml
|
||||
backend/docs/
|
||||
config.yaml
|
||||
docs/**/*.md
|
||||
|
||||
!docs/garage-setup.md
|
||||
# Superpowers brainstorm / session scratch
|
||||
.superpowers/
|
||||
@@ -0,0 +1,59 @@
|
||||
# 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](../README.md#quick-start).
|
||||
|
||||
## Prerequisites
|
||||
|
||||
- Docker & Docker Compose
|
||||
|
||||
## 1. Start Garage
|
||||
|
||||
From the garage-ui repository root:
|
||||
|
||||
```bash
|
||||
docker compose up -d garage
|
||||
sleep 10
|
||||
```
|
||||
|
||||
## 2. Initialize the Cluster Layout
|
||||
|
||||
```bash
|
||||
# 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
|
||||
|
||||
```bash
|
||||
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:
|
||||
|
||||
```bash
|
||||
cp config.example.yaml config.yaml
|
||||
```
|
||||
|
||||
The `admin_token` can be found in your `garage.toml` file. See [Garage Configuration](../README.md#garage-configuration) for the required `garage.toml` settings.
|
||||
|
||||
## 5. Start Garage UI
|
||||
|
||||
```bash
|
||||
docker compose up -d garage-ui
|
||||
```
|
||||
|
||||
Access Garage UI at http://localhost:8080
|
||||
|
||||
## Next Steps
|
||||
|
||||
- [Configuration reference](../config.example.yaml) for all available options
|
||||
- [Garage official documentation](https://garagehq.deuxfleurs.fr/documentation/) for advanced Garage setup
|
||||
Reference in New Issue
Block a user