Skip to content

Commit 403412d

Browse files
authored
Merge pull request #46 from DefGuard/mobile-client
mobile client documentation
2 parents 54dd90b + 5d5849f commit 403412d

File tree

6 files changed

+57
-12
lines changed

6 files changed

+57
-12
lines changed
41.4 KB
Loading
41.3 KB
Loading
189 KB
Loading
57.8 KB
Loading
48.6 KB
Loading

help/mobile-client.md

Lines changed: 57 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -15,11 +15,10 @@ Join closed beta for [iOS](https://defguard.net/download) or [Android](https://d
1515
### Connecting made effortless
1616
1. Download app from [App Store](https://defguard.net/download) or [Google Play](https://defguard.net/download)
1717
2. Open app
18-
3. To add instance [scan QR](#add-instance-by-qr-code) or [use manual configuartion](#add-instance-manually)
18+
3. To add instance [scan QR](#add-instance-by-qr-code) or [use manual configuration](#add-instance-manually)
1919
4. [Connect](#connecting-to-location-without-mfa) with single click
2020

2121

22-
2322
### Quick guide
2423
- [How to add an instance?](#adding-new-instance)
2524
- [How to connect to location without MFA?](#connecting-to-location-without-mfa)
@@ -57,28 +56,74 @@ Your phone will need to add new VPN configuration, when you see the request, ple
5756

5857
### Connecting to location (without MFA)
5958

60-
1. Choose desired instance from list
61-
2. Select location by clicking "Connect" next to it
59+
1. Choose the desired instance from list
60+
2. Select the location by clicking "Connect" next to it
6261
3. Choose if you want to route your traffic with:
63-
* Predefined traffic (Faster for general browsing)
64-
* All traffic (Full encryption and privacy)
62+
* Predefined traffic
63+
* All traffic
6564
4. Press "Connect"
6665

6766
### Connecting to location (with MFA)
6867

68+
{% hint style="warning" %}
69+
Please check [this](#authenticating-with-openid) section for information about how the OpenID authentication method works.
70+
{% endhint %}
71+
6972
1. Choose desired instance from list
7073
2. Select location by clicking "Connect" next to it
7174
3. Choose if you want to route your traffic with:
72-
* Predefined traffic (Faster for general browsing)
73-
* All traffic (Full encryption and privacy)
75+
* Predefined traffic
76+
* All traffic
7477
4. Choose MFA method which is configured in your account
7578
* Email
76-
* Authenticator App
77-
5. Authenticate and connect.
79+
* [Authenticator App](#authenticating-with-authenticator-app-totp)
80+
5. Authenticate and connect
81+
82+
83+
{% hint style="info" %}
84+
The first time you connect, app will ask whether you want to route **predefined traffic** or **all traffic**.
85+
86+
- **Predefined traffic** is optimized for general browsing and will route only specific traffic through VPN.
87+
- **All traffic** provides full encryption and privacy for all your device traffic.
88+
89+
You can select **"Remember my choice"** if you don't want to be asked again.
90+
91+
92+
If you want to change this setting later:
93+
1. Go to **Instances** in the app menu.
94+
2. Press **Connect** button next to location name and wait until popup shows.
95+
3. Click **Select Traffic Routing**, choose option and confirm with **Save** button.
96+
97+
{% endhint %}
98+
99+
<figure><img src="../.gitbook/assets/defguard-mobile-connect-traffic.png"width="50%"><figcaption></figcaption></figure>
100+
101+
{% hint style="info" %}
102+
When connecting with MFA for the first time, you will have the option to select **"Remember my choice"**. Select this option if you want to always use this method for this location.
103+
104+
To change your preferred MFA method later:
105+
1. Go to **Instances** in the app menu.
106+
2. Press **Connect** button next to location name and wait until popup shows.
107+
3. Click **Select MFA Method**, choose option and confirm with **Save** button.
78108

79-
{% hint style="warning" %}
80-
If your instance has configured external OpenID authentication, it will be used as primary method for MFA
81109
{% endhint %}
110+
<figure><img src="../.gitbook/assets/defguard-mobile-connect-mfa.png"width="50%"><figcaption></figcaption></figure>
111+
112+
### Authenticating with OpenID
113+
Upon connecting location with **external** MFA requirement we should see this information
114+
<figure><img src="../.gitbook/assets/defguard-mobile-openid-banner.png"width="50%"><figcaption></figcaption></figure>
115+
116+
After clicking "Authenticate with OpenID", we should be redirected to login page. After successfully logging in, you should see something like this:
117+
<figure><img src="../.gitbook/assets/defguard-mobile-openid-success.png"width="50%"><figcaption></figcaption></figure>
118+
After this step please go back to the Defguard app and check your connection.
119+
120+
### Authenticating with Authenticator App (TOTP)
121+
122+
When connecting to a location that requires **internal** MFA, you should see this screen.
123+
<figure><img src="../.gitbook/assets/defguard-mobile-totp-screen.png"width="50%"><figcaption></figcaption></figure>
124+
125+
Enter code from **your Authenticator App** and click "Verify". After this step your VPN connection will be established.
126+
82127

83128
### How can I obtain QR Code, URL and token?
84129

0 commit comments

Comments
 (0)