Node Red Unstorage

Node-RED is a programming tool for wiring together hardware devices, APIs and online services via a browser-based editor.

Unstorage is a universal key-value storage library. It supports multiple storage platform: filesystem, database, localStorage and more.

This package is a Node-RED storage plugin that enables the integration with unstorage. It implements a storageModule for storing flows, settings, sessions and library content. Plus a contextStorage for storing context data. Ultimately, the goal is to create a platform agnostic storage layer for Node RED.

Setup

Make sure to install the dependency:

1npm i @bg-dev/node-red-unstorage

Usage

Below, a Node-Red instance is embedded in a node.js application. Mongo DB is used for storage layer.

1// Supports ESM and CJS
2import storage from "@bg-dev/node-red-unstorage";
3
4import * as dotenv from "dotenv";
5import express from "express";
6import { createServer } from "http";
7import nodered from "node-red";
8import { dirname, resolve } from "path";
9import { fileURLToPath } from "url";
10import mongodbDriver from "unstorage/drivers/mongodb";
11
12dotenv.config();
13
14const { contextStore, storageModule } = storage({
15  // A namespace for the storage layer
16  // Allows creating multiple projects with isolated data access
17  app: process.env.APP_NAME || "default",
18
19  // Unstorage instance options, for storageModule (required)
20  storageOptions: {
21    driver: mongodbDriver({
22      connectionString: process.env.MONGO_DB_URL,
23      databaseName: "nodeRed",
24      collectionName: "storage",
25    }),
26  },
27
28  // Unstorage instance options, for contextStore (optional)
29  contextOptions: {
30    driver: mongodbDriver({
31      connectionString: process.env.MONGO_DB_URL,
32      databaseName: "nodeRed",
33      collectionName: "context",
34    }),
35  },
36});
37
38const cwd = dirname(fileURLToPath(import.meta.url));
39
40const settings = {
41  httpAdminRoot: "/",
42  httpNodeRoot: "/api",
43  // The userDir contains the external libraries
44  // Should be at the project root
45  userDir: cwd,
46  nodesDir: resolve(cwd, "nodes"),
47  uiHost: "0.0.0.0",
48  uiPort: parseInt(process.env.PORT) || 8080,
49  credentialSecret: process.env.CREDENTIAL_SECRET || "secret",
50
51  storageModule: storageModule,
52
53  contextStorage: {
54    unstorage: {
55      module: contextStore,
56    },
57  },
58};
59
60// Express is used as suggested in Node-Red docs
61const app = express();
62
63const server = createServer(app);
64
65app.use("/", express.static("public"));
66
67nodered.init(server, settings);
68
69app.use(settings.httpAdminRoot, nodered.httpAdmin);
70
71app.use(settings.httpNodeRoot, nodered.httpNode);
72
73server.listen(settings.uiPort);
74
75nodered.start();

Credits

• @hardillb - node-red-contrib-storage-mongodb

License

MIT License