GITBOOK-412: New documentation structure #2

Author: defguard-community

README.md

@@ -8,14 +8,14 @@ Welcome to the Defguard documentation. Here, you'll learn how to explore the ful
   Briefly describes defguard and its features.
 * [Getting started](broken-reference)\
   Lets you quickly set up your own defguard instance to explore its features an user interface.
-* [Admin features](broken-reference)\
+* [Features and configuration](broken-reference)\
   Helps you, as a future defguard administrator, get familiar with all of defguard's features and how to configure them to suit your needs.
-* [User features](broken-reference)\
-  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.
-* [Enterprise features](enterprise/license.md)\
-  Covers the advanced features available in the enterprise version of defguard, including how to purchase an enterprise license and the additional benefits it provides.
 * [Deployment strategies](broken-reference)\
   Walks you through the most common deployment strategies to help you set up your defguard instance as a production-grade solution.
+* [Enterprise](broken-reference)\
+  Outlines the benefits, terms, and purchasing process for the Defguard Enterprise license.
+* [Using defguard (for end users)](broken-reference)\
+  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.
 * [Tutorials](broken-reference)\
   A collection of step-by-step guides with clear examples and helpful screenshots to make the setup process smooth and enjoyable.
 * [In depth](broken-reference)\

SUMMARY.md

@@ -12,7 +12,7 @@
 
 * [One-line install script](getting-started/one-line-install.md)
 
-## Admin Features <a href="#admin-and-features" id="admin-and-features"></a>
+## Features <a href="#admin-and-features" id="admin-and-features"></a>
 
 * [Overview](admin-and-features/overview.md)
 * [Zero-Trust VPN with 2FA/MFA](admin-and-features/wireguard/README.md)
@@ -23,8 +23,10 @@
     * [MFA Architecture](admin-and-features/wireguard/multi-factor-authentication-mfa-2fa/architecture.md)
   * [Remote desktop client configuration](admin-and-features/wireguard/remote-desktop-activation.md)
   * [DNS and domains](admin-and-features/wireguard/dns-and-domains.md)
+  * [VPN & Client behavior customization](admin-and-features/wireguard/behavior-customization.md)
 * [Remote user enrollment](admin-and-features/remote-user-enrollment/README.md)
   * [User onboarding after enrollment](admin-and-features/remote-user-enrollment/user-onboarding-after-enrollment.md)
+  * [Automatic (real time) desktop client configuration & sync](admin-and-features/remote-user-enrollment/automatic-real-time-desktop-client-configuration.md)
 * [SSO (OpenID Connect)](admin-and-features/openid-connect/README.md)
   * [Portainer](admin-and-features/openid-connect/portainer.md)
   * [Grafana setup](admin-and-features/openid-connect/grafana-setup.md)
@@ -33,63 +35,45 @@
   * [Django](admin-and-features/openid-connect/django.md)
   * [MinIO](admin-and-features/openid-connect/minio.md)
   * [Vault](admin-and-features/openid-connect/vault.md)
-* [SMTP for email notifications](admin-and-features/setting-up-smtp-for-email-notifications.md)
-* [YubiKey Provisioning](admin-and-features/yubikey-provisioning.md)
-* [Webhooks](admin-and-features/webhooks.md)
-* [Forward auth](admin-and-features/forward-auth.md)
+* [LDAP and Active Directory integration](admin-and-features/ldap-and-active-directory-integration/README.md)
+  * [Configuration](admin-and-features/ldap-and-active-directory-integration/configuration.md)
+  * [Settings table](admin-and-features/ldap-and-active-directory-integration/settings-table.md)
+  * [Two-way LDAP and Active Directory synchronization](admin-and-features/ldap-and-active-directory-integration/two-way-ldap-and-active-directory-synchronization.md)
+* [Access Control List](admin-and-features/access-control-list/README.md)
+  * [ACL Aliases](admin-and-features/access-control-list/acl-aliases.md)
+  * [Implementation Details](admin-and-features/access-control-list/firewall-internals.md)
+* [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)
+  * [Custom](admin-and-features/external-openid-providers/custom.md)
+  * [External OIDC secure enrollment](admin-and-features/external-openid-providers/external-oidc-secure-enrollment.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)
 * [Network devices](admin-and-features/network-devices.md)
-* [Activity & Audit logs](admin-and-features/activity-log.md)
-* [Gateway notifications](admin-and-features/gateway-notifications.md)
-* [New version notifications](admin-and-features/new-version-notifications.md)
-
-## User features <a href="#help" id="help"></a>
 
-* [Overwiew](help/overwiew.md)
-* [Desktop Client](help/desktop-client.md)
-* [CLI Client](help/cli-client.md)
-* [Configuring VPN](help/configuring-vpn/README.md)
-  * [Defguard Desktop Client](help/configuring-vpn/add-new-instance/README.md)
-    * [Update instance](help/configuring-vpn/add-new-instance/update-instance.md)
-  * [Other WireGuard® Clients](help/configuring-vpn/adding-wireguard-devices/README.md)
-    * [Configuring a device for new VPN Location manually](help/configuring-vpn/adding-wireguard-devices/configuring-a-device-for-a-new-vpn-location.md)
-* [Password change / Reset](help/changing-your-password.md)
-* [Enrollment & Onboarding](help/enrollment/README.md)
-  * [With internal Defguard SSO](help/enrollment/with-internal-defguard-sso.md)
-  * [With external SSO (Google/Microsoft/Custom)](help/enrollment/with-external-sso-google-microsoft-custom.md)
-* [Setting up 2FA/MFA](help/setting-up-2fa-mfa.md)
+***
 
-## Enterprise Features <a href="#enterprise" id="enterprise"></a>
-
-* [Overview](enterprise/license.md)
-* [Enteprise features](enterprise/all-enteprise-features/README.md)
-  * [Automatic (real time) desktop client configuration & sync](enterprise/all-enteprise-features/automatic-real-time-desktop-client-configuration.md)
-  * [External OpenID providers](enterprise/all-enteprise-features/external-openid-providers/README.md)
-    * [Google](enterprise/all-enteprise-features/external-openid-providers/google.md)
-    * [Microsoft](enterprise/all-enteprise-features/external-openid-providers/microsoft.md)
-    * [Zitadel](enterprise/all-enteprise-features/external-openid-providers/zitadel.md)
-    * [Keycloak](enterprise/all-enteprise-features/external-openid-providers/keycloak.md)
-    * [JumpCloud](enterprise/all-enteprise-features/external-openid-providers/jumpcloud.md)
-    * [Okta](enterprise/all-enteprise-features/external-openid-providers/okta.md)
-    * [Custom](enterprise/all-enteprise-features/external-openid-providers/custom.md)
-  * [External OIDC secure enrollment](enterprise/all-enteprise-features/external-oidc-secure-enrollment.md)
-  * [VPN & Client behavior customization](enterprise/all-enteprise-features/behavior-customization.md)
-  * [Access Control List](enterprise/all-enteprise-features/access-control-list/README.md)
-    * [ACL Aliases](enterprise/all-enteprise-features/access-control-list/acl-aliases.md)
-    * [Implementation Details](enterprise/all-enteprise-features/access-control-list/firewall-internals.md)
-  * [Audit Log Streaming to SIEM systems](enterprise/all-enteprise-features/activity-log-streaming/README.md)
-    * [Supported SIEM systems integrations](enterprise/all-enteprise-features/activity-log-streaming/activity-log-integrations/README.md)
-      * [Vector integration guide](enterprise/all-enteprise-features/activity-log-streaming/activity-log-integrations/vector-integration-guide.md)
-      * [Logstash integration guide](enterprise/all-enteprise-features/activity-log-streaming/activity-log-integrations/logstash-integration-guide.md)
-  * [LDAP and Active Directory integration](enterprise/all-enteprise-features/ldap-and-active-directory-integration/README.md)
-    * [Configuration](enterprise/all-enteprise-features/ldap-and-active-directory-integration/configuration.md)
-    * [Settings table](enterprise/all-enteprise-features/ldap-and-active-directory-integration/settings-table.md)
-    * [Two-way LDAP and Active Directory synchronization](enterprise/all-enteprise-features/ldap-and-active-directory-integration/two-way-ldap-and-active-directory-synchronization.md)
-  * [REST API](enterprise/all-enteprise-features/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)
 
 ## Deployment strategies
 
-* [Prerequisites](deployment-strategies/setting-up-your-instance.md)
+* [Overview](deployment-strategies/setting-up-your-instance.md)
 * [Standalone package based installation](deployment-strategies/standalone-package-based-installation.md)
 * [Docker images and tags](deployment-strategies/docker-images-and-tags.md)
 * [Docker Compose](deployment-strategies/docker-compose.md)
@@ -100,14 +84,34 @@
 * [Pre-production and development releases](deployment-strategies/pre-production-and-development-releases.md)
 * [Gateway](deployment-strategies/gateway/README.md)
   * [Running gateway on MikroTik routers](deployment-strategies/gateway/running-gateway-on-mikrotik-routers.md)
+* [Securing gRPC communication](deployment-strategies/grpc-ssl-communication.md)
 
 ***
 
-* [Securing gRPC communication](grpc-ssl-communication.md)
 * [OpenID RSA key](openid-rsa-key.md)
 * [Health check](health-check.md)
 * [Configuration](configuration.md)
 
+## Enterprise
+
+* [License](enterprise/license.md)
+
+## Using defguard (for end users) <a href="#help" id="help"></a>
+
+* [Overwiew](help/overwiew.md)
+* [Desktop Client](help/desktop-client.md)
+* [CLI Client](help/cli-client.md)
+* [Configuring VPN](help/configuring-vpn/README.md)
+  * [Defguard Desktop Client](help/configuring-vpn/add-new-instance/README.md)
+    * [Update instance](help/configuring-vpn/add-new-instance/update-instance.md)
+  * [Other WireGuard® Clients](help/configuring-vpn/adding-wireguard-devices/README.md)
+    * [Configuring a device for new VPN Location manually](help/configuring-vpn/adding-wireguard-devices/configuring-a-device-for-a-new-vpn-location.md)
+* [Password change / Reset](help/changing-your-password.md)
+* [Enrollment & Onboarding](help/enrollment/README.md)
+  * [With internal Defguard SSO](help/enrollment/with-internal-defguard-sso.md)
+  * [With external SSO (Google/Microsoft/Custom)](help/enrollment/with-external-sso-google-microsoft-custom.md)
+* [Setting up 2FA/MFA](help/setting-up-2fa-mfa.md)
+
 ## Tutorials
 
 * [Step by step setting up a VPN server](tutorials/step-by-step-setting-up-a-vpn-server/README.md)

about/about-defguard.md

@@ -36,7 +36,7 @@ Of course you can deploy defguard in a typical scenario (all services on one ser
 
 Incorporating IDM, ALM, VPN has also other advantages:
 
-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](../enterprise/all-enteprise-features/external-openid-providers/) (Google/Microsoft/Custom - which defguard supports), we still use our internal IdP for 2FA/MFA.
+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.
 2. Your organization may use just **one account** (login) for access control to all your applications as well as VPN.
 3. It simplifies deployment, maintenance, audits.
 

about/features-overview.md

@@ -16,7 +16,7 @@ _defguard is not an official WireGuard project, and WireGuard is a registered tr
 ### Identity Management:
 
 * #### [OpenID Connect](https://openid.net/developers/how-connect-works/) based SSO
-* External [OpenID providers for login/account creation (Google/Microsoft/Custom)](../enterprise/all-enteprise-features/external-openid-providers/)
+* External [OpenID providers for login/account creation (Google/Microsoft/Custom)](../admin-and-features/external-openid-providers/)
 * LDAP (tested on [OpenLDAP](https://www.openldap.org/)) synchronization
 * nice UI to manage users
 * Users **self-service** (besides typical data management, users can revoke access to granted apps, MFA, Wireguard, etc.)

admin-and-features/activity-log.md activity-log/README.mdadmin-and-features/activity-log.md renamed to 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.)&#x20;
 * **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:&#x20;
 
@@ -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
 
@@ -121,5 +121,5 @@ At the moment following events are tracked in the Activity log:
 
 ## Streaming to external SIEM systems
 
-Please note, that enterprise version supports streaming of audit logs to e[xternal SIEM systems. More on this topic in dedicated documentation section](../../enterprise/all-enteprise-features/activity-log-streaming/).
+Please note, that enterprise version supports streaming of audit logs to e[xternal SIEM systems. More on this topic in dedicated documentation section](activity-log-streaming/).
 

…eatures/activity-log-streaming/README.md …ity-log/activity-log-streaming/README.mdenterprise/all-enteprise-features/activity-log-streaming/README.md renamed to activity-log/activity-log-streaming/README.md enterprise/all-enteprise-features/activity-log-streaming/README.md renamed to activity-log/activity-log-streaming/README.md

@@ -3,10 +3,13 @@ description: >-
   This feature is designed to help teams centralize visibility into user
   actions, security events, and system behavior by integrating with tools they
   already use for monitoring and incident response.
-icon: notebook
 ---
 
-# Activity Log Streaming
+# 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).
+{% endhint %}
 
 {% hint style="info" %}
 This feature is available starting from version 1.4