Skip to content

Commit

Permalink
initial commit of README
Browse files Browse the repository at this point in the history
  • Loading branch information
fullerzz committed Nov 27, 2024
1 parent 4209900 commit bfc55ca
Showing 1 changed file with 16 additions and 0 deletions.
16 changes: 16 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
# smolvault

smolvault is a self-hosted file storage tool I built to run on my Raspberry Pi.

## Overview

At its core, smolvault is a Python REST API written with [FastAPI](https://fastapi.tiangolo.com) that manages users and files.

File metadata is stored in a SQLite table while the uploaded files themselves are stored in S3.

> [!NOTE]
> When a user requests a file, that file is cached locally on the server for an indeterminate amount of time to improve subsequent download requests.
### IAC - AWS Resources

This project also includes a `terraform` directory containing code to setup IAM resources and an S3 bucket to store the uploaded files.

0 comments on commit bfc55ca

Please sign in to comment.