Install from npm

Omni-Edge is an npm package that runs on Node.js. This is the install to use on a machine with no container runtime — an engineering workstation, or an industrial gateway.

Prerequisites

• Node.js 22 or newer. Install the LTS build from nodejs.org, or:

  # Debian / Ubuntu
  curl -fsSL https://deb.nodesource.com/setup_22.x | sudo -E bash -
  sudo apt-get install -y nodejs

  # Windows
  winget install OpenJS.NodeJS.LTS

• A Sterfive npm account. Ask your Sterfive administrator, or email contact@sterfive.com with your name and company.

Install

Point the @sterfive scope at the Sterfive registry and log in. You only do this once per machine:

npm config set @sterfive:registry=https://npm-registry.sterfive.fr
npm login --registry=https://npm-registry.sterfive.fr

Then install into a folder of its own:

mkdir omni-edge
cd omni-edge
npm init -y
npm install @sterfive/opcua-omni-edge

tip

Install into a folder rather than globally (-g). Everything the gateway needs then lives under one directory — the package, your configuration, the certificate store, and the licence state. That is what makes backups and air-gapped transfers a matter of copying one folder.

Run it

# Linux / macOS
node_modules/.bin/opcua-omni-edge run -c config.yaml

# Windows
node_modules\.bin\opcua-omni-edge.cmd run -c config.yaml

Ctrl+C stops the server. Stopping it this way matters: the gateway releases its licence seat on the way out.

Options

Option	Meaning
-c, --config	the configuration YAML file
-d, --database	folder holding IODD definition XML files
-w, --watch	watch the config file and restart on changes
--poll	with --watch, detect changes by polling instead of filesystem events
--managed	run under a controller process (the editor's Run button)

Watch mode is convenient while you are building a configuration:

node_modules/.bin/opcua-omni-edge run -c config.yaml --watch

Other useful commands: opcua-omni-edge version prints the version, git sha, and build date; opcua-omni-edge licence info reports the licence state; opcua-omni-edge migrate-config converts a v3 configuration file to the v4 format.

What lives where

Path	What it holds
config.yaml	your gateway configuration
node_modules/	the package and its dependencies
$HOME/.sterfive/opcua-omni-edge/	licence activation and this machine's stable identity

That last one matters. It is how the gateway recognises itself across restarts; losing it consumes a new licence seat. Back it up along with your configuration.

Update

cd omni-edge
npm install @sterfive/opcua-omni-edge@latest

Keep it running

The command above runs in the foreground. To start the gateway on boot and restart it if it fails, install it as a service — see Run it as a service.

Licensing

The gateway starts without a licence key and runs in demo mode, stopping after one hour. This is deliberate: connect a device, point an OPC UA client at it, and confirm it does what you need before licensing.

To license an installation that has internet access, either set the key in the environment before starting the gateway:

export OPCUA_OMNI_EDGE_LICENSE_KEY=ABCDEF-01234-...-ABCDEF
node_modules/.bin/opcua-omni-edge run -c config.yaml

or activate it once with the CLI, which stores the activation under $HOME/.sterfive/opcua-omni-edge/:

node_modules/.bin/opcua-omni-edge licence activate

Either way, confirm the result:

node_modules/.bin/opcua-omni-edge licence info

opcua-omni-edge licence deactivate returns the seat when you are decommissioning the machine.

On a machine with no internet access, see Offline and air-gapped installs.

info

Purchasing a licence — contact contact@sterfive.com or visit the Sterfive website. You will receive a licence key and instructions for your deployment model.