TBA
Setup Guide
Linux
macOS
Windows
TBA
Install with one command
curl -fsSL https://swarmguard.io/install.sh | sh content_copy
Detailed Instructions
1. Sign up
Please sign up for a SwarmGuard account. Request your sign-up code by emailing us at support@inalp.com .
2. Download the app
Manage your swarm network using the SwarmGuard Industrial mobile application. Download the app from either the Google Play Store or the Apple App Store by scanning the QR code below:
3. Sign in
Open the app and sign in with your account (email address and authentication code).
4. Install Docker
Prepare a first device for your swarm network by installing the Docker engine if it isn’t already installed. Follow these instructions for the supported platforms:
5. Install the SwarmGuard Agent
Ensure your device runs Linux with a kernel version of 5.4 or higher to integrate it successfully into your swarm network.
- Install a regular agent by running the command:
curl -fsSL https://swarmguard.io/install.sh | sh content_copy - Alternatively, if you would also like to use the SwarmKeeper (see below), run the command:
curl -fsSL https://swarmguard.io/install-gateway.sh | sh content_copy
6. Start SwarmGuard on the device
Start SwarmGuard by running swarm up.
7. Register your device
Use the SwarmGuard Industrial mobile application and scan the QR code issued by the swarm up command on the device.
8. Add more devices to your swarm network
Repeat steps 4 to 7 for additional devices.
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>
SwarmKeeper
A SwarmKeeper functions as a bridge between the public Internet and your private swarm network. By configuring one or more of your swarm devices as SwarmKeepers, 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.
Instead of downloading and executing the install.sh script in step 5, use the following command line instead:
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 choose 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 SwarmKeepers.
