Update readme with new recipe structure

Author: andruby

README.md

@@ -2,19 +2,46 @@
 
 Chef cookbook to setup gitlab v5.2 according to [these instructions](https://github.com/gitlabhq/gitlabhq/blob/v5.2.0/doc/install/installation.md).
 
-# Requirements
+## Requirements
 
-To develop and test this cookbook, we recommend installing [Vagrant](http://www.vagrantup.com/) and [vagrant-berkshelf](https://github.com/RiotGames/vagrant-berkshelf).
+To contribute to and test this cookbook, we recommend installing [Vagrant](http://www.vagrantup.com/) and [vagrant-berkshelf](https://github.com/RiotGames/vagrant-berkshelf).
 
-#### Platforms
+### Supported Platforms
 * Ubuntu 12.04
 * CentOS 6.4
 
-# Usage
+## Attributes
 
-## gitlab::default
+It is recommended that you change the following attributes:
+
+* `node['gitlab']['root']['name']` - Name of the root user. (default: 'Administrator')
+* `node['gitlab']['root']['email']` - Email of the root user. (default: '[email protected]')
+* `node['gitlab']['root']['username']` - Username of the root user. (default: 'root')
+* `node['gitlab']['root']['password']` - Password of the root user. (default: '5iveL!fe')
+
+Set these attributes to match your server configuration:
+
+* `node['gitlab']['url']` - Url to the gitlab instance. Used for api calls (default: 'http://localhost/')
+* `node['gitlab']['host']` - Host name in gitlab.yml (default: 'localhost')
+* `node['gitlab']['email_from']` - Email address used in the "From" field in mails sent by GitLab (default: 'gitlab@localhost')
+* `node['gitlab']['support_email']` - Email address of your support contact (default: 'support@localhost')
+
+See the `attributes/default.rb` file for the full list of attributes.
+
+## Usage
+
+Installing Ruby and configuring Nginx are now  separated from the default recipe. This allows users to choose their prefered ruby installation and to use apache instead of nginx. (If you do use apache, please consider writing a recipe and opening a pull request).
 
-Default recipe. Installs Gitlab with all its dependencies. Configures it as a service that is started at boot time.
+There are three recipes in this cookbook to help you install ruby:
+
+* `gitlab::ruby_package`: Install ruby through the OS package manager. Uses the `node['ruby_package']['version']` attribute. (Recommended for new user)
+* `gitlab::ruby_build`: Compile ruby from source with [ruby_build](https://github.com/sstephenson/ruby-build). Uses the `node['ruby_build']['version']` attribute. (For advanced users)
+* `gitlab::ruby_rvm`: Compile ruby via [rvm](https://rvm.io/). This recipe is a little less stable than the previous two recipes. Please open an issue or pull request if you encounter problems. Uses the `node['rvm']['default_ruby']` attribute.
+
+
+### gitlab::default
+
+Default recipe. Installs Gitlab and its dependencies. Configures it as a service that is started at boot time.
 
 Add `gitlab::default` to your node's run_list and make sure to set these attributes:
 
@@ -40,19 +67,23 @@ Add `gitlab::default` to your node's run_list and make sure to set these attribu
 }
 ```
 
-When running on CentOS, you also have to provide the following RVM configuration:
+Make sure your node has ruby 1.9.3 installed. (eg: by using the `gitlab::ruby_package` recipe). You can optionally add the `gitlab::nginx`.
 
 ```json
-"rvm" : {
-  "default_ruby" : "1.9.3",
-  "global_gems" : [
-    {"name" : "bundler"},
-    {"name" : "chef"}
+{
+  "run_list": [
+  "recipe[gitlab::ruby_package]",
+  "recipe[gitlab::default]",
+  "recipe[gitlab::nginx]"
   ]
 }
 ```
 
-## With Vagrant from an other repository
+See the [Vagrantfile](https://github.com/andruby/gitlab-cookbook/blob/master/Vagrantfile) for a full example.
+
+### gitlab::development
+
+Recipe to set up most development requirements.
 
 When I work on the GitlabHQ code I use this Vagrantfile (inside the GitlabHQ code directory):
 
@@ -66,8 +97,8 @@ Vagrant.configure("2") do |config|
   config.vm.hostname = "gitlab-dev"
 
   # Standard Ubuntu 12.04.2 base box
-  config.vm.box = "ubuntu-12.04.2-amd64"
-  config.vm.box_url = "https://dl.dropbox.com/u/2894322/ubuntu-12.04.2-amd64.box"
+  config.vm.box = "ubuntu-12.04.2-amd64-chef-11-omnibus"
+  config.vm.box_url = "http://grahamc.com/vagrant/ubuntu-12.04-omnibus-chef.box"
 
   # Create a forwarded port mapping which allows access to a specific port
   # within the machine from a port on the host machine. In the example below,
@@ -76,6 +107,7 @@ Vagrant.configure("2") do |config|
   config.vm.network :forwarded_port, guest: 3000, host: 3001  # Development Puma
 
   config.vm.provision :chef_solo do |chef|
+    chef.log_level = :debug
     chef.json = {
       :mysql => {
         :server_root_password => 'rootpass',
@@ -84,46 +116,25 @@ Vagrant.configure("2") do |config|
         :bind_address => 'localhost'
       },
       :gitlab => {
-        :mysql_password => 'k09vw7wa5s',
-        :path => '/vagrant',
-        :rails_env => 'development',
-        :sync_repository => false,
-        :bundle_install_cmd => 'bundle install --without postgres'
+        :mysql_password => 'gitlabpass'
       }
     }
 
-    chef.add_recipe "gitlab::default"
+    chef.add_recipe "gitlab::ruby_build"
+    chef.add_recipe "gitlab::development"
   end
 end
 ```
 
-Note the `path`, `sync_repository`, `rails_env` and `bundle_install_cmd` used to set gitlab in development mode.
-
-With this Berksfile
+With this Berksfile:
 
-```
+```ruby
 cookbook 'gitlab', :git => 'https://github.com/andruby/gitlab-cookbook.git'
 ```
 
-# Attributes
-
-It is recommended that you change the following attributes:
-
-* `node['gitlab']['root']['name']` - Name of the root user. (default: 'Administrator')
-* `node['gitlab']['root']['email']` - Email of the root user. (default: '[email protected]')
-* `node['gitlab']['root']['username']` - Username of the root user. (default: 'root')
-* `node['gitlab']['root']['password']` - Password of the root user. (default: '5iveL!fe')
-
-Set these attributes to match your server configuration:
-
-* `node['gitlab']['url']` - Url to the gitlab instance. Used for api calls (default: 'http://localhost/')
-* `node['gitlab']['host']` - Host name in gitlab.yml (default: 'localhost')
-* `node['gitlab']['email_from']` - Email address used in the "From" field in mails sent by GitLab (default: 'gitlab@localhost')
-* `node['gitlab']['support_email']` - Email address of your support contact (default: 'support@localhost')
-
-See the `attributes/default.rb` file for the full list of attributes.
+When your VM is up and provisioned you should run `bundle install --without postgres` and `rake gitlab:setup` inside the VM in the `/vagrant` directory.
 
-# Authors
+## Authors
 
 * [Andrew Fecheyr](https://github.com/andruby) (<[email protected]>)
 * [Aimo Thiele](https://github.com/athiele) (<[email protected]>)