Setup Guide

Linux

Weidmüller

u-OS

Hilscher

OI4

ctrlX

Bosch Rexroth

Install with one command

curl -fsSL https://swarmguard.io/install.sh | sh content_copy

Standard Setup Guide for Linux

1. Sign up for SwarmGuard

Please sign up for a SwarmGuard account.
Download the SwarmGuard Industrial mobile application from either the Google Play Store or the Apple App Store by scanning the QR code below.c
Open the app and sign in with your account (email address and authentication code).

2. Install Docker (if it isn’t already installed)
Prepare a first device for your swarm network by installing the Docker engine . Follow these instructions for the supported platforms:

3. Install SwarmGuard Agent
Ensure your device runs Linux with a kernel version of 5.4 or higher to integrate it successfully into your swarm network. You can either install a regular agent or alternatively an agent + ingress gateway (see more infos below).

Regular Agent

Run the following command to install a regular agent on your device:

curl -fsSL https://swarmguard.io/install.sh | sh content_copy

Agent + ingress gateway

Run the following command to install an agent and make your device an ingress gateway:

curl -fsSL https://swarmguard.io/install-gateway.sh | sh content_copy

4. Add your device to the swarm

Start SwarmGuard on your device by running swarm up.
Use the SwarmGuard Industrial mobile application and scan the QR code issued by the swarm up command on the device.
Your device is connected to your swarm now.

5. Add more devices to your swarm network
Repeat steps 2 to 4 for additional devices.

Good To Know

SwarmGuard autonomously creates a full-mesh overlay network encompassing all the registered devices, known as the swarm. Access devices within the swarm using the domain name <device-name.swarm>.

Ingress Gateway

An ingress gateway functions as a bridge between the public Internet and your private swarm network. By configuring one or more of your swarm devices as ingress gateways, provided they have a connection to the public Internet with a public IP address, you get the ability to forward designated ports to other devices within your private swarm network.

Make sure to run this alternative command in step 3 of this guide in order to make your device an ingress gateway:

curl -fsSL https://swarmguard.io/install-gateway.sh | sh content_copy

This command installs two services: the regular SwarmGuard Agent and a SwarmGuard Layer-4-Gateway. The layer-4-gateway is managed remotely via your mobile application. To enable external access to a device port from the Internet, navigate to the device screen within the app and select Public Access. Subsequently, specify the desired port for opening, such as HTTPS (TCP/443). The app will display a public URL that can be used to access to the device port through one of your ingress gateways.

Manual Setup Guide for Linux

The manual install guide explains the steps to install SwarmGuard binaries manually.
Basic technical knowledge and administrator access to the target system is needed. If you are looking for the standard industrial setup guide or the setup guide for industrial app stores, please follow the industrial setup guide.

1. Sign up for SwarmGuard

Please sign up for a SwarmGuard account.
Download the SwarmGuard Industrial mobile application from either the Google Play Store or the Apple App Store by scanning the QR code below.
Open the app and sign in with your account (email address and authentication code).

2. Installation
Download the binary for your architecture from the official release page and copy it to your target system to /usr/bin.
Create two links, swarm and swarmd, both linking to the binary you just installed to /usr/bin.
Keep in mind that the name of your binary might differ depending on the architecture of your system.

sudo ln -s /usr/bin/swarmd-linux-amd64 /usr/bin/swarmd
sudo ln -s /usr/bin/swarmd-linux-amd64 /usr/bin/swarm content_copy

Create a systemd service file /etc/systemd/system/swarmguard.service with the following content:

[Unit]
Description=SwarmGuard Agent
After=network-online.target
StartLimitIntervalSec=0

[Service]
Type=simple
User=root
ExecStart=/usr/bin/swarmd
Restart=on-failure

[Install]
WantedBy=multi-user.target
content_copy

3. Start the SwarmGuard Agent
To start the SwarmGuard agent service, run the following command:

sudo systemctl start swarmguard content_copy

To enable the SwarmGuard agent service to be started by default on boot, run the following command:

sudo systemctl enable swarmguard content_copy

Run the command sudo swarm statusto see the status of the SwarmGuard agent.
Run the command sudo systemctl status swarmguard to see the status of the systemd service.

4. Register your device
To register your device, scan the QR code with the SwarmGuard Industrial mobile app.
The QR code can be displayed by running the command sudo swarm register.