Installation

The recommended way to install QuickRetro is by using Docker.

Ensure you have Docker Desktop OR Docker Engine with Compose plugin ready, and choose any of the below installation choices.

Quick Install (using pre-built image)

This creates containers for the app (with the latest vijeesh82/quickretro-app:latest image from DockerHub), and redis, using the compose.install.yml file.

Linux / MacOS / Windows (with git bash)

# Download compose file to local directory
curl -LO https://raw.githubusercontent.com/vijeeshr/quickretro/main/compose.install.yml

# Run in detached mode in background
docker compose -f compose.install.yml up -d

Windows PowerShell

# Download compose file to local directory
Invoke-WebRequest -Uri "https://raw.githubusercontent.com/vijeeshr/quickretro/main/compose.install.yml" -OutFile "compose.install.yml"

# Run in detached mode in background
docker compose -f compose.install.yml up -d

Visit http://localhost:8921 to open the app.

Install (build from source)

This creates containers for the app (with image built from source code), and redis, using the compose.yml file.

# Clone the repo in a empty directory
git clone https://github.com/vijeeshr/quickretro.git
cd quickretro

# Run in detached mode in background
docker compose up -d

Visit http://localhost:8921 to open the app.
To run in a different port, check Running in a different port

Install Full-Stack (build from source)

This creates containers for the app (with image built from source code), redis, and caddy as reverse-proxy using the compose.local.yml file.

This is closest to production setup.

# Clone the repo in a empty directory
git clone https://github.com/vijeeshr/quickretro.git
cd quickretro

# Run in detached mode in background
docker compose -f compose.local.yml up -d

Visit https://localhost to open the app.

---

TIP

For running QuickRetro directly in the host machine and outside of docker containers, check the Development page.