Runtime Export

A runtime agent is a headless Nodlyn package that runs your workflow on a target machine — factory PC, edge gateway, server, or even a folder on a USB stick — without Studio UI. You design and validate in Studio, then export an Active workflow as a self-contained ZIP.

When to use

On-prem protocols: Modbus, serial, GPIO, local filesystem, Matter, Zigbee.
Air-gapped or low-latency sites where cloud execution is not acceptable.
Same validated workflow deployed to many edge nodes.
ERP, MES, or custom apps triggering workflows via HTTP/MQTT/file ingress.

How to export

Move the workflow through the lifecycle until it is Active.
Open the canvas toolbar menu → Export Runtime (or right-click canvas → Export as Runtime).
Configure the export modal (see below) and download the ZIP.
Install on the target machine, or extract and run in Portable mode.
Monitor the agent in the Agents tab or on the agent’s built-in dashboard — see Runtime Monitoring.

Requires Operator, Supervisor, or Admin role. Sub-workflows referenced by SubWorkflow nodes must also be Active (embedded automatically in the package).

Export modal options

Setting	Description
Runtime name	Service display name and ZIP filename prefix.
Package contents	This workflow — one agent, one workflow. Multiple workflows — one agent, up to 10 Active workflows (bundle).
Target operating system	Windows, Linux, or macOS (Apple Silicon / Intel for Mac).
Deployment mode	Install as Service (Windows Service, systemd, launchd) or Portable (USB / folder — no install, no admin).
Runtime dashboard port	Local status UI and event ingress API (default `9090`).
Webhook listener port	Single-workflow export with a Webhook trigger only.
Agent monitoring	This on-prem studio or Nodlyn Cloud (remote) — where heartbeats appear. See Runtime Monitoring.
External events	HTTP / MQTT / file-watch routes for external consumers. See Event Ingress.

What is inside the ZIP

bin/ — self-contained Nodlyn.Runtime (includes .NET — no separate runtime install).
runtime-manifest.nodpkg or runtime-bundle-manifest.nodpkg — encrypted workflow graph, schedules, variables, ingress routes, agent token.
install/ — service installers (Setup.bat, install.sh, systemd/launchd units) when using Install as Service.
run.bat / run.sh — portable launchers when using Portable mode.
plugins/custom/ — custom component DLLs included in the export. See Custom Components.
README-quickstart.txt — install steps, agent token, dashboard port.

Security: The package contains decrypted workflow secrets. Treat the ZIP like a password — store and transfer it securely.

Portable mode (USB stick / folder)

Choose Deployment mode → Portable when you need zero installation:

Extract the ZIP to any folder — desktop, shared drive, or USB stick.
Windows: double-click run.bat. Linux/macOS: chmod +x run.sh && ./run.sh.
No admin rights, no Windows Service / systemd registration.
Ideal for demos, field laptops, and quick edge tests.

For 24/7 production hosts, prefer Install as Service so the agent restarts automatically after reboot.

Multi-workflow bundles

Select Package contents → Multiple workflows to ship up to 10 Active workflows in one agent:

Shared agent token and one runtime process.
Webhook paths use /webhook/{workflowId} instead of separate ports.
Global variables are deduplicated across workflows.
Ingress-only workflows in a bundle need explicit workflowId or type routing — see Event Ingress.

Install (service mode)

OS	Steps
Windows	Extract ZIP → run `install\Setup.bat` as administrator.
Linux	Extract → `sudo bash install/install.sh`
macOS	Extract → `sudo bash install/install.sh` (launchd daemon)

After install, the agent sends heartbeats to the monitoring target you chose at export. The Agents tab shows Waiting for agent to connect… until the first check-in.