From 1172d2e816c0b338ac17abc617776e022f518946 Mon Sep 17 00:00:00 2001
From: Jacek Chmielewski <jchmielewski@teonite.com>
Date: Fri, 19 Apr 2024 08:17:07 +0200
Subject: [PATCH] Add known-issues section to README

---
 README.md | 21 ++++++++++++++++++++-
 1 file changed, 20 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index cf32613f..1bd1e628 100644
--- a/README.md
+++ b/README.md
@@ -2,7 +2,7 @@
     <img src="docs/header.png" alt="defguard">
  </p>
 
-# defguard desktop client
+# Defguard desktop client
 
 Desktop client for managing WireGuard VPN connections (any WireGuard server and [defguard](https://github.com/DefGuard/defguard) instances).
 
@@ -53,6 +53,25 @@ Built packages are available after in `src-tauri/target/release/bundle`.
 
 Remove `default-run` line from `[package]` section in `Cargo.toml` to build the project.
 
+# Known issues
+
+## Failed to bundle project
+
+`pnpm tauri build` may fail with error: `Error failed to bundle project: error running appimage.sh`. To
+fix this set the NO_STRIP environment variable:
+
+```
+NO_STRIP=1 pnpm tauri build
+```
+
+## Blank screen
+
+The app launches but the window is blank. Set the `WEBKIT_DISABLE_DMABUF_RENDERER` environment variable:
+
+```
+WEBKIT_DISABLE_DMABUF_RENDERER=1 defguard-client
+```
+
 # Legal
 
   - *defguard is not an official WireGuard project, and WireGuard is a registered trademark of Jason A. Donenfeld.*