UNS OpenHubDocumentation

Getting started

Install UNS OpenHub Runtime

Use the public Bootstrap to install a verified Runtime containing the controller and local data services. Complete first-time setup in the browser, then use the version-matched guide included with that release.

Before you begin

The Bootstrap is available for macOS, Linux, and Windows on Intel/AMD 64-bit and ARM64 hosts.

  • Container engineDocker or Podman with Compose support.
  • Runtime downloadThe default Runtime release is public and Bootstrap downloads it without a GitHub account or token.
  • Container imagesThe default controller and PostgreSQL images are public. A Docker Hub account is needed only if you choose a restricted registry or private image.

Install the Runtime

Choose your platform. Install the public Bootstrap, then let it download and verify the matching Runtime bundle.

Choose your platform
curl -fsSL \
  https://github.com/uns-openhub/uns-openhub-bootstrap/releases/latest/download/install.sh |
  sh
"$HOME/.local/bin/uns-bootstrap" install
Watch the first local installSee Bootstrap, Runtime startup, and the browser setup handoff.

After installation

Complete first-time setup in the browser

Complete the terminal configuration wizard, authenticate to the image registry if requested, and run its printed Runtime start command. On the same computer, open http://localhost:8180. A fresh Controller redirects to the setup wizard. When the Runtime runs on another host, use that host's configured address instead.

Runtime guideComplete first-time setup

For a local demo, keep the generated configuration, create your administrator account, and choose a starting profile.

Read guide →

Bring in your first measurements

A running Controller and a Schema profile do not generate measurements. Start a producer such as rtt-demo-app, add UNS Archiver for history in QuestDB, and UNS API Global for current and historical queries.

Video guide · 3 min 46 secSet up the demo services

Follow the hot-rolling simulator walkthrough using fictional equipment and measurements.

Watch walkthrough →
Load and trace demo materials →Compare signals and export →

Ongoing operations

Continue with the Runtime README

The installed Runtime includes the version-matched guide for configuration, operations, updates, administration, and troubleshooting. The installer uses the directory name uns-openhub-runtime.

macOS and Linux$HOME/uns-openhub-runtime/README.md
Windows$HOME\uns-openhub-runtime\README.md
Versions, upgrades, and recovery →All Runtime guides →