From b17f0c696d0320eebf0ff296f4ad9c20af8703f1 Mon Sep 17 00:00:00 2001 From: Alaa Qutaish Date: Thu, 12 Mar 2015 04:42:34 +0100 Subject: [PATCH] update README --- README.md | 15 ++++++++------- 1 file changed, 8 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index f570781..69df1fb 100644 --- a/README.md +++ b/README.md @@ -1,16 +1,13 @@ # oh-my-vpn! Setup your own OpenVPN server in 30 seconds! and secure your naked internet connections before it is too late. -### Installation: +### Server Setup Pick a new cheap server, CPU and Memory does not really matter Make sure you get Ubuntu 14.10 as it is the only platform tested so far. -install the following dependencies +Install the required dependencies Pull down the repository to your server run chef-solo -After your run chef-solo your OpenVPN server will be ready to use, except you -need to copy the key and certificate and install them into your favorite openvpn-client - ### Install the dependencies first: ``` @@ -26,15 +23,19 @@ sudo gem install ohai chef --no-rdoc --no-ri cd /tmp/ && git clone https://github.com/alaa/oh-my-vpn.git sudo chef-solo -c /tmp/oh-my-vpn/solo.rb ``` + +### Post-Installation +After your run chef-solo, your OpenVPN server will be ready: +- Copy the generated config ```/root/client.conf``` and place it in your laptop at ```/etc/openvpn``` +- Restart openvpn service on your laptop ``` service openvpn restart``` + ### Supporting Operating Systems ``` Ubuntu 14.10 ``` ### TODO -- Generate Client SSL certificates - Email the client certificates to the user email - Make one-liner command for installation - Add recipe to configure the client machine -- Write system tests on top of docker and kitchen - Pipe-line the project to Travis-ci for continous testing - Add Support Ubuntu [14.04, 13.10, 13.04, 12.10, 12.04] and Debian [7.4, 7.0]