From aac1517c2387a7b34bb3c04933377cc3fb880cf3 Mon Sep 17 00:00:00 2001 From: zaneschepke Date: Mon, 2 Mar 2026 15:26:50 -0500 Subject: [PATCH] docs: update readme install directions --- README.md | 29 ++++++++++++++++++++++++----- 1 file changed, 24 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index df279e8..b83ecbf 100644 --- a/README.md +++ b/README.md @@ -10,19 +10,38 @@ A WireGuard and AmneziaWG client for desktop. # Installation +## Windows + +> **Note:** Only Windows 11 and 10 patch `10.0.19041.0` and greater are supported. + +1. Download the `.msix` file from latest release. +2. Launch the installer by double-clicking on the download. +3. Proceed through the installation prompts (will require relaunching the installer as administrator). + ## Linux -### Linux Tarball Installation +> **Note:** Only `systemd`-based Linux systems are currently supported. Also, the firewall must use `nftables` or `iptables` with the nft backend (`iptables-nft`). -```bash -# Download and extract the tarball, download install/uninstall scripts, and execute +### Linux Tarball Installation (Recommended) + +In future versions, these scripts will be bundled with the tarball. For now, this command is the simplest way to get up and running. + +**Install** +```bash +# Download and extract the tarball, download install script, and execute tar -xzf wgtunnel-*.tar.gz && \ cd wgtunnel-*/ && \ curl -LO https://raw.githubusercontent.com/wgtunnel/desktop/master/scripts/linux/install.sh && \ -curl -LO https://raw.githubusercontent.com/wgtunnel/desktop/master/scripts/linux/uninstall.sh && \ -chmod +x install.sh uninstall.sh && \ +chmod +x install.sh && \ ./install.sh ``` +**Uninstall** (Optional) +```bash +curl -LO https://raw.githubusercontent.com/wgtunnel/desktop/master/scripts/linux/uninstall.sh && \ +chmod +x uninstall.sh && \ +./uninstall.sh +``` +