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

Author: defguard-community

SUMMARY.md

@@ -13,28 +13,25 @@
 * [Password change / Reset](help/changing-your-password.md)
 * [Setting up 2FA/MFA](help/setting-up-2fa-mfa.md)
 * [Desktop Client](help/desktop-client/README.md)
-  * [General troubleshooting](help/desktop-client/general-troubleshooting.md)
   * [Windows installer exit codes](help/desktop-client/windows-installer-exit-codes.md)
-  * [Upgrading](help/desktop-client/upgrading.md)
 
 ## Admin & features
 
 * [Troubleshooting Guide](admin-and-features/troubleshooting/README.md)
   * [Sending support information](admin-and-features/troubleshooting/sending-support-info.md)
 * [Deploying your instance](features/setting-up-your-instance/README.md)
+  * [Upgrading](features/setting-up-your-instance/upgrading.md)
   * [One-line install script](features/setting-up-your-instance/one-line-install.md)
   * [Standalone package based installation](admin-and-features/setting-up-your-instance/standalone-package-based-installation.md)
-  * [Securing gRPC communication](admin-and-features/setting-up-your-instance/grpc-ssl-communication.md)
-  * [OpenID RSA key](admin-and-features/setting-up-your-instance/openid-rsa-key.md)
-  * [Configuration](features/setting-up-your-instance/configuration.md)
   * [Docker images and tags](admin-and-features/setting-up-your-instance/docker-images-and-tags.md)
   * [Docker Compose](features/setting-up-your-instance/docker-compose.md)
   * [Kubernetes](community-features/setting-up-your-instance/kubernetes.md)
   * [Gateway](admin-and-features/setting-up-your-instance/gateway/README.md)
     * [Running gateway on MikroTik routers](admin-and-features/setting-up-your-instance/gateway/running-gateway-on-mikrotik-routers.md)
+  * [Securing gRPC communication](admin-and-features/setting-up-your-instance/grpc-ssl-communication.md)
+  * [OpenID RSA key](admin-and-features/setting-up-your-instance/openid-rsa-key.md)
+  * [Configuration](features/setting-up-your-instance/configuration.md)
   * [Pre-production and development releases](admin-and-features/setting-up-your-instance/pre-production-and-development-releases.md)
-  * [OpenID RSA Certificates](admin-and-features/setting-up-your-instance/openid-rsa-certificates.md)
-  * [Upgrading](features/setting-up-your-instance/upgrading.md)
   * [High Availability and Failover](admin-and-features/setting-up-your-instance/high-availability-and-failover.md)
   * [Health check](features/setting-up-your-instance/health-check.md)
 * [Remote user enrollment](features/remote-user-enrollment/README.md)

admin-and-features/setting-up-your-instance/docker-images-and-tags.md

@@ -1,3 +1,7 @@
+---
+icon: container-storage
+---
+
 # Docker images and tags
 
 All docker images for gateway, core and proxy have these aditional tags:

admin-and-features/setting-up-your-instance/high-availability-and-failover.md

@@ -1,3 +1,7 @@
+---
+icon: bolt
+---
+
 # High Availability and Failover
 
 Currently we support the following HA/failover scenarios:

admin-and-features/setting-up-your-instance/openid-rsa-certificates.md

@@ -1,3 +1,7 @@
+---
+icon: box-taped
+---
+
 # Standalone package based installation
 
 ## Introduction
@@ -656,7 +660,7 @@ DEFGUARD_DB_PASSWORD="defguard"
 DATABASE_URL="postgresql://defguard:defguard@localhost/defguard"
 ```
 
- Reload changes in `/etc/defguarc/core.conf`
+Reload changes in `/etc/defguarc/core.conf`
 
 ```
 systemctl restart defguard.service

admin-and-features/setting-up-your-instance/standalone-package-based-installation.md

@@ -22,6 +22,18 @@ Common problems may be:
 
 See the "[Desktop client real-time/auto sync doesn't work](./#desktop-client-real-time-auto-sync-doesnt-work)" answer.
 
+## Client: failed to configure DNS (Linux)
+
+This error commonly occurs on Ubuntu 22. Defguard client internally calls `resolvconf` to set DNS servers. The only tested backend is `systemd-resolved`, so make sure you use it before proceeding further (`systemctl status systemd-resolved`). 
+
+On newer Ubuntu distributions (23 and up) `resolvconf` is, by default, a symbolic link to `resolvectl` and this is the recommended way of interacting with the system's DNS configuration. On Ubuntu 22 the symbolic link doesn't exist and the most straightforward way to fix this issue is to manually create it:
+
+```bash
+sudo ln -s /usr/bin/resolvectl /usr/sbin/resolvconf
+```
+
+If this fails, one may also try installing one of the packages providing the `resolvconf` command, like `openresolv` or `resolvconf` but this has not been tested and may possibly cause issues with `systemd-resolved`, so proceed at your own risk.
+
 ## TOTP / Email codes for MFA do not work
 
 If you are having problems with TOTP codes form 2FA/MFA (when logging in to defguard or when connecting to VPN) please make sure your clock on the server that defguard core is running is set properly.

admin-and-features/troubleshooting/README.md

@@ -1,3 +1,7 @@
+---
+icon: truck-container
+---
+
 # Docker Compose
 
 Here are basic and simple docker-compose configuration files that will enable you to quickly deploy your own instance manually. We also assume in this example, that all services will deployed on dedicated servers/VMs - separating them physically, thus each compose is for a separate service.

features/setting-up-your-instance/docker-compose.md

@@ -1,3 +1,7 @@
+---
+icon: stethoscope
+---
+
 # Health check
 
 ## Core & Proxy

features/setting-up-your-instance/health-check.md

@@ -1,3 +1,7 @@
+---
+icon: rocket
+---
+
 # One-line install script
 
 {% hint style="info" %}

features/setting-up-your-instance/one-line-install.md

@@ -1,5 +1,6 @@
 ---
 description: Notes on upgrading Defguard and its components
+icon: chevrons-up
 ---
 
 # Upgrading
@@ -80,3 +81,10 @@ defguard | 2024-01-24T14:17:47.815294Z  INFO defguard::grpc: Connecting to proxy
 proxy_1  | 2024-01-24T14:17:47.819504Z  INFO defguard_proxy: RPC client connected from: 10.123.123.2:35916
 ```
 
+## Desktop Client 0.1.x -> 0.2.0
+
+With this release we have added Multi-Factor Authentication  to the desktop client. Unfortunately desktop client database has change significantly as well as business logic (for example endpoints to proxy for MFA handshake). We have not stored them previously in the database - thus they cannot be recovered/updated automatically.
+
+{% hint style="warning" %}
+That unfortunately means you have to remove all your instances before upgrading (or just remove any desktop client configuration files, including the database) and start the enrollment (adding new instance) again after upgrading - just by adding a new device (you can remove the old one).
+{% endhint %}