Simple web UI to manage OpenVPN users.
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
 
 
 
Ilya Sosnovsky a0daf5b4d7 add feature for rotate and delete users; fixes; refactoring 7 months ago
.github/workflows add feature for rotate and delete users; fixes; refactoring 7 months ago
frontend add feature for rotate and delete users; fixes; refactoring 7 months ago
helm add helm chart example 11 months ago
img Fixing metrics screenshot in README 2 years ago
setup add feature for rotate and delete users; fixes; refactoring 7 months ago
templates Update client.conf.tpl 1 year ago
.dockerignore add feature for rotate and delete users; fixes; refactoring 7 months ago
.editorconfig add option to specify custom user template path 2 years ago
.gitignore envvar configuraion; arm build; docs fixes 1 year ago
Dockerfile add feature for rotate and delete users; fixes; refactoring 7 months ago
Dockerfile.openvpn add feature for rotate and delete users; fixes; refactoring 7 months ago
LICENSE Initial commit 3 years ago
README.md add feature for rotate and delete users; fixes; refactoring 7 months ago
bootstrap.sh Prepare for release 1.7.0 1 year ago
build.sh fixes for build scripts 1 year ago
build_arm.sh fixed a broken release 1 year ago
certificates.go kubernetes.secrets storage.backend implementation 11 months ago
docker-compose-slave.yaml renaming; fixes 2 years ago
docker-compose.yaml add feature for rotate and delete users; fixes; refactoring 7 months ago
go.mod add feature for rotate and delete users; fixes; refactoring 7 months ago
go.sum add feature for rotate and delete users; fixes; refactoring 7 months ago
helpers.go add feature for rotate and delete users; fixes; refactoring 7 months ago
install-deps-arm.sh node 16.13 1 year ago
install-deps.sh node 16.13 1 year ago
kubernetes.go add feature for rotate and delete users; fixes; refactoring 7 months ago
main.go add feature for rotate and delete users; fixes; refactoring 7 months ago
package-lock.json add feature for rotate and delete users; fixes; refactoring 7 months ago
start-with-slave.sh Addded master-slave mode for openvpn-admin 2 years ago
start.sh Addded master-slave mode for openvpn-admin 2 years ago
werf.yaml Renaming to ovpn-admin 2 years ago

README.md

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!

DISCLAIMER! This project was created for experienced users (system administrators) and private (e.g., protected by network policies) environments only. Thus, it is not implemented with security in mind (e.g., it doesn't strictly check all parameters passed by users, etc.). It also relies heavily on files and fails if required files aren't available.

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;
  • (optionally) Specifying the Kubernetes LoadBalancer if it's used in front of the OpenVPN server (to get an automatically defined remote in the client.conf.tpl template).
  • (optionally) Storing certificates and other files in Kubernetes Secrets (Attention, this feature is experimental!).

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 forget to configure all needed params in advance.)

3. Prebuilt binary

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

Notes

To use password authentication (the --auth flag) you have to install openvpn-user. This tool should be available in your $PATH and its binary should be executable (+x).

Usage

usage: ovpn-admin [<flags>]

Flags:
  --help                       show context-sensitive help (try also --help-long and --help-man)

  --listen.host="0.0.0.0"      host for ovpn-admin
  (or OVPN_LISTEN_HOST)

  --listen.port="8080"         port for ovpn-admin
  (or OVPN_LISTEN_PROT)

  --role="master"              server role, master or slave
  (or OVPN_ROLE)

  --master.host="http://127.0.0.1"  
  (or OVPN_MASTER_HOST)       URL for the master server

  --master.basic-auth.user=""  user for master server's Basic Auth
  (or OVPN_MASTER_USER)
 
  --master.basic-auth.password=""  
  (or OVPN_MASTER_PASSWORD)   password for master server's Basic Auth

  --master.sync-frequency=600  master host data sync frequency in seconds
  (or OVPN_MASTER_SYNC_FREQUENCY)

  --master.sync-token=TOKEN    master host data sync security token
  (or OVPN_MASTER_TOKEN)

  --ovpn.network="172.16.100.0/24"  
  (or OVPN_NETWORK)           NETWORK/MASK_PREFIX for OpenVPN server

  --ovpn.server=HOST:PORT:PROTOCOL ...  
  (or OVPN_SERVER)            HOST:PORT:PROTOCOL for OpenVPN server
                               can have multiple values

  --ovpn.server.behindLB       enable if your OpenVPN server is behind Kubernetes
  (or OVPN_LB)                Service having the LoadBalancer type

  --ovpn.service="openvpn-external"  
  (or OVPN_LB_SERVICE)        the name of Kubernetes Service having the LoadBalancer
                               type if your OpenVPN server is behind it

  --mgmt=main=127.0.0.1:8989 ...  
  (or OVPN_MGMT)              ALIAS=HOST:PORT for OpenVPN server mgmt interface;
                               can have multiple values

  --metrics.path="/metrics"    URL path for exposing collected metrics
  (or OVPN_METRICS_PATH)

  --easyrsa.path="./easyrsa/"  path to easyrsa dir
  (or EASYRSA_PATH)

  --easyrsa.index-path="./easyrsa/pki/index.txt"  
  (or OVPN_INDEX_PATH)        path to easyrsa index file

  --ccd                        enable client-config-dir
  (or OVPN_CCD)

  --ccd.path="./ccd"           path to client-config-dir
  (or OVPN_CCD_PATH)

  --templates.clientconfig-path=""  
  (or OVPN_TEMPLATES_CC_PATH) path to custom client.conf.tpl

  --templates.ccd-path=""      path to custom ccd.tpl
  (or OVPN_TEMPLATES_CCD_PATH)

  --auth.password              enable additional password authorization
  (or OVPN_AUTH)

  --auth.db="./easyrsa/pki/users.db"
  (or OVPN_AUTH_DB_PATH)      database path for password authorization

  --debug                      enable debug mode
  (or OVPN_DEBUG)

  --verbose                    enable verbose mode
  (or OVPN_VERBOSE)
  
  --log.level                  set log level: trace, debug, info, warn, error (default info)
  (or LOG_LEVEL)
  
  --log.format                 set log format: text, json (default text)
  (or LOG_FORMAT)
  
  --storage.backend            storage backend: filesystem, kubernetes.secrets (default filesystem)
  (or STORAGE_BACKEND)
 
  --version                    show application version

Further information

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