ovpn-admin/README.md

99 lines
3.8 KiB
Markdown
Raw Normal View History

2021-03-17 04:23:04 -04:00
# ovpn-admin
2021-03-17 05:27:08 -04:00
Simple Web UI to manage OpenVPN users, their certificates & routes.
## 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.
## Install
2021-03-17 05:27:08 -04:00
### Disclaimer
2021-02-26 07:25:10 -05:00
2021-03-17 05:27:08 -04:00
This tool uses external calls for `bash`, `core-utils` and `easyrsa`, thus **Linux systems only are supported** at the moment.
2021-03-17 05:27:08 -04:00
### Docker
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-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:
```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-03-17 05:27:08 -04:00
### Building from source
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-03-17 05:27:08 -04:00
Commands to execute:
```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 04:23:04 -04:00
./ovpn-admin
```
2021-03-17 05:27:08 -04:00
(Please don't forgot to configure all needed params in advance.)
### Prebuilt binary (WIP)
You can also use prebuilt binary from [releases](https://github.com/flant/ovpn-admin/releases) page — just download a tar.gz file.
## Usage
```
2021-03-17 04:23:04 -04:00
usage: ovpn-admin [<flags>]
Flags:
--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
--role="master" server role master or slave
2021-02-20 08:40:14 -05:00
--master.host="http://127.0.0.1"
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=""
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"
network for openvpn server
--ovpn.server=HOST:PORT:PROTOCOL ...
comma separated addresses for openvpn servers
2021-02-20 08:40:14 -05:00
--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.
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.