Skip to content

Commit

Permalink
Merge pull request #4294 from FlowFuse/3818-docs
Browse files Browse the repository at this point in the history
update docs for snapshot edit
  • Loading branch information
knolleary committed Jul 31, 2024
2 parents d46a226 + 02d6655 commit 4830d72
Show file tree
Hide file tree
Showing 2 changed files with 18 additions and 0 deletions.
4 changes: 4 additions & 0 deletions docs/user/envvar.md
Original file line number Diff line number Diff line change
Expand Up @@ -62,3 +62,7 @@ In addition, the following variables are set when running on a device:

When deploying the same set of flows out to multiple devices, these variables can
be used by the flows to identify the specific device being run on.

NOTE: `FF_SNAPSHOT_NAME` will not be immediately updated when the current snapshot is edited.
It will only be updated when the snapshot is changed or a setting that causes the device to
be restarted is changed.
14 changes: 14 additions & 0 deletions docs/user/snapshots.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,20 @@ To create a snapshot:

The list of snapshots will update with the newly created entry at the top.

## Edit a snapshot

To edit a snapshot:

1. Go to the instance's page and select the **Snapshots** tab.
2. Open the dropdown menu to the right of the snapshot you want to edit and
select the **Edit Snapshot** option.
3. Update the name and description as required.
4. 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.
Expand Down

0 comments on commit 4830d72

Please sign in to comment.