Docker Compose

Docker Compose is the recommended way to run LinkBreeze if you want to customize ports, add a reverse proxy, or manage updates easily.

Prerequisites

• Docker 20+ and Docker Compose v2 installed
• Port 3000 available (or map to any port you prefer)

Option A — Pull the Pre-Built Image

Create a docker-compose.yml:

services:
  linkbreeze:
    image: ghcr.io/manak-hash/linkbreeze:latest
    ports:
      - "3000:3000"
    volumes:
      - linkbreeze-data:/app/data
    restart: unless-stopped

volumes:
  linkbreeze-data:

Start it:

docker compose up -d

Option B — Build From Source

git clone https://github.com/Manak-hash/LinkBreeze.git
cd LinkBreeze
docker compose up -d --build

Updating

docker compose pull
docker compose up -d

Your data persists in the named volume linkbreeze-data.

Logs

docker compose logs -f linkbreeze

Backup

The database and uploads live in the Docker volume. To back up:

docker compose exec linkbreeze cat /app/data/linkbreeze.db > backup.db

Or use the built-in backup feature: Admin > Settings > Backup > Export.