Docker Compose (Recommended)

Fastest way to run DataForeman with all dependencies.

git clone https://github.com/orionK-max/DataForeman.git
cd dataforeman
./fix-permissions.sh
npm start

Access: http://localhost:8080

Default login: admin@example.com / password


Windows Installer

  1. Download the installer (GitHub Releases)
  2. Run setup
  3. Launch DataForeman from Start Menu
  4. Open http://localhost:8080

Build from Source

For developers customizing the platform.

Requirements: Node 22+, Git, Docker.


What's Included

  • ✅ PostgreSQL + TimescaleDB
  • ✅ Core API service
  • ✅ Connectivity drivers
  • ✅ Real-time log & metrics
  • ✅ Optional reverse proxy (Caddy)

System Requirements

  • • Docker 20.10+ & Compose 2.0+
  • • 8 GB RAM recommended
  • • 20 GB disk space
  • • Linux, Windows 10+, or macOS

Additional Resources

Ready to modernize your industrial data collection? Download DataForeman today!