Linux-Help/ovpn-admin
1
0
Fork 0
mirror of synced 2024-12-18 12:31:08 -05:00
Code Issues Projects Releases Packages Wiki Activity

Adding Features & small fixes

Browse source
This commit is contained in:
Dmitry Shurupov 2021-03-17 16:27:08 +07:00 committed by GitHub
parent 9629f51e76
commit e7eb841805
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 36 additions and 21 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

57
README.md
View file

@ -1,47 +1,59 @@
# ovpn-admin # ovpn-admin
Web UI for manage and admin openvpn users 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 ## Install
### disclaimer ### Disclaimer
Because this utility uses external calls for `bash`, `core-utils` and `easyrsa` it can work only on Linux systems This tool uses external calls for `bash`, `core-utils` and `easyrsa`, thus **Linux systems only are supported** at the moment.
### docker ### Docker
We have [docker-compose.yaml](https://github.com/flant/ovpn-admin/blob/master/docker-compose.yaml) you can just change/add values you need and start it with [start.sh](https://github.com/flant/ovpn-admin/blob/master/start.sh) 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).
First you need to have installed Requirements. You need [Docker](https://docs.docker.com/get-docker/) and [docker-compose](https://docs.docker.com/compose/install/) installed.
[docker](https://docs.docker.com/get-docker/)
[docker-compose](https://docs.docker.com/compose/install/) Commands to execute:
```bash ```bash
git clone https://github.com/flant/ovpn-admin.git git clone https://github.com/flant/ovpn-admin.git
cd ovpn-admin cd ovpn-admin
start.sh ./start.sh
``` ```
### building from source ### Building from source
First you need to have installed: Requirements. You need Linux with the following components installed:
[golang](https://golang.org/doc/install) - [golang](https://golang.org/doc/install)
[packr2](https://github.com/gobuffalo/packr#installation) - [packr2](https://github.com/gobuffalo/packr#installation)
[nodejs/npm](https://nodejs.org/en/download/package-manager/) - [nodejs/npm](https://nodejs.org/en/download/package-manager/)
Commands to execute:
```bash ```bash
git clone https://github.com/flant/ovpn-admin.git git clone https://github.com/flant/ovpn-admin.git
cd ovpn-admin cd ovpn-admin
bootstrap.sh ./bootstrap.sh
build.sh ./build.sh
./ovpn-admin ./ovpn-admin
``` ```
be sure you don't forgot to configure all needed params
### prebuild binary (WIP) (Please don't forgot to configure all needed params in advance.)
You can use prebuild binary from [releases](https://github.com/flant/ovpn-admin/releases) page
just download tar.gz file . ### 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 ## Usage
@ -79,5 +91,8 @@ Flags:
--verbose Enable verbose mode. --verbose Enable verbose mode.
--version Show application version. --version Show application version.
``` ```
## 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.