Setup

This guide walks you through setting up umh-core with Docker Compose, starting from a minimal configuration you can extend with additional services.

What you'll need

• Docker installed on your system
• Basic familiarity with the command line

Minimal Setup

1. Find the latest version on the Releases page and replace ENTER_VERSION_HERE with your selected version.
2. Save this in docker-compose.yaml.

Hint: If your desired release is v0.44.31, the image tag is: umh-core:v0.44.31

services:
  umh:
    # TODO: set your desired container version here 
    # e.g. `umh-core:v0.44.31`
    image: management.umh.app/oci/united-manufacturing-hub/umh-core:ENTER_VERSION_HERE
    restart: unless-stopped
    volumes:
      - umh-data:/data
    environment:
      # TODO: Enter your instance's Auth Token.
      # You'll find it in your instance's
      # configuration file on management.umh.app.
      - AUTH_TOKEN=your_auth_token
      # TODO: Change the LOCATION_0 parameter
      # to your desired Level 0 Location name
      - LOCATION_0=your_level_0_location
      # Optional: Define more levels
      # - LOCATION_1=your_level_1
      # - LOCATION_2=your_level_2
      # - LOCATION_3=your_level_3
      # - LOCATION_4=your_level_4
      - RELEASE_CHANNEL=stable
      - API_URL=https://management.umh.app/api

volumes:
  umh-data: {}

This achieves the same result as the docker cli commands, but the configuration is now documented in a file that you can version control and extend.

Starting the Stack

Once the configuration is done you can start the stack:

docker compose up -d

We recommend that you familiarise yourself with the docker commands below. They'll come in handy while working with umh-core.

• docker compose ps: check the running state of all services
• docker compose stats: check resource usage of all services
• docker compose pull: re-pull the image tags currently listed in the docker-compose.yaml

Note: docker compose pull does not move you to a newer UMH release. The image tags here are pinned to a specific version, so the pull only refreshes that same version. To deploy a newer release, change the tag in docker-compose.yaml first. See Updating.

For more refer to the official Docker Compose documentation.

Add More Services

While umh-core can operate standalone, most deployments benefit from persistent storage and visualization capabilities.

• Recommended UMH Stack: umh-core, Grafana, PgBouncer, and TimescaleDB in one file
• TimescaleDB: time-series storage, with PgBouncer in front of it
• Grafana: create dashboards that run locally from your data
• nginx: reverse proxy and SSL termination