summaryrefslogtreecommitdiff
path: root/INSTALL.md
diff options
context:
space:
mode:
authorAzul <azul@leap.se>2013-03-05 13:35:05 +0100
committerAzul <azul@leap.se>2013-03-05 13:35:05 +0100
commit27c16ccceffa1d8eaaf02612cf29a60bfe6ced01 (patch)
tree1df9d9900872cf2e97d5c27b4175816eff5cbf80 /INSTALL.md
parent733426aa3992dafaf1c58ede7e74018057a01148 (diff)
parent87c306ea212c01ecc8f98009def5971fc4d5af11 (diff)
Merge branch 'master' into feature/limit_user_leak
Conflicts: users/lib/warden/strategies/secure_remote_password.rb
Diffstat (limited to 'INSTALL.md')
-rw-r--r--INSTALL.md52
1 files changed, 43 insertions, 9 deletions
diff --git a/INSTALL.md b/INSTALL.md
index 9e93eb0..7e95b76 100644
--- a/INSTALL.md
+++ b/INSTALL.md
@@ -1,5 +1,23 @@
# Installation #
+Please see TROUBLESHOOT.md if you run into any issues during install.
+
+## TL;DR ##
+
+Install git, ruby 1.9, rubygems and couchdb on your system. Then run
+
+```
+gem install bundler
+git clone git://github.com/leapcode/leap_web.git
+cd leap_web
+git submodule init
+git submodule update
+bundle install --binstubs
+bin/rails server
+```
+
+You will find Leap Web running on `localhost:3000`. Check out the Cert Distribution section below for setting up the cert and server config.
+
## Requirements ##
The webapp only depends on very basic ruby packages and installs the other requirements as gems through bundler.
@@ -9,17 +27,31 @@ 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.
+We install most gems we depend upon through [bundler](http://gembundler.com). First install bundler
-### Bundler ###
+```
+ gem install bundler
+```
-Run `bundle install` to install all the required gems.
+Then install all the required gems:
+```
+ bundle install --binstubs
+```
## Setup ##
@@ -32,13 +64,15 @@ We currently use a git submodule to include srp-js. This will soon be replaced b
git submodule update
```
-### Cert Distribution ###
-
-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.
+### Provider Information ###
-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.
+```
+bin/rails server
+```
+You'll find Leap Web running on `localhost:3000`