Skip to content
Permalink
Branch: master
Find file Copy path
Find file Copy path
2 contributors

Users who have contributed to this file

@felipeelias @gitbook-bot
63 lines (41 sloc) 2.58 KB

Doorkeeper Guides

Doorkeeper is an oAuth2 provider built in Ruby. It integrates with Ruby on Rails and Grape frameworks.

Installation

The installation process depends on the framework you're using. The first step is to add doorkeeper to your Gemfile:

{% code-tabs %} {% code-tabs-item title="Gemfile" %}

gem 'doorkeeper'

{% endcode-tabs-item %} {% endcode-tabs %}

And run bundle install. After this, make sure to follow the guide related to the framework you're using below.

Ruby on Rails

Doorkeeper currently supports Ruby on Rails 5. See the guide here.

Grape

Guide for integration with Grape framework can be found here.

ORMs

Doorkeeper supports ActiveRecord by default, but can be configured to work with the following ORMs:

ORM Support via
Active Record by default
MongoDB doorkeeper-gem/doorkeeper-mongodb
Sequel nbulaj/doorkeeper-sequel
Couchbase acaprojects/doorkeeper-couchbase

Extensions

Extensions that are not included by default and can be installed separately.

Link
OpenID Connect extension doorkeeper-gem/doorkeeper-openid_connect
JWT Token support doorkeeper-gem/doorkeeper-jwt
Assertion grant extension doorkeeper-gem/doorkeeper-grants_assertion
I18n translations doorkeeper-gem/doorkeeper-i18n

Example Applications

These applications show how Doorkeeper works and how to integrate with it. Start with the oAuth2 server and use the clients to connect with the server.

Application Link
oAuth2 Server with Doorkeeper doorkeeper-gem/doorkeeper-provider-app
Sinatra Client connected to Provider App doorkeeper-gem/doorkeeper-sinatra-client
Devise + Omniauth Client doorkeeper-gem/doorkeeper-devise-client

Tutorials

See list of tutorials in order to learn how to use the gem or integrate it with other solutions / gems.

You can’t perform that action at this time.