- docs
- FlowFuse User Manuals
- Using FlowFuse
- Getting Started
- Static asset service
- Bill of Materials
- FlowFuse Concepts
- Changing the Stack
- Custom Hostnames
- Device Groups
- DevOps Pipelines
- Environment Variables
- FlowFuse Assistant
- FlowFuse File Nodes
- FlowFuse Persistent Context
- FlowFuse Project Nodes
- High Availability mode
- HTTP Access Tokens
- Instance Settings
- Logging
- Shared Team Library
- Snapshots
- Teams
- User Settings
- FlowFuse API
- Migrating a Node-RED project to FlowFuse
- Device Agent
- Device Agent
- FlowFuse Device Agent Introduction
- Quick Start
- Installation
- Quick Start with Web UI
- Register your Device
- Running the Agent
- Deploying your Flows
- Hardware Guides
- FlowFuse Cloud
- FlowFuse Cloud
- FlowFuse Self-Hosted
- Quick Start
- Installing FlowFuse
- Overview
- Configuring FlowFuse
- DNS Setup
- Docker install
- Docker from AWS Market Place
- Docker on Digital Ocean
- Add Project Stacks on Docker
- Docker Engine on Windows
- Email configuration
- First Run Setup
- FlowFuse File Storage
- Install FlowFuse on Kubernetes
- Upgrading FlowFuse
- Administering FlowFuse
- Administering FlowFuse
- Configuring Single Sign-On (SSO)
- Licensing
- Monitoring
- Telemetry
- User Management
- Support
- Community Support
- Premium Support
- Debugging Node-RED issues
- Contributing
- Contributing to FlowFuse
- Introduction
- Adding Template Settings
- API Design
- Creating debug stack containers
- Database migrations
- FlowFuse Architecture
- Local Install
- State Flows
- Device Editor
- Invite External Users
- User Login Flows
- Reset Password Flow
- Project Creation
- Instance states
- User Sign up Flow
- Team creation Flow
- Working with Feature Flags
# Snapshots
A Snapshot is a point-in-time backup of a Node-RED instance. It captures:
- The flows
- Credentials
- Environment variables
- NPM packages, with locked versions
- Runtime settings.
They can also be pushed to devices connected to the instance.
# Create a snapshot
To create a snapshot:
- Go to the instance's page and select the Snapshots tab.
- Click the Create Snapshot button.
- You will be prompted to give the snapshot a name and optional description.
- Click Create
The list of snapshots will update with the newly created entry at the top.
# Edit a snapshot
To edit a snapshot:
- Go to the instance's page and select the Snapshots tab.
- Open the dropdown menu to the right of the snapshot you want to edit and select the Edit Snapshot option.
- Update the name and description as required.
- Click Update
NOTE: Changes made to a snapshot will not be immediately reflected on devices that are already running this snapshot.
# Download a snapshot
A snapshot can be downloaded to your local machine for backup or sharing.
To download a snapshot:
- Go to the desired application, instance or device overview page and select the Snapshots tab.
- Open the dropdown menu to the right of the snapshot you want to download and click the Download Snapshot option to open the download dialog.
- Select the required components to download.
- Flows: Include the snapshot flows
- Credentials: Include the snapshot flows credentials
- Environment Variables: Include environment variables in the snapshot
- Keys and Values: Include the keys and values of the environment variables
- Keys Only: Include only the keys of the environment variables
- Enter a secret to encrypt any credentials in the snapshot (optional, depends on components selected).
- Click Download
# Upload a snapshot
A snapshot can be uploaded to a Node-RED instance in FlowFuse.
To upload a snapshot:
- Go to the desired instance or device overview page and select the Snapshots tab.
- Click the Upload Snapshot button.
- Select the snapshot file from your local machine.
- Update the name and description if required.
- Select the components to upload:
- Flows: Include the snapshots flows
- Credentials: Include the snapshots flows credentials (visible only if the snapshot contains credentials)
- Environment Variables: Include environment variables in the snapshot
- Keys and Values: Include the keys and values of the environment variables
- Keys Only: Include only the keys of the environment variables
- If the snapshot contains credentials and the
Credentials
component is checked, you will be asked to enter a Secret. This will be used to later decrypt any credentials in the snapshots flows. - Click Upload
# Delete a snapshot
To delete a snapshot:
- Go to the instance's page and select the Snapshots tab.
- Open the dropdown menu to the right of the snapshot you want to delete and select the Delete snapshot option.
- You will be asked to confirm - click Delete to continue.
Note: If the snapshot is the current Device Target snapshot, this will cause any connected devices to stop running the snapshot when they next check in.
# Setting a Device Target snapshot
Snapshots are used to identify a version of the Node-RED instance that should be pushed out to any connected devices. This allows you to develop you flows in FlowFuse and only push out to the devices when it is ready.
# Instance owned devices
To set the Device Target of an instance owned device:
- Go to the instance's page and select the Snapshots tab.
- Open the dropdown menu to the right of the snapshot you want to set as the device target and select the Set as Device Target option.
- You will be asked to confirm - click Set Target to continue.
This will cause the snapshot to be pushed out to any connected devices the next time it checks in.
# Application owned devices
To set the Device Target of an application owned device:
- Go to the devices's page and select the Snapshots tab.
- In the list of snapshots available, a "Restore Snapshot" button will be displayed for each snapshot as you hover over it.
- You will be asked to confirm - click the Confirm button to set it as the target snapshot.
This will cause the snapshot to be pushed out to the device the next time it checks in.
# Creating a Snapshot from a device
It is possible to create a Snapshot from a device that is connected to the platform. The device must be set to Developer Mode for this to work. See Working with Devices for more information.
# Creating a Snapshot locally
Using the Node-RED Tools Plugin it is also possible to create Snapshots in a local copy of Node-RED and push them back into your FlowFuse managed Node-RED instances.
For more information, see the Node-RED Tools Plugin guide.
# Auto Snapshots
FlowFuse can automatically create snapshots whenever flows are deployed to the instance. This is useful for tracking changes, and rolling back.
FlowFuse will label these snapshots as "Auto snapshot - yyyy-mm-dd hh:mm:ss". A limit of 10 auto snapshots will be kept, with the oldest being deleted when a new one is created.
Devices can optionally disable auto snapshots, in the developer mode tab. This can be helpful to avoid excessive data usage when a device is in the field or on a cellular connection.
NOTE: This feature is only available to Team and Enterprise tier teams
# Previewing Snapshots
From any Snapshots tab, you can preview the flows of a snapshot by selecting the Snapshot's actions, and selecting "View Snapshot".
Screenshot to show the available "Actions" for a given Snapshot
Screenshot to an example flow preview for a Snapshot in FlowFuse