README.rdoc in blavosync-0.0.5 vs README.rdoc in blavosync-0.1.0
- old
+ new
@@ -1,10 +1,14 @@
-= indierockmedia-blavosync
+== blavosync
+INSTALLATION:
+Add this line BELOW load 'config/deploy' in your Capfile
-BLAVOSYNC
+require 'blavosync'
+
+USAGE:
adds the following tasks to projects using capistrano
------------------------------------------------------------
cap local:backup_content
------------------------------------------------------------
@@ -74,10 +78,30 @@
Wrapper for local:force_backup_db, local:force_backup_content, and the
local:sync to get
a completely fresh set of data from the server
$> cap local:sync RAILS_ENV=production RESTORE_ENV=development
+CONFIGURATION:
+the following variables (with defaults shown) are available in your deploy.rb
+
+
+ set :blavosync_local_root, Pathname.new('.').realpath
+ set :blavosync_content_directories, content_directories ||= "system"
+ set :blavosync_content_path, File.join(shared_path, content_dir)
+ set :blavosync_public_path, File.join(latest_release, 'public')
+ set :blavosync_remote_backup_expires, 100000
+ set :blavosync_zip_command, "gzip"
+ set :blavosync_unzip_command, "gunzip"
+ set :blavosync_compressed_extension, "gz"
+ set :blavosync_tmp_dir, "tmp"
+ set :blavosync_content_sync_method, 'rsync'
+ set :blavosync_from_env, (ENV['FROM_ENV'].nil? ? 'production' : ENV['RAILS_ENV'])
+ set :blavosync_to_env, (ENV['TO_ENV'].nil? ? 'development' : ENV['TO_ENV'])
+ set :blavosync_rsync_content_backup_file, "#{shared_path}/system"
+ set :blavosync_tar_content_backup_file, "#{shared_path}/backup_#{from_env}_content.tar.#{zip_ext}"
+ set :blavosync_db_backup_file, "#{shared_path}/backup_#{from_env}_db.sql"
+ set :blavosync_db_backup_zip_file, "#{db_backup_file}.#{zip_ext}"
== Note on Patches/Pull Requests
* Fork the project.