Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/supabase/storage
S3 compatible object storage service that stores metadata in Postgres
https://github.com/supabase/storage
gotrue object-storage postgres s3
Last synced: 27 days ago
JSON representation
S3 compatible object storage service that stores metadata in Postgres
- Host: GitHub
- URL: https://github.com/supabase/storage
- Owner: supabase
- License: apache-2.0
- Created: 2021-03-15T06:32:53.000Z (over 3 years ago)
- Default Branch: master
- Last Pushed: 2024-04-13T10:07:53.000Z (7 months ago)
- Last Synced: 2024-04-13T21:54:16.119Z (7 months ago)
- Topics: gotrue, object-storage, postgres, s3
- Language: TypeScript
- Homepage: https://supabase.com/docs/guides/storage
- Size: 3.46 MB
- Stars: 596
- Watchers: 22
- Forks: 89
- Open Issues: 36
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- jimsghstars - supabase/storage - S3 compatible object storage service that stores metadata in Postgres (TypeScript)
README
# Supabase Storage Engine
[](https://coveralls.io/github/supabase/storage-api?branch=master)
A scalable, light-weight object storage service.
> Read [this post](https://supabase.io/blog/2021/03/30/supabase-storage) on why we decided to build a new object storage service.
- Multi-protocol support (HTTP, TUS, S3)
- 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**
- [x] HTTP/REST
- [x] TUS Resumable Upload
- [x] S3 Compatible API
## Documentation
- [OpenAPI Spec](https://supabase.github.io/storage)
- [Storage Guides](https://supabase.io/docs/guides/storage)
- [Client library](https://supabase.io/docs/reference/javascript/storage-createbucket)
## Development
- Copy `.env.sample` to `.env` file.
- Copy `.env.test.sample` to `.env.test`.
```bash
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:
```bash
# this sets up a postgres database and postgrest locally via docker
npm run infra:restart
# Start the storage server
npm run dev
```
The server should now be running at http://localhost:5000/
The following request should insert and return the list of buckets.
```bash
# insert a bucket named avatars
curl --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 buckets
curl --location --request GET 'http://localhost:5000/bucket' \
--header 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJyb2xlIjoic2VydmljZV9yb2xlIiwiaWF0IjoxNjEzNTMxOTg1LCJleHAiOjE5MjkxMDc5ODV9.th84OKK0Iz8QchDyXZRrojmKSEZ-OuitQm_5DvLiSIc'
```
### Testing
To perform your tests you can run the following command: `npm test`