https://github.com/zekrotja/sharex-backend
My private and very much over engineered, 100% serverless and (almost) completely free ShareX image sharing backend.
https://github.com/zekrotja/sharex-backend
rust serverless sharex vercel
Last synced: about 2 months ago
JSON representation
My private and very much over engineered, 100% serverless and (almost) completely free ShareX image sharing backend.
- Host: GitHub
- URL: https://github.com/zekrotja/sharex-backend
- Owner: zekroTJA
- License: mit
- Created: 2023-04-29T00:20:27.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2023-05-01T22:23:16.000Z (over 2 years ago)
- Last Synced: 2025-08-08T05:45:35.399Z (about 2 months ago)
- Topics: rust, serverless, sharex, vercel
- Language: Rust
- Homepage: https://imgupload-blush.vercel.app
- Size: 45.9 KB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# sharex-backend
My private and very much over engineered, 100% serverless and (almost) completely free [ShareX](https://getsharex.com) image sharing backend.
## Structure
The backend consists of Vercel serverless functions written in Rust (see [handler](handler/) crate) to authenticate and upload, retrieve, list and manage images. The authentication is done via the [OpenID Connect](https://openid.net/connect) flow. In this case, Auth0 is used as authentication server and identity provider. Images are stored in a S3 bucket on Contabo and persistent information like user-to-image links are stored in a Postgres database, in this case hosted on Supabase. To reduce load on the `GET i.zekro.de/:image_id` endpoint, CloudFront is used as proxy cache in front of Vercel functions.
```mermaid
flowchart TD
ApiEntryPoint([api.i.zekro.de])
ImageEntryPoint([i.zekro.de])
Cache[CloudFront]
Functions[Vercel Functions]
DB[Supabase PG]
S3[Contabo S3]
ImageEntryPoint <--> Cache
ApiEntryPoint <---> Functions
Cache <--> Functions
Functions <--> DB
Functions <--> S3
```
## Motivation
This project is primarily created to learn more about serverless software architecture - especially with Rust, authentication via OAuth2 and OpenID Connect and proxy caching via AWS Cloudfront.
## Todo
Because this project is currently WIP, some features are still missing but planned.
### Authentication
- [x] Login via OAuth2 + OpenID Connect
- [x] Authentication in serverless fucntions
- [ ] Creating API tokens for authentication
- [ ] Using API tokens for authentication
### Images
- [x] Upload images
- [x] Retrieve images
- [x] List users images
- [x] Delete images
### Web UI
- [ ] Web UI to list, view and manage images