For the complete documentation index, see llms.txt. This page is also available as Markdown.

Getting Started

60 seconds — that's all it takes to launch UMH Core.

No kubectl, no Kubernetes setup, just a single Docker container. Almost anything that runs Docker works — from your MacBook to enterprise edge boxes.

Note: This getting-started guide follows the common PLC/sensor path (raw → device models). For ERP integration and other patterns, see the Data Modeling documentation.

System requirements

Minimum:

  • 2 vCPU

  • 4 GB RAM

  • 40 GB SSD

Architecture:

  • x86_64 (Intel/AMD 64-bit)

  • ARM64 (64-bit ARM, but NOT Raspberry Pi - Redpanda requires 48-bit virtual address space)

CPU health reporting (early access):

UMH Core runs on any of the above. Its CPU pressure signal also needs Linux pressure stats (PSI) and cgroup v2, which the Red Hat family ships off. Without them CPU health still reports from throttling, steal and headroom, and an instance with no CPU limit reports limited visibility. CPU Health covers how to check, how to switch them on, and which flag enables this reporting.

For detailed sizing recommendations, see the Sizing Guide.

Installation using the Management Console

  1. Click "Add a new instance"

Instance setup screen
  1. Configure your instance:

    • Name (1): Give it a cool name (e.g., my-first-umh)

    • Type (2): Select "Core" from the dropdown

    • Location (3): Enter your location path:

      • Level 0: your-company (required - your enterprise name)

      • Level 1: Your level 1 name (optional - e.g., site or plant)

      • Level 2-4: Leave empty for now (optional)

    • Click "Add Instance" (4)

  2. Copy the Docker command that appears

  3. Run it on any machine with Docker installed

🎉 Success!

Your instance will appear as "Online" in the Management Console within seconds.


Troubleshooting

Volume permission errors Named volumes automatically handle permissions for the container user (UID 1000). If you still see permission errors like s6-svscan: warning: unable to stat benthos-dataflow-*, try removing the container and recreating the volume:

Then re-run the docker run command.

For advanced users needing bind mounts (custom data locations), see the Container Layout reference.

Corporate firewall/proxy issues If your corporate network intercepts TLS traffic, see Network Configuration to add your CA certificate.

For proxy configuration, see Network Configuration or add these arguments to your docker run:


Coming from UMH Classic?

See the Migration Guide for step-by-step migration instructions, including data contract changes and configuration updates.


Concepts Learned

  • UMH Core - Single-container Industrial IoT platform

  • Management Console - Cloud UI for managing instances

  • Instance - A running UMH Core deployment

  • Location hierarchy - Organizational structure (enterprise → site → area → line)

  • Docker container - How UMH Core runs

Ready to Connect Data?

You've successfully installed UMH Core! 🚀

Last updated