Install Netclient and Join the Network

Introduction

If you want to integrate a device as a client into an existing Netmaker VPN, this Help Center article is the right place to start. Installing Netclient is easy and allows your devices to become part of a VPN, whether they are Linux servers or Windows clients.


Prerequisites

  • Netmaker Server
  • At least one client



Add a Device

Select the Nodes tab in the left-hand menu bar, then click the blue Add Device button in the overview that appears to add a device.


Netmaker makes setting up its Netclient very easy and always provides small script snippets for installation and joining the current network.



Windows

First, download the Netclient for Windows by clicking the blue Netclient for Windows button and install netclientbundle.exe.

Next, open a PowerShell command prompt or a CMD command prompt, paste the command from the second step into it, and confirm the entry by pressing the [Enter] key.


Mac

For Mac, the procedure is similar to that for Windows; however, in the first step, you must select the correct processor architecture for your Mac and then download the client using the Netclient for Mac button.

After installing Netclient, open your Terminal, enter the command from Step 2, and confirm your entry by pressing the [Enter] key.


Joining the network requires sudo privileges, which is why you will be prompted for your system user’s password; you must successfully authenticate.


Linux

For Linux, you must also select the correct processor architecture in Step 1; however, the installation here is performed directly via the command line. Therefore, copy the command from Step 1 and execute it in a terminal of your choice by pressing the [Enter] key.


The installation requires sudo privileges, which is why you will be prompted for your system user’s password and must successfully authenticate.



After installing Netclients, enter the command from Step 2 in the terminal and confirm the entry again by pressing the [Enter] key.



Verification

There is no confirmation in the web interface modal. On the command line in Linux, successful connection to the VPN is confirmed by the following output:

sudo netclient join -t eyJzZXJxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
setting host fields
registered with server mwycq.creoline.cloud 


When you close the modal for adding a device, your device should appear in the Nodes overview.




Common Error Messages


Since the Netmaker pre-installation is a Unmanaged support-level pre-installation, we cannot provide direct assistance and can only offer limited support in the event of an error.