No Description

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

# 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