Skip to content

ogt111/ovpn-admin

 
 

Repository files navigation

ovpn-admin

Simple web UI to manage OpenVPN users, their certificates & routes in Linux. While backend is written in Go, frontend is based on Vue.js.

Originally created in Flant for internal needs & used for years, then updated to be more modern and publicly released in March'21. Your contributions are welcome!

Features

  • Adding OpenVPN users (generating certificates for them);
  • Revoking/restoring users certificates;
  • Generating ready-to-user config files;
  • Providing metrics for Prometheus, including certificates expiration date, number of (connected/total) users, information about connected users;
  • (optionally) Specifying CCD (client-config-dir) for each user;
  • (optionally) Operating in a master/slave mode (syncing certs & CCD with other server);
  • (optionally) Specifying/changing password for additional authorization in OpenVPN.

Screenshots

Managing users in ovpn-admin: ovpn-admin UI

An example of dashboard made using ovpn-admin metrics: ovpn-admin metrics

Installation

Disclaimer

This tool uses external calls for bash, coreutils and easy-rsa, thus Linux systems only are supported at the moment.

1. Docker

There is a ready-to-use docker-compose.yaml, so you can just change/add values you need and start it with start.sh.

Requirements. You need Docker and docker-compose installed.

Commands to execute:

git clone https://github.com/flant/ovpn-admin.git cd ovpn-admin ./start.sh

2. Building from source

Requirements. You need Linux with the following components installed:

Commands to execute:

git clone https://github.com/flant/ovpn-admin.git cd ovpn-admin ./bootstrap.sh ./build.sh ./ovpn-admin 

(Please don't forgot to configure all needed params in advance.)

3. Prebuilt binary (WIP)

You can also download & use prebuilt binaries from the releases page — just choose a relevant tar.gz file.

Usage

usage: ovpn-admin [<flags>] Flags: --help Show context-sensitive help (also try --help-long and --help-man). --listen.host="0.0.0.0" host for ovpn-admin --listen.port="8080" port for ovpn-admin --role="master" server role master or slave --master.host="http://127.0.0.1" url for master server --master.basic-auth.user="" user for basic auth on master server url --master.basic-auth.password="" password for basic auth on master server url --master.sync-frequency=600 master host data sync frequency in seconds. --master.sync-token=TOKEN master host data sync security token --ovpn.network="172.16.100.0/24" network for openvpn server --ovpn.server=HOST:PORT:PROTOCOL ... comma separated addresses for openvpn servers --mgmt=main=127.0.0.1:8989 ... comma separated (alias=address) for openvpn servers mgmt interfaces --metrics.path="/metrics" URL path for surfacing collected metrics --easyrsa.path="./easyrsa/" path to easyrsa dir --easyrsa.index-path="./easyrsa/pki/index.txt" path to easyrsa index file. --ccd Enable client-config-dir. --ccd.path="./ccd" path to client-config-dir --auth.password Enable additional password authorization. --auth.db="./easyrsa/pki/users.db" Database path fort password authorization. --debug Enable debug mode. --verbose Enable verbose mode. --version Show application version. 

Further information

Please feel free to use issues and discussions to get help from maintainers & community.

About

Simple web UI to manage OpenVPN users.

Resources

License

Stars

Watchers

Forks

Packages

 
 
 

Contributors

Languages

  • Go 57.9%
  • JavaScript 19.7%
  • HTML 14.2%
  • Shell 4.4%
  • Smarty 1.4%
  • CSS 1.2%
  • Dockerfile 1.2%