Ports and endpoints
This page lists verified ports from the deploy-dock monorepo (deploy/docker/*.yml, apps/api, Vite config, README).
In this page
Local development
| Service | Port | Notes |
|---|---|---|
| NestJS API | 4000 | PANEL_API_PORT (default 4000). Listens on 0.0.0.0. |
| Vite (React UI) | 5173 | Dev server; proxies /api to the API (see monorepo README). |
| PostgreSQL | 5432 | Your local instance or Docker postgres service. |
| Redis | 6379 | Required unless PANEL_DISABLE_QUEUE=1 (queue disabled; deploy completes inline on API). |
Health check (no auth): GET http://127.0.0.1:4000/api/v1/health
Swagger UI: http://127.0.0.1:4000/api/docs
Docker Compose (development)
File: deploy/docker/docker-compose.yml
| Published port | Container | Purpose |
|---|---|---|
| 5432 | postgres:16-alpine | PostgreSQL panel database. |
| 6379 | redis:7-alpine | BullMQ. |
| 4000 | api | NestJS API. |
The Vite dev server is not part of this compose file; run pnpm dev on the host for UI + API together, or point a browser tool at :4000 for API-only.
Docker Compose (production-style)
File: deploy/docker/docker-compose.prod.yml
| Published port | Service | Purpose |
|---|---|---|
| 8080 | web (nginx) | Static UI from apps/web/dist + reverse proxy of /api/ to the API container on port 4000. |
| 4000 | api | Exposed for debugging; browser traffic normally goes through nginx on 8080. |
| 5432 | postgres | Database. |
| 6379 | redis | Queue. |
README excerpt: open http://localhost:8080 after pnpm --filter @deploydock/web build and docker compose -f deploy/docker/docker-compose.prod.yml up -d --build.
HTTP paths
- API global prefix:
/api/v1(seeapps/api/src/main.ts). - Nginx prod config (
deploy/docker/nginx.panel.conf):location /api/→proxy_pass http://api:4000/api/;so browser requests stay same-origin on:8080. - OpenAPI JSON export (from README):
curl -s http://127.0.0.1:4000/api/docs-json -o openapi.json
Public marketing site for the project: https://deploydock.in (documentation you are reading now).