Documentation

Appearance

Linux compatibility ​

Dataplicity is designed for a broad range of Linux devices. Raspberry Pi OS, Ubuntu, and Debian are common choices, while specialised distributions, custom images, and industrial hardware can also run the agent when they provide its runtime and network requirements.

This flexibility is useful when your product does not fit a short hardware catalogue. If you are working with an unusual board, architecture, or Linux image, we will help you assess it and get the agent running wherever the platform makes that possible.

Installer modes ​

Requirements depend on whether the device needs remote access only, or also the optional supervisor used for Class Software and connected-product on-device functions. See Dataplicity agent.

Remote access only (rescue) ​

Rescue is the remote-access agent for mixed-age Linux fleets:

  • Python 2.7 or newer (package requirement)
  • Build and test coverage includes 2.7, 3.5–3.7, and 3.9–3.12 (including Ubuntu 24.04 / Python 3.12)
  • Outbound HTTPS and accurate system time
  • Writable /var/lib/dataplicity, /etc/dataplicity, and /home/dataplicity

That Python floor is intentional: decade-old gateways and current build images can share one Dataplicity organisation and inventory.

Rescue plus supervisor ​

Install the supervisor when the device needs Class Software, the local stream broker, or other management-plane functions:

  • Python 3.8 or newer, with pip and venv
  • Debian / Raspberry Pi OS 11 (Bullseye) or newer, Ubuntu 20.04 or newer, or a current Arch, Alpine, or Fedora image with equivalent packages
  • Architecture x86_64, aarch64, or armv7 for the published management package
  • docker, podman, or nerdctl on PATH when Class Software is used
  • Writable install and state paths described in Dataplicity agent

Field devices are Linux. The workstation Dataplicity CLI is a separate tool.

Install the agent ​

In the Dataplicity app, select Add device, then copy and run the generated command on your Linux device. This is the supported installation route. The command includes the correct installer and provisioning details for your organisation.

When the management-plane installer is used and the device only needs remote access, append --rescue-only so the supervisor is not installed.

Custom hardware and images ​

Email support@dataplicity.com with the distribution, release, architecture, and any image customisations. We can help identify the agent's runtime, certificate, service, permission, and connectivity requirements for your platform.

Linux images vary, so validate the exact image you plan to ship. This gives you a repeatable installation for production devices and catches image-specific changes before a fleet rollout.

Validate your Linux image ​

Before a fleet rollout:

  1. Confirm outbound HTTPS access and accurate system time.
  2. Generate a fresh install command from Add device.
  3. Run it on the exact OS image and architecture you will deploy. Use --rescue-only when validating a remote-access-only cohort.
  4. Confirm the device enrols, reconnects after a reboot, supports the remote-access features you need, and completes an agent upgrade.
  5. When you use Class Software, confirm the supervisor, container runtime, and a successful application deploy on the same image.
  6. Repeat the test whenever you change the base image, architecture, security policy, or service manager.

Once the image passes these checks, use the same validated build and installation process for your production rollout.