Skip to content

Commit

Permalink
Merge pull request #4747 from FlowFuse/da-doc-update
Browse files Browse the repository at this point in the history
Update Device Agent docs for 3.x release
  • Loading branch information
hardillb authored Nov 8, 2024
2 parents 605166b + 7c208fd commit 8b24d64
Showing 1 changed file with 10 additions and 2 deletions.
12 changes: 10 additions & 2 deletions docs/device-agent/install.md
Original file line number Diff line number Diff line change
Expand Up @@ -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:

Expand Down Expand Up @@ -125,6 +125,14 @@ 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.

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
Expand Down

0 comments on commit 8b24d64

Please sign in to comment.