Skip to content

Commit b6e3fa5

Browse files
authored
Merge pull request #44 from DefGuard/mobile-client
Improving Defguard mobile wiki
2 parents 74322d5 + f392c44 commit b6e3fa5

6 files changed

Lines changed: 61 additions & 16 deletions
42.1 KB
Loading
133 KB
Loading
56.2 KB
Loading
116 KB
Loading
130 KB
Loading

help/mobile-client.md

Lines changed: 61 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -4,25 +4,49 @@
44
Mobile client is currently under development, current page should be considered as preview. Some parts of UI may look diffrent in upcoming release.
55
{% endhint %}
66

7+
### Overview
8+
This guide explains how to use the Defguard Mobile to connect securely to VPN locations managed within your Defguard [instance](#what-is-an-instance). It covers the entire process, from installation, adding new instances, connecting to locations, to managing your VPN connection settings.
9+
10+
11+
712
### Installation
813

914
Download for [iOS](https://defguard.net) or [Android](https://defguard.net) (Coming soon!)
1015

1116
### Quick guide
17+
- [How to add instance?](#adding-new-instance-by-qr-or-manually)
18+
- [How to connect to location without MFA?](#connecting-to-location-without-mfa)
19+
- [How to connect to location with MFA?](#connecting-to-location-with-mfa)
20+
- [How can I obtain QR Code?](#how-can-i-obtain-qr-code-url-and-token)
21+
- [What is an instance?](#what-is-an-instance)
22+
- [Supported MFA methods](#supported-mfa-methods)
23+
- [Additional features](#additional-features)
24+
### Connecting made effortless
25+
26+
<figure><img src="../.gitbook/assets/defguard-mobile-connecting.gif" width=50% alt=""></figure>
1227

13-
* [How to add instance?](mobile-client.md#adding-new-instance-by-qr-or-manually)
14-
* [How to connect to location without MFA?](mobile-client.md#connecting-to-location-without-mfa)
15-
* [How to connect to location with MFA?](mobile-client.md#connecting-to-location-with-mfa)
16-
* [Supported MFA methods](mobile-client.md#supported-mfa-methods)
17-
* [Additional features](mobile-client.md#additional-features)
1828

19-
### Connecting made effortless
2029

21-
<figure><img src="../.gitbook/assets/defguard-mobile-connecting.gif" alt="" width="333"><figcaption></figcaption></figure>
30+
### Adding new instance
31+
32+
<figure><img src="../.gitbook/assets/defguard-mobile-new-instance.jpg" width=50% alt=""></figure>
33+
34+
{% hint style="info" %}
35+
**Before** proceeding, please read [this](#how-can-i-obtain-qr-code-url-and-token)
36+
{% endhint %}
37+
38+
#### Add instance by QR Code
39+
1. Go to "Add Instance" tab
40+
2. Click "Scan QR Code"
41+
3. Scan QR code
42+
4. Enter name
2243

23-
### Adding new instance (by QR or manually)
44+
#### Add instance manually
45+
1. Go to "Add Instance" tab
46+
2. Click "Add Instance Manually"
47+
3. Enter URL and token
48+
4. Confirm
2449

25-
<figure><img src="../.gitbook/assets/defguard-mobile-new-instance.jpg" alt="" width="375"><figcaption></figcaption></figure>
2650

2751
{% hint style="warning" %}
2852
Your phone will need to add new VPN configuration, when you see the request, please allow it. Without this permission, Defguard cannot establish VPN connection.
@@ -45,23 +69,44 @@ Your phone will need to add new VPN configuration, when you see the request, ple
4569
* Predefined traffic (Faster for general browsing)
4670
* All traffic (Full encryption and privacy)
4771
4. Choose MFA method which is configured in your account
48-
* Email
49-
* Authenticator App
50-
* Biometric
72+
- Email
73+
- Authenticator App
5174
5. Authenticate and connect.
5275

5376
{% hint style="warning" %}
5477
If your instance have configured external OpenID authentication, it will be used as primary method for MFA
5578
{% endhint %}
5679

80+
### How can I obtain QR Code, URL and token?
81+
1. Login to your Defguard instance
82+
2. Go to "My Profile" tab
83+
3. Click "Add new device" in "User devices" tab
84+
<figure><img src="../.gitbook/assets/defguard-myprofile-add-device.png" width=50% alt=""></figure>
85+
4. Select "Remote Device Activation" and click "Next"
86+
<figure><img src="../.gitbook/assets/defguard-add-new-device.png" width=50% alt=""></figure>
87+
5. You will see URL, Authentication token and **QR Code**
88+
<figure><img src="../.gitbook/assets/defguard-add-instance-qr.png" width=50% alt=""></figure>
89+
90+
### What is an instance?
91+
An instance contains locations. These are the servers you can connect to via VPN. When you use the Defguard Mobile, you select an instance first, and then choose the specific location within it to establish your VPN connection.
92+
93+
#### Instance list
94+
<figure><img src="../.gitbook/assets/defguard-instance-list.jpg" width=50% alt=""></figure>
95+
96+
#### Location list (inside instance)
97+
<figure><img src="../.gitbook/assets/defguard-location-list.jpg" width=50% alt=""></figure>
98+
99+
100+
57101
### Supported MFA Methods
58102

59103
Defguard Mobile supports multiple secure authentication methods:
104+
- **TOTP** – time‑based one‑time passwords (Authenticator apps)
105+
- **Email** – receive verification codes via email
106+
- **OpenID** – integrate with any OpenID Connect provider (Google, etc.)
107+
108+
60109

61-
* **TOTP** – time‑based one‑time passwords (Authenticator apps)
62-
* **Email** – receive verification codes via email
63-
* **Biometry** – Touch ID / Face ID support
64-
* **OpenID** – integrate with any OpenID Connect provider (Google, etc.)
65110

66111
## Additional features
67112

0 commit comments

Comments
 (0)