Skip to content

Getting started

Choose the outcome you need:

OutcomeStart here
Reach and support one Linux deviceConnect your first device
Manage Home Assistant on the free planManage Home Assistant with Dataplicity
Prove a device through your first customer's branded portalBuild your first connected product
Add portal and operations capabilities to devices already onlineExpand beyond remote access
Understand the architecture and boundaries firstHow Dataplicity fits

The first path ends with engineering access. The connected-product path continues through Device Class, product data, customer UI, customer organisation, placement, and a portal login. Use that second outcome as the activation test for a product you intend to sell.

What you need

You need toOpen
Sign in or recover an accountSign in or reset a password
Install the agent on one Linux deviceQuick start
Understand what the field agent installs and runsDataplicity agent
Confirm the device can reach the internetInternet connection
Put the agent on a factory imageInstall on many devices
Allowlist outbound traffic on a restricted networkFirewall requirements
See whether this Linux image is a supported starting pointSupported systems

Install and first connection

GuideDescription
Quick startInstall the agent, confirm the device is online, and open a remote shell.
Manage Home Assistant with DataplicityHow people run one free-plan HA host: shell when it breaks, Wormhole when away, plus one monitor, task, and dashboard.
Dataplicity agentOn-device architecture, requirements, layout, and health checks.
Internet connectionEthernet and WiFi setup. Skip this if the device already has a working route.
Supported systemsLinux agent requirements, image validation, and the agent or CLI distinction.
Command-line toolsInstall the workstation CLI or use the in-app Web CLI.
Firewall requirementsOutbound HTTPS URLs and NTP requirements for restricted networks.
Agent lifecycleUpgrade, uninstall, and data left on the device.
Data consumptionBaseline agent traffic when idle.
Improving reliabilityNetwork reconnect handling on embedded devices.

Before you install

After your first device is online