Skip to content

Commit

Permalink
update README
Browse files Browse the repository at this point in the history
  • Loading branch information
alaa committed Mar 12, 2015
1 parent 713ade3 commit b17f0c6
Showing 1 changed file with 8 additions and 7 deletions.
15 changes: 8 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
@@ -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:

```
Expand All @@ -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]

0 comments on commit b17f0c6

Please sign in to comment.