FFFF GitHub - j0ck4/wren: A native WireGuard VPN client for Linux · GitHub
[go: up one dir, main page]

Skip to content
j0ck4Public

Repository files navigation

Wren

Wren

A native WireGuard client for the GNOME desktop — import, connect, and manage your tunnels from a clean GTK4 window, no terminal required.

🇷🇺 Русская версия — README.ru.md

CI License: GPL v3 Rust

Wren main window

About

Wren manages WireGuard VPN tunnels on Linux through a native GTK4 / libadwaita interface. It is a front-end for the standard wg-quick tools: import the regular .conf file your VPN provider or admin gives you, then bring the tunnel up or down, watch its status, and edit it — without touching a terminal.

Features

  • One-click connect / disconnect through wg-quick, authorized via polkit (your password is cached for a few minutes, not asked every time).
  • Import any standard .conf with a file picker — no editing by hand.
  • Live transfer stats (received / sent) that refresh every two seconds while a tunnel is up.
  • Full detail view — address, DNS, listen port, MTU, and every peer with its allowed IPs, endpoint, and keepalive.
  • Built-in editor — tweak interface fields, add or remove peers, all from the UI.
  • Delete tunnels safely — a confirmation dialog brings the tunnel down first if it is active.
  • Share to mobile via QR code — scan straight into the WireGuard app on Android or iOS.
  • System tray (StatusNotifierItem) with a per-tunnel toggle, plus desktop notifications on connect / disconnect.
  • Start at login with one toggle.
  • Native everywhere — GTK4 / libadwaita, Wayland and X11, follows the GNOME HIG.

Status

Early development. The design specification lives in wren-project.md.

Documentation

For end users (download → install → use):

For developers and power users (native install, building from source, polkit, file layout):

A quick build reference follows below.

Installing a prebuilt bundle

For users who just want to try Wren without building it.

# 1. Add Flathub (skip if already done)
flatpak remote-add --if-not-exists --user flathub \
    https://dl.flathub.org/repo/flathub.flatpakrepo

# 2. Download wren-vX.Y.Z.flatpak from GitHub Releases:
#    https://github.com/j0ck4/wren/releases

# 3. Install
flatpak install --user wren-vX.Y.Z.flatpak

# 4. Run
flatpak run io.github.j0ck4.Wren.Devel

The bundle is self-contained and runs on any distribution with Flatpak (Ubuntu, Fedora, Arch, openSUSE…). Dependencies (the GNOME 50 runtime, ~600 MB) are pulled automatically from Flathub on first install.

You also need WireGuard tools on the host — Wren shells out to wg-quick:

sudo apt install wireguard-tools     # Debian / Ubuntu

Building from source

Via Flatpak (recommended)

# One-time: add flathub and install the GNOME SDK 50
flatpak remote-add --if-not-exists --user flathub https://dl.flathub.org/repo/flathub.flatpakrepo
flatpak install --user flathub org.gnome.Sdk//50 org.gnome.Platform//50 \
  org.freedesktop.Sdk.Extension.rust-stable//25.08 \
  org.freedesktop.Sdk.Extension.llvm20//25.08

# Build and run
flatpak-builder --user --install --force-clean build-dir \
  build-aux/flatpak/io.github.j0ck4.Wren.Devel.json
flatpak run io.github.j0ck4.Wren.Devel

Local build (requires system dev packages)

sudo apt install meson ninja-build pkg-config \
    libgtk-4-dev libadwaita-1-dev libglib2.0-dev libdbus-1-dev cargo
meson setup builddir --buildtype=release
meson compile -C builddir
sudo meson install -C builddir

Rust 1.85+ is required (edition 2024). If your distro's cargo is older, install rustup or use the Flatpak build above. See DEVELOPING.md for details and for how to uninstall either flavour.

License

GPL-3.0-or-later — see LICENSE.

Releases

Packages

Used by

Contributors

Languages

0