- docs
- Overview
- Administering FlowForge
- Contributing to FlowForge
- FlowForge API
- FlowForge Cloud
- Using FlowForge
- Changing the Stack
- devices
- Environment Variables
- FlowForge Concepts
- FlowForge File Nodes
- FlowForge Persistent Context
- FlowForge Project Nodes
- Instance Settings
- Logging
- Migrating a Node-RED project to FlowForge
- Node-RED Tools plugin
- Shared Team Library
- Snapshots
- Staged Deployments
- Teams
- Running FlowForge
- Installing FlowForge
- Configuring FlowForge
- DNS Setup
- Docker install
- Email configuration
- First Run Setup
- FlowForge File Storage
- Install FlowForge on Kubernetes
- Local Install
- Upgrading FlowForge
# 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 Snapshots in the sidebar.
- 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.
# Delete a snapshot
To delete a snapshot:
- Go to the instance's page and select Snapshots in the sidebar.
- 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 FlowForge and only push out to the devices when it is ready.
To set the Device Target:
- Go to the instance's page and select Snapshots in the sidebar.
- 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 they check 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 FlowForge managed Node-RED instances.
For more information, see the Node-RED Tools Plugin guide.