Skip to content

Commit 83a4dc5

Browse files
committed
Mobile client page, changed defguard to Defguard
1 parent da3f767 commit 83a4dc5

File tree

58 files changed

+214
-183
lines changed

Some content is hidden

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

58 files changed

+214
-183
lines changed
6.9 MB
Loading

README.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -5,22 +5,22 @@ Welcome to the Defguard documentation. Here, you'll learn how to explore the ful
55
### How is this documentation organised?
66

77
* [About](broken-reference)\
8-
Briefly describes defguard and its features.
8+
Briefly describes Defguard and its features.
99
* [Getting started](broken-reference)\
10-
Lets you quickly set up your own defguard instance to explore its features an user interface.
10+
Lets you quickly set up your own Defguard instance to explore its features an user interface.
1111
* [Features and configuration](broken-reference)\
12-
Helps you, as a future defguard administrator, get familiar with all of defguard's features and how to configure them to suit your needs.
12+
Helps you, as a future Defguard administrator, get familiar with all of defguard's features and how to configure them to suit your needs.
1313
* [Deployment strategies](broken-reference)\
14-
Walks you through the most common deployment strategies to help you set up your defguard instance as a production-grade solution.
14+
Walks you through the most common deployment strategies to help you set up your Defguard instance as a production-grade solution.
1515
* [Enterprise](broken-reference)\
1616
Outlines the benefits, terms, and purchasing process for the Defguard Enterprise license.
17-
* [Using defguard (for end users)](broken-reference)\
18-
Helps you, as a defguard end user, get familiar with the client applications and their features so you can quickly connect to your defguard instance.
17+
* [Using Defguard (for end users)](broken-reference)\
18+
Helps you, as a Defguard end user, get familiar with the client applications and their features so you can quickly connect to your Defguard instance.
1919
* [Tutorials](broken-reference)\
2020
A collection of step-by-step guides with clear examples and helpful screenshots to make the setup process smooth and enjoyable.
2121
* [In depth](broken-reference)\
2222
In-depth information about the platform and its development, reflecting our commitment to transparency.
2323
* [For developers](broken-reference)\
24-
All the information you need to become a defguard contributor — join us in building a better solution.
24+
All the information you need to become a Defguard contributor — join us in building a better solution.
2525
* [Resources](broken-reference)\
2626
A collection of essential resources, including troubleshooting guides, API documentation, and more.

SUMMARY.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -97,10 +97,11 @@
9797

9898
* [License](enterprise/license.md)
9999

100-
## Using defguard (for end users) <a href="#help" id="help"></a>
100+
## Using Defguard (for end users) <a href="#help" id="help"></a>
101101

102102
* [Overview](help/overwiew.md)
103103
* [Desktop Client](help/desktop-client.md)
104+
* [Mobile Client](help/mobile-client.md)
104105
* [CLI Client](help/cli-client.md)
105106
* [Configuring VPN](help/configuring-vpn/README.md)
106107
* [Defguard Desktop Client](help/configuring-vpn/add-new-instance/README.md)

about/about-defguard.md

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

1313
***
1414

15-
<mark style="color:purple;">**Our primary focus at defguard is on prioritizing security. Then, we aim to make this challenging topic both useful and as easy to navigate as possible.**</mark>
15+
<mark style="color:purple;">**Our primary focus at Defguard is on prioritizing security. Then, we aim to make this challenging topic both useful and as easy to navigate as possible.**</mark>
1616

1717
***
1818

@@ -30,13 +30,13 @@ The main architecture concept is that **all critical data should be in the inter
3030

3131
This approach is **vastly different from most (if not all) VPN/IdP solutions**, which are a simple or monolithic applications focus on functionalities and most of the time is publicly available in the Internet for any attacker to exploit.
3232

33-
Of course you can deploy defguard in a typical scenario (all services on one server and even all publicly available) - but that should be **for you to decide!**
33+
Of course you can deploy Defguard in a typical scenario (all services on one server and even all publicly available) - but that should be **for you to decide!**
3434

3535
### Incorporating IdP and VPN in one solution
3636

3737
Incorporating IDM, ALM, VPN has also other advantages:
3838

39-
1. Internal IdP with 2FA/MFA enables us to provide [**real VPN 2FA/MFA**](../admin-and-features/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](../admin-and-features/external-openid-providers/) (Google/Microsoft/Custom - which defguard supports), we still use our internal IdP for 2FA/MFA.
39+
1. Internal IdP with 2FA/MFA enables us to provide [**real VPN 2FA/MFA**](../admin-and-features/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](../admin-and-features/external-openid-providers/) (Google/Microsoft/Custom - which Defguard supports), we still use our internal IdP for 2FA/MFA.
4040
2. Your organization may use just **one account** (login) for access control to all your applications as well as VPN.
4141
3. It simplifies deployment, maintenance, audits.
4242

activity-log/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,11 +4,11 @@
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 behavior, troubleshoot issues, and maintain an audit trail of important activities.
88

99
## Viewing Activity log events
1010

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

1313
To access it click the `Activity log` button in the navbar.
1414

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

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ description: How to stream activity logs to vector.
66

77
[Logstash ](https://www.elastic.co/logstash)serves as a versatile data processing pipeline that ingests, transforms, and forwards logs from various sources to your preferred observability or SIEM tools. With its modular plugin architecture, Logstash enables flexible configuration of inputs, filters, and outputs—making it ideal for adapting log flows to fit evolving infrastructure needs.
88

9-
This guide demonstrates how to configure a Logstash service running in Docker using Docker Compose to accept HTTP events from defguard and forward them for further processing or storage.
9+
This guide demonstrates how to configure a Logstash service running in Docker using Docker Compose to accept HTTP events from Defguard and forward them for further processing or storage.
1010

1111
### Setup Logstash
1212

@@ -40,7 +40,7 @@ Add Logstash service to the `docker-compose.yaml` and start it.
4040
4141
### Add Logstash destination
4242
43-
In defguard UI with an administrator account, go into settings page and choose `Activity log streaming`.
43+
In Defguard UI with an administrator account, go into settings page and choose `Activity log streaming`.
4444

4545
Click `Add new` and choose `Vector` destination.
4646

@@ -50,7 +50,7 @@ Fill out `Name` and `Url` fields and click **Submit**.
5050

5151
<figure><img src="../../../../.gitbook/assets/image (112).png" alt=""><figcaption></figcaption></figure>
5252

53-
That's it! defguard should now be sending activity events to Logstash, and you should see them printed to `stdout` in the running Logstash container.
53+
That's it! Defguard should now be sending activity events to Logstash, and you should see them printed to `stdout` in the running Logstash container.
5454

5555
To verify that everything is working, try logging in or out of `defguard` and check if the events appear in the Logstash stdout.
5656

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

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ description: How to stream activity logs to vector.
77
[Vector ](https://vector.dev/)serves as a flexible log pipeline, allowing activity events to be collected, processed, and forwarded to a wide range of SIEM systems. By using Vector, you can transform and route logs as needed, making it easier to integrate with your existing observability tools and adapt to future changes in your logging infrastructure.
88

99
\
10-
The goal is to connect defguard as [HTTP Source](https://vector.dev/docs/reference/configuration/sinks/http/) in Vector service. This guide uses an example Vector service running in Docker, configured via Docker Compose.
10+
The goal is to connect Defguard as [HTTP Source](https://vector.dev/docs/reference/configuration/sinks/http/) in Vector service. This guide uses an example Vector service running in Docker, configured via Docker Compose.
1111

1212
### Setup Vector
1313

@@ -58,7 +58,7 @@ INFO vector::app: Loading configs. paths=["/etc/vector/vector.toml"]
5858
5959
### Add Vector destination
6060
61-
In defguard UI with an administrator account, go into settings page and choose `Activity log streaming`.
61+
In Defguard UI with an administrator account, go into settings page and choose `Activity log streaming`.
6262
6363
Click `Add new` and choose `Vector` destination.
6464
@@ -70,7 +70,7 @@ If your `defguard` instance is running in the same Docker Compose network as Vec
7070
7171
<figure><img src="../../../../.gitbook/assets/image (108).png" alt=""><figcaption></figcaption></figure>
7272
73-
That's it! defguard should now be sending activity events to Vector, and you should see them printed to `stdout` in the running Vector container.
73+
That's it! Defguard should now be sending activity events to Vector, and you should see them printed to `stdout` in the running Vector container.
7474
7575
To verify that everything is working, try logging in or out of `defguard` and check if the events appear in the Vector stdout.
7676
@@ -91,7 +91,7 @@ sources:
9191
username: vector
9292
```
9393

94-
Next, add the configured `username` and `password` in defguard settings to the Vector destination.
94+
Next, add the configured `username` and `password` in Defguard settings to the Vector destination.
9595

9696
<figure><img src="../../../../.gitbook/assets/image (109).png" alt=""><figcaption></figcaption></figure>
9797

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ Defguard Gateway v1.3.0 supports Linux machines with [NFTables](https://nftables
1111
Defguard Gateway v1.4.0 supports FreeBSD, NetBSD, and macOS machines with Packet Filter (PF).
1212
{% endhint %}
1313

14-
The ACL (Access Control List) functionality in defguard allows administrators to define and manage who can access specific network resources. It provides a clear and centralized way to control access based on users, groups, or devices, ensuring that only authorized entities can reach sensitive systems or services.
14+
The ACL (Access Control List) functionality in Defguard allows administrators to define and manage who can access specific network resources. It provides a clear and centralized way to control access based on users, groups, or devices, ensuring that only authorized entities can reach sensitive systems or services.
1515

1616
### How to enable Access Control List functionality
1717

admin-and-features/external-openid-providers/external-oidc-secure-enrollment.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
This is an enterprise feature. To use it, purchase our [enterprise license](../../enterprise/license.md) or ensure that your deployment does not exceed the [usage limits](../../enterprise/license.md#enterprise-is-free-up-to-certain-limits).
55
{% endhint %}
66

7-
When [External OIDC is enabled](./) users have the possibility to [securely enroll (automatically create a defguard account) and very easily configure their desktop client](../../help/enrollment/with-external-sso-google-microsoft-custom.md) just by logging in with the SSO provider:
7+
When [External OIDC is enabled](./) users have the possibility to [securely enroll (automatically create a Defguard account) and very easily configure their desktop client](../../help/enrollment/with-external-sso-google-microsoft-custom.md) just by logging in with the SSO provider:
88

99
<figure><img src="../../.gitbook/assets/Screenshot 2024-11-20 at 18.14.17.png" alt=""><figcaption></figcaption></figure>
1010

admin-and-features/forward-auth.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,18 @@
11
# Forward auth
22

3-
defguard supports [forward auth](https://app.gitbook.com/o/Z3mGSAbEj9iLdZ7cNFlL/s/hM5HQk0xXl585Dm4YMUV/~/changes/48/features/forward-auth) integration with popular reverse proxies (tested with [traefik](https://doc.traefik.io/traefik/) and [caddy](https://caddyserver.com/)). This allows you to use defguard to secure services which don't provide their own authorization or OAuth integration.
3+
defguard supports [forward auth](https://app.gitbook.com/o/Z3mGSAbEj9iLdZ7cNFlL/s/hM5HQk0xXl585Dm4YMUV/~/changes/48/features/forward-auth) integration with popular reverse proxies (tested with [traefik](https://doc.traefik.io/traefik/) and [caddy](https://caddyserver.com/)). This allows you to use Defguard to secure services which don't provide their own authorization or OAuth integration.
44

55
{% hint style="warning" %}
6-
In order for forward auth to work the services you are trying to protect must be available at URLs within the same base domain as your defguard instance.
6+
In order for forward auth to work the services you are trying to protect must be available at URLs within the same base domain as your Defguard instance.
77

8-
For example if you are serving your defguard UI at `id.yourdomain.com`, then your services must use other subdomains of `yourdomain.com`, e.g. ``app1.yourdomain.com, `service.yourdomain.com` etc``.
8+
For example if you are serving your Defguard UI at `id.yourdomain.com`, then your services must use other subdomains of `yourdomain.com`, e.g. ``app1.yourdomain.com, `service.yourdomain.com` etc``.
99

1010
Additionally you have to update your [defguard config](../configuration.md#auth-cookies-configuration) to set the cookies domain to `yourdomain.com`.
1111
{% endhint %}
1212

1313
## Example configurations
1414

15-
For brevity all of the examples below assume you are hosting your defguard instance at `defguard.yourdomain.com`.
15+
For brevity all of the examples below assume you are hosting your Defguard instance at `defguard.yourdomain.com`.
1616

1717
We'll use a basic [whoami](https://github.com/traefik/whoami) container as an example service which will be available at `whoami.yourdomain.com`.
1818

0 commit comments

Comments
 (0)