Skip to main content

Install with Docker Compose

This is the supported production deployment: a released bundle of container images — the edge gateway, the configuration editor, Node-RED, and Redis — wired together by a docker-compose.yml that Sterfive publishes and supports. Nothing is built on your machine.

Prerequisites

  • A Linux server (or Windows with WSL2) with Docker Engine 24+ and the Docker Compose plugin
  • Node.js 20.12+ on the host, for the npm run … driver scripts. Optional — every command has a plain docker compose equivalent
  • A registry deploy token from Sterfive (support@sterfive.com)

If you need to install Docker Engine, the convenience script covers the common distributions:

curl -fsSL https://get.docker.com | sudo sh
sudo systemctl enable --now docker
sudo usermod -aG docker "$USER" # then log out and back in

Check what you have with docker compose version — note the space. Compose v1 (docker-compose, hyphenated) does not support this bundle.

Install

curl -fsSL https://deploy.sterfive.com/install/opcua-omni-edge.sh | bash
cd opcua-omni-edge
npm run up

On Windows:

powershell -c "irm https://deploy.sterfive.com/install/opcua-omni-edge.ps1 | iex"
cd opcua-omni-edge
npm run up

The installer reads the release manifest, downloads the bundle, verifies its SHA-256, and extracts it. INSTALL_DIR chooses where; VERSION pins a specific release.

npm run up does the rest on a first run: it creates .env and .env.secrets from the templates, creates the data folders, and logs in to the Sterfive registry — prompting once for your deploy token, or reading STERFIVE_REGISTRY_USER / STERFIVE_REGISTRY_TOKEN for an unattended install.

Then watch it come up:

npm run ps

The edge server loads every declared OPC UA nodeset before it opens its port, so the first start takes a minute. Wait for healthy.

tip

No licence key is needed to start. Without one the gateway runs in demo mode and stops after an hour — long enough to connect a device and see the data. npm run doctor will tell you if anything else is wrong.

What you get

ServiceWhere
OPC UA endpointsopc.tcp://<host>:4840:4843
Configuration editorhttp://localhost:3030
Node-REDhttp://localhost:1880
warning

The editor and Node-RED have no built-in authentication, and the editor can rewrite the gateway configuration. They are published on 127.0.0.1 only. Reach them over an SSH tunnel, or put an authenticating reverse proxy in front — never expose them to the plant network directly. The bundle's own README.md explains both.

Day-to-day

CommandWhat it does
npm run logsfollow the logs
npm run psservices and their health
npm run downgraceful stop — releases the licence seat
npm run updateupgrade to the latest published release
npm run backuparchive config, PKI, flows and licence state
npm run doctordiagnose engine / config / registry problems

The bundle ships its own README.md with the full reference: upgrades, what a backup contains and why the licence volume matters, the reverse-proxy guidance, and the plain docker compose equivalent of every command above.