Skip to Content
Getting StartedQuick Start

Quick Start

Get PicPeak running in under five minutes with Docker.

Requirements: Docker v20.10+ and Docker Compose v2.0+. At least 2 CPU cores, 2 GB RAM, 20 GB storage.

Clone and configure

git clone https://github.com/the-luap/picpeak.git cd picpeak cp .env.example .env

Generate secure secrets and edit .env:

# Generate values openssl rand -base64 64 # use for JWT_SECRET openssl rand -base64 32 | tr -d '$' # use for DB_PASSWORD openssl rand -base64 32 | tr -d '$' # use for REDIS_PASSWORD

Open .env and set these three values:

JWT_SECRET=<paste generated value> DB_PASSWORD=<paste generated value> REDIS_PASSWORD=<paste generated value>

Create storage directories

mkdir -p events/active events/archived data logs backup storage

The backend container will chown these to its internal nodejs user on first boot — no PUID/PGID setup needed. If you’ve pinned user: in a compose override, see Permissions for the manual pre-chown step.

Start PicPeak

docker compose -f docker-compose.production.yml pull docker compose -f docker-compose.production.yml up -d

Wait for all containers to report as healthy:

docker compose ps

Open PicPeak

Open http://localhost:3000 in your browser. The admin panel is at http://localhost:3000/admin.

The frontend (port 3000) serves the UI and proxies API requests to the backend (port 3001). You don’t need to access port 3001 directly.

Next: First Login — find your admin password and complete the mandatory password change.

Last updated on