How to Add Devices

Purpose

Three Methods to Add Devices to a Netmaker Network

Introduction to the Netmaker Dashboard

The Netmaker dashboard serves as the central command center for managing your virtual software-defined networks. Upon logging in, you can view all existing networks under the Networks tab. This interface allows you to monitor connectivity and initiate the process of expanding your infrastructure.

Understanding the Default Network Structure

When managing a specific network, such as the Cloud Overlay, you will notice that at least one device is usually already present. This is the server running the Netmaker instance itself (e.g., "demo-server").

It is highly recommended to keep the default server node within the network. This node handles core networking functions, acting as the default GATEWAY, which facilitates traffic flow between network segments and acts as a backup to ensure continuous connectivity if other paths fail.

Endpoint Management Tabs

The dashboard organizes network endpoints into three distinct categories, accessible via tabs at the top of the node list:

• Devices: Displays nodes running the Netclient agent.

• Config files: Shows devices connected via standard WireGuard configuration files.

• Active Users: Lists users connected through desktop or mobile applications using managed access.

To scale your network, click the blue + Add device button in the top-right corner. This opens the Add new node modal, which presents the three primary methods for integration: the Netclient agent, manual Config files, or User Access based on identity providers.

Method 1: Using the Netclient Agent

The Netclient agent is Netmaker's native binary designed for automated network management on servers and persistent nodes. It is compatible with Windows, Mac, Linux, and Docker environments, providing a seamless way to maintain encrypted connections between devices.

Accessing the Installation Commands

To begin adding a device via the Netclient, navigate to the Add device modal in the Netmaker dashboard. By default, the Netclient method is selected, which displays the firewall requirements and connection options.

• Select the Linux tab to retrieve the specific commands for Linux systems.

• The dashboard provides two critical code blocks: the installation script (utilizing wget) and the join command (containing the unique network token).

Installing and Joining the Network

Once you have access to the target Linux cloud VM's terminal or command-line interface, follow these steps to deploy the agent:

1. Install the Netclient: Copy and paste the installation command from the dashboard. This multi-part command downloads the Netclient binary, updates file permissions, and installs the service on your system.

1. Register the Node: Execute the join command provided in the dashboard (for example, sudo netclient join -t <token>). This command registers the device with the Netmaker server and configures the encrypted WireGuard interface.

After execution, the terminal will confirm the device has successfully joined. You can verify the connection by checking the Devices list in the Netmaker dashboard, where the new node will appear with its assigned private network address.

Method 2: WireGuard Config Files

For devices that do not support the Netmaker agent (Netclient) or the specialized desktop and mobile applications, Netmaker provides a manual integration method using standard WireGuard configuration files. This approach is ideal for legacy systems, IoT devices, or specific edge hardware where installing third-party binaries is not feasible.

Generating the Node Configuration

To initiate a manual connection, navigate to the Add new node modal within the Netmaker dashboard and select the Config files tab. This method creates a static configuration that relies on an existing network node to act as its entry point.

Follow these steps to generate the configuration:

• Node Name: Enter a descriptive identifier for the device, such as "edge-server".

• Gateway Selection: Select an existing node from the Select node as gateway dropdown (e.g., "demo-server") to handle the routing for this manual connection.

• Create Config: Click the Create Config button to finalize the settings.

Applying the Configuration Manually

Once the configuration is generated, you must manually apply it to the target device. Locate the newly created node in the Config files list, select it, and click View/Download config. Copy the provided WireGuard configuration text to your clipboard.

On the target remote device, perform the following steps via the terminal to establish the link:

1. Create the File: Use a command like touch wg-config.conf to create a new configuration file on the local filesystem.

2. Edit and Paste: Open the file using a text editor (e.g., vim wg-config.conf) and paste the configuration text copied from the dashboard.

3. Deploy to System Directory: Move the file to the standard WireGuard directory using mv wg-config.conf /etc/wireguard.

4. Activate Interface: Bring the connection online by executing wg-quick up wg-config.

Once the interface is active, the Netmaker dashboard will update the status of the "edge-server" to Online, indicating it is successfully routing traffic through the designated gateway.

Method 3: Netmaker Desktop Application

The third method for adding devices to your network is designed specifically for end-users on workstations or mobile devices using the Netmaker Desktop application. This approach is ideal for managing active user access rather than persistent server nodes.

Accessing User Setup

To begin, navigate to the Nodes section of your network and click on the Active Users tab. This area allows you to manage connections for users authenticated via OAuth, invites, or IDP integration.

• Click the + Add device button and select the User Access method.

• Select the appropriate operating system (Windows, Mac, Linux, or Mobile) to see the specific installation instructions for the Netmaker Desktop app.

• Take note of the Server Domain or Tenant ID (e.g., api.demo.netmaker.io) provided in the setup instructions, as this is required for the application configuration.

Configuring the Desktop Client

Once you have installed the Netmaker Desktop application on your local machine, you must point it to your Netmaker server.

1. Open the Netmaker Desktop application and click the Settings (gear icon) in the top-right corner.

2. Enter the Server URL or Tenant ID you noted earlier into the designated field and click Save.

3. Return to the main screen and log in using your network credentials (username and password).

Joining the Network

After logging in, the application will display a list of all networks your user account has permission to access. To connect your device to the overlay:

• Locate your target network (e.g., cloud-overlay).

• Click the toggle switch next to the network name.

• The switch will turn green, indicating that the device has successfully joined the network and established a secure connection.

Verifying Connection Status

To confirm the connection from the administrator's perspective, return to the Netmaker Dashboard in your web browser. Under the Nodes management view for your network, navigate back to the Active Users tab. You should now see the user listed with an Online status and a designated Private Address within the overlay network.