Installation

Installation

Requirements

• Docker
• Docker Compose

Docker Compose

git clone https://github.com/xiao-villamor/PrintStash.git
cd PrintStash

cp .env.example .env
# Edit .env and change VAULT_JWT_SECRET.

docker compose up -d --build

Open:

Service	URL
Web UI	http://localhost:3000
API docs	http://localhost:8000/docs
Health check	http://localhost:8000/api/v1/health

On first launch, the web UI walks through creating the first admin account. There is no default username or password.

Tagged Images

Tagged releases publish Docker images to GitHub Container Registry:

Image	Purpose
ghcr.io/xiao-villamor/printstash-api:<version>	FastAPI backend
ghcr.io/xiao-villamor/printstash-frontend:<version>	Vite/React frontend

The checked-in Compose file builds locally by default so contributors can run from source. Self-hosted release installs can pin the GHCR images in a Compose override.

Upgrades

Read UPGRADE.md before upgrading an existing install. Release smoke checks are listed in release validation.

Recovery

Backup and restore recovery steps live in disaster recovery.