README.md 1.7 KB

OVPM - OpenVPn Manager

Build Status GitHub version codecov GoDoc

OVPM allows you to manage an OpenVPN server from command line easily. With OVPM you can create and run an OpenVPN server, add/remove vpn users, generate client .ovpn files for your users etc.

Usage

Install OVPM:

$ go get -u github.com/cad/ovpm/...

And verify the installation by running ovpmd:

$ ovpmd --version

ovpmd version 0.1.0

And also make sure openvpn is also installed on the host:

$ openvpn --version

OpenVPN 2.4.3 x86_64-pc-linux-gnu [SSL (OpenSSL)] [LZO] [LZ4] [EPOLL] [PKCS11] [MH/PKTINFO]
...

Now you can actually run the ovpmd server:

# Since ovpmd launches and supervises openvpn binary it needs root privileges.
$ sudo ovpmd

INFO[0000] OVPM is running :9090 ...                    

In another terminal you can use ovpm via the command line tool, ovpm:

$ ovpm 

NAME:
   ovpm - OpenVPN Manager

USAGE:
   main [global options] command [command options] [arguments...]

VERSION:
   0.1.0

COMMANDS:
     user     User Operations
     vpn      VPN Operations
     help, h  Shows a list of commands or help for one command

GLOBAL OPTIONS:
   --verbose            verbose output
   --daemon-port value  port number for OVPM daemon to call
   --help, -h           show help
   --version, -v        print the version