Docker Setup

Recommended Docker workflows for infrastructure-only and full-stack deployments.

by @saifyxpro

Recommended development workflow

For most developers, the cleanest setup is:

  • PostgreSQL: Supabase or Docker
  • Redis: Docker
  • app runtime: pnpm dev

This keeps the application easy to iterate on while avoiding local Redis installation.

Mixed local setup

Run PostgreSQL and Redis in Docker, then run the apps locally.

PostgreSQL

Redis

Start the workspace

Full Docker stack

HeadlessX ships Docker infrastructure in infra/docker.

Populate at least:

  • DASHBOARD_INTERNAL_API_KEY
  • CREDENTIAL_ENCRYPTION_KEY
  • database values
  • REDIS_URL if your deployment differs from defaults

Full Docker now includes:

  • postgres
  • redis
  • html-to-markdown
  • api
  • worker
  • web
  • yt-engine

Without Docker

If you do not want Docker at all, install these locally on your OS first:

  • PostgreSQL
  • Redis

Official installers:

Caveats

  • queued crawl features do not work with API-only boot; the worker must also be running
  • if you run apps locally, Docker is still a good choice for Redis
  • YouTube flows now work inside the full Docker stack because yt-engine is part of compose

Troubleshooting