Edge Runtime installation

Use the runtime package and cloud endpoints supplied for your deployment. The following source-install commands require Node.js 24 and pnpm. Production commissioning requires an administrator with connector-management and service-identity authority, the correct workspace, assigned work centers, and approved network paths.

Register and approve

1. Open Edge Connectors in the assigned workspace, directly or through Studio.
2. Generate a registration token with the intended name and permitted preassigned work centers. The token is valid for 24 hours.
3. Place the supplied package on the host in a directory writable by the service account.
4. Copy its .env.example to a private .env and enter the supplied configuration.

CLOUD_API_URL=https://your-ennea-api.example
CLOUD_WS_URL=wss://your-ennea-api.example
REGISTRATION_TOKEN=<enter-locally>
EDGE_STATE_DIR=/var/lib/ennea-edge
LOG_LEVEL=info
NODE_ENV=production

Set both cloud URLs explicitly. The current loader has independent defaults; a custom WebSocket URL is not automatically derived from the API URL.

From the source checkout:

pnpm install
pnpm --filter @ennea/edge-runtime build
pnpm --filter @ennea/edge-runtime start

For a supplied standalone package, follow its package-specific installation commands. Do not assume an executable built for an older runtime matches the source installation.

First startup registers the host and saves its generated identity/API key. Registration creates a pending connector. Startup can exit at authentication until an administrator approves it and provisions eligible scoped service access. Approve the correct connector, inspect its assignments, then restart. Remove the initial registration token from the local environment once registration has succeeded.

Storage and service configuration

Keep .env, edge-config.json, data/, and logs/ private and persistent. They contain credentials and manufacturing data. The identity is stored under EDGE_STATE_DIR (default ~/.ennea/edge), with private data/ and logs/ subdirectories. Migrate existing state together before changing paths; see Security.

Run under a dedicated service account with a fixed working directory, the installed Node 24 path, restart policy, and orderly SIGTERM shutdown. A Node 24 runtime archive starts through start.sh or start.cmd; a source build starts with node dist/index.js. Preserve state across service upgrades and follow your deployment's backup procedure.

Configuration reference

Setting	Meaning
CLOUD_API_URL, CLOUD_WS_URL	Deployment API and WebSocket origins.
REGISTRATION_TOKEN	Initial registration only.
EDGE_API_KEY, EDGE_CONNECTOR_ID, EDGE_HARDWARE_ID	Explicit identity/credential overrides; use only an administrator-provisioned identity.
EDGE_STATE_DIR	Dedicated private identity/cache/log directory; migrate old state together.
DATA_DIR, LOG_DIR	Optional explicit cache/log locations, secured before opening.
PLC_REST_ENABLED, OPCUA_SERVER_ENABLED	Disabled by default; provisioning required before enabling.
EDGE_LOCAL_PRINCIPALS_FILE	Private machine IDs, tokens, work-center/action scopes.
LOG_LEVEL	Logging level.
PLC_SERVER_PORT	Local REST port; default 3005.

The local OPC UA server defaults to port 4841 and accepts OPCUA_SERVER_PORT. Configure TLS keys/certificates, bind hosts and OPC UA trust as documented under Security. Defaults include a 5-second sync interval and a 30-second buffer retry interval; persisted configuration can change these supported values. The current heartbeat runs every 30 seconds.

Validate before commissioning

Check approval and service authority, assigned work centers, current cloud sync, a read-only PLC connection, and local interface reachability. Then test reporting against an authorized order and verify the cloud result. Check printing separately if required. See Security before exposing local ports and Troubleshooting for failures.