Skip to content

instance-configuration.md

Latest commit

 

History

History
120 lines (71 loc) · 5.01 KB

instance-configuration.md

File metadata and controls

120 lines (71 loc) · 5.01 KB
Raw
description In this guide, you will learn how to add, remove and update Instance in Defguard desktop client.

Instance configuration

{% hint style="warning" %} Defguard Desktop Client is required if you want to use Multi-Factor Authentication, as any other WireGuard client doesn't support this functionality. {% endhint %}

Obtaining URL and Token

{% hint style="info" %} If you are looking for how to generate tokens for your users as an Administrator, look here:

remote-desktop-activation.md {% endhint %}

  1. Log in to your Defguard account.
  2. Go to My Profile tab.
  3. Click Add new device button inside User Devices list.

  1. Select Remote Device Activation and click Next.

  1. After that you will see URL, Token and QR Code. Copy URL and Token.

Adding Instance

  1. Open Defguard client
  2. Click Add Instance.

  1. Enter URL and Token, then click Add Instance. (If you don't have it, check out this section)

Connecting to Instance

  1. Select your Instance from menu

  1. Select your location, allowed traffic then click Connect.

{% hint style="info" %}

  • Predefined traffic will only route traffic specified by your administrator.
  • All traffic will route everything through VPN tunnel. {% endhint %}

Disconnecting from Instance

Click Disconnect next to the location you are currently connected to.

Updating Instance

If you want to update your instance manually:

  1. Go to your Instance and click Edit Instance

{% hint style="warning" %} Only tokens issued from that specific instance will work in that modal. {% endhint %}

  1. Enter Token provided by your administrator, or generate it on your own. Then click Update Instance

Your Instance will update immediately.

Why do instances need updates?

Defguard Desktop stores all information locally and doesn't communicate with Defguard outside the registration process. This means that information about instances are snapshots of the moment you registered them in the desktop client, and you might want to update that, for example when some new locations are added or removed.

{% hint style="success" %} If you have an Enterprise License, all desktop clients and all instances are synchronized automatically and in real-time. {% endhint %}

Removing Instance

  1. Go to your Instance and click Edit Instance

  1. Click Remove Instance

Your Instance will be removed immediately.

Default instance (auto-connect on startup)

The client can be configured to automatically connect to an instance when it launches. Open Settings and scroll to the Default instance section, then select the instance you want from the dropdown. The default value is None, which means no automatic connection takes place on startup.

{% hint style="info" %} The dropdown only lists instances that have already been added to the client. {% endhint %}

Connect MFA locations on startup

When a default instance is set, locations that require Multi-Factor Authentication are skipped during auto-connect by default. Enable Connect MFA locations on startup to include them — the MFA prompt will appear automatically after the client launches.

{% hint style="warning" %} For locations using an external SSO provider (e.g. Google, Entra ID, Okta) this will open a browser window automatically on startup to complete authentication. {% endhint %}