ConsoleKit

A simple and flexible multi-tenant console setup toolkit for Rails applications.

ConsoleKit helps you manage tenant-specific database connections and context configuration via an easy CLI interface and Rails integration.

Installation

Install the gem and add to the application's Gemfile by executing:

bundle add console_kit

Additionally you can also add this line to your application's Gemfile:

gem 'console_kit'

And then execute:

bundle install

If bundler is not being used to manage dependencies, install the gem by executing:

gem install console_kit

Usage

After installing, generate the initializer and configuration files by running:

rails generate console_kit:install

Then, edit config/initializers/console_kit.rb to define your tenants and context class. Example format:

ConsoleKit.configure do |config|
  config.tenants = {
    tenant_one: {
      constants: { shard: :tenant_one_db, mongo_db: :tenant_one_mongo, partner_code: 'partnerA' }
    },
    tenant_two: {
      constants: { shard: :tenant_two_db, mongo_db: :tenant_two_mongo, partner_code: 'partnerB' }
    }
  }

  config.context_class = CurrentContext

  # Optional: Toggle pretty CLI output
  config.pretty_output = true
end

Console Usage

When launching the Rails console, ConsoleKit will prompt you to select a tenant (if tenants are configured). You can also manually interact with it:

Get Current Tenant

ConsoleKit.current_tenant
# => :tenant_one

Reset Current Tenant

ConsoleKit.reset_current_tenant
# => nil

Manually Disable Pretty Output

ConsoleKit.enable_pretty_output

Manually Disable Pretty Output

ConsoleKit.disable_pretty_output

Development

After checking out the repo, run bin/setup to install dependencies. Then, run rake spec to run the tests. You can also run bin/console for an interactive prompt that will allow you to experiment.

To install this gem onto your local machine, run bundle exec rake install. To release a new version, update the version number in version.rb, and then run bundle exec rake release, which will create a git tag for the version, push git commits and the created tag, and push the .gem file to rubygems.org.

Contributing

Bug reports and pull requests are welcome on GitHub at Console Kit. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the code of conduct.

License

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

Code of Conduct

Everyone interacting in the ConsoleKit project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the code of conduct.