Skip to content

Commit

Permalink
Add known-issues section to README
Browse files Browse the repository at this point in the history
  • Loading branch information
j-chmielewski committed Apr 19, 2024
1 parent d4cc496 commit 1172d2e
Showing 1 changed file with 20 additions and 1 deletion.
21 changes: 20 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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).

Expand Down Expand Up @@ -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.*

0 comments on commit 1172d2e

Please sign in to comment.