- docs
- FlowFuse User Manuals
- Using FlowFuse
- Getting Started
- Static asset service
- Bill of Materials
- FlowFuse Concepts
- Changing the Stack
- Custom Hostnames
- Custom Node Packages
- Device Groups
- DevOps Pipelines
- Environment Variables
- FlowFuse Assistant
- FlowFuse File Nodes
- FlowFuse MQTT Nodes
- FlowFuse Project Nodes
- FlowFuse Tables
- High Availability mode
- HTTP Access Tokens
- Instance Settings
- Logging
- persistent-context
- Shared Team Library
- Snapshots
- Team Broker
- Teams
- User Settings
- FlowFuse API
- Migrating a Node-RED project to FlowFuse
- Device Agent
- Device Agent
- FlowFuse Device Agent Introduction
- Installation
- Quick Start
- Register your Remote Instance
- Running the Agent
- Deploying your Flows
- Hardware Guides
- FlowFuse Cloud
- FlowFuse Cloud
- FlowFuse Self-Hosted
- Quick Start
- Installing FlowFuse
- Overview
- Configuring FlowFuse
- DNS Setup
- Docker install
- Docker from AWS Market Place
- Docker on Digital Ocean
- Add Project Stacks on Docker
- Docker Engine on Windows
- Email configuration
- First Run Setup
- FlowFuse File Storage
- Install FlowFuse on Kubernetes
- Upgrading FlowFuse
- Administering FlowFuse
- Administering FlowFuse
- Configuring Single Sign-On (SSO)
- Licensing
- Monitoring
- Telemetry
- User Management
- Support
- Community Support
- Premium Support
- Debugging Node-RED issues
- Contributing
- Contributing to FlowFuse
- Introduction
- Adding Template Settings
- API Design
- Creating debug stack containers
- Database migrations
- FlowFuse Architecture
- Local Install
- State Flows
- Device Editor
- Invite External Users
- User Login Flows
- Reset Password Flow
- Project Creation
- Instance states
- User Sign up Flow
- Team creation Flow
- Team Broker
- Working with Feature Flags
Installing Device Agent
Choose your install path
Most users should use the Device Agent Installer. Power users can choose Manual ( using npm) or Docker deployments.
- Recommended: Use the Device Agent Installer
- Fastest way to get started with a one-line command in the Quick Start guide
- Full options and service management in the Installer reference
- Alternative: Manual install (using
npm)- Install the npm package, set working directory, configure, and run as a service. See Manual install
- Alternative: Docker / Docker Compose
- Run the agent in a container; bind-mount the configuration. See Docker install
Prerequisites
- Node.js 18 or later (for Manual install and for running locally)
- Supported OS: Linux, macOS, Windows, or Docker container
- Networking: allow outbound access on 443 to:
- app.flowfuse.com
- mqtt.flowfuse.cloud
- Access to npm registry when snapshots are installed: https://registry.npmjs.com
Note: The Device Agent downloads the required Node-RED version and any nodes specified by the assigned snapshot. Ensure firewall/proxy permits access to the npm registry or see Running with no access to npmjs.org.
Verify the installation
After installing by any method:
- Ensure a working directory exists (default is
/opt/flowfuse-deviceorc:\opt\flowfuse-device). - Provide a device configuration (via Quick Connect, provisioning, or manual
device.yml). See Register your Remote Instance. - Start the agent (service or CLI) and open
http://<device-ip>:1880when assigned and running.
What’s next
- Follow the Quick Start guide to add and connect a Remote Instance
- Learn how to run and configure the agent
- Use DevOps Pipelines to deploy flows
Table of Contents
Updated: 11 Sep, 2025