Skip to content

Commit c7ca70a

Browse files
docs: add descriptions to standard environment variables
1 parent 75a6fd8 commit c7ca70a

1 file changed

Lines changed: 8 additions & 8 deletions

File tree

docs/user/envvar.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -49,17 +49,17 @@ The image below shows an instance with the following environment variables:
4949
Standard environment variables are set for all Node-RED instances running
5050
within the platform:
5151

52-
- `FF_INSTANCE_ID`
53-
- `FF_INSTANCE_NAME`
54-
- `FF_INSTANCE_URL`
52+
- `FF_INSTANCE_ID` - The unique identifier of the instance
53+
- `FF_INSTANCE_NAME` - The name of the instance as set in FlowFuse
54+
- `FF_INSTANCE_URL` - The full URL of the instance (e.g. `https://my-instance.flowfuse.cloud`)
5555

5656
In addition, the following variables are set when running on a device:
5757

58-
- `FF_DEVICE_ID`
59-
- `FF_DEVICE_NAME`
60-
- `FF_DEVICE_TYPE`
61-
- `FF_SNAPSHOT_ID`
62-
- `FF_SNAPSHOT_NAME`
58+
- `FF_DEVICE_ID` - The unique identifier of the device
59+
- `FF_DEVICE_NAME` - The name of the device as set in FlowFuse
60+
- `FF_DEVICE_TYPE` - The device type label assigned in FlowFuse
61+
- `FF_SNAPSHOT_ID` - The unique identifier of the snapshot currently deployed to the device
62+
- `FF_SNAPSHOT_NAME` - The name of the snapshot currently deployed to the device
6363

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

0 commit comments

Comments
 (0)