module
Version:
v0.3.0
Opens a new window with list of versions in this module.
Published: Oct 30, 2025
License: MIT
Opens a new window with license information.
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 |
Useful Links
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
Links
Clean
make down-<backend>
License
This project is licensed under the MIT License - see the LICENSE file for details.
Directories
¶
cmd
|
|
|
|
|
|
|
|
|
|
|
|
|
|
internal
|
|
|
|
|
|
|
|
Click to show internal directories.
Click to hide internal directories.