GITBOOK-463: change request with no subject merged in GitBook

defguard-community · gitbook-bot · commit ae5688a041d9 · 2025-07-29T15:44:04.000Z
diff --git a/SUMMARY.md b/SUMMARY.md
@@ -38,10 +38,10 @@
 * [External OpenID providers](admin-and-features/external-openid-providers/README.md)
   * [Google](admin-and-features/external-openid-providers/google.md)
   * [Microsoft](admin-and-features/external-openid-providers/microsoft.md)
-  * [Zitadel](admin-and-features/external-openid-providers/zitadel.md)
-  * [Keycloak](admin-and-features/external-openid-providers/keycloak.md)
-  * [JumpCloud](admin-and-features/external-openid-providers/jumpcloud.md)
   * [Okta](admin-and-features/external-openid-providers/okta.md)
+  * [JumpCloud](admin-and-features/external-openid-providers/jumpcloud.md)
+  * [Keycloak](admin-and-features/external-openid-providers/keycloak.md)
+  * [Zitadel](admin-and-features/external-openid-providers/zitadel.md)
   * [Custom](admin-and-features/external-openid-providers/custom.md)
   * [External OIDC secure enrollment](admin-and-features/external-openid-providers/external-oidc-secure-enrollment.md)
 * [LDAP and Active Directory integration](admin-and-features/ldap-and-active-directory-integration/README.md)
@@ -52,23 +52,23 @@
   * [ACL Aliases](admin-and-features/access-control-list/acl-aliases.md)
   * [Implementation Details](admin-and-features/access-control-list/firewall-internals.md)
 * [Network devices](admin-and-features/network-devices.md)
-* [Activity & Audit logs](admin-and-features/activity-log/README.md)
-  * [Audit Log Streaming to SIEM systems](admin-and-features/activity-log/activity-log-streaming/README.md)
-    * [Supported SIEM systems integrations](admin-and-features/activity-log/activity-log-streaming/activity-log-integrations/README.md)
-      * [Vector integration guide](admin-and-features/activity-log/activity-log-streaming/activity-log-integrations/vector-integration-guide.md)
-      * [Logstash integration guide](admin-and-features/activity-log/activity-log-streaming/activity-log-integrations/logstash-integration-guide.md)
-* [Notifications](admin-and-features/notifications/README.md)
-  * [Email notifications](admin-and-features/notifications/setting-up-smtp-for-email-notifications.md)
-  * [Gateway notifications](admin-and-features/notifications/gateway-notifications.md)
-  * [New version notifications](admin-and-features/notifications/new-version-notifications.md)
-* [Integrations](admin-and-features/integrations/README.md)
-  * [Webhooks](admin-and-features/integrations/webhooks.md)
-  * [REST API](admin-and-features/integrations/api-tokens.md)
+* [Activity & Audit logs](activity-log/README.md)
+  * [Audit Log Streaming to SIEM systems](activity-log/activity-log-streaming/README.md)
+    * [Supported SIEM systems integrations](activity-log/activity-log-streaming/activity-log-integrations/README.md)
+      * [Vector integration guide](activity-log/activity-log-streaming/activity-log-integrations/vector-integration-guide.md)
+      * [Logstash integration guide](activity-log/activity-log-streaming/activity-log-integrations/logstash-integration-guide.md)
+* [Notifications](notifications/README.md)
+  * [Email notifications](notifications/setting-up-smtp-for-email-notifications.md)
+  * [Gateway notifications](notifications/gateway-notifications.md)
+  * [New version notifications](notifications/new-version-notifications.md)
+* [Integrations](integrations/README.md)
+  * [Webhooks](integrations/webhooks.md)
+  * [REST API](integrations/api-tokens.md)
 * [OPSense Configuartion](admin-and-features/setting-up-your-instance/gateway/README.md)
 * [SSH Authentication](admin-and-features/ssh-authentication.md)
 * [Forward auth](admin-and-features/forward-auth.md)
 * [YubiKey Provisioning](admin-and-features/yubikey-provisioning.md)
-* [User SNAT bindings](admin-and-features/user-snat-bindings.md)
+* [User SNAT bindings](user-snat-bindings.md)
 
 ## Deployment strategies
 
diff --git a/activity-log/README.md b/activity-log/README.md
@@ -12,7 +12,7 @@ Activity log is available as a dedicated page in Defguard core Web UI that's use
 
 To access it click the `Activity log` button in the navbar.
 
-<figure><img src="../../.gitbook/assets/image.png" alt=""><figcaption><p>Activity log page</p></figcaption></figure>
+<figure><img src="../.gitbook/assets/image.png" alt=""><figcaption><p>Activity log page</p></figcaption></figure>
 
 ### Overview
 
@@ -35,12 +35,12 @@ Currently there are four modules:
 
 * **Defguard** - operations performed in the core Web UI (e.g. adding users, modifying devices, managing groups etc.)
 * **Client** - actions performed by desktop client applications
-* **Enrollment** - events related to the [user enrollment](../../help/enrollment/) process
+* **Enrollment** - events related to the [user enrollment](../help/enrollment/) process
 * **VPN -** events related to VPN clients (e.g. client connecting to a location)
 
 ### Filtering
 
-<figure><img src="../../.gitbook/assets/image (1).png" alt=""><figcaption><p>Event filter modal</p></figcaption></figure>
+<figure><img src="../.gitbook/assets/image (1).png" alt=""><figcaption><p>Event filter modal</p></figcaption></figure>
 
 By clicking the `Filter` button above the list you can narrow down the displayed events based on following criteria:
 
@@ -52,7 +52,7 @@ For each of those you can select multiple options.
 
 Filtering by date can be done by clicking the `Time range` button above the list.
 
-<figure><img src="../../.gitbook/assets/image (2).png" alt=""><figcaption><p>Time range filter modal</p></figcaption></figure>
+<figure><img src="../.gitbook/assets/image (2).png" alt=""><figcaption><p>Time range filter modal</p></figcaption></figure>
 
 ### Sorting
 
diff --git a/activity-log/activity-log-streaming/README.md b/activity-log/activity-log-streaming/README.md
@@ -8,7 +8,7 @@ description: >-
 # Audit Log Streaming to SIEM systems
 
 {% hint style="warning" %}
-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).
+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).
 {% endhint %}
 
 {% hint style="info" %}
diff --git a/activity-log/activity-log-streaming/activity-log-integrations/README.md b/activity-log/activity-log-streaming/activity-log-integrations/README.md
@@ -2,7 +2,7 @@
 description: List of supported services to stream activity logs into.
 ---
 
-# Activity log integrations
+# Supported SIEM systems integrations
 
 {% hint style="info" %}
 We're actively working to expand support for additional SIEM and log management platforms. If your organization uses a tool that's not currently supported, we welcome your feedback—user requests help us prioritize future integrations.
diff --git a/activity-log/activity-log-streaming/activity-log-integrations/logstash-integration-guide.md b/activity-log/activity-log-streaming/activity-log-integrations/logstash-integration-guide.md
@@ -40,15 +40,15 @@ Add Logstash service to the `docker-compose.yaml` and start it.
 
 ### Add Logstash destination
 
-In Defguard UI with an administrator account, go into  settings page and choose `Activity log streaming`.
+In Defguard UI with an administrator account, go into settings page and choose `Activity log streaming`.
 
 Click `Add new` and choose `Vector` destination.
 
-<figure><img src="../../../../.gitbook/assets/image (111).png" alt=""><figcaption></figcaption></figure>
+<figure><img src="../../../.gitbook/assets/image (111).png" alt=""><figcaption></figcaption></figure>
 
 Fill out `Name` and `Url` fields and click **Submit**.
 
-<figure><img src="../../../../.gitbook/assets/image (112).png" alt=""><figcaption></figcaption></figure>
+<figure><img src="../../../.gitbook/assets/image (112).png" alt=""><figcaption></figcaption></figure>
 
 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.
 
@@ -78,7 +78,7 @@ output {
 
 Modify Logstash destination in settings and fill`username` and `password` in settings.
 
-<figure><img src="../../../../.gitbook/assets/image (113).png" alt=""><figcaption></figcaption></figure>
+<figure><img src="../../../.gitbook/assets/image (113).png" alt=""><figcaption></figcaption></figure>
 
 ### Logstash integration configuration
 
diff --git a/activity-log/activity-log-streaming/activity-log-integrations/vector-integration-guide.md b/activity-log/activity-log-streaming/activity-log-integrations/vector-integration-guide.md
@@ -58,17 +58,17 @@ INFO vector::app: Loading configs. paths=["/etc/vector/vector.toml"]
 
 ### Add Vector destination
 
-In Defguard UI with an administrator account, go into  settings page and choose `Activity log streaming`.
+In Defguard UI with an administrator account, go into settings page and choose `Activity log streaming`.
 
 Click `Add new` and choose `Vector` destination.
 
-<figure><img src="../../../../.gitbook/assets/image (107).png" alt=""><figcaption></figcaption></figure>
+<figure><img src="../../../.gitbook/assets/image (107).png" alt=""><figcaption></figcaption></figure>
 
 Fill out `Name` and `Url` of the form and click `Submit`.
 
 If your `defguard` instance is running in the same Docker Compose network as Vector, use `http://vector:8001` as the URL instead of `http://127.0.0.1`, since services in the same Compose network communicate by container name.
 
-<figure><img src="../../../../.gitbook/assets/image (108).png" alt=""><figcaption></figcaption></figure>
+<figure><img src="../../../.gitbook/assets/image (108).png" alt=""><figcaption></figcaption></figure>
 
 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.
 
@@ -93,7 +93,7 @@ sources:
 
 Next, add the configured `username` and `password` in Defguard settings to the Vector destination.
 
-<figure><img src="../../../../.gitbook/assets/image (109).png" alt=""><figcaption></figcaption></figure>
+<figure><img src="../../../.gitbook/assets/image (109).png" alt=""><figcaption></figcaption></figure>
 
 ### TLS
 
@@ -139,9 +139,8 @@ sources:
 
 Next, copy the contents of `cert.pem` into the **Certificate** field in the Vector destination settings. Then, update the **URL** field to use the `https` scheme instead of `http`.
 
-<figure><img src="../../../../.gitbook/assets/image (110).png" alt=""><figcaption></figcaption></figure>
+<figure><img src="../../../.gitbook/assets/image (110).png" alt=""><figcaption></figcaption></figure>
 
 ### Vector integration configuration
 
 <table data-full-width="true"><thead><tr><th>Name</th><th width="203.7999267578125">Example value</th><th width="111.199951171875" data-type="checkbox">Required</th><th width="179">Vector related configuration</th><th>Description</th></tr></thead><tbody><tr><td>Name</td><td>Vector</td><td>true</td><td></td><td>Assigned name for the destination.</td></tr><tr><td>Url</td><td>http(s)://127.0.0.1:8001</td><td>true</td><td><a href="https://vector.dev/docs/reference/configuration/sources/http_server/#address">address</a></td><td>Address of running vector HTTP source.</td></tr><tr><td>Username</td><td>vector</td><td>false</td><td><a href="https://vector.dev/docs/reference/configuration/sources/http_server/#auth.username">auth.username</a></td><td>username for Basic Authentication</td></tr><tr><td>Password</td><td>strongPassword</td><td>false</td><td><a href="https://vector.dev/docs/reference/configuration/sources/http_server/#auth.password">auth.password</a></td><td>password for Basic Authentication</td></tr><tr><td>Cert</td><td>contents of cert.pem</td><td>false</td><td><a href="https://vector.dev/docs/reference/configuration/sources/http_server/#tls">tls</a></td><td>Used for TLS connection</td></tr></tbody></table>
-
diff --git a/admin-and-features/external-openid-providers/custom.md b/admin-and-features/external-openid-providers/custom.md
@@ -1,7 +1,3 @@
----
-hidden: true
----
-
 # Custom
 
 {% hint style="warning" %}
diff --git a/admin-and-features/external-openid-providers/google.md b/admin-and-features/external-openid-providers/google.md
@@ -1,7 +1,3 @@
----
-hidden: true
----
-
 # Google
 
 {% hint style="info" %}
diff --git a/admin-and-features/external-openid-providers/jumpcloud.md b/admin-and-features/external-openid-providers/jumpcloud.md
@@ -1,7 +1,3 @@
----
-hidden: true
----
-
 # JumpCloud
 
 1. Login to your JumpCloud admin account.
diff --git a/admin-and-features/external-openid-providers/keycloak.md b/admin-and-features/external-openid-providers/keycloak.md
@@ -1,7 +1,3 @@
----
-hidden: true
----
-
 # Keycloak
 
 A basic guide about securing applications using Keycloack can be found [here](https://www.keycloak.org/getting-started/getting-started-docker#_secure_the_first_application).
diff --git a/admin-and-features/external-openid-providers/microsoft.md b/admin-and-features/external-openid-providers/microsoft.md
@@ -1,7 +1,3 @@
----
-hidden: true
----
-
 # Microsoft
 
 1. Go to [https://portal.azure.com/](https://portal.azure.com)
diff --git a/admin-and-features/external-openid-providers/okta.md b/admin-and-features/external-openid-providers/okta.md
@@ -1,7 +1,3 @@
----
-hidden: true
----
-
 # Okta
 
 1. First, navigate in your Okta dashboard to "Applications" and create a new app integration here:
diff --git a/admin-and-features/external-openid-providers/zitadel.md b/admin-and-features/external-openid-providers/zitadel.md
@@ -1,7 +1,3 @@
----
-hidden: true
----
-
 # Zitadel
 
 {% hint style="info" %}
diff --git a/admin-and-features/remote-user-enrollment/README.md b/admin-and-features/remote-user-enrollment/README.md
@@ -17,7 +17,7 @@ Please also see the relevant configuration options for [core](../../configuratio
 ## Enrollment settings
 
 {% hint style="warning" %}
-In order for the enrollment process to function correctly you must also [set up an SMTP server](../notifications/setting-up-smtp-for-email-notifications.md) for delivering email notifications.
+In order for the enrollment process to function correctly you must also [set up an SMTP server](../../notifications/setting-up-smtp-for-email-notifications.md) for delivering email notifications.
 {% endhint %}
 
 As an admin, you can configure enrollment-related settings on the **Enrollment** page. This includes:
diff --git a/admin-and-features/wireguard/create-your-vpn-network.md b/admin-and-features/wireguard/create-your-vpn-network.md
@@ -116,7 +116,7 @@ Each connection in the client:
 For this feature to work, the user must:
 
 1. configure their [TOTP settings in the profile](../../help/setting-up-2fa-mfa.md#one-time-password)
-2. [SMTP settings needs to be set up](../notifications/setting-up-smtp-for-email-notifications.md) and the user must enable Email tokens in their profile.
+2. [SMTP settings needs to be set up](../../notifications/setting-up-smtp-for-email-notifications.md) and the user must enable Email tokens in their profile.
 {% endhint %}
 
 #### Keepalive interval
diff --git a/admin-and-features/wireguard/multi-factor-authentication-mfa-2fa/README.md b/admin-and-features/wireguard/multi-factor-authentication-mfa-2fa/README.md
@@ -49,7 +49,7 @@ If a VPN has MFA enabled, before connecting you will be asked to complete the au
 For now, MFA is only available with the following methods:
 
 * [TOTP - Time-based one-time password](../../../help/setting-up-2fa-mfa.md#one-time-password)
-* Email - requires [SMTP to be configured](../../notifications/setting-up-smtp-for-email-notifications.md)
+* Email - requires [SMTP to be configured](../../../notifications/setting-up-smtp-for-email-notifications.md)
 
 {% hint style="warning" %}
 Please remember to configure TOTP on you user account and/or SMTP settings for MFA on the desktop client to work..
diff --git a/enterprise/enterprise-features.md b/enterprise/enterprise-features.md
@@ -7,10 +7,10 @@ Here is a list of all Enterprise features:
 * [Two-way LDAP & Active Directory synchronization](../admin-and-features/ldap-and-active-directory-integration/two-way-ldap-and-active-directory-synchronization.md)
 * [Real time sync for client configurations](../admin-and-features/remote-user-enrollment/automatic-real-time-desktop-client-configuration.md)! **First WireGuard client to support this feature!**
 * Ability to define and enforce [Access Control List rules](../admin-and-features/access-control-list/) / firewall management
-* Ability to [stream the Activity & Audit logs to external SIEM systems](../admin-and-features/activity-log/activity-log-streaming/)
+* Ability to [stream the Activity & Audit logs to external SIEM systems](../activity-log/activity-log-streaming/)
 * Ability to use [external OIDC for secure remote enrollment and Desktop client configuration](../admin-and-features/external-openid-providers/external-oidc-secure-enrollment.md)
 * Ability to [disable for users to manage their devices](../admin-and-features/wireguard/behavior-customization.md#disable-for-users-to-manage-their-devices) (just admin will have this possibility).
 * Ability to [disable for users to configure WireGuard clients other then defguard desktop client](../admin-and-features/wireguard/behavior-customization.md#disable-ability-to-configure-other-vpn-clients-then-defguard-desktop-client).
 * Ability to [disable "All traffic" in the desktop client ](../admin-and-features/wireguard/behavior-customization.md#disable-all-traffic-option-in-the-desktop-client)- just "predefined" traffic by admins.
-* Ability to integrate with external tooling using [REST API](../admin-and-features/integrations/api-tokens.md).
+* Ability to integrate with external tooling using [REST API](../integrations/api-tokens.md).
 
diff --git a/integrations/README.md b/integrations/README.md
diff --git a/integrations/api-tokens.md b/integrations/api-tokens.md
@@ -1,14 +1,14 @@
 # REST API
 
 {% hint style="warning" %}
-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).
+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).
 {% endhint %}
 
 {% hint style="warning" %}
 API functionality:
 
 1. requires Defguard version 1.2.4+
-2. is also **available without enterprise license**, if your instance does not exceed the limits [described here](../../enterprise/license.md#enterprise-is-free-up-to-certain-limits).
+2. is also **available without enterprise license**, if your instance does not exceed the limits [described here](../enterprise/license.md#enterprise-is-free-up-to-certain-limits).
 {% endhint %}
 
 ## REST API documentation
@@ -27,19 +27,19 @@ Tokens retain the same access permissions as their owner, so be careful when sha
 
 To generate a new API token go to your profile page and click the `Add new API Token`button:
 
-<figure><img src="../../.gitbook/assets/image (62).png" alt=""><figcaption></figcaption></figure>
+<figure><img src="../.gitbook/assets/image (62).png" alt=""><figcaption></figcaption></figure>
 
 Fill in your chosen token name and submit form:
 
-<figure><img src="../../.gitbook/assets/image (64).png" alt=""><figcaption></figcaption></figure>
+<figure><img src="../.gitbook/assets/image (64).png" alt=""><figcaption></figcaption></figure>
 
 Copy generated token. This is the only time the token will be available in plain text form. If you lose it you will have to generate a new one.
 
-<figure><img src="../../.gitbook/assets/image (65).png" alt=""><figcaption></figcaption></figure>
+<figure><img src="../.gitbook/assets/image (65).png" alt=""><figcaption></figcaption></figure>
 
 In the API token list you can later rename or delete a token:
 
-<figure><img src="../../.gitbook/assets/image (66).png" alt=""><figcaption></figcaption></figure>
+<figure><img src="../.gitbook/assets/image (66).png" alt=""><figcaption></figcaption></figure>
 
 ## Usage
 
diff --git a/integrations/webhooks.md b/integrations/webhooks.md
@@ -8,7 +8,7 @@ Basic idea of webhooks is to send user data to external systems in order to auto
 
 On the left side of Defguard navigation you'll find webhooks page
 
-![New webhook form](../../.gitbook/assets/webhookform.png)
+![New webhook form](../.gitbook/assets/webhookform.png)
 
 On above form you'll see inputs like URL description token and triggers
 
diff --git a/notifications/README.md b/notifications/README.md
diff --git a/notifications/gateway-notifications.md b/notifications/gateway-notifications.md
@@ -10,7 +10,7 @@ You can configure automatic e-mail notifications when one of your gateways disco
 
 In order to configure the notifications, navigate to the "Gateway notifications" settings tab.
 
-<figure><img src="../../.gitbook/assets/image (1) (1) (1) (1) (1) (1) (1) (1).png" alt=""><figcaption></figcaption></figure>
+<figure><img src="../.gitbook/assets/image (1) (1) (1) (1) (1) (1) (1) (1).png" alt=""><figcaption></figcaption></figure>
 
 The configuration options are as follows:
 
diff --git a/notifications/new-version-notifications.md b/notifications/new-version-notifications.md
@@ -2,11 +2,11 @@
 
 Defguard will periodically (every 6 hours) check for a new version, If there is one that is newer than the current one, a toast will be displayed in the admin dashboard.
 
-<figure><img src="../../.gitbook/assets/image (55).png" alt=""><figcaption></figcaption></figure>
+<figure><img src="../.gitbook/assets/image (55).png" alt=""><figcaption></figcaption></figure>
 
 You can display the release notes by clicking "See what's new".
 
-<figure><img src="../../.gitbook/assets/image (56).png" alt=""><figcaption></figcaption></figure>
+<figure><img src="../.gitbook/assets/image (56).png" alt=""><figcaption></figcaption></figure>
 
 If the update is considered critical (e.g. fixes a vulnerability) it will have the "critical update" badge.
 
diff --git a/notifications/setting-up-smtp-for-email-notifications.md b/notifications/setting-up-smtp-for-email-notifications.md
@@ -1,4 +1,4 @@
-# SMTP for email notifications
+# Email notifications
 
 In **Settings > SMTP** tab you can setup a connection to an SMTP server.
 
diff --git a/resources/troubleshooting/sending-support-info.md b/resources/troubleshooting/sending-support-info.md
diff --git a/user-snat-bindings.md b/user-snat-bindings.md
