Go to file
Cameron Crockett 5da4c4539d fixed issues with gem release 2018-12-16 16:52:37 -06:00
.vscode Initial commit for keycloak - opend id support 2018-12-16 15:45:33 -06:00
bin fixed issues with gem release 2018-12-16 16:52:37 -06:00
lib Initial commit for keycloak - opend id support 2018-12-16 15:45:33 -06:00
spec Initial commit for keycloak - opend id support 2018-12-16 15:45:33 -06:00
.gitignore Initial commit for keycloak - opend id support 2018-12-16 15:45:33 -06:00
.rspec Initial commit for keycloak - opend id support 2018-12-16 15:45:33 -06:00
.travis.yml Initial commit for keycloak - opend id support 2018-12-16 15:45:33 -06:00
CODE_OF_CONDUCT.md Initial commit for keycloak - opend id support 2018-12-16 15:45:33 -06:00
Gemfile Initial commit for keycloak - opend id support 2018-12-16 15:45:33 -06:00
Gemfile.lock Initial commit for keycloak - opend id support 2018-12-16 15:45:33 -06:00
LICENSE.txt Initial commit for keycloak - opend id support 2018-12-16 15:45:33 -06:00
README.md Initial commit for keycloak - opend id support 2018-12-16 15:45:33 -06:00
Rakefile Initial commit for keycloak - opend id support 2018-12-16 15:45:33 -06:00
omniauth-keycloak.gemspec fixed issues with gem release 2018-12-16 16:52:37 -06:00

README.md

Omniauth::Keycloak

Installation

Add this line to your application's Gemfile:

gem 'omniauth-keycloak'

And then execute:

$ bundle

Or install it yourself as:

$ gem install omniauth-keycloak

Usage

OmniAuth::Strategies::Keycloak is simply a Rack middleware. Read the OmniAuth docs for detailed instructions: https://github.com/intridea/omniauth.

Here's a quick example, adding the middleware to a Rails app in config/initializers/omniauth.rb:

Rails.application.config.middleware.use OmniAuth::Builder do
  provider :keycloak_openid, 'Example-Client', '19cca35f-dddd-473a-bdd5-03f00d61d884',
    client_options: {site: 'https://example.keycloak-url.com', realm: 'example-realm'}
end

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/ccrockett/omniauth-keycloak. 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.

Code of Conduct

Everyone interacting in the Omniauth::Keycloak projects codebases, issue trackers, chat rooms and mailing lists is expected to follow the code of conduct.