diff options
| author | elijah <elijah@riseup.net> | 2015-04-29 13:51:11 -0700 |
|---|---|---|
| committer | elijah <elijah@riseup.net> | 2015-04-29 13:51:11 -0700 |
| commit | e99856e5338424b36884e21db1f1399f4753ab3a (patch) | |
| tree | 1e11e8b27c63f848a876f8f5dfca2e3b4eb5deb7 | |
| parent | 73fd6f5ef05adf5abdb31bcca4377c0ee7ca052b (diff) | |
clean up docs
| -rw-r--r-- | INSTALL.md | 78 | ||||
| -rw-r--r-- | doc/CUSTOM.md (renamed from CUSTOM.md) | 0 | ||||
| -rw-r--r-- | doc/DEPLOY.md (renamed from DEPLOY.md) | 0 | ||||
| -rw-r--r-- | doc/DEVELOP.md (renamed from DEVELOP.md) | 0 | ||||
| -rw-r--r-- | doc/KNOWN_PROBLEMS.md | 4 | ||||
| -rw-r--r-- | doc/README_FOR_APP | 2 | ||||
| -rw-r--r-- | doc/TROUBLESHOOT.md (renamed from TROUBLESHOOT.md) | 0 | ||||
| -rw-r--r-- | doc/examples/capistrano/Capfile (renamed from Capfile) | 0 | ||||
| -rw-r--r-- | doc/examples/capistrano/deploy.rb (renamed from config/deploy.rb.example) | 0 |
9 files changed, 4 insertions, 80 deletions
diff --git a/INSTALL.md b/INSTALL.md deleted file mode 100644 index 75cb2a6..0000000 --- a/INSTALL.md +++ /dev/null @@ -1,78 +0,0 @@ -# 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 https://leap.se/git/leap_web -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. - -### Packages ### - -The following packages need to be installed: - -* git -* ruby1.9.3 -* rubygems -* couchdb - -### Code ### - -Simply clone the git repository: - -``` - git clone https://leap.se/git/leap_web - cd leap_web -``` - -### Gems ### - -We install most gems we depend upon through [bundler](http://gembundler.com). First install bundler - -``` - gem install bundler -``` - -Then install all the required gems: -``` - bundle install --binstubs -``` - -## Setup ## - -### SRP submodule ### - -We currently use a git submodule to include srp-js. This will soon be replaced by a ruby gem. but for now you need to run - -``` - git submodule init - git submodule update -``` - -### Provider Information ### - -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 ## - -``` -bin/rails server -``` - -You'll find Leap Web running on `localhost:3000` diff --git a/CUSTOM.md b/doc/CUSTOM.md index 53e4d88..53e4d88 100644 --- a/CUSTOM.md +++ b/doc/CUSTOM.md diff --git a/DEPLOY.md b/doc/DEPLOY.md index 33d5598..33d5598 100644 --- a/DEPLOY.md +++ b/doc/DEPLOY.md diff --git a/DEVELOP.md b/doc/DEVELOP.md index 991218e..991218e 100644 --- a/DEVELOP.md +++ b/doc/DEVELOP.md diff --git a/doc/KNOWN_PROBLEMS.md b/doc/KNOWN_PROBLEMS.md new file mode 100644 index 0000000..d35c743 --- /dev/null +++ b/doc/KNOWN_PROBLEMS.md @@ -0,0 +1,4 @@ +PROBLEMS + +rake couchrest:migrate on empty db fails + diff --git a/doc/README_FOR_APP b/doc/README_FOR_APP deleted file mode 100644 index fe41f5c..0000000 --- a/doc/README_FOR_APP +++ /dev/null @@ -1,2 +0,0 @@ -Use this README file to introduce your application and point to useful places in the API for learning more. -Run "rake doc:app" to generate API documentation for your models, controllers, helpers, and libraries. diff --git a/TROUBLESHOOT.md b/doc/TROUBLESHOOT.md index f3db006..f3db006 100644 --- a/TROUBLESHOOT.md +++ b/doc/TROUBLESHOOT.md diff --git a/Capfile b/doc/examples/capistrano/Capfile index f65237f..f65237f 100644 --- a/Capfile +++ b/doc/examples/capistrano/Capfile diff --git a/config/deploy.rb.example b/doc/examples/capistrano/deploy.rb index 1fd4b8c..1fd4b8c 100644 --- a/config/deploy.rb.example +++ b/doc/examples/capistrano/deploy.rb |