Garage S3 for Cloudron

Garage is an open-source, S3-compatible object store designed for self-hosted, geo-distributed deployments. It is lightweight, highly resilient, and perfect for small clusters or single-node setups.

Features

• S3 Compatible: Works with standard S3 tools (AWS CLI, MinIO Client, Rclone, etc.).
• Lightweight: Extremely efficient resource usage, suitable for older hardware or small VPS instances.
• Resilient: Designed to handle network failures and node outages gracefully.
• Multi-Architecture: Supports x86_64, arm64, and others (this package is configured for x86_64).
• Web UI: Includes a built-in web interface for managing buckets and keys.

Getting Started

Once installed, the app automatically initializes a single-node cluster with a default capacity of 100GB.

1. Retrieve Credentials:

   • Use the Cloudron File Manager to open /app/data/credentials.txt.
   • Note the username (admin) and password.

2. Open the Web UI: Click the app icon in your Cloudron dashboard and log in with the credentials from step 1.

3. Create Buckets: Use the "Buckets" tab to create storage containers.

4. Generate Keys: Use the "Keys" tab to create Access/Secret keys for your applications.

Connecting Clients

MinIO Client (mc)

To use mc with Garage:

1. Install:
   • Mac: brew install minio/stable/mc
   • Linux: curl https://dl.min.io/client/mc/release/linux-amd64/mc -o mc && chmod +x mc && sudo mv mc /usr/local/bin/
2. Configure:

   mc alias set garage https://garage.yourdomain.com ACCESS_KEY SECRET_KEY
   

3. Test:

   mc ls garage/
   

Rclone

To use rclone with Garage:

1. Install: curl https://rclone.org/install.sh | sudo bash (or via brew/apt).
2. Configure: Run rclone config and select "s3".
   • Provider: Other
   • env_auth: false
   • access_key_id: (Your Access Key)
   • secret_access_key: (Your Secret Key)
   • region: garage (or leave blank)
   • endpoint: https://garage.yourdomain.com
   • acl: private (default)
3. Test:

   rclone lsd remote_name:
   

Common Questions

Q: If I delete a bucket, is the data deleted from the disk? A: Yes. When you delete a bucket via the Web UI or CLI, Garage removes the bucket and schedules the underlying data for garbage collection. You do not need to manually delete files from the disk; the system handles cleanup automatically to reclaim space.

Q: Can I use the same Access Key for multiple buckets? A: Yes. You can create a single Access Key (in the "Keys" tab) and grant it permissions to as many buckets as you like. You can also mix permissions (e.g., Read-Only on one bucket, Read/Write on another) for the same key.

Documentation

For advanced usage, clustering, and API details, visit the official Garage Documentation.