README in mongrel_cluster-0.1 vs README in mongrel_cluster-0.1.1
- old
+ new
@@ -1,8 +1,8 @@
== Mongrel Cluster Plugin
-Tool to help start/stop/restart multiple mongrel servers to use behind a load balancer like Pound or Balance. This plugin adds an option to specify a number of Mongrel servers to launch, a range of ports, and a configuration file for the cluster. Use "-h" to see command syntax.
+Tool to help start/stop/restart multiple mongrel servers to use behind a load balancer like Pound, Pen or Balance. This plugin adds an option to specify a number of Mongrel servers to launch, a range of ports, and a configuration file for the cluster. Use "-h" to see command syntax.
Configure cluster and write configuration file:
mongrel_rails cluster::configure
Start cluster:
@@ -13,5 +13,28 @@
Stop cluster:
mongrel_rails cluster::stop
+Capistrano Recipe
+
+Add to deploy.rb:
+require 'mongrel_cluster/recipes'
+
+Example usage:
+cap -a configure_mongrel_cluster
+
+Variables
+mongrel_servers: Number of Mongrel servers to start.
+mongrel_port: Starting port to bind to.
+mongrel_address: Address to bind to.
+mongrel_environment: Rails environment to run as.
+mongrel_config: Path to config file.
+use_sudo: Whether or not tasks that can use sudo, ought to use sudo. Capistrano defaults to true.
+
+Tasks (performed on :app role)
+configure_mongrel_cluster: Configure the cluster with variables. Uses sudo if use_sudo is true.
+start_mongrel_cluster: Start Mongrel processes on the app server. Uses sudo if use_sudo is true.
+stop_mongrel_cluster: Stop the Mongrel processes on the app server. Uses sudo if use_sudo is true.
+restart_mongrel_cluster: Restart the Mongrel processes on the app server. Uses sudo if use_sudo is true.
+restart: Calls restart_mongrel_cluster to allow Mongrel to be used with the standard Capistrano deploy task.
+spinner: Calls start_mongrel_cluster to allow Mongrel to be used with the standard Capistrano cold_deploy task.