Git Product home page Git Product logo

simple-openvpn-web's Introduction

This is a little web frontend that I wrote for managing low security logins to an OpenVPN layer 2 tunnel for playing LAN games. This project is build for easy of use. It stores passwords in plain text, has no authentication but it does however make it trivial to distribute logins. It can also be used to manage logins for other services.

Features

  • Stores passwords in plain text(!!) in an actual text/plain file. (I heard you like plaintext...)

  • Management of users (create, delete, update).

  • Copy button which will copy a preformatted message into clipboard, ready to be send to friends.

  • No access control. You need to bring your own.

  • Looks janky as shit.

  • Comes with a script to use with OpenVPN for validating logins.

  • Even has a Docker image.

Demo

(Usually outdated) Example Screenshot of Website

Configuration

The following options can be passed via environment variables:

Variable Description Default
LOGIN_FILE_PATH Path to the file where the logins are stored. /data/logins.txt
FILE_PERMISSIONS Permissions of the login file. 0644
PAGE_TITLE Title of the page. Simple

Using docker-compose with OpenVPN

When using docker-compose it will look something like this:

version: "3.9"

services:
  openvpn:
    # some openvpn image
    # you also need to get the check-login.sh into the container
    image: "..."
    cap_add:
      - NET_ADMIN
    environment:
      # ...
    ports:
      # ...
    volumes:
      - "keys:/etc/openvpn/keys"
      - "logins:/data:ro"

  webpanel:
    image: "ghcr.io/chrisliebaer/simple-openvpn-web:master"
    restart: "always"
    environment:
      - "PAGE_TITLE=Simple VPN"
      # Usefull since OpenVPN will drop privileges to nobody:nogroup
      - "FILE_PERMISSIONS=644"
    volumes:
      - "logins:/data"
    labels:
      - "traefik.enable=true"
      - "traefik.http.services.simple-openvpn-web.loadbalancer.server.port=8080"
      - "traefik.http.routers.simple-openvpn-web.rule=Host(`vpn.example.com`)"
      - "traefik.http.routers.simple-openvpn-web.entryPoints=web"
      - "traefik.http.routers.simple-openvpn-web.middlewares=myauth"


volumes:
  keys:
  logins:

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.