Keine Beschreibung

Mustafa Arici abb1453e70 chore(Makefile): build dynamic vor 5 Jahren
.github 46ceb3c53f Update go.yml vor 5 Jahren
api 64c03b3896 chore(proto): generat protos vor 5 Jahren
cmd 2aa560a631 style(cmd): format vor 5 Jahren
contrib 6e266184bc chore: move scripts from contrib to scripts/ dir vor 5 Jahren
errors b07cbde9ce Feature: Added keepalive-period, keepalive-timeout and use-lzo params support vor 6 Jahren
permset 5b9fdc5548 doc(permset): add package docstring vor 8 Jahren
pki 6ec7bb72d2 chore: switch to go mod vor 7 Jahren
scripts 6e266184bc chore: move scripts from contrib to scripts/ dir vor 5 Jahren
supervisor 6ec7bb72d2 chore: switch to go mod vor 7 Jahren
webui 38c6e59054 chore(webui): update deps vor 5 Jahren
.gitignore 39c62f5be5 chore(gitignore): ignore build dirs vor 5 Jahren
CHANGELOG.md e254739ce3 doc(Changelog): update changelog vor 5 Jahren
Dockerfile 9e1f03e051 chore(Dockerfile): drop MAINTAINER keyword vor 7 Jahren
LICENSE cd22d83ab6 Create LICENSE vor 8 Jahren
Makefile abb1453e70 chore(Makefile): build dynamic vor 5 Jahren
README.md e5c389d184 chore: replace ci badge vor 5 Jahren
build.sh d42c20dc41 chore: fix user generation after package install vor 8 Jahren
const.go 9694cc34f2 refactor: make ovpm.Version a variable not a constant vor 5 Jahren
db.go 6ec7bb72d2 chore: switch to go mod vor 7 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 4f34e07500 chore: use makefile for code generation vor 5 Jahren
go.mod ca2ddecd0e chore(vgo): update deps vor 5 Jahren
go.sum ca2ddecd0e chore(vgo): update deps vor 5 Jahren
net.go 6ec7bb72d2 chore: switch to go mod vor 7 Jahren
net_test.go ec7f296253 created description field in user profile vor 6 Jahren
nfpm.yaml e8daf853a1 chore: switch to nfpm for package creation vor 5 Jahren
parselog.go 9f97850442 fix(parselog): recover panic from parsing OpenVPN log vor 7 Jahren
parselog_test.go 9f97850442 fix(parselog): recover panic from parsing OpenVPN log vor 7 Jahren
perms.go 0ec54061e3 doc(perms): improve docstrings vor 8 Jahren
templates.go 5546a03af6 refactor: relocate actual templates from bindata to code itself vor 5 Jahren
user.go ec7f296253 created description field in user profile vor 6 Jahren
user_internal_test.go ec7f296253 created description field in user profile vor 6 Jahren
user_test.go ec7f296253 created description field in user profile vor 6 Jahren
vpn.go 5546a03af6 refactor: relocate actual templates from bindata to code itself vor 5 Jahren
vpn_test.go ec7f296253 created description field in user profile vor 6 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

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

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