wireguard-gui

(โ˜… 314)

A wireguard client GUI for Linux made with nextauri

  • .gitignore
  • CHANGELOG.md
  • CODE_OF_CONDUCT.md
  • components.json
  • eslint.config.mjs
  • flake.lock
  • flake.nix
  • LICENSE-APACHE
  • LICENSE-MIT
  • next-env.d.ts
  • next.config.mjs
  • package-lock.json
  • package.json
  • postcss.config.cjs
  • prettier.config.js
  • README.md
  • rustfmt.toml
  • tsconfig.json
  • wdio.conf.ts

# Installation Guide

1. Get the code
git clone https://github.com/0xle0ne/wireguard-gui

Downloads the entire project code from GitHub to your computer.

cd wireguard-gui

Moves into the project folder you just downloaded.

2. Official Install Script

Easy Recommended
Prerequisites
  • APT (Debian/Ubuntu ๊ณ„์—ด) Built into Debian/Ubuntu-based Linux distributions.
sudo apt-get install javascriptcoregtk-4.1 libsoup-3.0 webkit2gtk-4.1 libayatana-appindicator3-dev librsvg2-dev wireguard resolvconf -y

Installs directly from the APT package repository (Debian/Ubuntu-based).

sudo apt-get install webkit2gtk-driver -y

Installs directly from the APT package repository (Debian/Ubuntu-based).

โœ… After installing, open a new terminal and run the program's version command (e.g. --version) to confirm it worked.

Pulled directly from this repo's README.

3. Node.js

Easy
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Node.js Node.js must be installed to use npm. The LTS version is recommended.
npm install

Downloads and installs the libraries listed in package.json.

npm run dev

Starts the development/run server.

npm run e2e

Type this command into your terminal and run it.

npm run e2e:build

Type this command into your terminal and run it.

npm run e2e:test

Type this command into your terminal and run it.

โœ… After running the command, open the address shown in the terminal (usually something like http://localhost:3000) in your browser.

Pulled directly from this repo's README.

4. Rust

Medium
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Rust (rustup) Installing via rustup also installs cargo.
cd src-tauri

This project's files live in a subfolder, so move into it first.

cargo build --release

Compiles the Rust project.

cargo run

Builds and then immediately runs the program.

โœ… If cargo build finishes without errors, it worked. The executable is created under target/.
// repository documentation