https://github.com/doorkeeper-gem/doorkeeper-devise-client
An example OAuth 2 client for Doorkeeper Provider App using Rails and Devise
https://github.com/doorkeeper-gem/doorkeeper-devise-client
devise doorkeeper oauth2-client ruby
Last synced: 14 days ago
JSON representation
An example OAuth 2 client for Doorkeeper Provider App using Rails and Devise
- Host: GitHub
- URL: https://github.com/doorkeeper-gem/doorkeeper-devise-client
- Owner: doorkeeper-gem
- Created: 2011-11-29T11:06:07.000Z (over 13 years ago)
- Default Branch: master
- Last Pushed: 2024-10-01T10:56:53.000Z (8 months ago)
- Last Synced: 2025-04-22T12:33:41.674Z (29 days ago)
- Topics: devise, doorkeeper, oauth2-client, ruby
- Language: Ruby
- Homepage: https://doorkeeper-devise-client.herokuapp.com
- Size: 469 KB
- Stars: 83
- Watchers: 5
- Forks: 56
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Doorkeeper Devise+Omniauth Client
[](https://semaphoreci.com/doorkeeper-gem/doorkeeper-devise-client)
This app is an example of OAuth2 client. It was built in order to test
the [doorkeeper provider example](http://doorkeeper-provider.herokuapp.com/).
It uses [rails](http://github.com/rails/rails/), [devise](http://github.com/plataformatec/devise)
and [omniauth](http://github.com/intridea/omniauth) gems. OAuth2
strategy is build on top of [abstract OAuth2 strategy for OmniAuth](https://github.com/intridea/omniauth-oauth2)
## About Doorkeeper Gem
For more information [about the gem](https://github.com/applicake/doorkeeper),
[documentation](https://github.com/applicake/doorkeeper#readme),
[wiki](https://github.com/applicake/doorkeeper/wiki/_pages) and another resources,
check out the project [on GitHub](https://github.com/applicake/doorkeeper).
## Installation & Configuration
If you want to run the application by yourself here are the steps for
you.
First you need to clone the [repository from GitHub](http://github.com/applicake/doorkeeper-devise-client)
git clone [email protected]:doorkeeper-gem/doorkeeper-devise-client.git
Install all the gems
bundle install
And migrate the database
bundle exec rake db:migrate
At this point the application should be ready to run, but it won't
communicate correctly with the provider. You need to set up environment
variables to indicate the oauth2 provider values. In your
`.env` file, setup these variables
DOORKEEPER_APP_ID = "375c2e3fd..." # ID for your app registered at the provider
DOORKEEPER_APP_SECRET = "6a2fa82ab..." # Secret
DOORKEEPER_APP_URL = "http://the-provider.com" # URL to the provider
If you want to test it out you can use our sample provider using
[doorkeeper](http://github.com/applicake/doorkeeper) gem. It's available
[here](http://doorkeeper-provider.herokuapp.com). In order to add your
application and get your application ID and SECRET [click
here](http://doorkeeper-provider.herokuapp.com/oauth/application/new).
Now you are ready to start the app
bundle exec rails s