2021-03-17 04:23:04 -04:00
# ovpn-admin
2021-02-26 07:11:13 -05:00
2021-03-17 05:33:46 -04:00
Simple web UI to manage OpenVPN users, their certificates & routes in Linux. While backend is written in Go, frontend is based on Vue.js.
2021-03-17 05:27:08 -04:00
2021-03-26 04:04:34 -04:00
Originally created in [Flant ](https://flant.com/ ) for internal needs & used for years, then updated to be more modern and [publicly released ](https://blog.flant.com/introducing-ovpn-admin-web-interface-for-openvpn/ ) in March'21. Your contributions are welcome!
2021-03-17 05:27:08 -04:00
## Features
2021-03-17 05:53:00 -04:00
* Adding OpenVPN users (generating certificates for them);
2021-03-17 05:27:08 -04:00
* Revoking/restoring users certificates;
* Generating ready-to-user config files;
2021-03-17 05:53:00 -04:00
* Providing metrics for Prometheus, including certificates expiration date, number of (connected/total) users, information about connected users;
2021-03-17 05:27:08 -04:00
* (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.
2021-02-26 07:11:13 -05:00
2021-03-17 05:50:43 -04:00
### Screenshots
Managing users in ovpn-admin:
An example of dashboard made using ovpn-admin metrics:
2021-03-17 05:33:46 -04:00
## Installation
2021-02-26 07:11:13 -05:00
2021-03-17 05:27:08 -04:00
### Disclaimer
2021-02-26 07:25:10 -05:00
2021-04-22 04:42:57 -04:00
This tool uses external calls for `bash` , `coreutils` and `easy-rsa` , thus **Linux systems only are supported** at the moment.
2021-02-26 07:11:13 -05:00
2021-03-17 05:30:12 -04:00
### 1. Docker
2021-02-26 07:11:13 -05:00
2021-03-17 05:27:08 -04:00
There is a ready-to-use [docker-compose.yaml ](https://github.com/flant/ovpn-admin/blob/master/docker-compose.yaml ), so you can just change/add values you need and start it with [start.sh ](https://github.com/flant/ovpn-admin/blob/master/start.sh ).
2021-02-26 07:11:13 -05:00
2021-03-17 05:27:08 -04:00
Requirements. You need [Docker ](https://docs.docker.com/get-docker/ ) and [docker-compose ](https://docs.docker.com/compose/install/ ) installed.
Commands to execute:
2021-02-26 07:11:13 -05:00
```bash
2021-03-17 04:23:04 -04:00
git clone https://github.com/flant/ovpn-admin.git
cd ovpn-admin
2021-03-17 05:27:08 -04:00
./start.sh
2021-02-26 07:11:13 -05:00
```
2021-03-17 05:30:12 -04:00
### 2. Building from source
2021-02-26 07:11:13 -05:00
2021-03-17 05:27:08 -04:00
Requirements. You need Linux with the following components installed:
- [golang ](https://golang.org/doc/install )
- [packr2 ](https://github.com/gobuffalo/packr#installation )
- [nodejs/npm ](https://nodejs.org/en/download/package-manager/ )
2021-02-26 07:11:13 -05:00
2021-03-17 05:27:08 -04:00
Commands to execute:
2021-02-26 07:11:13 -05:00
```bash
2021-03-17 04:23:04 -04:00
git clone https://github.com/flant/ovpn-admin.git
cd ovpn-admin
2021-03-17 05:27:08 -04:00
./bootstrap.sh
./build.sh
2021-03-17 05:30:12 -04:00
./ovpn-admin
2021-02-26 07:11:13 -05:00
```
2021-03-17 05:27:08 -04:00
(Please don't forgot to configure all needed params in advance.)
2021-03-17 05:30:12 -04:00
### 3. Prebuilt binary (WIP)
2021-03-17 05:27:08 -04:00
2021-10-05 11:09:29 -04:00
You can also download and use prebuilt binaries from the [releases ](https://github.com/flant/ovpn-admin/releases ) page — just choose a relevant tar.gz file.
2021-02-26 07:11:13 -05:00
## Usage
2020-11-19 12:08:55 -05:00
```
2021-03-17 04:23:04 -04:00
usage: ovpn-admin [< flags > ]
2020-11-19 12:08:55 -05:00
Flags:
2021-02-26 07:11:13 -05:00
--help Show context-sensitive help (also try --help-long and --help-man).
2021-03-17 04:23:04 -04:00
--listen.host="0.0.0.0" host for ovpn-admin
--listen.port="8080" port for ovpn-admin
2021-02-26 07:11:13 -05:00
--role="master" server role master or slave
2021-02-20 08:40:14 -05:00
--master.host="http://127.0.0.1"
2021-02-26 07:11:13 -05:00
url for master server
--master.basic-auth.user="" user for basic auth on master server url
2021-02-20 08:40:14 -05:00
--master.basic-auth.password=""
2021-02-26 07:11:13 -05:00
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
2021-02-20 08:40:14 -05:00
--ovpn.network="172.16.100.0/24"
2021-02-26 07:11:13 -05:00
network for openvpn server
--ovpn.server=HOST:PORT:PROTOCOL ...
comma separated addresses for openvpn servers
2021-10-05 11:09:29 -04:00
--ovpn.server.behindLB ovpn behind cloud loadbalancer
--ovpn.service="openvpn-external"
ovpn behind cloud loadbalancer k8s service name
2021-02-20 08:40:14 -05:00
--mgmt=main=127.0.0.1:8989 ...
2021-02-26 07:11:13 -05:00
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
2021-07-21 18:06:34 -04:00
--templates.clientconfig-path=""
path to custom client.config.tpl file
--templates.ccd-path="" path to custom ccd.tpl file
2021-02-26 07:11:13 -05:00
--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.
2021-03-17 04:23:04 -04:00
```
2021-03-17 05:27:08 -04:00
## Further information
Please feel free to use [issues ](https://github.com/flant/ovpn-admin/issues ) and [discussions ](https://github.com/flant/ovpn-admin/discussions ) to get help from maintainers & community.
