diff --git a/README.md b/README.md index 63cdd93..c55ce73 100755 --- a/README.md +++ b/README.md @@ -16,6 +16,15 @@ Or install it yourself as: $ gem install omniauth-keycloak +## Use with Keycloak >= 17 (Quarkus distribution) +In version 17 of Keycloak, `/auth` was removed from the default context path. (See Issue #29) +In order to reduce breaking existing user's setup, this gem assumes `/auth` as the default context. +__So if you want to use Keycloak 17 or greater then you must do one of the following:__ + +1. Pass in `--http-relative-path '/auth'` option with the keycloak start command +2. Pass in a empty string for you base_url client_option: + `client_options: {base_url: '', site: 'https://example.keycloak-url.com', realm: 'example-realm'}` + ## Usage `OmniAuth::Strategies::Keycloak` is simply a Rack middleware. Read the OmniAuth docs for detailed instructions: https://github.com/intridea/omniauth.