No Description

Mustafa Arici 4cb50d916b chore: update dependencies 7 years ago
api 9ce7db14b1 refactor(vpn): move all funcs under Server struct 7 years ago
bindata 9ce7db14b1 refactor(vpn): move all funcs under Server struct 7 years ago
cmd 5c4e124460 doc(cmd/ovpm): fix log stmt 7 years ago
contrib 29fe7fcd76 chore(build): ensure nogroup does exist on the target 7 years ago
errors fc6ff58592 refactor(cmd/ovpm): refactor ovpm commands 7 years ago
permset 5b9fdc5548 doc(permset): add package docstring 8 years ago
pki 3c59a7469c doc: fix the word usage whether 8 years ago
supervisor 50f831d884 fix(vpn): ensure Emit() when restarting 8 years ago
template 8e3f01dc7d feat: connected users 7 years ago
webui 8e3f01dc7d feat: connected users 7 years ago
.gitignore fc6ff58592 refactor(cmd/ovpm): refactor ovpm commands 7 years ago
.travis.yml 5c4c565601 chore(ci): fix on fix 8 years ago
CHANGELOG.md 19eabf865e release: v0.2.6 8 years ago
Dockerfile 9e1f03e051 chore(Dockerfile): drop MAINTAINER keyword 7 years ago
Gopkg.lock 4cb50d916b chore: update dependencies 7 years ago
Gopkg.toml 4cb50d916b chore: update dependencies 7 years ago
LICENSE cd22d83ab6 Create LICENSE 8 years ago
Makefile 5622b954fb chore(build): update build env to include npm 8 years ago
README.md 3ae849d6e7 doc(readme): improve the wording of quickstart instructions 7 years ago
build.sh d42c20dc41 chore: fix user generation after package install 8 years ago
const.go 8e3f01dc7d feat: connected users 7 years ago
db.go 55acfb6b25 refactor: major refactor of all service 8 years ago
db_test.go 55acfb6b25 refactor: major refactor of all service 8 years ago
doc.go 6006fb9610 feat(api): implement authentication service 8 years ago
generate.go cbaf634afb doc(generate): seperate docstring from package definition 8 years ago
net.go 9ce7db14b1 refactor(vpn): move all funcs under Server struct 7 years ago
net_test.go 9ce7db14b1 refactor(vpn): move all funcs under Server struct 7 years ago
parselog.go 85478d5e5a refactor(parselog): accept io.Reader instead of path 7 years ago
parselog_test.go 5a547099f7 test(parselog): add test for parseStatusLog 7 years ago
perms.go 0ec54061e3 doc(perms): improve docstrings 8 years ago
user.go 9ce7db14b1 refactor(vpn): move all funcs under Server struct 7 years ago
user_test.go 9ce7db14b1 refactor(vpn): move all funcs under Server struct 7 years ago
vpn.go 1c6c9e0b63 chore: remove debug line 7 years ago
vpn_test.go cf1e09661d chore: remove debug line 7 years ago

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.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 the server after fresh install
$ ovpm vpn init --hostname <vpn.example.com>
INFO[0004] ovpm server initialized

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

# Finally export the vpn profile for, the created 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