- docs
- FlowFuse User Manuals
- Using FlowFuse
- Getting Started
- FlowFuse Concepts
- Changing the Stack
- DevOps Pipelines
- Environment Variables
- FlowFuse File Nodes
- FlowFuse Persistent Context
- FlowFuse Project Nodes
- High Availability mode
- Instance Settings
- Logging
- Shared Team Library
- Snapshots
- Teams
- FlowFuse API
- Migrating a Node-RED project to FlowFuse
- Device Agent
- Device Agent
- Hardware Guides
- FlowFuse Cloud
- FlowFuse Cloud
- FlowFuse Self-Hosted
- Installing FlowFuse
- Overview
- Configuring FlowFuse
- DNS Setup
- Docker install
- Email configuration
- First Run Setup
- FlowFuse File Storage
- Install FlowFuse on Kubernetes
- Local Install
- Upgrading FlowFuse
- Administering FlowFuse
- Administering FlowFuse
- Administrator configuration for SSO
- licensing
- Monitoring
- Telemetry
- User Management
- Support
- Community Support
- Premium Support
- Debugging Node-RED issues
- Contributing
- Contributing to FlowFuse
# Getting Started with FlowFuse
This guide will help you learn how to use the FlowFuse platform to quickly create new Node-RED applications after a successful installation or sign-up for FlowFuse Cloud.
# Creating a Node-RED Instance
-
Automatic Creation: Your first Node-RED instance should be automatically created upon your initial login to FlowFuse. To access the Node-RED Editor, simply click on
Open Editor
. -
Additional Instance: For utilizing various other FlowFuse features (e.g., DevOps Pipelines), it's highly beneficial to create a second Node-RED instance. A second Node-RED instance is included in both our Starter Tier and the Trial Phase of FlowFuse Cloud. To do so, select your application— in our example, "Demo's Application"— and click
Add Instance
.
# Creating Your First Flow
If you are already familiar with Node-RED, you can skip this section.
-
Access the Node-RED Editor.
-
Add Nodes: Drag an "http in" node into the editor. This node will listen for incoming HTTP requests. Next, drag in the "change" and the "http response" nodes.
-
Connect Nodes: Connect the "http in" node to the "change" node, and then the "change" node to the "http response" node. Your flow should look like this:
-
Configure 'http in' Node: Double-click on the "http in" node to open its properties. Set the URL to "/hello" and the method to "GET".
-
Configure 'change' Node: Double-click the "change" node. Add "Hello World" to the field that says "to the value".
-
Configure 'http response' Node: Double-click to open its properties. Set the "Status Code" to be 200.
-
Deploy: Now that we have our flow set up, we can deploy it by clicking the "Deploy" button in the top right corner of the editor. Once the flow is deployed, you can test it by opening up a web browser, take the URL of your Instance and add "/hello" to the end, it should looks something like this
https://your-project.flowforge.cloud/hello
. You should see "Hello World!" displayed in the browser.
Learn more about Flow creation
# Creating Your First DevOps Pipeline
DevOps Pipelines enable you to link multiple Node-RED instances together in a deployment pipeline.
-
Add a Pipeline: Select your application and click
Add Pipeline
. -
Name Your Pipeline: Enter a suitable name.
-
Add Stages: You can now add stages to your pipeline. In our example, we add a Development Stage and a Production Stage.
-
Execute the Pipeline: It is now easy to execute the pipeline with one click, promoting your recently created flow to your Production Node-RED instance.
Learn more about DevOps Pipelines
# Working with Devices
FlowFuse supports managing Node-RED on your own hardware.
# Working with Teams
- Team management - How to add and remove users from a team.
- Role based access control - Which privileges are granted to different roles.
# Working with Files and Context
FlowFuse supports reading and writing persistent files and persistent context.
# Working with Instances
- Snapshots - Create point-in-time backups of your Node-RED instances.
- Environment Variables - How to manage Environment Variables in your Node-RED instances.
- Change Project Stack - How to change an instance stack, for example to upgrade Node-RED.
- Logs - The Logs available in the FlowFuse application.
- Project Link Nodes - Custom nodes for sending messages between Node-RED instances and devices.
- Instance Settings - Settings available for Node-RED instances.
- Shared Team Library - Share flows easily between different Node-RED instances in your team.
- Node-RED Tools Plugin - A plugin for Node-RED that lets you work with your flows outside of FlowFuse.
- High Availability mode - Run multiple copies of your instance for scaling and availability.