Nav apraksta

Mustafa Arici 46982f21f7 refactor(user): use consistent datetime standart within gRPC 7 gadi atpakaļ
api 34f46e7302 chore(webui): add static files to bindata 7 gadi atpakaļ
bindata 34fe513f89 feat(webui): ensure assets are fetched from the OVPM HTTP server only 7 gadi atpakaļ
cmd 46982f21f7 refactor(user): use consistent datetime standart within gRPC 7 gadi atpakaļ
contrib 29fe7fcd76 chore(build): ensure nogroup does exist on the target 7 gadi atpakaļ
errors fc6ff58592 refactor(cmd/ovpm): refactor ovpm commands 7 gadi atpakaļ
permset 5b9fdc5548 doc(permset): add package docstring 8 gadi atpakaļ
pki 3c59a7469c doc: fix the word usage whether 8 gadi atpakaļ
supervisor 50f831d884 fix(vpn): ensure Emit() when restarting 8 gadi atpakaļ
template 34fe513f89 feat(webui): ensure assets are fetched from the OVPM HTTP server only 7 gadi atpakaļ
webui 34fe513f89 feat(webui): ensure assets are fetched from the OVPM HTTP server only 7 gadi atpakaļ
.gitignore fc6ff58592 refactor(cmd/ovpm): refactor ovpm commands 7 gadi atpakaļ
.travis.yml 5c4c565601 chore(ci): fix on fix 8 gadi atpakaļ
CHANGELOG.md 19eabf865e release: v0.2.6 8 gadi atpakaļ
Dockerfile 9e1f03e051 chore(Dockerfile): drop MAINTAINER keyword 7 gadi atpakaļ
Gopkg.lock 4cb50d916b chore: update dependencies 7 gadi atpakaļ
Gopkg.toml 4cb50d916b chore: update dependencies 7 gadi atpakaļ
LICENSE cd22d83ab6 Create LICENSE 8 gadi atpakaļ
Makefile 5622b954fb chore(build): update build env to include npm 8 gadi atpakaļ
README.md 3ae849d6e7 doc(readme): improve the wording of quickstart instructions 7 gadi atpakaļ
build.sh d42c20dc41 chore: fix user generation after package install 8 gadi atpakaļ
const.go 0de988f873 chore: bump to 0.2.7-beta 7 gadi atpakaļ
db.go 55acfb6b25 refactor: major refactor of all service 8 gadi atpakaļ
db_test.go 55acfb6b25 refactor: major refactor of all service 8 gadi atpakaļ
doc.go 6006fb9610 feat(api): implement authentication service 8 gadi atpakaļ
generate.go 34f46e7302 chore(webui): add static files to bindata 7 gadi atpakaļ
net.go 9ce7db14b1 refactor(vpn): move all funcs under Server struct 7 gadi atpakaļ
net_test.go 9ce7db14b1 refactor(vpn): move all funcs under Server struct 7 gadi atpakaļ
parselog.go 85478d5e5a refactor(parselog): accept io.Reader instead of path 7 gadi atpakaļ
parselog_test.go 5a547099f7 test(parselog): add test for parseStatusLog 7 gadi atpakaļ
perms.go 0ec54061e3 doc(perms): improve docstrings 8 gadi atpakaļ
user.go 46982f21f7 refactor(user): use consistent datetime standart within gRPC 7 gadi atpakaļ
user_internal_test.go c45c1786f9 test(user): add tests for ConectionStatus 7 gadi atpakaļ
user_test.go 645c27dba1 feat(user): impl. ExpiresAtExpiresAt returns date time for which the user certificate gets expired. 7 gadi atpakaļ
vpn.go eb561943de refactor(vpn): remove unnecessary line 7 gadi atpakaļ
vpn_test.go cf1e09661d chore: remove debug line 7 gadi atpakaļ

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