railsmachine-railsmachine 1.0.3 → 1.0.4

data/README.textile

@@ -1,32 +1,133 @@
-h1. Railsmachine
-
-A set of capistrano recipes for simplifying the deployment of Rails applications.
-
-The deployment process looks like this:
-
-<code>
-  <pre>
-    cd <app_directory>
-    capify .
-    railsmachine --apply-to . --name <app_name> --domain <yourdomain.com>
-    cap repos:setup
-    cd ../<app_name>_machine
-    cap servers:setup deploy:cold
-  </pre>
-</code>
-
-Under the default configuration the gem will use these directories:
-
-<code>
-  <pre>
-    /var/www/apps/            - Rails applications
-    /etc/httpd/conf/apps/     - Apache configurations
-    /var/run/mongrel_cluster/ - Mongrel pid files
-    /etc/mongrel_cluster/     - Mongrel cluster configurations
-  </pre>
-</code>
-
-h3. Requirements
-
-* a 'deploy' system account with write access to the above directories.
-* You also need a 'deploy' mysql account with all privileges on *.* and grant option.
+h1. Five Minute Rails Application Deployment
+
+Ready to deploy your Rails application to "Rails Machine":http://railsmachine.com/? Follow these steps and you'll have it running in no time! Feel free to utilize Rails Machine's Ask Us Anything Support and "contact us with any questions you have along the way":https://support.railsmachine.com/index.php?pg=request.
+
+h2. Update Gems
+
+Install the latest version of the "railsmachine gem":http://github.com/railsmachine/railsmachine:
+
+<pre>
+  <code>
+    $ sudo gem install railsmachine
+  </code>
+</pre>
+
+h2. Install Phusion Passenger and Ruby Enterprise Edition
+
+If you do not have Phusion Passenger and Ruby Enterprise Edition installed on your Rails Machine yet you can run this installer on your server. 
+
+<pre>
+  <code>
+	$ wget http://assets.railsmachine.com/wiki/centos_passenger_install.sh
+	$ sh centos_passenger_install.sh
+  </code>
+</pre>
+
+
+h2. Setup Capistrano
+
+Capify your application:
+
+<pre>
+  <code>
+    $ capify .
+  </code>
+</pre>
+
+h2. Configure Capistrano for Rails Machine
+
+The following step customizes your @config/deploy.rb@ with two bits of information you provide:
+
+* *@--name@*: a simple name for your application. no spaces, please.
+** example: my-cool-app
+* *@--domain@*: the primary domain name for your application. please omit the 'www' - we automaticaly alias www.whateveryouprovide.com as needed.
+** example: my-cool-app.com
+
+<pre>
+  <code>
+    $ railsmachine --apply-to . --name my-cool-app --domain my-cool-app.com 
+  </code>
+</pre>
+
+Please note that the domain name provided will need to be correctly pointed at your Rails Machine account. If you don't have a DNS provider, we've been more than happy with "DNS Made Easy":http://dnsmadeeasy.com.
+
+h2. Update Database Config
+
+Update your applications @config/database.yml@'s section with your desired MySQL datbase name, username, and password. The database and user will be created for you in a forthcoming step.
+
+h2. Application Setup
+
+Rails Machine defaults to using mongrel + mod_proxy_balancer to run your Rails Application. If you'd like to switch to "Phusion Passenger":http://www.modrails.com/, edit the line in your application's @config/deploy.rb@ that begins @set :app_server@  to reflect your choice. For example:
+
+<pre>
+  <code>
+    set :app_server, :passenger
+  </code>
+</pre>
+
+Run the following Capistrano task to setup your MySQL databases and configure your application servers (mongrel/passenger):
+
+<pre>
+  <code>
+    $ cap servers:setup
+  </code>
+</pre>
+
+h2. Source Control
+
+h3. If you're already using Source Control...
+
+...edit the lines in your application's @config/deploy.rb@ that begin @set :repository@ and @set :repository@. For example:
+
+<pre>
+  <code>
+    set :scm, :git
+    set :repository, "git@github.com:yourname/my-cool-app.git"
+  </code>
+</pre>
+
+h3. If you're not yet using Source Control...
+
+...you can easily setup a Git/Subversion repository on your Rails Machine.  Subversion is the default, edit the line in your application's @config/deploy.rb@ that begins @set :scm@ if you'd like to change it to git. For example:
+
+<pre>
+  <code>
+    set :scm, :git
+  </code>
+</pre>
+
+Next, run the following task to import your application into a Git/SVN repository on your Rails Machine:
+
+<pre>
+  <code>
+    $ cap repos:setup
+  </code>
+</pre>
+
+h2. Initial Deploy
+
+That's it! You're ready to use Capistrano to deploy your app for the first time:
+
+<pre>
+  <code>
+    $ cap deploy:cold
+  </code>
+</pre>
+
+Once that's done, open your application in a web browser and test it out!
+
+To perform a subsequent deploy with Capistrano:
+
+<pre>
+  <code>
+    $ cap deploy
+  </code>
+</pre>
+
+or, if you need to run migrations as well:
+
+<pre>
+  <code>
+    $ cap deploy:migrations
+  </code>
+</pre>

data/lib/railsmachine/generators/railsmachine/templates/deploy.rb

@@ -52,7 +52,7 @@ role :scm, domain
 # =============================================================================
 # APPLICATION SERVER OPTIONS
 # ============================================================================= 
-# set :app_server, "passenger"  # mongrel or passenger
+# set :app_server, :mongrel  # :mongrel or :passenger
 
 # =============================================================================
 # WEB SERVER OPTIONS

data/lib/railsmachine/recipes.rb

@@ -3,14 +3,44 @@ Capistrano::Configuration.instance(:must_exist).load do
   default_run_options[:pty] = true
   set :keep_releases, 3
   set :app_symlinks, nil
-  set :scm, :subversion
+  set :scm, :subversion 
   set :httpd, :apache
-  set :app_server, :mongrel
+  set :app_server, :mongrel 
   set :db_adapter, :mysql
   set :rails_env, "production"
-
-  load    'config/deploy'
   
+  # mongrel defaults
+  set :mongrel_servers, 2
+  set :mongrel_port, 8000
+  set :mongrel_address, "127.0.0.1"
+  set :mongrel_environment, "production"
+  set :mongrel_conf, nil
+  set :mongrel_user, nil
+  set :mongrel_group, nil
+  set :mongrel_prefix, nil
+  set :mongrel_rails, 'mongrel_rails'
+  set :mongrel_clean, false
+  set :mongrel_pid_file, nil
+  set :mongrel_log_file, nil
+  set :mongrel_config_script, nil
+  
+  # passenger defaults
+  set :use_mod_rewrite, false
+  
+  # apache defaults
+  set :apache_server_name, nil            
+  set :apache_conf, nil
+  set :apache_default_vhost, false
+  set :apache_default_vhost_conf, nil
+  set :apache_ctl, "/etc/init.d/httpd"
+  set :apache_server_aliases, []
+  set :apache_proxy_port, 8000
+  set :apache_proxy_servers, 2
+  set :apache_proxy_address, "127.0.0.1"
+  set :apache_ssl_enabled, false
+  set :apache_ssl_ip, nil
+  set :apache_ssl_forward_all, false
+ 
   set :repository do
     scm = fetch(:scm)
     repos_base = "#{user}@#{domain}#{deploy_to}"
@@ -20,7 +50,6 @@ Capistrano::Configuration.instance(:must_exist).load do
       "ssh://#{repos_base}/repos/#{application}.git"
     end
   end
-
   
   task :validate_required_variables do
     validate_option(:scm, :in => [:subversion, :git])
@@ -73,7 +102,7 @@ Capistrano::Configuration.instance(:must_exist).load do
   namespace :app do
   
     desc <<-DESC
-    Setup #{app_server}
+    Setup application server.
     DESC
     task :setup, :roles => :app  do
       case app_server.to_s
@@ -188,6 +217,7 @@ Capistrano::Configuration.instance(:must_exist).load do
     task :setup, :roles => :scm  do
     begin
       sudo  "chown -R #{user}:#{user} #{deploy_to.gsub(application,'')}"
+      dump_settings
       localrepo.setup
     rescue
       puts "repos:setup failed!"

data/lib/railsmachine/recipes/app/deploy.rb

@@ -1,23 +1,22 @@
 Capistrano::Configuration.instance(:must_exist).load do
-  load    'config/deploy'
   namespace :deploy do
   
     desc <<-DESC
-    #{app_server.to_s == 'mongrel' ? "Start the mongrel processes on the app server." : "This task no effect when using Passenger as your application server."}
+    Start the application server processes.
     DESC
     task :start, :roles => :app do
       application_servlet.start
     end
 
     desc <<-DESC
-    Restart the #{app_server} processes on the app server.
+    Restart the application server processes.
     DESC
     task :restart, :roles => :app do
       application_servlet.restart
     end
 
     desc <<-DESC
-    #{app_server.to_s == 'mongrel' ? "Stop the mongrel processes on the app server." : "This task no effect when using Passenger as your application server."} 
+    Stop the application server processes. 
     DESC
     task :stop, :roles => :app do
       application_servlet.stop

data/lib/railsmachine/recipes/app/mongrel.rb

@@ -1,19 +1,4 @@
 Capistrano::Configuration.instance(:must_exist).load do
-  set :mongrel_servers, 2
-  set :mongrel_port, 8000
-  set :mongrel_address, "127.0.0.1"
-  set :mongrel_environment, "production"
-  set :mongrel_conf, nil
-  set :mongrel_user, nil
-  set :mongrel_group, nil
-  set :mongrel_prefix, nil
-  set :mongrel_rails, 'mongrel_rails'
-  set :mongrel_clean, false
-  set :mongrel_pid_file, nil
-  set :mongrel_log_file, nil
-  set :mongrel_config_script, nil
- 
-  load    'config/deploy'
  
   namespace :mongrel do
   

data/lib/railsmachine/recipes/app/passenger.rb

@@ -1,6 +1,5 @@
 Capistrano::Configuration.instance(:must_exist).load do
-  set :use_mod_rewrite, false
-  load    'config/deploy'
+
   namespace :passenger do
 
     [:start, :stop].each do |t|

data/lib/railsmachine/recipes/web/apache.rb

@@ -1,22 +1,6 @@
 require 'erb'
 Capistrano::Configuration.instance(:must_exist).load do
   
-  
-  set :apache_server_name, nil            
-  set :apache_conf, nil
-  set :apache_default_vhost, false
-  set :apache_default_vhost_conf, nil
-  set :apache_ctl, "/etc/init.d/httpd"
-  set :apache_server_aliases, []
-  set :apache_proxy_port, 8000
-  set :apache_proxy_servers, 2
-  set :apache_proxy_address, "127.0.0.1"
-  set :apache_ssl_enabled, false
-  set :apache_ssl_ip, nil
-  set :apache_ssl_forward_all, false
-  
-  load    'config/deploy'
-  
   namespace :apache do
   
     desc "Configure Apache. This uses the :use_sudo

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: railsmachine-railsmachine
 version: !ruby/object:Gem::Version 
-  version: 1.0.3
+  version: 1.0.4
 platform: ruby
 authors: 
 - Rails Machine
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2008-12-18 00:00:00 -08:00
+date: 2008-12-29 00:00:00 -08:00
 default_executable: railsmachine
 dependencies: 
 - !ruby/object:Gem::Dependency