Skip to content

Commit 51068d8

Browse files
defguard-communitygitbook-bot
authored andcommitted
GITBOOK-468: desktop-client polishing
1 parent 06929cc commit 51068d8

File tree

76 files changed

+451
-548
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

76 files changed

+451
-548
lines changed
462 KB
Loading

SUMMARY.md

Lines changed: 7 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -16,14 +16,14 @@
1616

1717
* [Overview](admin-and-features/overview.md)
1818
* [Zero-Trust VPN with 2FA/MFA](admin-and-features/wireguard/README.md)
19-
* [Create/manage VPN Location](admin-and-features/wireguard/create-your-vpn-network.md)
19+
* [Create/Manage VPN Location](admin-and-features/wireguard/create-your-vpn-network.md)
2020
* [Network overview](admin-and-features/wireguard/network-overview.md)
2121
* [Executing custom gateway commands](admin-and-features/wireguard/executing-custom-gateway-commands.md)
2222
* [Multi-Factor Authentication (MFA/2FA)](admin-and-features/wireguard/multi-factor-authentication-mfa-2fa/README.md)
2323
* [MFA Architecture](admin-and-features/wireguard/multi-factor-authentication-mfa-2fa/architecture.md)
2424
* [Remote desktop client configuration](admin-and-features/wireguard/remote-desktop-activation.md)
2525
* [DNS and domains](admin-and-features/wireguard/dns-and-domains.md)
26-
* [VPN & Client behavior customization](admin-and-features/wireguard/behavior-customization.md)
26+
* [VPN & Client behaviour customization](admin-and-features/wireguard/behavior-customization.md)
2727
* [Remote user enrollment](admin-and-features/remote-user-enrollment/README.md)
2828
* [User onboarding after enrollment](admin-and-features/remote-user-enrollment/user-onboarding-after-enrollment.md)
2929
* [Automatic (real time) desktop client configuration & sync](admin-and-features/remote-user-enrollment/automatic-real-time-desktop-client-configuration.md)
@@ -100,19 +100,16 @@
100100
## Using Defguard (for end users) <a href="#help" id="help"></a>
101101

102102
* [Overview](help/overwiew.md)
103-
* [Desktop Client](help/desktop-client/README.md)
104-
* [Instance configuration](help/desktop-client/instance-configuration.md)
105-
* [Using Multi-Factor Authentication (MFA)](help/desktop-client/using-multi-factor-authentication-mfa.md)
106103
* [Mobile Client](help/mobile-client/README.md)
107104
* [Adding new Instance](help/mobile-client/instance-adding.md)
108105
* [Connecting to Instance](help/mobile-client/instance-connect.md)
109106
* [Managing your Instance](help/mobile-client/instance-manage.md)
107+
* [Desktop Client](help/desktop-client/README.md)
108+
* [Instance configuration](help/desktop-client/instance-configuration.md)
109+
* [Using Multi-Factor Authentication (MFA)](help/desktop-client/using-multi-factor-authentication-mfa.md)
110110
* [CLI Client](help/cli-client.md)
111-
* [Configuring VPN](help/configuring-vpn/README.md)
112-
* [Defguard Desktop Client](help/configuring-vpn/add-new-instance/README.md)
113-
* [Update instance](help/configuring-vpn/add-new-instance/update-instance.md)
114-
* [Other WireGuard® Clients](help/configuring-vpn/adding-wireguard-devices/README.md)
115-
* [Configuring a device for new VPN Location manually](help/configuring-vpn/adding-wireguard-devices/configuring-a-device-for-a-new-vpn-location.md)
111+
* [Other WireGuard® Clients](help/adding-wireguard-devices/README.md)
112+
* [Configuring a device for new VPN Location manually](help/adding-wireguard-devices/configuring-a-device-for-a-new-vpn-location.md)
116113
* [Password change / Reset](help/changing-your-password.md)
117114
* [Enrollment & Onboarding](help/enrollment/README.md)
118115
* [With internal Defguard SSO](help/enrollment/with-internal-defguard-sso.md)

about/features-overview.md

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -3,23 +3,23 @@
33
### Remote Access with WireGuard® VPN 2FA/MFA:
44

55
* [**Multi-Factor Authentication**](../admin-and-features/wireguard/multi-factor-authentication-mfa-2fa/) using our [desktop client](https://defguard.net/client)
6-
* **multiple VPN Locations** (networks/sites) - with defined access (all users or only Admin group)
7-
* multiple [Gateways](https://github.com/DefGuard/gateway) for each VPN Location ([**high availability/failove**](../deployment-strategies/high-availability-and-failover.md)**r**) - supported on a cluster of routers/firewalls for Linux, FreeBSD/PFSense/OPNSense
8-
* import your current WireGuard server configuration (with a wizard!)
9-
* _easy_ device setup by users themselves (self-service)
10-
* automatic IP allocation
11-
* kernel (Linux, FreeBSD/OPNSense/PFSense) & userspace WireGuard support
12-
* dashboard and statistics overview of connected users/devices for admins
6+
* **Multiple VPN Locations** (networks/sites) - with defined access (all users or only Admin group)
7+
* Multiple [Gateways](https://github.com/DefGuard/gateway) for each VPN Location ([**high availability/failove**](../deployment-strategies/high-availability-and-failover.md)**r**) - supported on a cluster of routers/firewalls for Linux, FreeBSD/PFSense/OPNSense
8+
* Import your current WireGuard server configuration (with a wizard!)
9+
* _Easy_ device setup by users themselves (self-service)
10+
* Automatic IP allocation
11+
* Kernel (Linux, FreeBSD/OPNSense/PFSense) & userspace WireGuard support
12+
* [Dashboard and statistics overview](../admin-and-features/wireguard/network-overview.md) of connected users/devices for admins
1313

14-
_defguard is not an official WireGuard project, and WireGuard is a registered trademark of Jason A. Donenfeld._
14+
_Defguard is not an official WireGuard project, and WireGuard is a registered trademark of Jason A. Donenfeld._
1515

1616
### Identity Management:
1717

1818
* #### [OpenID Connect](https://openid.net/developers/how-connect-works/) based SSO
1919
* External [OpenID providers for login/account creation (Google/Microsoft/Custom)](../admin-and-features/external-openid-providers/)
2020
* LDAP (tested on [OpenLDAP](https://www.openldap.org/)) synchronization
21-
* nice UI to manage users
22-
* Users **self-service** (besides typical data management, users can revoke access to granted apps, MFA, Wireguard, etc.)
21+
* Nice UI to manage users
22+
* Users **self-service** (besides typical data management, users can revoke access to granted apps, MFA, WireGuard, etc.)
2323

2424
#### [Multi-Factor/2FA](https://en.wikipedia.org/wiki/Multi-factor_authentication) Authentication
2525

@@ -33,9 +33,9 @@ _defguard is not an official WireGuard project, and WireGuard is a registered tr
3333
* User [onboarding after enrollment](https://defguard.gitbook.io/defguard/help/remote-user-enrollment/user-onboarding-after-enrollment)
3434
* Self-service for password reset
3535

36-
### Yubikey Provisioning
36+
### YubiKey Provisioning
3737

38-
[Yubikey hardware keys](https://www.yubico.com/) provisioning for users with _one click_
38+
[YubiKey hardware keys](https://www.yubico.com/) provisioning for users with _one click_
3939

4040
### Integrations
4141

activity-log/README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,19 +4,19 @@
44
This feature is available starting from version 1.4
55
{% endhint %}
66

7-
The Activity Log provides a comprehensive view of user interactions within your Defguard instance. This allows you to monitor user behavior, troubleshoot issues, and maintain an audit trail of important activities.
7+
The Activity Log provides a comprehensive view of user interactions within your Defguard instance. This allows you to monitor user behaviour, troubleshoot issues, and maintain an audit trail of important activities.
88

99
## Viewing Activity log events
1010

1111
Activity log is available as a dedicated page in Defguard core Web UI that's used to manage your instance.
1212

13-
To access it click the `Activity log` button in the navbar.
13+
To access it, click the `Activity log` button in the navbar.
1414

1515
<figure><img src="../.gitbook/assets/image.png" alt=""><figcaption><p>Activity log page</p></figcaption></figure>
1616

1717
### Overview
1818

19-
Activity log page displays a chronological list of user-initiated events. By default most recent events are on top.
19+
Activity log page displays a chronological list of user-initiated events. By default, most recent events are on top.
2020

2121
Each entry in the list contains following fields:
2222

@@ -31,7 +31,7 @@ Each entry in the list contains following fields:
3131

3232
Events are grouped into modules based on the part of the system they are related to.
3333

34-
Currently there are four modules:
34+
Currently, there are four modules:
3535

3636
* **Defguard** - operations performed in the core Web UI (e.g. adding users, modifying devices, managing groups etc.)
3737
* **Client** - actions performed by desktop client applications

activity-log/activity-log-streaming/activity-log-integrations/logstash-integration-guide.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ This guide demonstrates how to configure a Logstash service running in Docker us
1010

1111
### Setup Logstash
1212

13-
Save the following config to `logstash.conf` . This will setup http input for Logstash on port 8002 and output the incoming data into stdout.
13+
Save the following config to `logstash.conf` . This will set up http input for Logstash on port 8002 and output the incoming data into stdout.
1414

1515
```
1616
input {

activity-log/activity-log-streaming/activity-log-integrations/vector-integration-guide.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ The goal is to connect Defguard as [HTTP Source](https://vector.dev/docs/referen
1111

1212
### Setup Vector
1313

14-
For the sake of this example we will follow simple Docker deployment of Vector via Docker Compose but you most likely want to follow Vector's guide to [deploy ](https://vector.dev/docs/setup/deployment/)it in your infrastructure.
14+
For the sake of this example we will follow simple Docker deployment of Vector via Docker Compose, but you most likely want to follow Vector's guide to [deploy ](https://vector.dev/docs/setup/deployment/)it in your infrastructure.
1515

1616
### Vector configuration
1717

@@ -37,7 +37,7 @@ sinks:
3737

3838
This basic configuration adds an HTTP source named `defguard` and a console sink, which forwards all logs received from `defguard` to standard output.
3939

40-
Next add vector service to your **docker-compose.yaml** file.
40+
Next, add vector service to your **docker-compose.yaml** file.
4141

4242
```yaml
4343
vector:
@@ -50,7 +50,7 @@ Next add vector service to your **docker-compose.yaml** file.
5050
- "8001:8001"
5151
```
5252
53-
Make sure that new `vector` service is up and it loaded the configuration, it should print it in stdout:
53+
Make sure that new `vector` service is up, and it loaded the configuration, it should print it in stdout:
5454

5555
```
5656
INFO vector::app: Loading configs. paths=["/etc/vector/vector.toml"]

admin-and-features/access-control-list/README.md

Lines changed: 25 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ This is an enterprise feature. To use it, purchase our [enterprise license](../.
55
{% endhint %}
66

77
{% hint style="warning" %}
8-
Access Control List feature is available in Defguard Core v1.3.0 and Defgaurd Gateway v1.3.0.
8+
Access Control List feature is available in Defguard Core v1.3.0 and Defguard Gateway v1.3.0.
99

1010
Defguard Gateway v1.3.0 supports Linux machines with [NFTables](https://nftables.org/).\
1111
Defguard Gateway v1.4.0 supports FreeBSD, NetBSD, and macOS machines with Packet Filter (PF).
@@ -18,7 +18,7 @@ The ACL (Access Control List) functionality in Defguard allows administrators to
1818
Access Control can be enabled for each location individually. To enable it:
1919

2020
1. Navigate to **VPN Overview** > **Edit Location settings**
21-
2. In **Location configuration** section select **Enable ACL for this location**.
21+
2. In **Location configuration** section, select **Enable ACL for this location**.
2222
3. Click on **Save changes**.
2323

2424
<figure><img src="../../.gitbook/assets/image (17).png" alt=""><figcaption></figcaption></figure>
@@ -27,7 +27,7 @@ Access Control can be enabled for each location individually. To enable it:
2727

2828
## Default Access Control List Policy
2929

30-
Default policy defines how to treat network traffic (with regarding to resources) that was not explicitly specified in ACL rules:
30+
Default policy defines how to treat network traffic (with regard to resources) that was not explicitly specified in ACL rules:
3131

3232
* **Allow** - users and devices connected to a location will be able to access all resources within the network, if the resource access is not modified by one of ACL rules.
3333
* **Deny** - all traffic to network resources that is not regulated by one of the ACL rules will be blocked.
@@ -37,7 +37,7 @@ Default policy defines how to treat network traffic (with regarding to resources
3737
Make sure ACL has been enabled (see above), otherwise the policy setting will not be inactive.
3838

3939
1. Navigate to **VPN Overview** > **Edit Location settings**
40-
2. In **Location configuration** choose the desired option under **Default ACL Policy**.
40+
2. In **Location configuration,** choose the desired option under **Default ACL Policy**.
4141
3. Click on **Save changes**.
4242

4343
<figure><img src="../../.gitbook/assets/image (17).png" alt=""><figcaption></figcaption></figure>
@@ -68,7 +68,7 @@ Use the **Deploy pending changes** button to apply all the rules from **Pending
6868
Defguard’s ACL functionality is designed to allow users to apply access control rules in batches. This approach minimizes the risk of transient network issues that could occur when deploying rules individually. By grouping changes and deploying them together, the system reduces the likelihood of connectivity hiccups or firewall disruptions.
6969
{% endhint %}
7070

71-
The ACL list view also allows rule filtering by name, locations and other attributes
71+
The ACL list view also allows rule filtering by name, locations, and other attributes
7272

7373
<figure><img src="../../.gitbook/assets/image (2) (1) (1).png" alt=""><figcaption></figcaption></figure>
7474

@@ -120,24 +120,24 @@ In Defguard, sources can be defined as one of three object types:
120120
Each ACL rule in Defguard is intended to fully define access to a specific resource, you must therefore always include at least one allowed source.
121121

122122
{% hint style="warning" %}
123-
This setting is independent from the default location-level [**Allowed groups**](../wireguard/create-your-vpn-network.md#allowed-groups) configuration.
123+
This setting is independent of the default location-level [**Allowed groups**](../wireguard/create-your-vpn-network.md#allowed-groups) configuration.
124124

125125
If you give a user access to some resource through an ACL rule, but they do not have access to a given location, they still won't be able to access it, because they'll be unable to establish a VPN connection with the gateway.
126126
{% endhint %}
127127

128128
### How to define your ACL ruleset
129129

130-
Access Control List (ACL) rules in Defguard are used to manage **who can access specific resources** across your network. Think of each rule as a clear instruction that says: _These users or devices are allowed to reach this resource – and optionally, these others are not._
130+
Access Control List (ACL) rules in Defguard are used to manage **who can access specific resources** across your network. Think of each rule as a clear instruction that says: _These users or devices are allowed to reach this resource – and, optionally, these others are not._
131131

132132
#### Key Concepts:
133133

134134
* Each rule connects **who** (users, groups, or devices) to **what** (a resource address).
135135
* At least one "allowed" source must always be specified - this defines who gets access.
136136
* Optionally, you can **exclude** specific users, groups, or devices using the "denied" section.
137137
* You can use this combination to create flexible rules, such as:\
138-
\&#xNAN;_Allow everyone in the “Remote Workers” group except a few individuals access specific office network._
138+
\&#xNAN;_Allow everyone in the “Remote Workers” group except a few individuals to access a specific office network._
139139

140-
This setup helps controlling access clearly and safely without worrying about lower-level network and firewall behavior.
140+
This setup helps control access clearly and safely without worrying about lower-level network and firewall behaviour.
141141

142142
#### Details
143143

@@ -153,51 +153,51 @@ This setup helps controlling access clearly and safely without worrying about lo
153153

154154
#### Allowing access for specific users
155155

156-
In this scenario we will allow specific users to access the 10.1.1.0/24 network, assuming the users connect through _Office-Berlin_ location.
156+
In this scenario, we will allow specific users to access the 10.1.1.0/24 network, assuming the users connect through _Office-Berlin_ location.
157157

158158
To do this, the following new rules have to be added:
159159

160160
* Navigate to **Access Control**.
161161
* Click on **Add new** button.
162-
* Name the rule under **Rule Name**: _Staff access Berlin_.
162+
* Name the rule under **Rule Name**: _Staff access, Berlin_.
163163
* Select _Office-Berlin_ in the **Locations** input.
164-
* Under **Manual Input** > **IPv4/v6 CIDR range or adderess**, enter: _10.1.1.0/24_.
164+
* Under **Manual Input** > **IPv4/v6 CIDR range or address**, enter: _10.1.1.0/24_.
165165
* Add desired users in the **"Allowed Users/Groups/Devices** > **Users**.
166166
* Click on the **Submit** button.
167167

168168
<figure><img src="../../.gitbook/assets/image (71).png" alt=""><figcaption></figcaption></figure>
169169

170-
You will be redirected back to the [ACL List View](./#list-of-acl-rules) and the new rule should now be in the **Pending Changes** section.
170+
You will be redirected back to the [ACL List View,](./#list-of-acl-rules) and the new rule should now be in the **Pending Changes** section.
171171

172172
<figure><img src="../../.gitbook/assets/image (73).png" alt=""><figcaption></figcaption></figure>
173173

174174
Now, click on **Deploy pending changes (1)** button. After that, the rule should be applied on the _Office-Berlin_ location.
175175

176176
<figure><img src="../../.gitbook/assets/image (75).png" alt=""><figcaption></figcaption></figure>
177177

178-
(See [Implementation Details](../../enterprise/all-enteprise-features/access-control-list/firewall-internals.md) documentation to understand integrationn with system packet filtering.)
178+
(See [Implementation Details](../../enterprise/all-enteprise-features/access-control-list/firewall-internals.md) documentation to understand integration with system packet filtering.)
179179

180180
#### Adding access exceptions for specific users
181181

182-
Let's build on the last example. The example defined a single rule that grants network access for two users. In this example we will block access for one specific user. But first let's rethink our approach.
182+
Let's build on the last example. The example defined a single rule that grants network access for two users. In this example, we will block access for one specific user. But first, let's rethink our approach.
183183

184-
It may be tempting to specify the access for each user individually, like we did while constructing the first rule. This may work at first or if your users don't change too often. But what if you have a constant influx of new users? This might get tedious pretty fast.
184+
It may be tempting to specify the access for each user individually, like we did while constructing the first rule. This may work at first, or if your users don't change too often. But what if you have a constant influx of new users? This might get tedious pretty fast.
185185

186186
So what we will do is:
187187

188-
* we will define two groups:
188+
* Define two groups:
189189
* _Staff-Berlin_
190190
* _Externals_
191-
* we will add all the users that work in our _Berlin_ office to _Staff-Berlin_ group
192-
* we will add all users we collaborate with in _Berlin_, but are not our direct employees, to the _Externals_ group
193-
* we will allow all users in _Staff-Berlin_ group access to the network
194-
* we will add an exception for the users in _Externals_ group so that they are not allowed to access the network
191+
* Add all the users that work in our _Berlin_ office to _Staff-Berlin_ group
192+
* Add all users we collaborate with in _Berlin_, but are not our direct employees, to the _Externals_ group
193+
* Allow all users in _Staff-Berlin_ group access to the network
194+
* Add an exception for the users in _Externals_ group so that they are not allowed to access the network
195195

196196
Once you have created appropriate groups and assigned the users, let's update the ACL rule. The rule should now:
197197

198-
* still be assigned to the _Office-Berlin_ location
199-
* still define the destination resource address as `10.1.1.0/24`
200-
* instead of specific users in the **Allowed Users** input, we now select the _Staff-Berlin_ group in the **Allowed Groups** input
201-
* in **Denied Groups** input we should now select the _Externals_ group
198+
* Still be assigned to the _Office-Berlin_ location
199+
* Still define the destination resource address as `10.1.1.0/24`
200+
* Instead of specific users in the **Allowed Users** input, we now select the _Staff-Berlin_ group in the **Allowed Groups** input
201+
* In **Denied Groups** input we should now select the _Externals_ group
202202

203203
<figure><img src="../../.gitbook/assets/image (80).png" alt=""><figcaption></figcaption></figure>

0 commit comments

Comments
 (0)