Quat Documentation
User documentation for Quat, a local S3-compatible object storage platform.
Overview
Quat is a customer-facing console for managing S3-style object storage on local, private, or self-managed infrastructure. It provides account onboarding, subscription-gated API credentials, bucket management, object uploads and downloads, CORS configuration, usage visibility, and billing workflows.
Use Quat when you want applications to store files through S3-compatible SDKs without depending on AWS infrastructure.
What Quat Does
Quat lets users:
- Create and manage buckets.
- Upload, list, download, and delete objects through the Quat console.
- Obtain an access key and secret key for S3-compatible SDK integrations.
- Regenerate credentials when needed.
- Configure bucket CORS rules.
- Review storage, upload, download, and operation usage.
- Choose subscription plans backed by local infrastructure pricing.
Use Cases
| Use case | Description |
|---|---|
| Private object storage | Store files in infrastructure controlled by your organization. |
| S3 SDK replacement | Point existing AWS S3 SDK integrations at a Quat-compatible endpoint. |
| Application media storage | Store user uploads, images, generated reports, exports, and attachments. |
| Internal platform storage | Provide buckets and credentials to internal teams. |
| Cost-controlled storage | Use subscription plans and local infrastructure pricing instead of AWS pricing. |
Key Features
- S3-style access key and secret key credentials.
- Bucket creation and deletion.
- Object upload/download/list/delete from the web console.
- Backend-generated upload intents and download links for console operations.
- Bucket CORS rule management.
- Usage statistics and usage export endpoints.
- Subscription plans with storage, bucket, read, and write limits.
- Chapa and Telebirr payment provider integration in the customer console.
Who Should Use Quat
Quat is intended for:
- Developers replacing AWS S3 in existing applications.
- Teams running object storage on local or private infrastructure.
- Organizations that need account, billing, and usage visibility around storage.
- Operators who want a customer console over an S3-compatible backend such as Ceph.
Architecture
At a high level, Quat has three surfaces:
| Surface | Purpose |
|---|---|
| Customer console | Next.js application where users manage buckets, CORS, credentials, usage, and billing. |
| Quat backend API | Account, subscription, bucket metadata, upload intent, download link, CORS, key, and usage endpoints. |
| S3-compatible storage endpoint | Object storage endpoint used by S3 SDKs with access key and secret key credentials. |
Applications usually connect directly to the S3-compatible storage endpoint with an AWS-compatible SDK. Users manage credentials and buckets in the Quat console.