summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorAzul <azul@leap.se>2012-10-22 15:36:27 +0200
committerAzul <azul@leap.se>2013-02-27 09:38:07 +0100
commitd656c33422c3d3ac72878e8ddccbd087a48a401c (patch)
treec4705e85a99228bf284321e655a715a67a4389bc
parent97fe2b4d19edacf2ea67c7efcfbec50feca305b0 (diff)
added TL;DR - fixed some issues with documentation
* using ruby 1.9.3 now * not using leap_ca anymore
-rw-r--r--INSTALL.md40
1 files changed, 33 insertions, 7 deletions
diff --git a/INSTALL.md b/INSTALL.md
index 9e93eb0..ce17f39 100644
--- a/INSTALL.md
+++ b/INSTALL.md
@@ -1,5 +1,18 @@
# Installation #
+## TL;DR ##
+
+Install git, ruby, rubygems, bundler and couchdb on your system. Then run
+
+```
+git clone git://github.com/leapcode/leap_web.git
+cd leap_web
+bundle install
+git submodule init
+git submodule update
+bundle exec rails server
+```
+
## Requirements ##
The webapp only depends on very basic ruby packages and installs the other requirements as gems through bundler.
@@ -9,17 +22,29 @@ The webapp only depends on very basic ruby packages and installs the other requi
The following packages need to be installed:
* git
-* ruby (1.8.7 and 1.9.3 work)
+* ruby1.9.3
* rubygems
* couchdb
+### Code ###
+
+Simply clone the git repository:
+
+```
+ git clone git://github.com/leapcode/leap_web.git
+ cd leap_web
+```
+
### Gems ###
We install most gems we depend upon through [bundler](http://gembundler.com). However the bundler gem needs to be installed and the `bundle` command needs to be available to the user used for deploy.
### Bundler ###
-Run `bundle install` to install all the required gems.
+Install all the required gems:
+```
+ bundle install
+```
## Setup ##
@@ -32,13 +57,14 @@ We currently use a git submodule to include srp-js. This will soon be replaced b
git submodule update
```
-### Cert Distribution ###
+### Provider Information ###
-The Webapp can hand out certs for the EIP client. These certs are either picked from a pool in CouchDB or from a file. For now you can either run [Leap CA](http://github.com/leapcode/leap_ca) to fill the pool or you can put your certs file in config/cert.
-
-We also ship provider information through the webapp. For now please add your eip-service.json to the public/config directory.
+The leap client fetches provider information via json files from the server.
+If you want to use that functionality please add your provider files the public/config directory.
## Running ##
-Run `rails server`, `bundle exec rails server` or whatever rack server you prefer.
+```
+bundle exec rails server
+```