Home

Welcome to the doorkeeper wiki!

About

Doorkeeper is an OAuth 2 provider for Rails. It's built on top of Rails engines. The gem is in active development. So far it supports all protocol flows, but we will still have to work on few missing pieces.

More info:

• Supported OAuth 2 features
• Supported Ruby & Rails versions

See it in action

Demo app

We've built a simple provider demo using Devise. Check it out here.

Screencast @ railscasts.com

#353 OAuth with Doorkeeper

For more example applications, see this page in the wiki.

How to's

• Contributing
• Upgrade Guide
• Create a OmniAuth strategy for your provider
• Conditionally requiring OAuth token
• ActionController::Metal with doorkeeper

Flows

• Using Resource Owner Password Credentials flow
• Client Credentials flow

Customization/Configuration

• Customize access token expiration time
• Enable refresh token credentials
• Using scopes
• Customizing Views
• Customizing Routes
• Changing how clients are authenticatied
• Authenticating using Clearance/DIY

Testing

• Testing controllers protected with doorkeeper
• Testing your provider with OAuth2 gem