diff options
| -rw-r--r-- | INSTALL.md | 16 | ||||
| -rw-r--r-- | TROUBLESHOOT.md | 46 |
2 files changed, 58 insertions, 4 deletions
@@ -1,10 +1,13 @@ # Installation # +Please see TROUBLESHOOT.md if you run into any issues during install. + ## TL;DR ## -Install git, ruby, rubygems, bundler and couchdb on your system. Then run +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 bundle install @@ -13,6 +16,8 @@ git submodule update bundle exec 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. @@ -37,11 +42,13 @@ Simply clone the git repository: ### 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 +``` -Install all the required gems: +Then install all the required gems: ``` bundle install ``` @@ -68,3 +75,4 @@ If you want to use that functionality please add your provider files the public/ bundle exec rails server ``` +You'll find Leap Web running on `localhost:3000` diff --git a/TROUBLESHOOT.md b/TROUBLESHOOT.md new file mode 100644 index 0000000..f3db006 --- /dev/null +++ b/TROUBLESHOOT.md @@ -0,0 +1,46 @@ +# Troubleshooting # + +Here are some less common issues you might run into when installing Leap Web. + +## Cannot find Bundler ## + +### Error Messages ### + +`bundle: command not found` + +### Solution ### + +Make sure bundler is installed. `gem list bundler` should list `bundler`. +You also need to be able to access the `bundler` executable in your PATH. + +## Outdated version of rubygems ## + +### Error Messages ### + +`bundler requires rubygems >= 1.3.6` + +### Solution ### + +`gem update --system` will install the latest rubygems + +## Missing development tools ## + +Some required gems will compile C extensions. They need a bunch of utils for this. + +### Error Messages ### + +`make: Command not found` + +### Solution ### + +Install the required tools. For linux the `build-essential` package provides most of them. For Mac OS you probably want the XCode Commandline tools. + +## Missing libraries and headers ## + +Some gem dependencies might not compile because they lack the needed c libraries. + +### Solution ### + +Install the libraries in question including their development files. + + |