README.md

Wireguard GUI

❤️ Made with love with Nextauri ❤️

IMPORTANT

The snap version is currently not working, please use the .deb package instead.

❓ What is Wireguard GUI ?

Wireguard GUI is a Debian/Linux application that allow you to manage your Wireguard VPN configuration.

💡 Features

• List all profile
• Add a new profile
• Edit a profile
• Remove a profile
• Start a profile
• Stop a profile
• Import a profile
• Export a profile

💪 Motivation

I didn't found any GUI application that allow me to manage my Wireguard VPN configuration.
I wanted to make an application with nextauri since a while, so i took this opportunity to make it.

Pre-requisites

In order to work properly, the application needs the following dependencies:

sudo apt install libcanberra-gtk-module libjavascriptcoregtk-4.0-18 libicu70 libwebkit2gtk-4.0-37 wireguard resolvconf

📦 Installation

Release are currently only available as a .deb package for Debian/Ubuntu. It can be found on the release page

🚀 Demo

A demo will be recorded soon.

🎨 Developing

Be sure you have NodeJS and Rust installed on your system

1. See Tauri prerequisites to prepare your system to build Tauri

2. Clone or fork this repository

   git clone https://github.com/leon3s/wireguard-gui
   cd wireguard-gui

3. Install node dependencies

   npm install

To get started you only need one command

npm run dev

⚡Production

To build in production you can do it in a single command. This will build and export Next.js and build Tauri for your current environnement.

npm run tauri build

📚 Documentation

To learn more about Tauri and Next.js, take a look at the following resources:

• Tauri Guides - guide about Tauri.
• Tauri API - discover javascript Tauri api.
• Next.js Documentation - learn more about Next.js.
• Next.js Tutorial - interactive Next.js tutorial.