add README and LICENSE

LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2020 Christoph Haas
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

README.md

@@ -1,3 +1,98 @@
 # WireGuard Portal
 
 [![Build Status](https://travis-ci.com/h44z/wg-portal.svg?token=q4pSqaqT58Jzpxdx62xk&branch=master)](https://travis-ci.com/h44z/wg-portal)
+[![License: MIT](https://img.shields.io/badge/license-MIT-green.svg)](https://opensource.org/licenses/MIT)
+![GitHub last commit](https://img.shields.io/github/last-commit/h44z/wg-portal)
+![GitHub go.mod Go version](https://img.shields.io/github/go-mod/go-version/h44z/wg-portal)
+![GitHub code size in bytes](https://img.shields.io/github/languages/code-size/h44z/wg-portal)
+
+A simple web base configuration portal for [WireGuard](https://wireguard.com). 
+The portal uses the WireGuard [wgctrl](https://github.com/WireGuard/wgctrl-go) library to manage the VPN 
+interface. This allows for seamless activation or deactivation of new users, without disturbing existing VPN 
+connections.
+
+The configuration portal is designed to use LDAP (Active Directory) as a user source for authentication and profile data.
+It still can be used without LDAP by using a predefined administrator account. Some features like mass creation of accounts 
+will only be available in combination with LDAP.
+
+## Features
+ * Self-hosted and web based
+ * Automatically select IP from the network pool assigned to client
+ * QR-Code for convenient mobile client configuration
+ * Sent email to client with QR-code and client config
+ * Enable / Disable clients seamlessly
+ * Generation of `wgX.conf` after any modification
+ * IPv6 ready
+ * User authentication (LDAP and/or predefined admin account)
+ * Dockerized
+ * Responsive template
+ 
+![Screenshot](screenshot.png)
+
+## Setup
+
+### Docker
+The easiest way to run WireGuard Portal is using the provided docker image.
+
+Docker compose snippet, used for demo server
+```
+version: '3.6'
+services:
+  wg-portal:
+    image: h44z/wg-portal:latest
+    container_name: wg-portal
+    restart: unless-stopped
+    cap_add:
+      - NET_ADMIN
+    network_mode: "host"
+    volumes:
+      - /etc/wireguard:/etc/wireguard
+      - ./data:/app/data
+    ports:
+      - '8123:8123'
+    environment:
+      - EXTERNAL_URL=https://vpn.company.com
+      - WEBSITE_TITLE=WireGuard VPN
+      - COMPANY_NAME=Your Company Name
+      - MAIL_FROM=WireGuard VPN <noreply+wireguard@company.com>
+      - ADMIN_USER=admin  # optional admin user
+      - ADMIN_PASS=supersecret
+      - ADMIN_LDAP_GROUP=CN=WireGuardAdmins,OU=Users,DC=COMPANY,DC=LOCAL
+      - EMAIL_HOST=10.10.10.10
+      - EMAIL_PORT=25
+      - LDAP_URL=ldap://srv-ad01.company.local:389
+      - LDAP_BASEDN=DC=COMPANY,DC=LOCAL
+      - LDAP_USER=ldap_wireguard@company.local
+      - LDAP_PASSWORD=supersecretldappassword
+```
+Please note that mapping ```/etc/wireguard``` to ```/etc/wireguard``` inside the docker, will erase your host's current configuration.
+If needed, please make sure to backup your files from ```/etc/wireguard```.
+For a full list of configuration options take a look at the source file [internal/common/configuration.go](internal/common/configuration.go).
+
+### Standalone
+For a standalone application, use the Makefile provided in the repository to build the application.
+
+```
+make
+```
+
+The compiled binary and all necessary assets will be located in the dist folder.
+
+## What is out of scope
+
+ * Generation or application of any `iptables` or `nftables` rules
+ * Setting up or changing IP-addresses of the WireGuard interface
+ 
+## Application stack
+
+ * [Gin, HTTP web framework written in Go](https://github.com/gin-gonic/gin)
+ * [go-template, data-driven templates for generating textual output](https://golang.org/pkg/text/template/)
+ * [Bootstrap, for the HTML templates](https://getbootstrap.com/)
+ * [JQuery, for some nice JavaScript effects ;)](https://jquery.com/)
+
+## License
+
+ * MIT License. [MIT](LICENSE.txt) or https://opensource.org/licenses/MIT
+ 
+
+This project was inspired by [wg-gen-web](https://github.com/vx3r/wg-gen-web).