node-red-contrib-websockify

A Node-RED contribution package built on noVNC's websockify-js WebSocket-to-TCP proxy bridge.

Upstream, license, and AI assistance

This package is based on novnc/websockify-js, originally authored by Joel Martin and contributors. It retains the upstream LGPL-3.0 license and applicable copyright notices.

The Node-RED integration, group and standalone nodes, and this package documentation were developed with AI assistance from OpenAI Codex and are maintained by lathesky. AI tools are not listed as an author or maintainer.

Installation

After the package is published to npm, install it in your Node-RED user directory:

npm install node-red-contrib-websockify

Usage

Send all services that should be running to the websockify-group node in msg.payload. Each new message replaces the complete active set: the node stops every previous service before starting the new array.

Use websockify-standalone for a single proxy that must remain independent of group updates. It restarts its own service for every input, taking a single mapping object in msg.payload; without msg.payload, it uses the node editor settings.

[
  {
    "id": "vnc-1",
    "listen": "6080",
    "target": "127.0.0.1:5900"
  },
  {
    "id": "ssh",
    "listen": { "host": "127.0.0.1", "port": 6081 },
    "target": { "host": "10.0.0.10", "port": 22 }
  }
]