Merge pull request #7 from WeeJeWel/master

mmip
This commit is contained in:
Emile Nijssen 2021-05-24 11:26:28 +02:00 committed by GitHub
commit c2ce81800a
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
7 changed files with 42 additions and 29 deletions

23
.github/workflows/lint.yml vendored Normal file
View File

@ -0,0 +1,23 @@
name: Lint
on:
push:
branches:
- master
- production
pull_request:
jobs:
lint:
name: Lint
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
- uses: actions/setup-node@v1
with:
node-version: '14'
- run: |
cd src
npm ci
npm run lint

View File

@ -1,9 +0,0 @@
# Note: Do not edit this file directly.
# Your changes will be overwritten!
# Server
[Interface]
PrivateKey = 8JtWwlHvx4ogphP601ABdvNFXbd1noCd+Sn9fg19jWA=
Address = 10.8.0.1/24
ListenPort = 51820

View File

@ -1,8 +0,0 @@
{
"server": {
"privateKey": "8JtWwlHvx4ogphP601ABdvNFXbd1noCd+Sn9fg19jWA=",
"publicKey": "065+jEZi4CMWbwSCrixByy3D+haZR2e+kjmxMq6h+EY=",
"address": "10.8.0.1"
},
"clients": {}
}

View File

@ -1,23 +1,26 @@
# WireGuard Easy
[![Build & Publish Docker Image to Docker Hub](https://github.com/WeeJeWel/wg-easy/actions/workflows/deploy.yml/badge.svg?branch=production)](https://github.com/WeeJeWel/wg-easy/actions/workflows/deploy.yml)
[![Lint](https://github.com/WeeJeWel/wg-easy/actions/workflows/lint.yml/badge.svg?branch=master)](https://github.com/WeeJeWel/wg-easy/actions/workflows/lint.yml)
[![Docker](https://img.shields.io/docker/v/weejewel/wg-easy/latest)](https://hub.docker.com/r/weejewel/wg-easy)
[![Docker](https://img.shields.io/docker/pulls/weejewel/wg-easy.svg)](https://hub.docker.com/r/weejewel/wg-easy)
[![Sponsor](https://img.shields.io/github/sponsors/weejewel)](https://github.com/sponsors/WeeJeWel)
You have found the easiest way to install & manage WireGuard on any Linux host!
<p align="center">
<img src="./assets/screenshot.png" width="702" height="510" />
<img src="./assets/screenshot.png" width="702" />
</p>
## Features
* All-in-one: WireGuard + Web UI
* A beautiful management Web UI
* Easy installation
* List, create, delete, enable & disable clients
* Show a client's QR code
* Download a client's configuration file
* Statistics for which clients are connected
* Gravatar support 😏
* All-in-one: WireGuard + Web UI.
* Easy installation, simple to use.
* List, create, delete, enable & disable clients.
* Show a client's QR code.
* Download a client's configuration file.
* Statistics for which clients are connected.
* Gravatar support.
## Installation
@ -52,7 +55,7 @@ Optionally, set a Web UI password by uncommenting `PASSWORD=foobar123` and chang
Finally, run WireGuard. It will automatically start after a reboot.
```bash
$ docker-compose up
$ docker-compose up --detach
```
The Web UI will be available on `http://0.0.0.0:51821`. You can create new clients there.

View File

@ -15,7 +15,7 @@ services:
image: weejewel/wg-easy
container_name: wg-easy
volumes:
- .wg-easy:/etc/wireguard
- .:/etc/wireguard
ports:
- "51820:51820/udp"
- "51821:51821/tcp"

View File

@ -1,5 +1,8 @@
{
"extends": "athom",
"ignorePatterns": [
"**/vendor/*.js"
],
"rules": {
"consistent-return": "off",
"no-shadow": "off"

View File

@ -5,7 +5,8 @@
"main": "server.js",
"scripts": {
"serve": "DEBUG=Server,WireGuard WG_HOST=0.0.0.0 WG_PATH=../config/ nodemon server.js",
"serve-with-password": "PASSWORD=wg npm run serve"
"serve-with-password": "PASSWORD=wg npm run serve",
"lint": "eslint ."
},
"author": "Emile Nijssen",
"license": "GPL",