Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/joseantmazonsb/linguard

A simple, yet powerful web GUI to manage your Wireguard server, powered by Flask.
https://github.com/joseantmazonsb/linguard

flask python vpn webgui wireguard wireguard-server

Last synced: 25 days ago
JSON representation

A simple, yet powerful web GUI to manage your Wireguard server, powered by Flask.

Host: GitHub
URL: https://github.com/joseantmazonsb/linguard
Owner: joseantmazonsb
License: gpl-3.0
Created: 2021-01-07T18:48:08.000Z (almost 4 years ago)
Default Branch: main
Last Pushed: 2022-04-16T18:02:37.000Z (over 2 years ago)
Last Synced: 2023-11-07T18:15:11.902Z (about 1 year ago)
Topics: flask, python, vpn, webgui, wireguard, wireguard-server
Language: Python
Homepage: https://linguard.readthedocs.io
Size: 28.8 MB
Stars: 125
Watchers: 11
Forks: 20
Open Issues: 26
Metadata Files:
- Readme: README.md
- License: LICENSE.md

Awesome Lists containing this project

README

        # Linguard

[![GitHub](https://img.shields.io/github/license/joseantmazonsb/linguard)](LICENSE.md) ![Python version](https://img.shields.io/badge/python-3.7%20%7C%203.8%20%7C%203.9-blue?logo=python&logoColor=yellow) [![Stable workflow status](https://github.com/joseantmazonsb/linguard/actions/workflows/stable-test.yaml/badge.svg)](https://github.com/joseantmazonsb/linguard/actions/workflows/stable-test.yaml) [![Latest workflow status](https://github.com/joseantmazonsb/linguard/actions/workflows/latest-test.yaml/badge.svg)](https://github.com/joseantmazonsb/linguard/actions/workflows/latest-test.yaml) [![Stable Documentation Status](https://readthedocs.org/projects/linguard/badge/?version=stable)](https://linguard.readthedocs.io/en/stable/?badge=stable) [![codecov](https://codecov.io/gh/joseantmazonsb/linguard/branch/dev/graph/badge.svg)](https://codecov.io/gh/joseantmazonsb/linguard)

[![GitHub release (latest SemVer including pre-releases)](https://img.shields.io/github/v/release/joseantmazonsb/linguard?color=green&include_prereleases&logo=github)](https://github.com/joseantmazonsb/linguard/releases) [![GitHub all releases](https://img.shields.io/github/downloads/joseantmazonsb/linguard/total?logo=github)](https://github.com/joseantmazonsb/linguard/releases)

Linguard aims to provide a clean, simple yet powerful web GUI to manage your WireGuard server, and it's powered by Flask.

**[Read the docs](https://linguard.readthedocs.io) for further information!**

## Key features

* Management of Wireguard interfaces and peers via web. Interfaces can be created, removed, edited, exported and brought up and down directly from the web GUI. Peers can be created, removed, edited and downloaded at anytime as well.

* Display stored and real time traffic data using charts (storage of traffic data may be manually disabled).

* Display general network information.

* Encrypted user credentials (AES).

* Easy management through the ``linguard`` systemd service.

## Installation

### As a `systemd` service

1. Download [any release](https://github.com/joseantmazonsb/linguard/releases).

    

2. Extract it and run the installation script:

    ```bash

    chmod +x install.sh

    sudo ./install.sh

    ```

3. Run Linguard: 

    ```bash

    sudo systemctl start linguard.service

    ```

### Docker

1. Download the [`docker-compose.yaml` file](https://raw.githubusercontent.com/joseantmazonsb/linguard/main/docker/docker-compose.yaml).

2. Run Linguard: 

   ```bash

   sudo docker-compose up -d

   ```

NOTE: You can check all available tags [here](https://github.com/joseantmazonsb/linguard/pkgs/container/linguard/versions).