Setup Guide

Linux

Docker

Weidmüller

u-OS

Hilscher

OI4

ctrlX

Bosch Rexroth

Install with one command

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

Manually Install on

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. Install setup dependencies
Run the following command to install the dependencies of the installation process:

sudo apt update && sudo apt -y install curl content_copy

3. Add SwarmGuard repository
Load basic information about your operating system:

. /etc/os-release content_copy

Add the Inalp public key to your apt keyring:

curl https://repo.inalp.com/os/${ID}/${VERSION_ID}/inalp-keyring.gpg | sudo tee /usr/share/keyrings/inalp.gpg > /dev/null content_copy

Add the Inalp package list:

curl https://repo.inalp.com/os/${ID}/${VERSION_ID}/stable-keyring.list | sudo tee /etc/apt/sources.list.d/inalp.list > /dev/null content_copy

Write operating system information to the package list:

sudo sed -i "s|{OS_NAME}|$ID|g" /etc/apt/sources.list.d/inalp.list
sudo sed -i "s|{OS_VERSION}|$VERSION_ID|g"
/etc/apt/sources.list.d/inalp.list content_copy

4. Install SwarmGuard Agent
Run the following command to install the SwarmGuard Agent:

sudo apt update && sudo apt -y install swarmguard content_copy

5. Add your device to the swarm

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

6. Add more devices to your swarm network
Repeat steps 2 to 5 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. If you configure one or more of your swarm devices as ingress gateways (with a public internet connection and a public IP address), you can forward designated ports to other devices within your private swarm network.

To run a SwarmGuard ingress gateway using apt, please contact us.

This guide explains the steps to install SwarmGuard binaries manually. Basic technical knowledge and administrator access to the target system are required. 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 symlinks, swarm and swarmd, both pointing to the binary you just installed in /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. To start the SwarmGuard agent service, run the following command:

To start the SwarmGuard agent service, run the following command:

sudo systemctl start swarmguard content_copy

To enable the SwarmGuard agent service to start automatically 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.

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

To run an ingress gateway, add the flag --l4gw to the ExecStart directive in the systemd file.