# Accessing the VPN as an End User

## Overview

Once you have configured access to the platform for users, your users will need to join. Here are some simple steps for how users accept an invite, download, install, and use the VPN client: Netmaker Desktop and Mobile

## Accepting an Invite

Users who have been invited to the platform will be sent an email with an invite link, if email is configured. If not, you must manually provide them with the invite link.

Once they click the link, they will see a registration page allowing them to sign up with SSO (Social Sign On) or by setting a password.

![](/files/78cdfdd37373aa58cddfa4459f3cba60edf6477d)

## Downloading and Installing the Netmaker Desktop

After signing up, the user should download and install the Netmaker Desktop.

{% stepper %}
{% step %}

### Download the installer

Download the platform-specific installer from:\
<https://www.netmaker.io/download>

![](/files/FQRETIX1IoIxUMUXKAGK)
{% endstep %}

{% step %}

### Install the application

Follow the installation instructions from the bundler.

![](/files/pQeIrNbYVWMloFsFYmVN)
{% endstep %}

{% step %}

### Virtual Machine prerequisite

{% hint style="info" %}
If installing on a Virtual Machine, include the “Mesa Dependency” package while installing.
{% endhint %}

![](/files/ciujp54vgGJHTwaYjftk)
{% endstep %}

{% step %}

### Finalize installation

On successful installation, press the “Finish” button to finalize and close the installer.

![](/files/bZ8tasXbgsNY7TnrXP26)

After that, users can search for “Netmaker Desktop” and open the application.

![](/files/W2twg7Ngo1mPv4KJNWGn)
{% endstep %}
{% endstepper %}

## Logging In

To log in, a user will need to specify the netmaker server, and enter their credentials.

### Specify Server

The application needs to know which server it is logging into.

* On Prem: For On-Prem installations, this will be the API URL, which usually looks like api.
* SaaS: For SaaS accounts, this will be the “Tenant ID”, which should be included in the email invite, and can be seen when logging into [account.netmaker.io](http://account.netmaker.io/) under tenant management.

![](/files/ZDHvb43zR2Jo8aC7vZQv)

### Enter Credentials

* Basic Auth: For basic auth users, they will enter their username and password.
* OAuth: To log in using OAuth (SSO), click the “Login with OAuth” button and then go through the provider’s login process.

![](/files/59YwezC6CrM5NjCfbDH6)

Note: If this is a new registration, the admin of the netmaker server or the netmaker SaaS tenant will be notified of the new user request which needs to be manually approved by the admin, under Pending Users.

<figure><img src="/files/25xwZI44Mu3gwp05SfUD" alt=""><figcaption></figcaption></figure>

### Connecting to the VPN <a href="#connecting-to-the-vpn" id="connecting-to-the-vpn"></a>

After logging in, users will see the networks and gateways for which they have been granted access.

#### Gateway Information <a href="#connecting-to-the-vpn__gateway-information" id="connecting-to-the-vpn__gateway-information"></a>

Hover over the information icon to view gateway details.

<figure><img src="/files/PIi8awLf0pnFWXhVHijQ" alt=""><figcaption></figcaption></figure>

#### Connecting/Disconnecting <a href="#connecting-to-the-vpn__connectingdisconnecting" id="connecting-to-the-vpn__connectingdisconnecting"></a>

Use the toggle switch to connect or disconnect from a specific gateway and access the network.

Press the Refresh icon to refresh a connection.

<figure><img src="/files/iKLpptAWFpkeu9zyv4fQ" alt=""><figcaption></figcaption></figure>

### Admin Visibility <a href="#admin-visibility" id="admin-visibility"></a>

As an admin, you can see active users in your network, if you navigate to the Node interface and click on the “Active Users” filter, you will be able to see users.

<figure><img src="/files/TcYVAWzPLrZqyZLGN9q8" alt=""><figcaption></figcaption></figure>

### Troubleshooting <a href="#troubleshooting" id="troubleshooting"></a>

#### **OAuth Error** <a href="#troubleshooting__oauth-error" id="troubleshooting__oauth-error"></a>

<figure><img src="/files/we20OU9ywlvqqoR8aEe7" alt=""><figcaption></figcaption></figure>

This error is related to the netmaker server not having OAuth setup and enabled. Please request the netmaker server admin to configure and enable OAuth by following the docs at <https://docs.netmaker.io/docs/server-installation/integrating-oauth>

#### **Checking WireGuard** <a href="#troubleshooting__checking-wireguard" id="troubleshooting__checking-wireguard"></a>

To look at the wireguard configuration that has been applied by the Netmaker Desktop, you can simply open up your terminal and use the “wg” command to view the current connection status as shown below.

<figure><img src="/files/sMtcMX5eJQ5Sd3yaO4Mw" alt=""><figcaption></figcaption></figure>

This information can help you diagnose any problems further or simply log the current WireGuard connection status.

#### **Authentication Timeouts and Re-Authenticating** <a href="#troubleshooting__authentication-timeouts-and-re-authenticating" id="troubleshooting__authentication-timeouts-and-re-authenticating"></a>

In the Netmaker standalone server environment configuration file, there are two options to set user authentication token validity duration and auto disable a non-admin user’s remote access upon token expiration. These two configuration variables can be found in the netmaker.env file on a standalone netmaker server as shown below.

<figure><img src="/files/kivM89Xmkp8kYy2SeWVW" alt=""><figcaption></figcaption></figure>

The “**JWT\_VALIDITY\_DURATION**” is responsible for expiring the user authentication token after the **value in seconds**. And if the “**RAC\_AUTO\_DISABLE**” is set to **true**, it will result in authentication timeout and the remote access client user needs to re-authenticate using the rac software for renewing the authentication token and resume normal operation.

### Next Steps <a href="#next-steps" id="next-steps"></a>

Let’s now cover some global troubleshooting, should you run into any trouble while setting up your network.


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://learn.netmaker.io/getting-started/operations-field-guide/accessing-the-vpn-as-an-end-user.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.