Doorkeeper is a gem (Rails engine) that makes it easy to introduce OAuth 2 provider functionality to your Ruby on Rails or Grape application.
Supported features:
- The OAuth 2.0 Authorization Framework
- OAuth 2.0 Token Revocation
- OAuth 2.0 Token Introspection
- OAuth 2.0 Threat Model and Security Considerations
- OAuth 2.0 for Native Apps
- Proof Key for Code Exchange by OAuth Public Clients
- Documentation
- Installation
- ORMs
- Extensions
- Example Applications
- Tutorials
- Sponsors
- Development
- Contributing
- Contributors
- License
This documentation is valid for master branch. Please check the documentation for the version of doorkeeper you are using in:
https://github.com/doorkeeper-gem/doorkeeper/releases.
Additionally, other resources can be found on:
- Guides with how-to get started and configuration documentation
- See the Wiki with articles and other documentation
- Screencast from railscasts.com: #353 OAuth with Doorkeeper
- See upgrade guides
- For general questions, please post on Stack Overflow
- See SECURITY.md for this project's security disclose policy
Installation depends on the framework you're using. The first step is to add the following to your Gemfile:
gem 'doorkeeper'And run bundle install. After this, check out the guide related to the framework you're using.
Doorkeeper currently supports Ruby on Rails >= 5.0. See the guide here.
Guide for integration with Grape framework can be found here.
Doorkeeper supports Active Record 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 |
| RethinkDB | aca-labs/doorkeeper-rethinkdb |
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 |
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 |
You may want to create a client application to test the integration. Check out these client examples in our wiki or follow this tutorial here.
See list of tutorials in order to learn how to use the gem or integrate it with other solutions / gems.
Support this project by becoming a sponsor. Your logo will show up here with a link to your website. [Become a sponsor]
If you prefer not to deal with the gory details of OAuth 2, need dedicated customer support & consulting, try the cloud-based SaaS version: https://oauth.io
Wealthsimple is a financial company on a mission to help everyone achieve financial freedom by providing products and advice that are accessible and affordable. Using smart technology, Wealthsimple takes financial services that are often confusing, opaque and expensive and makes them simple, transparent, and low-cost. See what Investing on Autopilot is all about: https://www.wealthsimple.com
To run the local engine server:
bundle install
bundle exec rake doorkeeper:server
By default, it uses the latest Rails version with ActiveRecord. To run the tests with a specific Rails version:
BUNDLE_GEMFILE=gemfiles/rails_6_0.gemfile bundle exec rake
Want to contribute and don't know where to start? Check out features we're missing, create example apps, integrate the gem with your app and let us know!
Also, check out our contributing guidelines page.
Thanks to all our awesome contributors!
MIT License. Copyright 2011 Applicake.