{"id":13416354,"url":"https://github.com/doorkeeper-gem/doorkeeper","last_synced_at":"2025-09-09T19:53:05.745Z","repository":{"id":37336566,"uuid":"2802565","full_name":"doorkeeper-gem/doorkeeper","owner":"doorkeeper-gem","description":"Doorkeeper is an OAuth 2 provider for Ruby on Rails / Grape.","archived":false,"fork":false,"pushed_at":"2025-05-01T08:53:14.000Z","size":4377,"stargazers_count":5386,"open_issues_count":54,"forks_count":1076,"subscribers_count":104,"default_branch":"main","last_synced_at":"2025-05-05T08:52:25.446Z","etag":null,"topics":["authentication","authorization","doorkeeper","grape","identity","oauth","oauth2","oauth2-provider","oauth2-server","ruby-on-rails"],"latest_commit_sha":null,"homepage":"https://doorkeeper.gitbook.io/guides/","language":"Ruby","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/doorkeeper-gem.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","funding":".github/FUNDING.yml","license":"MIT-LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":"SECURITY.md","support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null},"funding":{"open_collective":"doorkeeper-gem"}},"created_at":"2011-11-18T13:02:01.000Z","updated_at":"2025-05-04T22:05:30.000Z","dependencies_parsed_at":"2023-10-15T16:53:00.238Z","dependency_job_id":"e951dfb9-aeb8-421e-98c6-7e18e2a8b0c9","html_url":"https://github.com/doorkeeper-gem/doorkeeper","commit_stats":{"total_commits":1849,"total_committers":327,"mean_commits":5.654434250764526,"dds":0.7928610059491616,"last_synced_commit":"8b85512e8daa787bf875965f58d86d315b219b5e"},"previous_names":["applicake/doorkeeper"],"tags_count":123,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/doorkeeper-gem%2Fdoorkeeper","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/doorkeeper-gem%2Fdoorkeeper/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/doorkeeper-gem%2Fdoorkeeper/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/doorkeeper-gem%2Fdoorkeeper/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/doorkeeper-gem","download_url":"https://codeload.github.com/doorkeeper-gem/doorkeeper/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":252478393,"owners_count":21754357,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["authentication","authorization","doorkeeper","grape","identity","oauth","oauth2","oauth2-provider","oauth2-server","ruby-on-rails"],"created_at":"2024-07-30T21:00:57.564Z","updated_at":"2025-05-05T12:55:56.825Z","avatar_url":"https://github.com/doorkeeper-gem.png","language":"Ruby","funding_links":["https://opencollective.com/doorkeeper-gem"],"categories":["Ruby","Authentication","Authentication and OAuth","others","API","OAuth","Uncategorized","Gems","Client Library"],"sub_categories":["Uncategorized","Articles","Ruby"],"readme":"# Doorkeeper — awesome OAuth 2 provider for your Rails / Grape app.\n\n[![Gem Version](https://badge.fury.io/rb/doorkeeper.svg)](https://rubygems.org/gems/doorkeeper)\n[![CI](https://github.com/doorkeeper-gem/doorkeeper/actions/workflows/ci.yml/badge.svg)](https://github.com/doorkeeper-gem/doorkeeper/actions/workflows/ci.yml)\n[![Code Climate](https://codeclimate.com/github/doorkeeper-gem/doorkeeper.svg)](https://codeclimate.com/github/doorkeeper-gem/doorkeeper)\n[![Coverage Status](https://coveralls.io/repos/github/doorkeeper-gem/doorkeeper/badge.svg?branch=main)](https://coveralls.io/github/doorkeeper-gem/doorkeeper?branch=main)\n[![Reviewed by Hound](https://img.shields.io/badge/Reviewed_by-Hound-8E64B0.svg)](https://houndci.com)\n[![GuardRails badge](https://badges.guardrails.io/doorkeeper-gem/doorkeeper.svg?token=66768ce8f6995814df81f65a2cff40f739f688492704f973e62809e15599bb62)](https://dashboard.guardrails.io/default/gh/doorkeeper-gem/doorkeeper)\n[![Dependabot](https://img.shields.io/badge/dependabot-enabled-success.svg)](https://dependabot.com)\n\nDoorkeeper is a gem (Rails engine) that makes it easy to introduce OAuth 2 provider\nfunctionality to your Ruby on Rails or Grape application.\n\nSupported features:\n\n- [The OAuth 2.0 Authorization Framework](https://datatracker.ietf.org/doc/html/rfc6749)\n  - [Authorization Code Flow](https://datatracker.ietf.org/doc/html/rfc6749#section-4.1)\n  - [Access Token Scopes](https://datatracker.ietf.org/doc/html/rfc6749#section-3.3)\n  - [Refresh token](https://datatracker.ietf.org/doc/html/rfc6749#section-1.5)\n  - [Implicit grant](https://datatracker.ietf.org/doc/html/rfc6749#section-4.2)\n  - [Resource Owner Password Credentials](https://datatracker.ietf.org/doc/html/rfc6749#section-4.3)\n  - [Client Credentials](https://datatracker.ietf.org/doc/html/rfc6749#section-4.4)\n- [OAuth 2.0 Token Revocation](https://datatracker.ietf.org/doc/html/rfc7009)\n- [OAuth 2.0 Token Introspection](https://datatracker.ietf.org/doc/html/rfc7662)\n- [OAuth 2.0 Threat Model and Security Considerations](https://datatracker.ietf.org/doc/html/rfc6819)\n- [OAuth 2.0 for Native Apps](https://datatracker.ietf.org/doc/html/rfc8252)\n- [Proof Key for Code Exchange by OAuth Public Clients](https://datatracker.ietf.org/doc/html/rfc7636)\n\n## Table of Contents\n\n\u003c!-- START doctoc generated TOC please keep comment here to allow auto update --\u003e\n\u003c!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE --\u003e\n\n\n- [Documentation](#documentation)\n- [Installation](#installation)\n  - [Ruby on Rails](#ruby-on-rails)\n  - [Grape](#grape)\n- [ORMs](#orms)\n- [Extensions](#extensions)\n- [Example Applications](#example-applications)\n- [Sponsors](#sponsors)\n- [Development](#development)\n- [Contributing](#contributing)\n- [Contributors](#contributors)\n- [License](#license)\n\n\u003c!-- END doctoc generated TOC please keep comment here to allow auto update --\u003e\n\n## Documentation\n\nThis documentation is valid for `main` branch. Please check the documentation for the version of doorkeeper you are using in:\nhttps://github.com/doorkeeper-gem/doorkeeper/releases.\n\nAdditionally, other resources can be found on:\n\n- [Guides](https://doorkeeper.gitbook.io/guides/) with how-to get started and configuration documentation\n- See the [Wiki](https://github.com/doorkeeper-gem/doorkeeper/wiki) for articles on how to integrate with other solutions\n- Screencast from [railscasts.com](http://railscasts.com/): [#353\nOAuth with\nDoorkeeper](http://railscasts.com/episodes/353-oauth-with-doorkeeper)\n- See [upgrade guides](https://github.com/doorkeeper-gem/doorkeeper/wiki/Migration-from-old-versions)\n- For general questions, please post on [Stack Overflow](http://stackoverflow.com/questions/tagged/doorkeeper)\n- See [SECURITY.md](SECURITY.md) for this project's security disclose\n  policy\n\n## Installation\n\nInstallation depends on the framework you're using. The first step is to add the following to your Gemfile:\n\n```ruby\ngem 'doorkeeper'\n```\n\nAnd run `bundle install`. After this, check out the guide related to the framework you're using.\n\n### Ruby on Rails\n\nDoorkeeper currently supports Ruby on Rails \u003e= 5.0. See the guide [here](https://doorkeeper.gitbook.io/guides/ruby-on-rails/getting-started).\n\n### Grape\n\nGuide for integration with Grape framework can be found [here](https://doorkeeper.gitbook.io/guides/grape/grape).\n\n## ORMs\n\nDoorkeeper supports Active Record by default, but can be configured to work with the following ORMs:\n\n| ORM | Support via |\n| :--- | :--- |\n| Active Record | by default |\n| MongoDB | [doorkeeper-gem/doorkeeper-mongodb](https://github.com/doorkeeper-gem/doorkeeper-mongodb) |\n| Sequel | [nbulaj/doorkeeper-sequel](https://github.com/nbulaj/doorkeeper-sequel) |\n| Couchbase | [acaprojects/doorkeeper-couchbase](https://github.com/acaprojects/doorkeeper-couchbase) |\n| RethinkDB | [aca-labs/doorkeeper-rethinkdb](https://github.com/aca-labs/doorkeeper-rethinkdb) |\n\n## Extensions\n\nExtensions that are not included by default and can be installed separately.\n\n|  | Link |\n| :--- | :--- |\n| OpenID Connect extension | [doorkeeper-gem/doorkeeper-openid\\_connect](https://github.com/doorkeeper-gem/doorkeeper-openid_connect) |\n| JWT Token support | [doorkeeper-gem/doorkeeper-jwt](https://github.com/doorkeeper-gem/doorkeeper-jwt) |\n| Assertion grant extension | [doorkeeper-gem/doorkeeper-grants\\_assertion](https://github.com/doorkeeper-gem/doorkeeper-grants_assertion) |\n| I18n translations | [doorkeeper-gem/doorkeeper-i18n](https://github.com/doorkeeper-gem/doorkeeper-i18n) |\n| CIBA - Client Initiated Backchannel Authentication Flow extension | [doorkeeper-ciba](https://github.com/autoseg/doorkeeper-ciba) |\n| Device Authorization Grant | [doorkeeper-device_authorization_grant](https://github.com/exop-group/doorkeeper-device_authorization_grant) |\n\n## Example Applications\n\nThese 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.\n\n| Application | Link |\n| :--- | :--- |\n| OAuth2 Server with Doorkeeper | [doorkeeper-gem/doorkeeper-provider-app](https://github.com/doorkeeper-gem/doorkeeper-provider-app) |\n| Sinatra Client connected to Provider App | [doorkeeper-gem/doorkeeper-sinatra-client](https://github.com/doorkeeper-gem/doorkeeper-sinatra-client) |\n| Devise + Omniauth Client | [doorkeeper-gem/doorkeeper-devise-client](https://github.com/doorkeeper-gem/doorkeeper-devise-client) |\n\nYou may want to create a client application to\ntest the integration. Check out these [client\nexamples](https://github.com/doorkeeper-gem/doorkeeper/wiki/Example-Applications)\nin our wiki or follow this [tutorial\nhere](https://github.com/doorkeeper-gem/doorkeeper/wiki/Testing-your-provider-with-OAuth2-gem).\n\n## Sponsors\n\n[![OpenCollective](https://opencollective.com/doorkeeper-gem/backers/badge.svg)](#backers) \n[![OpenCollective](https://opencollective.com/doorkeeper-gem/sponsors/badge.svg)](#sponsors)\n\nSupport this project by becoming a sponsor. Your logo will show up here with a link to your website. [[Become a sponsor](https://opencollective.com/doorkeeper-gem#sponsor)]\n\n\u003ca href=\"https://codecademy.com/about/careers?utm_source=doorkeeper-gem\" target=\"_blank\"\u003e\u003cimg src=\"https://static-assets.codecademy.com/marketing/codecademy_logo_padded.png\"/\u003e\u003c/a\u003e\n\n\u003e Codecademy supports open source as part of its mission to democratize tech. Come help us build the education the world deserves: [https://codecademy.com/about/careers](https://codecademy.com/about/careers?utm_source=doorkeeper-gem)\n\n\u003cbr\u003e\n\n\u003ca href=\"https://oauth.io/?utm_source=doorkeeper-gem\" target=\"_blank\"\u003e\u003cimg src=\"https://oauth.io/img/logo_text.png\"/\u003e\u003c/a\u003e\n\n\u003e If you prefer not to deal with the gory details of OAuth 2, need dedicated customer support \u0026 consulting, try the cloud-based SaaS version: [https://oauth.io](https://oauth.io/?utm_source=doorkeeper-gem)\n\n\u003cbr\u003e\n\n\u003ca href=\"https://www.wealthsimple.com/?utm_source=doorkeeper-gem\" target=\"_blank\"\u003e\u003cimg src=\"https://wealthsimple.s3.amazonaws.com/branding/medium-black.svg\"/\u003e\u003c/a\u003e\n\n\u003e 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](https://www.wealthsimple.com/?utm_source=doorkeeper-gem)\n\n## Development\n\nTo run the local engine server:\n\n```\nbundle install\nbundle exec rake doorkeeper:server\n````\n\nBy default, it uses the latest Rails version with ActiveRecord. To run the\ntests with a specific Rails version:\n\n```\nBUNDLE_GEMFILE=gemfiles/rails_6_0.gemfile bundle exec rake\n```\n\nYou can also experiment with the changes using `bin/console`. It uses in-memory SQLite database and default\nDoorkeeper config, but you can reestablish connection or reconfigure the gem if you need.\n\n## Contributing\n\nWant to contribute and don't know where to start? Check out [features we're\nmissing](https://github.com/doorkeeper-gem/doorkeeper/wiki/Supported-Features),\ncreate [example\napps](https://github.com/doorkeeper-gem/doorkeeper/wiki/Example-Applications),\nintegrate the gem with your app and let us know!\n\nAlso, check out our [contributing guidelines page](CONTRIBUTING.md).\n\n## Contributors\n\nThanks to all our [awesome\ncontributors](https://github.com/doorkeeper-gem/doorkeeper/graphs/contributors)!\n\n\u003ca href=\"https://github.com/doorkeeper-gem/doorkeeper/graphs/contributors\"\u003e\u003cimg src=\"https://opencollective.com/doorkeeper-gem/contributors.svg?width=890\u0026button=false\" /\u003e\u003c/a\u003e\n\n## License\n\nMIT License. Created in Applicake. Maintained by the community.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdoorkeeper-gem%2Fdoorkeeper","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdoorkeeper-gem%2Fdoorkeeper","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdoorkeeper-gem%2Fdoorkeeper/lists"}