Keine Beschreibung

Mustafa Arici 62d1bbaef7 doc(readme): add network management link vor 8 Jahren
api 9c34a5fcb1 feat(permset): apply permission checking using permsets vor 8 Jahren
bindata e977eba7db refactor(webui): set some top padding vor 8 Jahren
cmd 707e209b68 refactor: correct typo vor 8 Jahren
contrib aab7a67225 refactor: preferred group is nogroup vor 8 Jahren
permset 5b9fdc5548 doc(permset): add package docstring vor 8 Jahren
pki 3c59a7469c doc: fix the word usage whether vor 8 Jahren
supervisor 3c59a7469c doc: fix the word usage whether vor 8 Jahren
template e977eba7db refactor(webui): set some top padding vor 8 Jahren
webui e977eba7db refactor(webui): set some top padding vor 8 Jahren
.gitignore 33a3d57151 init: add gitignore vor 8 Jahren
.travis.yml 5c4c565601 chore(ci): fix on fix vor 8 Jahren
CHANGELOG.md ff285d7995 release: v0.2.0 vor 8 Jahren
Dockerfile 5622b954fb chore(build): update build env to include npm vor 8 Jahren
LICENSE cd22d83ab6 Create LICENSE vor 8 Jahren
Makefile 5622b954fb chore(build): update build env to include npm vor 8 Jahren
README.md 62d1bbaef7 doc(readme): add network management link vor 8 Jahren
build.sh d42c20dc41 chore: fix user generation after package install vor 8 Jahren
const.go ff285d7995 release: v0.2.0 vor 8 Jahren
db.go 55acfb6b25 refactor: major refactor of all service vor 8 Jahren
db_test.go 55acfb6b25 refactor: major refactor of all service vor 8 Jahren
doc.go 6006fb9610 feat(api): implement authentication service vor 8 Jahren
generate.go cbaf634afb doc(generate): seperate docstring from package definition vor 8 Jahren
net.go 55acfb6b25 refactor: major refactor of all service vor 8 Jahren
net_test.go 8bbbb27401 feat(vpn): implement configurable dns option vor 8 Jahren
perms.go d37557bd4d refactor(perms): add DeleteNetworkPerm to admin vor 8 Jahren
user.go 2b1197d5c1 feat(webui): implement basic webui vor 8 Jahren
user_test.go 8bbbb27401 feat(vpn): implement configurable dns option vor 8 Jahren
vpn.go 707e209b68 refactor: correct typo vor 8 Jahren
vpn_test.go 0f211905e5 test(vpn): remove client ovpn config nopull check vor 8 Jahren

README.md

OVPM - OpenVPN Management Server

Build Status GitHub version codecov GoDoc

OVPM allows you to administrate an OpenVPN server on linux easily via command line and web interface.

With OVPM you can create and run an OpenVPN server, add/remove VPN users, generate client .ovpn files for your users etc.

This software is not stable yet. We recommend against using it for anything serious until, version 1.0 is released.

Roadmap

  • OpenVPN management functionality
  • User management functionality
  • Network management functionality
  • Command Line Interface (CLI)
  • API (REST and gRPC)
  • Web User Interface (WebUI)
  • Import/Export/Backup OVPM config
  • Effortless client profile (.ovpn file) delivery over Web
  • Monitoring and Quota functionality

Demo Here is a little demo of what it looks on terminal to init the server, create a vpn user and generate .ovpn file for the created user.

asciicast

Installation

from RPM (CentOS/Fedora):

# Add YUM Repo
$ sudo yum-config-manager --add-repo https://cad.github.io/ovpm/rpm/ovpm.repo

# Install OVPM
$ sudo yum install ovpm

from DEB (Ubuntu/Debian):

This is tested only on Ubuntu >=16.04.3 LTS

# Add APT Repo
$ sudo sh -c 'echo "deb [trusted=yes] https://cad.github.io/ovpm/deb/ ovpm main" >> /etc/apt/sources.list'
$ sudo apt update

# Install OVPM
$ sudo apt install ovpm

# Enable and start ovpmd service
$ systemctl start ovpmd
$ systemctl enable ovpmd  

from Source (go get):

Only dependency for ovpm is OpenVPN>=2.3.

$ go get -u github.com/cad/ovpm/...

# Make sure user nobody and group nogroup is available
# on the system
$ sudo useradd nobody
$ sudo groupadd nogroup

# Start ovpmd on a seperate terminal
$ sudo ovpmd

Now ovpmd should be running.

Quickstart

Create a vpn user and export vpn profile for the created user.

# We should init after fresh install
$ ovpm vpn init --hostname <vpn.example.com>
INFO[0004] ovpm server initialized

# Now, lets create a vpn user
$ ovpm user create -u joe -p verySecretPassword
INFO[0000] user created: joe

# Finally export the vpn profile for user joe
$ ovpm user genconfig -u joe
INFO[0000] exported to joe.ovpn

OpenVPN profile for user joe is exported to joe.ovpn file. You can simply use this file with OpenVPN to connect to the vpn server from another computer.

Next Steps