Geen omschrijving

Mustafa Arici b86f7b201a Merge branch 'release-v0.2.5' 8 jaren geleden
api 0b7c7cb222 feat(api): expose restart vpn functionality over api 8 jaren geleden
bindata e56ad6809a release: v0.2.5 8 jaren geleden
cmd ce31ee4923 feat(cmd): add vpn restart cmd 8 jaren geleden
contrib b778191618 refactor(package): disable verbose output 8 jaren geleden
permset 5b9fdc5548 doc(permset): add package docstring 8 jaren geleden
pki 3c59a7469c doc: fix the word usage whether 8 jaren geleden
supervisor 50f831d884 fix(vpn): ensure Emit() when restarting 8 jaren geleden
template 77ae50b414 feat(conf): set AES-128-CBC as the cipher 8 jaren geleden
webui 0bb8bf6ab4 feat(webui): add restart vpn button 8 jaren geleden
.gitignore 33a3d57151 init: add gitignore 8 jaren geleden
.travis.yml 5c4c565601 chore(ci): fix on fix 8 jaren geleden
CHANGELOG.md e56ad6809a release: v0.2.5 8 jaren geleden
Dockerfile 5622b954fb chore(build): update build env to include npm 8 jaren geleden
LICENSE cd22d83ab6 Create LICENSE 8 jaren geleden
Makefile 5622b954fb chore(build): update build env to include npm 8 jaren geleden
README.md 6e35f648cd doc(readme): update stated OpenVPN dependency 8 jaren geleden
build.sh d42c20dc41 chore: fix user generation after package install 8 jaren geleden
const.go e56ad6809a release: v0.2.5 8 jaren geleden
db.go 55acfb6b25 refactor: major refactor of all service 8 jaren geleden
db_test.go 55acfb6b25 refactor: major refactor of all service 8 jaren geleden
doc.go 6006fb9610 feat(api): implement authentication service 8 jaren geleden
generate.go cbaf634afb doc(generate): seperate docstring from package definition 8 jaren geleden
net.go 50f831d884 fix(vpn): ensure Emit() when restarting 8 jaren geleden
net_test.go 5479ea9562 fix(net,user): improve handle validation process 8 jaren geleden
perms.go 0b7c7cb222 feat(api): expose restart vpn functionality over api 8 jaren geleden
user.go 50f831d884 fix(vpn): ensure Emit() when restarting 8 jaren geleden
user_test.go 689f258164 fix(user): don't allow assigning server's ip to the client 8 jaren geleden
vpn.go 0b7c7cb222 feat(api): expose restart vpn functionality over api 8 jaren geleden
vpn_test.go 0f211905e5 test(vpn): remove client ovpn config nopull check 8 jaren geleden

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 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