Skip to content

Commit 264efaa

Browse files
defguard-communitygitbook-bot
authored andcommitted
GITBOOK-285: change request with no subject merged in GitBook
1 parent 82c88a4 commit 264efaa

File tree

9 files changed

+40
-28
lines changed

9 files changed

+40
-28
lines changed

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ This approach is vastly different from most (if not all) VPN/IdP solutions, whic
2020

2121
Incorporating IDM, ALM, VPN has also other advantages:
2222

23-
1. Internal IdP with 2FA/MFA enables us to provide [**real VPN 2FA/MFA**](admin-and-features/features-and-configuration/wireguard/multi-factor-authentication-mfa-2fa/architecture.md) - and not like most applications just 2FA when opening the app (and not during the connection process). Even if you use [external OIDC](enterprise/external-openid-providers.md) (Google/Microsoft/Custom - which defguard supports), we still use our internal IdP for 2FA/MFA.
23+
1. Internal IdP with 2FA/MFA enables us to provide [**real VPN 2FA/MFA**](admin-and-features/features-and-configuration/wireguard/multi-factor-authentication-mfa-2fa/architecture.md) - and not like most applications just 2FA when opening the app (and not during the connection process). Even if you use [external OIDC](enterprise/all-enteprise-features/external-openid-providers.md) (Google/Microsoft/Custom - which defguard supports), we still use our internal IdP for 2FA/MFA.
2424
2. Your organisation may use just **one account** (login) for access control to all your applications as well as VPN.
2525
3. It simplifies deployment, maintenance, audits.
2626

SUMMARY.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -65,10 +65,10 @@
6565
## Enterprise Features <a href="#enterprise" id="enterprise"></a>
6666

6767
* [License](enterprise/license.md)
68-
* [All enteprise features](enterprise/all-enteprise-features.md)
69-
* [Automatic (real time) desktop client configuration & sync](enterprise/automatic-real-time-desktop-client-configuration.md)
70-
* [External OpenID providers](enterprise/external-openid-providers.md)
71-
* [VPN & Client behavior customization](enterprise/behavior-customization.md)
68+
* [Enteprise features](enterprise/all-enteprise-features/README.md)
69+
* [Automatic (real time) desktop client configuration & sync](enterprise/all-enteprise-features/automatic-real-time-desktop-client-configuration.md)
70+
* [External OpenID providers](enterprise/all-enteprise-features/external-openid-providers.md)
71+
* [VPN & Client behavior customization](enterprise/all-enteprise-features/behavior-customization.md)
7272

7373
## Tutorials
7474

File renamed without changes.

enterprise/automatic-real-time-desktop-client-configuration.md renamed to enterprise/all-enteprise-features/automatic-real-time-desktop-client-configuration.md

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,7 @@
1+
---
2+
icon: rotate-exclamation
3+
---
4+
15
# Automatic (real time) desktop client configuration & sync
26

37
When initially configuring defguard desktop client all available locations for the user (with all location settings) is automatically configured (which is one of defguard's uniqe functionalities).
@@ -6,10 +10,10 @@ In the course of time: new locations can be added by administrators, existing on
610

711
In order to reconfigure users desktop client the administrator has two possibilities:
812

9-
1. If using the **Open Source Open Core** - the administrator needs to send a new configuration token to each user affected, and the user needs to [Update the instance](../help/configuring-vpn/add-new-instance/update-instance.md) in the desktop client with the new obtained token.
13+
1. If using the **Open Source Open Core** - the administrator needs to send a new configuration token to each user affected, and the user needs to [Update the instance](../../help/configuring-vpn/add-new-instance/update-instance.md) in the desktop client with the new obtained token.
1014
2. Obtain the **Enterprise License**, then each users desktop client (and all Locations) are **reconfigured automatically, real time** (propagation takes around 30 seconds to 1 minute) each time any VPN Location is reconfigured or the user is assigned to a different group.&#x20;
1115

1216
{% hint style="warning" %}
13-
If you have been using defguard prior to version 1.0.0, upgraded and have Enterprise License, to take advantage of the real-time config sync on an already configured desktop client, [please refer to Upgrade notes documentation.](../features/setting-up-your-instance/upgrading.md#desktop-client-real-time-sync)
17+
If you have been using defguard prior to version 1.0.0, upgraded and have Enterprise License, to take advantage of the real-time config sync on an already configured desktop client, [please refer to Upgrade notes documentation.](../../features/setting-up-your-instance/upgrading.md#desktop-client-real-time-sync)
1418
{% endhint %}
1519

enterprise/behavior-customization.md renamed to enterprise/all-enteprise-features/behavior-customization.md

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,12 @@
1+
---
2+
icon: sliders
3+
---
4+
15
# VPN & Client behavior customization
26

37
After purchasing the Enterprise License the _Enterprise features_ **tab will be activated**, enabling the administrator to configure additional features:
48

5-
<figure><img src="../.gitbook/assets/Enterprise Features.png" alt=""><figcaption><p>Additional Enterprise Features</p></figcaption></figure>
9+
<figure><img src="../../.gitbook/assets/Enterprise Features.png" alt=""><figcaption><p>Additional Enterprise Features</p></figcaption></figure>
610

711
### Disable for users to manage their devices
812

@@ -14,7 +18,7 @@ If '_Disable users' ability to manually configure WireGuard client_' option is *
1418

1519
This option will not be available for users:
1620

17-
<figure><img src="../.gitbook/assets/Screenshot 2024-10-14 at 12.44.15.png" alt=""><figcaption></figcaption></figure>
21+
<figure><img src="../../.gitbook/assets/Screenshot 2024-10-14 at 12.44.15.png" alt=""><figcaption></figcaption></figure>
1822

1923
{% hint style="danger" %}
2024
Please note that defguard has only **desktop clients** and **no official mobile** client, thus when using this option users **will not be able to configure their mobile WireGuard clients.**
@@ -24,7 +28,7 @@ Please note that defguard has only **desktop clients** and **no official mobile*
2428

2529
Of of defguard desktop client uniqe features is the possibility for the user to automatically route **All network traffic** from their device **through the connected VPN Location**, when the user checks _All traffic_ option_**:**_
2630

27-
&#x20;![](<../.gitbook/assets/Screenshot 2024-10-14 at 12.49.30.png>)
31+
&#x20;![](<../../.gitbook/assets/Screenshot 2024-10-14 at 12.49.30.png>)
2832

2933
But there are scenarios that administrator would like that users have only access to the **Predefined traffic** (meaning Allowed IPs in the Network VPN configuration) and the possibility to access all networks disabled.
3034

enterprise/external-openid-providers.md renamed to enterprise/all-enteprise-features/external-openid-providers.md

Lines changed: 19 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,10 @@
1+
---
2+
icon: up-right-from-square
3+
---
4+
15
# External OpenID providers
26

3-
Defguard, [apart from being an identity provider itself](../admin-and-features/features-and-configuration/openid-connect/), supports logging in through external OpenID providers. Currently, there are two built in providers (Google and Microsoft) but there is also an option to specify a custom provider.
7+
Defguard, [apart from being an identity provider itself](../../admin-and-features/features-and-configuration/openid-connect/), supports logging in through external OpenID providers. Currently, there are two built in providers (Google and Microsoft) but there is also an option to specify a custom provider.
48

59
### Prerequisites
610

@@ -29,7 +33,7 @@ This is an optional value required only if you are using Microsoft as your provi
2933

3034
In order to configure the external OpenID provider login, go to the settings in the Defguard admin dashboard.
3135

32-
<figure><img src="../.gitbook/assets/image (29).png" alt=""><figcaption></figcaption></figure>
36+
<figure><img src="../../.gitbook/assets/image (29).png" alt=""><figcaption></figcaption></figure>
3337

3438
Everything related to the external OpenID configuration can be found in the OpenID tab of the settings page. First thing to do here would be to pick your provider using the dropdown menu under the "Provider" label. Next, fill out the required information with values acquired from your provider. If you picked "Microsoft" or "Custom", make sure to also make corresponding changes in the "Base URL" field. After you are done, click "Save changes" to keep your changes.&#x20;
3539

@@ -44,37 +48,37 @@ You may have also noticed the checkbox option on the right. By default, when a n
4448
1. The Google OpenID connect can be configured in the [Google Cloud Console](https://console.cloud.google.com)
4549
2. If you don't have any project setup already (or you want to create a new one for this purpose), create it by clicking the dropdown menu here:
4650

47-
<figure><img src="../.gitbook/assets/image (31).png" alt="" width="312"><figcaption></figcaption></figure>
51+
<figure><img src="../../.gitbook/assets/image (31).png" alt="" width="312"><figcaption></figcaption></figure>
4852

4953
If you already have project, make sure to select it in the above dropdown menu.
5054
3. Now, navigate to [`APIs & Services`](https://console.cloud.google.com/apis)&#x20;
5155
4. We will focus on the consent screen first, select `OAuth consent screen`
5256
5. &#x20;Pick the User Type according to your needs, this example will focus on the internal type
5357

54-
<figure><img src="../.gitbook/assets/image (32).png" alt=""><figcaption></figcaption></figure>
58+
<figure><img src="../../.gitbook/assets/image (32).png" alt=""><figcaption></figcaption></figure>
5559

5660

5761
6. Fill in all required details. Make sure to fill the correct domain. This should be the top domain under which your Defguard dashboard can be accessed, not the subdomain (e.g. `defguard.example.com` -> `example.com`).&#x20;
5862
7. On the scopes config screen, click `ADD OR REMOVE SCOPES`, Defguard requires at least the following scopes:
5963

60-
<figure><img src="../.gitbook/assets/image (34).png" alt=""><figcaption></figcaption></figure>
64+
<figure><img src="../../.gitbook/assets/image (34).png" alt=""><figcaption></figcaption></figure>
6165

6266

6367
8. Proceed until the end and return to the OAuth consent screen dashboard.
6468
9. Now, go to [`Credentials`](https://console.cloud.google.com/apis/credentials), click `CREATE CREDENTIALS` and choose `OAuth client ID`&#x20;
6569

66-
<figure><img src="../.gitbook/assets/image (35).png" alt=""><figcaption></figcaption></figure>
70+
<figure><img src="../../.gitbook/assets/image (35).png" alt=""><figcaption></figcaption></figure>
6771

6872

6973
10. On the next screen, fill out all required information:\
7074

7175

72-
<figure><img src="../.gitbook/assets/obraz (3).png" alt=""><figcaption></figcaption></figure>
76+
<figure><img src="../../.gitbook/assets/obraz (3).png" alt=""><figcaption></figcaption></figure>
7377

7478
Make sure to select "Web application" as the application type. The other thing to note here is the redirect URI. It is the URI to which the user will be redirected from the external provider's authorization. This URI is in the form of `<DEFGUARD_DASHBOARD_URL>/auth/callback`. Replace `<DEFGUARD_DASHBOARD_URL>` with the URL under which your dashboard is accessible, e.g. `https://defguard.example.com`.
7579
11. After you proceed further, you will be presented with a popup containing your `Client ID` and `Client Secret`, copy them and paste on the Defguard OpenID configuration page.
7680

77-
<figure><img src="../.gitbook/assets/settings.png" alt=""><figcaption></figcaption></figure>
81+
<figure><img src="../../.gitbook/assets/settings.png" alt=""><figcaption></figcaption></figure>
7882

7983
#### Microsoft
8084

@@ -84,46 +88,46 @@ You may have also noticed the checkbox option on the right. By default, when a n
8488
\
8589

8690

87-
<figure><img src="../.gitbook/assets/obraz (4).png" alt=""><figcaption></figcaption></figure>
91+
<figure><img src="../../.gitbook/assets/obraz (4).png" alt=""><figcaption></figcaption></figure>
8892

8993

9094
4. Click "Make new registration"
9195
5. Fill out the form, like in the example:\
9296

9397

94-
<figure><img src="../.gitbook/assets/obraz (5).png" alt=""><figcaption></figcaption></figure>
98+
<figure><img src="../../.gitbook/assets/obraz (5).png" alt=""><figcaption></figcaption></figure>
9599

96100
Make sure the Redirect URL you insert here is correct. Replace `defguard.example.com` with the domain you use for your Defguard dashboard.
97101
6. You should be now on the registered application's management screen. You can copy the client's ID and the tenant ID from here, as you need to provide them on the Defguard settings' page.\
98102

99103

100-
<figure><img src="../.gitbook/assets/Zrzut ekranu 2024-10-18 o 16.13.54.png" alt=""><figcaption></figcaption></figure>
104+
<figure><img src="../../.gitbook/assets/Zrzut ekranu 2024-10-18 o 16.13.54.png" alt=""><figcaption></figcaption></figure>
101105
7. Go to Defguard settings, click the OpenID tab and paste the copied client ID. The tenant ID should be inserted instead of the `<TENANT_ID>` placeholder in the base URL field.
102106
8. &#x20;Now back in Microsoft Entra ID, still in your newly created application, go to Certificates and Secrets\
103107
\
104108

105109

106-
<figure><img src="../.gitbook/assets/obraz (8).png" alt=""><figcaption></figcaption></figure>
110+
<figure><img src="../../.gitbook/assets/obraz (8).png" alt=""><figcaption></figcaption></figure>
107111

108112

109113
9. Click Client secrets and create a new client secret. Copy its **value** and paste it in your Defguard OpenID settings.
110114
10. Go to Token configuration (in the menu on the left) and add a new optional token claim.
111115
11. Make sure to select the ID token type and the following claims:\
112116

113117

114-
<figure><img src="../.gitbook/assets/obraz (9).png" alt=""><figcaption></figcaption></figure>
118+
<figure><img src="../../.gitbook/assets/obraz (9).png" alt=""><figcaption></figcaption></figure>
115119

116120

117121
12. Accept the popup or configure the API permissions manually.\
118122

119123

120-
<figure><img src="../.gitbook/assets/obraz (10).png" alt=""><figcaption></figcaption></figure>
124+
<figure><img src="../../.gitbook/assets/obraz (10).png" alt=""><figcaption></figcaption></figure>
121125

122126

123127
13. Go to Authentication (again, it's in the menu on the left, still in the registered App settings) and enable the ID tokens field\
124128

125129

126-
<figure><img src="../.gitbook/assets/obraz (11).png" alt=""><figcaption></figcaption></figure>
130+
<figure><img src="../../.gitbook/assets/obraz (11).png" alt=""><figcaption></figcaption></figure>
127131

128132

129133
14. Now you should be good to go. A new login button should appear on the login screen.

enterprise/license.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ icon: file-certificate
44

55
# License
66

7-
Defguard Enterprise offers a lot of functionalities that are not offered in the Open Source Open Core, like external OpenID Connect support, automatic\&real time desktop client synchronization and configuration, and much more (go to [All Enterprise Features](all-enteprise-features.md) to see more). In order to activate those features an Enterprise License must be obtained.
7+
Defguard Enterprise offers a lot of functionalities that are not offered in the Open Source Open Core, like external OpenID Connect support, automatic\&real time desktop client synchronization and configuration, and much more (go to [All Enterprise Features](all-enteprise-features/) to see more). In order to activate those features an Enterprise License must be obtained.
88

99
{% hint style="info" %}
1010
From release 1.1.0 (to be released mid Nov 2024) **all enterprise features up to the following limits are free and no license is required!**

features/setting-up-your-instance/upgrading.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ If you have duplicate emails in your database, the migrations during the upgrade
2323

2424
### Desktop Client Real Time Sync
2525

26-
From 1.0.0 we have introduced [Enterprise features](../../enterprise/all-enteprise-features.md), and one of them is [automatic and real-time desktop client configuration synchronisation](../../enterprise/automatic-real-time-desktop-client-configuration.md).
26+
From 1.0.0 we have introduced [Enterprise features](../../enterprise/all-enteprise-features/), and one of them is [automatic and real-time desktop client configuration synchronisation](../../enterprise/all-enteprise-features/automatic-real-time-desktop-client-configuration.md).
2727

2828
To enable this on an **already configured desktop client** one must perform one time instance update, which will generate necessary tokens on the client to perform from now on automatic updates. In details:
2929

help/configuring-vpn/add-new-instance/update-instance.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ If you are looking for how to generate tokens for your users as an Administrator
1111
{% endhint %}
1212

1313
{% hint style="warning" %}
14-
Updating the desktop client instance manually is only done if you are using defguard Open Source Open Core, if you have an Enterprise License, all desktop clients and all instances are [synchronized automatically and in real-time.](../../../enterprise/automatic-real-time-desktop-client-configuration.md)
14+
Updating the desktop client instance manually is only done if you are using defguard Open Source Open Core, if you have an Enterprise License, all desktop clients and all instances are [synchronized automatically and in real-time.](../../../enterprise/all-enteprise-features/automatic-real-time-desktop-client-configuration.md)
1515
{% endhint %}
1616

1717
## Why do instances need updates?

0 commit comments

Comments
 (0)