Installation
Spinning up your own factory-local IronFlock instance takes just a few minutes. From a bare Industrial PC to a fully running platform — a few steps, no manual configuration.
Requirements
- An Industrial PC (or a virtual machine) with a Debian or Ubuntu based Linux with systemd, and internet access during installation.
- ARM64 or AMD64 architecture.
gpgvorsqvon the host: the install script ofironflockchecks IronFlock’s signature with it. Every Debian and Ubuntu installation has one of them.ironflockitself checks every release of the appliance before it installs it.- SSD storage, preferably NVMe. Machine data is kept in a time-series database, which becomes slow on a spinning hard disk.
- CPU, RAM and storage as in the table below.
| Use | CPU | RAM | Storage |
|---|---|---|---|
| Evaluation and tests | 2 cores | 4 GB | 64 GB SSD |
| Pilot with a few machines | 4 cores | 8 GB | 128 GB SSD |
| Production | 4 cores | 16 GB | 256–512 GB NVMe SSD |
These sizes assume that the machine runs only the appliance. Apps that you install on the appliance itself need resources in addition.
At idle, with no machine data coming in, the appliance and its operating system use about 2.5 GB of RAM and a small part of one CPU core. The load comes from your machine data: how many devices send data and how often, the transformations and alarms that run on it, and how many people use dashboards at the same time.
Storage grows with the data that you keep: the history of machine data, files, and the app images in the appliance’s registry. For long histories of machine data, plan more than 500 GB. Keep space free: when less than 3 GB is free, the appliance stops accepting new data until you free up space.
The install adapts the appliance’s databases to the RAM and CPU cores of the machine, at installation and at every update. If you add RAM or CPU cores later, or resize the virtual machine, the databases use them after the next update to a new release, or at once after sudo ironflock appliance install --version <version> with the version the appliance runs (ironflock status shows it).
Time Synchronization (NTP)
Point the appliance host at a time server it can actually reach before you install. The system clock is not cosmetic: TLS certificate validation, the periodic license re-check, remote access tokens and the timestamp of every data point your machines produce all depend on it. A host that drifts by minutes produces certificate errors, failed logins and history that no longer matches what happened on the shop floor.
In a corporate network the public time servers an operating system ships with are usually unreachable, because outbound NTP on UDP port 123 is blocked at the firewall. Nothing fails loudly — the host simply never synchronizes and drifts away. Ask your IT department for the internal time server and configure it on the host, or have them allow outbound UDP 123.
With systemd-timesyncd (the default on Debian and Ubuntu):
sudo mkdir -p /etc/systemd/timesyncd.conf.d
sudo tee /etc/systemd/timesyncd.conf.d/corporate.conf > /dev/null <<'EOF'
[Time]
NTP=ntp.your-company.com
EOF
sudo systemctl restart systemd-timesyncd
timedatectl statusWith chrony:
echo "server ntp.your-company.com iburst" | sudo tee -a /etc/chrony/chrony.conf
sudo systemctl restart chrony
chronyc sourcestimedatectl status must report System clock synchronized: yes before you install the appliance.
Virtual machines drift faster than physical hardware. If the appliance runs in a VM, enable the hypervisor’s guest time synchronization as well, and still configure NTP inside the guest.
Steps
-
Create an account on ironflock.com.
-
Generate an Instance Key — in the IronFlock UI, open your Profile → Instances, pick the plan that fits your use case, and create a new Instance Key. Copy the key and save it in a file on your appliance host, for example
license.txt. Theironflockcommand calls the instance key the license key: it is the same key. -
Install
ironflockon your appliance host. Open a terminal on your Industrial PC and run:curl -fsSL https://instance-registry.ironflock.com/dl/cli/install.sh | sudo bashThis installs the
ironflockcommand as/usr/local/bin/ironflock, where the appliance needs it. Installation of the command line tool describes what the script does, and how to check it before it runs (Verify the Install Script First). -
Install the appliance:
# Behind a corporate proxy? See the note below before running this. sudo ironflock appliance install --license-file license.txtThe command downloads the newest release, checks it against IronFlock’s appliance release key, installs Docker when it is missing and the host’s own device agent, and starts the appliance. It waits until every service is healthy and ironflock.com reaches the appliance, then shows the admin login of the web UI, once, on the terminal. The appliance keeps the instance key in
/opt/ironflock/license.env, so you can deletelicense.txtafterwards. If the command stops part-way, run the same command again: it continues from where it stopped.Its options (HTTPS, the release channel, a proxy and more) are described in
ironflock appliance install.Behind a corporate proxy? If the appliance only reaches the internet through a corporate HTTP proxy, you must supply it on the install command so the Docker daemon can pull the images — otherwise the install stops at the login step. See Behind a Corporate Proxy.
That’s it. Once the install finishes, the full IronFlock platform runs on the appliance and starts again at every boot.
Note: The appliance commands are new in release 2.1.0 of
ironflock. They have passed one test run, from install to removal, on a fresh Ubuntu 24.04 virtual machine (amd64); see Appliance Commands.
Choosing a Mode
The install sets the appliance up in plain HTTP mode, which needs nothing from corporate IT. For trusted https:// addresses — with a CA the appliance issues itself or with your corporate certificate — see HTTPS & Certificates. If the appliance reaches the internet only through an HTTP proxy, see Behind a Corporate Proxy.