Skip to content

Commit e831755

Browse files
defguard-communitygitbook-bot
authored andcommitted
GITBOOK-291: change request with no subject merged in GitBook
1 parent bba3ae8 commit e831755

11 files changed

+42
-8
lines changed
132 KB
Loading
316 KB
Loading
329 KB
Loading
278 KB
Loading

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ Defguard is a **comprehensive Remote Access Management solution** incorporating
1212

1313
* Remote Access secured by [WireGuard® VPN with 2FA/Multi-Factor Authentication](admin-and-features/features-and-configuration/wireguard/),
1414
* Identity Management with [SSO based on OpenID Identity Provider](admin-and-features/features-and-configuration/openid-connect/),
15-
* Account Lifecycle management with [secure remote account onboarding](help/enrollment.md).
15+
* Account Lifecycle management with [secure remote account onboarding](help/enrollment/).
1616

1717
***
1818

SUMMARY.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,9 @@
1010
* [Other WireGuard® Clients](help/configuring-vpn/adding-wireguard-devices/README.md)
1111
* [Configuring manually a device for a new VPN Location](help/configuring-vpn/adding-wireguard-devices/configuring-a-device-for-a-new-vpn-location.md)
1212
* [Password change / Reset](help/changing-your-password.md)
13-
* [Enrollment & Onboarding](help/enrollment.md)
13+
* [Enrollment & Onboarding](help/enrollment/README.md)
14+
* [With internal Defguard SSO](help/enrollment/with-internal-defguard-sso.md)
15+
* [With external SSO (Google/Microsoft/Custom)](help/enrollment/with-external-sso-google-microsoft-custom.md)
1416
* [Setting up 2FA/MFA](help/setting-up-2fa-mfa.md)
1517
* [Desktop Client](help/desktop-client.md)
1618

admin-and-features/setting-up-your-instance/standalone-package-based-installation.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -508,7 +508,7 @@ On the other side, core service should print those informations:
508508

509509
### Proxy - enrollment, onboardin and desktop configuration service
510510

511-
To run proxy service (for [remote onboarding & enrollment](../../help/enrollment.md)), we can do it by:
511+
To run proxy service (for [remote onboarding & enrollment](../../help/enrollment/)), we can do it by:
512512

513513
```
514514
# systemctl enable defguard-proxy.service

help/changing-your-password.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,15 +11,15 @@ The same url you have used to do your remote enrollment & onboarding has the fun
1111
<figure><img src="../.gitbook/assets/password-reset.pg.png" alt=""><figcaption><p>Password reset in enrollment service</p></figcaption></figure>
1212

1313
{% hint style="info" %}
14-
The enrollemnt service URL should be avaialbe in the onboarding email you have received when finishing the [onboarding\&enrollment process.](enrollment.md)
14+
The enrollemnt service URL should be avaialbe in the onboarding email you have received when finishing the [onboarding\&enrollment process.](enrollment/)
1515
{% endhint %}
1616

1717
#### By admin
1818

1919
Ask your administrator to send you the password reset link.&#x20;
2020

2121
{% hint style="info" %}
22-
You should have you admin contact data on the onboarding message that was sent automatically after you have finished the [onboarding\&enrollment process.](enrollment.md)
22+
You should have you admin contact data on the onboarding message that was sent automatically after you have finished the [onboarding\&enrollment process.](enrollment/)
2323
{% endhint %}
2424

2525
## Changing your password in defguard

help/enrollment/README.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
# Enrollment & Onboarding
2+
3+
The enrollment proces depends on your configuration:
4+
5+
1. If you are using[ internal defguard's SSO](with-internal-defguard-sso.md) - then most probably defguard is also the SSO for all your application access, meaning with defguard's account you not only access/configure VPN but also log in to other applications. Then the process includes setting up your account as well as configuring VPN. [More details here.](with-internal-defguard-sso.md)
6+
2. If you are using an [external SSO to login to defguard](with-external-sso-google-microsoft-custom.md) (Google/Microsoft/Custom), then defguard only is responsible for the VPN, and only VPN client is configured. [More details here.](with-external-sso-google-microsoft-custom.md)
Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
# With external SSO (Google/Microsoft/Custom)
2+
3+
{% hint style="info" %}
4+
This features is available from Defguard 1.1
5+
{% endhint %}
6+
7+
In this scenario defguard is only the VPN system and enrollment is used just to obtain credentials to configure the [Defguard Desktop Client](../configuring-vpn/add-new-instance/).
8+
9+
Please go to the enrollment URL, like: https://enrollment.company.com and choose Enrollment:
10+
11+
<figure><img src="../../.gitbook/assets/Screenshot 2024-11-15 at 18.48.20.png" alt="" width="563"><figcaption></figcaption></figure>
12+
13+
Then all you have to do is click on your SSO login - the button name depends on the SSO you have configured:
14+
15+
<figure><img src="../../.gitbook/assets/Screenshot 2024-11-15 at 18.49.54 (1).png" alt=""><figcaption></figcaption></figure>
16+
17+
Now log in with your SSO and after successful login process, you will receive information how to configure your desktop client:
18+
19+
<figure><img src="../../.gitbook/assets/Screenshot 2024-11-15 at 18.52.56.png" alt=""><figcaption></figcaption></figure>
20+
21+
Download the [defguard desktop client](https://defguard.net/download/), and [enter _Instance URL_ and _token_ shown on this screen - more details here](../configuring-vpn/#automatic-with-defguard-client).

0 commit comments

Comments
 (0)