mirror of https://gitlab.com/ydkn/capistrano-rails-console.git synced 2023-02-13 20:54:14 -05:00

No description

Find a file

Florian Schwab 0ded7fe4ef add missing entry for PR#25 to changelog		2016-10-25 10:28:58 +02:00
lib	Merge pull request #25 from hector/master	2016-10-16 13:33:48 +02:00
.gitignore	initial import	2013-11-09 15:58:59 +01:00
capistrano-rails-console.gemspec	switch to sshkit-interactive	2016-09-16 00:39:27 +02:00
CHANGELOG.md	add missing entry for PR#25 to changelog	2016-10-25 10:28:58 +02:00
Gemfile	initial import	2013-11-09 15:58:59 +01:00
LICENSE.txt	initial import	2013-11-09 15:58:59 +01:00
Rakefile	initial import	2013-11-09 15:58:59 +01:00
README.md	revert requiring the gem to work as before	2016-09-19 22:03:55 +02:00

Capistrano::Rails::Console

Remote rails console and dbconsole for capistrano.

Installation

Add this line to your application's Gemfile:

gem 'capistrano-rails-console', require: false

And then execute:

$ bundle

Or install it yourself as:

$ gem install capistrano-rails-console

Require in Capfile to use the default task:

require 'capistrano/rails/console'

Run a remote rails console with:

$ cap production rails:console

You can also start a sandbox session:

$ cap production rails:console sandbox=1

Or run a dbconsole:

$ cap production rails:dbconsole

set :console_env, :production # use different environment than deployment environment (rails_env)

set :console_user, :appuser # run rails console as appuser through sudo
set :console_user, nil # explicitly disable switching user through sudo

Bug reports and pull requests are welcome on GitHub at https://github.com/ydkn/capistrano-rails-console.

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