Build Status

Useful Capistrano recipes including:

  • Create MySQL database and user on server (via prompts)
  • Restart/Stop/Start Apache/HTTPD server
  • Log rotation and tailing commands
  • Deploy Omeka

Included Tasks

  • cap apache:reload # |OmekaRecipes| Reload Apache
  • cap apache:restart # |OmekaRecipes| Restart Apache
  • cap apache:start # |OmekaRecipes| Start Apache
  • cap apache:stop # |OmekaRecipes| Stop Apache
  • cap db:create_ini # |OmekaRecipes| Create db.ini in shared pa...
  • cap db:mysql:dump # |OmekaRecipes| Performs a compressed data...
  • cap db:mysql:fetch_dump # |OmekaRecipes| Downloads the compressed d...
  • cap db:mysql:restore # |OmekaRecipes| Restores the database from...
  • cap db:mysql:setup # |OmekaRecipes| Create MySQL database and ...
  • cap deploy # |OmekaRecipes| Deploy omeka, github-style
  • cap deploy:seppuku # |OmekaRecipes| Destroys everything
  • cap deploy:setup_dirs # |OmekaRecipes| Create shared dirs
  • cap deploy:symlink # |OmekaRecipes| Alias for symlinks:make
  • cap log:rotate # |OmekaRecipes| Install log rotation scrip...
  • cap log:tail # |OmekaRecipes| Tail all log files
  • cap omeka:db_ini # |OmekaRecipes| Add the db.ini to the shar...
  • cap omeka:fix_archive_permissions # |OmekaRecipes| Ensure the archive directo...
  • cap omeka:get_plugins # |OmekaRecipes| Deploy the plugins defined...
  • cap omeka:get_themes # |OmekaRecipes| Deploy the themes defined ...
  • cap omeka:link_archive_dir # |OmekaRecipes| Link the archive directoy ...
  • cap omeka:maintenance:start # |OmekaRecipes| Add a maitenance page for ...
  • cap omeka:move_archive_dir # |OmekaRecipes| Move the archive directory...
  • cap omeka:move_files_to_shared # |OmekaRecipes| Move a pristine copy of th...
  • cap omeka:rename_files # |OmekaRecipes| Rename files
  • cap symlinks:make # |OmekaRecipes| Make all the symlinks in a...`


Add this line to your application's Gemfile:

gem 'omeka-recipes'

And then execute:

$ bundle

Or install it yourself as:

$ gem install omeka-recipes


To set up the initial Capistrano deploy file, go to your application folder in the command line and enter the capify command:

$ capify .


Inside a newly created config/deploy.rb file, add this:

require 'capistrano/ext/multistage'

require 'omeka-recipes'

Now set up capistrano to do multistage

cap multistage:prepare


Plugins are defined in the plugins hash, giving a plugin name, and it's git repo. Be sure to use a read-only version.

set :plugins, {
  'Neatline' => 'git://',
  'NeatlineMaps' => 'git://',
  'CsvImport' => 'git://',
  'Scripto' => 'git://'


Themes are defined in the themes hash, passing a theme name and it's git repository.

set :themes, {
  'neatline' => 'git://',
  'emiglio' => 'git://'

Example Configuration

The following is an example of a config/deploy.rb file:

set :stages, %w(production staging)
set :default_stage, "staging"
require 'capistrano/ext/multistage'

require 'omeka-recipes'

set :application, "omeka"
set :repository,  "git://"

set :scm, :git

set :branch, 'stable-1.5'

set :plugins, {
  'Neatline' => 'git://',
  'NeatlineFeatures' => 'git://',
  'NeatlineMaps' => 'git://',
  'NeatlineTime' => 'git://',
  'SolrSearch' => 'git://',

set :themes, {
  'mcos-omeka-theme' => 'git://'

after "deploy:restart", "deploy:cleanup"

In each of the stages of your deployment (e.g. deploy/deploy/production.rb), you will need to add a definition to tell capistrano where to go.

server '', :app, :web, :primary => true

And your staging:

server '', :app, :db, :web, :primary => true


RVM is disabled by default, but you can enable it by setting :use_rvm, true. You may also leverage it by setting your rvm_ruby_string to an appropriate version (default is 1.9.3).

If using_rvm is true, the rvm recipe will load the RVM capistrano extensions so you don't have to worry about them during your deployments. You will need to make sure you have an .rvmrc file in the project directory, and system-wide installation on the servers.

See for more information.


See the LICENSE for more information.


  1. Fork it
  2. Create your feature branch (git checkout -b my-new-feature)
  3. Commit your changes (git commit -am 'Added some feature')
  4. Push to the branch (git push origin my-new-feature)
  5. Create a new Pull Request