Skip to content

Latest commit

 

History

History
67 lines (46 loc) · 2.1 KB

README.md

File metadata and controls

67 lines (46 loc) · 2.1 KB
Raw

Doorkeeper MongoDB extension

Gem Version Build Status

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 for Mongoid versions 6 and later. Earlier versions of Mongoid are supported on earlier versions of doorkeeper-mongodb.

To start using it, add both doorkeeper and doorkeeper-mongodb to your Gemfile:

gem 'doorkeeper'
gem 'doorkeeper-mongodb'

# 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 :mongoid8 # or any other version of mongoid
end

Indexes

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=6.0
$ export BUNDLE_GEMFILE=$PWD/gemfiles/Gemfile.mongoid7.rb

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