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.

107 lines
4.2 KiB

# 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.
## Features
* Adding users (generating certificates for them);
* Revoking/restoring users certificates;
* Generating ready-to-user config files;
* Providing metrics for Prometheus, including certifications 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
3 years ago
This tool uses external calls for `bash`, `core-utils` and `easyrsa`, 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 [](
Requirements. You need [Docker]( and [docker-compose]( installed.
Commands to execute:
git clone
cd ovpn-admin
### 2. Building from source
Requirements. You need Linux with the following components installed:
- [golang](
- [packr2](
- [nodejs/npm](
Commands to execute:
git clone
cd 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>]
--help Show context-sensitive help (also try --help-long and --help-man)."" host for ovpn-admin
--listen.port="8080" port for ovpn-admin
--role="master" server role master or slave
3 years ago""
url for master server
--master.basic-auth.user="" user for basic auth on master server url
3 years ago
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
3 years ago""
network for openvpn server
--ovpn.server=HOST:PORT:PROTOCOL ...
comma separated addresses for openvpn servers
3 years ago
--mgmt=main= ...
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
path to easyrsa index file.
--ccd Enable client-config-dir.
--ccd.path="./ccd" path to client-config-dir
--auth.password Enable additional password authorization.
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.