Skip to content

README.md

Latest commit

 

History

History
39 lines (27 loc) · 1.22 KB

README.md

File metadata and controls

39 lines (27 loc) · 1.22 KB

OmniAuth::Strategies::FedidOauth

This gem contains the FEDID strategy for OmniAuth.

How To Use It

If you are using rails, you need to add the gem to your Gemfile:

gem 'omniauth-fedid'

Once these are in, you need to add the following to your config/initializers/omniauth.rb:

Rails.application.config.middleware.use OmniAuth::Builder do
  provider :fedid_oauth, 'client_id', 'secret', scope: 'scopes', client_options: { site: 'site' }, pkce: true, pkce_verifier: 'example'
end

OR

Inside Devise (optional if using devise gem) config/initializers/devise.rb:

config.omniauth
  :fedid_oauth,
    'client_id',
    'secret',
    scope: 'scope',
    client_options: {
      site: 'site'
    },
    pkce: true,
    pkce_verifier: 'example'

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/justcodeio/omniauth-fedid. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the Contributor Covenant code of conduct.

License

The gem is available as open source under the terms of the MIT License.