Module Manager

Overview

The Module Manager allows you to extend EdgeFlow with additional functionality by installing third-party modules. It supports modules from multiple ecosystems including npm, Node-RED, n8n, and GitHub repositories.

Module Card Details

Each installed module displays the following information:

Module Status

Installing Modules

Click the + Install Module button to open the marketplace dialog. There are three ways to install modules:

1. Search Marketplace

Search across multiple registries to find and install modules:

• npm - Node Package Manager registry
• Node-RED - Node-RED flow library catalog
• GitHub - GitHub repositories

2. Upload File

Upload a module package directly from your computer. Supported formats:

• .zip - ZIP archive
• .tgz - npm package format
• .tar.gz - Gzipped tarball

3. URL / NPM / GitHub

Install directly by entering a URL, npm package name, or GitHub repository:

Supported Module Formats

EdgeFlow supports modules from multiple ecosystems:

EdgeFlow Native

• Manifest file: edgeflow.json
• JavaScript or TypeScript node implementations
• Optional platform-specific binaries
• Full access to EdgeFlow APIs

Node-RED Compatible

• Manifest: package.json with node-red configuration
• Package naming: node-red-contrib-* or node-red-node-*
• Automatic format conversion during installation

n8n Compatible

• Manifest: package.json with n8n configuration
• Package naming: n8n-nodes-*
• TypeScript node definitions supported

Module Actions

Right-click a module card or use the action menu to access these operations:

Module Validation

Before installation, modules undergo security and compatibility validation:

Security Checks

• Obfuscated code detection - Blocks hex/unicode escape sequences
• Dynamic code execution - Flags eval(), Function constructor
• Process manipulation - Detects process/global access attempts
• Size limits - Maximum 50MB total, 10MB per file

License Analysis

EdgeFlow analyzes module licenses for compatibility:

Validation Score

Each module receives a safety score from 0-100 based on the validation checks. Modules with critical errors cannot be installed. Warnings are displayed but don't prevent installation.

Resource Monitoring

The module manager displays system resources to help you manage module usage:

• Memory - RAM usage by loaded modules
• Disk - Storage space used by installed modules
• CPU - Processor usage (on supported platforms)

Module Storage

Installed modules are stored in the modules/ directory within your EdgeFlow installation. The module manifest is saved to modules/modules.json for persistence across restarts.

Manifest Contents

• Module metadata (name, version, description)
• Installation timestamp
• Enable/disable status
• Current status (installed, loaded, error)
• Loaded node types
• License attribution information

Updating Modules

To update a module to a newer version:

1. Install the new version using any installation method
2. EdgeFlow automatically creates a backup of the existing version
3. The new version replaces the old one
4. If installation fails, the backup is restored automatically

Troubleshooting

Module Won't Install

• Check the validation errors in the installation dialog
• Verify the module format is supported (EdgeFlow, Node-RED, or n8n)
• Ensure the archive is not corrupted
• Check if the module exceeds size limits (50MB)

Nodes Not Appearing

• Ensure the module is loaded (green status badge)
• Check if the module is enabled
• Try reloading the module
• Refresh the flow editor page

Module Errors

• Click the module card to view error details
• Check for missing dependencies
• Verify the module is compatible with your EdgeFlow version
• Review the module's documentation for requirements

API Reference

The Module Manager exposes a REST API for programmatic control: