4.6 KiB

Raw Blame History

WireGuard Easy

[!WARNING] You are viewing the README of the pre-release of v15. If you want to setup wg-easy right now. Read the README in the production branch here: README or here for the last nightly: README

You have found the easiest way to install & manage WireGuard on any Linux host!

Features

All-in-one: WireGuard + Web UI.
Easy installation, simple to use.
List, create, edit, delete, enable & disable clients.
Show a client's QR code.
Download a client's configuration file.
Statistics for which clients are connected.
Tx/Rx charts for each connected client.
Gravatar support.
Automatic Light / Dark Mode
Multilanguage Support
One Time Links
Client Expiration
Prometheus metrics support
IPv6 support
CIDR support
2FA support

[!NOTE] To better manage documentation for this project, it has its own site here: https://wg-easy.github.io/wg-easy/latest

[!WARNING] As the Docs are still in Pre-release, you can access them here https://wg-easy.github.io/wg-easy/Pre-release

[!NOTE] If you want to migrate from the old version to the new version, you can find the migration guide here: Migration Guide

Installation

This is a quick start guide to get you up and running with WireGuard Easy.

For a more detailed installation guide, please refer to the Getting Started page.

1. Install Docker

If you haven't installed Docker yet, install it by running as root:

curl -sSL https://get.docker.com | sh
exit

And log in again.

2. Run WireGuard Easy

The easiest way to run WireGuard Easy is with Docker Compose.

Just download docker-compose.yml and execute sudo docker compose up -d.

Now setup a reverse proxy to be able to access the Web UI from the internet.

If you want to access the Web UI over HTTP, change the env var INSECURE to true. This is not recommended. Only use this for testing

Donate

Are you enjoying this project? Consider donating.

Founder: Buy Emile a beer! 🍻

Maintainer: Buy kaaax0815 a coffee! ☕

Development

Prerequisites

Docker
Node LTS & corepack enabled
Visual Studio Code

Dev Server

This starts the development server with docker

pnpm dev

Update Auto Imports

If you add something that should be auto-importable and VSCode complains, run:

cd src
pnpm install

License

This project is licensed under the AGPL-3.0-only License - see the LICENSE file for details

This project is not affiliated, associated, authorized, endorsed by, or in any way officially connected with Jason A. Donenfeld, ZX2C4 or Edge Security

"WireGuard" and the "WireGuard" logo are registered trademarks of Jason A. Donenfeld

4.6 KiB Raw Blame History