2015-03-23 22:19:06 +00:00
|
|
|
[![Gem Version](https://img.shields.io/gem/v/capistrano-rails-console.svg)](https://rubygems.org/gems/capistrano-rails-console)
|
|
|
|
[![Dependencies](https://img.shields.io/gemnasium/ydkn/capistrano-rails-console.svg)](https://gemnasium.com/ydkn/capistrano-rails-console)
|
|
|
|
[![Code Climate](https://img.shields.io/codeclimate/github/ydkn/capistrano-rails-console.svg)](https://codeclimate.com/github/ydkn/capistrano-rails-console)
|
|
|
|
|
2015-07-26 11:57:07 +00:00
|
|
|
[![Join the chat](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/ydkn/capistrano-rails-console)
|
|
|
|
|
|
|
|
|
2013-11-09 14:49:28 +00:00
|
|
|
# Capistrano::Rails::Console
|
|
|
|
|
2016-09-16 18:44:22 +00:00
|
|
|
Remote rails console and dbconsole for capistrano.
|
2015-11-12 22:10:04 +00:00
|
|
|
|
2013-11-09 14:49:28 +00:00
|
|
|
|
|
|
|
## Installation
|
|
|
|
|
|
|
|
Add this line to your application's Gemfile:
|
|
|
|
|
2015-02-10 20:00:25 +00:00
|
|
|
```ruby
|
|
|
|
gem 'capistrano-rails-console'
|
|
|
|
```
|
2013-11-09 14:49:28 +00:00
|
|
|
|
|
|
|
And then execute:
|
|
|
|
|
|
|
|
$ bundle
|
|
|
|
|
|
|
|
Or install it yourself as:
|
|
|
|
|
|
|
|
$ gem install capistrano-rails-console
|
|
|
|
|
2015-11-12 22:10:04 +00:00
|
|
|
|
2013-11-09 14:49:28 +00:00
|
|
|
## Usage
|
|
|
|
|
|
|
|
Require in `Capfile` to use the default task:
|
|
|
|
|
2015-02-10 20:00:25 +00:00
|
|
|
```ruby
|
|
|
|
require 'capistrano/rails/console'
|
|
|
|
```
|
2013-11-09 14:49:28 +00:00
|
|
|
|
2016-09-16 18:44:22 +00:00
|
|
|
Run a remote rails console with:
|
2013-11-09 14:49:28 +00:00
|
|
|
|
|
|
|
$ cap production rails:console
|
|
|
|
|
2015-03-23 22:19:06 +00:00
|
|
|
You can also start a sandbox session:
|
|
|
|
|
|
|
|
$ cap production rails:console sandbox=1
|
|
|
|
|
2016-09-16 18:44:22 +00:00
|
|
|
Or run a dbconsole:
|
|
|
|
|
|
|
|
$ cap production rails:dbconsole
|
|
|
|
|
2016-09-15 22:39:27 +00:00
|
|
|
## Options
|
|
|
|
|
|
|
|
### Rails environment
|
|
|
|
|
|
|
|
```ruby
|
2016-09-16 15:14:03 +00:00
|
|
|
set :console_env, :production # use different environment than deployment environment (rails_env)
|
2016-09-15 22:39:27 +00:00
|
|
|
```
|
|
|
|
|
|
|
|
### User
|
|
|
|
|
|
|
|
```ruby
|
2016-09-16 15:14:03 +00:00
|
|
|
set :console_user, :appuser # run rails console as appuser through sudo
|
|
|
|
set :console_user, nil # explicitly disable switching user through sudo
|
2016-09-15 22:39:27 +00:00
|
|
|
```
|
|
|
|
|
2015-11-12 22:10:04 +00:00
|
|
|
|
2013-11-09 14:49:28 +00:00
|
|
|
## Contributing
|
|
|
|
|
2015-11-12 22:10:04 +00:00
|
|
|
Bug reports and pull requests are welcome on GitHub at https://github.com/ydkn/capistrano-rails-console.
|
|
|
|
|
|
|
|
|
|
|
|
## License
|
|
|
|
|
|
|
|
The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
|