Capistrano Foreman

Capistrano tasks for foreman and upstart/systemd.

Installation

$ gem install capistrano-foreman

Add this to your Capfile:

require 'capistrano/foreman'

# Default settings
set :foreman_use_sudo, false # Set to :rbenv for rbenv sudo, :rvm for rvmsudo or true for normal sudo
set :foreman_roles, :all
set :foreman_init_system, 'upstart'
set :foreman_export_path, ->{ File.join(Dir.home, '.init') }
set :foreman_app, -> { fetch(:application) }
set :foreman_app_name_systemd, -> { "#{ fetch(:foreman_app) }.target" }
set :foreman_options, ->{ {
  app: application,
  log: File.join(shared_path, 'log')
} }

See exporting options for an exhaustive list of foreman options.

Use it with capistrano-bundler

You don't have to configure anything, it's already compatible with capistrano-bundler!

Use it with rvm

Add this to your config/deploy.rb:

append :rvm_map_bins, 'rvmsudo'

Use it with rbenv

Since rbenv does not have a command like rvmsudo to perform sudo operation with it, you can use a sort of an hack like this below (source)

$ vim .bash.d/50_rbenv.bash
# Append this
# function rbenvsudo(){
#   executable=$1
#   shift 1
#   sudo $(rbenv which $executable) $*
# }
$ source .bash.d/50_rbenv.bash

Add this to your config/deploy.rb with the alias/function name wrote before to perform sudo command with rbenv:

set :foreman_rbenv_sudo, 'rbenvsudo'
append :rbenv_map_bins, 'rbenvsudo'

Usage

Export Procfile to upstart/systemd:

$ bundle exec cap production foreman:export

Restart the application services:

$ bundle exec cap production foreman:restart

Credits

Hyper made this. We're a digital communications agency with a passion for good code, and if you're using this library we probably want to hire you.