Ingen beskrivning

Mustafa Arıcı 46ceb3c53f Update go.yml 5 år sedan
.github 46ceb3c53f Update go.yml 5 år sedan
api 64c03b3896 chore(proto): generat protos 5 år sedan
cmd 2aa560a631 style(cmd): format 5 år sedan
contrib 73798c4d80 chore(build): fix typo 7 år sedan
errors b07cbde9ce Feature: Added keepalive-period, keepalive-timeout and use-lzo params support 6 år sedan
permset 5b9fdc5548 doc(permset): add package docstring 8 år sedan
pki 6ec7bb72d2 chore: switch to go mod 7 år sedan
supervisor 6ec7bb72d2 chore: switch to go mod 7 år sedan
webui 7e6b05377d chore(webui): update yarn deps 5 år sedan
.gitignore 39c62f5be5 chore(gitignore): ignore build dirs 5 år sedan
CHANGELOG.md 4beee04e17 chore: add changelog 7 år sedan
Dockerfile 9e1f03e051 chore(Dockerfile): drop MAINTAINER keyword 7 år sedan
LICENSE cd22d83ab6 Create LICENSE 8 år sedan
Makefile b003631f5b chore(makefile): add bundle, test and proto targets 5 år sedan
README.md e5c389d184 chore: replace ci badge 5 år sedan
build.sh d42c20dc41 chore: fix user generation after package install 8 år sedan
const.go b07cbde9ce Feature: Added keepalive-period, keepalive-timeout and use-lzo params support 6 år sedan
db.go 6ec7bb72d2 chore: switch to go mod 7 år sedan
db_test.go 55acfb6b25 refactor: major refactor of all service 8 år sedan
doc.go 6006fb9610 feat(api): implement authentication service 8 år sedan
generate.go 4f34e07500 chore: use makefile for code generation 5 år sedan
go.mod b6ac0002db chore(vgo): update deps 5 år sedan
go.sum b6ac0002db chore(vgo): update deps 5 år sedan
net.go 6ec7bb72d2 chore: switch to go mod 7 år sedan
net_test.go ec7f296253 created description field in user profile 6 år sedan
parselog.go 9f97850442 fix(parselog): recover panic from parsing OpenVPN log 7 år sedan
parselog_test.go 9f97850442 fix(parselog): recover panic from parsing OpenVPN log 7 år sedan
perms.go 0ec54061e3 doc(perms): improve docstrings 8 år sedan
templates.go 5546a03af6 refactor: relocate actual templates from bindata to code itself 5 år sedan
user.go ec7f296253 created description field in user profile 6 år sedan
user_internal_test.go ec7f296253 created description field in user profile 6 år sedan
user_test.go ec7f296253 created description field in user profile 6 år sedan
vpn.go 5546a03af6 refactor: relocate actual templates from bindata to code itself 5 år sedan
vpn_test.go ec7f296253 created description field in user profile 6 år sedan

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