Skip to main content

Quick install

Fast path to a local DeployDock stack from the monorepo (matches deploy-dock README).

In this page​

Steps​

  1. Clone the repository and enter it:

    git clone https://github.com/gwalesh/deploy-dock.git
    cd deploy-dock

  2. Enable pnpm:

    corepack enable && corepack prepare pnpm@9.15.0 --activate

  3. Install dependencies:

    pnpm install

  4. PostgreSQL + Redis — run locally or start deploy/docker/docker-compose.yml for just postgres + redis if you prefer containers.

  5. Configure API env:

    cp apps/api/.env.example apps/api/.env

    Edit DATABASE_URL, secrets, and PANEL_WEB_ORIGIN (default http://127.0.0.1:5173 for Vite). If Redis is unavailable, set PANEL_DISABLE_QUEUE=1.

  6. Migrate + seed:

    pnpm --filter @deploydock/api exec prisma migrate deploy
    pnpm --filter @deploydock/api exec prisma db seed

  7. Run dev servers:

    pnpm dev

Verify​

  • UI: http://127.0.0.1:5173
  • Swagger: http://127.0.0.1:4000/api/docs
  • Health: curl -s http://127.0.0.1:4000/api/v1/health

Next​

Continue with First login (/auth/setup).

For Docker-only API/worker, see Docker install.