System Requirements
Hardware, software, and network prerequisites for running DataHub.
Software requirements
| Component | Requirement |
|---|---|
| Container runtime | Docker Engine 24+ with Compose v2 |
| Operating system | Linux (recommended), macOS, or Windows with Docker Desktop |
| Browser | Modern evergreen browser (Chrome, Firefox, Safari, Edge) |
Default host ports
| Surface | Host port | Container port |
|---|---|---|
| Console (Next.js) | 4300 | 3000 |
| API (NestJS) | 4400 | 4000 |
Ports are chosen to avoid common conflicts on shared servers. Adjust in deploy/docker-compose.yml if needed.
Hardware recommendations
| Deployment | CPU | RAM | Storage |
|---|---|---|---|
| Demo / dev | 2 cores | 4 GB | 20 GB |
| Single-site production | 4+ cores | 8 GB | 100 GB+ (telemetry history grows over time) |
The stack runs nine containers: API, frontend, five backend workers, PostgreSQL, Redis, and NATS JetStream.
Network
- Runtime: No internet required except for optional notification channels (Slack, SMTP, Telegram)
- Inbound: Console and API ports (or nginx reverse proxy on 443)
- Field devices: Adapters connect outbound to NATS or are managed in-process by the orchestrator
Environment variables
Minimum for production (set in deploy/.env):
POSTGRES_PASSWORD=<strong>
JWT_SECRET=<long-random>
ADMIN_PASSWORD=<strong>
NEXT_PUBLIC_API_URL=https://your-domain.exampleDo not override ASSET_FILES_DIR unless you intentionally change asset storage — Compose sets the default volume mount.
Production deployment
For VPS deployment with nginx and TLS, see Production deployment.