Netbird

install and manage NetBird remote access, verify the connection, and configure SIA Connect as a routining peer

+ More

Introduction

Netbird is an easy to use VPN-service, which can be installed directly on your SIA Connect device, with only a few easy steps. With the Netbird software installed on SIA Connect, the user is able to get easy and secure remote access to their network while also gaining easy access to the data from their network. Netbird comes with comprehensive user management and network segmentation, allowing organizations to assign different users varying levels of access to devices and networks.

This article will cover the following steps

Setting up Netbird
Setting up Netbird on SIA Connect
Using SIA Connect as a VPN gateway to the rest of the subnet
Accessing the subnet from your PC

Video guide

Setting up Netbird

Start by logging on to your account at app.netbird.io

Navigate to “Setup Keys” and create a new setup key

Fill out the required information in the following popup and click “Create Setup Key”
Each of the parameters are explained in the table below

Parameter	Description
Name	The name of your setup key This can be used to distinguish between different installations of Netbird
Make this key reusable	Choose whether this key can be used by more than one Peer A Peer is a device connected to Netbird - essentially one Setup Key could be used for multiple SIA Connect units
Usage limit	Limit the amount of Peers who can use the Setup Key Only applicable if turning on the above parameter
Expires in	Days until the key expires This will disconnect any connected devices when the time has elapsed
Ephemeral Peers	Choose whether inactive peers are to be deleted after being offline for 10 minuted
Allow extra DNS labels	Enable multiple sub-domains
Auto-assigned groups	Groups are used to distinguish different networks and sites. It will also be used to grant access to users, based on their group

The next popup contains your Setup Key

Make sure to save your Setup Key, as it will not be shown again. However, you can create as many setup keys as you need and let them expire when no longer in use.

Setting up Netbird on SIA Connect

NetBird connects the gateway to a NetBird network. After configuration, the card shows the Signal and Management states, CLI version, FQDN, assigned IP address, and networks.

Parameters

Parameter	Required	Description
Management URI	No	Only required for self-hosted NetBird. Leave it empty when using NetBird Cloud.
Admin URI	No	Only required for self-hosted NetBird. Leave it empty when using NetBird Cloud.
Setup Key	Yes	The enrollment key used to install and configure NetBird on the gateway.

Install and configure NetBird

Find the NetBird card.
For self-hosted NetBird, enter the Management URI and Admin URI.
Enter the required Setup Key.
Select Install NetBird.
Wait for NetBird has been installed and configured successfully.
Confirm that the status becomes Running and that Management reports Connected.

The Setup Key field is hidden by default. Use its visibility control when you need to review the entered value. The key is cleared from the form after successful installation.

Start and stop NetBird

If NetBird is installed but stopped, select Start NetBird.

To stop it:

Select Stop NetBird.
Confirm the stop action.

Uninstall NetBird

Select Uninstall NetBird.
Confirm the uninstall action.

Uninstalling stops NetBird and removes its local configuration from the gateway.

After successfully installing Netbird and applying the key you will see the status and proceed to next steps if successfully on-boarded.

Verifying SIA Connect on Netbird

On the Netbird interface, navigate to the Peers-menu. Here you should see the SIA Connect added to the list of Peers

Everything set up until this point will only allow the user to access the SIA Connect gateway remotely

Using SIA Connect to access the entire network remotely

At this point, you have remote access to the SIA Connect unit.To access other devices on the same network, follow the guides in this section. If you only need remote access to SIA Connect, you can skip this step.

Navigate to the Networks menu and click Add Network

At the first popup, give the network a name and click Add Network

At the second popup, click Add resource

Fill out the boxes in the next popup and click Add Resource
For the whole network, input your subnet with .0/24 at the last octet

Click Create Policy at the next popup

Fill out the source and destination groups and click continue. Keep clicking continue and add the policy

At the next popup, click Add Routing Peer

At the next popup, use the drop-down menu to select the SIA Connect gateway and click Continue. On the next screen, click Add Routing Peer

Congratulations, SIA Connect is now acting as a gateway to your entire network!

Accessing the newly created network

Installing Netbird on your PC

You can follow this link to find information on how to install the Netbird client on your PC

After installing the Netbird Client on your PC, you will have Netbird in your system tray. Right click the icon and select Networks

Select the newly created network

You are now connected to the entire subnet

Troubleshoot NetBird

Message or condition	Possible cause	How to resolve it
Setup key is required.	The Setup Key field is empty.	Enter a valid setup key from the NetBird dashboard.
Failed to install NetBird.	The setup key, self-hosted addresses, internet connection, or NetBird service may be unavailable or incorrect. A more specific API message may be shown when available.	Verify the setup key. Confirm that it has not expired or exceeded its usage limit. Check the Management and Admin addresses for self-hosted deployments, then retry.
Unable to read the NetBird configuration.	The Edge Portal could not retrieve the configuration from the gateway.	Reload the page. Check the gateway and internet status, then review the system logs if the message continues.
NetBird error: [message]	The gateway returned a specific NetBird error.	Follow the displayed message. If the configuration is invalid, enter a new setup key and the correct service addresses, then install NetBird again.
Failed to start NetBird.	The saved configuration may be invalid, or the gateway cannot reach the NetBird services.	Check DNS and internet access. Verify the self-hosted service addresses when used. Reinstall NetBird with a new setup key if the saved configuration cannot connect.
Failed to stop NetBird.	The gateway could not stop the NetBird service.	Wait for any pending operation to finish and try again. Review the system logs if the service remains active.
Failed to uninstall NetBird.	The gateway could not remove the local NetBird installation or configuration.	Retry the action. Check gateway storage and system logs if the installation remains present.
Status remains Stopped.	The Management connection is not connected.	Select Start NetBird. Confirm internet access, DNS, setup-key registration, and the Management address.
Management is connected but Signal is not connected.	The peer can reach the Management service but not the Signal service.	Check firewall and outbound network rules for the NetBird services. Review the NetBird dashboard and gateway logs for a more specific connection error.
The gateway appears in NetBird, but a remote peer cannot reach it.	An access policy or group assignment may not allow the connection.	Verify the source and destination groups, access policy, protocol, and ports in the NetBird dashboard.
A remote peer cannot reach equipment behind SIA Connect.	The Network resource, routing peer, policy, or local route may be missing or incorrect.	Confirm that SIA Connect is assigned as the routing peer. Check the resource CIDR and access policy. Use the Ping tool from SIA Connect to verify that the gateway can reach the target equipment.

access remote netbird vpn configuration

Contact Us