https://github.com/deanpcmad/omniauth-discord
Discord OAuth2 Strategy for OmniAuth
https://github.com/deanpcmad/omniauth-discord
Last synced: 19 days ago
JSON representation
Discord OAuth2 Strategy for OmniAuth
- Host: GitHub
- URL: https://github.com/deanpcmad/omniauth-discord
- Owner: deanpcmad
- License: mit
- Created: 2016-06-30T16:23:58.000Z (almost 9 years ago)
- Default Branch: main
- Last Pushed: 2024-03-02T22:44:15.000Z (about 1 year ago)
- Last Synced: 2024-04-25T05:21:24.301Z (about 1 year ago)
- Language: Ruby
- Homepage:
- Size: 65.4 KB
- Stars: 40
- Watchers: 1
- Forks: 30
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
README
# OmniAuth Discord
OmniAuth Discord - OAuth2 Strategy for OmniAuth
OmniAuth Discord is an OAuth2 strategy for OmniAuth that allows you to authenticate users using Discord. If you're not familiar with Discord's OAuth2, we recommend you check out the Discord API documentation for more details.
## Installation
To install OmniAuth Discord, simply add the following line to your Gemfile:
```ruby
gem 'omniauth-discord'
```
Then run bundle install to install the gem.
## Usage
OmniAuth Discord is a Rack middleware. If you're not familiar with OmniAuth, we recommend reading the documentation for detailed instructions. Here's an example of how to add the middleware to a Rails app in config/initializers/omniauth.rb:
```ruby
Rails.application.config.middleware.use OmniAuth::Builder do
provider :discord, ENV['DISCORD_CLIENT_ID'], ENV['DISCORD_CLIENT_SECRET']
end
```
By default, Discord does not return a user's email address. You can request access to additional resources by setting scopes. For example, to get a user's email, you would set the scope to 'email'.
```ruby
Rails.application.config.middleware.use OmniAuth::Builder do
provider :discord, ENV['DISCORD_CLIENT_ID'], ENV['DISCORD_CLIENT_SECRET'], scope: 'email'
end
```
You can pass multiple scopes in the same string. For example, to get a user's Discord account info, you would set the scope to 'email identify'.
```ruby
Rails.application.config.middleware.use OmniAuth::Builder do
provider :discord, ENV['DISCORD_CLIENT_ID'], ENV['DISCORD_CLIENT_SECRET'], scope: 'email identify'
end
```
You can also specify a callback URL by adding callback_url to the provider options.
```ruby
Rails.application.config.middleware.use OmniAuth::Builder do
provider :discord, ENV['DISCORD_CLIENT_ID'], ENV['DISCORD_CLIENT_SECRET'], scope: 'email identify', callback_url: 'https://someurl.com/users/auth/discord/callback'
end
```
## Additional Permissions
You can request additional permissions from the user by setting the permissions option. For example, to request permission to the MANAGE_CHANNELS and MANAGE_ROLES permissions, you would set permissions to 0x00000010 + 0x10000000.
```ruby
Rails.application.config.middleware.use OmniAuth::Builder do
provider :discord, ENV['DISCORD_CLIENT_ID'], ENV['DISCORD_CLIENT_SECRET'], scope: 'identify bot', permissions: 0x00000010 + 0x10000000
end
```
This will request permission to the MANAGE_CHANNELS and the MANAGE_ROLES
permissions.
## Prompt Options
You can specify the prompt options by setting the prompt option. The prompt option indicates whether the user should be prompted to reauthorize on sign in. Valid options are 'consent' and 'none'. Note that the user is always prompted to authorize on sign up.
## Contributing
If you find a bug or want to contribute to the project, we welcome bug reports and pull requests on GitHub.
## License
OmniAuth Discord is available as open-source software under the [MIT License](http://opensource.org/licenses/MIT).