Getting Started

There are two ways to run Omni-Edge. Pick the one that matches where it will live — the rest of the documentation applies to both.

The container stack, on a plant server

The supported production deployment. One command downloads a released, supported bundle and starts the gateway, the configuration editor, and Node-RED together:

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

Choose this if the gateway runs on a Linux server, if you want the editor and Node-RED alongside it, or if you would rather upgrade by pulling a new image than by reinstalling a package.

→ Install with Docker Compose

A native install, on a workstation or industrial gateway

Omni-Edge is also an npm package that runs directly on Node.js — no container runtime involved. It is a single process and a configuration file.

npm install @sterfive/opcua-omni-edge --registry=https://npm-registry.sterfive.fr
node_modules/.bin/opcua-omni-edge run -c config.yaml

Choose this if the machine has no container runtime, if you are running on a small industrial gateway, or if the site is air-gapped.

→ Install from npm → Run it as a service → Offline and air-gapped installs

You do not need a licence key to start

Either way, the gateway starts without a licence: it runs in demo mode and stops after an hour. That is enough to connect it to a device and see the data appear in an OPC UA client before you licence it.

See Licensing when you are ready.

Then what?

Once the server is running, the work is in the configuration file — which devices to connect to, and how their data should appear in the OPC UA address space. See Configuration, or use the web editor, which writes that file for you.