Capistrano::Shortcuts

This gem simply encapsulate the common custom server tasks I use to manage Rails projects. It assumes a two-tiered development including both staging and production environments.

Add this line to your application's Gemfile:

gem 'capistrano-shortcuts', require: false

And then execute:

$ bundle

Or install it yourself as:

$ gem install capistrano-shortcuts

And include the tasks via your Capfile:

require 'capistrano/shortcuts'

Push or pull a copy of the database to or from the environment:

cap <environment> db:pull
cap <environment> db:push

Pull a copy of the production database to local machine, run migrations to update to development mode, then push the fresh and updated version to staging:

cap <environment> db:sync

Mysqldump the remote database to a timestamped (also remote) file. These are synonyms:

cap <environment> db:dump

...or..

cap <environment> db:backup

Push all config files listed in the :linked_files variable to the specified environment:

cap <environment> config:push

Pull all config files listed in the :linked_files variable down from the specified environment:

cap <environment> config:pull

Symlink environment-specific .htaccess and robots.txt files to their expected location:

cap <environment> config:symlink

Push the config files and restart the server to pick up changes immediately:

cap <environment> config:reconfig

Install the maintenance page and show it instead of executing the web app:

cap <environment> deploy:web:disable

Resume normal operation:

cap <environment> deploy:web:enable

Reload or restart apache:

cap <environment> apache:reload
cap <environment> apache:restart

Copy all domain-related config files from the rails repo "config/apache" directory into the sites-available directory for apache to pick up, and re-enable the website specified in <domain-name>.conf as well as assets.<domain-name>.conf:

cap <environment> apache:install

Clears all data stored in memcache by restarting the server. This task requires passwordless sudo to be set up on the server.

cap <environment> memcache:flush

After checking out the repo, run bin/setup to install dependencies. You can also run bin/console for an interactive prompt that will allow you to experiment.

To install this gem onto your local machine, run bundle exec rake install. To release a new version, update the version number in version.rb, and then run bundle exec rake release, which will create a git tag for the version, push git commits and tags, and push the .gem file to rubygems.org.

Bug reports and pull requests are welcome on GitHub at https://github.com/pugetive/capistrano-shortcuts.

The gem is available as open source under the terms of the MIT License.