README

<h2> OpenVPN Manager for Linux/Gentoo </h2>

This is an attempt to create an awesome open source openVPN Manager for Linux. 
It is tested to run on Gentoo Linux, but actually should work on all Linux and OSX, just need to change the paths on the settings pane.

It's still very basic now. I will try to copy some functionality from the official openvpn manager.

Anyone interested to join me is very welcome. 


<h2> About Application </h2>

Right now at this early stage, the application is in safe-mode. 
Which means that it will make no changes to you current openvpn configuration and files. It will only read and display. So it's safe to try out and experiment. 

There are two modes of operation. 

<h3>1. Using the database: </h3>

- Using the database to store the user keys. 
- you can store more data about the client, such as email, user login, and other stuff.
- if you use other scripts to generate the keys, they will not show up in the application. 
  You will need to migrate them to the database.

<h3>2. Using the filesystem:</h3>

- default mode
- The keys are store and read by the filesystem each query.
- could be faster.
- if you use other scripts to generate the keys, they will show up in the application.



<h2> Requirements: </h2>

- rails, mysql/sqlite
- OpenVPN
- You need to know where is the 'easyrsa' folder (included in openvpn)
- you need to load the 'vars' variables into the settings of the application.

<h2> Gems </h2>

- formtastic
- authlogic
- thoughtbot-factory_girl
- rspec
- cucumber 


<h2> Installation </h2>

1. Edit database.yml
2. Edit db/seed.rb
2. sudo rake gems:install
3. rake db:create
3. rake db:migrate
4. rake db:seed
5. ruby ./script/server

Then login as :

email: "admin"
password: "welcome"

you can change login info in db/seed.rb