pocketstream

module
v0.3.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Oct 30, 2025 License: MIT

README

PocketStream - Admin UI + REST API for any S3 Storage

github.com/nativebpm/pocketstream

File storage with SQLite metadata, PocketBase API, S3/local storage, and instant replication backups via Litestream.

Key Features

  • Simple technology stack: Docker + SQLite + Litestream + PocketBase + S3 backends
  • Shell-script-free, Go binaries for better security and portability
  • Simple deployment with Docker and Makefile
  • Automatic backups with Litestream for seamless recovery
  • Automatic database recovery with Litestream restore
  • Built-in REST API and Admin UI via PocketBase
  • High reliability with minimal maintenance requirements

Storage Backends

Backend Type
Filesystem Local
MinIO Local S3
RustFS Local S3
Garage Distributed S3
SeaweedFS Distributed S3
rclone Local S3
AWS S3 Cloud

Requirements

  • Docker
  • Make
  • Go 1.24+ (for building from source)

Setup

  • Filesystem: Fast local file operations, no external dependencies, automatic local backups
make up-fs
make up-minio
  • RustFS: High-performance alternative to MinIO, optimized for high-throughput workloads
make up-rustfs
  • Garage: Distributed S3-compatible storage with built-in replication, ideal for multi-node clusters
make up-garage
  • SeaweedFS: Fast and scalable distributed file system with an S3 API, suited for high-performance workloads
make up-seaweedfs
  • rclone: Flexible S3-compatible layer using rclone serve s3, supports various storage backends
make up-rclone
  • AWS S3: Cloud-based storage offering high availability and scalability
make up-aws

Clean

make down-<backend>

License

This project is licensed under the MIT License - see the LICENSE file for details.

Directories

Path Synopsis
cmd
garage command
litestream command
pocketbase command
pocketstream command
internal

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL