chill-crate-api

chill-crate-api

REST API for managing file storage organized into groups and buckets. Files are stored in S3-compatible object storage (MinIO or Ceph) with metadata tracked in PostgreSQL.

Stack

• Go 1.26 / Gin — HTTP server
• GORM + PostgreSQL 16 — metadata storage
• AWS SDK v2 / MinIO — object storage
• Keycloak — authentication (in progress)
• Viper — configuration

Concepts

API

GET    /ping

POST   /groups                                        create group
GET    /groups                                        list user's groups
GET    /groups/:groupId/buckets                       list buckets in group
GET    /groups/:groupId/buckets/:name                 get bucket by name

POST   /buckets                                       create bucket
DELETE /buckets/:bucketId                             delete bucket (add ?force=true to remove non-empty)
GET    /buckets/:bucketId/objects                     list objects in bucket (latest version per file)
POST   /buckets/:bucketId/objects/:filename           upload file (creates new version)
GET    /buckets/:bucketId/objects/:filename           download file (latest version)
DELETE /buckets/:bucketId/objects/:filename           soft-delete file (inserts delete marker)
POST   /buckets/:bucketId/objects/:filename/restore   restore soft-deleted file

GET    /objects/:id                                   get object metadata by ID

Getting Started

Prerequisites: Go 1.26+, Docker, Docker Compose

# 1. Copy and configure environment
cp .env.example .env

# 2. Start dependencies (PostgreSQL, MinIO, Keycloak)
docker-compose up -d

# 3. Run the server
go run cmd/server/main.go
# Listening on http://localhost:8081

# Health check
curl http://localhost:8081/ping

Configuration

Copy .env.example to .env and set:

Docker Compose services are available at:

• PostgreSQL: localhost:5432
• MinIO API: localhost:9000, console: localhost:9001
• Keycloak: localhost:8080

License

Apache 2.0 — see LICENSE.