From dc6fbd9dd58e7db15e3ca900c66aa2374e0f2d06 Mon Sep 17 00:00:00 2001 From: Nick O'Leary Date: Fri, 8 Nov 2024 10:26:56 +0000 Subject: [PATCH 1/2] Update Device Agent docs for 3.x release --- docs/device-agent/install.md | 10 ++++++++-- 1 file changed, 8 insertions(+), 2 deletions(-) diff --git a/docs/device-agent/install.md b/docs/device-agent/install.md index c72aa92222..bf911b9ee9 100644 --- a/docs/device-agent/install.md +++ b/docs/device-agent/install.md @@ -13,9 +13,9 @@ meta: ## Prerequisites -NodeJS of version 20 or later is recommended, through the device agent supports NodeJS v14 or later. +The Device Agent requires Node.js 18 or later. -The Device Agent can be installed on most Linux distributions, Windows, and MacOS. +It can be installed on most Linux distributions, Windows, and MacOS, or via the provided Docker image. The Device Agent connects back to the FlowFuse platform on port 443. You will need to ensure your network permits traffic on that port. For FlowFuse Cloud, the device agent will connect to: @@ -125,6 +125,12 @@ For backwards compatibility we will continue to publish to both the old and new locations for a period of time, but we strongly encourage users to update to the new package to ensure you continue to receive the latest updates. +### Upgrading to Device Agent 3.x + +Version 3.x of the Device Agent requires Node.js 18 as a minimum; older versions of Node.js are no longer supported. + +The `latest` tagged Docker image is now based on Node.js 18. + ### Linux/MacOS ```bash From 7c208fd138ba69bd722d31620125d70eb9461719 Mon Sep 17 00:00:00 2001 From: Nick O'Leary Date: Fri, 8 Nov 2024 10:50:40 +0000 Subject: [PATCH 2/2] Add note on staying on 2.x stream of device agent --- docs/device-agent/install.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/docs/device-agent/install.md b/docs/device-agent/install.md index bf911b9ee9..be70ccd847 100644 --- a/docs/device-agent/install.md +++ b/docs/device-agent/install.md @@ -131,6 +131,8 @@ Version 3.x of the Device Agent requires Node.js 18 as a minimum; older versions The `latest` tagged Docker image is now based on Node.js 18. +If you are not able to update to Node.js 18 or later at this time, you should stay on the Device Agent 2.x release. For the install commands below, this means using `@2.x` instead of `@latest`. In the case of Docker, make sure you use the `2.8.0` tag instead of `latest`. + ### Linux/MacOS ```bash