From 408620c1eafdabe9e36fd312931aabe8b2c1b2bb Mon Sep 17 00:00:00 2001 From: Steve-Mcl Date: Mon, 21 Oct 2024 14:59:36 +0100 Subject: [PATCH] update docs for group env vars closes #4663 --- docs/user/device-groups.md | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/docs/user/device-groups.md b/docs/user/device-groups.md index 5701bbfd3d..44e0484fc2 100644 --- a/docs/user/device-groups.md +++ b/docs/user/device-groups.md @@ -17,6 +17,11 @@ Furthermore: * Devices added to an active Device Group will automatically be updated to the active pipeline snapshot * Devices removed from an active Device Group will have their active pipeline snapshot cleared More details are provided below in [Adding a Device to a group](#adding-a-device-to-a-group-which-has-an-active-pipeline-snapshot) and [Removing a Device from a group](#removing-a-device-from-a-group-which-has-an-active-pipeline-snapshot) +* Device Groups can have Environment Variables set at the group level. These are merged with the Environment Variables set in each member device. The following rules apply: + * Values set in the Device take precedence over values set in the Device Group. + * Removing a device from the group will remove these variables from the device. + * The devices environment variables are never modified, they are only merged at runtime. + * Updating these environment variables will cause devices in the group to be restarted when a change is detected This greatly simplifies deployments of the same configuration to one or even hundreds of devices with a single click. @@ -24,6 +29,7 @@ The following requirements apply: - FlowFuse 1.15+ Enterprise Tier - FlowFuse Cloud teams on the Enterprise tier +- FlowFuse 2.10+ is require for Group Environment Variables ## Creating a Device Group