# 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](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! ## 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. ### Screenshots Managing users in ovpn-admin: ![ovpn-admin UI](https://raw.githubusercontent.com/flant/ovpn-admin/master/img/ovpn-admin-users.png) An example of dashboard made using ovpn-admin metrics: ![ovpn-admin metrics](https://raw.githubusercontent.com/flant/ovpn-admin/master/img/ovpn-admin-metrics.png) ## 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](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). Requirements. You need [Docker](https://docs.docker.com/get-docker/) and [docker-compose](https://docs.docker.com/compose/install/) installed. Commands to execute: ```bash 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: - [golang](https://golang.org/doc/install) - [packr2](https://github.com/gobuffalo/packr#installation) - [nodejs/npm](https://nodejs.org/en/download/package-manager/) Commands to execute: ```bash 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 (WIP) 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. ## Usage ``` usage: ovpn-admin [] Flags: --help Show context-sensitive help (also try --help-long and --help-man). --listen.host="0.0.0.0" host for ovpn-admin --listen.port="8080" port for ovpn-admin --role="master" server role master or slave --master.host="http://127.0.0.1" url for master server --master.basic-auth.user="" user for basic auth on master server url --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 --ovpn.network="172.16.100.0/24" network for openvpn server --ovpn.server=HOST:PORT:PROTOCOL ... comma separated addresses for openvpn servers --ovpn.server.behindLB ovpn behind cloud loadbalancer --ovpn.service="openvpn-external" ovpn behind cloud loadbalancer k8s service name --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 --templates.clientconfig-path="" path to custom client.config.tpl file --templates.ccd-path="" path to custom ccd.tpl file --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. ``` ## 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.