Registry / communication / node-red-contrib-aedes

node-red-contrib-aedes

library1.2.0jsnpmunverified

This Node-RED contribution provides an embedded MQTT broker directly within a Node-RED instance, eliminating the need for an external MQTT server like Mosquitto. Based on the actively maintained Aedes library (version 1.0 as of package version 1.x.x), it offers standard MQTT TCP and WebSocket support, including SSL/TLS, and various message persistence options (in-memory, MongoDB, file snapshotting). The current stable version is 1.2.0, with releases occurring as needed to track Aedes updates and Node-RED compatibility. It serves as a modern replacement for older Node-RED MQTT broker nodes that relied on the unmaintained Mosca library, distinguishing itself by its direct integration and modern backend.

communication web-framework database http-networking

github ↗package ↗

Install & Compatibility

Where this runs

tested against v? · npm install

Install × environment matrix

Each cell = how many times install + import succeeded across repeated harness runs. Partial = flaky.
glibc = Debian/Ubuntu slim · musl = Alpine Linux

musl

node 18–226 runs

build_error

glibc

node 18–226 runs

build_error

Code

Verified usage

Verified import paths — ran on the pinned version, not inferred.

This package is a Node-RED contribution; it makes new nodes available in the Node-RED editor's palette after installation. Users interact with the 'Aedes MQTT Broker' node graphically within the editor, rather than through direct JavaScript/TypeScript imports.

N/A

The primary method to make the Aedes broker node available in your Node-RED instance is via the Node-RED Palette Manager GUI or by executing this command in your Node-RED user directory.

npm install node-red-contrib-aedes

Once installed and added to a flow, the Aedes MQTT Broker node's settings (e.g., ports, SSL, and persistence) are entirely configured through its properties panel in the Node-RED graphical editor.

N/A

Installs the Aedes MQTT broker node into your Node-RED environment, making it available in the palette for graphical configuration and deployment within your Node-RED flows.

// Step 1: Install the Node-RED contribution package // This command should be run in your Node-RED user directory (e.g., ~/.node-red) // or via the Node-RED Palette Manager GUI. // Execute in your terminal: // npm install node-red-contrib-aedes // Step 2: Restart Node-RED // After successful installation, restart your Node-RED instance. // For example, by running 'node-red' in your terminal or restarting its service. // Step 3: Access and Configure in Node-RED Editor // - Open your Node-RED editor (typically at http://localhost:1880). // - Find the 'Aedes MQTT Broker' node in the MQTT category of the palette. // - Drag this node onto your flow canvas. // - Double-click the node to open its configuration panel. // - Configure desired settings, such as TCP port (e.g., 1883), WebSocket port (e.g., 8080), // SSL/TLS settings, and message persistence options. // - Deploy your flow to start the embedded MQTT broker. console.log("Aedes MQTT Broker node installed and ready for configuration in Node-RED editor."); // For testing, connect any MQTT client to the configured broker (e.g., mqtt://localhost:1883).

Debug

Known footguns

breakingVersions 1.0.0 and above of `node-red-contrib-aedes` are based on Aedes version 1.0, which introduced significant breaking changes compared to previous Aedes versions (0.x).

breakingVersions `>=1.0.0` (and `0.15.x`) of this package require Node.js version 20 or newer, and Node-RED version 3.0 or newer. Running on older environments will lead to runtime errors or installation failures.

gotchaThis package replaces older Node-RED MQTT broker nodes (e.g., `node-red-contrib-mqtt-broker`) that relied on the unmaintained Mosca library. While functionally similar, Aedes may have behavioral differences in specific MQTT protocol implementations or configuration options.

gotchaEnsuring proper port availability and firewall configuration is crucial for external clients to connect to the embedded Aedes broker, especially for TCP and WebSocket listeners. If deployed behind a reverse proxy, WebSocket paths need careful setup.

Upgrade

Version history

Breaking-change detection hasn't run for this library yet.

Audit

Security & dependencies

CVE tracking and dependency tree are planned for a later release.

Agent activity

48 hits · last 30 days

oai-searchbot

bytedance

ahrefsbot

amazonbot

chatgpt-user

script

bingbot

Resources

githubhttps://github.com/martin-doyle/node-red-contrib-aedes ↗

packagehttps://www.npmjs.com/package/node-red-contrib-aedes ↗