Requirements
This section provides a list of hardware and software requirements that must be met to run the relayr Gateway Agent.
Minimum Platform Requirements
To run the relayr Gateway Agent, your platform must meet the following minimum requirements:
Name | Requirement |
---|---|
CPU | 1 gigahertz (GHz) or faster |
Memory | 256 megabytes (MB) or more |
Disk | 1 GB or more available hard disk space |
OS | Linux |
Libraries | cURL, paho, lua, libssl, libsqlite, libevent, rapidjson, spdlog |
For more resource-limited devices, you can install the Nano Agent, which is a lightweight version of the Gateway Agent. For more information on its requirements, installation and usage, see the Deployment on Nano Devices section.
Supported Linux Distributions
The relayr Gateway Agent installation packages are tailored to various Linux distributions and architectures, listed in the table below.
OS/Arch | i386 | amd64 | armhf | arm64 | RasPiOS |
---|---|---|---|---|---|
Debian Buster 10 stable | ✔ | ✔ | ✔ | ✔ | ✔ |
Ubuntu Bionic Beaver 18.04 LTS | ✔ | ✔ | - | - | - |
Ubuntu Focal Fossa 20.04 LTS | - | ✔ | - | - | - |
The GWA Analytics component is available for Debian Buster only.
MQTT Broker Requirements
An MQTT broker is required to run the Gateway Agent. When you install the Gateway Agent from Debian packages, the default broker is automatically installed as one of the dependencies.
You can also use a different MQTT broker that meets the following requirements:
Compliance with the MQTT 3.1/3.1.1 standard.
Support for data persistency.
Support for the configurable
max_inflight_messages
andkeepalive_interval
and theclientID
defined by a client.Support for the QoS 1, 2, 3.
The recommended broker is mosquitto 1.5.
The supported mosquitto versions are >= 1.4.11.
If you have automatically installed the default MQTT broker as the Gateway Agent's dependency, but you want to use a different broker on the Debian/Ubuntu system, you need to leave the mosquitto in the system, but disable it.
To disable the automatic start of the mosquitto service, stop the service and run:
systemctl disable mosquitto
or:
update-rc.d disable mosquitto
or:
chmod -x /etc/init.d/mosquitto