Choose the installation method that works best for your environment.

Docker Compose (Recommended)

Fastest way to run DataForeman on Linux with all dependencies included.

Requirements:

  • Docker 20.10+ and Docker Compose 2.0+
  • 8GB RAM recommended
  • Internet connection (only for initial setup)
mkdir dataforeman && cd dataforeman
curl -o docker-compose.yml https://raw.githubusercontent.com/orionK-max/DataForeman/main/docker-compose.yml
curl -o .env           https://raw.githubusercontent.com/orionK-max/DataForeman/main/.env.example
curl -o start.sh       https://raw.githubusercontent.com/orionK-max/DataForeman/main/start.sh
chmod +x start.sh && sudo bash start.sh

Access: http://localhost:8080

Default login: ADMIN_EMAIL (default: admin@example.com) / password from ADMIN_PASSWORD (default: password)

Windows Installer

Easy one-click installer with automatic updates.

Requirements:

  • Windows 10/11 (64-bit), 8GB RAM
  • Install Docker Desktop (free from docker.com)
  • Internet connection (only for initial setup)

Installation Steps:

  1. Install Docker Desktop if not already installed
  2. Download the installer from GitHub Releases
  3. Run DataForeman-Setup-X.X.X.exe (requires Administrator)
  4. If Windows shows "Windows protected your PC", click More info → Run anyway (this is normal for open-source software without paid code signing)
  5. Start from desktop shortcut or Start Menu
  6. Open http://localhost:8080

Note: If Docker Desktop prompts to update WSL, open PowerShell as Administrator and run: wsl --update

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!