{"id":19465174,"url":"https://github.com/doorkeeper-gem/guides","last_synced_at":"2026-07-20T22:30:18.528Z","repository":{"id":39758599,"uuid":"174834478","full_name":"doorkeeper-gem/guides","owner":"doorkeeper-gem","description":null,"archived":false,"fork":false,"pushed_at":"2023-08-31T12:38:43.000Z","size":125,"stargazers_count":3,"open_issues_count":0,"forks_count":11,"subscribers_count":4,"default_branch":"master","last_synced_at":"2024-05-22T20:31:58.816Z","etag":null,"topics":["doorkeeper","guides"],"latest_commit_sha":null,"homepage":"https://doorkeeper.gitbook.io/guides/","language":null,"has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/doorkeeper-gem.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":"security/token-and-application-secrets.md","support":null,"governance":null}},"created_at":"2019-03-10T14:25:53.000Z","updated_at":"2022-03-02T07:05:59.000Z","dependencies_parsed_at":"2023-02-09T21:35:13.646Z","dependency_job_id":"443f2493-a139-4c17-ba40-fdafbd711981","html_url":"https://github.com/doorkeeper-gem/guides","commit_stats":{"total_commits":33,"total_committers":11,"mean_commits":3.0,"dds":0.5454545454545454,"last_synced_commit":"bca56d51e45f25e0bff9074cc67bb03f686eee94"},"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/doorkeeper-gem%2Fguides","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/doorkeeper-gem%2Fguides/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/doorkeeper-gem%2Fguides/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/doorkeeper-gem%2Fguides/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/doorkeeper-gem","download_url":"https://codeload.github.com/doorkeeper-gem/guides/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":240676632,"owners_count":19839554,"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":["doorkeeper","guides"],"created_at":"2024-11-10T18:19:04.969Z","updated_at":"2026-07-20T22:30:16.437Z","avatar_url":"https://github.com/doorkeeper-gem.png","language":null,"funding_links":[],"categories":[],"sub_categories":[],"readme":"# Doorkeeper Guides\n\n{% hint style='info' %}\nDear Russian friends, please watch President Zelenskyy's [speech addressed to you](https://twitter.com/PMoelleken/status/1496941845812760577). 🇺🇦\nHelp our brave mates in Ukraine with [a donation](https://actions.sumofus.org/a/give-to-ukrainians-who-need-an-urgent-lifeline).\n{% endhint %}\n\nDoorkeeper is an oAuth2 provider built in Ruby. It integrates with Ruby on Rails and Grape frameworks.\n\n## Installation\n\nThe installation process depends on the framework you're using. The first step is to add `doorkeeper` to your `Gemfile`:\n\n{% code-tabs %}\n{% code-tabs-item title=\"# Gemfile\" %}\n```ruby\ngem 'doorkeeper'\n```\n{% endcode-tabs-item %}\n{% endcode-tabs %}\n\nAnd run `bundle install`. After this, make sure to follow the guide related to the framework you're using below.\n\n### Ruby on Rails\n\nDoorkeeper follows Rails maintenance policy and supports only supported versions of the framework.\nCurrently we support Ruby on Rails 5 and higher. See the guide [here](ruby-on-rails/getting-started.md).\n\n### Grape\n\nGuide for integration with Grape framework can be found [here](grape/grape.md).\n\n### ORMs\n\nDoorkeeper supports `ActiveRecord` 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\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\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\n### Tutorials\n\nSee [list of tutorials](https://github.com/doorkeeper-gem/doorkeeper/wiki#how-tos--tutorials) in order to learn how to use the gem or integrate it with other solutions / gems.\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdoorkeeper-gem%2Fguides","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdoorkeeper-gem%2Fguides","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdoorkeeper-gem%2Fguides/lists"}