Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/nhost/hasura-storage
Storage for Hasura built on top of S3
https://github.com/nhost/hasura-storage
files hasura nhost s3 storage upload
Last synced: 2 days ago
JSON representation
Storage for Hasura built on top of S3
- Host: GitHub
- URL: https://github.com/nhost/hasura-storage
- Owner: nhost
- License: apache-2.0
- Created: 2021-09-23T23:03:37.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2024-11-06T07:55:48.000Z (about 1 month ago)
- Last Synced: 2024-11-29T15:18:39.867Z (14 days ago)
- Topics: files, hasura, nhost, s3, storage, upload
- Language: Go
- Homepage:
- Size: 27.9 MB
- Stars: 215
- Watchers: 6
- Forks: 42
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Security: SECURITY.md
Awesome Lists containing this project
- awesome-hasura - Hasura Storage - Storage for Hasura. Built on top of S3. (Tools and Extensions)
README
# Hasura Storage
Hasura storage is a service that adds a storage service on top of hasura and any s3-compatible storage service. The goal is to be able to leverage the cloud storage service while also leveraging hasura features like its graphql API, permissions, actions, presets, etc...
## Workflows
To understand what hasura-storage does we can look at the two main workflows to upload and retrieve files.
### Uploading files
When a user wants to upload a file hasura-storage will first check with hasura if the user is allowed to do so, if it the file will be uploaded to s3 and, on completion, file metadata will be stored in hasura.
``` mermaid
sequenceDiagram
actor User
autonumber
User->>+hasura-storage: upload file
hasura-storage->>+hasura: check permissions
hasura->>-hasura-storage: return if user can upload file
hasura-storage->>+s3: upload file
s3->>-hasura-storage: file information
hasura-storage->>+hasura: file metadata
hasura->>-hasura-storage: success
hasura-storage->>-User: file metadata
```
### Retrieving files
Similarly, when retrieving files, hasura-storage will first check with hasura if the user has permissions to retrieve the file and if the user is allowed, it will forward the file to the user:
``` mermaid
sequenceDiagram
actor User
autonumber
User->>+hasura-storage: request file
hasura-storage->>+hasura: check permissions
hasura->>-hasura-storage: return if user can access file
hasura-storage->>+s3: request file
s3->>-hasura-storage: file
hasura-storage->>-User: file
```
## Features
The main features of the service are:
- leverage hasura's permissions to allow users to upload/retrieve files
- upload files to any s3-compatible service
- download files from any s3-compatible service
- create presigned URLs to grant temporary access
- caching information to integrate with caches and CDNs (cache headers, etag, conditional headers, etc)
- perform basic image manipulation on the fly
- integration with [clamav](https://www.clamav.net) antivirus
## Antivirus
Integration with [clamav](https://www.clamav.net) antivirus relies on an external [clamd](https://docs.clamav.net/manual/Usage/Scanning.html#clamd) service. When a file is uploaded `hasura-storage` will create the file metadata first and then check if the file is clean with `clamd` via its TCP socket. If the file is clean the rest of the process will continue as usual. If a virus is found details about the virus will be added to the `virus` table and the rest of the process will be aborted.
``` mermaid
sequenceDiagram
actor User
User ->> storage: upload file
storage ->>clamav: check for virus
alt virus found
storage-->s3: abort upload
storage->>graphql: insert row in virus table
else virus not found
storage->>s3: upload
storage->>graphql: update metadata
end
```
This feature can be enabled with the flag `--clamav-server string`, where `string` is the tcp address for the clamd service.
## OpenAPI
The service comes with an [OpenAPI definition](/controller/openapi.yaml) which you can also see [online](https://editor.swagger.io/?url=https://raw.githubusercontent.com/nhost/hasura-storage/main/controller/openapi.yaml).
## Using the service
Easiest way to get started is by using [nhost](https://nhost.io)'s free tier but if you want to self-host you can easily do it yourself as well.
### Self-hosting the service
Requirements:
1. [hasura](https://hasura.io) running, which in turns needs [postgres or any other supported database](https://hasura.io/docs/latest/graphql/core/databases/index/#supported-databases).
2. An s3-compatible service. For instance, [AWS S3](https://aws.amazon.com/s3/), [minio](https://min.io), etc...
A fully working example using docker-compose can be found [here](/build/dev/docker/). Just remember to replace the image `hasura-storage:dev` with a valid [docker image](https://hub.docker.com/r/nhost/hasura-storage/tags), for instance, `nhost/hasura-storage:0.1.5`.
## Contributing
If you need help or want to contribute it is recommended to read the [contributing](/CONTRIBUTING.md) information first. In addition, if you plan to contribute with code it is also encouraged to read the [development](/DEVELOPMENT.md) guide.