Doorkeeper MongoDB extension

Documentation

This documentation is valid for master branch. Please check the documentation for the version
of doorkeeper-mongodb you are using in: https://github.com/doorkeeper-gem/doorkeeper-mongodb/releases.

Installation

doorkeeper-mongodb provides Doorkeeper support to Mongoid
(2, 3, 4 and 5 for doorkeeper-mongodb 3.0 and 4, 5, 6 and 7 for version 4.0 and higher). To start using it, add
to your Gemfile:

# For Doorkeeper >= 5.2
gem 'doorkeeper', '~> 5.2'
gem 'doorkeeper-mongodb', '~> 5.2'

# For Doorkeeper >= 5.0
gem 'doorkeeper', '~> 5.0'
gem 'doorkeeper-mongodb', '~> 5.0'

# For Doorkeeper >= 4.4 && < 5.0
gem 'doorkeeper', '~> 4.4'
gem 'doorkeeper-mongodb', '~> 4.2'

# For Doorkeeper < 4.4
gem 'doorkeeper', '~> 4.3'
gem 'doorkeeper-mongodb', '~> 4.1.0'

# or if you want to use cutting edge version:
# gem 'doorkeeper-mongodb', github: 'doorkeeper-gem/doorkeeper-mongodb'

Run doorkeeper’s installation generator:

rails generate doorkeeper:install

This will install the doorkeeper initializer into
config/initializers/doorkeeper.rb.

Set the ORM configuration:

Doorkeeper.configure do
  orm :mongoid7 # or any other version of mongoid
end

MongoMapper

NOTE: Support of MongoMapper gem was dropped.

Indexes

Mongoid

Make sure you create indexes for doorkeeper models. You can do this either by
running rake db:mongoid:create_indexes or (if you're using Mongoid 2) by
adding autocreate_indexes: true to your config/mongoid.yml

Tests

To run tests, clone this repository and run rake. It will copy and run
doorkeeper’s original test suite, after configuring the ORM according to the
variables defined in .travis.yml file.

To run locally, you need to choose a gemfile, with a command similar to:

$ export RAILS=5.1
$ export BUNDLE_GEMFILE=$PWD/gemfiles/Gemfile.mongoid6.rb

Please refer to https://github.com/doorkeeper-gem/doorkeeper for instructions on
doorkeeper’s project.