Skip to content

About

A web console for managing Garage clusters, buckets, access keys, users, and objects.

Resources

Stars

0 stars

Watchers

1 watching

Forks

Repository files navigation

Garage Web UI

Web interface for managing Garage buckets, access keys, admin tokens, and objects.

Garage Web UI overview showing cluster health and bucket storage

Quick Start

Run locally (Docker Compose, Go, and npm required):

make run

Open http://localhost:8080 and sign in with the development admin token local-garage-admin-token.

Or run the full stack in Docker:

docker compose -p garage-webui-dev -f dev/compose/compose.yaml up --build -d

For deployable Compose and Kubernetes examples, including persistent storage and credential setup, see Deployment.

Flags

Flag Description
--database-url PostgreSQL connection URL or SQLite file URL (required)
--session-secret Base64-encoded 32-byte key encrypting credential sessions (required)
--garage-url Garage Admin API URL (required)
--listen-address Web UI listen address (default 127.0.0.1:8080)
--management-listen-address Health endpoint listen address (default 127.0.0.1:8081)
--public-url Public origin (default http://localhost:8080)
--route-prefix Optional URL path prefix
--s3-url Garage S3 endpoint for backend browsing and transfers (falls back to --s3-public-url)
--s3-public-url Optional public S3 endpoint for direct uploads and downloads
--s3-response-header-timeout S3 response-header wait after sending a request body (default 45s; 0 disables)
--s3-region S3 region (default garage)
--log-format json or text
--debug Enable debug logging
--access-log Enable HTTP access logging

Flags are also available as environment variables prefixed with GARAGE_WEBUI__, for example GARAGE_WEBUI__ROUTE_PREFIX=/garage. Run garage-webui --help for the complete list.

For a single instance, use GARAGE_WEBUI__DATABASE_URL=sqlite:///data/garage-webui.db with a persistent, writable /data directory. PostgreSQL remains available for multiple replicas. See SQLite configuration for details.

Normal browsing, uploads, and downloads stream through the Go backend and do not need bucket CORS. Optional Upload directly to S3 and Download directly from S3 actions use signed URLs; direct uploads require bucket CORS.

Authentication

Sign in with a Garage admin token for administration, or an S3 access key and secret for bucket access. Garage controls permissions. Admins can create, edit, and revoke named admin tokens according to their scopes. PostgreSQL or SQLite stores revocable sessions with encrypted credentials.

License

No license has been specified in the current repository snapshot.

About

A web console for managing Garage clusters, buckets, access keys, users, and objects.

Resources

Stars

0 stars

Watchers

1 watching

Forks

Releases

Packages

Contributors

Languages