RVM support for Capistrano v3:
If you use this integration with capistrano-rails, please ensure that you have
capistrano-bundler >= 1.1.0.
If you want solution with RVM/rubies installer included, give a try to rvm1-capistrano3.
Add this line to your application's Gemfile:
# Gemfile gem 'capistrano', '~> 3.0' gem 'capistrano-rvm'
And then execute:
$ bundle install
Require in Capfile to use the default task:
# Capfile require 'capistrano/rvm'
And you should be good to go!
Everything should work for a basic RVM setup out of the box.
If you need some special settings, set those in the stage file for your server:
# deploy.rb or stage file (staging.rb, production.rb or else) set :rvm_type, :user # Defaults to: :auto set :rvm_ruby_version, '2.0.0-p247' # Defaults to: 'default' set :rvm_custom_path, '~/.myveryownrvm' # only needed if not detected
RVM path selection:
Valid options are:
:auto(default): just tries to find the correct path.
:system: defines the RVM path to
:user: defines the RVM path to
Ruby and gemset selection:
By default the Ruby and gemset is used which is returned by
rvm current on
the target host.
You can omit the ruby patch level from
:rvm_ruby_version if you want, and
capistrano will choose the most recent patch level for that version of ruby:
set :rvm_ruby_version, '2.0.0'
If you are using an rvm gemset, just specify it after your ruby_version:
set :rvm_ruby_version, '2.0.0-p247@mygemset'
set :rvm_ruby_version, '2.0.0@mygemset'
Custom RVM path:
If you have a custom RVM setup with a different path then expected, you have to define a custom RVM path to tell capistrano where it is.
If you want to restrict RVM usage to a subset of roles, you may set
set :rvm_roles, [:app, :web]
Capistrano can't use RVM to install rubies or create gemsets, so on the servers you are deploying to, you will have to manually use RVM to install the proper ruby and create the gemset.
How it works
This gem adds a new task
It sets the
rvm ... do ... for capistrano when it wants to run
Check your configuration
If you want to check your configuration you can use the
rvm:check task to
get information about the RVM version and ruby which would be used for
$ cap production rvm:check
- Fork it
- Create your feature branch (
git checkout -b my-new-feature)
- Commit your changes (
git commit -am 'Add some feature')
- Push to the branch (
git push origin my-new-feature)
- Create new Pull Request