Skip to content

Latest commit

 

History

History
 
 

README.md

navTitle meta
Documentation
description tags
Explore comprehensive documentation for FlowFuse, covering user manuals, API references, Node-RED migration guides, device management, FlowFuse Cloud setup, self-hosted installations, support resources, and contributing to FlowFuse development.
flowfuse
nodered
documentation
api
migration
device management
cloud
self-hosted
support
contributing
<script> class IconChevronRight extends HTMLElement { constructor() { super(); this.attachShadow({ 'mode': 'open' }) } connectedCallback () { this.shadowRoot.innerHTML = `` } } customElements.define('icon-chevron-right', IconChevronRight); </script>

FlowFuse Documentation

Welcome to the documentation for FlowFuse, an open-source, industrial data platform that enables engineers to build, manage, scale, and secure their Node-RED solutions.

It covers everything from setup, to usage, and development. All contributions are welcome.

Getting Started

FlowFuse Cloud

Hosted solution, nothing to install anything, jump straight in.

Using FlowFuse

Getting Started

Here are some quick reference links to our most popular topics. You can also view the full documentation available for FlowFuse in our Getting Started guide.

Configuring Instances Understand the options available for your Node-RED Instances
Snapshots Version Control for your Node-RED Instances.
Team Library Centralized management of re-usable flows and functions.
Pipelines Deploy flows between Test, Staging & Production Environments.
Remote Instances Deploy flows remotely with FlowFuse "Devices".
  </div>
  <div>
     <label>Device Groups</label>
     <span>Manage large numbers of devices together.</span>
  </div>

Advanced Features

Once you're more comfortable with FlowFuse, you may want to explore some of our more advanced features that will help elevate your Node-RED experience even further.

Managing Teams Host your Instances at a custom subdomain
  </div>
  <div>
     <label>Custom Domains</label>
     <span>Host your Instances at a custom subdomain</span>
  </div>
High Availability Automatically distribute workload across multiple copies of your Node-RED Instance.

FlowFuse Extras

FlowFuse Dashboard

Create interactive, responsive and secure Dashboards in Node-RED.

FlowFuse Device Agent

Manage thousands of Node-RED Instances remotely with the FlowFuse Device Agent.

FlowFuse Assistant

AI in the Node-RED Editor to help build your flows.

FlowFuse Project Nodes

Seamlessly pass data between your Node-RED Instances.

Support

Contributing to FlowFuse

  • Useful Information - Learn the foundational concepts of how FlowFuse is built & structured.
  • Development Setup - Configure your local development environment to contribute to FlowFuse.
  • Testing - Understand our testing philosophy at FlowFuse.
<style> .st0 { fill: currentColor; stroke-width: 1.5; stroke-linecap: round; stroke-linejoin: round; } </style> <style> a label { cursor: pointer; } .ff-tile, .ff-offering-tile ul li a { gap: 6px; border: 1px solid #e2e8f0; border-radius: 0.5rem; } .ff-tile span { display: block; color: #374151; font-size: 0.875rem; font-weight: 300; line-height: 1.25rem; } .ff-offering-tiles { display: grid; gap: 1rem; } .ff-offering-tile { padding: 1rem; } .ff-offering-tile .ff-offering-cta { /* margin-bottom: 1.5rem; */ } .ff-offering-tile label { font-size: 1.25rem; font-weight: 500; color: #4b5563; display: flex; align-items: center; gap: 6px; } .ff-offering-tile label img { width: 32px; } .ff-offering-tile ul { list-style: none; padding: 0; margin-bottom: 0; } .ff-offering-tile ul li { padding-left: 0; } .ff-offering-tile ul li:last-child { margin-bottom: 0; } .ff-offering-tile ul li a { display: flex; padding: 6px 9px; text-decoration: none; align-items: center; justify-content: space-between; } .ff-offering-tile ul li a:hover, .ff-product-feature-tile:hover { cursor: pointer; border: 1px solid #4F46E5; text-decoration: none; } .ff-offering-tile ul li .ff-icon { padding-right: 0; } .ff-product-feature-tiles { display: grid; gap: 1rem; } .ff-product-feature-tile { display: flex; padding: 6px; text-decoration: none; } .ff-product-feature-tile label, .ff-product-feature-tile .ff-product-feature-tile-decorator { color: #2463eb; } .ff-product-feature-tile .ff-icon { width: 32px; height: 32px; stroke-width: 1.5px; } .ff-product-feature-tile-decorator { background-color: #EEF2FF; padding: 3px; width: 42px; display: flex; justify-content: center; align-items: center; flex-shrink: 0; } </style>