Folders and files

Name		Name	Last commit message	Last commit date
Latest commit History 844 Commits
.docker		.docker
.github		.github
migrations		migrations
monitoring		monitoring
patches		patches
src		src
static		static
.dockerignore		.dockerignore
.env.sample		.env.sample
.env.test.sample		.env.test.sample
.eslintrc.js		.eslintrc.js
.gitignore		.gitignore
.prettierignore		.prettierignore
.prettierrc		.prettierrc
.releaserc		.releaserc
Dockerfile		Dockerfile
LICENSE		LICENSE
README.md		README.md
babel.config.cjs		babel.config.cjs
build.js		build.js
docker-compose-multi-tenant.yml		docker-compose-multi-tenant.yml
docker-compose.yml		docker-compose.yml
jest-setup.ts		jest-setup.ts
jest.config.cjs		jest.config.cjs
jest.sequencer.cjs		jest.sequencer.cjs
package-lock.json		package-lock.json
package.json		package.json
tsconfig.json		tsconfig.json

Repository files navigation

Supabase Storage Engine

A scalable, lightweight object storage service.

Readthis post on why we decided to build a new object storage service.

Multi-protocol support (HTTP, TUS, S3, Iceberg)
Uses Postgres as its datastore for storing metadata
Authorization rules are written as Postgres Row Level Security policies
Integrates with S3 Compatible Storages
Extremely lightweight and performant

Supported Protocols

HTTP/REST
TUS Resumable Upload
S3 Compatible API
Iceberg REST Catalog

Documentation

Development

Copy.env.sample to.env file.
Copy.env.test.sample to.env.test.

cp .env.sample .env&& cp .env.test.sample .env.test

Your root directory should now have both.env and.env.test files.

Then run the following:

# this sets up a postgres database and postgrest locally via dockernpm run infra:restart# Start the storage servernpm run dev

The server should now be running athttp://localhost:5000/

The following request should insert and return the list of buckets.

# insert a bucket named avatarscurl --location --request POST'http://localhost:5000/bucket' \--header'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJyb2xlIjoic2VydmljZV9yb2xlIiwiaWF0IjoxNjEzNTMxOTg1LCJleHAiOjE5MjkxMDc5ODV9.th84OKK0Iz8QchDyXZRrojmKSEZ-OuitQm_5DvLiSIc' \--header'Content-Type: application/json' \--data-raw'{    "name": "avatars"}'# get bucketscurl --location --request GET'http://localhost:5000/bucket' \--header'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJyb2xlIjoic2VydmljZV9yb2xlIiwiaWF0IjoxNjEzNTMxOTg1LCJleHAiOjE5MjkxMDc5ODV9.th84OKK0Iz8QchDyXZRrojmKSEZ-OuitQm_5DvLiSIc'