Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/leon3s/wireguard-gui
A wireguard client GUI for Linux made with nextauri
https://github.com/leon3s/wireguard-gui
linux security vpn vpn-client wireguard
Last synced: 3 days ago
JSON representation
A wireguard client GUI for Linux made with nextauri
- Host: GitHub
- URL: https://github.com/leon3s/wireguard-gui
- Owner: leon3s
- License: apache-2.0
- Created: 2024-01-29T00:15:29.000Z (11 months ago)
- Default Branch: master
- Last Pushed: 2024-12-23T05:47:58.000Z (11 days ago)
- Last Synced: 2024-12-24T03:08:28.433Z (10 days ago)
- Topics: linux, security, vpn, vpn-client, wireguard
- Language: TypeScript
- Homepage:
- Size: 2.2 MB
- Stars: 109
- Watchers: 2
- Forks: 8
- Open Issues: 19
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Funding: .github/FUNDING.yml
- License: LICENSE-APACHE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
Wireguard GUI
❤️ Made with love with Nextauri ❤️
[](https://github.com/leon3s/wireguard-gui)
[](https://github.com/leon3s/wireguard-gui)
[](https://github.com/leon3s/wireguard-gui)
[](https://discord.gg/WV4Aac8uZg)
[](https://github.com/leon3s/wireguard-gui/actions/workflows/eslint_clippy.yml)
[](https://github.com/leon3s/wireguard-gui/actions/workflows/build.yml)
## 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
- [x] List all profile
- [x] Add a new profile
- [x] Edit a profile
- [x] Remove a profile
- [x] Start a profile
- [x] 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:
```sh
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](https://github.com/leon3s/wireguard-gui/releases/latest)
## 🚀 Demo
A demo will be recorded soon.
## 🎨 Developing
Be sure you have [NodeJS](https://nodejs.org/en/) and [Rust](https://www.rust-lang.org/) installed on your system
1. See Tauri [prerequisites](https://tauri.app/v1/guides/getting-started/prerequisites/) to prepare your system to build `Tauri`
2. Clone or fork this repository
```sh
git clone https://github.com/leon3s/wireguard-gui
cd wireguard-gui
```
3. Install node dependencies
```sh
npm install
```
To get started you only need one command
```sh
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.
```sh
npm run tauri build
```
## 📚 Documentation
To learn more about Tauri and Next.js, take a look at the following resources:
- [Tauri Guides](https://tauri.app/v1/guides/) - guide about Tauri.
- [Tauri API](https://tauri.app/v1/api/js) - discover javascript Tauri api.
- [Next.js Documentation](https://nextjs.org/docs) - learn more about Next.js.
- [Next.js Tutorial](https://nextjs.org/learn) - interactive Next.js tutorial.