storage-api (Go + RustFS)

Supabase Storage SDK–compatible HTTP API that talks directly to physical storage engines (S3-compatible). No PostgreSQL, no logical buckets.

中文文档

• Multi-engine: YAML config + STORAGE_DEFAULT_ENGINE env var
• Bucket routing: engine:bucket (e.g. rustfs:uploads); omit engine to use the default
• Preview: on-demand rendering for images, video, PDF, and Office (imgproxy, Gotenberg, Poppler, ffmpeg)

Quick start

docker compose -f deploy/docker-compose.yml up -d --build

• Transform example: GET /storage/v1/render/image/public/uploads/photo.png?width=320&height=200&resize=cover

cp .env.example .env
go run ./cmd/server

Configuration

config/storage.yaml:

default_engine: rustfs
engines:
  rustfs:
    type: s3
    endpoint: http://localhost:9000
    region: us-east-1
    access_key_id: rustfsadmin
    secret_access_key: rustfsadmin
    path_style: true

Environment variables:

Variable	Description
STORAGE_CONFIG_PATH	Path to YAML config
STORAGE_DEFAULT_ENGINE	Override default engine
API_KEY	Server API key; required on /storage/v1 when set
API_KEYS	Comma-separated API keys (alternative to API_KEY)
JWT_SECRET	Supabase-style HS256 JWT secret; Authorization: Bearer <jwt> accepted
ALLOW_PRESIGNED_UPLOAD	false disables S3 presigned PUT (signUpload)
AUTH_DOWNLOAD_MODE	proxy (default) or redirect for authenticated downloads
IMGPROXY_KEY / IMGPROXY_SALT	Required when IMGPROXY_INSECURE=false
AUTHZ_HTTP_URL	External HTTP authorizer (docs/AUTHZ.md)
PREVIEW_ASYNC	Async PDF/Office preview (GET /render/job/{id})
SIDECAR_API_TOKEN	Bearer token for Gotenberg and preview-worker

Supabase SDK usage

const supabase = createClient(url, key, {
  global: { fetch: customFetch },
});
// bucket id supports engine:bucket format
await supabase.storage.from('rustfs:uploads').upload('a.png', file);
await supabase.storage.from('uploads').download('a.png');

Project layout

cmd/server/
internal/api/          # Supabase Storage HTTP API
internal/engine/       # Multi-engine registry and S3 driver
internal/transform/    # On-demand image transforms
internal/preview/      # PDF/Office preview pipeline
config/storage.yaml    # Local / non-Docker storage config
deploy/                # Docker Compose, Dockerfiles, container config

See docs/ARCHITECTURE.md, docs/TRANSFORM_BACKENDS.md, docs/AUTHZ.md, and docs/CROSS_ENGINE.md.

Agent instructions: AGENTS.md

License

MIT